@Generated(value="software.amazon.awssdk:codegen") public interface ResourceGroupsTaggingApiClient extends SdkClient
builder()
method.
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider . |
static String |
SERVICE_NAME |
Modifier and Type | Method and Description |
---|---|
static ResourceGroupsTaggingApiClientBuilder |
builder()
Create a builder that can be used to configure and create a
ResourceGroupsTaggingApiClient . |
static ResourceGroupsTaggingApiClient |
create()
Create a
ResourceGroupsTaggingApiClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider . |
default DescribeReportCreationResponse |
describeReportCreation(Consumer<DescribeReportCreationRequest.Builder> describeReportCreationRequest)
Describes the status of the
StartReportCreation operation. |
default DescribeReportCreationResponse |
describeReportCreation(DescribeReportCreationRequest describeReportCreationRequest)
Describes the status of the
StartReportCreation operation. |
default GetComplianceSummaryResponse |
getComplianceSummary(Consumer<GetComplianceSummaryRequest.Builder> getComplianceSummaryRequest)
Returns a table that shows counts of resources that are noncompliant with their tag policies.
|
default GetComplianceSummaryResponse |
getComplianceSummary(GetComplianceSummaryRequest getComplianceSummaryRequest)
Returns a table that shows counts of resources that are noncompliant with their tag policies.
|
default GetComplianceSummaryIterable |
getComplianceSummaryPaginator(Consumer<GetComplianceSummaryRequest.Builder> getComplianceSummaryRequest)
Returns a table that shows counts of resources that are noncompliant with their tag policies.
|
default GetComplianceSummaryIterable |
getComplianceSummaryPaginator(GetComplianceSummaryRequest getComplianceSummaryRequest)
Returns a table that shows counts of resources that are noncompliant with their tag policies.
|
default GetResourcesResponse |
getResources()
Returns all the tagged or previously tagged resources that are located in the specified Region for the AWS
account.
|
default GetResourcesResponse |
getResources(Consumer<GetResourcesRequest.Builder> getResourcesRequest)
Returns all the tagged or previously tagged resources that are located in the specified Region for the AWS
account.
|
default GetResourcesResponse |
getResources(GetResourcesRequest getResourcesRequest)
Returns all the tagged or previously tagged resources that are located in the specified Region for the AWS
account.
|
default GetResourcesIterable |
getResourcesPaginator()
Returns all the tagged or previously tagged resources that are located in the specified Region for the AWS
account.
|
default GetResourcesIterable |
getResourcesPaginator(Consumer<GetResourcesRequest.Builder> getResourcesRequest)
Returns all the tagged or previously tagged resources that are located in the specified Region for the AWS
account.
|
default GetResourcesIterable |
getResourcesPaginator(GetResourcesRequest getResourcesRequest)
Returns all the tagged or previously tagged resources that are located in the specified Region for the AWS
account.
|
default GetTagKeysResponse |
getTagKeys()
Returns all tag keys currently in use in the specified Region for the calling AWS account.
|
default GetTagKeysResponse |
getTagKeys(Consumer<GetTagKeysRequest.Builder> getTagKeysRequest)
Returns all tag keys currently in use in the specified Region for the calling AWS account.
|
default GetTagKeysResponse |
getTagKeys(GetTagKeysRequest getTagKeysRequest)
Returns all tag keys currently in use in the specified Region for the calling AWS account.
|
default GetTagKeysIterable |
getTagKeysPaginator()
Returns all tag keys currently in use in the specified Region for the calling AWS account.
|
default GetTagKeysIterable |
getTagKeysPaginator(Consumer<GetTagKeysRequest.Builder> getTagKeysRequest)
Returns all tag keys currently in use in the specified Region for the calling AWS account.
|
default GetTagKeysIterable |
getTagKeysPaginator(GetTagKeysRequest getTagKeysRequest)
Returns all tag keys currently in use in the specified Region for the calling AWS account.
|
default GetTagValuesResponse |
getTagValues(Consumer<GetTagValuesRequest.Builder> getTagValuesRequest)
Returns all tag values for the specified key that are used in the specified AWS Region for the calling AWS
account.
|
default GetTagValuesResponse |
getTagValues(GetTagValuesRequest getTagValuesRequest)
Returns all tag values for the specified key that are used in the specified AWS Region for the calling AWS
account.
|
default GetTagValuesIterable |
getTagValuesPaginator(Consumer<GetTagValuesRequest.Builder> getTagValuesRequest)
Returns all tag values for the specified key that are used in the specified AWS Region for the calling AWS
account.
|
default GetTagValuesIterable |
getTagValuesPaginator(GetTagValuesRequest getTagValuesRequest)
Returns all tag values for the specified key that are used in the specified AWS Region for the calling AWS
account.
|
static ServiceMetadata |
serviceMetadata() |
default StartReportCreationResponse |
startReportCreation(Consumer<StartReportCreationRequest.Builder> startReportCreationRequest)
Generates a report that lists all tagged resources in the accounts across your organization and tells whether
each resource is compliant with the effective tag policy.
|
default StartReportCreationResponse |
startReportCreation(StartReportCreationRequest startReportCreationRequest)
Generates a report that lists all tagged resources in the accounts across your organization and tells whether
each resource is compliant with the effective tag policy.
|
default TagResourcesResponse |
tagResources(Consumer<TagResourcesRequest.Builder> tagResourcesRequest)
Applies one or more tags to the specified resources.
|
default TagResourcesResponse |
tagResources(TagResourcesRequest tagResourcesRequest)
Applies one or more tags to the specified resources.
|
default UntagResourcesResponse |
untagResources(Consumer<UntagResourcesRequest.Builder> untagResourcesRequest)
Removes the specified tags from the specified resources.
|
default UntagResourcesResponse |
untagResources(UntagResourcesRequest untagResourcesRequest)
Removes the specified tags from the specified resources.
|
serviceName
close
static final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider
.static ResourceGroupsTaggingApiClient create()
ResourceGroupsTaggingApiClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static ResourceGroupsTaggingApiClientBuilder builder()
ResourceGroupsTaggingApiClient
.default DescribeReportCreationResponse describeReportCreation(DescribeReportCreationRequest describeReportCreationRequest) throws ConstraintViolationException, InternalServiceException, InvalidParameterException, ThrottledException, AwsServiceException, SdkClientException, ResourceGroupsTaggingApiException
Describes the status of the StartReportCreation
operation.
You can call this operation only from the organization's management account and from the us-east-1 Region.
describeReportCreationRequest
- ConstraintViolationException
- The request was denied because performing this operation violates a constraint.
Some of the reasons in the following list might not apply to this specific operation.
You must meet the prerequisites for using tag policies. For information, see Prerequisites and Permissions for Using Tag Policies in the AWS Organizations User Guide.
You must enable the tag policies service principal (tagpolicies.tag.amazonaws.com
) to
integrate with AWS Organizations For information, see EnableAWSServiceAccess.
You must have a tag policy attached to the organization root, an OU, or an account.
InternalServiceException
- The request processing failed because of an unknown error, exception, or failure. You can retry the
request.InvalidParameterException
- This error indicates one of the following:
A parameter is missing.
A malformed string was supplied for the request parameter.
An out-of-range value was supplied for the request parameter.
The target ID is invalid, unsupported, or doesn't exist.
You can't access the Amazon S3 bucket for report storage. For more information, see Additional Requirements for Organization-wide Tag Compliance Reports in the AWS Organizations User Guide.
ThrottledException
- The request was denied to limit the frequency of submitted requests.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ResourceGroupsTaggingApiException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeReportCreationResponse describeReportCreation(Consumer<DescribeReportCreationRequest.Builder> describeReportCreationRequest) throws ConstraintViolationException, InternalServiceException, InvalidParameterException, ThrottledException, AwsServiceException, SdkClientException, ResourceGroupsTaggingApiException
Describes the status of the StartReportCreation
operation.
You can call this operation only from the organization's management account and from the us-east-1 Region.
This is a convenience which creates an instance of the DescribeReportCreationRequest.Builder
avoiding the
need to create one manually via DescribeReportCreationRequest.builder()
describeReportCreationRequest
- A Consumer
that will call methods on DescribeReportCreationInput.Builder
to create a
request.ConstraintViolationException
- The request was denied because performing this operation violates a constraint.
Some of the reasons in the following list might not apply to this specific operation.
You must meet the prerequisites for using tag policies. For information, see Prerequisites and Permissions for Using Tag Policies in the AWS Organizations User Guide.
You must enable the tag policies service principal (tagpolicies.tag.amazonaws.com
) to
integrate with AWS Organizations For information, see EnableAWSServiceAccess.
You must have a tag policy attached to the organization root, an OU, or an account.
InternalServiceException
- The request processing failed because of an unknown error, exception, or failure. You can retry the
request.InvalidParameterException
- This error indicates one of the following:
A parameter is missing.
A malformed string was supplied for the request parameter.
An out-of-range value was supplied for the request parameter.
The target ID is invalid, unsupported, or doesn't exist.
You can't access the Amazon S3 bucket for report storage. For more information, see Additional Requirements for Organization-wide Tag Compliance Reports in the AWS Organizations User Guide.
ThrottledException
- The request was denied to limit the frequency of submitted requests.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ResourceGroupsTaggingApiException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetComplianceSummaryResponse getComplianceSummary(GetComplianceSummaryRequest getComplianceSummaryRequest) throws ConstraintViolationException, InternalServiceException, InvalidParameterException, ThrottledException, AwsServiceException, SdkClientException, ResourceGroupsTaggingApiException
Returns a table that shows counts of resources that are noncompliant with their tag policies.
For more information on tag policies, see Tag Policies in the AWS Organizations User Guide.
You can call this operation only from the organization's management account and from the us-east-1 Region.
This operation supports pagination, where the response can be sent in multiple pages. You should check the
PaginationToken
response parameter to determine if there are additional results available to return.
Repeat the query, passing the PaginationToken
response parameter value as an input to the next
request until you recieve a null
value. A null value for PaginationToken
indicates that
there are no more results waiting to be returned.
getComplianceSummaryRequest
- ConstraintViolationException
- The request was denied because performing this operation violates a constraint.
Some of the reasons in the following list might not apply to this specific operation.
You must meet the prerequisites for using tag policies. For information, see Prerequisites and Permissions for Using Tag Policies in the AWS Organizations User Guide.
You must enable the tag policies service principal (tagpolicies.tag.amazonaws.com
) to
integrate with AWS Organizations For information, see EnableAWSServiceAccess.
You must have a tag policy attached to the organization root, an OU, or an account.
InternalServiceException
- The request processing failed because of an unknown error, exception, or failure. You can retry the
request.InvalidParameterException
- This error indicates one of the following:
A parameter is missing.
A malformed string was supplied for the request parameter.
An out-of-range value was supplied for the request parameter.
The target ID is invalid, unsupported, or doesn't exist.
You can't access the Amazon S3 bucket for report storage. For more information, see Additional Requirements for Organization-wide Tag Compliance Reports in the AWS Organizations User Guide.
ThrottledException
- The request was denied to limit the frequency of submitted requests.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ResourceGroupsTaggingApiException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetComplianceSummaryResponse getComplianceSummary(Consumer<GetComplianceSummaryRequest.Builder> getComplianceSummaryRequest) throws ConstraintViolationException, InternalServiceException, InvalidParameterException, ThrottledException, AwsServiceException, SdkClientException, ResourceGroupsTaggingApiException
Returns a table that shows counts of resources that are noncompliant with their tag policies.
For more information on tag policies, see Tag Policies in the AWS Organizations User Guide.
You can call this operation only from the organization's management account and from the us-east-1 Region.
This operation supports pagination, where the response can be sent in multiple pages. You should check the
PaginationToken
response parameter to determine if there are additional results available to return.
Repeat the query, passing the PaginationToken
response parameter value as an input to the next
request until you recieve a null
value. A null value for PaginationToken
indicates that
there are no more results waiting to be returned.
This is a convenience which creates an instance of the GetComplianceSummaryRequest.Builder
avoiding the
need to create one manually via GetComplianceSummaryRequest.builder()
getComplianceSummaryRequest
- A Consumer
that will call methods on GetComplianceSummaryInput.Builder
to create a
request.ConstraintViolationException
- The request was denied because performing this operation violates a constraint.
Some of the reasons in the following list might not apply to this specific operation.
You must meet the prerequisites for using tag policies. For information, see Prerequisites and Permissions for Using Tag Policies in the AWS Organizations User Guide.
You must enable the tag policies service principal (tagpolicies.tag.amazonaws.com
) to
integrate with AWS Organizations For information, see EnableAWSServiceAccess.
You must have a tag policy attached to the organization root, an OU, or an account.
InternalServiceException
- The request processing failed because of an unknown error, exception, or failure. You can retry the
request.InvalidParameterException
- This error indicates one of the following:
A parameter is missing.
A malformed string was supplied for the request parameter.
An out-of-range value was supplied for the request parameter.
The target ID is invalid, unsupported, or doesn't exist.
You can't access the Amazon S3 bucket for report storage. For more information, see Additional Requirements for Organization-wide Tag Compliance Reports in the AWS Organizations User Guide.
ThrottledException
- The request was denied to limit the frequency of submitted requests.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ResourceGroupsTaggingApiException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetComplianceSummaryIterable getComplianceSummaryPaginator(GetComplianceSummaryRequest getComplianceSummaryRequest) throws ConstraintViolationException, InternalServiceException, InvalidParameterException, ThrottledException, AwsServiceException, SdkClientException, ResourceGroupsTaggingApiException
Returns a table that shows counts of resources that are noncompliant with their tag policies.
For more information on tag policies, see Tag Policies in the AWS Organizations User Guide.
You can call this operation only from the organization's management account and from the us-east-1 Region.
This operation supports pagination, where the response can be sent in multiple pages. You should check the
PaginationToken
response parameter to determine if there are additional results available to return.
Repeat the query, passing the PaginationToken
response parameter value as an input to the next
request until you recieve a null
value. A null value for PaginationToken
indicates that
there are no more results waiting to be returned.
This is a variant of
getComplianceSummary(software.amazon.awssdk.services.resourcegroupstaggingapi.model.GetComplianceSummaryRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.resourcegroupstaggingapi.paginators.GetComplianceSummaryIterable responses = client.getComplianceSummaryPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.resourcegroupstaggingapi.paginators.GetComplianceSummaryIterable responses = client .getComplianceSummaryPaginator(request); for (software.amazon.awssdk.services.resourcegroupstaggingapi.model.GetComplianceSummaryResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.resourcegroupstaggingapi.paginators.GetComplianceSummaryIterable responses = client.getComplianceSummaryPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getComplianceSummary(software.amazon.awssdk.services.resourcegroupstaggingapi.model.GetComplianceSummaryRequest)
operation.
getComplianceSummaryRequest
- ConstraintViolationException
- The request was denied because performing this operation violates a constraint.
Some of the reasons in the following list might not apply to this specific operation.
You must meet the prerequisites for using tag policies. For information, see Prerequisites and Permissions for Using Tag Policies in the AWS Organizations User Guide.
You must enable the tag policies service principal (tagpolicies.tag.amazonaws.com
) to
integrate with AWS Organizations For information, see EnableAWSServiceAccess.
You must have a tag policy attached to the organization root, an OU, or an account.
InternalServiceException
- The request processing failed because of an unknown error, exception, or failure. You can retry the
request.InvalidParameterException
- This error indicates one of the following:
A parameter is missing.
A malformed string was supplied for the request parameter.
An out-of-range value was supplied for the request parameter.
The target ID is invalid, unsupported, or doesn't exist.
You can't access the Amazon S3 bucket for report storage. For more information, see Additional Requirements for Organization-wide Tag Compliance Reports in the AWS Organizations User Guide.
ThrottledException
- The request was denied to limit the frequency of submitted requests.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ResourceGroupsTaggingApiException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetComplianceSummaryIterable getComplianceSummaryPaginator(Consumer<GetComplianceSummaryRequest.Builder> getComplianceSummaryRequest) throws ConstraintViolationException, InternalServiceException, InvalidParameterException, ThrottledException, AwsServiceException, SdkClientException, ResourceGroupsTaggingApiException
Returns a table that shows counts of resources that are noncompliant with their tag policies.
For more information on tag policies, see Tag Policies in the AWS Organizations User Guide.
You can call this operation only from the organization's management account and from the us-east-1 Region.
This operation supports pagination, where the response can be sent in multiple pages. You should check the
PaginationToken
response parameter to determine if there are additional results available to return.
Repeat the query, passing the PaginationToken
response parameter value as an input to the next
request until you recieve a null
value. A null value for PaginationToken
indicates that
there are no more results waiting to be returned.
This is a variant of
getComplianceSummary(software.amazon.awssdk.services.resourcegroupstaggingapi.model.GetComplianceSummaryRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.resourcegroupstaggingapi.paginators.GetComplianceSummaryIterable responses = client.getComplianceSummaryPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.resourcegroupstaggingapi.paginators.GetComplianceSummaryIterable responses = client .getComplianceSummaryPaginator(request); for (software.amazon.awssdk.services.resourcegroupstaggingapi.model.GetComplianceSummaryResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.resourcegroupstaggingapi.paginators.GetComplianceSummaryIterable responses = client.getComplianceSummaryPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getComplianceSummary(software.amazon.awssdk.services.resourcegroupstaggingapi.model.GetComplianceSummaryRequest)
operation.
This is a convenience which creates an instance of the GetComplianceSummaryRequest.Builder
avoiding the
need to create one manually via GetComplianceSummaryRequest.builder()
getComplianceSummaryRequest
- A Consumer
that will call methods on GetComplianceSummaryInput.Builder
to create a
request.ConstraintViolationException
- The request was denied because performing this operation violates a constraint.
Some of the reasons in the following list might not apply to this specific operation.
You must meet the prerequisites for using tag policies. For information, see Prerequisites and Permissions for Using Tag Policies in the AWS Organizations User Guide.
You must enable the tag policies service principal (tagpolicies.tag.amazonaws.com
) to
integrate with AWS Organizations For information, see EnableAWSServiceAccess.
You must have a tag policy attached to the organization root, an OU, or an account.
InternalServiceException
- The request processing failed because of an unknown error, exception, or failure. You can retry the
request.InvalidParameterException
- This error indicates one of the following:
A parameter is missing.
A malformed string was supplied for the request parameter.
An out-of-range value was supplied for the request parameter.
The target ID is invalid, unsupported, or doesn't exist.
You can't access the Amazon S3 bucket for report storage. For more information, see Additional Requirements for Organization-wide Tag Compliance Reports in the AWS Organizations User Guide.
ThrottledException
- The request was denied to limit the frequency of submitted requests.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ResourceGroupsTaggingApiException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetResourcesResponse getResources() throws InvalidParameterException, ThrottledException, InternalServiceException, PaginationTokenExpiredException, AwsServiceException, SdkClientException, ResourceGroupsTaggingApiException
Returns all the tagged or previously tagged resources that are located in the specified Region for the AWS account.
Depending on what information you want returned, you can also specify the following:
Filters that specify what tags and resource types you want returned. The response includes all tags that are associated with the requested resources.
Information about compliance with the account's effective tag policy. For more information on tag policies, see Tag Policies in the AWS Organizations User Guide.
This operation supports pagination, where the response can be sent in multiple pages. You should check the
PaginationToken
response parameter to determine if there are additional results available to return.
Repeat the query, passing the PaginationToken
response parameter value as an input to the next
request until you recieve a null
value. A null value for PaginationToken
indicates that
there are no more results waiting to be returned.
InvalidParameterException
- This error indicates one of the following:
A parameter is missing.
A malformed string was supplied for the request parameter.
An out-of-range value was supplied for the request parameter.
The target ID is invalid, unsupported, or doesn't exist.
You can't access the Amazon S3 bucket for report storage. For more information, see Additional Requirements for Organization-wide Tag Compliance Reports in the AWS Organizations User Guide.
ThrottledException
- The request was denied to limit the frequency of submitted requests.InternalServiceException
- The request processing failed because of an unknown error, exception, or failure. You can retry the
request.PaginationTokenExpiredException
- A PaginationToken
is valid for a maximum of 15 minutes. Your request was denied because the
specified PaginationToken
has expired.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ResourceGroupsTaggingApiException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
getResources(GetResourcesRequest)
,
AWS API Documentationdefault GetResourcesResponse getResources(GetResourcesRequest getResourcesRequest) throws InvalidParameterException, ThrottledException, InternalServiceException, PaginationTokenExpiredException, AwsServiceException, SdkClientException, ResourceGroupsTaggingApiException
Returns all the tagged or previously tagged resources that are located in the specified Region for the AWS account.
Depending on what information you want returned, you can also specify the following:
Filters that specify what tags and resource types you want returned. The response includes all tags that are associated with the requested resources.
Information about compliance with the account's effective tag policy. For more information on tag policies, see Tag Policies in the AWS Organizations User Guide.
This operation supports pagination, where the response can be sent in multiple pages. You should check the
PaginationToken
response parameter to determine if there are additional results available to return.
Repeat the query, passing the PaginationToken
response parameter value as an input to the next
request until you recieve a null
value. A null value for PaginationToken
indicates that
there are no more results waiting to be returned.
getResourcesRequest
- InvalidParameterException
- This error indicates one of the following:
A parameter is missing.
A malformed string was supplied for the request parameter.
An out-of-range value was supplied for the request parameter.
The target ID is invalid, unsupported, or doesn't exist.
You can't access the Amazon S3 bucket for report storage. For more information, see Additional Requirements for Organization-wide Tag Compliance Reports in the AWS Organizations User Guide.
ThrottledException
- The request was denied to limit the frequency of submitted requests.InternalServiceException
- The request processing failed because of an unknown error, exception, or failure. You can retry the
request.PaginationTokenExpiredException
- A PaginationToken
is valid for a maximum of 15 minutes. Your request was denied because the
specified PaginationToken
has expired.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ResourceGroupsTaggingApiException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetResourcesResponse getResources(Consumer<GetResourcesRequest.Builder> getResourcesRequest) throws InvalidParameterException, ThrottledException, InternalServiceException, PaginationTokenExpiredException, AwsServiceException, SdkClientException, ResourceGroupsTaggingApiException
Returns all the tagged or previously tagged resources that are located in the specified Region for the AWS account.
Depending on what information you want returned, you can also specify the following:
Filters that specify what tags and resource types you want returned. The response includes all tags that are associated with the requested resources.
Information about compliance with the account's effective tag policy. For more information on tag policies, see Tag Policies in the AWS Organizations User Guide.
This operation supports pagination, where the response can be sent in multiple pages. You should check the
PaginationToken
response parameter to determine if there are additional results available to return.
Repeat the query, passing the PaginationToken
response parameter value as an input to the next
request until you recieve a null
value. A null value for PaginationToken
indicates that
there are no more results waiting to be returned.
This is a convenience which creates an instance of the GetResourcesRequest.Builder
avoiding the need to
create one manually via GetResourcesRequest.builder()
getResourcesRequest
- A Consumer
that will call methods on GetResourcesInput.Builder
to create a request.InvalidParameterException
- This error indicates one of the following:
A parameter is missing.
A malformed string was supplied for the request parameter.
An out-of-range value was supplied for the request parameter.
The target ID is invalid, unsupported, or doesn't exist.
You can't access the Amazon S3 bucket for report storage. For more information, see Additional Requirements for Organization-wide Tag Compliance Reports in the AWS Organizations User Guide.
ThrottledException
- The request was denied to limit the frequency of submitted requests.InternalServiceException
- The request processing failed because of an unknown error, exception, or failure. You can retry the
request.PaginationTokenExpiredException
- A PaginationToken
is valid for a maximum of 15 minutes. Your request was denied because the
specified PaginationToken
has expired.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ResourceGroupsTaggingApiException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetResourcesIterable getResourcesPaginator() throws InvalidParameterException, ThrottledException, InternalServiceException, PaginationTokenExpiredException, AwsServiceException, SdkClientException, ResourceGroupsTaggingApiException
Returns all the tagged or previously tagged resources that are located in the specified Region for the AWS account.
Depending on what information you want returned, you can also specify the following:
Filters that specify what tags and resource types you want returned. The response includes all tags that are associated with the requested resources.
Information about compliance with the account's effective tag policy. For more information on tag policies, see Tag Policies in the AWS Organizations User Guide.
This operation supports pagination, where the response can be sent in multiple pages. You should check the
PaginationToken
response parameter to determine if there are additional results available to return.
Repeat the query, passing the PaginationToken
response parameter value as an input to the next
request until you recieve a null
value. A null value for PaginationToken
indicates that
there are no more results waiting to be returned.
This is a variant of
getResources(software.amazon.awssdk.services.resourcegroupstaggingapi.model.GetResourcesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.resourcegroupstaggingapi.paginators.GetResourcesIterable responses = client.getResourcesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.resourcegroupstaggingapi.paginators.GetResourcesIterable responses = client .getResourcesPaginator(request); for (software.amazon.awssdk.services.resourcegroupstaggingapi.model.GetResourcesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.resourcegroupstaggingapi.paginators.GetResourcesIterable responses = client.getResourcesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of ResourcesPerPage won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getResources(software.amazon.awssdk.services.resourcegroupstaggingapi.model.GetResourcesRequest)
operation.
InvalidParameterException
- This error indicates one of the following:
A parameter is missing.
A malformed string was supplied for the request parameter.
An out-of-range value was supplied for the request parameter.
The target ID is invalid, unsupported, or doesn't exist.
You can't access the Amazon S3 bucket for report storage. For more information, see Additional Requirements for Organization-wide Tag Compliance Reports in the AWS Organizations User Guide.
ThrottledException
- The request was denied to limit the frequency of submitted requests.InternalServiceException
- The request processing failed because of an unknown error, exception, or failure. You can retry the
request.PaginationTokenExpiredException
- A PaginationToken
is valid for a maximum of 15 minutes. Your request was denied because the
specified PaginationToken
has expired.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ResourceGroupsTaggingApiException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
getResourcesPaginator(GetResourcesRequest)
,
AWS API Documentationdefault GetResourcesIterable getResourcesPaginator(GetResourcesRequest getResourcesRequest) throws InvalidParameterException, ThrottledException, InternalServiceException, PaginationTokenExpiredException, AwsServiceException, SdkClientException, ResourceGroupsTaggingApiException
Returns all the tagged or previously tagged resources that are located in the specified Region for the AWS account.
Depending on what information you want returned, you can also specify the following:
Filters that specify what tags and resource types you want returned. The response includes all tags that are associated with the requested resources.
Information about compliance with the account's effective tag policy. For more information on tag policies, see Tag Policies in the AWS Organizations User Guide.
This operation supports pagination, where the response can be sent in multiple pages. You should check the
PaginationToken
response parameter to determine if there are additional results available to return.
Repeat the query, passing the PaginationToken
response parameter value as an input to the next
request until you recieve a null
value. A null value for PaginationToken
indicates that
there are no more results waiting to be returned.
This is a variant of
getResources(software.amazon.awssdk.services.resourcegroupstaggingapi.model.GetResourcesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.resourcegroupstaggingapi.paginators.GetResourcesIterable responses = client.getResourcesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.resourcegroupstaggingapi.paginators.GetResourcesIterable responses = client .getResourcesPaginator(request); for (software.amazon.awssdk.services.resourcegroupstaggingapi.model.GetResourcesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.resourcegroupstaggingapi.paginators.GetResourcesIterable responses = client.getResourcesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of ResourcesPerPage won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getResources(software.amazon.awssdk.services.resourcegroupstaggingapi.model.GetResourcesRequest)
operation.
getResourcesRequest
- InvalidParameterException
- This error indicates one of the following:
A parameter is missing.
A malformed string was supplied for the request parameter.
An out-of-range value was supplied for the request parameter.
The target ID is invalid, unsupported, or doesn't exist.
You can't access the Amazon S3 bucket for report storage. For more information, see Additional Requirements for Organization-wide Tag Compliance Reports in the AWS Organizations User Guide.
ThrottledException
- The request was denied to limit the frequency of submitted requests.InternalServiceException
- The request processing failed because of an unknown error, exception, or failure. You can retry the
request.PaginationTokenExpiredException
- A PaginationToken
is valid for a maximum of 15 minutes. Your request was denied because the
specified PaginationToken
has expired.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ResourceGroupsTaggingApiException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetResourcesIterable getResourcesPaginator(Consumer<GetResourcesRequest.Builder> getResourcesRequest) throws InvalidParameterException, ThrottledException, InternalServiceException, PaginationTokenExpiredException, AwsServiceException, SdkClientException, ResourceGroupsTaggingApiException
Returns all the tagged or previously tagged resources that are located in the specified Region for the AWS account.
Depending on what information you want returned, you can also specify the following:
Filters that specify what tags and resource types you want returned. The response includes all tags that are associated with the requested resources.
Information about compliance with the account's effective tag policy. For more information on tag policies, see Tag Policies in the AWS Organizations User Guide.
This operation supports pagination, where the response can be sent in multiple pages. You should check the
PaginationToken
response parameter to determine if there are additional results available to return.
Repeat the query, passing the PaginationToken
response parameter value as an input to the next
request until you recieve a null
value. A null value for PaginationToken
indicates that
there are no more results waiting to be returned.
This is a variant of
getResources(software.amazon.awssdk.services.resourcegroupstaggingapi.model.GetResourcesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.resourcegroupstaggingapi.paginators.GetResourcesIterable responses = client.getResourcesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.resourcegroupstaggingapi.paginators.GetResourcesIterable responses = client .getResourcesPaginator(request); for (software.amazon.awssdk.services.resourcegroupstaggingapi.model.GetResourcesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.resourcegroupstaggingapi.paginators.GetResourcesIterable responses = client.getResourcesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of ResourcesPerPage won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getResources(software.amazon.awssdk.services.resourcegroupstaggingapi.model.GetResourcesRequest)
operation.
This is a convenience which creates an instance of the GetResourcesRequest.Builder
avoiding the need to
create one manually via GetResourcesRequest.builder()
getResourcesRequest
- A Consumer
that will call methods on GetResourcesInput.Builder
to create a request.InvalidParameterException
- This error indicates one of the following:
A parameter is missing.
A malformed string was supplied for the request parameter.
An out-of-range value was supplied for the request parameter.
The target ID is invalid, unsupported, or doesn't exist.
You can't access the Amazon S3 bucket for report storage. For more information, see Additional Requirements for Organization-wide Tag Compliance Reports in the AWS Organizations User Guide.
ThrottledException
- The request was denied to limit the frequency of submitted requests.InternalServiceException
- The request processing failed because of an unknown error, exception, or failure. You can retry the
request.PaginationTokenExpiredException
- A PaginationToken
is valid for a maximum of 15 minutes. Your request was denied because the
specified PaginationToken
has expired.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ResourceGroupsTaggingApiException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetTagKeysResponse getTagKeys() throws InvalidParameterException, ThrottledException, InternalServiceException, PaginationTokenExpiredException, AwsServiceException, SdkClientException, ResourceGroupsTaggingApiException
Returns all tag keys currently in use in the specified Region for the calling AWS account.
This operation supports pagination, where the response can be sent in multiple pages. You should check the
PaginationToken
response parameter to determine if there are additional results available to return.
Repeat the query, passing the PaginationToken
response parameter value as an input to the next
request until you recieve a null
value. A null value for PaginationToken
indicates that
there are no more results waiting to be returned.
InvalidParameterException
- This error indicates one of the following:
A parameter is missing.
A malformed string was supplied for the request parameter.
An out-of-range value was supplied for the request parameter.
The target ID is invalid, unsupported, or doesn't exist.
You can't access the Amazon S3 bucket for report storage. For more information, see Additional Requirements for Organization-wide Tag Compliance Reports in the AWS Organizations User Guide.
ThrottledException
- The request was denied to limit the frequency of submitted requests.InternalServiceException
- The request processing failed because of an unknown error, exception, or failure. You can retry the
request.PaginationTokenExpiredException
- A PaginationToken
is valid for a maximum of 15 minutes. Your request was denied because the
specified PaginationToken
has expired.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ResourceGroupsTaggingApiException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
getTagKeys(GetTagKeysRequest)
,
AWS API Documentationdefault GetTagKeysResponse getTagKeys(GetTagKeysRequest getTagKeysRequest) throws InvalidParameterException, ThrottledException, InternalServiceException, PaginationTokenExpiredException, AwsServiceException, SdkClientException, ResourceGroupsTaggingApiException
Returns all tag keys currently in use in the specified Region for the calling AWS account.
This operation supports pagination, where the response can be sent in multiple pages. You should check the
PaginationToken
response parameter to determine if there are additional results available to return.
Repeat the query, passing the PaginationToken
response parameter value as an input to the next
request until you recieve a null
value. A null value for PaginationToken
indicates that
there are no more results waiting to be returned.
getTagKeysRequest
- InvalidParameterException
- This error indicates one of the following:
A parameter is missing.
A malformed string was supplied for the request parameter.
An out-of-range value was supplied for the request parameter.
The target ID is invalid, unsupported, or doesn't exist.
You can't access the Amazon S3 bucket for report storage. For more information, see Additional Requirements for Organization-wide Tag Compliance Reports in the AWS Organizations User Guide.
ThrottledException
- The request was denied to limit the frequency of submitted requests.InternalServiceException
- The request processing failed because of an unknown error, exception, or failure. You can retry the
request.PaginationTokenExpiredException
- A PaginationToken
is valid for a maximum of 15 minutes. Your request was denied because the
specified PaginationToken
has expired.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ResourceGroupsTaggingApiException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetTagKeysResponse getTagKeys(Consumer<GetTagKeysRequest.Builder> getTagKeysRequest) throws InvalidParameterException, ThrottledException, InternalServiceException, PaginationTokenExpiredException, AwsServiceException, SdkClientException, ResourceGroupsTaggingApiException
Returns all tag keys currently in use in the specified Region for the calling AWS account.
This operation supports pagination, where the response can be sent in multiple pages. You should check the
PaginationToken
response parameter to determine if there are additional results available to return.
Repeat the query, passing the PaginationToken
response parameter value as an input to the next
request until you recieve a null
value. A null value for PaginationToken
indicates that
there are no more results waiting to be returned.
This is a convenience which creates an instance of the GetTagKeysRequest.Builder
avoiding the need to
create one manually via GetTagKeysRequest.builder()
getTagKeysRequest
- A Consumer
that will call methods on GetTagKeysInput.Builder
to create a request.InvalidParameterException
- This error indicates one of the following:
A parameter is missing.
A malformed string was supplied for the request parameter.
An out-of-range value was supplied for the request parameter.
The target ID is invalid, unsupported, or doesn't exist.
You can't access the Amazon S3 bucket for report storage. For more information, see Additional Requirements for Organization-wide Tag Compliance Reports in the AWS Organizations User Guide.
ThrottledException
- The request was denied to limit the frequency of submitted requests.InternalServiceException
- The request processing failed because of an unknown error, exception, or failure. You can retry the
request.PaginationTokenExpiredException
- A PaginationToken
is valid for a maximum of 15 minutes. Your request was denied because the
specified PaginationToken
has expired.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ResourceGroupsTaggingApiException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetTagKeysIterable getTagKeysPaginator() throws InvalidParameterException, ThrottledException, InternalServiceException, PaginationTokenExpiredException, AwsServiceException, SdkClientException, ResourceGroupsTaggingApiException
Returns all tag keys currently in use in the specified Region for the calling AWS account.
This operation supports pagination, where the response can be sent in multiple pages. You should check the
PaginationToken
response parameter to determine if there are additional results available to return.
Repeat the query, passing the PaginationToken
response parameter value as an input to the next
request until you recieve a null
value. A null value for PaginationToken
indicates that
there are no more results waiting to be returned.
This is a variant of
getTagKeys(software.amazon.awssdk.services.resourcegroupstaggingapi.model.GetTagKeysRequest)
operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.resourcegroupstaggingapi.paginators.GetTagKeysIterable responses = client.getTagKeysPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.resourcegroupstaggingapi.paginators.GetTagKeysIterable responses = client .getTagKeysPaginator(request); for (software.amazon.awssdk.services.resourcegroupstaggingapi.model.GetTagKeysResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.resourcegroupstaggingapi.paginators.GetTagKeysIterable responses = client.getTagKeysPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getTagKeys(software.amazon.awssdk.services.resourcegroupstaggingapi.model.GetTagKeysRequest)
operation.
InvalidParameterException
- This error indicates one of the following:
A parameter is missing.
A malformed string was supplied for the request parameter.
An out-of-range value was supplied for the request parameter.
The target ID is invalid, unsupported, or doesn't exist.
You can't access the Amazon S3 bucket for report storage. For more information, see Additional Requirements for Organization-wide Tag Compliance Reports in the AWS Organizations User Guide.
ThrottledException
- The request was denied to limit the frequency of submitted requests.InternalServiceException
- The request processing failed because of an unknown error, exception, or failure. You can retry the
request.PaginationTokenExpiredException
- A PaginationToken
is valid for a maximum of 15 minutes. Your request was denied because the
specified PaginationToken
has expired.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ResourceGroupsTaggingApiException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
getTagKeysPaginator(GetTagKeysRequest)
,
AWS API Documentationdefault GetTagKeysIterable getTagKeysPaginator(GetTagKeysRequest getTagKeysRequest) throws InvalidParameterException, ThrottledException, InternalServiceException, PaginationTokenExpiredException, AwsServiceException, SdkClientException, ResourceGroupsTaggingApiException
Returns all tag keys currently in use in the specified Region for the calling AWS account.
This operation supports pagination, where the response can be sent in multiple pages. You should check the
PaginationToken
response parameter to determine if there are additional results available to return.
Repeat the query, passing the PaginationToken
response parameter value as an input to the next
request until you recieve a null
value. A null value for PaginationToken
indicates that
there are no more results waiting to be returned.
This is a variant of
getTagKeys(software.amazon.awssdk.services.resourcegroupstaggingapi.model.GetTagKeysRequest)
operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.resourcegroupstaggingapi.paginators.GetTagKeysIterable responses = client.getTagKeysPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.resourcegroupstaggingapi.paginators.GetTagKeysIterable responses = client .getTagKeysPaginator(request); for (software.amazon.awssdk.services.resourcegroupstaggingapi.model.GetTagKeysResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.resourcegroupstaggingapi.paginators.GetTagKeysIterable responses = client.getTagKeysPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getTagKeys(software.amazon.awssdk.services.resourcegroupstaggingapi.model.GetTagKeysRequest)
operation.
getTagKeysRequest
- InvalidParameterException
- This error indicates one of the following:
A parameter is missing.
A malformed string was supplied for the request parameter.
An out-of-range value was supplied for the request parameter.
The target ID is invalid, unsupported, or doesn't exist.
You can't access the Amazon S3 bucket for report storage. For more information, see Additional Requirements for Organization-wide Tag Compliance Reports in the AWS Organizations User Guide.
ThrottledException
- The request was denied to limit the frequency of submitted requests.InternalServiceException
- The request processing failed because of an unknown error, exception, or failure. You can retry the
request.PaginationTokenExpiredException
- A PaginationToken
is valid for a maximum of 15 minutes. Your request was denied because the
specified PaginationToken
has expired.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ResourceGroupsTaggingApiException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetTagKeysIterable getTagKeysPaginator(Consumer<GetTagKeysRequest.Builder> getTagKeysRequest) throws InvalidParameterException, ThrottledException, InternalServiceException, PaginationTokenExpiredException, AwsServiceException, SdkClientException, ResourceGroupsTaggingApiException
Returns all tag keys currently in use in the specified Region for the calling AWS account.
This operation supports pagination, where the response can be sent in multiple pages. You should check the
PaginationToken
response parameter to determine if there are additional results available to return.
Repeat the query, passing the PaginationToken
response parameter value as an input to the next
request until you recieve a null
value. A null value for PaginationToken
indicates that
there are no more results waiting to be returned.
This is a variant of
getTagKeys(software.amazon.awssdk.services.resourcegroupstaggingapi.model.GetTagKeysRequest)
operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.resourcegroupstaggingapi.paginators.GetTagKeysIterable responses = client.getTagKeysPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.resourcegroupstaggingapi.paginators.GetTagKeysIterable responses = client .getTagKeysPaginator(request); for (software.amazon.awssdk.services.resourcegroupstaggingapi.model.GetTagKeysResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.resourcegroupstaggingapi.paginators.GetTagKeysIterable responses = client.getTagKeysPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getTagKeys(software.amazon.awssdk.services.resourcegroupstaggingapi.model.GetTagKeysRequest)
operation.
This is a convenience which creates an instance of the GetTagKeysRequest.Builder
avoiding the need to
create one manually via GetTagKeysRequest.builder()
getTagKeysRequest
- A Consumer
that will call methods on GetTagKeysInput.Builder
to create a request.InvalidParameterException
- This error indicates one of the following:
A parameter is missing.
A malformed string was supplied for the request parameter.
An out-of-range value was supplied for the request parameter.
The target ID is invalid, unsupported, or doesn't exist.
You can't access the Amazon S3 bucket for report storage. For more information, see Additional Requirements for Organization-wide Tag Compliance Reports in the AWS Organizations User Guide.
ThrottledException
- The request was denied to limit the frequency of submitted requests.InternalServiceException
- The request processing failed because of an unknown error, exception, or failure. You can retry the
request.PaginationTokenExpiredException
- A PaginationToken
is valid for a maximum of 15 minutes. Your request was denied because the
specified PaginationToken
has expired.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ResourceGroupsTaggingApiException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetTagValuesResponse getTagValues(GetTagValuesRequest getTagValuesRequest) throws InvalidParameterException, ThrottledException, InternalServiceException, PaginationTokenExpiredException, AwsServiceException, SdkClientException, ResourceGroupsTaggingApiException
Returns all tag values for the specified key that are used in the specified AWS Region for the calling AWS account.
This operation supports pagination, where the response can be sent in multiple pages. You should check the
PaginationToken
response parameter to determine if there are additional results available to return.
Repeat the query, passing the PaginationToken
response parameter value as an input to the next
request until you recieve a null
value. A null value for PaginationToken
indicates that
there are no more results waiting to be returned.
getTagValuesRequest
- InvalidParameterException
- This error indicates one of the following:
A parameter is missing.
A malformed string was supplied for the request parameter.
An out-of-range value was supplied for the request parameter.
The target ID is invalid, unsupported, or doesn't exist.
You can't access the Amazon S3 bucket for report storage. For more information, see Additional Requirements for Organization-wide Tag Compliance Reports in the AWS Organizations User Guide.
ThrottledException
- The request was denied to limit the frequency of submitted requests.InternalServiceException
- The request processing failed because of an unknown error, exception, or failure. You can retry the
request.PaginationTokenExpiredException
- A PaginationToken
is valid for a maximum of 15 minutes. Your request was denied because the
specified PaginationToken
has expired.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ResourceGroupsTaggingApiException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetTagValuesResponse getTagValues(Consumer<GetTagValuesRequest.Builder> getTagValuesRequest) throws InvalidParameterException, ThrottledException, InternalServiceException, PaginationTokenExpiredException, AwsServiceException, SdkClientException, ResourceGroupsTaggingApiException
Returns all tag values for the specified key that are used in the specified AWS Region for the calling AWS account.
This operation supports pagination, where the response can be sent in multiple pages. You should check the
PaginationToken
response parameter to determine if there are additional results available to return.
Repeat the query, passing the PaginationToken
response parameter value as an input to the next
request until you recieve a null
value. A null value for PaginationToken
indicates that
there are no more results waiting to be returned.
This is a convenience which creates an instance of the GetTagValuesRequest.Builder
avoiding the need to
create one manually via GetTagValuesRequest.builder()
getTagValuesRequest
- A Consumer
that will call methods on GetTagValuesInput.Builder
to create a request.InvalidParameterException
- This error indicates one of the following:
A parameter is missing.
A malformed string was supplied for the request parameter.
An out-of-range value was supplied for the request parameter.
The target ID is invalid, unsupported, or doesn't exist.
You can't access the Amazon S3 bucket for report storage. For more information, see Additional Requirements for Organization-wide Tag Compliance Reports in the AWS Organizations User Guide.
ThrottledException
- The request was denied to limit the frequency of submitted requests.InternalServiceException
- The request processing failed because of an unknown error, exception, or failure. You can retry the
request.PaginationTokenExpiredException
- A PaginationToken
is valid for a maximum of 15 minutes. Your request was denied because the
specified PaginationToken
has expired.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ResourceGroupsTaggingApiException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetTagValuesIterable getTagValuesPaginator(GetTagValuesRequest getTagValuesRequest) throws InvalidParameterException, ThrottledException, InternalServiceException, PaginationTokenExpiredException, AwsServiceException, SdkClientException, ResourceGroupsTaggingApiException
Returns all tag values for the specified key that are used in the specified AWS Region for the calling AWS account.
This operation supports pagination, where the response can be sent in multiple pages. You should check the
PaginationToken
response parameter to determine if there are additional results available to return.
Repeat the query, passing the PaginationToken
response parameter value as an input to the next
request until you recieve a null
value. A null value for PaginationToken
indicates that
there are no more results waiting to be returned.
This is a variant of
getTagValues(software.amazon.awssdk.services.resourcegroupstaggingapi.model.GetTagValuesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.resourcegroupstaggingapi.paginators.GetTagValuesIterable responses = client.getTagValuesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.resourcegroupstaggingapi.paginators.GetTagValuesIterable responses = client .getTagValuesPaginator(request); for (software.amazon.awssdk.services.resourcegroupstaggingapi.model.GetTagValuesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.resourcegroupstaggingapi.paginators.GetTagValuesIterable responses = client.getTagValuesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getTagValues(software.amazon.awssdk.services.resourcegroupstaggingapi.model.GetTagValuesRequest)
operation.
getTagValuesRequest
- InvalidParameterException
- This error indicates one of the following:
A parameter is missing.
A malformed string was supplied for the request parameter.
An out-of-range value was supplied for the request parameter.
The target ID is invalid, unsupported, or doesn't exist.
You can't access the Amazon S3 bucket for report storage. For more information, see Additional Requirements for Organization-wide Tag Compliance Reports in the AWS Organizations User Guide.
ThrottledException
- The request was denied to limit the frequency of submitted requests.InternalServiceException
- The request processing failed because of an unknown error, exception, or failure. You can retry the
request.PaginationTokenExpiredException
- A PaginationToken
is valid for a maximum of 15 minutes. Your request was denied because the
specified PaginationToken
has expired.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ResourceGroupsTaggingApiException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetTagValuesIterable getTagValuesPaginator(Consumer<GetTagValuesRequest.Builder> getTagValuesRequest) throws InvalidParameterException, ThrottledException, InternalServiceException, PaginationTokenExpiredException, AwsServiceException, SdkClientException, ResourceGroupsTaggingApiException
Returns all tag values for the specified key that are used in the specified AWS Region for the calling AWS account.
This operation supports pagination, where the response can be sent in multiple pages. You should check the
PaginationToken
response parameter to determine if there are additional results available to return.
Repeat the query, passing the PaginationToken
response parameter value as an input to the next
request until you recieve a null
value. A null value for PaginationToken
indicates that
there are no more results waiting to be returned.
This is a variant of
getTagValues(software.amazon.awssdk.services.resourcegroupstaggingapi.model.GetTagValuesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.resourcegroupstaggingapi.paginators.GetTagValuesIterable responses = client.getTagValuesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.resourcegroupstaggingapi.paginators.GetTagValuesIterable responses = client .getTagValuesPaginator(request); for (software.amazon.awssdk.services.resourcegroupstaggingapi.model.GetTagValuesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.resourcegroupstaggingapi.paginators.GetTagValuesIterable responses = client.getTagValuesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getTagValues(software.amazon.awssdk.services.resourcegroupstaggingapi.model.GetTagValuesRequest)
operation.
This is a convenience which creates an instance of the GetTagValuesRequest.Builder
avoiding the need to
create one manually via GetTagValuesRequest.builder()
getTagValuesRequest
- A Consumer
that will call methods on GetTagValuesInput.Builder
to create a request.InvalidParameterException
- This error indicates one of the following:
A parameter is missing.
A malformed string was supplied for the request parameter.
An out-of-range value was supplied for the request parameter.
The target ID is invalid, unsupported, or doesn't exist.
You can't access the Amazon S3 bucket for report storage. For more information, see Additional Requirements for Organization-wide Tag Compliance Reports in the AWS Organizations User Guide.
ThrottledException
- The request was denied to limit the frequency of submitted requests.InternalServiceException
- The request processing failed because of an unknown error, exception, or failure. You can retry the
request.PaginationTokenExpiredException
- A PaginationToken
is valid for a maximum of 15 minutes. Your request was denied because the
specified PaginationToken
has expired.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ResourceGroupsTaggingApiException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default StartReportCreationResponse startReportCreation(StartReportCreationRequest startReportCreationRequest) throws ConcurrentModificationException, ConstraintViolationException, InternalServiceException, InvalidParameterException, ThrottledException, AwsServiceException, SdkClientException, ResourceGroupsTaggingApiException
Generates a report that lists all tagged resources in the accounts across your organization and tells whether each resource is compliant with the effective tag policy. Compliance data is refreshed daily. The report is generated asynchronously.
The generated report is saved to the following location:
s3://example-bucket/AwsTagPolicies/o-exampleorgid/YYYY-MM-ddTHH:mm:ssZ/report.csv
You can call this operation only from the organization's management account and from the us-east-1 Region.
startReportCreationRequest
- ConcurrentModificationException
- The target of the operation is currently being modified by a different request. Try again later.ConstraintViolationException
- The request was denied because performing this operation violates a constraint.
Some of the reasons in the following list might not apply to this specific operation.
You must meet the prerequisites for using tag policies. For information, see Prerequisites and Permissions for Using Tag Policies in the AWS Organizations User Guide.
You must enable the tag policies service principal (tagpolicies.tag.amazonaws.com
) to
integrate with AWS Organizations For information, see EnableAWSServiceAccess.
You must have a tag policy attached to the organization root, an OU, or an account.
InternalServiceException
- The request processing failed because of an unknown error, exception, or failure. You can retry the
request.InvalidParameterException
- This error indicates one of the following:
A parameter is missing.
A malformed string was supplied for the request parameter.
An out-of-range value was supplied for the request parameter.
The target ID is invalid, unsupported, or doesn't exist.
You can't access the Amazon S3 bucket for report storage. For more information, see Additional Requirements for Organization-wide Tag Compliance Reports in the AWS Organizations User Guide.
ThrottledException
- The request was denied to limit the frequency of submitted requests.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ResourceGroupsTaggingApiException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default StartReportCreationResponse startReportCreation(Consumer<StartReportCreationRequest.Builder> startReportCreationRequest) throws ConcurrentModificationException, ConstraintViolationException, InternalServiceException, InvalidParameterException, ThrottledException, AwsServiceException, SdkClientException, ResourceGroupsTaggingApiException
Generates a report that lists all tagged resources in the accounts across your organization and tells whether each resource is compliant with the effective tag policy. Compliance data is refreshed daily. The report is generated asynchronously.
The generated report is saved to the following location:
s3://example-bucket/AwsTagPolicies/o-exampleorgid/YYYY-MM-ddTHH:mm:ssZ/report.csv
You can call this operation only from the organization's management account and from the us-east-1 Region.
This is a convenience which creates an instance of the StartReportCreationRequest.Builder
avoiding the
need to create one manually via StartReportCreationRequest.builder()
startReportCreationRequest
- A Consumer
that will call methods on StartReportCreationInput.Builder
to create a request.ConcurrentModificationException
- The target of the operation is currently being modified by a different request. Try again later.ConstraintViolationException
- The request was denied because performing this operation violates a constraint.
Some of the reasons in the following list might not apply to this specific operation.
You must meet the prerequisites for using tag policies. For information, see Prerequisites and Permissions for Using Tag Policies in the AWS Organizations User Guide.
You must enable the tag policies service principal (tagpolicies.tag.amazonaws.com
) to
integrate with AWS Organizations For information, see EnableAWSServiceAccess.
You must have a tag policy attached to the organization root, an OU, or an account.
InternalServiceException
- The request processing failed because of an unknown error, exception, or failure. You can retry the
request.InvalidParameterException
- This error indicates one of the following:
A parameter is missing.
A malformed string was supplied for the request parameter.
An out-of-range value was supplied for the request parameter.
The target ID is invalid, unsupported, or doesn't exist.
You can't access the Amazon S3 bucket for report storage. For more information, see Additional Requirements for Organization-wide Tag Compliance Reports in the AWS Organizations User Guide.
ThrottledException
- The request was denied to limit the frequency of submitted requests.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ResourceGroupsTaggingApiException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default TagResourcesResponse tagResources(TagResourcesRequest tagResourcesRequest) throws InvalidParameterException, ThrottledException, InternalServiceException, AwsServiceException, SdkClientException, ResourceGroupsTaggingApiException
Applies one or more tags to the specified resources. Note the following:
Not all resources can have tags. For a list of services with resources that support tagging using this operation, see Services that support the Resource Groups Tagging API.
Each resource can have up to 50 tags. For other limits, see Tag Naming and Usage Conventions in the AWS General Reference.
You can only tag resources that are located in the specified AWS Region for the AWS account.
To add tags to a resource, you need the necessary permissions for the service that the resource belongs to as well as permissions for adding tags. For more information, see the documentation for each service.
Do not store personally identifiable information (PII) or other confidential or sensitive information in tags. We use tags to provide you with billing and administration services. Tags are not intended to be used for private or sensitive data.
tagResourcesRequest
- InvalidParameterException
- This error indicates one of the following:
A parameter is missing.
A malformed string was supplied for the request parameter.
An out-of-range value was supplied for the request parameter.
The target ID is invalid, unsupported, or doesn't exist.
You can't access the Amazon S3 bucket for report storage. For more information, see Additional Requirements for Organization-wide Tag Compliance Reports in the AWS Organizations User Guide.
ThrottledException
- The request was denied to limit the frequency of submitted requests.InternalServiceException
- The request processing failed because of an unknown error, exception, or failure. You can retry the
request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ResourceGroupsTaggingApiException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default TagResourcesResponse tagResources(Consumer<TagResourcesRequest.Builder> tagResourcesRequest) throws InvalidParameterException, ThrottledException, InternalServiceException, AwsServiceException, SdkClientException, ResourceGroupsTaggingApiException
Applies one or more tags to the specified resources. Note the following:
Not all resources can have tags. For a list of services with resources that support tagging using this operation, see Services that support the Resource Groups Tagging API.
Each resource can have up to 50 tags. For other limits, see Tag Naming and Usage Conventions in the AWS General Reference.
You can only tag resources that are located in the specified AWS Region for the AWS account.
To add tags to a resource, you need the necessary permissions for the service that the resource belongs to as well as permissions for adding tags. For more information, see the documentation for each service.
Do not store personally identifiable information (PII) or other confidential or sensitive information in tags. We use tags to provide you with billing and administration services. Tags are not intended to be used for private or sensitive data.
This is a convenience which creates an instance of the TagResourcesRequest.Builder
avoiding the need to
create one manually via TagResourcesRequest.builder()
tagResourcesRequest
- A Consumer
that will call methods on TagResourcesInput.Builder
to create a request.InvalidParameterException
- This error indicates one of the following:
A parameter is missing.
A malformed string was supplied for the request parameter.
An out-of-range value was supplied for the request parameter.
The target ID is invalid, unsupported, or doesn't exist.
You can't access the Amazon S3 bucket for report storage. For more information, see Additional Requirements for Organization-wide Tag Compliance Reports in the AWS Organizations User Guide.
ThrottledException
- The request was denied to limit the frequency of submitted requests.InternalServiceException
- The request processing failed because of an unknown error, exception, or failure. You can retry the
request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ResourceGroupsTaggingApiException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UntagResourcesResponse untagResources(UntagResourcesRequest untagResourcesRequest) throws InvalidParameterException, ThrottledException, InternalServiceException, AwsServiceException, SdkClientException, ResourceGroupsTaggingApiException
Removes the specified tags from the specified resources. When you specify a tag key, the action removes both that key and its associated value. The operation succeeds even if you attempt to remove tags from a resource that were already removed. Note the following:
To remove tags from a resource, you need the necessary permissions for the service that the resource belongs to as well as permissions for removing tags. For more information, see the documentation for the service whose resource you want to untag.
You can only tag resources that are located in the specified AWS Region for the calling AWS account.
untagResourcesRequest
- InvalidParameterException
- This error indicates one of the following:
A parameter is missing.
A malformed string was supplied for the request parameter.
An out-of-range value was supplied for the request parameter.
The target ID is invalid, unsupported, or doesn't exist.
You can't access the Amazon S3 bucket for report storage. For more information, see Additional Requirements for Organization-wide Tag Compliance Reports in the AWS Organizations User Guide.
ThrottledException
- The request was denied to limit the frequency of submitted requests.InternalServiceException
- The request processing failed because of an unknown error, exception, or failure. You can retry the
request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ResourceGroupsTaggingApiException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UntagResourcesResponse untagResources(Consumer<UntagResourcesRequest.Builder> untagResourcesRequest) throws InvalidParameterException, ThrottledException, InternalServiceException, AwsServiceException, SdkClientException, ResourceGroupsTaggingApiException
Removes the specified tags from the specified resources. When you specify a tag key, the action removes both that key and its associated value. The operation succeeds even if you attempt to remove tags from a resource that were already removed. Note the following:
To remove tags from a resource, you need the necessary permissions for the service that the resource belongs to as well as permissions for removing tags. For more information, see the documentation for the service whose resource you want to untag.
You can only tag resources that are located in the specified AWS Region for the calling AWS account.
This is a convenience which creates an instance of the UntagResourcesRequest.Builder
avoiding the need to
create one manually via UntagResourcesRequest.builder()
untagResourcesRequest
- A Consumer
that will call methods on UntagResourcesInput.Builder
to create a request.InvalidParameterException
- This error indicates one of the following:
A parameter is missing.
A malformed string was supplied for the request parameter.
An out-of-range value was supplied for the request parameter.
The target ID is invalid, unsupported, or doesn't exist.
You can't access the Amazon S3 bucket for report storage. For more information, see Additional Requirements for Organization-wide Tag Compliance Reports in the AWS Organizations User Guide.
ThrottledException
- The request was denied to limit the frequency of submitted requests.InternalServiceException
- The request processing failed because of an unknown error, exception, or failure. You can retry the
request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ResourceGroupsTaggingApiException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
static ServiceMetadata serviceMetadata()