@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface OamAsyncClient extends SdkClient
builder() method.
Use Amazon CloudWatch Observability Access Manager to create and manage links between source accounts and monitoring accounts by using CloudWatch cross-account observability. With CloudWatch cross-account observability, you can monitor and troubleshoot applications that span multiple accounts within a Region. Seamlessly search, visualize, and analyze your metrics, logs, and traces in any of the linked accounts without account boundaries.
<p>Set up one or more Amazon Web Services accounts as <i>monitoring accounts</i> and link them with multiple <i>source accounts</i>. A monitoring account is a central Amazon Web Services account that can view and interact with observability data generated from source accounts. A source account is an individual Amazon Web Services account that generates observability data for the resources that reside in it. Source accounts share their observability data with the monitoring account. The shared observability data can include metrics in Amazon CloudWatch, logs in Amazon CloudWatch Logs, and traces in X-Ray.</p>
| 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 OamAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
OamAsyncClient. |
static OamAsyncClient |
create()
Create a
OamAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CompletableFuture<CreateLinkResponse> |
createLink(Consumer<CreateLinkRequest.Builder> createLinkRequest)
Creates a link between a source account and a sink that you have created in a monitoring account.
|
default CompletableFuture<CreateLinkResponse> |
createLink(CreateLinkRequest createLinkRequest)
Creates a link between a source account and a sink that you have created in a monitoring account.
|
default CompletableFuture<CreateSinkResponse> |
createSink(Consumer<CreateSinkRequest.Builder> createSinkRequest)
Use this to create a sink in the current account, so that it can be used as a monitoring account in
CloudWatch cross-account observability.
|
default CompletableFuture<CreateSinkResponse> |
createSink(CreateSinkRequest createSinkRequest)
Use this to create a sink in the current account, so that it can be used as a monitoring account in
CloudWatch cross-account observability.
|
default CompletableFuture<DeleteLinkResponse> |
deleteLink(Consumer<DeleteLinkRequest.Builder> deleteLinkRequest)
Deletes a link between a monitoring account sink and a source account.
|
default CompletableFuture<DeleteLinkResponse> |
deleteLink(DeleteLinkRequest deleteLinkRequest)
Deletes a link between a monitoring account sink and a source account.
|
default CompletableFuture<DeleteSinkResponse> |
deleteSink(Consumer<DeleteSinkRequest.Builder> deleteSinkRequest)
Deletes a sink.
|
default CompletableFuture<DeleteSinkResponse> |
deleteSink(DeleteSinkRequest deleteSinkRequest)
Deletes a sink.
|
default CompletableFuture<GetLinkResponse> |
getLink(Consumer<GetLinkRequest.Builder> getLinkRequest)
Returns complete information about one link.
|
default CompletableFuture<GetLinkResponse> |
getLink(GetLinkRequest getLinkRequest)
Returns complete information about one link.
|
default CompletableFuture<GetSinkResponse> |
getSink(Consumer<GetSinkRequest.Builder> getSinkRequest)
Returns complete information about one monitoring account sink.
|
default CompletableFuture<GetSinkResponse> |
getSink(GetSinkRequest getSinkRequest)
Returns complete information about one monitoring account sink.
|
default CompletableFuture<GetSinkPolicyResponse> |
getSinkPolicy(Consumer<GetSinkPolicyRequest.Builder> getSinkPolicyRequest)
Returns the current sink policy attached to this sink.
|
default CompletableFuture<GetSinkPolicyResponse> |
getSinkPolicy(GetSinkPolicyRequest getSinkPolicyRequest)
Returns the current sink policy attached to this sink.
|
default CompletableFuture<ListAttachedLinksResponse> |
listAttachedLinks(Consumer<ListAttachedLinksRequest.Builder> listAttachedLinksRequest)
Returns a list of source account links that are linked to this monitoring account sink.
|
default CompletableFuture<ListAttachedLinksResponse> |
listAttachedLinks(ListAttachedLinksRequest listAttachedLinksRequest)
Returns a list of source account links that are linked to this monitoring account sink.
|
default ListAttachedLinksPublisher |
listAttachedLinksPaginator(Consumer<ListAttachedLinksRequest.Builder> listAttachedLinksRequest)
Returns a list of source account links that are linked to this monitoring account sink.
|
default ListAttachedLinksPublisher |
listAttachedLinksPaginator(ListAttachedLinksRequest listAttachedLinksRequest)
Returns a list of source account links that are linked to this monitoring account sink.
|
default CompletableFuture<ListLinksResponse> |
listLinks(Consumer<ListLinksRequest.Builder> listLinksRequest)
Use this operation in a source account to return a list of links to monitoring account sinks that this source
account has.
|
default CompletableFuture<ListLinksResponse> |
listLinks(ListLinksRequest listLinksRequest)
Use this operation in a source account to return a list of links to monitoring account sinks that this source
account has.
|
default ListLinksPublisher |
listLinksPaginator(Consumer<ListLinksRequest.Builder> listLinksRequest)
Use this operation in a source account to return a list of links to monitoring account sinks that this source
account has.
|
default ListLinksPublisher |
listLinksPaginator(ListLinksRequest listLinksRequest)
Use this operation in a source account to return a list of links to monitoring account sinks that this source
account has.
|
default CompletableFuture<ListSinksResponse> |
listSinks(Consumer<ListSinksRequest.Builder> listSinksRequest)
Use this operation in a monitoring account to return the list of sinks created in that account.
|
default CompletableFuture<ListSinksResponse> |
listSinks(ListSinksRequest listSinksRequest)
Use this operation in a monitoring account to return the list of sinks created in that account.
|
default ListSinksPublisher |
listSinksPaginator(Consumer<ListSinksRequest.Builder> listSinksRequest)
Use this operation in a monitoring account to return the list of sinks created in that account.
|
default ListSinksPublisher |
listSinksPaginator(ListSinksRequest listSinksRequest)
Use this operation in a monitoring account to return the list of sinks created in that account.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Displays the tags associated with a resource.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Displays the tags associated with a resource.
|
default CompletableFuture<PutSinkPolicyResponse> |
putSinkPolicy(Consumer<PutSinkPolicyRequest.Builder> putSinkPolicyRequest)
Creates or updates the resource policy that grants permissions to source accounts to link to the monitoring
account sink.
|
default CompletableFuture<PutSinkPolicyResponse> |
putSinkPolicy(PutSinkPolicyRequest putSinkPolicyRequest)
Creates or updates the resource policy that grants permissions to source accounts to link to the monitoring
account sink.
|
default CompletableFuture<TagResourceResponse> |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Assigns one or more tags (key-value pairs) to the specified resource.
|
default CompletableFuture<TagResourceResponse> |
tagResource(TagResourceRequest tagResourceRequest)
Assigns one or more tags (key-value pairs) to the specified resource.
|
default CompletableFuture<UntagResourceResponse> |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes one or more tags from the specified resource.
|
default CompletableFuture<UntagResourceResponse> |
untagResource(UntagResourceRequest untagResourceRequest)
Removes one or more tags from the specified resource.
|
default CompletableFuture<UpdateLinkResponse> |
updateLink(Consumer<UpdateLinkRequest.Builder> updateLinkRequest)
Use this operation to change what types of data are shared from a source account to its linked monitoring account
sink.
|
default CompletableFuture<UpdateLinkResponse> |
updateLink(UpdateLinkRequest updateLinkRequest)
Use this operation to change what types of data are shared from a source account to its linked monitoring account
sink.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.static OamAsyncClient create()
OamAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static OamAsyncClientBuilder builder()
OamAsyncClient.default CompletableFuture<CreateLinkResponse> createLink(CreateLinkRequest createLinkRequest)
Creates a link between a source account and a sink that you have created in a monitoring account.
Before you create a link, you must create a sink in the monitoring account and create a sink policy in that account. The sink policy must permit the source account to link to it. You can grant permission to source accounts by granting permission to an entire organization or to individual accounts.
For more information, see CreateSink and PutSinkPolicy.
Each monitoring account can be linked to as many as 100,000 source accounts.
Each source account can be linked to as many as five monitoring accounts.
createLinkRequest - default CompletableFuture<CreateLinkResponse> createLink(Consumer<CreateLinkRequest.Builder> createLinkRequest)
Creates a link between a source account and a sink that you have created in a monitoring account.
Before you create a link, you must create a sink in the monitoring account and create a sink policy in that account. The sink policy must permit the source account to link to it. You can grant permission to source accounts by granting permission to an entire organization or to individual accounts.
For more information, see CreateSink and PutSinkPolicy.
Each monitoring account can be linked to as many as 100,000 source accounts.
Each source account can be linked to as many as five monitoring accounts.
This is a convenience which creates an instance of the CreateLinkRequest.Builder avoiding the need to
create one manually via CreateLinkRequest.builder()
createLinkRequest - A Consumer that will call methods on CreateLinkInput.Builder to create a request.default CompletableFuture<CreateSinkResponse> createSink(CreateSinkRequest createSinkRequest)
Use this to create a sink in the current account, so that it can be used as a monitoring account in CloudWatch cross-account observability. A sink is a resource that represents an attachment point in a monitoring account. Source accounts can link to the sink to send observability data.
After you create a sink, you must create a sink policy that allows source accounts to attach to it. For more information, see PutSinkPolicy.
Each account can contain one sink. If you delete a sink, you can then create a new one in that account.
createSinkRequest - default CompletableFuture<CreateSinkResponse> createSink(Consumer<CreateSinkRequest.Builder> createSinkRequest)
Use this to create a sink in the current account, so that it can be used as a monitoring account in CloudWatch cross-account observability. A sink is a resource that represents an attachment point in a monitoring account. Source accounts can link to the sink to send observability data.
After you create a sink, you must create a sink policy that allows source accounts to attach to it. For more information, see PutSinkPolicy.
Each account can contain one sink. If you delete a sink, you can then create a new one in that account.
This is a convenience which creates an instance of the CreateSinkRequest.Builder avoiding the need to
create one manually via CreateSinkRequest.builder()
createSinkRequest - A Consumer that will call methods on CreateSinkInput.Builder to create a request.default CompletableFuture<DeleteLinkResponse> deleteLink(DeleteLinkRequest deleteLinkRequest)
Deletes a link between a monitoring account sink and a source account. You must run this operation in the source account.
deleteLinkRequest - default CompletableFuture<DeleteLinkResponse> deleteLink(Consumer<DeleteLinkRequest.Builder> deleteLinkRequest)
Deletes a link between a monitoring account sink and a source account. You must run this operation in the source account.
This is a convenience which creates an instance of the DeleteLinkRequest.Builder avoiding the need to
create one manually via DeleteLinkRequest.builder()
deleteLinkRequest - A Consumer that will call methods on DeleteLinkInput.Builder to create a request.default CompletableFuture<DeleteSinkResponse> deleteSink(DeleteSinkRequest deleteSinkRequest)
Deletes a sink. You must delete all links to a sink before you can delete that sink.
deleteSinkRequest - default CompletableFuture<DeleteSinkResponse> deleteSink(Consumer<DeleteSinkRequest.Builder> deleteSinkRequest)
Deletes a sink. You must delete all links to a sink before you can delete that sink.
This is a convenience which creates an instance of the DeleteSinkRequest.Builder avoiding the need to
create one manually via DeleteSinkRequest.builder()
deleteSinkRequest - A Consumer that will call methods on DeleteSinkInput.Builder to create a request.default CompletableFuture<GetLinkResponse> getLink(GetLinkRequest getLinkRequest)
Returns complete information about one link.
To use this operation, provide the link ARN. To retrieve a list of link ARNs, use ListLinks.
getLinkRequest - default CompletableFuture<GetLinkResponse> getLink(Consumer<GetLinkRequest.Builder> getLinkRequest)
Returns complete information about one link.
To use this operation, provide the link ARN. To retrieve a list of link ARNs, use ListLinks.
This is a convenience which creates an instance of the GetLinkRequest.Builder avoiding the need to create
one manually via GetLinkRequest.builder()
getLinkRequest - A Consumer that will call methods on GetLinkInput.Builder to create a request.default CompletableFuture<GetSinkResponse> getSink(GetSinkRequest getSinkRequest)
Returns complete information about one monitoring account sink.
To use this operation, provide the sink ARN. To retrieve a list of sink ARNs, use ListSinks.
getSinkRequest - default CompletableFuture<GetSinkResponse> getSink(Consumer<GetSinkRequest.Builder> getSinkRequest)
Returns complete information about one monitoring account sink.
To use this operation, provide the sink ARN. To retrieve a list of sink ARNs, use ListSinks.
This is a convenience which creates an instance of the GetSinkRequest.Builder avoiding the need to create
one manually via GetSinkRequest.builder()
getSinkRequest - A Consumer that will call methods on GetSinkInput.Builder to create a request.default CompletableFuture<GetSinkPolicyResponse> getSinkPolicy(GetSinkPolicyRequest getSinkPolicyRequest)
Returns the current sink policy attached to this sink. The sink policy specifies what accounts can attach to this sink as source accounts, and what types of data they can share.
getSinkPolicyRequest - default CompletableFuture<GetSinkPolicyResponse> getSinkPolicy(Consumer<GetSinkPolicyRequest.Builder> getSinkPolicyRequest)
Returns the current sink policy attached to this sink. The sink policy specifies what accounts can attach to this sink as source accounts, and what types of data they can share.
This is a convenience which creates an instance of the GetSinkPolicyRequest.Builder avoiding the need to
create one manually via GetSinkPolicyRequest.builder()
getSinkPolicyRequest - A Consumer that will call methods on GetSinkPolicyInput.Builder to create a request.default CompletableFuture<ListAttachedLinksResponse> listAttachedLinks(ListAttachedLinksRequest listAttachedLinksRequest)
Returns a list of source account links that are linked to this monitoring account sink.
To use this operation, provide the sink ARN. To retrieve a list of sink ARNs, use ListSinks.
To find a list of links for one source account, use ListLinks.
listAttachedLinksRequest - default CompletableFuture<ListAttachedLinksResponse> listAttachedLinks(Consumer<ListAttachedLinksRequest.Builder> listAttachedLinksRequest)
Returns a list of source account links that are linked to this monitoring account sink.
To use this operation, provide the sink ARN. To retrieve a list of sink ARNs, use ListSinks.
To find a list of links for one source account, use ListLinks.
This is a convenience which creates an instance of the ListAttachedLinksRequest.Builder avoiding the need
to create one manually via ListAttachedLinksRequest.builder()
listAttachedLinksRequest - A Consumer that will call methods on ListAttachedLinksInput.Builder to create a request.default ListAttachedLinksPublisher listAttachedLinksPaginator(ListAttachedLinksRequest listAttachedLinksRequest)
Returns a list of source account links that are linked to this monitoring account sink.
To use this operation, provide the sink ARN. To retrieve a list of sink ARNs, use ListSinks.
To find a list of links for one source account, use ListLinks.
This is a variant of
listAttachedLinks(software.amazon.awssdk.services.oam.model.ListAttachedLinksRequest) 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 subscribe helper method
software.amazon.awssdk.services.oam.paginators.ListAttachedLinksPublisher publisher = client.listAttachedLinksPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.oam.paginators.ListAttachedLinksPublisher publisher = client.listAttachedLinksPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.oam.model.ListAttachedLinksResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.oam.model.ListAttachedLinksResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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
listAttachedLinks(software.amazon.awssdk.services.oam.model.ListAttachedLinksRequest) operation.
listAttachedLinksRequest - default ListAttachedLinksPublisher listAttachedLinksPaginator(Consumer<ListAttachedLinksRequest.Builder> listAttachedLinksRequest)
Returns a list of source account links that are linked to this monitoring account sink.
To use this operation, provide the sink ARN. To retrieve a list of sink ARNs, use ListSinks.
To find a list of links for one source account, use ListLinks.
This is a variant of
listAttachedLinks(software.amazon.awssdk.services.oam.model.ListAttachedLinksRequest) 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 subscribe helper method
software.amazon.awssdk.services.oam.paginators.ListAttachedLinksPublisher publisher = client.listAttachedLinksPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.oam.paginators.ListAttachedLinksPublisher publisher = client.listAttachedLinksPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.oam.model.ListAttachedLinksResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.oam.model.ListAttachedLinksResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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
listAttachedLinks(software.amazon.awssdk.services.oam.model.ListAttachedLinksRequest) operation.
This is a convenience which creates an instance of the ListAttachedLinksRequest.Builder avoiding the need
to create one manually via ListAttachedLinksRequest.builder()
listAttachedLinksRequest - A Consumer that will call methods on ListAttachedLinksInput.Builder to create a request.default CompletableFuture<ListLinksResponse> listLinks(ListLinksRequest listLinksRequest)
Use this operation in a source account to return a list of links to monitoring account sinks that this source account has.
To find a list of links for one monitoring account sink, use ListAttachedLinks from within the monitoring account.
listLinksRequest - default CompletableFuture<ListLinksResponse> listLinks(Consumer<ListLinksRequest.Builder> listLinksRequest)
Use this operation in a source account to return a list of links to monitoring account sinks that this source account has.
To find a list of links for one monitoring account sink, use ListAttachedLinks from within the monitoring account.
This is a convenience which creates an instance of the ListLinksRequest.Builder avoiding the need to
create one manually via ListLinksRequest.builder()
listLinksRequest - A Consumer that will call methods on ListLinksInput.Builder to create a request.default ListLinksPublisher listLinksPaginator(ListLinksRequest listLinksRequest)
Use this operation in a source account to return a list of links to monitoring account sinks that this source account has.
To find a list of links for one monitoring account sink, use ListAttachedLinks from within the monitoring account.
This is a variant of listLinks(software.amazon.awssdk.services.oam.model.ListLinksRequest) 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 subscribe helper method
software.amazon.awssdk.services.oam.paginators.ListLinksPublisher publisher = client.listLinksPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.oam.paginators.ListLinksPublisher publisher = client.listLinksPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.oam.model.ListLinksResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.oam.model.ListLinksResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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
listLinks(software.amazon.awssdk.services.oam.model.ListLinksRequest) operation.
listLinksRequest - default ListLinksPublisher listLinksPaginator(Consumer<ListLinksRequest.Builder> listLinksRequest)
Use this operation in a source account to return a list of links to monitoring account sinks that this source account has.
To find a list of links for one monitoring account sink, use ListAttachedLinks from within the monitoring account.
This is a variant of listLinks(software.amazon.awssdk.services.oam.model.ListLinksRequest) 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 subscribe helper method
software.amazon.awssdk.services.oam.paginators.ListLinksPublisher publisher = client.listLinksPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.oam.paginators.ListLinksPublisher publisher = client.listLinksPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.oam.model.ListLinksResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.oam.model.ListLinksResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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
listLinks(software.amazon.awssdk.services.oam.model.ListLinksRequest) operation.
This is a convenience which creates an instance of the ListLinksRequest.Builder avoiding the need to
create one manually via ListLinksRequest.builder()
listLinksRequest - A Consumer that will call methods on ListLinksInput.Builder to create a request.default CompletableFuture<ListSinksResponse> listSinks(ListSinksRequest listSinksRequest)
Use this operation in a monitoring account to return the list of sinks created in that account.
listSinksRequest - default CompletableFuture<ListSinksResponse> listSinks(Consumer<ListSinksRequest.Builder> listSinksRequest)
Use this operation in a monitoring account to return the list of sinks created in that account.
This is a convenience which creates an instance of the ListSinksRequest.Builder avoiding the need to
create one manually via ListSinksRequest.builder()
listSinksRequest - A Consumer that will call methods on ListSinksInput.Builder to create a request.default ListSinksPublisher listSinksPaginator(ListSinksRequest listSinksRequest)
Use this operation in a monitoring account to return the list of sinks created in that account.
This is a variant of listSinks(software.amazon.awssdk.services.oam.model.ListSinksRequest) 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 subscribe helper method
software.amazon.awssdk.services.oam.paginators.ListSinksPublisher publisher = client.listSinksPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.oam.paginators.ListSinksPublisher publisher = client.listSinksPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.oam.model.ListSinksResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.oam.model.ListSinksResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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
listSinks(software.amazon.awssdk.services.oam.model.ListSinksRequest) operation.
listSinksRequest - default ListSinksPublisher listSinksPaginator(Consumer<ListSinksRequest.Builder> listSinksRequest)
Use this operation in a monitoring account to return the list of sinks created in that account.
This is a variant of listSinks(software.amazon.awssdk.services.oam.model.ListSinksRequest) 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 subscribe helper method
software.amazon.awssdk.services.oam.paginators.ListSinksPublisher publisher = client.listSinksPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.oam.paginators.ListSinksPublisher publisher = client.listSinksPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.oam.model.ListSinksResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.oam.model.ListSinksResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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
listSinks(software.amazon.awssdk.services.oam.model.ListSinksRequest) operation.
This is a convenience which creates an instance of the ListSinksRequest.Builder avoiding the need to
create one manually via ListSinksRequest.builder()
listSinksRequest - A Consumer that will call methods on ListSinksInput.Builder to create a request.default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Displays the tags associated with a resource. Both sinks and links support tagging.
listTagsForResourceRequest - default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Displays the tags associated with a resource. Both sinks and links support tagging.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceInput.Builder to create a request.default CompletableFuture<PutSinkPolicyResponse> putSinkPolicy(PutSinkPolicyRequest putSinkPolicyRequest)
Creates or updates the resource policy that grants permissions to source accounts to link to the monitoring account sink. When you create a sink policy, you can grant permissions to all accounts in an organization or to individual accounts.
You can also use a sink policy to limit the types of data that is shared. The three types that you can allow or deny are:
Metrics - Specify with AWS::CloudWatch::Metric
Log groups - Specify with AWS::Logs::LogGroup
Traces - Specify with AWS::XRay::Trace
See the examples in this section to see how to specify permitted source accounts and data types.
putSinkPolicyRequest - default CompletableFuture<PutSinkPolicyResponse> putSinkPolicy(Consumer<PutSinkPolicyRequest.Builder> putSinkPolicyRequest)
Creates or updates the resource policy that grants permissions to source accounts to link to the monitoring account sink. When you create a sink policy, you can grant permissions to all accounts in an organization or to individual accounts.
You can also use a sink policy to limit the types of data that is shared. The three types that you can allow or deny are:
Metrics - Specify with AWS::CloudWatch::Metric
Log groups - Specify with AWS::Logs::LogGroup
Traces - Specify with AWS::XRay::Trace
See the examples in this section to see how to specify permitted source accounts and data types.
This is a convenience which creates an instance of the PutSinkPolicyRequest.Builder avoiding the need to
create one manually via PutSinkPolicyRequest.builder()
putSinkPolicyRequest - A Consumer that will call methods on PutSinkPolicyInput.Builder to create a request.default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)
Assigns one or more tags (key-value pairs) to the specified resource. Both sinks and links can be tagged.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.
Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.
You can use the TagResource action with a resource that already has tags. If you specify a new tag
key for the alarm, this tag is appended to the list of tags associated with the alarm. If you specify a tag key
that is already associated with the alarm, the new tag value that you specify replaces the previous value for
that tag.
You can associate as many as 50 tags with a resource.
Unlike tagging permissions in other Amazon Web Services services, to tag or untag links and sinks you must have
the oam:ResourceTag permission. The iam:ResourceTag permission does not allow you to
tag and untag links and sinks.
tagResourceRequest - default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Assigns one or more tags (key-value pairs) to the specified resource. Both sinks and links can be tagged.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.
Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.
You can use the TagResource action with a resource that already has tags. If you specify a new tag
key for the alarm, this tag is appended to the list of tags associated with the alarm. If you specify a tag key
that is already associated with the alarm, the new tag value that you specify replaces the previous value for
that tag.
You can associate as many as 50 tags with a resource.
Unlike tagging permissions in other Amazon Web Services services, to tag or untag links and sinks you must have
the oam:ResourceTag permission. The iam:ResourceTag permission does not allow you to
tag and untag links and sinks.
This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on TagResourceInput.Builder to create a request.default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)
Removes one or more tags from the specified resource.
Unlike tagging permissions in other Amazon Web Services services, to tag or untag links and sinks you must have
the oam:ResourceTag permission. The iam:TagResource permission does not allow you to
tag and untag links and sinks.
untagResourceRequest - default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes one or more tags from the specified resource.
Unlike tagging permissions in other Amazon Web Services services, to tag or untag links and sinks you must have
the oam:ResourceTag permission. The iam:TagResource permission does not allow you to
tag and untag links and sinks.
This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on UntagResourceInput.Builder to create a request.default CompletableFuture<UpdateLinkResponse> updateLink(UpdateLinkRequest updateLinkRequest)
Use this operation to change what types of data are shared from a source account to its linked monitoring account sink. You can't change the sink or change the monitoring account with this operation.
To update the list of tags associated with the sink, use TagResource.
updateLinkRequest - default CompletableFuture<UpdateLinkResponse> updateLink(Consumer<UpdateLinkRequest.Builder> updateLinkRequest)
Use this operation to change what types of data are shared from a source account to its linked monitoring account sink. You can't change the sink or change the monitoring account with this operation.
To update the list of tags associated with the sink, use TagResource.
This is a convenience which creates an instance of the UpdateLinkRequest.Builder avoiding the need to
create one manually via UpdateLinkRequest.builder()
updateLinkRequest - A Consumer that will call methods on UpdateLinkInput.Builder to create a request.Copyright © 2022. All rights reserved.