Table of Contents
A low-level client representing AWS Resource Groups:
import boto3
client = boto3.client('resource-groups')
These are the available methods:
Check if an operation can be paginated.
Creates a group with a specified name, description, and resource query.
See 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'
}
)
[REQUIRED]
The name of the group, which is the identifier of the group in other operations. A resource group name cannot be updated after it is created. A resource group name can have a maximum of 128 characters, including letters, numbers, hyphens, dots, and underscores. The name cannot start with AWS or aws ; these are reserved. A resource group name must be unique within your account.
[REQUIRED]
The resource query that determines which AWS resources are members of this group.
The type of the query. The valid values in this release are TAG_FILTERS_1_0 and CLOUDFORMATION_STACK_1_0 .
- TAG_FILTERS_1_0: * A JSON syntax that lets you specify a collection of simple tag filters for resource types and tags, as supported by the AWS Tagging API GetResources operation. 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. ([{"Key":"Stage","Values":["Test","Deploy"]},{"Key":"Version","Values":["1","2"]}] ) The results of this query might include the following.
The query would not return the following results, however. The following EC2 instance does not have all tag keys specified in the filter, so it is rejected. The RDS database has all of the tag keys, but no values that match at least one of the specified tag key values in the filter.
- CLOUDFORMATION_STACK_1_0: * A JSON syntax that lets you specify a CloudFormation stack ARN.
The query that defines a group or a search.
The tags to add to the group. A tag is a string-to-string map of key-value pairs. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
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'
}
}
Response Structure
(dict) --
Group (dict) --
A full description of the resource group after it is created.
GroupArn (string) --
The ARN of a resource group.
Name (string) --
The name of a resource group.
Description (string) --
The description of the resource group.
ResourceQuery (dict) --
The resource query associated with the group.
Type (string) --
The type of the query. The valid values in this release are TAG_FILTERS_1_0 and CLOUDFORMATION_STACK_1_0 .
- TAG_FILTERS_1_0: * A JSON syntax that lets you specify a collection of simple tag filters for resource types and tags, as supported by the AWS Tagging API GetResources operation. 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. ([{"Key":"Stage","Values":["Test","Deploy"]},{"Key":"Version","Values":["1","2"]}] ) The results of this query might include the following.
The query would not return the following results, however. The following EC2 instance does not have all tag keys specified in the filter, so it is rejected. The RDS database has all of the tag keys, but no values that match at least one of the specified tag key values in the filter.
- CLOUDFORMATION_STACK_1_0: * A JSON syntax that lets you specify a CloudFormation stack ARN.
Query (string) --
The query that defines a group or a search.
Tags (dict) --
The tags associated with the group.
Deletes a specified resource group. Deleting a resource group does not delete resources that are members of the group; it only deletes the group structure.
See also: AWS API Documentation
Request Syntax
response = client.delete_group(
GroupName='string'
)
[REQUIRED]
The name of the resource group to delete.
{
'Group': {
'GroupArn': 'string',
'Name': 'string',
'Description': 'string'
}
}
Response Structure
A full description of the deleted resource group.
The ARN of a resource group.
The name of a resource group.
The description of the resource group.
Generate a presigned url given a client, its method, and arguments
The presigned url
Returns information about a specified resource group.
See also: AWS API Documentation
Request Syntax
response = client.get_group(
GroupName='string'
)
[REQUIRED]
The name of the resource group.
{
'Group': {
'GroupArn': 'string',
'Name': 'string',
'Description': 'string'
}
}
Response Structure
A full description of the resource group.
The ARN of a resource group.
The name of a resource group.
The description of the resource group.
Returns the resource query associated with the specified resource group.
See also: AWS API Documentation
Request Syntax
response = client.get_group_query(
GroupName='string'
)
[REQUIRED]
The name of the resource group.
{
'GroupQuery': {
'GroupName': 'string',
'ResourceQuery': {
'Type': 'TAG_FILTERS_1_0'|'CLOUDFORMATION_STACK_1_0',
'Query': 'string'
}
}
}
Response Structure
The resource query associated with the specified group.
The name of a resource group that is associated with a specific resource query.
The resource query which determines which AWS resources are members of the associated resource group.
The type of the query. The valid values in this release are TAG_FILTERS_1_0 and CLOUDFORMATION_STACK_1_0 .
- TAG_FILTERS_1_0: * A JSON syntax that lets you specify a collection of simple tag filters for resource types and tags, as supported by the AWS Tagging API GetResources operation. 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. ([{"Key":"Stage","Values":["Test","Deploy"]},{"Key":"Version","Values":["1","2"]}] ) The results of this query might include the following.
The query would not return the following results, however. The following EC2 instance does not have all tag keys specified in the filter, so it is rejected. The RDS database has all of the tag keys, but no values that match at least one of the specified tag key values in the filter.
- CLOUDFORMATION_STACK_1_0: * A JSON syntax that lets you specify a CloudFormation stack ARN.
The query that defines a group or a search.
Create a paginator for an operation.
Returns a list of tags that are associated with a resource, specified by an ARN.
See also: AWS API Documentation
Request Syntax
response = client.get_tags(
Arn='string'
)
[REQUIRED]
The ARN of the resource for which you want a list of tags. The resource must exist within the account you are using.
{
'Arn': 'string',
'Tags': {
'string': 'string'
}
}
Response Structure
The ARN of the tagged resource.
The tags associated with the specified resource.
Returns an object that can wait for some condition.
Returns a list of ARNs of resources that are members of a specified resource group.
See also: AWS API Documentation
Request Syntax
response = client.list_group_resources(
GroupName='string',
Filters=[
{
'Name': 'resource-type',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string'
)
[REQUIRED]
The name of the resource group.
Filters, formatted as ResourceFilter objects, that you want to apply to a ListGroupResources operation.
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.
dict
Response Syntax
{
'ResourceIdentifiers': [
{
'ResourceArn': 'string',
'ResourceType': 'string'
},
],
'NextToken': 'string',
'QueryErrors': [
{
'ErrorCode': 'CLOUDFORMATION_STACK_INACTIVE'|'CLOUDFORMATION_STACK_NOT_EXISTING',
'Message': 'string'
},
]
}
Response Structure
(dict) --
ResourceIdentifiers (list) --
The ARNs and resource types of resources that are members of the group that you specified.
(dict) --
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) --
The NextToken value to include in a subsequent ListGroupResources request, to get more results.
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 CloudFormation stack-based queries. The error occurs if the CloudFormation 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 AWS Resource Groups could not complete the operation, but the resulting group might have no member resources.
ErrorCode (string) --
Possible values are CLOUDFORMATION_STACK_INACTIVE and CLOUDFORMATION_STACK_NOT_EXISTING .
Message (string) --
A message that explains the ErrorCode value. Messages might state that the specified CloudFormation stack does not exist (or no longer exists). For CLOUDFORMATION_STACK_INACTIVE , the message typically states that the CloudFormation stack has a status that is not (or no longer) active, such as CREATE_FAILED .
Returns a list of existing resource groups in your account.
See also: AWS API Documentation
Request Syntax
response = client.list_groups(
Filters=[
{
'Name': 'resource-type',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string'
)
Filters, formatted as GroupFilter objects, that you want to apply to a ListGroups operation.
A filter name and value pair that is used to obtain more specific results from a list of groups.
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.
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 GroupName and the GroupArn.
(dict) --
The ARN and group name of a group.
GroupName (string) --
The name of a resource group.
GroupArn (string) --
The ARN of a resource group.
Groups (list) --
A list of resource groups.
(dict) --
A resource group.
GroupArn (string) --
The ARN of a resource group.
Name (string) --
The name of a resource group.
Description (string) --
The description of the resource group.
NextToken (string) --
The NextToken value to include in a subsequent ListGroups request, to get more results.
Returns a list of AWS resource identifiers that matches a specified query. The query uses the same format as a resource query in a CreateGroup or UpdateGroupQuery operation.
See 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.
The type of the query. The valid values in this release are TAG_FILTERS_1_0 and CLOUDFORMATION_STACK_1_0 .
- TAG_FILTERS_1_0: * A JSON syntax that lets you specify a collection of simple tag filters for resource types and tags, as supported by the AWS Tagging API GetResources operation. 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. ([{"Key":"Stage","Values":["Test","Deploy"]},{"Key":"Version","Values":["1","2"]}] ) The results of this query might include the following.
The query would not return the following results, however. The following EC2 instance does not have all tag keys specified in the filter, so it is rejected. The RDS database has all of the tag keys, but no values that match at least one of the specified tag key values in the filter.
- CLOUDFORMATION_STACK_1_0: * A JSON syntax that lets you specify a CloudFormation stack ARN.
The query that defines a group or a search.
dict
Response Syntax
{
'ResourceIdentifiers': [
{
'ResourceArn': 'string',
'ResourceType': 'string'
},
],
'NextToken': 'string',
'QueryErrors': [
{
'ErrorCode': 'CLOUDFORMATION_STACK_INACTIVE'|'CLOUDFORMATION_STACK_NOT_EXISTING',
'Message': 'string'
},
]
}
Response Structure
(dict) --
ResourceIdentifiers (list) --
The ARNs and resource types of resources that are members of the group that you specified.
(dict) --
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) --
The NextToken value to include in a subsequent SearchResources request, to get more results.
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 CloudFormation stack-based queries. The error occurs if the CloudFormation 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 AWS Resource Groups could not complete the operation, but the resulting group might have no member resources.
ErrorCode (string) --
Possible values are CLOUDFORMATION_STACK_INACTIVE and CLOUDFORMATION_STACK_NOT_EXISTING .
Message (string) --
A message that explains the ErrorCode value. Messages might state that the specified CloudFormation stack does not exist (or no longer exists). For CLOUDFORMATION_STACK_INACTIVE , the message typically states that the CloudFormation stack has a status that is not (or no longer) active, such as CREATE_FAILED .
Adds specified tags to a resource with the specified ARN. Existing tags on a resource are not changed if they are not specified in the request parameters.
See also: AWS API Documentation
Request Syntax
response = client.tag(
Arn='string',
Tags={
'string': 'string'
}
)
[REQUIRED]
The ARN of the resource to which to add tags.
[REQUIRED]
The tags to add to the specified resource. A tag is a string-to-string map of key-value pairs. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
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.
Deletes specified tags from a specified resource.
See also: AWS API Documentation
Request Syntax
response = client.untag(
Arn='string',
Keys=[
'string',
]
)
[REQUIRED]
The ARN of the resource from which to remove tags.
[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 from which tags have been removed.
Keys (list) --
The keys of tags that have been removed.
Updates an existing group with a new or changed description. You cannot update the name of a resource group.
See also: AWS API Documentation
Request Syntax
response = client.update_group(
GroupName='string',
Description='string'
)
[REQUIRED]
The name of the resource group for which you want to update its description.
dict
Response Syntax
{
'Group': {
'GroupArn': 'string',
'Name': 'string',
'Description': 'string'
}
}
Response Structure
(dict) --
Group (dict) --
The full description of the resource group after it has been updated.
GroupArn (string) --
The ARN of a resource group.
Name (string) --
The name of a resource group.
Description (string) --
The description of the resource group.
Updates the resource query of a group.
See also: AWS API Documentation
Request Syntax
response = client.update_group_query(
GroupName='string',
ResourceQuery={
'Type': 'TAG_FILTERS_1_0'|'CLOUDFORMATION_STACK_1_0',
'Query': 'string'
}
)
[REQUIRED]
The name of the resource group for which you want to edit the query.
[REQUIRED]
The resource query that determines which AWS resources are members of the resource group.
The type of the query. The valid values in this release are TAG_FILTERS_1_0 and CLOUDFORMATION_STACK_1_0 .
- TAG_FILTERS_1_0: * A JSON syntax that lets you specify a collection of simple tag filters for resource types and tags, as supported by the AWS Tagging API GetResources operation. 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. ([{"Key":"Stage","Values":["Test","Deploy"]},{"Key":"Version","Values":["1","2"]}] ) The results of this query might include the following.
The query would not return the following results, however. The following EC2 instance does not have all tag keys specified in the filter, so it is rejected. The RDS database has all of the tag keys, but no values that match at least one of the specified tag key values in the filter.
- CLOUDFORMATION_STACK_1_0: * A JSON syntax that lets you specify a CloudFormation stack ARN.
The query that defines a group or a search.
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 resource group after the update.
GroupName (string) --
The name of a resource group that is associated with a specific resource query.
ResourceQuery (dict) --
The resource query which determines which AWS resources are members of the associated resource group.
Type (string) --
The type of the query. The valid values in this release are TAG_FILTERS_1_0 and CLOUDFORMATION_STACK_1_0 .
- TAG_FILTERS_1_0: * A JSON syntax that lets you specify a collection of simple tag filters for resource types and tags, as supported by the AWS Tagging API GetResources operation. 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. ([{"Key":"Stage","Values":["Test","Deploy"]},{"Key":"Version","Values":["1","2"]}] ) The results of this query might include the following.
The query would not return the following results, however. The following EC2 instance does not have all tag keys specified in the filter, so it is rejected. The RDS database has all of the tag keys, but no values that match at least one of the specified tag key values in the filter.
- CLOUDFORMATION_STACK_1_0: * A JSON syntax that lets you specify a CloudFormation stack ARN.
Query (string) --
The query that defines a group or a search.
The available paginators are:
paginator = client.get_paginator('list_group_resources')
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',
Filters=[
{
'Name': 'resource-type',
'Values': [
'string',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The name of the resource group.
Filters, formatted as ResourceFilter objects, that you want to apply to a ListGroupResources operation.
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
{
'ResourceIdentifiers': [
{
'ResourceArn': 'string',
'ResourceType': 'string'
},
],
'QueryErrors': [
{
'ErrorCode': 'CLOUDFORMATION_STACK_INACTIVE'|'CLOUDFORMATION_STACK_NOT_EXISTING',
'Message': 'string'
},
]
}
Response Structure
(dict) --
ResourceIdentifiers (list) --
The ARNs and resource types of resources that are members of the group that you specified.
(dict) --
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 CloudFormation stack-based queries. The error occurs if the CloudFormation 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 AWS Resource Groups could not complete the operation, but the resulting group might have no member resources.
ErrorCode (string) --
Possible values are CLOUDFORMATION_STACK_INACTIVE and CLOUDFORMATION_STACK_NOT_EXISTING .
Message (string) --
A message that explains the ErrorCode value. Messages might state that the specified CloudFormation stack does not exist (or no longer exists). For CLOUDFORMATION_STACK_INACTIVE , the message typically states that the CloudFormation stack has a status that is not (or no longer) active, such as CREATE_FAILED .
paginator = client.get_paginator('list_groups')
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',
'Values': [
'string',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
Filters, formatted as GroupFilter objects, that you want to apply to a ListGroups operation.
A filter name and value pair that is used to obtain more specific results from a list of groups.
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 GroupName and the GroupArn.
(dict) --
The ARN and group name of a group.
GroupName (string) --
The name of a resource group.
GroupArn (string) --
The ARN of a resource group.
Groups (list) --
A list of resource groups.
(dict) --
A resource group.
GroupArn (string) --
The ARN of a resource group.
Name (string) --
The name of a resource group.
Description (string) --
The description of the resource group.
paginator = client.get_paginator('search_resources')
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.
The type of the query. The valid values in this release are TAG_FILTERS_1_0 and CLOUDFORMATION_STACK_1_0 .
- TAG_FILTERS_1_0: * A JSON syntax that lets you specify a collection of simple tag filters for resource types and tags, as supported by the AWS Tagging API GetResources operation. 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. ([{"Key":"Stage","Values":["Test","Deploy"]},{"Key":"Version","Values":["1","2"]}] ) The results of this query might include the following.
The query would not return the following results, however. The following EC2 instance does not have all tag keys specified in the filter, so it is rejected. The RDS database has all of the tag keys, but no values that match at least one of the specified tag key values in the filter.
- CLOUDFORMATION_STACK_1_0: * A JSON syntax that lets you specify a CloudFormation stack ARN.
The query that defines a group or a search.
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',
'Message': 'string'
},
]
}
Response Structure
(dict) --
ResourceIdentifiers (list) --
The ARNs and resource types of resources that are members of the group that you specified.
(dict) --
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 CloudFormation stack-based queries. The error occurs if the CloudFormation 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 AWS Resource Groups could not complete the operation, but the resulting group might have no member resources.
ErrorCode (string) --
Possible values are CLOUDFORMATION_STACK_INACTIVE and CLOUDFORMATION_STACK_NOT_EXISTING .
Message (string) --
A message that explains the ErrorCode value. Messages might state that the specified CloudFormation stack does not exist (or no longer exists). For CLOUDFORMATION_STACK_INACTIVE , the message typically states that the CloudFormation stack has a status that is not (or no longer) active, such as CREATE_FAILED .