Module types 

Data structures used by operation inputs/outputs.

Modules

builders

Builders

error

Error types that AWS Resource Groups can respond with.

Structs

AccountSettings

The Resource Groups settings for this Amazon Web Services account.

FailedResource

A resource that failed to be added to or removed from a group.

Group

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.

GroupConfiguration

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.

GroupConfigurationItem

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.

GroupConfigurationParameter

A parameter for a group configuration item. For details about group service configuration syntax, see Service configurations for resource groups.

GroupFilter

A filter collection that you can use to restrict the results from a List operation to only those you want to include.

GroupIdentifier

The unique identifiers for a resource group.

GroupQuery

A mapping of a query attached to a resource group that determines the Amazon Web Services resources that are members of the group.

GroupingStatusesItem

The information about a grouping or ungrouping resource action.

ListGroupResourcesItem

A structure returned by the ListGroupResources operation that contains identity and group membership status information for one of the resources in the group.

ListGroupingStatusesFilter

A filter name and value pair that is used to obtain more specific results from the list of grouping statuses.

ListTagSyncTasksFilter

Returns tag-sync tasks filtered by the Amazon resource name (ARN) or name of a specified application group.

PendingResource

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.

QueryError

A two-part error structure that can occur in ListGroupResources or SearchResources.

ResourceFilter

A filter name and value pair that is used to obtain more specific results from a list of resources.

ResourceIdentifier

A structure that contains the ARN of a resource and its resource type.

ResourceQuery

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"\]

ResourceStatus

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.

TagSyncTaskItem

The Amazon resource name (ARN) of the tag-sync task.

Enums

GroupConfigurationStatus

When writing a match expression against GroupConfigurationStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

GroupFilterName

When writing a match expression against GroupFilterName, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

GroupLifecycleEventsDesiredStatus

When writing a match expression against GroupLifecycleEventsDesiredStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

GroupLifecycleEventsStatus

When writing a match expression against GroupLifecycleEventsStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

GroupingStatus

When writing a match expression against GroupingStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

GroupingType

When writing a match expression against GroupingType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ListGroupingStatusesFilterName

When writing a match expression against ListGroupingStatusesFilterName, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

QueryErrorCode

When writing a match expression against QueryErrorCode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

QueryType

When writing a match expression against QueryType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ResourceFilterName

When writing a match expression against ResourceFilterName, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ResourceStatusValue

When writing a match expression against ResourceStatusValue, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

TagSyncTaskStatus

When writing a match expression against TagSyncTaskStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.