{ "smithy": "2.0", "metadata": { "suppressions": [ { "id": "HttpMethodSemantics", "namespace": "*" }, { "id": "HttpResponseCodeSemantics", "namespace": "*" }, { "id": "PaginatedTrait", "namespace": "*" }, { "id": "HttpHeaderTrait", "namespace": "*" }, { "id": "HttpUriConflict", "namespace": "*" }, { "id": "Service", "namespace": "*" } ] }, "shapes": { "com.amazonaws.resourcegroupstaggingapi#AmazonResourceType": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 }, "smithy.api#pattern": "^[\\s\\S]*$" } }, "com.amazonaws.resourcegroupstaggingapi#CloudFormationResourceType": { "type": "string" }, "com.amazonaws.resourcegroupstaggingapi#CloudFormationResourceTypes": { "type": "list", "member": { "target": "com.amazonaws.resourcegroupstaggingapi#CloudFormationResourceType" } }, "com.amazonaws.resourcegroupstaggingapi#ComplianceDetails": { "type": "structure", "members": { "NoncompliantKeys": { "target": "com.amazonaws.resourcegroupstaggingapi#TagKeyList", "traits": { "smithy.api#documentation": "

These tag keys on the resource are noncompliant with the effective tag policy.

" } }, "KeysWithNoncompliantValues": { "target": "com.amazonaws.resourcegroupstaggingapi#TagKeyList", "traits": { "smithy.api#documentation": "

These are keys defined in the effective policy that are on the resource with either\n incorrect case treatment or noncompliant values.

" } }, "MissingTagKeys": { "target": "com.amazonaws.resourcegroupstaggingapi#TagKeyList", "traits": { "smithy.api#documentation": "

These tag keys are defined as required in the\n report_required_tag_for block of the effective tag policy, but are\n missing from the resource.

" } }, "ComplianceStatus": { "target": "com.amazonaws.resourcegroupstaggingapi#ComplianceStatus", "traits": { "smithy.api#documentation": "

Whether a resource is compliant with the effective tag policy.

" } } }, "traits": { "smithy.api#documentation": "

Information that shows whether a resource is compliant with the effective tag policy,\n including details on any noncompliant tag keys.

" } }, "com.amazonaws.resourcegroupstaggingapi#ComplianceStatus": { "type": "boolean" }, "com.amazonaws.resourcegroupstaggingapi#ConcurrentModificationException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.resourcegroupstaggingapi#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

The request failed because the target of the operation is currently being modified by\n a different request. Try again later.

", "smithy.api#error": "client" } }, "com.amazonaws.resourcegroupstaggingapi#ConstraintViolationException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.resourcegroupstaggingapi#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

The request failed because performing the operation would violate a constraint.

\n

Some of the reasons in the following list might not apply to this specific\n operation.

\n ", "smithy.api#error": "client" } }, "com.amazonaws.resourcegroupstaggingapi#DescribeReportCreation": { "type": "operation", "input": { "target": "com.amazonaws.resourcegroupstaggingapi#DescribeReportCreationInput" }, "output": { "target": "com.amazonaws.resourcegroupstaggingapi#DescribeReportCreationOutput" }, "errors": [ { "target": "com.amazonaws.resourcegroupstaggingapi#ConstraintViolationException" }, { "target": "com.amazonaws.resourcegroupstaggingapi#InternalServiceException" }, { "target": "com.amazonaws.resourcegroupstaggingapi#InvalidParameterException" }, { "target": "com.amazonaws.resourcegroupstaggingapi#ThrottledException" } ], "traits": { "smithy.api#documentation": "

Describes the status of the StartReportCreation operation.

\n

You can call this operation only from the organization's \n management account and from the us-east-1 Region.

", "smithy.api#http": { "method": "POST", "uri": "/DescribeReportCreation", "code": 200 } } }, "com.amazonaws.resourcegroupstaggingapi#DescribeReportCreationInput": { "type": "structure", "members": {}, "traits": { "smithy.api#input": {} } }, "com.amazonaws.resourcegroupstaggingapi#DescribeReportCreationOutput": { "type": "structure", "members": { "Status": { "target": "com.amazonaws.resourcegroupstaggingapi#Status", "traits": { "smithy.api#documentation": "

Reports the status of the operation.

\n

The operation status can be one of the following:

\n " } }, "S3Location": { "target": "com.amazonaws.resourcegroupstaggingapi#S3Location", "traits": { "smithy.api#documentation": "

The path to the Amazon S3 bucket where the report was stored on creation.

" } }, "StartDate": { "target": "com.amazonaws.resourcegroupstaggingapi#StartDate", "traits": { "smithy.api#documentation": "

The date and time that the report was started.

" } }, "ErrorMessage": { "target": "com.amazonaws.resourcegroupstaggingapi#ErrorMessage", "traits": { "smithy.api#documentation": "

Details of the common errors that all operations return.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.resourcegroupstaggingapi#ErrorCode": { "type": "enum", "members": { "INTERNAL_SERVICE_EXCEPTION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "InternalServiceException" } }, "INVALID_PARAMETER_EXCEPTION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "InvalidParameterException" } } } }, "com.amazonaws.resourcegroupstaggingapi#ErrorMessage": { "type": "string" }, "com.amazonaws.resourcegroupstaggingapi#ExceptionMessage": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 2048 } } }, "com.amazonaws.resourcegroupstaggingapi#ExcludeCompliantResources": { "type": "boolean" }, "com.amazonaws.resourcegroupstaggingapi#FailedResourcesMap": { "type": "map", "key": { "target": "com.amazonaws.resourcegroupstaggingapi#ResourceARN" }, "value": { "target": "com.amazonaws.resourcegroupstaggingapi#FailureInfo" } }, "com.amazonaws.resourcegroupstaggingapi#FailureInfo": { "type": "structure", "members": { "StatusCode": { "target": "com.amazonaws.resourcegroupstaggingapi#StatusCode", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

The HTTP status code of the common error.

" } }, "ErrorCode": { "target": "com.amazonaws.resourcegroupstaggingapi#ErrorCode", "traits": { "smithy.api#documentation": "

The code of the common error. Valid values include\n InternalServiceException, InvalidParameterException, and\n any valid error code returned by the Amazon Web Services service that hosts the resource that you want\n to tag.

" } }, "ErrorMessage": { "target": "com.amazonaws.resourcegroupstaggingapi#ErrorMessage", "traits": { "smithy.api#documentation": "

The message of the common error.

" } } }, "traits": { "smithy.api#documentation": "

Information about the errors that are returned for each failed resource. This\n information can include InternalServiceException and\n InvalidParameterException errors. It can also include any valid error\n code returned by the Amazon Web Services service that hosts the resource that the ARN key\n represents.

\n

The following are common error codes that you might receive from other Amazon Web Services\n services:

\n \n

For more information on errors that are generated from other Amazon Web Services services, see the\n documentation for that service.

" } }, "com.amazonaws.resourcegroupstaggingapi#GetComplianceSummary": { "type": "operation", "input": { "target": "com.amazonaws.resourcegroupstaggingapi#GetComplianceSummaryInput" }, "output": { "target": "com.amazonaws.resourcegroupstaggingapi#GetComplianceSummaryOutput" }, "errors": [ { "target": "com.amazonaws.resourcegroupstaggingapi#ConstraintViolationException" }, { "target": "com.amazonaws.resourcegroupstaggingapi#InternalServiceException" }, { "target": "com.amazonaws.resourcegroupstaggingapi#InvalidParameterException" }, { "target": "com.amazonaws.resourcegroupstaggingapi#ThrottledException" } ], "traits": { "smithy.api#documentation": "

Returns a table that shows counts of resources that are noncompliant with their tag\n policies.

\n

For more information on tag policies, see Tag Policies in\n the Organizations User Guide.\n

\n

You can call this operation only from the organization's \n management account and from the us-east-1 Region.

\n

This operation supports pagination, where the response can be sent in \n multiple pages. You should check the PaginationToken response parameter to determine\n if there are additional results available to return. Repeat the query, passing the\n PaginationToken response parameter value as an input to the next request until you\n recieve a null value. A null value for PaginationToken indicates that\n there are no more results waiting to be returned.

", "smithy.api#http": { "method": "POST", "uri": "/GetComplianceSummary", "code": 200 }, "smithy.api#paginated": { "inputToken": "PaginationToken", "outputToken": "PaginationToken", "items": "SummaryList", "pageSize": "MaxResults" } } }, "com.amazonaws.resourcegroupstaggingapi#GetComplianceSummaryInput": { "type": "structure", "members": { "TargetIdFilters": { "target": "com.amazonaws.resourcegroupstaggingapi#TargetIdFilterList", "traits": { "smithy.api#documentation": "

Specifies target identifiers (usually, specific account IDs) to limit the output by.\n If you use this parameter, the count of returned noncompliant resources includes only\n resources with the specified target IDs.

" } }, "RegionFilters": { "target": "com.amazonaws.resourcegroupstaggingapi#RegionFilterList", "traits": { "smithy.api#documentation": "

Specifies a list of Amazon Web Services Regions to limit the output to. If you use this parameter,\n the count of returned noncompliant resources includes only resources in the specified\n Regions.

" } }, "ResourceTypeFilters": { "target": "com.amazonaws.resourcegroupstaggingapi#ResourceTypeFilterList", "traits": { "smithy.api#documentation": "

Specifies that you want the response to include information for only resources of the\n specified types. The format of each resource type is\n service[:resourceType]. For example, specifying a resource type of\n ec2 returns all Amazon EC2 resources (which includes EC2 instances).\n Specifying a resource type of ec2:instance returns only EC2\n instances.

\n

The string for each service name and resource type is the same as that embedded in a\n resource's Amazon Resource Name (ARN). Consult the \n Amazon Web Services General Reference\n \n for the following:

\n \n \n

For the list of services whose resources you can tag using the Resource Groups Tagging API, see\n Services that support the Resource Groups Tagging API. If an Amazon Web Services\n service isn't listed on that page, you might still be able to tag that service's\n resources by using that service's native tagging operations instead of using\n Resource Groups Tagging API operations. All tagged resources, whether the tagging used the Resource Groups Tagging API\n or not, are returned by the Get* operation.

\n
\n

You can specify multiple resource types by using a comma separated array. The array\n can include up to 100 items. Note that the length constraint requirement applies to each\n resource type filter.

" } }, "TagKeyFilters": { "target": "com.amazonaws.resourcegroupstaggingapi#TagKeyFilterList", "traits": { "smithy.api#documentation": "

Specifies that you want the response to include information for only resources that\n have tags with the specified tag keys. If you use this parameter, the count of returned\n noncompliant resources includes only resources that have the specified tag keys.

" } }, "GroupBy": { "target": "com.amazonaws.resourcegroupstaggingapi#GroupBy", "traits": { "smithy.api#documentation": "

Specifies a list of attributes to group the counts of noncompliant resources by. If\n supplied, the counts are sorted by those attributes.

" } }, "MaxResults": { "target": "com.amazonaws.resourcegroupstaggingapi#MaxResultsGetComplianceSummary", "traits": { "smithy.api#documentation": "

Specifies the maximum number of results to be returned in each page. A \n query can return fewer than this maximum, even if there are more results still to return. You\n should always check the PaginationToken response value to see if there are more\n results. You can specify a minimum of 1 and a maximum value of 100.

" } }, "PaginationToken": { "target": "com.amazonaws.resourcegroupstaggingapi#PaginationToken", "traits": { "smithy.api#documentation": "

Specifies a PaginationToken response value from a \n previous request to indicate that you want the next page of results. Leave this parameter empty \n in your initial request.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.resourcegroupstaggingapi#GetComplianceSummaryOutput": { "type": "structure", "members": { "SummaryList": { "target": "com.amazonaws.resourcegroupstaggingapi#SummaryList", "traits": { "smithy.api#documentation": "

A table that shows counts of noncompliant resources.

" } }, "PaginationToken": { "target": "com.amazonaws.resourcegroupstaggingapi#PaginationToken", "traits": { "smithy.api#documentation": "

A string that indicates that there is more data available than this\n response contains. To receive the next part of the response, specify this response value \n as the PaginationToken value in the request for the next page.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.resourcegroupstaggingapi#GetResources": { "type": "operation", "input": { "target": "com.amazonaws.resourcegroupstaggingapi#GetResourcesInput" }, "output": { "target": "com.amazonaws.resourcegroupstaggingapi#GetResourcesOutput" }, "errors": [ { "target": "com.amazonaws.resourcegroupstaggingapi#InternalServiceException" }, { "target": "com.amazonaws.resourcegroupstaggingapi#InvalidParameterException" }, { "target": "com.amazonaws.resourcegroupstaggingapi#PaginationTokenExpiredException" }, { "target": "com.amazonaws.resourcegroupstaggingapi#ThrottledException" } ], "traits": { "smithy.api#documentation": "

Returns all the tagged or previously tagged resources that are located in the\n specified Amazon Web Services Region for the account.

\n

Depending on what information you want returned, you can also specify the\n following:

\n \n

This operation supports pagination, where the response can be sent in \n multiple pages. You should check the PaginationToken response parameter to determine\n if there are additional results available to return. Repeat the query, passing the\n PaginationToken response parameter value as an input to the next request until you\n recieve a null value. A null value for PaginationToken indicates that\n there are no more results waiting to be returned.

\n \n

\n GetResources does not return untagged resources.

\n

To find untagged resources in your account, use Amazon Web Services Resource Explorer with a\n query that uses tag:none. For more information, see Search query syntax reference for Resource Explorer.

\n
", "smithy.api#http": { "method": "POST", "uri": "/GetResources", "code": 200 }, "smithy.api#paginated": { "inputToken": "PaginationToken", "outputToken": "PaginationToken", "items": "ResourceTagMappingList", "pageSize": "ResourcesPerPage" } } }, "com.amazonaws.resourcegroupstaggingapi#GetResourcesInput": { "type": "structure", "members": { "PaginationToken": { "target": "com.amazonaws.resourcegroupstaggingapi#PaginationToken", "traits": { "smithy.api#documentation": "

Specifies a PaginationToken response value from a \n previous request to indicate that you want the next page of results. Leave this parameter empty \n in your initial request.

" } }, "TagFilters": { "target": "com.amazonaws.resourcegroupstaggingapi#TagFilterList", "traits": { "smithy.api#documentation": "

Specifies a list of TagFilters (keys and values) to restrict the output to only those\n resources that have tags with the specified keys and, if included, the specified values.\n Each TagFilter must contain a key with values optional. A request can\n include up to 50 keys, and each key can include up to 20 values.

\n

You can't specify both this parameter and the ResourceArnList parameter\n in the same request. If you do, you get an Invalid Parameter\n exception.

\n

Note the following when deciding how to use TagFilters:

\n " } }, "ResourcesPerPage": { "target": "com.amazonaws.resourcegroupstaggingapi#ResourcesPerPage", "traits": { "smithy.api#documentation": "

Specifies the maximum number of results to be returned in each page. A \n query can return fewer than this maximum, even if there are more results still to return. You\n should always check the PaginationToken response value to see if there are more\n results. You can specify a minimum of 1 and a maximum value of 100.

" } }, "TagsPerPage": { "target": "com.amazonaws.resourcegroupstaggingapi#TagsPerPage", "traits": { "smithy.api#documentation": "

Amazon Web Services recommends using ResourcesPerPage instead of this parameter.

\n

A limit that restricts the number of tags (key and value pairs) returned by\n GetResources in paginated output. A resource with no tags is counted as\n having one tag (one key and value pair).

\n

\n GetResources does not split a resource and its associated tags across\n pages. If the specified TagsPerPage would cause such a break, a\n PaginationToken is returned in place of the affected resource and its\n tags. Use that token in another request to get the remaining data. For example, if you\n specify a TagsPerPage of 100 and the account has 22 resources\n with 10 tags each (meaning that each resource has 10 key and value pairs), the output\n will consist of three pages. The first page displays the first 10 resources, each with\n its 10 tags. The second page displays the next 10 resources, each with its 10 tags. The\n third page displays the remaining 2 resources, each with its 10 tags.

\n

You can set TagsPerPage to a minimum of 100 items up to a maximum of 500\n items.

" } }, "ResourceTypeFilters": { "target": "com.amazonaws.resourcegroupstaggingapi#ResourceTypeFilterList", "traits": { "smithy.api#documentation": "

Specifies the resource types that you want included in the response. The format of\n each resource type is service[:resourceType]. For example, specifying a\n service of ec2 returns all Amazon EC2 resources (which includes EC2 instances).\n Specifying a resource type of ec2:instance returns only EC2 instances.

\n

You can't specify both this parameter and the ResourceArnList parameter\n in the same request. If you do, you get an Invalid Parameter\n exception.

\n

The string for each service name and resource type is the same as that embedded in a\n resource's Amazon Resource Name (ARN).

\n \n

For the list of services whose resources you can tag using the Resource Groups Tagging API, see\n Services that support the Resource Groups Tagging API. If an Amazon Web Services\n service isn't listed on that page, you might still be able to tag that service's\n resources by using that service's native tagging operations instead of using\n Resource Groups Tagging API operations. All tagged resources, whether the tagging used the Resource Groups Tagging API\n or not, are returned by the Get* operation.

\n
\n

You can specify multiple resource types by using an array. The array can include up to\n 100 items. Note that the length constraint requirement applies to each resource type\n filter. For example, the following string would limit the response to only Amazon EC2\n instances, Amazon S3 buckets, or any Audit Manager resource:

\n

\n ec2:instance,s3:bucket,auditmanager\n

" } }, "IncludeComplianceDetails": { "target": "com.amazonaws.resourcegroupstaggingapi#IncludeComplianceDetails", "traits": { "smithy.api#documentation": "

Specifies whether to include details regarding the compliance with the effective tag\n policy. Set this to true to determine whether resources are compliant with\n the tag policy and to get details.

" } }, "ExcludeCompliantResources": { "target": "com.amazonaws.resourcegroupstaggingapi#ExcludeCompliantResources", "traits": { "smithy.api#documentation": "

Specifies whether to exclude resources that are compliant with the tag policy. Set\n this to true if you are interested in retrieving information on\n noncompliant resources only.

\n

You can use this parameter only if the IncludeComplianceDetails parameter\n is also set to true.

" } }, "ResourceARNList": { "target": "com.amazonaws.resourcegroupstaggingapi#ResourceARNListForGet", "traits": { "smithy.api#documentation": "

Specifies a list of ARNs of resources for which you want to retrieve tag data.

\n

You can't specify both this parameter and the ResourceTypeFilters\n parameter in the same request. If you do, you get an Invalid Parameter\n exception.

\n

You can't specify both this parameter and the TagFilters parameter in the\n same request. If you do, you get an Invalid Parameter exception.

\n

You can't specify both this parameter and any of the pagination parameters\n (ResourcesPerPage, TagsPerPage,\n PaginationToken) in the same request. If you do, you get an\n Invalid Parameter exception.

\n

If a resource specified by this parameter doesn't exist, it doesn't generate an error;\n it simply isn't included in the response.

\n

An ARN (Amazon Resource Name) uniquely identifies a resource. For more information,\n see Amazon\n Resource Names (ARNs) and Amazon Web Services Service Namespaces in the\n Amazon Web Services General Reference.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.resourcegroupstaggingapi#GetResourcesOutput": { "type": "structure", "members": { "PaginationToken": { "target": "com.amazonaws.resourcegroupstaggingapi#PaginationToken", "traits": { "smithy.api#documentation": "

A string that indicates that there is more data available than this\n response contains. To receive the next part of the response, specify this response value \n as the PaginationToken value in the request for the next page.

" } }, "ResourceTagMappingList": { "target": "com.amazonaws.resourcegroupstaggingapi#ResourceTagMappingList", "traits": { "smithy.api#documentation": "

A list of resource ARNs and the tags (keys and values) associated with \n each.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.resourcegroupstaggingapi#GetTagKeys": { "type": "operation", "input": { "target": "com.amazonaws.resourcegroupstaggingapi#GetTagKeysInput" }, "output": { "target": "com.amazonaws.resourcegroupstaggingapi#GetTagKeysOutput" }, "errors": [ { "target": "com.amazonaws.resourcegroupstaggingapi#InternalServiceException" }, { "target": "com.amazonaws.resourcegroupstaggingapi#InvalidParameterException" }, { "target": "com.amazonaws.resourcegroupstaggingapi#PaginationTokenExpiredException" }, { "target": "com.amazonaws.resourcegroupstaggingapi#ThrottledException" } ], "traits": { "smithy.api#documentation": "

Returns all tag keys currently in use in the specified Amazon Web Services Region for the calling\n account.

\n

This operation supports pagination, where the response can be sent in \n multiple pages. You should check the PaginationToken response parameter to determine\n if there are additional results available to return. Repeat the query, passing the\n PaginationToken response parameter value as an input to the next request until you\n recieve a null value. A null value for PaginationToken indicates that\n there are no more results waiting to be returned.

", "smithy.api#http": { "method": "POST", "uri": "/GetTagKeys", "code": 200 }, "smithy.api#paginated": { "inputToken": "PaginationToken", "outputToken": "PaginationToken", "items": "TagKeys" } } }, "com.amazonaws.resourcegroupstaggingapi#GetTagKeysInput": { "type": "structure", "members": { "PaginationToken": { "target": "com.amazonaws.resourcegroupstaggingapi#PaginationToken", "traits": { "smithy.api#documentation": "

Specifies a PaginationToken response value from a \n previous request to indicate that you want the next page of results. Leave this parameter empty \n in your initial request.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.resourcegroupstaggingapi#GetTagKeysOutput": { "type": "structure", "members": { "PaginationToken": { "target": "com.amazonaws.resourcegroupstaggingapi#PaginationToken", "traits": { "smithy.api#documentation": "

A string that indicates that there is more data available than this\n response contains. To receive the next part of the response, specify this response value \n as the PaginationToken value in the request for the next page.

" } }, "TagKeys": { "target": "com.amazonaws.resourcegroupstaggingapi#TagKeyList", "traits": { "smithy.api#documentation": "

A list of all tag keys in the Amazon Web Services account.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.resourcegroupstaggingapi#GetTagValues": { "type": "operation", "input": { "target": "com.amazonaws.resourcegroupstaggingapi#GetTagValuesInput" }, "output": { "target": "com.amazonaws.resourcegroupstaggingapi#GetTagValuesOutput" }, "errors": [ { "target": "com.amazonaws.resourcegroupstaggingapi#InternalServiceException" }, { "target": "com.amazonaws.resourcegroupstaggingapi#InvalidParameterException" }, { "target": "com.amazonaws.resourcegroupstaggingapi#PaginationTokenExpiredException" }, { "target": "com.amazonaws.resourcegroupstaggingapi#ThrottledException" } ], "traits": { "smithy.api#documentation": "

Returns all tag values for the specified key that are used in the specified Amazon Web Services\n Region for the calling account.

\n

This operation supports pagination, where the response can be sent in \n multiple pages. You should check the PaginationToken response parameter to determine\n if there are additional results available to return. Repeat the query, passing the\n PaginationToken response parameter value as an input to the next request until you\n recieve a null value. A null value for PaginationToken indicates that\n there are no more results waiting to be returned.

", "smithy.api#http": { "method": "POST", "uri": "/GetTagValues", "code": 200 }, "smithy.api#paginated": { "inputToken": "PaginationToken", "outputToken": "PaginationToken", "items": "TagValues" } } }, "com.amazonaws.resourcegroupstaggingapi#GetTagValuesInput": { "type": "structure", "members": { "PaginationToken": { "target": "com.amazonaws.resourcegroupstaggingapi#PaginationToken", "traits": { "smithy.api#documentation": "

Specifies a PaginationToken response value from a \n previous request to indicate that you want the next page of results. Leave this parameter empty \n in your initial request.

" } }, "Key": { "target": "com.amazonaws.resourcegroupstaggingapi#TagKey", "traits": { "smithy.api#documentation": "

Specifies the tag key for which you want to list all existing values that are\n currently used in the specified Amazon Web Services Region for the calling account.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.resourcegroupstaggingapi#GetTagValuesOutput": { "type": "structure", "members": { "PaginationToken": { "target": "com.amazonaws.resourcegroupstaggingapi#PaginationToken", "traits": { "smithy.api#documentation": "

A string that indicates that there is more data available than this\n response contains. To receive the next part of the response, specify this response value \n as the PaginationToken value in the request for the next page.

" } }, "TagValues": { "target": "com.amazonaws.resourcegroupstaggingapi#TagValuesOutputList", "traits": { "smithy.api#documentation": "

A list of all tag values for the specified key currently used in the specified Amazon Web Services\n Region for the calling account.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.resourcegroupstaggingapi#GroupBy": { "type": "list", "member": { "target": "com.amazonaws.resourcegroupstaggingapi#GroupByAttribute" } }, "com.amazonaws.resourcegroupstaggingapi#GroupByAttribute": { "type": "enum", "members": { "TARGET_ID": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TARGET_ID" } }, "REGION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "REGION" } }, "RESOURCE_TYPE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RESOURCE_TYPE" } } } }, "com.amazonaws.resourcegroupstaggingapi#IncludeComplianceDetails": { "type": "boolean" }, "com.amazonaws.resourcegroupstaggingapi#InternalServiceException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.resourcegroupstaggingapi#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

The request processing failed because of an unknown error, exception, or failure. You\n can retry the request.

", "smithy.api#error": "server" } }, "com.amazonaws.resourcegroupstaggingapi#InvalidParameterException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.resourcegroupstaggingapi#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

The request failed because of one of the following reasons:

\n ", "smithy.api#error": "client" } }, "com.amazonaws.resourcegroupstaggingapi#LastUpdated": { "type": "string" }, "com.amazonaws.resourcegroupstaggingapi#ListRequiredTags": { "type": "operation", "input": { "target": "com.amazonaws.resourcegroupstaggingapi#ListRequiredTagsInput" }, "output": { "target": "com.amazonaws.resourcegroupstaggingapi#ListRequiredTagsOutput" }, "errors": [ { "target": "com.amazonaws.resourcegroupstaggingapi#InternalServiceException" }, { "target": "com.amazonaws.resourcegroupstaggingapi#InvalidParameterException" }, { "target": "com.amazonaws.resourcegroupstaggingapi#PaginationTokenExpiredException" }, { "target": "com.amazonaws.resourcegroupstaggingapi#ThrottledException" } ], "traits": { "smithy.api#documentation": "

Lists the required tags for supported resource types in an Amazon Web Services account.

", "smithy.api#http": { "method": "POST", "uri": "/ListRequiredTags", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "RequiredTags", "pageSize": "MaxResults" } } }, "com.amazonaws.resourcegroupstaggingapi#ListRequiredTagsInput": { "type": "structure", "members": { "NextToken": { "target": "com.amazonaws.resourcegroupstaggingapi#PaginationToken", "traits": { "smithy.api#documentation": "

A token for requesting another page of required tags if the NextToken response element\n indicates that more required tags are available. Use the value of the returned NextToken\n element in your request until the token comes back as null. Pass null if this is the\n first call.

" } }, "MaxResults": { "target": "com.amazonaws.resourcegroupstaggingapi#MaxResultsForListRequiredTags", "traits": { "smithy.api#documentation": "

The maximum number of required tags.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.resourcegroupstaggingapi#ListRequiredTagsOutput": { "type": "structure", "members": { "RequiredTags": { "target": "com.amazonaws.resourcegroupstaggingapi#RequiredTagsForListRequiredTags", "traits": { "smithy.api#documentation": "

The required tags.

" } }, "NextToken": { "target": "com.amazonaws.resourcegroupstaggingapi#PaginationToken", "traits": { "smithy.api#documentation": "

A token for requesting another page of required tags if the NextToken response element\n indicates that more required tags are available. Use the value of the returned NextToken\n element in your request until the token comes back as null. Pass null if this is the\n first call.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.resourcegroupstaggingapi#MaxResultsForListRequiredTags": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 200 } } }, "com.amazonaws.resourcegroupstaggingapi#MaxResultsGetComplianceSummary": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 1000 } } }, "com.amazonaws.resourcegroupstaggingapi#NonCompliantResources": { "type": "long", "traits": { "smithy.api#default": 0 } }, "com.amazonaws.resourcegroupstaggingapi#PaginationToken": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 2048 }, "smithy.api#pattern": "^[\\s\\S]*$" } }, "com.amazonaws.resourcegroupstaggingapi#PaginationTokenExpiredException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.resourcegroupstaggingapi#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

The request failed because the specified PaginationToken has expired. A\n PaginationToken is valid for a maximum of 15 minutes.

", "smithy.api#error": "client" } }, "com.amazonaws.resourcegroupstaggingapi#Region": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#pattern": "^[\\s\\S]*$" } }, "com.amazonaws.resourcegroupstaggingapi#RegionFilterList": { "type": "list", "member": { "target": "com.amazonaws.resourcegroupstaggingapi#Region" }, "traits": { "smithy.api#length": { "min": 1, "max": 100 } } }, "com.amazonaws.resourcegroupstaggingapi#ReportingTagKeys": { "type": "list", "member": { "target": "com.amazonaws.resourcegroupstaggingapi#TagKey" } }, "com.amazonaws.resourcegroupstaggingapi#RequiredTag": { "type": "structure", "members": { "ResourceType": { "target": "com.amazonaws.resourcegroupstaggingapi#ResourceType", "traits": { "smithy.api#documentation": "

Describes the resource type for the required tag keys.

" } }, "CloudFormationResourceTypes": { "target": "com.amazonaws.resourcegroupstaggingapi#CloudFormationResourceTypes", "traits": { "smithy.api#documentation": "

Describes the CloudFormation resource type assigned the required tag keys.

" } }, "ReportingTagKeys": { "target": "com.amazonaws.resourcegroupstaggingapi#ReportingTagKeys", "traits": { "smithy.api#documentation": "

These tag keys are marked as required in the report_required_tag_for block of the effective tag policy.

" } } }, "traits": { "smithy.api#documentation": "

Information that describes the required tags for a given resource type.

" } }, "com.amazonaws.resourcegroupstaggingapi#RequiredTagsForListRequiredTags": { "type": "list", "member": { "target": "com.amazonaws.resourcegroupstaggingapi#RequiredTag" } }, "com.amazonaws.resourcegroupstaggingapi#ResourceARN": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1011 }, "smithy.api#pattern": "^[\\s\\S]*$" } }, "com.amazonaws.resourcegroupstaggingapi#ResourceARNListForGet": { "type": "list", "member": { "target": "com.amazonaws.resourcegroupstaggingapi#ResourceARN" }, "traits": { "smithy.api#length": { "min": 1, "max": 100 } } }, "com.amazonaws.resourcegroupstaggingapi#ResourceARNListForTagUntag": { "type": "list", "member": { "target": "com.amazonaws.resourcegroupstaggingapi#ResourceARN" }, "traits": { "smithy.api#length": { "min": 1, "max": 20 } } }, "com.amazonaws.resourcegroupstaggingapi#ResourceGroupsTaggingAPI_20170126": { "type": "service", "version": "2017-01-26", "operations": [ { "target": "com.amazonaws.resourcegroupstaggingapi#DescribeReportCreation" }, { "target": "com.amazonaws.resourcegroupstaggingapi#GetComplianceSummary" }, { "target": "com.amazonaws.resourcegroupstaggingapi#GetResources" }, { "target": "com.amazonaws.resourcegroupstaggingapi#GetTagKeys" }, { "target": "com.amazonaws.resourcegroupstaggingapi#GetTagValues" }, { "target": "com.amazonaws.resourcegroupstaggingapi#ListRequiredTags" }, { "target": "com.amazonaws.resourcegroupstaggingapi#StartReportCreation" }, { "target": "com.amazonaws.resourcegroupstaggingapi#TagResources" }, { "target": "com.amazonaws.resourcegroupstaggingapi#UntagResources" } ], "traits": { "aws.api#service": { "sdkId": "Resource Groups Tagging API", "arnNamespace": "tagging", "cloudFormationName": "ResourceGroupsTaggingAPI", "cloudTrailEventSource": "resourcegroupstaggingapi.amazonaws.com", "docId": "resourcegroupstaggingapi-2017-01-26", "endpointPrefix": "tagging" }, "aws.auth#sigv4": { "name": "tagging" }, "aws.protocols#awsJson1_1": {}, "smithy.api#documentation": "Resource Groups Tagging API", "smithy.api#title": "AWS Resource Groups Tagging API", "smithy.protocols#rpcv2Cbor": {}, "smithy.rules#endpointBdd": { "version": "1.1", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "results": [ { "conditions": [], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://tagging-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://tagging-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://tagging.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://tagging.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "root": 2, "nodeCount": 13, "nodes": "/////wAAAAH/////AAAAAAAAAAwAAAADAAAAAQAAAAQF9eELAAAAAgAAAAUF9eELAAAAAwAAAAgAAAAGAAAABAAAAAcF9eEKAAAABQX14QgF9eEJAAAABAAAAAoAAAAJAAAABgX14QYF9eEHAAAABQAAAAsF9eEFAAAABgX14QQF9eEFAAAAAwX14QEAAAANAAAABAX14QIF9eED" }, "smithy.rules#endpointRuleSet": { "version": "1.0", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Region" } ] } ], "rules": [ { "conditions": [ { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] } ] }, { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://tagging-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://tagging-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://tagging.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } ], "type": "tree" }, { "conditions": [], "endpoint": { "url": "https://tagging.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ] }, "smithy.rules#endpointTests": { "testCases": [ { "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://tagging.af-south-1.amazonaws.com" } }, "params": { "Region": "af-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://tagging.ap-east-1.amazonaws.com" } }, "params": { "Region": "ap-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://tagging.ap-northeast-1.amazonaws.com" } }, "params": { "Region": "ap-northeast-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://tagging.ap-northeast-2.amazonaws.com" } }, "params": { "Region": "ap-northeast-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://tagging.ap-northeast-3.amazonaws.com" } }, "params": { "Region": "ap-northeast-3", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://tagging.ap-south-1.amazonaws.com" } }, "params": { "Region": "ap-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://tagging.ap-southeast-1.amazonaws.com" } }, "params": { "Region": "ap-southeast-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://tagging.ap-southeast-2.amazonaws.com" } }, "params": { "Region": "ap-southeast-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://tagging.ap-southeast-3.amazonaws.com" } }, "params": { "Region": "ap-southeast-3", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://tagging.ca-central-1.amazonaws.com" } }, "params": { "Region": "ca-central-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://tagging.eu-central-1.amazonaws.com" } }, "params": { "Region": "eu-central-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://tagging.eu-north-1.amazonaws.com" } }, "params": { "Region": "eu-north-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://tagging.eu-south-1.amazonaws.com" } }, "params": { "Region": "eu-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://tagging.eu-west-1.amazonaws.com" } }, "params": { "Region": "eu-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://tagging.eu-west-2.amazonaws.com" } }, "params": { "Region": "eu-west-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://tagging.eu-west-3.amazonaws.com" } }, "params": { "Region": "eu-west-3", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://tagging.me-south-1.amazonaws.com" } }, "params": { "Region": "me-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://tagging.sa-east-1.amazonaws.com" } }, "params": { "Region": "sa-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://tagging.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://tagging.us-east-2.amazonaws.com" } }, "params": { "Region": "us-east-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://tagging.us-west-1.amazonaws.com" } }, "params": { "Region": "us-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://tagging.us-west-2.amazonaws.com" } }, "params": { "Region": "us-west-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://tagging-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://tagging-fips.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://tagging.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://tagging.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://tagging.cn-northwest-1.amazonaws.com.cn" } }, "params": { "Region": "cn-northwest-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://tagging-fips.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://tagging-fips.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://tagging.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://tagging.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://tagging.us-gov-west-1.amazonaws.com" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://tagging-fips.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://tagging-fips.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://tagging.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://tagging.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://tagging-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://tagging.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://tagging-fips.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips enabled and dualstack disabled", "expect": { "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips disabled and dualstack enabled", "expect": { "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true, "Endpoint": "https://example.com" } }, { "documentation": "Missing region", "expect": { "error": "Invalid Configuration: Missing Region" } } ], "version": "1.0" } } }, "com.amazonaws.resourcegroupstaggingapi#ResourceTagMapping": { "type": "structure", "members": { "ResourceARN": { "target": "com.amazonaws.resourcegroupstaggingapi#ResourceARN", "traits": { "smithy.api#documentation": "

The ARN of the resource.

" } }, "Tags": { "target": "com.amazonaws.resourcegroupstaggingapi#TagList", "traits": { "smithy.api#documentation": "

The tags that have been applied to one or more Amazon Web Services resources.

" } }, "ComplianceDetails": { "target": "com.amazonaws.resourcegroupstaggingapi#ComplianceDetails", "traits": { "smithy.api#documentation": "

Information that shows whether a resource is compliant with the effective tag policy,\n including details on any noncompliant tag keys.

" } } }, "traits": { "smithy.api#documentation": "

A list of resource ARNs and the tags (keys and values) that are associated with\n each.

" } }, "com.amazonaws.resourcegroupstaggingapi#ResourceTagMappingList": { "type": "list", "member": { "target": "com.amazonaws.resourcegroupstaggingapi#ResourceTagMapping" } }, "com.amazonaws.resourcegroupstaggingapi#ResourceType": { "type": "string" }, "com.amazonaws.resourcegroupstaggingapi#ResourceTypeFilterList": { "type": "list", "member": { "target": "com.amazonaws.resourcegroupstaggingapi#AmazonResourceType" } }, "com.amazonaws.resourcegroupstaggingapi#ResourcesPerPage": { "type": "integer" }, "com.amazonaws.resourcegroupstaggingapi#S3Bucket": { "type": "string", "traits": { "smithy.api#length": { "min": 3, "max": 63 }, "smithy.api#pattern": "^[a-z0-9.-]*$" } }, "com.amazonaws.resourcegroupstaggingapi#S3Location": { "type": "string" }, "com.amazonaws.resourcegroupstaggingapi#StartDate": { "type": "string" }, "com.amazonaws.resourcegroupstaggingapi#StartReportCreation": { "type": "operation", "input": { "target": "com.amazonaws.resourcegroupstaggingapi#StartReportCreationInput" }, "output": { "target": "com.amazonaws.resourcegroupstaggingapi#StartReportCreationOutput" }, "errors": [ { "target": "com.amazonaws.resourcegroupstaggingapi#ConcurrentModificationException" }, { "target": "com.amazonaws.resourcegroupstaggingapi#ConstraintViolationException" }, { "target": "com.amazonaws.resourcegroupstaggingapi#InternalServiceException" }, { "target": "com.amazonaws.resourcegroupstaggingapi#InvalidParameterException" }, { "target": "com.amazonaws.resourcegroupstaggingapi#ThrottledException" } ], "traits": { "smithy.api#documentation": "

Generates a report that lists all tagged resources in the accounts across your\n organization and tells whether each resource is compliant with the effective tag policy.\n Compliance data is refreshed daily. The report is generated asynchronously.

\n

The generated report is saved to the following location:

\n

\n s3://amzn-s3-demo-bucket/AwsTagPolicies/o-exampleorgid/YYYY-MM-ddTHH:mm:ssZ/report.csv\n

\n

For more information about evaluating resource compliance with tag policies, including\n the required permissions, review Permissions for evaluating organization-wide compliance in the\n Tagging Amazon Web Services Resources and Tag Editor user guide.

\n

You can call this operation only from the organization's \n management account and from the us-east-1 Region.

\n

If the account associated with the identity used to call\n StartReportCreation is different from the account that owns the Amazon S3\n bucket, there must be a bucket policy attached to the bucket to provide access. For more\n information, review Amazon S3 bucket\n policy for report storage in the Tagging Amazon Web Services Resources and Tag\n Editor user guide.

", "smithy.api#http": { "method": "POST", "uri": "/StartReportCreation", "code": 200 } } }, "com.amazonaws.resourcegroupstaggingapi#StartReportCreationInput": { "type": "structure", "members": { "S3Bucket": { "target": "com.amazonaws.resourcegroupstaggingapi#S3Bucket", "traits": { "smithy.api#documentation": "

The name of the Amazon S3 bucket where the report will be stored; for example:

\n

\n amzn-s3-demo-bucket\n

\n

For more information on S3 bucket requirements, including an example bucket policy,\n see the example Amazon S3 bucket policy on this page.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.resourcegroupstaggingapi#StartReportCreationOutput": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.resourcegroupstaggingapi#Status": { "type": "string" }, "com.amazonaws.resourcegroupstaggingapi#StatusCode": { "type": "integer", "traits": { "smithy.api#default": 0 } }, "com.amazonaws.resourcegroupstaggingapi#Summary": { "type": "structure", "members": { "LastUpdated": { "target": "com.amazonaws.resourcegroupstaggingapi#LastUpdated", "traits": { "smithy.api#documentation": "

The timestamp that shows when this summary was generated in this Region.

" } }, "TargetId": { "target": "com.amazonaws.resourcegroupstaggingapi#TargetId", "traits": { "smithy.api#documentation": "

The account identifier or the root identifier of the organization. If you don't know\n the root ID, you can call the Organizations ListRoots API.

" } }, "TargetIdType": { "target": "com.amazonaws.resourcegroupstaggingapi#TargetIdType", "traits": { "smithy.api#documentation": "

Whether the target is an account, an OU, or the organization root.

" } }, "Region": { "target": "com.amazonaws.resourcegroupstaggingapi#Region", "traits": { "smithy.api#documentation": "

The Amazon Web Services Region that the summary applies to.

" } }, "ResourceType": { "target": "com.amazonaws.resourcegroupstaggingapi#AmazonResourceType", "traits": { "smithy.api#documentation": "

The Amazon Web Services resource type.

" } }, "NonCompliantResources": { "target": "com.amazonaws.resourcegroupstaggingapi#NonCompliantResources", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

The count of noncompliant resources.

" } } }, "traits": { "smithy.api#documentation": "

A count of noncompliant resources.

" } }, "com.amazonaws.resourcegroupstaggingapi#SummaryList": { "type": "list", "member": { "target": "com.amazonaws.resourcegroupstaggingapi#Summary" } }, "com.amazonaws.resourcegroupstaggingapi#Tag": { "type": "structure", "members": { "Key": { "target": "com.amazonaws.resourcegroupstaggingapi#TagKey", "traits": { "smithy.api#documentation": "

One part of a key-value pair that makes up a tag. A key is a general label \n that acts like a category for more specific tag values.

", "smithy.api#required": {} } }, "Value": { "target": "com.amazonaws.resourcegroupstaggingapi#TagValue", "traits": { "smithy.api#documentation": "

One part of a key-value pair that make up a tag. A value acts as a \n descriptor within a tag category (key). The value can be empty or null.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The metadata that you apply to Amazon Web Services resources to help you categorize and organize\n them. Each tag consists of a key and a value, both of which you define. For more\n information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.

" } }, "com.amazonaws.resourcegroupstaggingapi#TagFilter": { "type": "structure", "members": { "Key": { "target": "com.amazonaws.resourcegroupstaggingapi#TagKey", "traits": { "smithy.api#documentation": "

One part of a key-value pair that makes up a tag. A key is a general label \n that acts like a category for more specific tag values.

" } }, "Values": { "target": "com.amazonaws.resourcegroupstaggingapi#TagValueList", "traits": { "smithy.api#documentation": "

One part of a key-value pair that make up a tag. A value acts as a \n descriptor within a tag category (key). The value can be empty or null.

" } } }, "traits": { "smithy.api#documentation": "

A list of tags (keys and values) that are used to specify the associated\n resources.

" } }, "com.amazonaws.resourcegroupstaggingapi#TagFilterList": { "type": "list", "member": { "target": "com.amazonaws.resourcegroupstaggingapi#TagFilter" }, "traits": { "smithy.api#length": { "min": 0, "max": 50 } } }, "com.amazonaws.resourcegroupstaggingapi#TagKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^[\\s\\S]*$" } }, "com.amazonaws.resourcegroupstaggingapi#TagKeyFilterList": { "type": "list", "member": { "target": "com.amazonaws.resourcegroupstaggingapi#TagKey" }, "traits": { "smithy.api#length": { "min": 1, "max": 50 } } }, "com.amazonaws.resourcegroupstaggingapi#TagKeyList": { "type": "list", "member": { "target": "com.amazonaws.resourcegroupstaggingapi#TagKey" } }, "com.amazonaws.resourcegroupstaggingapi#TagKeyListForUntag": { "type": "list", "member": { "target": "com.amazonaws.resourcegroupstaggingapi#TagKey" }, "traits": { "smithy.api#length": { "min": 1, "max": 50 } } }, "com.amazonaws.resourcegroupstaggingapi#TagList": { "type": "list", "member": { "target": "com.amazonaws.resourcegroupstaggingapi#Tag" } }, "com.amazonaws.resourcegroupstaggingapi#TagMap": { "type": "map", "key": { "target": "com.amazonaws.resourcegroupstaggingapi#TagKey" }, "value": { "target": "com.amazonaws.resourcegroupstaggingapi#TagValue" }, "traits": { "smithy.api#length": { "min": 1, "max": 50 } } }, "com.amazonaws.resourcegroupstaggingapi#TagResources": { "type": "operation", "input": { "target": "com.amazonaws.resourcegroupstaggingapi#TagResourcesInput" }, "output": { "target": "com.amazonaws.resourcegroupstaggingapi#TagResourcesOutput" }, "errors": [ { "target": "com.amazonaws.resourcegroupstaggingapi#InternalServiceException" }, { "target": "com.amazonaws.resourcegroupstaggingapi#InvalidParameterException" }, { "target": "com.amazonaws.resourcegroupstaggingapi#ThrottledException" } ], "traits": { "smithy.api#documentation": "

Applies one or more tags to the specified resources. Note the following:

\n \n \n

Do not store personally identifiable information (PII) or other confidential or\n sensitive information in tags. We use tags to provide you with billing and\n administration services. Tags are not intended to be used for private or sensitive\n data.

\n
\n

\n Minimum permissions\n

\n

In addition to the tag:TagResources permission required by this\n operation, you must also have the tagging permission defined by the service that created\n the resource. For example, to tag an Amazon EC2 instance using the TagResources\n operation, you must have both of the following permissions:

\n \n \n

In addition, some services might have specific requirements for tagging some types\n of resources. For example, to tag an Amazon S3 bucket, you must also have the\n s3:GetBucketTagging permission. If the expected minimum permissions\n don't work, check the documentation for that service's tagging APIs for more\n information.

\n
", "smithy.api#http": { "method": "POST", "uri": "/TagResources", "code": 200 } } }, "com.amazonaws.resourcegroupstaggingapi#TagResourcesInput": { "type": "structure", "members": { "ResourceARNList": { "target": "com.amazonaws.resourcegroupstaggingapi#ResourceARNListForTagUntag", "traits": { "smithy.api#documentation": "

Specifies the list of ARNs of the resources that you want to apply tags to.

\n

An ARN (Amazon Resource Name) uniquely identifies a resource. For more information,\n see Amazon\n Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services\n General Reference.

", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.resourcegroupstaggingapi#TagMap", "traits": { "smithy.api#documentation": "

Specifies a list of tags that you want to add to the specified resources. A tag\n consists of a key and a value that you define.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.resourcegroupstaggingapi#TagResourcesOutput": { "type": "structure", "members": { "FailedResourcesMap": { "target": "com.amazonaws.resourcegroupstaggingapi#FailedResourcesMap", "traits": { "smithy.api#documentation": "

A map containing a key-value pair for each failed item that couldn't be tagged. The\n key is the ARN of the failed resource. The value is a FailureInfo object\n that contains an error code, a status code, and an error message. If there are no\n errors, the FailedResourcesMap is empty.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.resourcegroupstaggingapi#TagValue": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 }, "smithy.api#pattern": "^[\\s\\S]*$" } }, "com.amazonaws.resourcegroupstaggingapi#TagValueList": { "type": "list", "member": { "target": "com.amazonaws.resourcegroupstaggingapi#TagValue" }, "traits": { "smithy.api#length": { "min": 0, "max": 20 } } }, "com.amazonaws.resourcegroupstaggingapi#TagValuesOutputList": { "type": "list", "member": { "target": "com.amazonaws.resourcegroupstaggingapi#TagValue" } }, "com.amazonaws.resourcegroupstaggingapi#TagsPerPage": { "type": "integer" }, "com.amazonaws.resourcegroupstaggingapi#TargetId": { "type": "string", "traits": { "smithy.api#length": { "min": 6, "max": 68 }, "smithy.api#pattern": "^[a-zA-Z0-9-]*$" } }, "com.amazonaws.resourcegroupstaggingapi#TargetIdFilterList": { "type": "list", "member": { "target": "com.amazonaws.resourcegroupstaggingapi#TargetId" }, "traits": { "smithy.api#length": { "min": 1, "max": 100 } } }, "com.amazonaws.resourcegroupstaggingapi#TargetIdType": { "type": "enum", "members": { "ACCOUNT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACCOUNT" } }, "OU": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OU" } }, "ROOT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ROOT" } } } }, "com.amazonaws.resourcegroupstaggingapi#ThrottledException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.resourcegroupstaggingapi#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

The request failed because it exceeded the allowed frequency of submitted\n requests.

", "smithy.api#error": "client" } }, "com.amazonaws.resourcegroupstaggingapi#UntagResources": { "type": "operation", "input": { "target": "com.amazonaws.resourcegroupstaggingapi#UntagResourcesInput" }, "output": { "target": "com.amazonaws.resourcegroupstaggingapi#UntagResourcesOutput" }, "errors": [ { "target": "com.amazonaws.resourcegroupstaggingapi#InternalServiceException" }, { "target": "com.amazonaws.resourcegroupstaggingapi#InvalidParameterException" }, { "target": "com.amazonaws.resourcegroupstaggingapi#ThrottledException" } ], "traits": { "smithy.api#documentation": "

Removes the specified tags from the specified resources. When you specify a tag key,\n the action removes both that key and its associated value. The operation succeeds even\n if you attempt to remove tags from a resource that were already removed. Note the\n following:

\n \n

\n Minimum permissions\n

\n

In addition to the tag:UntagResources permission required by this\n operation, you must also have the remove tags permission defined by the service that\n created the resource. For example, to remove the tags from an Amazon EC2 instance using the\n UntagResources operation, you must have both of the following\n permissions:

\n \n \n

In addition, some services might have specific requirements for untagging some\n types of resources. For example, to untag Amazon Web Services Glue Connection, you must also have the\n glue:GetConnection permission. If the expected minimum permissions\n don't work, check the documentation for that service's tagging APIs for more\n information.

\n
", "smithy.api#http": { "method": "POST", "uri": "/UntagResources", "code": 200 } } }, "com.amazonaws.resourcegroupstaggingapi#UntagResourcesInput": { "type": "structure", "members": { "ResourceARNList": { "target": "com.amazonaws.resourcegroupstaggingapi#ResourceARNListForTagUntag", "traits": { "smithy.api#documentation": "

Specifies a list of ARNs of the resources that you want to remove tags from.

\n

An ARN (Amazon Resource Name) uniquely identifies a resource. For more information,\n see Amazon\n Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services\n General Reference.

", "smithy.api#required": {} } }, "TagKeys": { "target": "com.amazonaws.resourcegroupstaggingapi#TagKeyListForUntag", "traits": { "smithy.api#documentation": "

Specifies a list of tag keys that you want to remove from the specified\n resources.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.resourcegroupstaggingapi#UntagResourcesOutput": { "type": "structure", "members": { "FailedResourcesMap": { "target": "com.amazonaws.resourcegroupstaggingapi#FailedResourcesMap", "traits": { "smithy.api#documentation": "

A map containing a key-value pair for each failed item that couldn't be untagged. The\n key is the ARN of the failed resource. The value is a FailureInfo object\n that contains an error code, a status code, and an error message. If there are no\n errors, the FailedResourcesMap is empty.

" } } }, "traits": { "smithy.api#output": {} } } } }