2020/07/29 - AWS Resource Groups - 3 new 8 updated api methods
Changes Resource Groups released a new feature that enables you to create a group with an associated configuration that specifies how other AWS services interact with the group. There are two new operations `GroupResources` and `UngroupResources` to work on a group with a configuration. In this release, you can associate EC2 Capacity Reservations with a resource group. Resource Groups also added a new request parameter `Group` to replace `GroupName` for all existing operations.
Removes the specified resources from the specified group.
See also: AWS API Documentation
Request Syntax
client.ungroup_resources(
Group='string',
ResourceArns=[
'string',
]
)
string
[REQUIRED]
The name or the ARN of the resource group from which to remove the resources.
list
[REQUIRED]
The ARNs of the resources to be removed from the group.
(string) --
dict
Response Syntax
{
'Succeeded': [
'string',
],
'Failed': [
{
'ResourceArn': 'string',
'ErrorMessage': 'string',
'ErrorCode': 'string'
},
]
}
Response Structure
(dict) --
Succeeded (list) --
The ARNs of the resources that were successfully removed from the group.
(string) --
Failed (list) --
The resources that failed to be removed from 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.
Returns the service configuration associated with the specified resource group. AWS Resource Groups supports configurations for the following resource group types:
AWS::EC2::CapacityReservationPool - Amazon EC2 capacity reservation pools. For more information, see Working with capacity reservation groups in the EC2 Users Guide .
See also: AWS API Documentation
Request Syntax
client.get_group_configuration(
Group='string'
)
string
The name or the ARN of the resource group.
dict
Response Syntax
{
'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) --
GroupConfiguration (dict) --
The configuration associated with the specified group.
Configuration (list) --
The configuration currently associated with the group and in effect.
(dict) --
An item in a group configuration. A group configuration can have one or more items.
Type (string) --
Specifies the type of group configuration item. Each item must have a unique value for type .
You can specify the following string values:
AWS::EC2::CapacityReservationPool For more information about EC2 capacity reservation groups, see Working with capacity reservation groups in the EC2 Users Guide .
AWS::ResourceGroups::Generic - Supports parameters that configure the behavior of resource groups of any type.
Parameters (list) --
A collection of parameters for this group configuration item.
(dict) --
A parameter for a group configuration item.
Name (string) --
The name of the group configuration parameter.
You can specify the following string values:
For configuration item type AWS::ResourceGroups::Generic :
allowed-resource-types Specifies the types of resources that you can add to this group by using the GroupResources operation.
For configuration item type AWS::EC2::CapacityReservationPool :
None - This configuration item type doesn't support any parameters.
For more information about EC2 capacity reservation groups, see Working with capacity reservation groups in the EC2 Users Guide .
Values (list) --
The values of for this parameter.
You can specify the following string value:
For item type allowed-resource-types : the only supported parameter value is AWS::EC2::CapacityReservation .
(string) --
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 configuration can have one or more items.
Type (string) --
Specifies the type of group configuration item. Each item must have a unique value for type .
You can specify the following string values:
AWS::EC2::CapacityReservationPool For more information about EC2 capacity reservation groups, see Working with capacity reservation groups in the EC2 Users Guide .
AWS::ResourceGroups::Generic - Supports parameters that configure the behavior of resource groups of any type.
Parameters (list) --
A collection of parameters for this group configuration item.
(dict) --
A parameter for a group configuration item.
Name (string) --
The name of the group configuration parameter.
You can specify the following string values:
For configuration item type AWS::ResourceGroups::Generic :
allowed-resource-types Specifies the types of resources that you can add to this group by using the GroupResources operation.
For configuration item type AWS::EC2::CapacityReservationPool :
None - This configuration item type doesn't support any parameters.
For more information about EC2 capacity reservation groups, see Working with capacity reservation groups in the EC2 Users Guide .
Values (list) --
The values of for this parameter.
You can specify the following string value:
For item type allowed-resource-types : the only supported parameter value is AWS::EC2::CapacityReservation .
(string) --
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.
Adds the specified resources to the specified group.
See also: AWS API Documentation
Request Syntax
client.group_resources(
Group='string',
ResourceArns=[
'string',
]
)
string
[REQUIRED]
The name or the ARN of the resource group to add resources to.
list
[REQUIRED]
The list of ARNs for resources to be added to the group.
(string) --
dict
Response Syntax
{
'Succeeded': [
'string',
],
'Failed': [
{
'ResourceArn': 'string',
'ErrorMessage': 'string',
'ErrorCode': 'string'
},
]
}
Response Structure
(dict) --
Succeeded (list) --
The ARNs of the resources that were successfully added to the group by this operation.
(string) --
Failed (list) --
The ARNs of the resources that failed to be added to 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.
{'Configuration': [{'Parameters': [{'Name': 'string', 'Values': ['string']}],
'Type': 'string'}]}
Response {'GroupConfiguration': {'Configuration': [{'Parameters': [{'Name': 'string',
'Values': ['string']}],
'Type': 'string'}],
'FailureReason': 'string',
'ProposedConfiguration': [{'Parameters': [{'Name': 'string',
'Values': ['string']}],
'Type': 'string'}],
'Status': 'UPDATING | UPDATE_COMPLETE | UPDATE_FAILED'}}
Creates a resource group with the specified name and description. You can optionally include a resource query, or a service configuration.
See also: AWS API Documentation
Request Syntax
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',
]
},
]
},
]
)
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 AWS Region in your AWS account.
string
The description of the resource group. Descriptions can consist of letters, numbers, hyphens, underscores, periods, and spaces.
dict
The resource query that determines which AWS resources are members of this group.
Note
You can specify either a ResourceQuery or a Configuration , but not both.
Type (string) -- [REQUIRED]
The type of the query. The valid values in this release are the following:
``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 <https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/API_GetResources.html>`__ 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.
An EC2 instance that has the following two tags: {"Key":"Stage","Value":"Deploy"} , and {"Key":"Version","Value":"2"}
An S3 bucket that has the following two tags: {"Key":"Stage","Value":"Test"} , and {"Key":"Version","Value":"1"}
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.
An EC2 instance that has only the following tag: {"Key":"Stage","Value":"Deploy"} .
An RDS database that has the following two tags: {"Key":"Stage","Value":"Archived"} , and {"Key":"Version","Value":"4"}
*CLOUDFORMATION_STACK_1_0: * A JSON syntax that lets you specify a CloudFormation stack ARN.
Query (string) -- [REQUIRED]
The query that defines a group or a search.
dict
The tags to add to the group. A tag is key-value pair string.
(string) --
(string) --
list
A configuration associates the resource group with an AWS service and specifies how the service can interact with the resources in the group. A configuration is an array of GroupConfigurationItem elements.
Note
You can specify either a Configuration or a ResourceQuery in a group, but not both.
(dict) --
An item in a group configuration. A group configuration can have one or more items.
Type (string) -- [REQUIRED]
Specifies the type of group configuration item. Each item must have a unique value for type .
You can specify the following string values:
AWS::EC2::CapacityReservationPool For more information about EC2 capacity reservation groups, see Working with capacity reservation groups in the EC2 Users Guide .
AWS::ResourceGroups::Generic - Supports parameters that configure the behavior of resource groups of any type.
Parameters (list) --
A collection of parameters for this group configuration item.
(dict) --
A parameter for a group configuration item.
Name (string) -- [REQUIRED]
The name of the group configuration parameter.
You can specify the following string values:
For configuration item type AWS::ResourceGroups::Generic :
allowed-resource-types Specifies the types of resources that you can add to this group by using the GroupResources operation.
For configuration item type AWS::EC2::CapacityReservationPool :
None - This configuration item type doesn't support any parameters.
For more information about EC2 capacity reservation groups, see Working with capacity reservation groups in the EC2 Users Guide .
Values (list) --
The values of for this parameter.
You can specify the following string value:
For item type allowed-resource-types : the only supported parameter value is AWS::EC2::CapacityReservation .
(string) --
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.
Type (string) --
The type of the query. The valid values in this release are the following:
``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 <https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/API_GetResources.html>`__ 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.
An EC2 instance that has the following two tags: {"Key":"Stage","Value":"Deploy"} , and {"Key":"Version","Value":"2"}
An S3 bucket that has the following two tags: {"Key":"Stage","Value":"Test"} , and {"Key":"Version","Value":"1"}
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.
An EC2 instance that has only the following tag: {"Key":"Stage","Value":"Deploy"} .
An RDS database that has the following two tags: {"Key":"Stage","Value":"Archived"} , and {"Key":"Version","Value":"4"}
*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.
(string) --
(string) --
GroupConfiguration (dict) --
The service configuration associated with the resource group. AWS Resource Groups supports adding service configurations for the following resource group types:
AWS::EC2::CapacityReservationPool - Amazon EC2 capacity reservation pools. For more information, see Working with capacity reservation groups in the EC2 Users Guide .
Configuration (list) --
The configuration currently associated with the group and in effect.
(dict) --
An item in a group configuration. A group configuration can have one or more items.
Type (string) --
Specifies the type of group configuration item. Each item must have a unique value for type .
You can specify the following string values:
AWS::EC2::CapacityReservationPool For more information about EC2 capacity reservation groups, see Working with capacity reservation groups in the EC2 Users Guide .
AWS::ResourceGroups::Generic - Supports parameters that configure the behavior of resource groups of any type.
Parameters (list) --
A collection of parameters for this group configuration item.
(dict) --
A parameter for a group configuration item.
Name (string) --
The name of the group configuration parameter.
You can specify the following string values:
For configuration item type AWS::ResourceGroups::Generic :
allowed-resource-types Specifies the types of resources that you can add to this group by using the GroupResources operation.
For configuration item type AWS::EC2::CapacityReservationPool :
None - This configuration item type doesn't support any parameters.
For more information about EC2 capacity reservation groups, see Working with capacity reservation groups in the EC2 Users Guide .
Values (list) --
The values of for this parameter.
You can specify the following string value:
For item type allowed-resource-types : the only supported parameter value is AWS::EC2::CapacityReservation .
(string) --
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 configuration can have one or more items.
Type (string) --
Specifies the type of group configuration item. Each item must have a unique value for type .
You can specify the following string values:
AWS::EC2::CapacityReservationPool For more information about EC2 capacity reservation groups, see Working with capacity reservation groups in the EC2 Users Guide .
AWS::ResourceGroups::Generic - Supports parameters that configure the behavior of resource groups of any type.
Parameters (list) --
A collection of parameters for this group configuration item.
(dict) --
A parameter for a group configuration item.
Name (string) --
The name of the group configuration parameter.
You can specify the following string values:
For configuration item type AWS::ResourceGroups::Generic :
allowed-resource-types Specifies the types of resources that you can add to this group by using the GroupResources operation.
For configuration item type AWS::EC2::CapacityReservationPool :
None - This configuration item type doesn't support any parameters.
For more information about EC2 capacity reservation groups, see Working with capacity reservation groups in the EC2 Users Guide .
Values (list) --
The values of for this parameter.
You can specify the following string value:
For item type allowed-resource-types : the only supported parameter value is AWS::EC2::CapacityReservation .
(string) --
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.
{'Group': 'string'}
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.
See also: AWS API Documentation
Request Syntax
client.delete_group(
GroupName='string',
Group='string'
)
string
Don't use this parameter. Use Group instead.
string
The name or the ARN of the resource group to delete.
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.
{'Group': 'string'}
Returns information about a specified resource group.
See also: AWS API Documentation
Request Syntax
client.get_group(
GroupName='string',
Group='string'
)
string
Don't use this parameter. Use Group instead.
string
The name or the ARN of the resource group to retrieve.
dict
Response Syntax
{
'Group': {
'GroupArn': 'string',
'Name': 'string',
'Description': 'string'
}
}
Response Structure
(dict) --
Group (dict) --
A full 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.
{'Group': 'string'}
Retrieves the resource query associated with the specified resource group.
See also: AWS API Documentation
Request Syntax
client.get_group_query(
GroupName='string',
Group='string'
)
string
Don't use this parameter. Use Group instead.
string
The name or the ARN of the resource group to query.
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.
GroupName (string) --
The name of the resource group that is associated with the specified resource query.
ResourceQuery (dict) --
The resource query that 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 the following:
``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 <https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/API_GetResources.html>`__ 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.
An EC2 instance that has the following two tags: {"Key":"Stage","Value":"Deploy"} , and {"Key":"Version","Value":"2"}
An S3 bucket that has the following two tags: {"Key":"Stage","Value":"Test"} , and {"Key":"Version","Value":"1"}
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.
An EC2 instance that has only the following tag: {"Key":"Stage","Value":"Deploy"} .
An RDS database that has the following two tags: {"Key":"Stage","Value":"Archived"} , and {"Key":"Version","Value":"4"}
*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.
{'Group': 'string'}
Returns a list of ARNs of resources that are members of a specified resource group.
See also: AWS API Documentation
Request Syntax
client.list_group_resources(
GroupName='string',
Group='string',
Filters=[
{
'Name': 'resource-type',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string'
)
string
Don't use this parameter. Use Group instead.
string
The name or the ARN of the resource group
list
Filters, formatted as ResourceFilter objects, that you want to apply to a ListGroupResources operation. Filters the results to include only those of the specified resource types.
resource-type - Filter resources by their type. Specify up to five resource types in the format AWS::ServiceCode::ResourceType . For example, AWS::EC2::Instance , or AWS::S3::Bucket .
When you specify a resource-type filter for ListGroupResources , AWS Resource Groups validates your filter resource types against the types that are defined in the query associated with the group. For example, if a group contains only S3 buckets because its query specifies only that resource type, but your resource-type filter includes EC2 instances, AWS Resource Groups does not filter for EC2 instances. In this case, a ListGroupResources request returns a BadRequestException error with a message similar to the following:
The resource types specified as filters in the request are not valid.
The error includes a list of resource types that failed the validation because they are not part of the query associated with the group. This validation doesn't occur when the group query specifies AWS::AllSupported , because a group based on such a query can contain any of the allowed resource types for the query type (tag-based or AWS CloudFormation stack-based queries).
(dict) --
A filter name and value pair that is used to obtain more specific results from a list of resources.
Name (string) -- [REQUIRED]
The name of the filter. Filter names are case-sensitive.
Values (list) -- [REQUIRED]
One or more filter values. Allowed filter values vary by resource filter name, and are case-sensitive.
(string) --
integer
The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.
string
The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value provided by a previous call's NextToken response to indicate where the output should continue from.
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) --
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 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 .
{'Filters': {'Name': {'configuration-type'}}}
Returns a list of existing resource groups in your account.
See also: AWS API Documentation
Request Syntax
client.list_groups(
Filters=[
{
'Name': 'resource-type'|'configuration-type',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string'
)
list
Filters, formatted as GroupFilter objects, that you want to apply to a ListGroups operation.
resource-type - Filter the results to include only those of the specified resource types. Specify up to five resource types in the format AWS::*ServiceCode* ::*ResourceType* `` . For example, ``AWS::EC2::Instance , or AWS::S3::Bucket .
configuration-type - Filter the results to include only those groups that have the specified configuration types attached. The current supported values are:
AWS:EC2::CapacityReservationPool
(dict) --
A filter collection that you can use to restrict the results from a List operation to only those you want to include.
Name (string) -- [REQUIRED]
The name of the filter. Filter names are case-sensitive.
Values (list) -- [REQUIRED]
One or more filter values. Allowed filter values vary by group filter name, and are case-sensitive.
(string) --
integer
The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.
string
The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value provided by a previous call's NextToken response to indicate where the output should continue from.
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) --
This output element is deprecated and shouldn't be used. Refer to GroupIdentifiers instead.
(dict) --
A resource group that contains AWS resources. You can assign resources to the group by associating either of the following elements with the group:
ResourceQuery - Use a resource query to specify a set of tag keys and values. All resources in the same AWS Region and AWS account that have those keys with the same values are included in the group. You can add a resource query when you create the group.
GroupConfiguration - Use a service configuration to associate the group with an AWS service. The configuration specifies which resource types can be included in 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 .
{'Group': 'string'}
Updates the description for an existing group. You cannot update the name of a resource group.
See also: AWS API Documentation
Request Syntax
client.update_group(
GroupName='string',
Group='string',
Description='string'
)
string
Don't use this parameter. Use Group instead.
string
The name or the ARN of the resource group to modify.
string
The new description that you want to update the resource group with. Descriptions can contain letters, numbers, hyphens, underscores, periods, and spaces.
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.
{'Group': 'string'}
Updates the resource query of a group.
See also: AWS API Documentation
Request Syntax
client.update_group_query(
GroupName='string',
Group='string',
ResourceQuery={
'Type': 'TAG_FILTERS_1_0'|'CLOUDFORMATION_STACK_1_0',
'Query': 'string'
}
)
string
Don't use this parameter. Use Group instead.
string
The name or the ARN of the resource group to query.
dict
[REQUIRED]
The resource query to determine which AWS resources are members of this resource group.
Type (string) -- [REQUIRED]
The type of the query. The valid values in this release are the following:
``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 <https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/API_GetResources.html>`__ 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.
An EC2 instance that has the following two tags: {"Key":"Stage","Value":"Deploy"} , and {"Key":"Version","Value":"2"}
An S3 bucket that has the following two tags: {"Key":"Stage","Value":"Test"} , and {"Key":"Version","Value":"1"}
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.
An EC2 instance that has only the following tag: {"Key":"Stage","Value":"Deploy"} .
An RDS database that has the following two tags: {"Key":"Stage","Value":"Archived"} , and {"Key":"Version","Value":"4"}
*CLOUDFORMATION_STACK_1_0: * A JSON syntax that lets you specify a CloudFormation stack ARN.
Query (string) -- [REQUIRED]
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 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 AWS resources are members of the associated resource group.
Type (string) --
The type of the query. The valid values in this release are the following:
``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 <https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/API_GetResources.html>`__ 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.
An EC2 instance that has the following two tags: {"Key":"Stage","Value":"Deploy"} , and {"Key":"Version","Value":"2"}
An S3 bucket that has the following two tags: {"Key":"Stage","Value":"Test"} , and {"Key":"Version","Value":"1"}
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.
An EC2 instance that has only the following tag: {"Key":"Stage","Value":"Deploy"} .
An RDS database that has the following two tags: {"Key":"Stage","Value":"Archived"} , and {"Key":"Version","Value":"4"}
*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.