AWS Resource Groups 2017-11-27
- Client: Aws\ResourceGroups\ResourceGroupsClient
- Service ID: resource-groups
- Version: 2017-11-27
This page describes the parameters and results for the operations of the AWS Resource Groups (2017-11-27), and shows how to use the Aws\ResourceGroups\ResourceGroupsClient object to call the described operations. This documentation is specific to the 2017-11-27 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName'), where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */).
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */).
- CreateGroup ( array $params = [] )
Creates a resource group with the specified name and description.
- DeleteGroup ( array $params = [] )
Deletes the specified resource group.
- GetAccountSettings ( array $params = [] )
Retrieves the current status of optional features in Resource Groups.
- GetGroup ( array $params = [] )
Returns information about a specified resource group.
- GetGroupConfiguration ( array $params = [] )
Retrieves the service configuration associated with the specified resource group.
- GetGroupQuery ( array $params = [] )
Retrieves the resource query associated with the specified resource group.
- GetTags ( array $params = [] )
Returns a list of tags that are associated with a resource group, specified by an ARN.
- GroupResources ( array $params = [] )
Adds the specified resources to the specified group.
- ListGroupResources ( array $params = [] )
Returns a list of ARNs of the resources that are members of a specified resource group.
- ListGroups ( array $params = [] )
Returns a list of existing Resource Groups in your account.
- PutGroupConfiguration ( array $params = [] )
Attaches a service configuration to the specified group.
- SearchResources ( array $params = [] )
Returns a list of Amazon Web Services resource identifiers that matches the specified query.
- Tag ( array $params = [] )
Adds tags to a resource group with the specified ARN.
- UngroupResources ( array $params = [] )
Removes the specified resources from the specified group.
- Untag ( array $params = [] )
Deletes tags from a specified resource group.
- UpdateAccountSettings ( array $params = [] )
Turns on or turns off optional features in Resource Groups.
- UpdateGroup ( array $params = [] )
Updates the description for an existing group.
- UpdateGroupQuery ( array $params = [] )
Updates the resource query of a group.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
Operations
CreateGroup
$result = $client->createGroup([/* ... */]); $promise = $client->createGroupAsync([/* ... */]);
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:CreateGroup
Parameter Syntax
$result = $client->createGroup([
'Configuration' => [
[
'Parameters' => [
[
'Name' => '<string>', // REQUIRED
'Values' => ['<string>', ...],
],
// ...
],
'Type' => '<string>', // REQUIRED
],
// ...
],
'Description' => '<string>',
'Name' => '<string>', // REQUIRED
'ResourceQuery' => [
'Query' => '<string>', // REQUIRED
'Type' => 'TAG_FILTERS_1_0|CLOUDFORMATION_STACK_1_0', // REQUIRED
],
'Tags' => ['<string>', ...],
]);
Parameter Details
Members
- Configuration
-
- Type: Array of GroupConfigurationItem structures
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.
A resource group can contain either a
Configurationor aResourceQuery, but not both. - Description
-
- Type: string
The description of the resource group. Descriptions can consist of letters, numbers, hyphens, underscores, periods, and spaces.
- Name
-
- Required: Yes
- Type: string
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
AWSoraws; these are reserved. A resource group name must be unique within each Amazon Web Services Region in your Amazon Web Services account. - ResourceQuery
-
- Type: ResourceQuery structure
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.
A resource group can contain either a
ResourceQueryor aConfiguration, but not both. - Tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags to add to the group. A tag is key-value pair string.
Result Syntax
[
'Group' => [
'Description' => '<string>',
'GroupArn' => '<string>',
'Name' => '<string>',
],
'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',
],
'ResourceQuery' => [
'Query' => '<string>',
'Type' => 'TAG_FILTERS_1_0|CLOUDFORMATION_STACK_1_0',
],
'Tags' => ['<string>', ...],
]
Result Details
Members
- Group
-
- Type: Group structure
The description of the resource group.
- GroupConfiguration
-
- Type: GroupConfiguration structure
The service configuration associated with the resource group. For details about the syntax of a service configuration, see Service configurations for Resource Groups.
- ResourceQuery
-
- Type: ResourceQuery structure
The resource query associated with the group. For more information about resource queries, see Create a tag-based group in Resource Groups.
- Tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags associated with the group.
Errors
-
The request includes one or more parameters that violate validation rules.
-
The caller isn't authorized to make the request. Check permissions.
-
The request uses an HTTP method that isn't allowed for the specified resource.
-
You've exceeded throttling limits by making too many requests in a period of time.
-
An internal error occurred while processing the request. Try again later.
DeleteGroup
$result = $client->deleteGroup([/* ... */]); $promise = $client->deleteGroupAsync([/* ... */]);
Deletes the specified resource group. Deleting a resource group does not delete any resources that are members of the group; it only deletes the group structure.
Minimum permissions
To run this command, you must have the following permissions:
-
resource-groups:DeleteGroup
Parameter Syntax
$result = $client->deleteGroup([
'Group' => '<string>',
'GroupName' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'Group' => [
'Description' => '<string>',
'GroupArn' => '<string>',
'Name' => '<string>',
],
]
Result Details
Members
- Group
-
- Type: Group structure
A full description of the deleted resource group.
Errors
-
The request includes one or more parameters that violate validation rules.
-
The caller isn't authorized to make the request. Check permissions.
-
One or more of the specified resources don't exist.
-
The request uses an HTTP method that isn't allowed for the specified resource.
-
You've exceeded throttling limits by making too many requests in a period of time.
-
An internal error occurred while processing the request. Try again later.
GetAccountSettings
$result = $client->getAccountSettings([/* ... */]); $promise = $client->getAccountSettingsAsync([/* ... */]);
Retrieves the current status of optional features in Resource Groups.
Parameter Syntax
$result = $client->getAccountSettings([ ]);
Parameter Details
Members
Result Syntax
[
'AccountSettings' => [
'GroupLifecycleEventsDesiredStatus' => 'ACTIVE|INACTIVE',
'GroupLifecycleEventsStatus' => 'ACTIVE|INACTIVE|IN_PROGRESS|ERROR',
'GroupLifecycleEventsStatusMessage' => '<string>',
],
]
Result Details
Members
- AccountSettings
-
- Type: AccountSettings structure
The current settings for the optional features in Resource Groups.
Errors
-
The request includes one or more parameters that violate validation rules.
-
The caller isn't authorized to make the request. Check permissions.
-
The request uses an HTTP method that isn't allowed for the specified resource.
-
You've exceeded throttling limits by making too many requests in a period of time.
-
An internal error occurred while processing the request. Try again later.
GetGroup
$result = $client->getGroup([/* ... */]); $promise = $client->getGroupAsync([/* ... */]);
Returns information about a specified resource group.
Minimum permissions
To run this command, you must have the following permissions:
-
resource-groups:GetGroup
Parameter Syntax
$result = $client->getGroup([
'Group' => '<string>',
'GroupName' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'Group' => [
'Description' => '<string>',
'GroupArn' => '<string>',
'Name' => '<string>',
],
]
Result Details
Members
- Group
-
- Type: Group structure
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.
Errors
-
The request includes one or more parameters that violate validation rules.
-
The caller isn't authorized to make the request. Check permissions.
-
One or more of the specified resources don't exist.
-
The request uses an HTTP method that isn't allowed for the specified resource.
-
You've exceeded throttling limits by making too many requests in a period of time.
-
An internal error occurred while processing the request. Try again later.
GetGroupConfiguration
$result = $client->getGroupConfiguration([/* ... */]); $promise = $client->getGroupConfigurationAsync([/* ... */]);
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:GetGroupConfiguration
Parameter Syntax
$result = $client->getGroupConfiguration([
'Group' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'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',
],
]
Result Details
Members
- GroupConfiguration
-
- Type: GroupConfiguration 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.
Errors
-
The request includes one or more parameters that violate validation rules.
-
The caller isn't authorized to make the request. Check permissions.
-
One or more of the specified resources don't exist.
-
The request uses an HTTP method that isn't allowed for the specified resource.
-
You've exceeded throttling limits by making too many requests in a period of time.
-
An internal error occurred while processing the request. Try again later.
GetGroupQuery
$result = $client->getGroupQuery([/* ... */]); $promise = $client->getGroupQueryAsync([/* ... */]);
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:GetGroupQuery
Parameter Syntax
$result = $client->getGroupQuery([
'Group' => '<string>',
'GroupName' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'GroupQuery' => [
'GroupName' => '<string>',
'ResourceQuery' => [
'Query' => '<string>',
'Type' => 'TAG_FILTERS_1_0|CLOUDFORMATION_STACK_1_0',
],
],
]
Result Details
Members
- GroupQuery
-
- Type: GroupQuery structure
The resource query associated with the specified group. For more information about resource queries, see Create a tag-based group in Resource Groups.
Errors
-
The request includes one or more parameters that violate validation rules.
-
The caller isn't authorized to make the request. Check permissions.
-
One or more of the specified resources don't exist.
-
The request uses an HTTP method that isn't allowed for the specified resource.
-
You've exceeded throttling limits by making too many requests in a period of time.
-
An internal error occurred while processing the request. Try again later.
GetTags
$result = $client->getTags([/* ... */]); $promise = $client->getTagsAsync([/* ... */]);
Returns a list of tags that are associated with a resource group, specified by an ARN.
Minimum permissions
To run this command, you must have the following permissions:
-
resource-groups:GetTags
Parameter Syntax
$result = $client->getTags([
'Arn' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'Arn' => '<string>',
'Tags' => ['<string>', ...],
]
Result Details
Members
Errors
-
The request includes one or more parameters that violate validation rules.
-
The caller isn't authorized to make the request. Check permissions.
-
One or more of the specified resources don't exist.
-
The request uses an HTTP method that isn't allowed for the specified resource.
-
You've exceeded throttling limits by making too many requests in a period of time.
-
An internal error occurred while processing the request. Try again later.
GroupResources
$result = $client->groupResources([/* ... */]); $promise = $client->groupResourcesAsync([/* ... */]);
Adds the specified resources to the specified group.
You can use this operation with only resource groups that are configured with the following types:
-
AWS::EC2::HostManagement -
AWS::EC2::CapacityReservationPool
Other 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:GroupResources
Parameter Syntax
$result = $client->groupResources([
'Group' => '<string>', // REQUIRED
'ResourceArns' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'Failed' => [
[
'ErrorCode' => '<string>',
'ErrorMessage' => '<string>',
'ResourceArn' => '<string>',
],
// ...
],
'Pending' => [
[
'ResourceArn' => '<string>',
],
// ...
],
'Succeeded' => ['<string>', ...],
]
Result Details
Members
- Failed
-
- Type: Array of FailedResource structures
A list of ARNs of any resources that this operation failed to add to the group.
- Pending
-
- Type: Array of PendingResource structures
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
ListGroupResourcesoperation, and checking theResourcesarray in the response and theStatusfield of each object in that array. - Succeeded
-
- Type: Array of strings
A list of ARNs of the resources that this operation successfully added to the group.
Errors
-
The request includes one or more parameters that violate validation rules.
-
The caller isn't authorized to make the request. Check permissions.
-
One or more of the specified resources don't exist.
-
The request uses an HTTP method that isn't allowed for the specified resource.
-
You've exceeded throttling limits by making too many requests in a period of time.
-
An internal error occurred while processing the request. Try again later.
ListGroupResources
$result = $client->listGroupResources([/* ... */]); $promise = $client->listGroupResourcesAsync([/* ... */]);
Returns a list of ARNs of the resources that are members of a specified resource group.
Minimum permissions
To run this command, you must have the following permissions:
-
resource-groups:ListGroupResources -
cloudformation:DescribeStacks -
cloudformation:ListStackResources -
tag:GetResources
Parameter Syntax
$result = $client->listGroupResources([
'Filters' => [
[
'Name' => 'resource-type', // REQUIRED
'Values' => ['<string>', ...], // REQUIRED
],
// ...
],
'Group' => '<string>',
'GroupName' => '<string>',
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
- Filters
-
- Type: Array of ResourceFilter structures
Filters, formatted as ResourceFilter objects, that you want to apply to a
ListGroupResourcesoperation. 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 formatAWS::ServiceCode::ResourceType. For example,AWS::EC2::Instance, orAWS::S3::Bucket.
When you specify a
resource-typefilter forListGroupResources, 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 yourresource-typefilter includes EC2 instances, AWS Resource Groups does not filter for EC2 instances. In this case, aListGroupResourcesrequest returns aBadRequestExceptionerror 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). - Group
-
- Type: string
The name or the ARN of the resource group
- GroupName
-
- Type: string
Deprecated - don't use this parameter. Use the
Grouprequest field instead. - MaxResults
-
- Type: int
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
NextTokenresponse element is present and has a value (is not null). Include that value as theNextTokenrequest 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 checkNextTokenafter every operation to ensure that you receive all of the results. - NextToken
-
- Type: string
The parameter for receiving additional results if you receive a
NextTokenresponse in a previous request. ANextTokenresponse indicates that more output is available. Set this parameter to the value provided by a previous call'sNextTokenresponse to indicate where the output should continue from.
Result Syntax
[
'NextToken' => '<string>',
'QueryErrors' => [
[
'ErrorCode' => 'CLOUDFORMATION_STACK_INACTIVE|CLOUDFORMATION_STACK_NOT_EXISTING|CLOUDFORMATION_STACK_UNASSUMABLE_ROLE',
'Message' => '<string>',
],
// ...
],
'ResourceIdentifiers' => [
[
'ResourceArn' => '<string>',
'ResourceType' => '<string>',
],
// ...
],
'Resources' => [
[
'Identifier' => [
'ResourceArn' => '<string>',
'ResourceType' => '<string>',
],
'Status' => [
'Name' => 'PENDING',
],
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
If present, indicates that more output is available than is included in the current response. Use this value in the
NextTokenrequest parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until theNextTokenresponse element comes back asnull. - QueryErrors
-
- Type: Array of QueryError structures
A list of
QueryErrorobjects. Each error is an object that containsErrorCodeandMessagestructures. Possible values forErrorCodeareCLOUDFORMATION_STACK_INACTIVEandCLOUDFORMATION_STACK_NOT_EXISTING. - ResourceIdentifiers
-
- Type: Array of ResourceIdentifier structures
Deprecated - don't use this parameter. Use the
Resourcesresponse field instead. - Resources
-
- Type: Array of ListGroupResourcesItem structures
An array of resources from which you can determine each resource's identity, type, and group membership status.
Errors
-
The request was rejected because it doesn't have valid credentials for the target resource.
-
The request includes one or more parameters that violate validation rules.
-
The caller isn't authorized to make the request. Check permissions.
-
One or more of the specified resources don't exist.
-
The request uses an HTTP method that isn't allowed for the specified resource.
-
You've exceeded throttling limits by making too many requests in a period of time.
-
An internal error occurred while processing the request. Try again later.
ListGroups
$result = $client->listGroups([/* ... */]); $promise = $client->listGroupsAsync([/* ... */]);
Returns a list of existing Resource Groups in your account.
Minimum permissions
To run this command, you must have the following permissions:
-
resource-groups:ListGroups
Parameter Syntax
$result = $client->listGroups([
'Filters' => [
[
'Name' => 'resource-type|configuration-type', // REQUIRED
'Values' => ['<string>', ...], // REQUIRED
],
// ...
],
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
- Filters
-
- Type: Array of GroupFilter structures
Filters, formatted as GroupFilter objects, that you want to apply to a
ListGroupsoperation.-
resource-type- Filter the results to include only those of the specified resource types. Specify up to five resource types in the formatAWS::ServiceCode::ResourceType. For example,AWS::EC2::Instance, orAWS::S3::Bucket. -
configuration-type- Filter the results to include only those groups that have the specified configuration types attached. The current supported values are:-
AWS::EC2::CapacityReservationPool -
AWS::EC2::HostManagement
-
- MaxResults
-
- Type: int
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
NextTokenresponse element is present and has a value (is not null). Include that value as theNextTokenrequest 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 checkNextTokenafter every operation to ensure that you receive all of the results. - NextToken
-
- Type: string
The parameter for receiving additional results if you receive a
NextTokenresponse in a previous request. ANextTokenresponse indicates that more output is available. Set this parameter to the value provided by a previous call'sNextTokenresponse to indicate where the output should continue from.
Result Syntax
[
'GroupIdentifiers' => [
[
'GroupArn' => '<string>',
'GroupName' => '<string>',
],
// ...
],
'Groups' => [
[
'Description' => '<string>',
'GroupArn' => '<string>',
'Name' => '<string>',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- GroupIdentifiers
-
- Type: Array of GroupIdentifier structures
A list of GroupIdentifier objects. Each identifier is an object that contains both the
Nameand theGroupArn. - Groups
-
- Type: Array of Group structures
Deprecated - don't use this field. Use the
GroupIdentifiersresponse field instead. - NextToken
-
- Type: string
If present, indicates that more output is available than is included in the current response. Use this value in the
NextTokenrequest parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until theNextTokenresponse element comes back asnull.
Errors
-
The request includes one or more parameters that violate validation rules.
-
The caller isn't authorized to make the request. Check permissions.
-
The request uses an HTTP method that isn't allowed for the specified resource.
-
You've exceeded throttling limits by making too many requests in a period of time.
-
An internal error occurred while processing the request. Try again later.
PutGroupConfiguration
$result = $client->putGroupConfiguration([/* ... */]); $promise = $client->putGroupConfigurationAsync([/* ... */]);
Attaches a service configuration to the specified group. This occurs asynchronously, and can take time to complete. You can use GetGroupConfiguration to check the status of the update.
Minimum permissions
To run this command, you must have the following permissions:
-
resource-groups:PutGroupConfiguration
Parameter Syntax
$result = $client->putGroupConfiguration([
'Configuration' => [
[
'Parameters' => [
[
'Name' => '<string>', // REQUIRED
'Values' => ['<string>', ...],
],
// ...
],
'Type' => '<string>', // REQUIRED
],
// ...
],
'Group' => '<string>',
]);
Parameter Details
Members
- Configuration
-
- Type: Array of GroupConfigurationItem structures
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.
A resource group can contain either a
Configurationor aResourceQuery, but not both. - Group
-
- Type: string
The name or ARN of the resource group with the configuration that you want to update.
Result Syntax
[]
Result Details
Errors
-
The request includes one or more parameters that violate validation rules.
-
The caller isn't authorized to make the request. Check permissions.
-
One or more of the specified resources don't exist.
-
The request uses an HTTP method that isn't allowed for the specified resource.
-
You've exceeded throttling limits by making too many requests in a period of time.
-
An internal error occurred while processing the request. Try again later.
SearchResources
$result = $client->searchResources([/* ... */]); $promise = $client->searchResourcesAsync([/* ... */]);
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:SearchResources -
cloudformation:DescribeStacks -
cloudformation:ListStackResources -
tag:GetResources
Parameter Syntax
$result = $client->searchResources([
'MaxResults' => <integer>,
'NextToken' => '<string>',
'ResourceQuery' => [ // REQUIRED
'Query' => '<string>', // REQUIRED
'Type' => 'TAG_FILTERS_1_0|CLOUDFORMATION_STACK_1_0', // REQUIRED
],
]);
Parameter Details
Members
- MaxResults
-
- Type: int
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
NextTokenresponse element is present and has a value (is not null). Include that value as theNextTokenrequest 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 checkNextTokenafter every operation to ensure that you receive all of the results. - NextToken
-
- Type: string
The parameter for receiving additional results if you receive a
NextTokenresponse in a previous request. ANextTokenresponse indicates that more output is available. Set this parameter to the value provided by a previous call'sNextTokenresponse to indicate where the output should continue from. - ResourceQuery
-
- Required: Yes
- Type: ResourceQuery structure
The search query, using the same formats that are supported for resource group definition. For more information, see CreateGroup.
Result Syntax
[
'NextToken' => '<string>',
'QueryErrors' => [
[
'ErrorCode' => 'CLOUDFORMATION_STACK_INACTIVE|CLOUDFORMATION_STACK_NOT_EXISTING|CLOUDFORMATION_STACK_UNASSUMABLE_ROLE',
'Message' => '<string>',
],
// ...
],
'ResourceIdentifiers' => [
[
'ResourceArn' => '<string>',
'ResourceType' => '<string>',
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
If present, indicates that more output is available than is included in the current response. Use this value in the
NextTokenrequest parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until theNextTokenresponse element comes back asnull. - QueryErrors
-
- Type: Array of QueryError structures
A list of
QueryErrorobjects. Each error is an object that containsErrorCodeandMessagestructures.Possible values for
ErrorCode:-
CLOUDFORMATION_STACK_INACTIVE -
CLOUDFORMATION_STACK_NOT_EXISTING
- ResourceIdentifiers
-
- Type: Array of ResourceIdentifier structures
The ARNs and resource types of resources that are members of the group that you specified.
Errors
-
The request was rejected because it doesn't have valid credentials for the target resource.
-
The request includes one or more parameters that violate validation rules.
-
The caller isn't authorized to make the request. Check permissions.
-
The request uses an HTTP method that isn't allowed for the specified resource.
-
You've exceeded throttling limits by making too many requests in a period of time.
-
An internal error occurred while processing the request. Try again later.
Tag
$result = $client->tag([/* ... */]); $promise = $client->tagAsync([/* ... */]);
Adds tags to a resource group with the specified ARN. Existing tags on a resource group are not changed if they are not specified in the request parameters.
Do not store personally identifiable information (PII) or other confidential or sensitive information in tags. We use tags to provide you with billing and administration services. Tags are not intended to be used for private or sensitive data.
Minimum permissions
To run this command, you must have the following permissions:
-
resource-groups:Tag
Parameter Syntax
$result = $client->tag([
'Arn' => '<string>', // REQUIRED
'Tags' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'Arn' => '<string>',
'Tags' => ['<string>', ...],
]
Result Details
Members
Errors
-
The request includes one or more parameters that violate validation rules.
-
The caller isn't authorized to make the request. Check permissions.
-
One or more of the specified resources don't exist.
-
The request uses an HTTP method that isn't allowed for the specified resource.
-
You've exceeded throttling limits by making too many requests in a period of time.
-
An internal error occurred while processing the request. Try again later.
UngroupResources
$result = $client->ungroupResources([/* ... */]); $promise = $client->ungroupResourcesAsync([/* ... */]);
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:UngroupResources
Parameter Syntax
$result = $client->ungroupResources([
'Group' => '<string>', // REQUIRED
'ResourceArns' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'Failed' => [
[
'ErrorCode' => '<string>',
'ErrorMessage' => '<string>',
'ResourceArn' => '<string>',
],
// ...
],
'Pending' => [
[
'ResourceArn' => '<string>',
],
// ...
],
'Succeeded' => ['<string>', ...],
]
Result Details
Members
- Failed
-
- Type: Array of FailedResource structures
A list of any resources that failed to be removed from the group by this operation.
- Pending
-
- Type: Array of PendingResource structures
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
ListGroupResourcesoperation. After the resource is successfully removed, it no longer appears in the response. - Succeeded
-
- Type: Array of strings
A list of resources that were successfully removed from the group by this operation.
Errors
-
The request includes one or more parameters that violate validation rules.
-
The caller isn't authorized to make the request. Check permissions.
-
One or more of the specified resources don't exist.
-
The request uses an HTTP method that isn't allowed for the specified resource.
-
You've exceeded throttling limits by making too many requests in a period of time.
-
An internal error occurred while processing the request. Try again later.
Untag
$result = $client->untag([/* ... */]); $promise = $client->untagAsync([/* ... */]);
Deletes tags from a specified resource group.
Minimum permissions
To run this command, you must have the following permissions:
-
resource-groups:Untag
Parameter Syntax
$result = $client->untag([
'Arn' => '<string>', // REQUIRED
'Keys' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'Arn' => '<string>',
'Keys' => ['<string>', ...],
]
Result Details
Members
Errors
-
The request includes one or more parameters that violate validation rules.
-
The caller isn't authorized to make the request. Check permissions.
-
One or more of the specified resources don't exist.
-
The request uses an HTTP method that isn't allowed for the specified resource.
-
You've exceeded throttling limits by making too many requests in a period of time.
-
An internal error occurred while processing the request. Try again later.
UpdateAccountSettings
$result = $client->updateAccountSettings([/* ... */]); $promise = $client->updateAccountSettingsAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->updateAccountSettings([
'GroupLifecycleEventsDesiredStatus' => 'ACTIVE|INACTIVE',
]);
Parameter Details
Members
- GroupLifecycleEventsDesiredStatus
-
- Type: string
Specifies whether you want to turn group lifecycle events on or off.
Result Syntax
[
'AccountSettings' => [
'GroupLifecycleEventsDesiredStatus' => 'ACTIVE|INACTIVE',
'GroupLifecycleEventsStatus' => 'ACTIVE|INACTIVE|IN_PROGRESS|ERROR',
'GroupLifecycleEventsStatusMessage' => '<string>',
],
]
Result Details
Members
- AccountSettings
-
- Type: AccountSettings structure
A structure that displays the status of the optional features in the account.
Errors
-
The request includes one or more parameters that violate validation rules.
-
The caller isn't authorized to make the request. Check permissions.
-
The request uses an HTTP method that isn't allowed for the specified resource.
-
You've exceeded throttling limits by making too many requests in a period of time.
-
An internal error occurred while processing the request. Try again later.
UpdateGroup
$result = $client->updateGroup([/* ... */]); $promise = $client->updateGroupAsync([/* ... */]);
Updates the description for an existing group. You cannot update the name of a resource group.
Minimum permissions
To run this command, you must have the following permissions:
-
resource-groups:UpdateGroup
Parameter Syntax
$result = $client->updateGroup([
'Description' => '<string>',
'Group' => '<string>',
'GroupName' => '<string>',
]);
Parameter Details
Members
- Description
-
- Type: string
The new description that you want to update the resource group with. Descriptions can contain letters, numbers, hyphens, underscores, periods, and spaces.
- Group
-
- Type: string
The name or the ARN of the resource group to modify.
- GroupName
-
- Type: string
Don't use this parameter. Use
Groupinstead.
Result Syntax
[
'Group' => [
'Description' => '<string>',
'GroupArn' => '<string>',
'Name' => '<string>',
],
]
Result Details
Members
- Group
-
- Type: Group structure
The update description of the resource group.
Errors
-
The request includes one or more parameters that violate validation rules.
-
The caller isn't authorized to make the request. Check permissions.
-
One or more of the specified resources don't exist.
-
The request uses an HTTP method that isn't allowed for the specified resource.
-
You've exceeded throttling limits by making too many requests in a period of time.
-
An internal error occurred while processing the request. Try again later.
UpdateGroupQuery
$result = $client->updateGroupQuery([/* ... */]); $promise = $client->updateGroupQueryAsync([/* ... */]);
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:UpdateGroupQuery
Parameter Syntax
$result = $client->updateGroupQuery([
'Group' => '<string>',
'GroupName' => '<string>',
'ResourceQuery' => [ // REQUIRED
'Query' => '<string>', // REQUIRED
'Type' => 'TAG_FILTERS_1_0|CLOUDFORMATION_STACK_1_0', // REQUIRED
],
]);
Parameter Details
Members
- Group
-
- Type: string
The name or the ARN of the resource group to query.
- GroupName
-
- Type: string
Don't use this parameter. Use
Groupinstead. - ResourceQuery
-
- Required: Yes
- Type: ResourceQuery structure
The resource query to determine which Amazon Web Services resources are members of this resource group.
A resource group can contain either a
Configurationor aResourceQuery, but not both.
Result Syntax
[
'GroupQuery' => [
'GroupName' => '<string>',
'ResourceQuery' => [
'Query' => '<string>',
'Type' => 'TAG_FILTERS_1_0|CLOUDFORMATION_STACK_1_0',
],
],
]
Result Details
Members
- GroupQuery
-
- Type: GroupQuery structure
The updated resource query associated with the resource group after the update.
Errors
-
The request includes one or more parameters that violate validation rules.
-
The caller isn't authorized to make the request. Check permissions.
-
One or more of the specified resources don't exist.
-
The request uses an HTTP method that isn't allowed for the specified resource.
-
You've exceeded throttling limits by making too many requests in a period of time.
-
An internal error occurred while processing the request. Try again later.
Shapes
AccountSettings
Description
The Resource Groups settings for this Amazon Web Services account.
Members
- GroupLifecycleEventsDesiredStatus
-
- Type: string
The desired target status of the group lifecycle events feature. If
- GroupLifecycleEventsStatus
-
- Type: string
The current status of the group lifecycle events feature.
- GroupLifecycleEventsStatusMessage
-
- Type: string
The text of any error message occurs during an attempt to turn group lifecycle events on or off.
BadRequestException
Description
The request includes one or more parameters that violate validation rules.
Members
FailedResource
Description
A resource that failed to be added to or removed from a group.
Members
ForbiddenException
Description
The caller isn't authorized to make the request. Check permissions.
Members
Group
Description
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:
-
ResourceQuery - Use a resource query to specify a set of tag keys and values. All resources in the same Amazon Web Services Region and Amazon Web Services 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, or later by using the PutGroupConfiguration operation.
-
GroupConfiguration - Use a service configuration to associate the group with an Amazon Web Services service. The configuration specifies which resource types can be included in the group.
Members
GroupConfiguration
Description
A service configuration associated with a resource group. The configuration options are determined by the Amazon Web Services service that defines the Type, and specifies which resources can be included in the group. You can add a service configuration when you create the group by using CreateGroup, or later by using the PutGroupConfiguration operation. For details about group service configuration syntax, see Service configurations for resource groups.
Members
- Configuration
-
- Type: Array of GroupConfigurationItem structures
The configuration currently associated with the group and in effect.
- FailureReason
-
- Type: string
If present, the reason why a request to update the group configuration failed.
- ProposedConfiguration
-
- Type: Array of GroupConfigurationItem structures
If present, the new configuration that is in the process of being applied to the group.
- Status
-
- Type: string
The current status of an attempt to update the group configuration.
GroupConfigurationItem
Description
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.
Members
- Parameters
-
- Type: Array of GroupConfigurationParameter structures
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.
- Type
-
- Required: Yes
- 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.
GroupConfigurationParameter
Description
A parameter for a group configuration item. For details about group service configuration syntax, see Service configurations for resource groups.
Members
- Name
-
- Required: Yes
- Type: 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
-
- Type: Array of strings
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.
GroupFilter
Description
A filter collection that you can use to restrict the results from a List operation to only those you want to include.
Members
GroupIdentifier
Description
The unique identifiers for a resource group.
Members
GroupQuery
Description
A mapping of a query attached to a resource group that determines the Amazon Web Services resources that are members of the group.
Members
- GroupName
-
- Required: Yes
- Type: string
The name of the resource group that is associated with the specified resource query.
- ResourceQuery
-
- Required: Yes
- Type: ResourceQuery structure
The resource query that determines which Amazon Web Services resources are members of the associated resource group.
InternalServerErrorException
Description
An internal error occurred while processing the request. Try again later.
Members
ListGroupResourcesItem
Description
A structure returned by the ListGroupResources operation that contains identity and group membership status information for one of the resources in the group.
Members
- Identifier
-
- Type: ResourceIdentifier structure
A structure that contains the ARN of a resource and its resource type.
- Status
-
- Type: ResourceStatus structure
A structure that contains the status of this resource's membership in the group.
This field is present in the response only if the group is of type
AWS::EC2::HostManagement.
MethodNotAllowedException
Description
The request uses an HTTP method that isn't allowed for the specified resource.
Members
NotFoundException
PendingResource
Description
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.
Members
QueryError
Description
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.
Members
- ErrorCode
-
- Type: string
Specifies the error code that was raised.
- Message
-
- Type: string
A message that explains the
ErrorCodevalue. Messages might state that the specified CloudFront stack does not exist (or no longer exists). ForCLOUDFORMATION_STACK_INACTIVE, the message typically states that the CloudFront stack has a status that is not (or no longer) active, such asCREATE_FAILED.
ResourceFilter
Description
A filter name and value pair that is used to obtain more specific results from a list of resources.
Members
ResourceIdentifier
Description
A structure that contains the ARN of a resource and its resource type.
Members
ResourceQuery
Description
The query you can use to define a resource group or a search for resources. A ResourceQuery specifies both a query Type and a Query string as JSON string objects. See the examples section for example JSON strings. For more information about creating a resource group with a resource query, see Build queries and groups in Resource Groups in the Resource Groups User Guide
When you combine all of the elements together into a single string, any double quotes that are embedded inside another double quote pair must be escaped by preceding the embedded double quote with a backslash character (\). For example, a complete ResourceQuery parameter must be formatted like the following CLI parameter example:
--resource-query '{"Type":"TAG_FILTERS_1_0","Query":"{\"ResourceTypeFilters\":[\"AWS::AllSupported\"],\"TagFilters\":[{\"Key\":\"Stage\",\"Values\":[\"Test\"]}]}"}'
In the preceding example, all of the double quote characters in the value part of the Query element must be escaped because the value itself is surrounded by double quotes. For more information, see Quoting strings in the Command Line Interface User Guide.
For the complete list of resource types that you can use in the array value for ResourceTypeFilters, see Resources you can use with Resource Groups and Tag Editor in the Resource Groups User Guide. For example:
"ResourceTypeFilters":["AWS::S3::Bucket", "AWS::EC2::Instance"]
Members
- Query
-
- Required: Yes
- Type: string
The query that defines a group or a search. The contents depends on the value of the
Typeelement.-
ResourceTypeFilters– Applies to allResourceQueryobjects of eitherType. This element contains one of the following two items:-
The value
AWS::AllSupported. This causes the ResourceQuery to match resources of any resource type that also match the query. -
A list (a JSON array) of resource type identifiers that limit the query to only resources of the specified types. For the complete list of resource types that you can use in the array value for
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 ifType=TAG_FILTERS_1_0. TheQuerycontains a JSON string that represents a collection of simple tag filters. The JSON string uses a syntax similar to theGetResourcesoperation, but uses only theResourceTypeFiltersandTagFiltersfields. 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,
StageandVersion, with two values each:[{"Stage":["Test","Deploy"]},{"Version":["1","2"]}]The results of this resource query could include the following.
-
An Amazon EC2 instance that has the following two tags:
{"Stage":"Deploy"}, and{"Version":"2"} -
An S3 bucket that has the following two tags:
{"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 ifType=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.
- Type
-
- Required: Yes
- 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. TheQuerycontains aStackIdentifierelement 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.
ResourceStatus
Description
A structure that identifies the current group membership status for a resource. Adding a resource to a resource group is performed asynchronously as a background task. A PENDING status indicates, for this resource, that the process isn't completed yet.
Members
TooManyRequestsException
Description
You've exceeded throttling limits by making too many requests in a period of time.