Documentation

Overview

    Package resourcegroups provides the API client, operations, and parameter types for AWS Resource Groups.

    AWS Resource Groups AWS Resource Groups lets you organize AWS resources such as Amazon EC2 instances, Amazon Relational Database Service databases, and Amazon S3 buckets into groups using criteria that you define as tags. A resource group is a collection of resources that match the resource types specified in a query, and share one or more tags or portions of tags. You can create a group of resources based on their roles in your cloud infrastructure, lifecycle stages, regions, application layers, or virtually any criteria. Resource Groups enable you to automate management tasks, such as those in AWS Systems Manager Automation documents, on tag-related resources in AWS Systems Manager. Groups of tagged resources also let you quickly view a custom console in AWS Systems Manager that shows AWS Config compliance and other monitoring data about member resources. To create a resource group, build a resource query, and specify tags that identify the criteria that members of the group have in common. Tags are key-value pairs. For more information about Resource Groups, see the AWS Resource Groups User Guide (https://docs.aws.amazon.com/ARG/latest/userguide/welcome.html). AWS Resource Groups uses a REST-compliant API that you can use to perform the following types of operations.

    * Create, Read, Update, and Delete (CRUD) operations on resource groups and resource query entities

    * Applying, editing, and removing tags from resource groups

    * Resolving resource group member ARNs so they can be returned as search results

    * Getting data about resources that are members of a group

    * Searching AWS resources based on a resource query

    Index

    Constants

    View Source
    const ServiceAPIVersion = "2017-11-27"
    View Source
    const ServiceID = "Resource Groups"

    Variables

    This section is empty.

    Functions

    func NewDefaultEndpointResolver

    func NewDefaultEndpointResolver() *internalendpoints.Resolver

      NewDefaultEndpointResolver constructs a new service endpoint resolver

      func WithAPIOptions

      func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

        WithAPIOptions returns a functional option for setting the Client's APIOptions option.

        func WithEndpointResolver

        func WithEndpointResolver(v EndpointResolver) func(*Options)

          WithEndpointResolver returns a functional option for setting the Client's EndpointResolver option.

          Types

          type Client

          type Client struct {
          	// contains filtered or unexported fields
          }

            Client provides the API client to make operations call for AWS Resource Groups.

            func New

            func New(options Options, optFns ...func(*Options)) *Client

              New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

              func NewFromConfig

              func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

                NewFromConfig returns a new client from the provided config.

                func (*Client) CreateGroup

                func (c *Client) CreateGroup(ctx context.Context, params *CreateGroupInput, optFns ...func(*Options)) (*CreateGroupOutput, error)

                  Creates a resource group with the specified name and description. You can optionally include a resource query, or a service configuration. For more information about constructing a resource query, see Create a tag-based group in Resource Groups (https://docs.aws.amazon.com/ARG/latest/userguide/gettingstarted-query.html#gettingstarted-query-cli-tag). For more information about service configurations, see Service configurations for resource groups (https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html). Minimum permissions To run this command, you must have the following permissions:

                  * resource-groups:CreateGroup

                  func (*Client) DeleteGroup

                  func (c *Client) DeleteGroup(ctx context.Context, params *DeleteGroupInput, optFns ...func(*Options)) (*DeleteGroupOutput, error)

                    Deletes the specified resource group. Deleting a resource group does not delete any resources that are members of the group; it only deletes the group structure. Minimum permissions To run this command, you must have the following permissions:

                    * resource-groups:DeleteGroup

                    func (*Client) GetGroup

                    func (c *Client) GetGroup(ctx context.Context, params *GetGroupInput, optFns ...func(*Options)) (*GetGroupOutput, error)

                      Returns information about a specified resource group. Minimum permissions To run this command, you must have the following permissions:

                      * resource-groups:GetGroup

                      func (*Client) GetGroupConfiguration

                      func (c *Client) GetGroupConfiguration(ctx context.Context, params *GetGroupConfigurationInput, optFns ...func(*Options)) (*GetGroupConfigurationOutput, error)

                        Returns the service configuration associated with the specified resource group. For details about the service configuration syntax, see Service configurations for resource groups (https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html). Minimum permissions To run this command, you must have the following permissions:

                        * resource-groups:GetGroupConfiguration

                        func (*Client) GetGroupQuery

                        func (c *Client) GetGroupQuery(ctx context.Context, params *GetGroupQueryInput, optFns ...func(*Options)) (*GetGroupQueryOutput, error)

                          Retrieves the resource query associated with the specified resource group. For more information about resource queries, see Create a tag-based group in Resource Groups (https://docs.aws.amazon.com/ARG/latest/userguide/gettingstarted-query.html#gettingstarted-query-cli-tag). Minimum permissions To run this command, you must have the following permissions:

                          * resource-groups:GetGroupQuery

                          func (*Client) GetTags

                          func (c *Client) GetTags(ctx context.Context, params *GetTagsInput, optFns ...func(*Options)) (*GetTagsOutput, error)

                            Returns a list of tags that are associated with a resource group, specified by an ARN. Minimum permissions To run this command, you must have the following permissions:

                            * resource-groups:GetTags

                            func (*Client) GroupResources

                            func (c *Client) GroupResources(ctx context.Context, params *GroupResourcesInput, optFns ...func(*Options)) (*GroupResourcesOutput, error)

                              Adds the specified resources to the specified group. Minimum permissions To run this command, you must have the following permissions:

                              * resource-groups:GroupResources

                              func (*Client) ListGroupResources

                              func (c *Client) ListGroupResources(ctx context.Context, params *ListGroupResourcesInput, optFns ...func(*Options)) (*ListGroupResourcesOutput, error)

                                Returns a list of ARNs of the resources that are members of a specified resource group. Minimum permissions To run this command, you must have the following permissions:

                                * resource-groups:ListGroupResources

                                func (*Client) ListGroups

                                func (c *Client) ListGroups(ctx context.Context, params *ListGroupsInput, optFns ...func(*Options)) (*ListGroupsOutput, error)

                                  Returns a list of existing resource groups in your account. Minimum permissions To run this command, you must have the following permissions:

                                  * resource-groups:ListGroups

                                  func (*Client) PutGroupConfiguration

                                  func (c *Client) PutGroupConfiguration(ctx context.Context, params *PutGroupConfigurationInput, optFns ...func(*Options)) (*PutGroupConfigurationOutput, error)

                                    Attaches a service configuration to the specified group. This occurs asynchronously, and can take time to complete. You can use GetGroupConfiguration to check the status of the update. Minimum permissions To run this command, you must have the following permissions:

                                    * resource-groups:PutGroupConfiguration

                                    func (*Client) SearchResources

                                    func (c *Client) SearchResources(ctx context.Context, params *SearchResourcesInput, optFns ...func(*Options)) (*SearchResourcesOutput, error)

                                      Returns a list of AWS resource identifiers that matches the specified query. The query uses the same format as a resource query in a CreateGroup or UpdateGroupQuery operation. Minimum permissions To run this command, you must have the following permissions:

                                      * resource-groups:SearchResources

                                      func (*Client) Tag

                                      func (c *Client) Tag(ctx context.Context, params *TagInput, optFns ...func(*Options)) (*TagOutput, error)

                                        Adds tags to a resource group with the specified ARN. Existing tags on a resource group are not changed if they are not specified in the request parameters. Do not store personally identifiable information (PII) or other confidential or sensitive information in tags. We use tags to provide you with billing and administration services. Tags are not intended to be used for private or sensitive data. Minimum permissions To run this command, you must have the following permissions:

                                        * resource-groups:Tag

                                        func (*Client) UngroupResources

                                        func (c *Client) UngroupResources(ctx context.Context, params *UngroupResourcesInput, optFns ...func(*Options)) (*UngroupResourcesOutput, error)

                                          Removes the specified resources from the specified group. Minimum permissions To run this command, you must have the following permissions:

                                          * resource-groups:UngroupResources

                                          func (*Client) Untag

                                          func (c *Client) Untag(ctx context.Context, params *UntagInput, optFns ...func(*Options)) (*UntagOutput, error)

                                            Deletes tags from a specified resource group. Minimum permissions To run this command, you must have the following permissions:

                                            * resource-groups:Untag

                                            func (*Client) UpdateGroup

                                            func (c *Client) UpdateGroup(ctx context.Context, params *UpdateGroupInput, optFns ...func(*Options)) (*UpdateGroupOutput, error)

                                              Updates the description for an existing group. You cannot update the name of a resource group. Minimum permissions To run this command, you must have the following permissions:

                                              * resource-groups:UpdateGroup

                                              func (*Client) UpdateGroupQuery

                                              func (c *Client) UpdateGroupQuery(ctx context.Context, params *UpdateGroupQueryInput, optFns ...func(*Options)) (*UpdateGroupQueryOutput, error)

                                                Updates the resource query of a group. For more information about resource queries, see Create a tag-based group in Resource Groups (https://docs.aws.amazon.com/ARG/latest/userguide/gettingstarted-query.html#gettingstarted-query-cli-tag). Minimum permissions To run this command, you must have the following permissions:

                                                * resource-groups:UpdateGroupQuery

                                                type CreateGroupInput

                                                type CreateGroupInput struct {
                                                
                                                	// The name of the group, which is the identifier of the group in other operations.
                                                	// You can't change the name of a resource group after you create it. A resource
                                                	// group name can consist of letters, numbers, hyphens, periods, and underscores.
                                                	// The name cannot start with AWS or aws; these are reserved. A resource group name
                                                	// must be unique within each AWS Region in your AWS account.
                                                	//
                                                	// This member is required.
                                                	Name *string
                                                
                                                	// A configuration associates the resource group with an AWS service and specifies
                                                	// how the service can interact with the resources in the group. A configuration is
                                                	// an array of GroupConfigurationItem elements. For details about the syntax of
                                                	// service configurations, see Service configurations for resource groups
                                                	// (https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html). A resource
                                                	// group can contain either a Configuration or a ResourceQuery, but not both.
                                                	Configuration []types.GroupConfigurationItem
                                                
                                                	// The description of the resource group. Descriptions can consist of letters,
                                                	// numbers, hyphens, underscores, periods, and spaces.
                                                	Description *string
                                                
                                                	// The resource query that determines which AWS resources are members of this
                                                	// group. For more information about resource queries, see Create a tag-based group
                                                	// in Resource Groups
                                                	// (https://docs.aws.amazon.com/ARG/latest/userguide/gettingstarted-query.html#gettingstarted-query-cli-tag).
                                                	// A resource group can contain either a ResourceQuery or a Configuration, but not
                                                	// both.
                                                	ResourceQuery *types.ResourceQuery
                                                
                                                	// The tags to add to the group. A tag is key-value pair string.
                                                	Tags map[string]string
                                                }

                                                type CreateGroupOutput

                                                type CreateGroupOutput struct {
                                                
                                                	// The description of the resource group.
                                                	Group *types.Group
                                                
                                                	// The service configuration associated with the resource group. For details about
                                                	// the syntax of a service configuration, see Service configurations for resource
                                                	// groups (https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html).
                                                	GroupConfiguration *types.GroupConfiguration
                                                
                                                	// The resource query associated with the group. For more information about
                                                	// resource queries, see Create a tag-based group in Resource Groups
                                                	// (https://docs.aws.amazon.com/ARG/latest/userguide/gettingstarted-query.html#gettingstarted-query-cli-tag).
                                                	ResourceQuery *types.ResourceQuery
                                                
                                                	// The tags associated with the group.
                                                	Tags map[string]string
                                                
                                                	// Metadata pertaining to the operation's result.
                                                	ResultMetadata middleware.Metadata
                                                }

                                                type DeleteGroupInput

                                                type DeleteGroupInput struct {
                                                
                                                	// The name or the ARN of the resource group to delete.
                                                	Group *string
                                                
                                                	// Deprecated - don't use this parameter. Use Group instead.
                                                	//
                                                	// Deprecated: This field is deprecated, use Group instead.
                                                	GroupName *string
                                                }

                                                type DeleteGroupOutput

                                                type DeleteGroupOutput struct {
                                                
                                                	// A full description of the deleted resource group.
                                                	Group *types.Group
                                                
                                                	// Metadata pertaining to the operation's result.
                                                	ResultMetadata middleware.Metadata
                                                }

                                                type EndpointResolver

                                                type EndpointResolver interface {
                                                	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
                                                }

                                                  EndpointResolver interface for resolving service endpoints.

                                                  func EndpointResolverFromURL

                                                  func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

                                                    EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

                                                    type EndpointResolverFunc

                                                    type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

                                                      EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

                                                      func (EndpointResolverFunc) ResolveEndpoint

                                                      func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

                                                      type EndpointResolverOptions

                                                      type EndpointResolverOptions = internalendpoints.Options

                                                        EndpointResolverOptions is the service endpoint resolver options

                                                        type GetGroupConfigurationInput

                                                        type GetGroupConfigurationInput struct {
                                                        
                                                        	// The name or the ARN of the resource group.
                                                        	Group *string
                                                        }

                                                        type GetGroupConfigurationOutput

                                                        type GetGroupConfigurationOutput struct {
                                                        
                                                        	// The service configuration associated with the specified group. For details about
                                                        	// the service configuration syntax, see Service configurations for resource groups
                                                        	// (https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html).
                                                        	GroupConfiguration *types.GroupConfiguration
                                                        
                                                        	// Metadata pertaining to the operation's result.
                                                        	ResultMetadata middleware.Metadata
                                                        }

                                                        type GetGroupInput

                                                        type GetGroupInput struct {
                                                        
                                                        	// The name or the ARN of the resource group to retrieve.
                                                        	Group *string
                                                        
                                                        	// Deprecated - don't use this parameter. Use Group instead.
                                                        	//
                                                        	// Deprecated: This field is deprecated, use Group instead.
                                                        	GroupName *string
                                                        }

                                                        type GetGroupOutput

                                                        type GetGroupOutput struct {
                                                        
                                                        	// A full description of the resource group.
                                                        	Group *types.Group
                                                        
                                                        	// Metadata pertaining to the operation's result.
                                                        	ResultMetadata middleware.Metadata
                                                        }

                                                        type GetGroupQueryInput

                                                        type GetGroupQueryInput struct {
                                                        
                                                        	// The name or the ARN of the resource group to query.
                                                        	Group *string
                                                        
                                                        	// Don't use this parameter. Use Group instead.
                                                        	//
                                                        	// Deprecated: This field is deprecated, use Group instead.
                                                        	GroupName *string
                                                        }

                                                        type GetGroupQueryOutput

                                                        type GetGroupQueryOutput struct {
                                                        
                                                        	// The resource query associated with the specified group. For more information
                                                        	// about resource queries, see Create a tag-based group in Resource Groups
                                                        	// (https://docs.aws.amazon.com/ARG/latest/userguide/gettingstarted-query.html#gettingstarted-query-cli-tag).
                                                        	GroupQuery *types.GroupQuery
                                                        
                                                        	// Metadata pertaining to the operation's result.
                                                        	ResultMetadata middleware.Metadata
                                                        }

                                                        type GetTagsInput

                                                        type GetTagsInput struct {
                                                        
                                                        	// The ARN of the resource group whose tags you want to retrieve.
                                                        	//
                                                        	// This member is required.
                                                        	Arn *string
                                                        }

                                                        type GetTagsOutput

                                                        type GetTagsOutput struct {
                                                        
                                                        	// The ARN of the tagged resource group.
                                                        	Arn *string
                                                        
                                                        	// The tags associated with the specified resource group.
                                                        	Tags map[string]string
                                                        
                                                        	// Metadata pertaining to the operation's result.
                                                        	ResultMetadata middleware.Metadata
                                                        }

                                                        type GroupResourcesInput

                                                        type GroupResourcesInput struct {
                                                        
                                                        	// The name or the ARN of the resource group to add resources to.
                                                        	//
                                                        	// This member is required.
                                                        	Group *string
                                                        
                                                        	// The list of ARNs for resources to be added to the group.
                                                        	//
                                                        	// This member is required.
                                                        	ResourceArns []string
                                                        }

                                                        type GroupResourcesOutput

                                                        type GroupResourcesOutput struct {
                                                        
                                                        	// A list of ARNs of any resources that failed to be added to the group by this
                                                        	// operation.
                                                        	Failed []types.FailedResource
                                                        
                                                        	// A list of ARNs of any resources that are still in the process of being added to
                                                        	// the group by this operation. These pending additions continue asynchronously.
                                                        	// You can check the status of pending additions by using the ListGroupResources
                                                        	// operation, and checking the Resources array in the response and the Status field
                                                        	// of each object in that array.
                                                        	Pending []types.PendingResource
                                                        
                                                        	// A list of ARNs of resources that were successfully added to the group by this
                                                        	// operation.
                                                        	Succeeded []string
                                                        
                                                        	// Metadata pertaining to the operation's result.
                                                        	ResultMetadata middleware.Metadata
                                                        }

                                                        type HTTPClient

                                                        type HTTPClient interface {
                                                        	Do(*http.Request) (*http.Response, error)
                                                        }

                                                        type HTTPSignerV4

                                                        type HTTPSignerV4 interface {
                                                        	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
                                                        }

                                                        type ListGroupResourcesAPIClient

                                                        type ListGroupResourcesAPIClient interface {
                                                        	ListGroupResources(context.Context, *ListGroupResourcesInput, ...func(*Options)) (*ListGroupResourcesOutput, error)
                                                        }

                                                          ListGroupResourcesAPIClient is a client that implements the ListGroupResources operation.

                                                          type ListGroupResourcesInput

                                                          type ListGroupResourcesInput struct {
                                                          
                                                          	// Filters, formatted as ResourceFilter objects, that you want to apply to a
                                                          	// ListGroupResources operation. Filters the results to include only those of the
                                                          	// specified resource types.
                                                          	//
                                                          	// * resource-type - Filter resources by their type.
                                                          	// Specify up to five resource types in the format AWS::ServiceCode::ResourceType.
                                                          	// For example, AWS::EC2::Instance, or AWS::S3::Bucket.
                                                          	//
                                                          	// When you specify a
                                                          	// resource-type filter for ListGroupResources, AWS Resource Groups validates your
                                                          	// filter resource types against the types that are defined in the query associated
                                                          	// with the group. For example, if a group contains only S3 buckets because its
                                                          	// query specifies only that resource type, but your resource-type filter includes
                                                          	// EC2 instances, AWS Resource Groups does not filter for EC2 instances. In this
                                                          	// case, a ListGroupResources request returns a BadRequestException error with a
                                                          	// message similar to the following: The resource types specified as filters in the
                                                          	// request are not valid. The error includes a list of resource types that failed
                                                          	// the validation because they are not part of the query associated with the group.
                                                          	// This validation doesn't occur when the group query specifies AWS::AllSupported,
                                                          	// because a group based on such a query can contain any of the allowed resource
                                                          	// types for the query type (tag-based or AWS CloudFormation stack-based queries).
                                                          	Filters []types.ResourceFilter
                                                          
                                                          	// The name or the ARN of the resource group
                                                          	Group *string
                                                          
                                                          	// Deprecated - don't use this parameter. Use the Group request field instead.
                                                          	//
                                                          	// Deprecated: This field is deprecated, use Group instead.
                                                          	GroupName *string
                                                          
                                                          	// The total number of results that you want included on each page of the response.
                                                          	// If you do not include this parameter, it defaults to a value that is specific to
                                                          	// the operation. If additional items exist beyond the maximum you specify, the
                                                          	// NextToken response element is present and has a value (is not null). Include
                                                          	// that value as the NextToken request parameter in the next call to the operation
                                                          	// to get the next part of the results. Note that the service might return fewer
                                                          	// results than the maximum even when there are more results available. You should
                                                          	// check NextToken after every operation to ensure that you receive all of the
                                                          	// results.
                                                          	MaxResults *int32
                                                          
                                                          	// The parameter for receiving additional results if you receive a NextToken
                                                          	// response in a previous request. A NextToken response indicates that more output
                                                          	// is available. Set this parameter to the value provided by a previous call's
                                                          	// NextToken response to indicate where the output should continue from.
                                                          	NextToken *string
                                                          }

                                                          type ListGroupResourcesOutput

                                                          type ListGroupResourcesOutput struct {
                                                          
                                                          	// If present, indicates that more output is available than is included in the
                                                          	// current response. Use this value in the NextToken request parameter in a
                                                          	// subsequent call to the operation to get the next part of the output. You should
                                                          	// repeat this until the NextToken response element comes back as null.
                                                          	NextToken *string
                                                          
                                                          	// A list of QueryError objects. Each error is an object that contains ErrorCode
                                                          	// and Message structures. Possible values for ErrorCode are
                                                          	// CLOUDFORMATION_STACK_INACTIVE and CLOUDFORMATION_STACK_NOT_EXISTING.
                                                          	QueryErrors []types.QueryError
                                                          
                                                          	// Deprecated - don't use this parameter. Use the Resources response field instead.
                                                          	//
                                                          	// Deprecated: This field is deprecated, use Resources instead.
                                                          	ResourceIdentifiers []types.ResourceIdentifier
                                                          
                                                          	// An array of resources from which you can determine each resource's identity,
                                                          	// type, and group membership status.
                                                          	Resources []types.ListGroupResourcesItem
                                                          
                                                          	// Metadata pertaining to the operation's result.
                                                          	ResultMetadata middleware.Metadata
                                                          }

                                                          type ListGroupResourcesPaginator

                                                          type ListGroupResourcesPaginator struct {
                                                          	// contains filtered or unexported fields
                                                          }

                                                            ListGroupResourcesPaginator is a paginator for ListGroupResources

                                                            func NewListGroupResourcesPaginator

                                                            func NewListGroupResourcesPaginator(client ListGroupResourcesAPIClient, params *ListGroupResourcesInput, optFns ...func(*ListGroupResourcesPaginatorOptions)) *ListGroupResourcesPaginator

                                                              NewListGroupResourcesPaginator returns a new ListGroupResourcesPaginator

                                                              func (*ListGroupResourcesPaginator) HasMorePages

                                                              func (p *ListGroupResourcesPaginator) HasMorePages() bool

                                                                HasMorePages returns a boolean indicating whether more pages are available

                                                                func (*ListGroupResourcesPaginator) NextPage

                                                                func (p *ListGroupResourcesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListGroupResourcesOutput, error)

                                                                  NextPage retrieves the next ListGroupResources page.

                                                                  type ListGroupResourcesPaginatorOptions

                                                                  type ListGroupResourcesPaginatorOptions struct {
                                                                  	// The total number of results that you want included on each page of the response.
                                                                  	// If you do not include this parameter, it defaults to a value that is specific to
                                                                  	// the operation. If additional items exist beyond the maximum you specify, the
                                                                  	// NextToken response element is present and has a value (is not null). Include
                                                                  	// that value as the NextToken request parameter in the next call to the operation
                                                                  	// to get the next part of the results. Note that the service might return fewer
                                                                  	// results than the maximum even when there are more results available. You should
                                                                  	// check NextToken after every operation to ensure that you receive all of the
                                                                  	// results.
                                                                  	Limit int32
                                                                  
                                                                  	// Set to true if pagination should stop if the service returns a pagination token
                                                                  	// that matches the most recent token provided to the service.
                                                                  	StopOnDuplicateToken bool
                                                                  }

                                                                    ListGroupResourcesPaginatorOptions is the paginator options for ListGroupResources

                                                                    type ListGroupsAPIClient

                                                                    type ListGroupsAPIClient interface {
                                                                    	ListGroups(context.Context, *ListGroupsInput, ...func(*Options)) (*ListGroupsOutput, error)
                                                                    }

                                                                      ListGroupsAPIClient is a client that implements the ListGroups operation.

                                                                      type ListGroupsInput

                                                                      type ListGroupsInput struct {
                                                                      
                                                                      	// Filters, formatted as GroupFilter objects, that you want to apply to a
                                                                      	// ListGroups operation.
                                                                      	//
                                                                      	// * resource-type - Filter the results to include only
                                                                      	// those of the specified resource types. Specify up to five resource types in the
                                                                      	// format AWS::ServiceCode::ResourceType . For example, AWS::EC2::Instance, or
                                                                      	// AWS::S3::Bucket.
                                                                      	//
                                                                      	// * configuration-type - Filter the results to include only
                                                                      	// those groups that have the specified configuration types attached. The current
                                                                      	// supported values are:
                                                                      	//
                                                                      	// * AWS:EC2::CapacityReservationPool
                                                                      	//
                                                                      	// *
                                                                      	// AWS:EC2::HostManagement
                                                                      	Filters []types.GroupFilter
                                                                      
                                                                      	// The total number of results that you want included on each page of the response.
                                                                      	// If you do not include this parameter, it defaults to a value that is specific to
                                                                      	// the operation. If additional items exist beyond the maximum you specify, the
                                                                      	// NextToken response element is present and has a value (is not null). Include
                                                                      	// that value as the NextToken request parameter in the next call to the operation
                                                                      	// to get the next part of the results. Note that the service might return fewer
                                                                      	// results than the maximum even when there are more results available. You should
                                                                      	// check NextToken after every operation to ensure that you receive all of the
                                                                      	// results.
                                                                      	MaxResults *int32
                                                                      
                                                                      	// The parameter for receiving additional results if you receive a NextToken
                                                                      	// response in a previous request. A NextToken response indicates that more output
                                                                      	// is available. Set this parameter to the value provided by a previous call's
                                                                      	// NextToken response to indicate where the output should continue from.
                                                                      	NextToken *string
                                                                      }

                                                                      type ListGroupsOutput

                                                                      type ListGroupsOutput struct {
                                                                      
                                                                      	// A list of GroupIdentifier objects. Each identifier is an object that contains
                                                                      	// both the Name and the GroupArn.
                                                                      	GroupIdentifiers []types.GroupIdentifier
                                                                      
                                                                      	// Deprecated - don't use this field. Use the GroupIdentifiers response field
                                                                      	// instead.
                                                                      	//
                                                                      	// Deprecated: This field is deprecated, use GroupIdentifiers instead.
                                                                      	Groups []types.Group
                                                                      
                                                                      	// If present, indicates that more output is available than is included in the
                                                                      	// current response. Use this value in the NextToken request parameter in a
                                                                      	// subsequent call to the operation to get the next part of the output. You should
                                                                      	// repeat this until the NextToken response element comes back as null.
                                                                      	NextToken *string
                                                                      
                                                                      	// Metadata pertaining to the operation's result.
                                                                      	ResultMetadata middleware.Metadata
                                                                      }

                                                                      type ListGroupsPaginator

                                                                      type ListGroupsPaginator struct {
                                                                      	// contains filtered or unexported fields
                                                                      }

                                                                        ListGroupsPaginator is a paginator for ListGroups

                                                                        func NewListGroupsPaginator

                                                                        func NewListGroupsPaginator(client ListGroupsAPIClient, params *ListGroupsInput, optFns ...func(*ListGroupsPaginatorOptions)) *ListGroupsPaginator

                                                                          NewListGroupsPaginator returns a new ListGroupsPaginator

                                                                          func (*ListGroupsPaginator) HasMorePages

                                                                          func (p *ListGroupsPaginator) HasMorePages() bool

                                                                            HasMorePages returns a boolean indicating whether more pages are available

                                                                            func (*ListGroupsPaginator) NextPage

                                                                            func (p *ListGroupsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListGroupsOutput, error)

                                                                              NextPage retrieves the next ListGroups page.

                                                                              type ListGroupsPaginatorOptions

                                                                              type ListGroupsPaginatorOptions struct {
                                                                              	// The total number of results that you want included on each page of the response.
                                                                              	// If you do not include this parameter, it defaults to a value that is specific to
                                                                              	// the operation. If additional items exist beyond the maximum you specify, the
                                                                              	// NextToken response element is present and has a value (is not null). Include
                                                                              	// that value as the NextToken request parameter in the next call to the operation
                                                                              	// to get the next part of the results. Note that the service might return fewer
                                                                              	// results than the maximum even when there are more results available. You should
                                                                              	// check NextToken after every operation to ensure that you receive all of the
                                                                              	// results.
                                                                              	Limit int32
                                                                              
                                                                              	// Set to true if pagination should stop if the service returns a pagination token
                                                                              	// that matches the most recent token provided to the service.
                                                                              	StopOnDuplicateToken bool
                                                                              }

                                                                                ListGroupsPaginatorOptions is the paginator options for ListGroups

                                                                                type Options

                                                                                type Options struct {
                                                                                	// Set of options to modify how an operation is invoked. These apply to all
                                                                                	// operations invoked for this client. Use functional options on operation call to
                                                                                	// modify this list for per operation behavior.
                                                                                	APIOptions []func(*middleware.Stack) error
                                                                                
                                                                                	// Configures the events that will be sent to the configured logger.
                                                                                	ClientLogMode aws.ClientLogMode
                                                                                
                                                                                	// The credentials object to use when signing requests.
                                                                                	Credentials aws.CredentialsProvider
                                                                                
                                                                                	// The endpoint options to be used when attempting to resolve an endpoint.
                                                                                	EndpointOptions EndpointResolverOptions
                                                                                
                                                                                	// The service endpoint resolver.
                                                                                	EndpointResolver EndpointResolver
                                                                                
                                                                                	// Signature Version 4 (SigV4) Signer
                                                                                	HTTPSignerV4 HTTPSignerV4
                                                                                
                                                                                	// The logger writer interface to write logging messages to.
                                                                                	Logger logging.Logger
                                                                                
                                                                                	// The region to send requests to. (Required)
                                                                                	Region string
                                                                                
                                                                                	// Retryer guides how HTTP requests should be retried in case of recoverable
                                                                                	// failures. When nil the API client will use a default retryer.
                                                                                	Retryer aws.Retryer
                                                                                
                                                                                	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
                                                                                	// implementation if nil.
                                                                                	HTTPClient HTTPClient
                                                                                }

                                                                                func (Options) Copy

                                                                                func (o Options) Copy() Options

                                                                                  Copy creates a clone where the APIOptions list is deep copied.

                                                                                  type PutGroupConfigurationInput

                                                                                  type PutGroupConfigurationInput struct {
                                                                                  
                                                                                  	// The new configuration to associate with the specified group. A configuration
                                                                                  	// associates the resource group with an AWS service and specifies how the service
                                                                                  	// can interact with the resources in the group. A configuration is an array of
                                                                                  	// GroupConfigurationItem elements. For information about the syntax of a service
                                                                                  	// configuration, see Service configurations for resource groups
                                                                                  	// (https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html). A resource
                                                                                  	// group can contain either a Configuration or a ResourceQuery, but not both.
                                                                                  	Configuration []types.GroupConfigurationItem
                                                                                  
                                                                                  	// The name or ARN of the resource group with the configuration that you want to
                                                                                  	// update.
                                                                                  	Group *string
                                                                                  }

                                                                                  type PutGroupConfigurationOutput

                                                                                  type PutGroupConfigurationOutput struct {
                                                                                  	// Metadata pertaining to the operation's result.
                                                                                  	ResultMetadata middleware.Metadata
                                                                                  }

                                                                                  type ResolveEndpoint

                                                                                  type ResolveEndpoint struct {
                                                                                  	Resolver EndpointResolver
                                                                                  	Options  EndpointResolverOptions
                                                                                  }

                                                                                  func (*ResolveEndpoint) HandleSerialize

                                                                                  func (*ResolveEndpoint) ID

                                                                                  func (*ResolveEndpoint) ID() string

                                                                                  type SearchResourcesAPIClient

                                                                                  type SearchResourcesAPIClient interface {
                                                                                  	SearchResources(context.Context, *SearchResourcesInput, ...func(*Options)) (*SearchResourcesOutput, error)
                                                                                  }

                                                                                    SearchResourcesAPIClient is a client that implements the SearchResources operation.

                                                                                    type SearchResourcesInput

                                                                                    type SearchResourcesInput struct {
                                                                                    
                                                                                    	// The search query, using the same formats that are supported for resource group
                                                                                    	// definition. For more information, see CreateGroup.
                                                                                    	//
                                                                                    	// This member is required.
                                                                                    	ResourceQuery *types.ResourceQuery
                                                                                    
                                                                                    	// The total number of results that you want included on each page of the response.
                                                                                    	// If you do not include this parameter, it defaults to a value that is specific to
                                                                                    	// the operation. If additional items exist beyond the maximum you specify, the
                                                                                    	// NextToken response element is present and has a value (is not null). Include
                                                                                    	// that value as the NextToken request parameter in the next call to the operation
                                                                                    	// to get the next part of the results. Note that the service might return fewer
                                                                                    	// results than the maximum even when there are more results available. You should
                                                                                    	// check NextToken after every operation to ensure that you receive all of the
                                                                                    	// results.
                                                                                    	MaxResults *int32
                                                                                    
                                                                                    	// The parameter for receiving additional results if you receive a NextToken
                                                                                    	// response in a previous request. A NextToken response indicates that more output
                                                                                    	// is available. Set this parameter to the value provided by a previous call's
                                                                                    	// NextToken response to indicate where the output should continue from.
                                                                                    	NextToken *string
                                                                                    }

                                                                                    type SearchResourcesOutput

                                                                                    type SearchResourcesOutput struct {
                                                                                    
                                                                                    	// If present, indicates that more output is available than is included in the
                                                                                    	// current response. Use this value in the NextToken request parameter in a
                                                                                    	// subsequent call to the operation to get the next part of the output. You should
                                                                                    	// repeat this until the NextToken response element comes back as null.
                                                                                    	NextToken *string
                                                                                    
                                                                                    	// A list of QueryError objects. Each error is an object that contains ErrorCode
                                                                                    	// and Message structures. Possible values for ErrorCode are
                                                                                    	// CLOUDFORMATION_STACK_INACTIVE and CLOUDFORMATION_STACK_NOT_EXISTING.
                                                                                    	QueryErrors []types.QueryError
                                                                                    
                                                                                    	// The ARNs and resource types of resources that are members of the group that you
                                                                                    	// specified.
                                                                                    	ResourceIdentifiers []types.ResourceIdentifier
                                                                                    
                                                                                    	// Metadata pertaining to the operation's result.
                                                                                    	ResultMetadata middleware.Metadata
                                                                                    }

                                                                                    type SearchResourcesPaginator

                                                                                    type SearchResourcesPaginator struct {
                                                                                    	// contains filtered or unexported fields
                                                                                    }

                                                                                      SearchResourcesPaginator is a paginator for SearchResources

                                                                                      func NewSearchResourcesPaginator

                                                                                      func NewSearchResourcesPaginator(client SearchResourcesAPIClient, params *SearchResourcesInput, optFns ...func(*SearchResourcesPaginatorOptions)) *SearchResourcesPaginator

                                                                                        NewSearchResourcesPaginator returns a new SearchResourcesPaginator

                                                                                        func (*SearchResourcesPaginator) HasMorePages

                                                                                        func (p *SearchResourcesPaginator) HasMorePages() bool

                                                                                          HasMorePages returns a boolean indicating whether more pages are available

                                                                                          func (*SearchResourcesPaginator) NextPage

                                                                                          func (p *SearchResourcesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*SearchResourcesOutput, error)

                                                                                            NextPage retrieves the next SearchResources page.

                                                                                            type SearchResourcesPaginatorOptions

                                                                                            type SearchResourcesPaginatorOptions struct {
                                                                                            	// The total number of results that you want included on each page of the response.
                                                                                            	// If you do not include this parameter, it defaults to a value that is specific to
                                                                                            	// the operation. If additional items exist beyond the maximum you specify, the
                                                                                            	// NextToken response element is present and has a value (is not null). Include
                                                                                            	// that value as the NextToken request parameter in the next call to the operation
                                                                                            	// to get the next part of the results. Note that the service might return fewer
                                                                                            	// results than the maximum even when there are more results available. You should
                                                                                            	// check NextToken after every operation to ensure that you receive all of the
                                                                                            	// results.
                                                                                            	Limit int32
                                                                                            
                                                                                            	// Set to true if pagination should stop if the service returns a pagination token
                                                                                            	// that matches the most recent token provided to the service.
                                                                                            	StopOnDuplicateToken bool
                                                                                            }

                                                                                              SearchResourcesPaginatorOptions is the paginator options for SearchResources

                                                                                              type TagInput

                                                                                              type TagInput struct {
                                                                                              
                                                                                              	// The ARN of the resource group to which to add tags.
                                                                                              	//
                                                                                              	// This member is required.
                                                                                              	Arn *string
                                                                                              
                                                                                              	// The tags to add to the specified resource group. A tag is a string-to-string map
                                                                                              	// of key-value pairs.
                                                                                              	//
                                                                                              	// This member is required.
                                                                                              	Tags map[string]string
                                                                                              }

                                                                                              type TagOutput

                                                                                              type TagOutput struct {
                                                                                              
                                                                                              	// The ARN of the tagged resource.
                                                                                              	Arn *string
                                                                                              
                                                                                              	// The tags that have been added to the specified resource group.
                                                                                              	Tags map[string]string
                                                                                              
                                                                                              	// Metadata pertaining to the operation's result.
                                                                                              	ResultMetadata middleware.Metadata
                                                                                              }

                                                                                              type UngroupResourcesInput

                                                                                              type UngroupResourcesInput struct {
                                                                                              
                                                                                              	// The name or the ARN of the resource group from which to remove the resources.
                                                                                              	//
                                                                                              	// This member is required.
                                                                                              	Group *string
                                                                                              
                                                                                              	// The ARNs of the resources to be removed from the group.
                                                                                              	//
                                                                                              	// This member is required.
                                                                                              	ResourceArns []string
                                                                                              }

                                                                                              type UngroupResourcesOutput

                                                                                              type UngroupResourcesOutput struct {
                                                                                              
                                                                                              	// A list of any resources that failed to be removed from the group by this
                                                                                              	// operation.
                                                                                              	Failed []types.FailedResource
                                                                                              
                                                                                              	// A list of any resources that are still in the process of being removed from the
                                                                                              	// group by this operation. These pending removals continue asynchronously. You can
                                                                                              	// check the status of pending removals by using the ListGroupResources operation.
                                                                                              	// After the resource is successfully removed, it no longer appears in the
                                                                                              	// response.
                                                                                              	Pending []types.PendingResource
                                                                                              
                                                                                              	// A list of resources that were successfully removed from the group by this
                                                                                              	// operation.
                                                                                              	Succeeded []string
                                                                                              
                                                                                              	// Metadata pertaining to the operation's result.
                                                                                              	ResultMetadata middleware.Metadata
                                                                                              }

                                                                                              type UntagInput

                                                                                              type UntagInput struct {
                                                                                              
                                                                                              	// The ARN of the resource group from which to remove tags. The command removed
                                                                                              	// both the specified keys and any values associated with those keys.
                                                                                              	//
                                                                                              	// This member is required.
                                                                                              	Arn *string
                                                                                              
                                                                                              	// The keys of the tags to be removed.
                                                                                              	//
                                                                                              	// This member is required.
                                                                                              	Keys []string
                                                                                              }

                                                                                              type UntagOutput

                                                                                              type UntagOutput struct {
                                                                                              
                                                                                              	// The ARN of the resource group from which tags have been removed.
                                                                                              	Arn *string
                                                                                              
                                                                                              	// The keys of the tags that were removed.
                                                                                              	Keys []string
                                                                                              
                                                                                              	// Metadata pertaining to the operation's result.
                                                                                              	ResultMetadata middleware.Metadata
                                                                                              }

                                                                                              type UpdateGroupInput

                                                                                              type UpdateGroupInput struct {
                                                                                              
                                                                                              	// The new description that you want to update the resource group with.
                                                                                              	// Descriptions can contain letters, numbers, hyphens, underscores, periods, and
                                                                                              	// spaces.
                                                                                              	Description *string
                                                                                              
                                                                                              	// The name or the ARN of the resource group to modify.
                                                                                              	Group *string
                                                                                              
                                                                                              	// Don't use this parameter. Use Group instead.
                                                                                              	//
                                                                                              	// Deprecated: This field is deprecated, use Group instead.
                                                                                              	GroupName *string
                                                                                              }

                                                                                              type UpdateGroupOutput

                                                                                              type UpdateGroupOutput struct {
                                                                                              
                                                                                              	// The update description of the resource group.
                                                                                              	Group *types.Group
                                                                                              
                                                                                              	// Metadata pertaining to the operation's result.
                                                                                              	ResultMetadata middleware.Metadata
                                                                                              }

                                                                                              type UpdateGroupQueryInput

                                                                                              type UpdateGroupQueryInput struct {
                                                                                              
                                                                                              	// The resource query to determine which AWS resources are members of this resource
                                                                                              	// group. A resource group can contain either a Configuration or a ResourceQuery,
                                                                                              	// but not both.
                                                                                              	//
                                                                                              	// This member is required.
                                                                                              	ResourceQuery *types.ResourceQuery
                                                                                              
                                                                                              	// The name or the ARN of the resource group to query.
                                                                                              	Group *string
                                                                                              
                                                                                              	// Don't use this parameter. Use Group instead.
                                                                                              	//
                                                                                              	// Deprecated: This field is deprecated, use Group instead.
                                                                                              	GroupName *string
                                                                                              }

                                                                                              type UpdateGroupQueryOutput

                                                                                              type UpdateGroupQueryOutput struct {
                                                                                              
                                                                                              	// The updated resource query associated with the resource group after the update.
                                                                                              	GroupQuery *types.GroupQuery
                                                                                              
                                                                                              	// Metadata pertaining to the operation's result.
                                                                                              	ResultMetadata middleware.Metadata
                                                                                              }

                                                                                              Directories

                                                                                              Path Synopsis
                                                                                              internal