@Generated(value="software.amazon.awssdk:codegen") public interface ResourceGroupsTaggingApiAsyncClient extends SdkClient
builder()
method.
This guide describes the API operations for the resource groups tagging.
A tag is a label that you assign to an AWS resource. A tag consists of a key and a value, both of which you define. For example, if you have two Amazon EC2 instances, you might assign both a tag key of "Stack." But the value of "Stack" might be "Testing" for one and "Production" for the other.
Tagging can help you organize your resources and enables you to simplify resource management, access management and cost allocation. For more information about tagging, see Working with Tag Editor and Working with Resource Groups. For more information about permissions you need to use the resource groups tagging APIs, see Obtaining Permissions for Resource Groups and Obtaining Permissions for Tagging .
You can use the resource groups tagging APIs to complete the following tasks:
Tag and untag supported resources located in the specified region for the AWS account
Use tag-based filters to search for resources located in the specified region for the AWS account
List all existing tag keys in the specified region for the AWS account
List all existing values for the specified key in the specified region for the AWS account
Not all resources can have tags. For a lists of resources that you can tag, see Supported Resources in the AWS Resource Groups and Tag Editor User Guide.
To make full use of the resource groups tagging APIs, you might need additional IAM permissions, including permission to access the resources of individual services as well as permission to view and apply tags to those resources. For more information, see Obtaining Permissions for Tagging in the AWS Resource Groups and Tag Editor User Guide.
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_NAME |
Modifier and Type | Method and Description |
---|---|
static ResourceGroupsTaggingApiAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
ResourceGroupsTaggingApiAsyncClient . |
static ResourceGroupsTaggingApiAsyncClient |
create()
Create a
ResourceGroupsTaggingApiAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider . |
default CompletableFuture<GetResourcesResponse> |
getResources()
Returns all the tagged resources that are associated with the specified tags (keys and values) located in the
specified region for the AWS account.
|
default CompletableFuture<GetResourcesResponse> |
getResources(Consumer<GetResourcesRequest.Builder> getResourcesRequest)
Returns all the tagged resources that are associated with the specified tags (keys and values) located in the
specified region for the AWS account.
|
default CompletableFuture<GetResourcesResponse> |
getResources(GetResourcesRequest getResourcesRequest)
Returns all the tagged resources that are associated with the specified tags (keys and values) located in the
specified region for the AWS account.
|
default GetResourcesPublisher |
getResourcesPaginator()
Returns all the tagged resources that are associated with the specified tags (keys and values) located in the
specified region for the AWS account.
|
default GetResourcesPublisher |
getResourcesPaginator(Consumer<GetResourcesRequest.Builder> getResourcesRequest)
Returns all the tagged resources that are associated with the specified tags (keys and values) located in the
specified region for the AWS account.
|
default GetResourcesPublisher |
getResourcesPaginator(GetResourcesRequest getResourcesRequest)
Returns all the tagged resources that are associated with the specified tags (keys and values) located in the
specified region for the AWS account.
|
default CompletableFuture<GetTagKeysResponse> |
getTagKeys()
Returns all tag keys in the specified region for the AWS account.
|
default CompletableFuture<GetTagKeysResponse> |
getTagKeys(Consumer<GetTagKeysRequest.Builder> getTagKeysRequest)
Returns all tag keys in the specified region for the AWS account.
|
default CompletableFuture<GetTagKeysResponse> |
getTagKeys(GetTagKeysRequest getTagKeysRequest)
Returns all tag keys in the specified region for the AWS account.
|
default GetTagKeysPublisher |
getTagKeysPaginator()
Returns all tag keys in the specified region for the AWS account.
|
default GetTagKeysPublisher |
getTagKeysPaginator(Consumer<GetTagKeysRequest.Builder> getTagKeysRequest)
Returns all tag keys in the specified region for the AWS account.
|
default GetTagKeysPublisher |
getTagKeysPaginator(GetTagKeysRequest getTagKeysRequest)
Returns all tag keys in the specified region for the AWS account.
|
default CompletableFuture<GetTagValuesResponse> |
getTagValues(Consumer<GetTagValuesRequest.Builder> getTagValuesRequest)
Returns all tag values for the specified key in the specified region for the AWS account.
|
default CompletableFuture<GetTagValuesResponse> |
getTagValues(GetTagValuesRequest getTagValuesRequest)
Returns all tag values for the specified key in the specified region for the AWS account.
|
default GetTagValuesPublisher |
getTagValuesPaginator(Consumer<GetTagValuesRequest.Builder> getTagValuesRequest)
Returns all tag values for the specified key in the specified region for the AWS account.
|
default GetTagValuesPublisher |
getTagValuesPaginator(GetTagValuesRequest getTagValuesRequest)
Returns all tag values for the specified key in the specified region for the AWS account.
|
default CompletableFuture<TagResourcesResponse> |
tagResources(Consumer<TagResourcesRequest.Builder> tagResourcesRequest)
Applies one or more tags to the specified resources.
|
default CompletableFuture<TagResourcesResponse> |
tagResources(TagResourcesRequest tagResourcesRequest)
Applies one or more tags to the specified resources.
|
default CompletableFuture<UntagResourcesResponse> |
untagResources(Consumer<UntagResourcesRequest.Builder> untagResourcesRequest)
Removes the specified tags from the specified resources.
|
default CompletableFuture<UntagResourcesResponse> |
untagResources(UntagResourcesRequest untagResourcesRequest)
Removes the specified tags from the specified resources.
|
serviceName
close
static final String SERVICE_NAME
static ResourceGroupsTaggingApiAsyncClient create()
ResourceGroupsTaggingApiAsyncClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static ResourceGroupsTaggingApiAsyncClientBuilder builder()
ResourceGroupsTaggingApiAsyncClient
.default CompletableFuture<GetResourcesResponse> getResources(GetResourcesRequest getResourcesRequest)
Returns all the tagged resources that are associated with the specified tags (keys and values) located in the specified region for the AWS account. The tags and the resource types that you specify in the request are known as filters. The response includes all tags that are associated with the requested resources. If no filter is provided, this action returns a paginated resource list with the associated tags.
getResourcesRequest
- PaginationToken
is valid for a maximum of 15 minutes.
Your request was denied because the specified PaginationToken
has expired.default CompletableFuture<GetResourcesResponse> getResources(Consumer<GetResourcesRequest.Builder> getResourcesRequest)
Returns all the tagged resources that are associated with the specified tags (keys and values) located in the specified region for the AWS account. The tags and the resource types that you specify in the request are known as filters. The response includes all tags that are associated with the requested resources. If no filter is provided, this action returns a paginated resource list with the associated tags.
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.PaginationToken
is valid for a maximum of 15 minutes.
Your request was denied because the specified PaginationToken
has expired.default CompletableFuture<GetResourcesResponse> getResources()
Returns all the tagged resources that are associated with the specified tags (keys and values) located in the specified region for the AWS account. The tags and the resource types that you specify in the request are known as filters. The response includes all tags that are associated with the requested resources. If no filter is provided, this action returns a paginated resource list with the associated tags.
PaginationToken
is valid for a maximum of 15 minutes.
Your request was denied because the specified PaginationToken
has expired.default GetResourcesPublisher getResourcesPaginator()
Returns all the tagged resources that are associated with the specified tags (keys and values) located in the specified region for the AWS account. The tags and the resource types that you specify in the request are known as filters. The response includes all tags that are associated with the requested resources. If no filter is provided, this action returns a paginated resource list with the associated tags.
This is a variant of
getResources(software.amazon.awssdk.services.resourcegroupstaggingapi.model.GetResourcesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.resourcegroupstaggingapi.paginators.GetResourcesPublisher publisher = client.getResourcesPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.resourcegroupstaggingapi.paginators.GetResourcesPublisher publisher = client.getResourcesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.resourcegroupstaggingapi.model.GetResourcesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.resourcegroupstaggingapi.model.GetResourcesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
getResources(software.amazon.awssdk.services.resourcegroupstaggingapi.model.GetResourcesRequest)
operation.
PaginationToken
is valid for a maximum of 15 minutes.
Your request was denied because the specified PaginationToken
has expired.default GetResourcesPublisher getResourcesPaginator(GetResourcesRequest getResourcesRequest)
Returns all the tagged resources that are associated with the specified tags (keys and values) located in the specified region for the AWS account. The tags and the resource types that you specify in the request are known as filters. The response includes all tags that are associated with the requested resources. If no filter is provided, this action returns a paginated resource list with the associated tags.
This is a variant of
getResources(software.amazon.awssdk.services.resourcegroupstaggingapi.model.GetResourcesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.resourcegroupstaggingapi.paginators.GetResourcesPublisher publisher = client.getResourcesPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.resourcegroupstaggingapi.paginators.GetResourcesPublisher publisher = client.getResourcesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.resourcegroupstaggingapi.model.GetResourcesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.resourcegroupstaggingapi.model.GetResourcesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
getResources(software.amazon.awssdk.services.resourcegroupstaggingapi.model.GetResourcesRequest)
operation.
getResourcesRequest
- PaginationToken
is valid for a maximum of 15 minutes.
Your request was denied because the specified PaginationToken
has expired.default GetResourcesPublisher getResourcesPaginator(Consumer<GetResourcesRequest.Builder> getResourcesRequest)
Returns all the tagged resources that are associated with the specified tags (keys and values) located in the specified region for the AWS account. The tags and the resource types that you specify in the request are known as filters. The response includes all tags that are associated with the requested resources. If no filter is provided, this action returns a paginated resource list with the associated tags.
This is a variant of
getResources(software.amazon.awssdk.services.resourcegroupstaggingapi.model.GetResourcesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.resourcegroupstaggingapi.paginators.GetResourcesPublisher publisher = client.getResourcesPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.resourcegroupstaggingapi.paginators.GetResourcesPublisher publisher = client.getResourcesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.resourcegroupstaggingapi.model.GetResourcesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.resourcegroupstaggingapi.model.GetResourcesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.PaginationToken
is valid for a maximum of 15 minutes.
Your request was denied because the specified PaginationToken
has expired.default CompletableFuture<GetTagKeysResponse> getTagKeys(GetTagKeysRequest getTagKeysRequest)
Returns all tag keys in the specified region for the AWS account.
getTagKeysRequest
- PaginationToken
is valid for a maximum of 15 minutes.
Your request was denied because the specified PaginationToken
has expired.default CompletableFuture<GetTagKeysResponse> getTagKeys(Consumer<GetTagKeysRequest.Builder> getTagKeysRequest)
Returns all tag keys in the specified region for the AWS account.
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.PaginationToken
is valid for a maximum of 15 minutes.
Your request was denied because the specified PaginationToken
has expired.default CompletableFuture<GetTagKeysResponse> getTagKeys()
Returns all tag keys in the specified region for the AWS account.
PaginationToken
is valid for a maximum of 15 minutes.
Your request was denied because the specified PaginationToken
has expired.default GetTagKeysPublisher getTagKeysPaginator()
Returns all tag keys in the specified region for the AWS account.
This is a variant of
getTagKeys(software.amazon.awssdk.services.resourcegroupstaggingapi.model.GetTagKeysRequest)
operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.resourcegroupstaggingapi.paginators.GetTagKeysPublisher publisher = client.getTagKeysPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.resourcegroupstaggingapi.paginators.GetTagKeysPublisher publisher = client.getTagKeysPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.resourcegroupstaggingapi.model.GetTagKeysResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.resourcegroupstaggingapi.model.GetTagKeysResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
getTagKeys(software.amazon.awssdk.services.resourcegroupstaggingapi.model.GetTagKeysRequest)
operation.
PaginationToken
is valid for a maximum of 15 minutes.
Your request was denied because the specified PaginationToken
has expired.default GetTagKeysPublisher getTagKeysPaginator(GetTagKeysRequest getTagKeysRequest)
Returns all tag keys in the specified region for the AWS account.
This is a variant of
getTagKeys(software.amazon.awssdk.services.resourcegroupstaggingapi.model.GetTagKeysRequest)
operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.resourcegroupstaggingapi.paginators.GetTagKeysPublisher publisher = client.getTagKeysPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.resourcegroupstaggingapi.paginators.GetTagKeysPublisher publisher = client.getTagKeysPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.resourcegroupstaggingapi.model.GetTagKeysResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.resourcegroupstaggingapi.model.GetTagKeysResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
getTagKeys(software.amazon.awssdk.services.resourcegroupstaggingapi.model.GetTagKeysRequest)
operation.
getTagKeysRequest
- PaginationToken
is valid for a maximum of 15 minutes.
Your request was denied because the specified PaginationToken
has expired.default GetTagKeysPublisher getTagKeysPaginator(Consumer<GetTagKeysRequest.Builder> getTagKeysRequest)
Returns all tag keys in the specified region for the AWS account.
This is a variant of
getTagKeys(software.amazon.awssdk.services.resourcegroupstaggingapi.model.GetTagKeysRequest)
operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.resourcegroupstaggingapi.paginators.GetTagKeysPublisher publisher = client.getTagKeysPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.resourcegroupstaggingapi.paginators.GetTagKeysPublisher publisher = client.getTagKeysPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.resourcegroupstaggingapi.model.GetTagKeysResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.resourcegroupstaggingapi.model.GetTagKeysResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.PaginationToken
is valid for a maximum of 15 minutes.
Your request was denied because the specified PaginationToken
has expired.default CompletableFuture<GetTagValuesResponse> getTagValues(GetTagValuesRequest getTagValuesRequest)
Returns all tag values for the specified key in the specified region for the AWS account.
getTagValuesRequest
- PaginationToken
is valid for a maximum of 15 minutes.
Your request was denied because the specified PaginationToken
has expired.default CompletableFuture<GetTagValuesResponse> getTagValues(Consumer<GetTagValuesRequest.Builder> getTagValuesRequest)
Returns all tag values for the specified key in the specified region for the AWS account.
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.PaginationToken
is valid for a maximum of 15 minutes.
Your request was denied because the specified PaginationToken
has expired.default GetTagValuesPublisher getTagValuesPaginator(GetTagValuesRequest getTagValuesRequest)
Returns all tag values for the specified key in the specified region for the AWS account.
This is a variant of
getTagValues(software.amazon.awssdk.services.resourcegroupstaggingapi.model.GetTagValuesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.resourcegroupstaggingapi.paginators.GetTagValuesPublisher publisher = client.getTagValuesPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.resourcegroupstaggingapi.paginators.GetTagValuesPublisher publisher = client.getTagValuesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.resourcegroupstaggingapi.model.GetTagValuesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.resourcegroupstaggingapi.model.GetTagValuesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
getTagValues(software.amazon.awssdk.services.resourcegroupstaggingapi.model.GetTagValuesRequest)
operation.
getTagValuesRequest
- PaginationToken
is valid for a maximum of 15 minutes.
Your request was denied because the specified PaginationToken
has expired.default GetTagValuesPublisher getTagValuesPaginator(Consumer<GetTagValuesRequest.Builder> getTagValuesRequest)
Returns all tag values for the specified key in the specified region for the AWS account.
This is a variant of
getTagValues(software.amazon.awssdk.services.resourcegroupstaggingapi.model.GetTagValuesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.resourcegroupstaggingapi.paginators.GetTagValuesPublisher publisher = client.getTagValuesPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.resourcegroupstaggingapi.paginators.GetTagValuesPublisher publisher = client.getTagValuesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.resourcegroupstaggingapi.model.GetTagValuesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.resourcegroupstaggingapi.model.GetTagValuesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.PaginationToken
is valid for a maximum of 15 minutes.
Your request was denied because the specified PaginationToken
has expired.default CompletableFuture<TagResourcesResponse> tagResources(TagResourcesRequest tagResourcesRequest)
Applies one or more tags to the specified resources. Note the following:
Not all resources can have tags. For a list of resources that support tagging, see Supported Resources in the AWS Resource Groups and Tag Editor User Guide.
Each resource can have up to 50 tags. For other limits, see Tag Restrictions in the Amazon EC2 User Guide for Linux Instances.
You can only tag resources that are located in the specified 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 Obtaining Permissions for Tagging in the AWS Resource Groups and Tag Editor User Guide.
tagResourcesRequest
- default CompletableFuture<TagResourcesResponse> tagResources(Consumer<TagResourcesRequest.Builder> tagResourcesRequest)
Applies one or more tags to the specified resources. Note the following:
Not all resources can have tags. For a list of resources that support tagging, see Supported Resources in the AWS Resource Groups and Tag Editor User Guide.
Each resource can have up to 50 tags. For other limits, see Tag Restrictions in the Amazon EC2 User Guide for Linux Instances.
You can only tag resources that are located in the specified 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 Obtaining Permissions for Tagging in the AWS Resource Groups and Tag Editor User Guide.
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.default CompletableFuture<UntagResourcesResponse> untagResources(UntagResourcesRequest untagResourcesRequest)
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 Obtaining Permissions for Tagging in the AWS Resource Groups and Tag Editor User Guide.
You can only tag resources that are located in the specified region for the AWS account.
untagResourcesRequest
- default CompletableFuture<UntagResourcesResponse> untagResources(Consumer<UntagResourcesRequest.Builder> untagResourcesRequest)
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 Obtaining Permissions for Tagging in the AWS Resource Groups and Tag Editor User Guide.
You can only tag resources that are located in the specified region for the 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.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.