Table of Contents
ResourceGroups.Client¶A low-level client representing AWS Resource Groups
Resource Groups lets you organize Amazon Web Services resources such as Amazon Elastic Compute Cloud instances, Amazon Relational Database Service databases, and Amazon Simple Storage Service 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 Amazon Web Services Systems Manager Automation documents, on tag-related resources in Amazon Web Services Systems Manager. Groups of tagged resources also let you quickly view a custom console in Amazon Web Services Systems Manager that shows 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 Resource Groups User Guide.
Resource Groups uses a REST-compliant API that you can use to perform the following types of operations.
import boto3
client = boto3.client('resource-groups')
These are the available methods:
can_paginate()close()create_group()delete_group()get_account_settings()get_group()get_group_configuration()get_group_query()get_paginator()get_tags()get_waiter()group_resources()list_group_resources()list_groups()put_group_configuration()search_resources()tag()ungroup_resources()untag()update_account_settings()update_group()update_group_query()can_paginate(operation_name)¶Check if an operation can be paginated.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").True if the operation can be paginated,
False otherwise.close()¶Closes underlying endpoint connections.
create_group(**kwargs)¶Creates a resource group with the specified name and description. You can optionally include either a resource query or a service configuration. For more information about constructing a resource query, see Build queries and groups in Resource Groups in the Resource Groups User Guide . For more information about service-linked groups and service configurations, see Service configurations for Resource Groups.
Minimum permissions
To run this command, you must have the following permissions:
resource-groups:CreateGroupSee also: AWS API Documentation
Request Syntax
response = client.create_group(
Name='string',
Description='string',
ResourceQuery={
'Type': 'TAG_FILTERS_1_0'|'CLOUDFORMATION_STACK_1_0',
'Query': 'string'
},
Tags={
'string': 'string'
},
Configuration=[
{
'Type': 'string',
'Parameters': [
{
'Name': 'string',
'Values': [
'string',
]
},
]
},
]
)
[REQUIRED]
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 Amazon Web Services Region in your Amazon Web Services account.
The resource query that determines which Amazon Web Services resources are members of this group. For more information about resource queries, see Create a tag-based group in Resource Groups.
Note
A resource group can contain either a ResourceQuery or a Configuration , but not both.
The type of the query to perform. This can have one of two values:
CLOUDFORMATION_STACK_1_0: Specifies that you want the group to contain the members of an CloudFormation stack. The Query contains a StackIdentifier element with an ARN for a CloudFormation stack.TAG_FILTERS_1_0: Specifies that you want the group to include resource that have tags that match the query.The query that defines a group or a search. The contents depends on the value of the Type element.
ResourceTypeFilters – Applies to all ResourceQuery objects of either Type . This element contains one of the following two items:AWS::AllSupported . This causes the ResourceQuery to match resources of any resource type that also match the query.ResourceTypeFilters , see Resources you can use with Resource Groups and Tag Editor in the Resource Groups User Guide .Example: "ResourceTypeFilters": ["AWS::AllSupported"] or "ResourceTypeFilters": ["AWS::EC2::Instance", "AWS::S3::Bucket"]
TagFilters – applicable only if Type = TAG_FILTERS_1_0 . The Query contains a JSON string that represents a collection of simple tag filters. The JSON string uses a syntax similar to the GetResources operation, but uses only the ResourceTypeFilters and TagFilters fields. If you specify more than one tag key, only resources that match all tag keys, and at least one value of each specified tag key, are returned in your query. If you specify more than one value for a tag key, a resource matches the filter if it has a tag key value that matches any of the specified values. For example, consider the following sample query for resources that have two tags, Stage and Version , with two values each: [{"Stage":["Test","Deploy"]},{"Version":["1","2"]}] The results of this resource query could include the following.{"Stage":"Deploy"} , and {"Version":"2"}{"Stage":"Test"} , and {"Version":"1"}The resource query results would not include the following items in the results, however.
- An Amazon EC2 instance that has only the following tag:
{"Stage":"Deploy"}. The instance does not have all of the tag keys specified in the filter, so it is excluded from the results.- An RDS database that has the following two tags:
{"Stage":"Archived"}and{"Version":"4"}The database has all of the tag keys, but none of those keys has an associated value that matches at least one of the specified values in the filter.
Example: "TagFilters": [ { "Key": "Stage", "Values": [ "Gamma", "Beta" ] }
StackIdentifier – applicable only if Type = CLOUDFORMATION_STACK_1_0 . The value of this parameter is the Amazon Resource Name (ARN) of the CloudFormation stack whose resources you want included in the group.The tags to add to the group. A tag is key-value pair string.
A configuration associates the resource group with an Amazon Web Services 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.
Note
A resource group can contain either a Configuration or a ResourceQuery , but not both.
An item in a group configuration. A group service configuration can have one or more items. For details about group service configuration syntax, see Service configurations for resource groups.
Specifies the type of group configuration item. Each item must have a unique value for type . For the list of types that you can specify for a configuration item, see Supported resource types and parameters.
A collection of parameters for this group configuration item. For the list of parameters that you can use with each configuration item type, see Supported resource types and parameters.
A parameter for a group configuration item. For details about group service configuration syntax, see Service configurations for resource groups.
The name of the group configuration parameter. For the list of parameters that you can use with each configuration item type, see Supported resource types and parameters.
The value or values to be used for the specified parameter. For the list of values you can use with each parameter, see Supported resource types and parameters.
dict
Response Syntax
{
'Group': {
'GroupArn': 'string',
'Name': 'string',
'Description': 'string'
},
'ResourceQuery': {
'Type': 'TAG_FILTERS_1_0'|'CLOUDFORMATION_STACK_1_0',
'Query': 'string'
},
'Tags': {
'string': 'string'
},
'GroupConfiguration': {
'Configuration': [
{
'Type': 'string',
'Parameters': [
{
'Name': 'string',
'Values': [
'string',
]
},
]
},
],
'ProposedConfiguration': [
{
'Type': 'string',
'Parameters': [
{
'Name': 'string',
'Values': [
'string',
]
},
]
},
],
'Status': 'UPDATING'|'UPDATE_COMPLETE'|'UPDATE_FAILED',
'FailureReason': 'string'
}
}
Response Structure
(dict) --
Group (dict) --
The description of the resource group.
GroupArn (string) --
The ARN of the resource group.
Name (string) --
The name of the resource group.
Description (string) --
The description of the resource group.
ResourceQuery (dict) --
The resource query associated with the group. For more information about resource queries, see Create a tag-based group in Resource Groups.
Type (string) --
The type of the query to perform. This can have one of two values:
CLOUDFORMATION_STACK_1_0: Specifies that you want the group to contain the members of an CloudFormation stack. The Query contains a StackIdentifier element with an ARN for a CloudFormation stack.TAG_FILTERS_1_0: Specifies that you want the group to include resource that have tags that match the query.Query (string) --
The query that defines a group or a search. The contents depends on the value of the Type element.
ResourceTypeFilters – Applies to all ResourceQuery objects of either Type . This element contains one of the following two items:AWS::AllSupported . This causes the ResourceQuery to match resources of any resource type that also match the query.ResourceTypeFilters , see Resources you can use with Resource Groups and Tag Editor in the Resource Groups User Guide .Example: "ResourceTypeFilters": ["AWS::AllSupported"] or "ResourceTypeFilters": ["AWS::EC2::Instance", "AWS::S3::Bucket"]
TagFilters – applicable only if Type = TAG_FILTERS_1_0 . The Query contains a JSON string that represents a collection of simple tag filters. The JSON string uses a syntax similar to the GetResources operation, but uses only the ResourceTypeFilters and TagFilters fields. If you specify more than one tag key, only resources that match all tag keys, and at least one value of each specified tag key, are returned in your query. If you specify more than one value for a tag key, a resource matches the filter if it has a tag key value that matches any of the specified values. For example, consider the following sample query for resources that have two tags, Stage and Version , with two values each: [{"Stage":["Test","Deploy"]},{"Version":["1","2"]}] The results of this resource query could include the following.{"Stage":"Deploy"} , and {"Version":"2"}{"Stage":"Test"} , and {"Version":"1"}The resource query results would not include the following items in the results, however.
- An Amazon EC2 instance that has only the following tag:
{"Stage":"Deploy"}. The instance does not have all of the tag keys specified in the filter, so it is excluded from the results.- An RDS database that has the following two tags:
{"Stage":"Archived"}and{"Version":"4"}The database has all of the tag keys, but none of those keys has an associated value that matches at least one of the specified values in the filter.
Example: "TagFilters": [ { "Key": "Stage", "Values": [ "Gamma", "Beta" ] }
StackIdentifier – applicable only if Type = CLOUDFORMATION_STACK_1_0 . The value of this parameter is the Amazon Resource Name (ARN) of the CloudFormation stack whose resources you want included in the group.Tags (dict) --
The tags associated with the group.
GroupConfiguration (dict) --
The service configuration associated with the resource group. For details about the syntax of a service configuration, see Service configurations for Resource Groups.
Configuration (list) --
The configuration currently associated with the group and in effect.
(dict) --
An item in a group configuration. A group service configuration can have one or more items. For details about group service configuration syntax, see Service configurations for resource groups.
Type (string) --
Specifies the type of group configuration item. Each item must have a unique value for type . For the list of types that you can specify for a configuration item, see Supported resource types and parameters.
Parameters (list) --
A collection of parameters for this group configuration item. For the list of parameters that you can use with each configuration item type, see Supported resource types and parameters.
(dict) --
A parameter for a group configuration item. For details about group service configuration syntax, see Service configurations for resource groups.
Name (string) --
The name of the group configuration parameter. For the list of parameters that you can use with each configuration item type, see Supported resource types and parameters.
Values (list) --
The value or values to be used for the specified parameter. For the list of values you can use with each parameter, see Supported resource types and parameters.
ProposedConfiguration (list) --
If present, the new configuration that is in the process of being applied to the group.
(dict) --
An item in a group configuration. A group service configuration can have one or more items. For details about group service configuration syntax, see Service configurations for resource groups.
Type (string) --
Specifies the type of group configuration item. Each item must have a unique value for type . For the list of types that you can specify for a configuration item, see Supported resource types and parameters.
Parameters (list) --
A collection of parameters for this group configuration item. For the list of parameters that you can use with each configuration item type, see Supported resource types and parameters.
(dict) --
A parameter for a group configuration item. For details about group service configuration syntax, see Service configurations for resource groups.
Name (string) --
The name of the group configuration parameter. For the list of parameters that you can use with each configuration item type, see Supported resource types and parameters.
Values (list) --
The value or values to be used for the specified parameter. For the list of values you can use with each parameter, see Supported resource types and parameters.
Status (string) --
The current status of an attempt to update the group configuration.
FailureReason (string) --
If present, the reason why a request to update the group configuration failed.
Exceptions
ResourceGroups.Client.exceptions.BadRequestExceptionResourceGroups.Client.exceptions.ForbiddenExceptionResourceGroups.Client.exceptions.MethodNotAllowedExceptionResourceGroups.Client.exceptions.TooManyRequestsExceptionResourceGroups.Client.exceptions.InternalServerErrorExceptiondelete_group(**kwargs)¶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:DeleteGroupSee also: AWS API Documentation
Request Syntax
response = client.delete_group(
GroupName='string',
Group='string'
)
Group instead.dict
Response Syntax
{
'Group': {
'GroupArn': 'string',
'Name': 'string',
'Description': 'string'
}
}
Response Structure
(dict) --
Group (dict) --
A full description of the deleted resource group.
GroupArn (string) --
The ARN of the resource group.
Name (string) --
The name of the resource group.
Description (string) --
The description of the resource group.
Exceptions
ResourceGroups.Client.exceptions.BadRequestExceptionResourceGroups.Client.exceptions.ForbiddenExceptionResourceGroups.Client.exceptions.NotFoundExceptionResourceGroups.Client.exceptions.MethodNotAllowedExceptionResourceGroups.Client.exceptions.TooManyRequestsExceptionResourceGroups.Client.exceptions.InternalServerErrorExceptionget_account_settings()¶Retrieves the current status of optional features in Resource Groups.
See also: AWS API Documentation
Request Syntax
response = client.get_account_settings()
{
'AccountSettings': {
'GroupLifecycleEventsDesiredStatus': 'ACTIVE'|'INACTIVE',
'GroupLifecycleEventsStatus': 'ACTIVE'|'INACTIVE'|'IN_PROGRESS'|'ERROR',
'GroupLifecycleEventsStatusMessage': 'string'
}
}
Response Structure
The current settings for the optional features in Resource Groups.
The desired target status of the group lifecycle events feature. If
The current status of the group lifecycle events feature.
The text of any error message occurs during an attempt to turn group lifecycle events on or off.
Exceptions
ResourceGroups.Client.exceptions.BadRequestExceptionResourceGroups.Client.exceptions.ForbiddenExceptionResourceGroups.Client.exceptions.MethodNotAllowedExceptionResourceGroups.Client.exceptions.TooManyRequestsExceptionResourceGroups.Client.exceptions.InternalServerErrorExceptionget_group(**kwargs)¶Returns information about a specified resource group.
Minimum permissions
To run this command, you must have the following permissions:
resource-groups:GetGroupSee also: AWS API Documentation
Request Syntax
response = client.get_group(
GroupName='string',
Group='string'
)
Group instead.dict
Response Syntax
{
'Group': {
'GroupArn': 'string',
'Name': 'string',
'Description': 'string'
}
}
Response Structure
(dict) --
Group (dict) --
A structure that contains the metadata details for the specified resource group. Use GetGroupQuery and GetGroupConfiguration to get those additional details of the resource group.
GroupArn (string) --
The ARN of the resource group.
Name (string) --
The name of the resource group.
Description (string) --
The description of the resource group.
Exceptions
ResourceGroups.Client.exceptions.BadRequestExceptionResourceGroups.Client.exceptions.ForbiddenExceptionResourceGroups.Client.exceptions.NotFoundExceptionResourceGroups.Client.exceptions.MethodNotAllowedExceptionResourceGroups.Client.exceptions.TooManyRequestsExceptionResourceGroups.Client.exceptions.InternalServerErrorExceptionget_group_configuration(**kwargs)¶Retrieves the service configuration associated with the specified resource group. For details about the service configuration syntax, see Service configurations for Resource Groups.
Minimum permissions
To run this command, you must have the following permissions:
resource-groups:GetGroupConfigurationSee also: AWS API Documentation
Request Syntax
response = client.get_group_configuration(
Group='string'
)
{
'GroupConfiguration': {
'Configuration': [
{
'Type': 'string',
'Parameters': [
{
'Name': 'string',
'Values': [
'string',
]
},
]
},
],
'ProposedConfiguration': [
{
'Type': 'string',
'Parameters': [
{
'Name': 'string',
'Values': [
'string',
]
},
]
},
],
'Status': 'UPDATING'|'UPDATE_COMPLETE'|'UPDATE_FAILED',
'FailureReason': 'string'
}
}
Response Structure
A structure that describes the service configuration attached with the specified group. For details about the service configuration syntax, see Service configurations for Resource Groups.
The configuration currently associated with the group and in effect.
An item in a group configuration. A group service configuration can have one or more items. For details about group service configuration syntax, see Service configurations for resource groups.
Specifies the type of group configuration item. Each item must have a unique value for type . For the list of types that you can specify for a configuration item, see Supported resource types and parameters.
A collection of parameters for this group configuration item. For the list of parameters that you can use with each configuration item type, see Supported resource types and parameters.
A parameter for a group configuration item. For details about group service configuration syntax, see Service configurations for resource groups.
The name of the group configuration parameter. For the list of parameters that you can use with each configuration item type, see Supported resource types and parameters.
The value or values to be used for the specified parameter. For the list of values you can use with each parameter, see Supported resource types and parameters.
If present, the new configuration that is in the process of being applied to the group.
An item in a group configuration. A group service configuration can have one or more items. For details about group service configuration syntax, see Service configurations for resource groups.
Specifies the type of group configuration item. Each item must have a unique value for type . For the list of types that you can specify for a configuration item, see Supported resource types and parameters.
A collection of parameters for this group configuration item. For the list of parameters that you can use with each configuration item type, see Supported resource types and parameters.
A parameter for a group configuration item. For details about group service configuration syntax, see Service configurations for resource groups.
The name of the group configuration parameter. For the list of parameters that you can use with each configuration item type, see Supported resource types and parameters.
The value or values to be used for the specified parameter. For the list of values you can use with each parameter, see Supported resource types and parameters.
The current status of an attempt to update the group configuration.
If present, the reason why a request to update the group configuration failed.
Exceptions
ResourceGroups.Client.exceptions.BadRequestExceptionResourceGroups.Client.exceptions.ForbiddenExceptionResourceGroups.Client.exceptions.NotFoundExceptionResourceGroups.Client.exceptions.MethodNotAllowedExceptionResourceGroups.Client.exceptions.TooManyRequestsExceptionResourceGroups.Client.exceptions.InternalServerErrorExceptionget_group_query(**kwargs)¶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.
Minimum permissions
To run this command, you must have the following permissions:
resource-groups:GetGroupQuerySee also: AWS API Documentation
Request Syntax
response = client.get_group_query(
GroupName='string',
Group='string'
)
Group instead.dict
Response Syntax
{
'GroupQuery': {
'GroupName': 'string',
'ResourceQuery': {
'Type': 'TAG_FILTERS_1_0'|'CLOUDFORMATION_STACK_1_0',
'Query': 'string'
}
}
}
Response Structure
(dict) --
GroupQuery (dict) --
The resource query associated with the specified group. For more information about resource queries, see Create a tag-based group in Resource Groups.
GroupName (string) --
The name of the resource group that is associated with the specified resource query.
ResourceQuery (dict) --
The resource query that determines which Amazon Web Services resources are members of the associated resource group.
Type (string) --
The type of the query to perform. This can have one of two values:
CLOUDFORMATION_STACK_1_0: Specifies that you want the group to contain the members of an CloudFormation stack. The Query contains a StackIdentifier element with an ARN for a CloudFormation stack.TAG_FILTERS_1_0: Specifies that you want the group to include resource that have tags that match the query.Query (string) --
The query that defines a group or a search. The contents depends on the value of the Type element.
ResourceTypeFilters – Applies to all ResourceQuery objects of either Type . This element contains one of the following two items:AWS::AllSupported . This causes the ResourceQuery to match resources of any resource type that also match the query.ResourceTypeFilters , see Resources you can use with Resource Groups and Tag Editor in the Resource Groups User Guide .Example: "ResourceTypeFilters": ["AWS::AllSupported"] or "ResourceTypeFilters": ["AWS::EC2::Instance", "AWS::S3::Bucket"]
TagFilters – applicable only if Type = TAG_FILTERS_1_0 . The Query contains a JSON string that represents a collection of simple tag filters. The JSON string uses a syntax similar to the GetResources operation, but uses only the ResourceTypeFilters and TagFilters fields. If you specify more than one tag key, only resources that match all tag keys, and at least one value of each specified tag key, are returned in your query. If you specify more than one value for a tag key, a resource matches the filter if it has a tag key value that matches any of the specified values. For example, consider the following sample query for resources that have two tags, Stage and Version , with two values each: [{"Stage":["Test","Deploy"]},{"Version":["1","2"]}] The results of this resource query could include the following.{"Stage":"Deploy"} , and {"Version":"2"}{"Stage":"Test"} , and {"Version":"1"}The resource query results would not include the following items in the results, however.
- An Amazon EC2 instance that has only the following tag:
{"Stage":"Deploy"}. The instance does not have all of the tag keys specified in the filter, so it is excluded from the results.- An RDS database that has the following two tags:
{"Stage":"Archived"}and{"Version":"4"}The database has all of the tag keys, but none of those keys has an associated value that matches at least one of the specified values in the filter.
Example: "TagFilters": [ { "Key": "Stage", "Values": [ "Gamma", "Beta" ] }
StackIdentifier – applicable only if Type = CLOUDFORMATION_STACK_1_0 . The value of this parameter is the Amazon Resource Name (ARN) of the CloudFormation stack whose resources you want included in the group.Exceptions
ResourceGroups.Client.exceptions.BadRequestExceptionResourceGroups.Client.exceptions.ForbiddenExceptionResourceGroups.Client.exceptions.NotFoundExceptionResourceGroups.Client.exceptions.MethodNotAllowedExceptionResourceGroups.Client.exceptions.TooManyRequestsExceptionResourceGroups.Client.exceptions.InternalServerErrorExceptionget_paginator(operation_name)¶Create a paginator for an operation.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").client.can_paginate method to
check if an operation is pageable.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:GetTagsSee also: AWS API Documentation
Request Syntax
response = client.get_tags(
Arn='string'
)
[REQUIRED]
The ARN of the resource group whose tags you want to retrieve.
{
'Arn': 'string',
'Tags': {
'string': 'string'
}
}
Response Structure
The ARN of the tagged resource group.
The tags associated with the specified resource group.
Exceptions
ResourceGroups.Client.exceptions.BadRequestExceptionResourceGroups.Client.exceptions.ForbiddenExceptionResourceGroups.Client.exceptions.NotFoundExceptionResourceGroups.Client.exceptions.MethodNotAllowedExceptionResourceGroups.Client.exceptions.TooManyRequestsExceptionResourceGroups.Client.exceptions.InternalServerErrorExceptionget_waiter(waiter_name)¶Returns an object that can wait for some condition.
group_resources(**kwargs)¶Adds the specified resources to the specified group.
Warning
You can use this operation with only resource groups that are configured with the following types:
AWS::EC2::HostManagementAWS::EC2::CapacityReservationPoolOther resource group type and resource types aren't currently supported by this operation.
Minimum permissions
To run this command, you must have the following permissions:
resource-groups:GroupResourcesSee also: AWS API Documentation
Request Syntax
response = client.group_resources(
Group='string',
ResourceArns=[
'string',
]
)
[REQUIRED]
The name or the ARN of the resource group to add resources to.
[REQUIRED]
The list of ARNs of the resources to be added to the group.
dict
Response Syntax
{
'Succeeded': [
'string',
],
'Failed': [
{
'ResourceArn': 'string',
'ErrorMessage': 'string',
'ErrorCode': 'string'
},
],
'Pending': [
{
'ResourceArn': 'string'
},
]
}
Response Structure
(dict) --
Succeeded (list) --
A list of ARNs of the resources that this operation successfully added to the group.
Failed (list) --
A list of ARNs of any resources that this operation failed to add to the group.
(dict) --
A resource that failed to be added to or removed from a group.
ResourceArn (string) --
The ARN of the resource that failed to be added or removed.
ErrorMessage (string) --
The error message text associated with the failure.
ErrorCode (string) --
The error code associated with the failure.
Pending (list) --
A list of ARNs of any resources that this operation is still in the process adding to the group. 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.
(dict) --
A structure that identifies a resource that is currently pending addition to the group as a member. Adding a resource to a resource group happens asynchronously as a background task and this one isn't completed yet.
ResourceArn (string) --
The Amazon resource name (ARN) of the resource that's in a pending state.
Exceptions
ResourceGroups.Client.exceptions.BadRequestExceptionResourceGroups.Client.exceptions.ForbiddenExceptionResourceGroups.Client.exceptions.NotFoundExceptionResourceGroups.Client.exceptions.MethodNotAllowedExceptionResourceGroups.Client.exceptions.TooManyRequestsExceptionResourceGroups.Client.exceptions.InternalServerErrorExceptionlist_group_resources(**kwargs)¶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:ListGroupResourcescloudformation:DescribeStackscloudformation:ListStackResourcestag:GetResourcesSee also: AWS API Documentation
Request Syntax
response = client.list_group_resources(
GroupName='string',
Group='string',
Filters=[
{
'Name': 'resource-type',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string'
)
Warning
Deprecated - don't use this parameter. Use the Group request field instead.
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 , 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 Amazon CloudFront stack-based queries).
A filter name and value pair that is used to obtain more specific results from a list of resources.
The name of the filter. Filter names are case-sensitive.
One or more filter values. Allowed filter values vary by resource filter name, and are case-sensitive.
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.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.dict
Response Syntax
{
'Resources': [
{
'Identifier': {
'ResourceArn': 'string',
'ResourceType': 'string'
},
'Status': {
'Name': 'PENDING'
}
},
],
'ResourceIdentifiers': [
{
'ResourceArn': 'string',
'ResourceType': 'string'
},
],
'NextToken': 'string',
'QueryErrors': [
{
'ErrorCode': 'CLOUDFORMATION_STACK_INACTIVE'|'CLOUDFORMATION_STACK_NOT_EXISTING'|'CLOUDFORMATION_STACK_UNASSUMABLE_ROLE',
'Message': 'string'
},
]
}
Response Structure
(dict) --
Resources (list) --
An array of resources from which you can determine each resource's identity, type, and group membership status.
(dict) --
A structure returned by the ListGroupResources operation that contains identity and group membership status information for one of the resources in the group.
Identifier (dict) --
A structure that contains the ARN of a resource and its resource type.
ResourceArn (string) --
The ARN of a resource.
ResourceType (string) --
The resource type of a resource, such as AWS::EC2::Instance .
Status (dict) --
A structure that contains the status of this resource's membership in the group.
Note
This field is present in the response only if the group is of type AWS::EC2::HostManagement .
Name (string) --
The current status.
ResourceIdentifiers (list) --
Warning
Deprecated - don't use this parameter. Use the Resources response field instead.
(dict) --
A structure that contains the ARN of a resource and its resource type.
ResourceArn (string) --
The ARN of a resource.
ResourceType (string) --
The resource type of a resource, such as AWS::EC2::Instance .
NextToken (string) --
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 .
QueryErrors (list) --
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 .
(dict) --
A two-part error structure that can occur in ListGroupResources or SearchResources operations on CloudFront stack-based queries. The error occurs if the CloudFront stack on which the query is based either does not exist, or has a status that renders the stack inactive. A QueryError occurrence does not necessarily mean that Resource Groups could not complete the operation, but the resulting group might have no member resources.
ErrorCode (string) --
Specifies the error code that was raised.
Message (string) --
A message that explains the ErrorCode value. Messages might state that the specified CloudFront stack does not exist (or no longer exists). For CLOUDFORMATION_STACK_INACTIVE , the message typically states that the CloudFront stack has a status that is not (or no longer) active, such as CREATE_FAILED .
Exceptions
ResourceGroups.Client.exceptions.UnauthorizedExceptionResourceGroups.Client.exceptions.BadRequestExceptionResourceGroups.Client.exceptions.ForbiddenExceptionResourceGroups.Client.exceptions.NotFoundExceptionResourceGroups.Client.exceptions.MethodNotAllowedExceptionResourceGroups.Client.exceptions.TooManyRequestsExceptionResourceGroups.Client.exceptions.InternalServerErrorExceptionlist_groups(**kwargs)¶Returns a list of existing Resource Groups in your account.
Minimum permissions
To run this command, you must have the following permissions:
resource-groups:ListGroupsSee also: AWS API Documentation
Request Syntax
response = client.list_groups(
Filters=[
{
'Name': 'resource-type'|'configuration-type',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string'
)
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::CapacityReservationPoolAWS::EC2::HostManagementA filter collection that you can use to restrict the results from a List operation to only those you want to include.
The name of the filter. Filter names are case-sensitive.
One or more filter values. Allowed filter values vary by group filter name, and are case-sensitive.
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.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.dict
Response Syntax
{
'GroupIdentifiers': [
{
'GroupName': 'string',
'GroupArn': 'string'
},
],
'Groups': [
{
'GroupArn': 'string',
'Name': 'string',
'Description': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
GroupIdentifiers (list) --
A list of GroupIdentifier objects. Each identifier is an object that contains both the Name and the GroupArn .
(dict) --
The unique identifiers for a resource group.
GroupName (string) --
The name of the resource group.
GroupArn (string) --
The ARN of the resource group.
Groups (list) --
Warning
Deprecated - don't use this field. Use the GroupIdentifiers response field instead.
(dict) --
A resource group that contains Amazon Web Services resources. You can assign resources to the group by associating either of the following elements with the group:
GroupArn (string) --
The ARN of the resource group.
Name (string) --
The name of the resource group.
Description (string) --
The description of the resource group.
NextToken (string) --
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 .
Exceptions
ResourceGroups.Client.exceptions.BadRequestExceptionResourceGroups.Client.exceptions.ForbiddenExceptionResourceGroups.Client.exceptions.MethodNotAllowedExceptionResourceGroups.Client.exceptions.TooManyRequestsExceptionResourceGroups.Client.exceptions.InternalServerErrorExceptionput_group_configuration(**kwargs)¶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:PutGroupConfigurationSee also: AWS API Documentation
Request Syntax
response = client.put_group_configuration(
Group='string',
Configuration=[
{
'Type': 'string',
'Parameters': [
{
'Name': 'string',
'Values': [
'string',
]
},
]
},
]
)
The new configuration to associate with the specified group. A configuration associates the resource group with an Amazon Web Services 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.
Note
A resource group can contain either a Configuration or a ResourceQuery , but not both.
An item in a group configuration. A group service configuration can have one or more items. For details about group service configuration syntax, see Service configurations for resource groups.
Specifies the type of group configuration item. Each item must have a unique value for type . For the list of types that you can specify for a configuration item, see Supported resource types and parameters.
A collection of parameters for this group configuration item. For the list of parameters that you can use with each configuration item type, see Supported resource types and parameters.
A parameter for a group configuration item. For details about group service configuration syntax, see Service configurations for resource groups.
The name of the group configuration parameter. For the list of parameters that you can use with each configuration item type, see Supported resource types and parameters.
The value or values to be used for the specified parameter. For the list of values you can use with each parameter, see Supported resource types and parameters.
dict
Response Syntax
{}
Response Structure
Exceptions
ResourceGroups.Client.exceptions.BadRequestExceptionResourceGroups.Client.exceptions.ForbiddenExceptionResourceGroups.Client.exceptions.NotFoundExceptionResourceGroups.Client.exceptions.MethodNotAllowedExceptionResourceGroups.Client.exceptions.TooManyRequestsExceptionResourceGroups.Client.exceptions.InternalServerErrorExceptionsearch_resources(**kwargs)¶Returns a list of Amazon Web Services 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:SearchResourcescloudformation:DescribeStackscloudformation:ListStackResourcestag:GetResourcesSee also: AWS API Documentation
Request Syntax
response = client.search_resources(
ResourceQuery={
'Type': 'TAG_FILTERS_1_0'|'CLOUDFORMATION_STACK_1_0',
'Query': 'string'
},
MaxResults=123,
NextToken='string'
)
[REQUIRED]
The search query, using the same formats that are supported for resource group definition. For more information, see CreateGroup.
The type of the query to perform. This can have one of two values:
CLOUDFORMATION_STACK_1_0: Specifies that you want the group to contain the members of an CloudFormation stack. The Query contains a StackIdentifier element with an ARN for a CloudFormation stack.TAG_FILTERS_1_0: Specifies that you want the group to include resource that have tags that match the query.The query that defines a group or a search. The contents depends on the value of the Type element.
ResourceTypeFilters – Applies to all ResourceQuery objects of either Type . This element contains one of the following two items:AWS::AllSupported . This causes the ResourceQuery to match resources of any resource type that also match the query.ResourceTypeFilters , see Resources you can use with Resource Groups and Tag Editor in the Resource Groups User Guide .Example: "ResourceTypeFilters": ["AWS::AllSupported"] or "ResourceTypeFilters": ["AWS::EC2::Instance", "AWS::S3::Bucket"]
TagFilters – applicable only if Type = TAG_FILTERS_1_0 . The Query contains a JSON string that represents a collection of simple tag filters. The JSON string uses a syntax similar to the GetResources operation, but uses only the ResourceTypeFilters and TagFilters fields. If you specify more than one tag key, only resources that match all tag keys, and at least one value of each specified tag key, are returned in your query. If you specify more than one value for a tag key, a resource matches the filter if it has a tag key value that matches any of the specified values. For example, consider the following sample query for resources that have two tags, Stage and Version , with two values each: [{"Stage":["Test","Deploy"]},{"Version":["1","2"]}] The results of this resource query could include the following.{"Stage":"Deploy"} , and {"Version":"2"}{"Stage":"Test"} , and {"Version":"1"}The resource query results would not include the following items in the results, however.
- An Amazon EC2 instance that has only the following tag:
{"Stage":"Deploy"}. The instance does not have all of the tag keys specified in the filter, so it is excluded from the results.- An RDS database that has the following two tags:
{"Stage":"Archived"}and{"Version":"4"}The database has all of the tag keys, but none of those keys has an associated value that matches at least one of the specified values in the filter.
Example: "TagFilters": [ { "Key": "Stage", "Values": [ "Gamma", "Beta" ] }
StackIdentifier – applicable only if Type = CLOUDFORMATION_STACK_1_0 . The value of this parameter is the Amazon Resource Name (ARN) of the CloudFormation stack whose resources you want included in the group.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.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.dict
Response Syntax
{
'ResourceIdentifiers': [
{
'ResourceArn': 'string',
'ResourceType': 'string'
},
],
'NextToken': 'string',
'QueryErrors': [
{
'ErrorCode': 'CLOUDFORMATION_STACK_INACTIVE'|'CLOUDFORMATION_STACK_NOT_EXISTING'|'CLOUDFORMATION_STACK_UNASSUMABLE_ROLE',
'Message': 'string'
},
]
}
Response Structure
(dict) --
ResourceIdentifiers (list) --
The ARNs and resource types of resources that are members of the group that you specified.
(dict) --
A structure that contains the ARN of a resource and its resource type.
ResourceArn (string) --
The ARN of a resource.
ResourceType (string) --
The resource type of a resource, such as AWS::EC2::Instance .
NextToken (string) --
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 .
QueryErrors (list) --
A list of QueryError objects. Each error is an object that contains ErrorCode and Message structures.
Possible values for ErrorCode :
CLOUDFORMATION_STACK_INACTIVECLOUDFORMATION_STACK_NOT_EXISTING(dict) --
A two-part error structure that can occur in ListGroupResources or SearchResources operations on CloudFront stack-based queries. The error occurs if the CloudFront stack on which the query is based either does not exist, or has a status that renders the stack inactive. A QueryError occurrence does not necessarily mean that Resource Groups could not complete the operation, but the resulting group might have no member resources.
ErrorCode (string) --
Specifies the error code that was raised.
Message (string) --
A message that explains the ErrorCode value. Messages might state that the specified CloudFront stack does not exist (or no longer exists). For CLOUDFORMATION_STACK_INACTIVE , the message typically states that the CloudFront stack has a status that is not (or no longer) active, such as CREATE_FAILED .
Exceptions
ResourceGroups.Client.exceptions.UnauthorizedExceptionResourceGroups.Client.exceptions.BadRequestExceptionResourceGroups.Client.exceptions.ForbiddenExceptionResourceGroups.Client.exceptions.MethodNotAllowedExceptionResourceGroups.Client.exceptions.TooManyRequestsExceptionResourceGroups.Client.exceptions.InternalServerErrorExceptiontag(**kwargs)¶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.
Warning
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:TagSee also: AWS API Documentation
Request Syntax
response = client.tag(
Arn='string',
Tags={
'string': 'string'
}
)
[REQUIRED]
The ARN of the resource group to which to add tags.
[REQUIRED]
The tags to add to the specified resource group. A tag is a string-to-string map of key-value pairs.
dict
Response Syntax
{
'Arn': 'string',
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
Arn (string) --
The ARN of the tagged resource.
Tags (dict) --
The tags that have been added to the specified resource group.
Exceptions
ResourceGroups.Client.exceptions.BadRequestExceptionResourceGroups.Client.exceptions.ForbiddenExceptionResourceGroups.Client.exceptions.NotFoundExceptionResourceGroups.Client.exceptions.MethodNotAllowedExceptionResourceGroups.Client.exceptions.TooManyRequestsExceptionResourceGroups.Client.exceptions.InternalServerErrorExceptionungroup_resources(**kwargs)¶Removes the specified resources from the specified group. This operation works only with static groups that you populated using the GroupResources operation. It doesn't work with any resource groups that are automatically populated by tag-based or CloudFormation stack-based queries.
Minimum permissions
To run this command, you must have the following permissions:
resource-groups:UngroupResourcesSee also: AWS API Documentation
Request Syntax
response = client.ungroup_resources(
Group='string',
ResourceArns=[
'string',
]
)
[REQUIRED]
The name or the ARN of the resource group from which to remove the resources.
[REQUIRED]
The ARNs of the resources to be removed from the group.
dict
Response Syntax
{
'Succeeded': [
'string',
],
'Failed': [
{
'ResourceArn': 'string',
'ErrorMessage': 'string',
'ErrorCode': 'string'
},
],
'Pending': [
{
'ResourceArn': 'string'
},
]
}
Response Structure
(dict) --
Succeeded (list) --
A list of resources that were successfully removed from the group by this operation.
Failed (list) --
A list of any resources that failed to be removed from the group by this operation.
(dict) --
A resource that failed to be added to or removed from a group.
ResourceArn (string) --
The ARN of the resource that failed to be added or removed.
ErrorMessage (string) --
The error message text associated with the failure.
ErrorCode (string) --
The error code associated with the failure.
Pending (list) --
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.
(dict) --
A structure that identifies a resource that is currently pending addition to the group as a member. Adding a resource to a resource group happens asynchronously as a background task and this one isn't completed yet.
ResourceArn (string) --
The Amazon resource name (ARN) of the resource that's in a pending state.
Exceptions
ResourceGroups.Client.exceptions.BadRequestExceptionResourceGroups.Client.exceptions.ForbiddenExceptionResourceGroups.Client.exceptions.NotFoundExceptionResourceGroups.Client.exceptions.MethodNotAllowedExceptionResourceGroups.Client.exceptions.TooManyRequestsExceptionResourceGroups.Client.exceptions.InternalServerErrorExceptionuntag(**kwargs)¶Deletes tags from a specified resource group.
Minimum permissions
To run this command, you must have the following permissions:
resource-groups:UntagSee also: AWS API Documentation
Request Syntax
response = client.untag(
Arn='string',
Keys=[
'string',
]
)
[REQUIRED]
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.
[REQUIRED]
The keys of the tags to be removed.
dict
Response Syntax
{
'Arn': 'string',
'Keys': [
'string',
]
}
Response Structure
(dict) --
Arn (string) --
The ARN of the resource group from which tags have been removed.
Keys (list) --
The keys of the tags that were removed.
Exceptions
ResourceGroups.Client.exceptions.BadRequestExceptionResourceGroups.Client.exceptions.ForbiddenExceptionResourceGroups.Client.exceptions.NotFoundExceptionResourceGroups.Client.exceptions.MethodNotAllowedExceptionResourceGroups.Client.exceptions.TooManyRequestsExceptionResourceGroups.Client.exceptions.InternalServerErrorExceptionupdate_account_settings(**kwargs)¶Turns on or turns off optional features in Resource Groups.
The preceding example shows that the request to turn on group lifecycle events is IN_PROGRESS . You can call the GetAccountSettings operation to check for completion by looking for GroupLifecycleEventsStatus to change to ACTIVE .
See also: AWS API Documentation
Request Syntax
response = client.update_account_settings(
GroupLifecycleEventsDesiredStatus='ACTIVE'|'INACTIVE'
)
{
'AccountSettings': {
'GroupLifecycleEventsDesiredStatus': 'ACTIVE'|'INACTIVE',
'GroupLifecycleEventsStatus': 'ACTIVE'|'INACTIVE'|'IN_PROGRESS'|'ERROR',
'GroupLifecycleEventsStatusMessage': 'string'
}
}
Response Structure
A structure that displays the status of the optional features in the account.
The desired target status of the group lifecycle events feature. If
The current status of the group lifecycle events feature.
The text of any error message occurs during an attempt to turn group lifecycle events on or off.
Exceptions
ResourceGroups.Client.exceptions.BadRequestExceptionResourceGroups.Client.exceptions.ForbiddenExceptionResourceGroups.Client.exceptions.MethodNotAllowedExceptionResourceGroups.Client.exceptions.TooManyRequestsExceptionResourceGroups.Client.exceptions.InternalServerErrorExceptionupdate_group(**kwargs)¶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:UpdateGroupSee also: AWS API Documentation
Request Syntax
response = client.update_group(
GroupName='string',
Group='string',
Description='string'
)
Group instead.dict
Response Syntax
{
'Group': {
'GroupArn': 'string',
'Name': 'string',
'Description': 'string'
}
}
Response Structure
(dict) --
Group (dict) --
The update description of the resource group.
GroupArn (string) --
The ARN of the resource group.
Name (string) --
The name of the resource group.
Description (string) --
The description of the resource group.
Exceptions
ResourceGroups.Client.exceptions.BadRequestExceptionResourceGroups.Client.exceptions.ForbiddenExceptionResourceGroups.Client.exceptions.NotFoundExceptionResourceGroups.Client.exceptions.MethodNotAllowedExceptionResourceGroups.Client.exceptions.TooManyRequestsExceptionResourceGroups.Client.exceptions.InternalServerErrorExceptionupdate_group_query(**kwargs)¶Updates the resource query of a group. For more information about resource queries, see Create a tag-based group in Resource Groups.
Minimum permissions
To run this command, you must have the following permissions:
resource-groups:UpdateGroupQuerySee also: AWS API Documentation
Request Syntax
response = client.update_group_query(
GroupName='string',
Group='string',
ResourceQuery={
'Type': 'TAG_FILTERS_1_0'|'CLOUDFORMATION_STACK_1_0',
'Query': 'string'
}
)
Group instead.[REQUIRED]
The resource query to determine which Amazon Web Services resources are members of this resource group.
Note
A resource group can contain either a Configuration or a ResourceQuery , but not both.
The type of the query to perform. This can have one of two values:
CLOUDFORMATION_STACK_1_0: Specifies that you want the group to contain the members of an CloudFormation stack. The Query contains a StackIdentifier element with an ARN for a CloudFormation stack.TAG_FILTERS_1_0: Specifies that you want the group to include resource that have tags that match the query.The query that defines a group or a search. The contents depends on the value of the Type element.
ResourceTypeFilters – Applies to all ResourceQuery objects of either Type . This element contains one of the following two items:AWS::AllSupported . This causes the ResourceQuery to match resources of any resource type that also match the query.ResourceTypeFilters , see Resources you can use with Resource Groups and Tag Editor in the Resource Groups User Guide .Example: "ResourceTypeFilters": ["AWS::AllSupported"] or "ResourceTypeFilters": ["AWS::EC2::Instance", "AWS::S3::Bucket"]
TagFilters – applicable only if Type = TAG_FILTERS_1_0 . The Query contains a JSON string that represents a collection of simple tag filters. The JSON string uses a syntax similar to the GetResources operation, but uses only the ResourceTypeFilters and TagFilters fields. If you specify more than one tag key, only resources that match all tag keys, and at least one value of each specified tag key, are returned in your query. If you specify more than one value for a tag key, a resource matches the filter if it has a tag key value that matches any of the specified values. For example, consider the following sample query for resources that have two tags, Stage and Version , with two values each: [{"Stage":["Test","Deploy"]},{"Version":["1","2"]}] The results of this resource query could include the following.{"Stage":"Deploy"} , and {"Version":"2"}{"Stage":"Test"} , and {"Version":"1"}The resource query results would not include the following items in the results, however.
- An Amazon EC2 instance that has only the following tag:
{"Stage":"Deploy"}. The instance does not have all of the tag keys specified in the filter, so it is excluded from the results.- An RDS database that has the following two tags:
{"Stage":"Archived"}and{"Version":"4"}The database has all of the tag keys, but none of those keys has an associated value that matches at least one of the specified values in the filter.
Example: "TagFilters": [ { "Key": "Stage", "Values": [ "Gamma", "Beta" ] }
StackIdentifier – applicable only if Type = CLOUDFORMATION_STACK_1_0 . The value of this parameter is the Amazon Resource Name (ARN) of the CloudFormation stack whose resources you want included in the group.dict
Response Syntax
{
'GroupQuery': {
'GroupName': 'string',
'ResourceQuery': {
'Type': 'TAG_FILTERS_1_0'|'CLOUDFORMATION_STACK_1_0',
'Query': 'string'
}
}
}
Response Structure
(dict) --
GroupQuery (dict) --
The updated resource query associated with the resource group after the update.
GroupName (string) --
The name of the resource group that is associated with the specified resource query.
ResourceQuery (dict) --
The resource query that determines which Amazon Web Services resources are members of the associated resource group.
Type (string) --
The type of the query to perform. This can have one of two values:
CLOUDFORMATION_STACK_1_0: Specifies that you want the group to contain the members of an CloudFormation stack. The Query contains a StackIdentifier element with an ARN for a CloudFormation stack.TAG_FILTERS_1_0: Specifies that you want the group to include resource that have tags that match the query.Query (string) --
The query that defines a group or a search. The contents depends on the value of the Type element.
ResourceTypeFilters – Applies to all ResourceQuery objects of either Type . This element contains one of the following two items:AWS::AllSupported . This causes the ResourceQuery to match resources of any resource type that also match the query.ResourceTypeFilters , see Resources you can use with Resource Groups and Tag Editor in the Resource Groups User Guide .Example: "ResourceTypeFilters": ["AWS::AllSupported"] or "ResourceTypeFilters": ["AWS::EC2::Instance", "AWS::S3::Bucket"]
TagFilters – applicable only if Type = TAG_FILTERS_1_0 . The Query contains a JSON string that represents a collection of simple tag filters. The JSON string uses a syntax similar to the GetResources operation, but uses only the ResourceTypeFilters and TagFilters fields. If you specify more than one tag key, only resources that match all tag keys, and at least one value of each specified tag key, are returned in your query. If you specify more than one value for a tag key, a resource matches the filter if it has a tag key value that matches any of the specified values. For example, consider the following sample query for resources that have two tags, Stage and Version , with two values each: [{"Stage":["Test","Deploy"]},{"Version":["1","2"]}] The results of this resource query could include the following.{"Stage":"Deploy"} , and {"Version":"2"}{"Stage":"Test"} , and {"Version":"1"}The resource query results would not include the following items in the results, however.
- An Amazon EC2 instance that has only the following tag:
{"Stage":"Deploy"}. The instance does not have all of the tag keys specified in the filter, so it is excluded from the results.- An RDS database that has the following two tags:
{"Stage":"Archived"}and{"Version":"4"}The database has all of the tag keys, but none of those keys has an associated value that matches at least one of the specified values in the filter.
Example: "TagFilters": [ { "Key": "Stage", "Values": [ "Gamma", "Beta" ] }
StackIdentifier – applicable only if Type = CLOUDFORMATION_STACK_1_0 . The value of this parameter is the Amazon Resource Name (ARN) of the CloudFormation stack whose resources you want included in the group.Exceptions
ResourceGroups.Client.exceptions.BadRequestExceptionResourceGroups.Client.exceptions.ForbiddenExceptionResourceGroups.Client.exceptions.NotFoundExceptionResourceGroups.Client.exceptions.MethodNotAllowedExceptionResourceGroups.Client.exceptions.TooManyRequestsExceptionResourceGroups.Client.exceptions.InternalServerErrorExceptionThe available paginators are:
ResourceGroups.Paginator.ListGroupResourcesResourceGroups.Paginator.ListGroupsResourceGroups.Paginator.SearchResourcesResourceGroups.Paginator.ListGroupResources¶paginator = client.get_paginator('list_group_resources')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from ResourceGroups.Client.list_group_resources().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
GroupName='string',
Group='string',
Filters=[
{
'Name': 'resource-type',
'Values': [
'string',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
Warning
Deprecated - don't use this parameter. Use the Group request field instead.
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 , 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 Amazon CloudFront stack-based queries).
A filter name and value pair that is used to obtain more specific results from a list of resources.
The name of the filter. Filter names are case-sensitive.
One or more filter values. Allowed filter values vary by resource filter name, and are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Resources': [
{
'Identifier': {
'ResourceArn': 'string',
'ResourceType': 'string'
},
'Status': {
'Name': 'PENDING'
}
},
],
'ResourceIdentifiers': [
{
'ResourceArn': 'string',
'ResourceType': 'string'
},
],
'QueryErrors': [
{
'ErrorCode': 'CLOUDFORMATION_STACK_INACTIVE'|'CLOUDFORMATION_STACK_NOT_EXISTING'|'CLOUDFORMATION_STACK_UNASSUMABLE_ROLE',
'Message': 'string'
},
]
}
Response Structure
(dict) --
Resources (list) --
An array of resources from which you can determine each resource's identity, type, and group membership status.
(dict) --
A structure returned by the ListGroupResources operation that contains identity and group membership status information for one of the resources in the group.
Identifier (dict) --
A structure that contains the ARN of a resource and its resource type.
ResourceArn (string) --
The ARN of a resource.
ResourceType (string) --
The resource type of a resource, such as AWS::EC2::Instance .
Status (dict) --
A structure that contains the status of this resource's membership in the group.
Note
This field is present in the response only if the group is of type AWS::EC2::HostManagement .
Name (string) --
The current status.
ResourceIdentifiers (list) --
Warning
Deprecated - don't use this parameter. Use the Resources response field instead.
(dict) --
A structure that contains the ARN of a resource and its resource type.
ResourceArn (string) --
The ARN of a resource.
ResourceType (string) --
The resource type of a resource, such as AWS::EC2::Instance .
QueryErrors (list) --
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 .
(dict) --
A two-part error structure that can occur in ListGroupResources or SearchResources operations on CloudFront stack-based queries. The error occurs if the CloudFront stack on which the query is based either does not exist, or has a status that renders the stack inactive. A QueryError occurrence does not necessarily mean that Resource Groups could not complete the operation, but the resulting group might have no member resources.
ErrorCode (string) --
Specifies the error code that was raised.
Message (string) --
A message that explains the ErrorCode value. Messages might state that the specified CloudFront stack does not exist (or no longer exists). For CLOUDFORMATION_STACK_INACTIVE , the message typically states that the CloudFront stack has a status that is not (or no longer) active, such as CREATE_FAILED .
ResourceGroups.Paginator.ListGroups¶paginator = client.get_paginator('list_groups')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from ResourceGroups.Client.list_groups().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Filters=[
{
'Name': 'resource-type'|'configuration-type',
'Values': [
'string',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
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::CapacityReservationPoolAWS::EC2::HostManagementA filter collection that you can use to restrict the results from a List operation to only those you want to include.
The name of the filter. Filter names are case-sensitive.
One or more filter values. Allowed filter values vary by group filter name, and are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'GroupIdentifiers': [
{
'GroupName': 'string',
'GroupArn': 'string'
},
],
'Groups': [
{
'GroupArn': 'string',
'Name': 'string',
'Description': 'string'
},
],
}
Response Structure
(dict) --
GroupIdentifiers (list) --
A list of GroupIdentifier objects. Each identifier is an object that contains both the Name and the GroupArn .
(dict) --
The unique identifiers for a resource group.
GroupName (string) --
The name of the resource group.
GroupArn (string) --
The ARN of the resource group.
Groups (list) --
Warning
Deprecated - don't use this field. Use the GroupIdentifiers response field instead.
(dict) --
A resource group that contains Amazon Web Services resources. You can assign resources to the group by associating either of the following elements with the group:
GroupArn (string) --
The ARN of the resource group.
Name (string) --
The name of the resource group.
Description (string) --
The description of the resource group.
ResourceGroups.Paginator.SearchResources¶paginator = client.get_paginator('search_resources')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from ResourceGroups.Client.search_resources().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ResourceQuery={
'Type': 'TAG_FILTERS_1_0'|'CLOUDFORMATION_STACK_1_0',
'Query': 'string'
},
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The search query, using the same formats that are supported for resource group definition. For more information, see CreateGroup.
The type of the query to perform. This can have one of two values:
CLOUDFORMATION_STACK_1_0: Specifies that you want the group to contain the members of an CloudFormation stack. The Query contains a StackIdentifier element with an ARN for a CloudFormation stack.TAG_FILTERS_1_0: Specifies that you want the group to include resource that have tags that match the query.The query that defines a group or a search. The contents depends on the value of the Type element.
ResourceTypeFilters – Applies to all ResourceQuery objects of either Type . This element contains one of the following two items:AWS::AllSupported . This causes the ResourceQuery to match resources of any resource type that also match the query.ResourceTypeFilters , see Resources you can use with Resource Groups and Tag Editor in the Resource Groups User Guide .Example: "ResourceTypeFilters": ["AWS::AllSupported"] or "ResourceTypeFilters": ["AWS::EC2::Instance", "AWS::S3::Bucket"]
TagFilters – applicable only if Type = TAG_FILTERS_1_0 . The Query contains a JSON string that represents a collection of simple tag filters. The JSON string uses a syntax similar to the GetResources operation, but uses only the ResourceTypeFilters and TagFilters fields. If you specify more than one tag key, only resources that match all tag keys, and at least one value of each specified tag key, are returned in your query. If you specify more than one value for a tag key, a resource matches the filter if it has a tag key value that matches any of the specified values. For example, consider the following sample query for resources that have two tags, Stage and Version , with two values each: [{"Stage":["Test","Deploy"]},{"Version":["1","2"]}] The results of this resource query could include the following.{"Stage":"Deploy"} , and {"Version":"2"}{"Stage":"Test"} , and {"Version":"1"}The resource query results would not include the following items in the results, however.
- An Amazon EC2 instance that has only the following tag:
{"Stage":"Deploy"}. The instance does not have all of the tag keys specified in the filter, so it is excluded from the results.- An RDS database that has the following two tags:
{"Stage":"Archived"}and{"Version":"4"}The database has all of the tag keys, but none of those keys has an associated value that matches at least one of the specified values in the filter.
Example: "TagFilters": [ { "Key": "Stage", "Values": [ "Gamma", "Beta" ] }
StackIdentifier – applicable only if Type = CLOUDFORMATION_STACK_1_0 . The value of this parameter is the Amazon Resource Name (ARN) of the CloudFormation stack whose resources you want included in the group.A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'ResourceIdentifiers': [
{
'ResourceArn': 'string',
'ResourceType': 'string'
},
],
'QueryErrors': [
{
'ErrorCode': 'CLOUDFORMATION_STACK_INACTIVE'|'CLOUDFORMATION_STACK_NOT_EXISTING'|'CLOUDFORMATION_STACK_UNASSUMABLE_ROLE',
'Message': 'string'
},
]
}
Response Structure
(dict) --
ResourceIdentifiers (list) --
The ARNs and resource types of resources that are members of the group that you specified.
(dict) --
A structure that contains the ARN of a resource and its resource type.
ResourceArn (string) --
The ARN of a resource.
ResourceType (string) --
The resource type of a resource, such as AWS::EC2::Instance .
QueryErrors (list) --
A list of QueryError objects. Each error is an object that contains ErrorCode and Message structures.
Possible values for ErrorCode :
CLOUDFORMATION_STACK_INACTIVECLOUDFORMATION_STACK_NOT_EXISTING(dict) --
A two-part error structure that can occur in ListGroupResources or SearchResources operations on CloudFront stack-based queries. The error occurs if the CloudFront stack on which the query is based either does not exist, or has a status that renders the stack inactive. A QueryError occurrence does not necessarily mean that Resource Groups could not complete the operation, but the resulting group might have no member resources.
ErrorCode (string) --
Specifies the error code that was raised.
Message (string) --
A message that explains the ErrorCode value. Messages might state that the specified CloudFront stack does not exist (or no longer exists). For CLOUDFORMATION_STACK_INACTIVE , the message typically states that the CloudFront stack has a status that is not (or no longer) active, such as CREATE_FAILED .