doc.go 2.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960
  1. // Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
  2. // Package resourcegroups provides the client and types for making API
  3. // requests to AWS Resource Groups.
  4. //
  5. // AWS Resource Groups lets you organize AWS resources such as Amazon EC2 instances,
  6. // Amazon Relational Database Service databases, and Amazon S3 buckets into
  7. // groups using criteria that you define as tags. A resource group is a collection
  8. // of resources that match the resource types specified in a query, and share
  9. // one or more tags or portions of tags. You can create a group of resources
  10. // based on their roles in your cloud infrastructure, lifecycle stages, regions,
  11. // application layers, or virtually any criteria. Resource groups enable you
  12. // to automate management tasks, such as those in AWS Systems Manager Automation
  13. // documents, on tag-related resources in AWS Systems Manager. Groups of tagged
  14. // resources also let you quickly view a custom console in AWS Systems Manager
  15. // that shows AWS Config compliance and other monitoring data about member resources.
  16. //
  17. // To create a resource group, build a resource query, and specify tags that
  18. // identify the criteria that members of the group have in common. Tags are
  19. // key-value pairs.
  20. //
  21. // For more information about Resource Groups, see the AWS Resource Groups User
  22. // Guide (https://docs.aws.amazon.com/ARG/latest/userguide/welcome.html).
  23. //
  24. // AWS Resource Groups uses a REST-compliant API that you can use to perform
  25. // the following types of operations.
  26. //
  27. // * Create, Read, Update, and Delete (CRUD) operations on resource groups
  28. // and resource query entities
  29. //
  30. // * Applying, editing, and removing tags from resource groups
  31. //
  32. // * Resolving resource group member ARNs so they can be returned as search
  33. // results
  34. //
  35. // * Getting data about resources that are members of a group
  36. //
  37. // * Searching AWS resources based on a resource query
  38. //
  39. // See https://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27 for more information on this service.
  40. //
  41. // See resourcegroups package documentation for more information.
  42. // https://docs.aws.amazon.com/sdk-for-go/api/service/resourcegroups/
  43. //
  44. // Using the Client
  45. //
  46. // To contact AWS Resource Groups with the SDK use the New function to create
  47. // a new service client. With that client you can make API requests to the service.
  48. // These clients are safe to use concurrently.
  49. //
  50. // See the SDK's documentation for more information on how to use the SDK.
  51. // https://docs.aws.amazon.com/sdk-for-go/api/
  52. //
  53. // See aws.Config documentation for more information on configuring SDK clients.
  54. // https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config
  55. //
  56. // See the AWS Resource Groups client ResourceGroups for more
  57. // information on creating client for this service.
  58. // https://docs.aws.amazon.com/sdk-for-go/api/service/resourcegroups/#New
  59. package resourcegroups