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

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

Errors

BadRequestException:

The request includes one or more parameters that violate validation rules.

ForbiddenException:

The caller isn't authorized to make the request. Check permissions.

MethodNotAllowedException:

The request uses an HTTP method that isn't allowed for the specified resource.

TooManyRequestsException:

You've exceeded throttling limits by making too many requests in a period of time.

InternalServerErrorException:

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

Result Syntax

[
    'Group' => [
        'Description' => '<string>',
        'GroupArn' => '<string>',
        'Name' => '<string>',
    ],
]

Result Details

Errors

BadRequestException:

The request includes one or more parameters that violate validation rules.

ForbiddenException:

The caller isn't authorized to make the request. Check permissions.

NotFoundException:

One or more of the specified resources don't exist.

MethodNotAllowedException:

The request uses an HTTP method that isn't allowed for the specified resource.

TooManyRequestsException:

You've exceeded throttling limits by making too many requests in a period of time.

InternalServerErrorException:

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

Result Syntax

[
    'AccountSettings' => [
        'GroupLifecycleEventsDesiredStatus' => 'ACTIVE|INACTIVE',
        'GroupLifecycleEventsStatus' => 'ACTIVE|INACTIVE|IN_PROGRESS|ERROR',
        'GroupLifecycleEventsStatusMessage' => '<string>',
    ],
]

Result Details

Errors

BadRequestException:

The request includes one or more parameters that violate validation rules.

ForbiddenException:

The caller isn't authorized to make the request. Check permissions.

MethodNotAllowedException:

The request uses an HTTP method that isn't allowed for the specified resource.

TooManyRequestsException:

You've exceeded throttling limits by making too many requests in a period of time.

InternalServerErrorException:

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

Result Syntax

[
    'Group' => [
        'Description' => '<string>',
        'GroupArn' => '<string>',
        'Name' => '<string>',
    ],
]

Result Details

Errors

BadRequestException:

The request includes one or more parameters that violate validation rules.

ForbiddenException:

The caller isn't authorized to make the request. Check permissions.

NotFoundException:

One or more of the specified resources don't exist.

MethodNotAllowedException:

The request uses an HTTP method that isn't allowed for the specified resource.

TooManyRequestsException:

You've exceeded throttling limits by making too many requests in a period of time.

InternalServerErrorException:

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

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

Errors

BadRequestException:

The request includes one or more parameters that violate validation rules.

ForbiddenException:

The caller isn't authorized to make the request. Check permissions.

NotFoundException:

One or more of the specified resources don't exist.

MethodNotAllowedException:

The request uses an HTTP method that isn't allowed for the specified resource.

TooManyRequestsException:

You've exceeded throttling limits by making too many requests in a period of time.

InternalServerErrorException:

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

Result Syntax

[
    'GroupQuery' => [
        'GroupName' => '<string>',
        'ResourceQuery' => [
            'Query' => '<string>',
            'Type' => 'TAG_FILTERS_1_0|CLOUDFORMATION_STACK_1_0',
        ],
    ],
]

Result Details

Errors

BadRequestException:

The request includes one or more parameters that violate validation rules.

ForbiddenException:

The caller isn't authorized to make the request. Check permissions.

NotFoundException:

One or more of the specified resources don't exist.

MethodNotAllowedException:

The request uses an HTTP method that isn't allowed for the specified resource.

TooManyRequestsException:

You've exceeded throttling limits by making too many requests in a period of time.

InternalServerErrorException:

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

Result Syntax

[
    'Arn' => '<string>',
    'Tags' => ['<string>', ...],
]

Result Details

Errors

BadRequestException:

The request includes one or more parameters that violate validation rules.

ForbiddenException:

The caller isn't authorized to make the request. Check permissions.

NotFoundException:

One or more of the specified resources don't exist.

MethodNotAllowedException:

The request uses an HTTP method that isn't allowed for the specified resource.

TooManyRequestsException:

You've exceeded throttling limits by making too many requests in a period of time.

InternalServerErrorException:

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.

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

Result Syntax

[
    'Failed' => [
        [
            'ErrorCode' => '<string>',
            'ErrorMessage' => '<string>',
            'ResourceArn' => '<string>',
        ],
        // ...
    ],
    'Pending' => [
        [
            'ResourceArn' => '<string>',
        ],
        // ...
    ],
    'Succeeded' => ['<string>', ...],
]

Result Details

Errors

BadRequestException:

The request includes one or more parameters that violate validation rules.

ForbiddenException:

The caller isn't authorized to make the request. Check permissions.

NotFoundException:

One or more of the specified resources don't exist.

MethodNotAllowedException:

The request uses an HTTP method that isn't allowed for the specified resource.

TooManyRequestsException:

You've exceeded throttling limits by making too many requests in a period of time.

InternalServerErrorException:

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

Result Syntax

[
    'NextToken' => '<string>',
    'QueryErrors' => [
        [
            'ErrorCode' => 'CLOUDFORMATION_STACK_INACTIVE|CLOUDFORMATION_STACK_NOT_EXISTING|CLOUDFORMATION_STACK_UNASSUMABLE_ROLE|RESOURCE_TYPE_NOT_SUPPORTED',
            'Message' => '<string>',
        ],
        // ...
    ],
    'ResourceIdentifiers' => [
        [
            'ResourceArn' => '<string>',
            'ResourceType' => '<string>',
        ],
        // ...
    ],
    'Resources' => [
        [
            'Identifier' => [
                'ResourceArn' => '<string>',
                'ResourceType' => '<string>',
            ],
            'Status' => [
                'Name' => 'PENDING',
            ],
        ],
        // ...
    ],
]

Result Details

Errors

UnauthorizedException:

The request was rejected because it doesn't have valid credentials for the target resource.

BadRequestException:

The request includes one or more parameters that violate validation rules.

ForbiddenException:

The caller isn't authorized to make the request. Check permissions.

NotFoundException:

One or more of the specified resources don't exist.

MethodNotAllowedException:

The request uses an HTTP method that isn't allowed for the specified resource.

TooManyRequestsException:

You've exceeded throttling limits by making too many requests in a period of time.

InternalServerErrorException:

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

Result Syntax

[
    'GroupIdentifiers' => [
        [
            'GroupArn' => '<string>',
            'GroupName' => '<string>',
        ],
        // ...
    ],
    'Groups' => [
        [
            'Description' => '<string>',
            'GroupArn' => '<string>',
            'Name' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

BadRequestException:

The request includes one or more parameters that violate validation rules.

ForbiddenException:

The caller isn't authorized to make the request. Check permissions.

MethodNotAllowedException:

The request uses an HTTP method that isn't allowed for the specified resource.

TooManyRequestsException:

You've exceeded throttling limits by making too many requests in a period of time.

InternalServerErrorException:

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

Result Syntax

[]

Result Details

Errors

BadRequestException:

The request includes one or more parameters that violate validation rules.

ForbiddenException:

The caller isn't authorized to make the request. Check permissions.

NotFoundException:

One or more of the specified resources don't exist.

MethodNotAllowedException:

The request uses an HTTP method that isn't allowed for the specified resource.

TooManyRequestsException:

You've exceeded throttling limits by making too many requests in a period of time.

InternalServerErrorException:

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

Result Syntax

[
    'NextToken' => '<string>',
    'QueryErrors' => [
        [
            'ErrorCode' => 'CLOUDFORMATION_STACK_INACTIVE|CLOUDFORMATION_STACK_NOT_EXISTING|CLOUDFORMATION_STACK_UNASSUMABLE_ROLE|RESOURCE_TYPE_NOT_SUPPORTED',
            'Message' => '<string>',
        ],
        // ...
    ],
    'ResourceIdentifiers' => [
        [
            'ResourceArn' => '<string>',
            'ResourceType' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

UnauthorizedException:

The request was rejected because it doesn't have valid credentials for the target resource.

BadRequestException:

The request includes one or more parameters that violate validation rules.

ForbiddenException:

The caller isn't authorized to make the request. Check permissions.

MethodNotAllowedException:

The request uses an HTTP method that isn't allowed for the specified resource.

TooManyRequestsException:

You've exceeded throttling limits by making too many requests in a period of time.

InternalServerErrorException:

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.

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

Result Syntax

[
    'Arn' => '<string>',
    'Tags' => ['<string>', ...],
]

Result Details

Errors

BadRequestException:

The request includes one or more parameters that violate validation rules.

ForbiddenException:

The caller isn't authorized to make the request. Check permissions.

NotFoundException:

One or more of the specified resources don't exist.

MethodNotAllowedException:

The request uses an HTTP method that isn't allowed for the specified resource.

TooManyRequestsException:

You've exceeded throttling limits by making too many requests in a period of time.

InternalServerErrorException:

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

Result Syntax

[
    'Failed' => [
        [
            'ErrorCode' => '<string>',
            'ErrorMessage' => '<string>',
            'ResourceArn' => '<string>',
        ],
        // ...
    ],
    'Pending' => [
        [
            'ResourceArn' => '<string>',
        ],
        // ...
    ],
    'Succeeded' => ['<string>', ...],
]

Result Details

Errors

BadRequestException:

The request includes one or more parameters that violate validation rules.

ForbiddenException:

The caller isn't authorized to make the request. Check permissions.

NotFoundException:

One or more of the specified resources don't exist.

MethodNotAllowedException:

The request uses an HTTP method that isn't allowed for the specified resource.

TooManyRequestsException:

You've exceeded throttling limits by making too many requests in a period of time.

InternalServerErrorException:

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

Result Syntax

[
    'Arn' => '<string>',
    'Keys' => ['<string>', ...],
]

Result Details

Errors

BadRequestException:

The request includes one or more parameters that violate validation rules.

ForbiddenException:

The caller isn't authorized to make the request. Check permissions.

NotFoundException:

One or more of the specified resources don't exist.

MethodNotAllowedException:

The request uses an HTTP method that isn't allowed for the specified resource.

TooManyRequestsException:

You've exceeded throttling limits by making too many requests in a period of time.

InternalServerErrorException:

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

Result Syntax

[
    'AccountSettings' => [
        'GroupLifecycleEventsDesiredStatus' => 'ACTIVE|INACTIVE',
        'GroupLifecycleEventsStatus' => 'ACTIVE|INACTIVE|IN_PROGRESS|ERROR',
        'GroupLifecycleEventsStatusMessage' => '<string>',
    ],
]

Result Details

Errors

BadRequestException:

The request includes one or more parameters that violate validation rules.

ForbiddenException:

The caller isn't authorized to make the request. Check permissions.

MethodNotAllowedException:

The request uses an HTTP method that isn't allowed for the specified resource.

TooManyRequestsException:

You've exceeded throttling limits by making too many requests in a period of time.

InternalServerErrorException:

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

Result Syntax

[
    'Group' => [
        'Description' => '<string>',
        'GroupArn' => '<string>',
        'Name' => '<string>',
    ],
]

Result Details

Errors

BadRequestException:

The request includes one or more parameters that violate validation rules.

ForbiddenException:

The caller isn't authorized to make the request. Check permissions.

NotFoundException:

One or more of the specified resources don't exist.

MethodNotAllowedException:

The request uses an HTTP method that isn't allowed for the specified resource.

TooManyRequestsException:

You've exceeded throttling limits by making too many requests in a period of time.

InternalServerErrorException:

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

Result Syntax

[
    'GroupQuery' => [
        'GroupName' => '<string>',
        'ResourceQuery' => [
            'Query' => '<string>',
            'Type' => 'TAG_FILTERS_1_0|CLOUDFORMATION_STACK_1_0',
        ],
    ],
]

Result Details

Errors

BadRequestException:

The request includes one or more parameters that violate validation rules.

ForbiddenException:

The caller isn't authorized to make the request. Check permissions.

NotFoundException:

One or more of the specified resources don't exist.

MethodNotAllowedException:

The request uses an HTTP method that isn't allowed for the specified resource.

TooManyRequestsException:

You've exceeded throttling limits by making too many requests in a period of time.

InternalServerErrorException:

An internal error occurred while processing the request. Try again later.