All Superinterfaces:: AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen") @SdkPublicApi @ThreadSafe public interface OamClient extends AwsClient

Service client for accessing CloudWatch Observability Access Manager. This can be created using the static 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, traces, Application Signals services and service level objectives (SLOs), Application Insights applications, and internet monitors in any of the linked accounts without account boundaries.

Set up one or more Amazon Web Services accounts as monitoring accounts and link them with multiple source accounts. 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, traces in X-Ray, Application Signals services and service level objectives (SLOs), applications in Amazon CloudWatch Application Insights, and internet monitors in CloudWatch Internet Monitor.

When you set up a link, you can choose to share the metrics from all namespaces with the monitoring account, or filter to a subset of namespaces. And for CloudWatch Logs, you can choose to share all log groups with the monitoring account, or filter to a subset of log groups.

Field Summary

Fields

Modifier and Type

Field

Description

static final String

SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

static final String

SERVICE_NAME
Method Summary

Modifier and Type

Method

Description

static OamClientBuilder

builder()

Create a builder that can be used to configure and create a OamClient.

static OamClient

create()

Create a OamClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

default 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 CreateLinkResponse

createLink(CreateLinkRequest createLinkRequest)

Creates a link between a source account and a sink that you have created in a monitoring account.

default 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 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 DeleteLinkResponse

deleteLink(Consumer<DeleteLinkRequest.Builder> deleteLinkRequest)

Deletes a link between a monitoring account sink and a source account.

default DeleteLinkResponse

deleteLink(DeleteLinkRequest deleteLinkRequest)

Deletes a link between a monitoring account sink and a source account.

default DeleteSinkResponse

deleteSink(Consumer<DeleteSinkRequest.Builder> deleteSinkRequest)

Deletes a sink.

default DeleteSinkResponse

deleteSink(DeleteSinkRequest deleteSinkRequest)

Deletes a sink.

default GetLinkResponse

getLink(Consumer<GetLinkRequest.Builder> getLinkRequest)

Returns complete information about one link.

default GetLinkResponse

getLink(GetLinkRequest getLinkRequest)

Returns complete information about one link.

default GetSinkResponse

getSink(Consumer<GetSinkRequest.Builder> getSinkRequest)

Returns complete information about one monitoring account sink.

default GetSinkResponse

getSink(GetSinkRequest getSinkRequest)

Returns complete information about one monitoring account sink.

default GetSinkPolicyResponse

getSinkPolicy(Consumer<GetSinkPolicyRequest.Builder> getSinkPolicyRequest)

Returns the current sink policy attached to this sink.

default GetSinkPolicyResponse

getSinkPolicy(GetSinkPolicyRequest getSinkPolicyRequest)

Returns the current sink policy attached to this sink.

default ListAttachedLinksResponse

listAttachedLinks(Consumer<ListAttachedLinksRequest.Builder> listAttachedLinksRequest)

Returns a list of source account links that are linked to this monitoring account sink.

default ListAttachedLinksResponse

listAttachedLinks(ListAttachedLinksRequest listAttachedLinksRequest)

Returns a list of source account links that are linked to this monitoring account sink.

default ListAttachedLinksIterable

listAttachedLinksPaginator(Consumer<ListAttachedLinksRequest.Builder> listAttachedLinksRequest)

This is a variant of listAttachedLinks(software.amazon.awssdk.services.oam.model.ListAttachedLinksRequest) operation.

default ListAttachedLinksIterable

listAttachedLinksPaginator(ListAttachedLinksRequest listAttachedLinksRequest)

This is a variant of listAttachedLinks(software.amazon.awssdk.services.oam.model.ListAttachedLinksRequest) operation.

default 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 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 ListLinksIterable

listLinksPaginator(Consumer<ListLinksRequest.Builder> listLinksRequest)

This is a variant of listLinks(software.amazon.awssdk.services.oam.model.ListLinksRequest) operation.

default ListLinksIterable

listLinksPaginator(ListLinksRequest listLinksRequest)

This is a variant of listLinks(software.amazon.awssdk.services.oam.model.ListLinksRequest) operation.

default ListSinksResponse

listSinks(Consumer<ListSinksRequest.Builder> listSinksRequest)

Use this operation in a monitoring account to return the list of sinks created in that account.

default ListSinksResponse

listSinks(ListSinksRequest listSinksRequest)

Use this operation in a monitoring account to return the list of sinks created in that account.

default ListSinksIterable

listSinksPaginator(Consumer<ListSinksRequest.Builder> listSinksRequest)

This is a variant of listSinks(software.amazon.awssdk.services.oam.model.ListSinksRequest) operation.

default ListSinksIterable

listSinksPaginator(ListSinksRequest listSinksRequest)

This is a variant of listSinks(software.amazon.awssdk.services.oam.model.ListSinksRequest) operation.

default ListTagsForResourceResponse

listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)

Displays the tags associated with a resource.

default ListTagsForResourceResponse

listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

Displays the tags associated with a resource.

default 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 PutSinkPolicyResponse

putSinkPolicy(PutSinkPolicyRequest putSinkPolicyRequest)

Creates or updates the resource policy that grants permissions to source accounts to link to the monitoring account sink.

default OamServiceClientConfiguration

serviceClientConfiguration()

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

static ServiceMetadata

serviceMetadata()

default TagResourceResponse

tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)

Assigns one or more tags (key-value pairs) to the specified resource.

default TagResourceResponse

tagResource(TagResourceRequest tagResourceRequest)

Assigns one or more tags (key-value pairs) to the specified resource.

default UntagResourceResponse

untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)

Removes one or more tags from the specified resource.

default UntagResourceResponse

untagResource(UntagResourceRequest untagResourceRequest)

Removes one or more tags from the specified resource.

default 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 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.

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close

Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName

Field Details
- SERVICE_NAME
  static final String SERVICE_NAME
  
  See Also:
  
  Constant Field Values
- SERVICE_METADATA_ID
  static final String SERVICE_METADATA_ID
  
  Value for looking up the service's metadata from the ServiceMetadataProvider.
  
  See Also:
  
  Constant Field Values
Method Details
- createLink
  default CreateLinkResponse createLink(CreateLinkRequest createLinkRequest) throws InternalServiceException, ConflictException, MissingRequiredParameterException, ServiceQuotaExceededException, InvalidParameterException, AwsServiceException, SdkClientException, OamException
  
  Creates a link between a source account and a sink that you have created in a monitoring account. After the link is created, data is sent from the source account to the monitoring account. When you create a link, you can optionally specify filters that specify which metric namespaces and which log groups are shared from the source account to the 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.
  
  Parameters:
  
  createLinkRequest -
  
  Returns:
  
  Result of the CreateLink operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- createLink
  default CreateLinkResponse createLink(Consumer<CreateLinkRequest.Builder> createLinkRequest) throws InternalServiceException, ConflictException, MissingRequiredParameterException, ServiceQuotaExceededException, InvalidParameterException, AwsServiceException, SdkClientException, OamException
  
  Creates a link between a source account and a sink that you have created in a monitoring account. After the link is created, data is sent from the source account to the monitoring account. When you create a link, you can optionally specify filters that specify which metric namespaces and which log groups are shared from the source account to the 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()
  
  Parameters:
  
  createLinkRequest - A Consumer that will call methods on CreateLinkRequest.Builder to create a request.
  
  Returns:
  
  Result of the CreateLink operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- createSink
  default CreateSinkResponse createSink(CreateSinkRequest createSinkRequest) throws InternalServiceException, ConflictException, MissingRequiredParameterException, ServiceQuotaExceededException, InvalidParameterException, AwsServiceException, SdkClientException, OamException
  
  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 per Region. If you delete a sink, you can then create a new one in that Region.
  
  Parameters:
  
  createSinkRequest -
  
  Returns:
  
  Result of the CreateSink operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- createSink
  default CreateSinkResponse createSink(Consumer<CreateSinkRequest.Builder> createSinkRequest) throws InternalServiceException, ConflictException, MissingRequiredParameterException, ServiceQuotaExceededException, InvalidParameterException, AwsServiceException, SdkClientException, OamException
  
  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 per Region. If you delete a sink, you can then create a new one in that Region.
  
  This is a convenience which creates an instance of the CreateSinkRequest.Builder avoiding the need to create one manually via CreateSinkRequest.builder()
  
  Parameters:
  
  createSinkRequest - A Consumer that will call methods on CreateSinkRequest.Builder to create a request.
  
  Returns:
  
  Result of the CreateSink operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- deleteLink
  default DeleteLinkResponse deleteLink(DeleteLinkRequest deleteLinkRequest) throws InternalServiceException, MissingRequiredParameterException, InvalidParameterException, ResourceNotFoundException, AwsServiceException, SdkClientException, OamException
  
  Deletes a link between a monitoring account sink and a source account. You must run this operation in the source account.
  
  Parameters:
  
  deleteLinkRequest -
  
  Returns:
  
  Result of the DeleteLink operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- deleteLink
  default DeleteLinkResponse deleteLink(Consumer<DeleteLinkRequest.Builder> deleteLinkRequest) throws InternalServiceException, MissingRequiredParameterException, InvalidParameterException, ResourceNotFoundException, AwsServiceException, SdkClientException, OamException
  
  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()
  
  Parameters:
  
  deleteLinkRequest - A Consumer that will call methods on DeleteLinkRequest.Builder to create a request.
  
  Returns:
  
  Result of the DeleteLink operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- deleteSink
  default DeleteSinkResponse deleteSink(DeleteSinkRequest deleteSinkRequest) throws InternalServiceException, ConflictException, MissingRequiredParameterException, InvalidParameterException, ResourceNotFoundException, AwsServiceException, SdkClientException, OamException
  
  Deletes a sink. You must delete all links to a sink before you can delete that sink.
  
  Parameters:
  
  deleteSinkRequest -
  
  Returns:
  
  Result of the DeleteSink operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- deleteSink
  default DeleteSinkResponse deleteSink(Consumer<DeleteSinkRequest.Builder> deleteSinkRequest) throws InternalServiceException, ConflictException, MissingRequiredParameterException, InvalidParameterException, ResourceNotFoundException, AwsServiceException, SdkClientException, OamException
  
  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()
  
  Parameters:
  
  deleteSinkRequest - A Consumer that will call methods on DeleteSinkRequest.Builder to create a request.
  
  Returns:
  
  Result of the DeleteSink operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- getLink
  default GetLinkResponse getLink(GetLinkRequest getLinkRequest) throws InternalServiceException, MissingRequiredParameterException, InvalidParameterException, ResourceNotFoundException, AwsServiceException, SdkClientException, OamException
  
  Returns complete information about one link.
  
  To use this operation, provide the link ARN. To retrieve a list of link ARNs, use ListLinks.
  
  Parameters:
  
  getLinkRequest -
  
  Returns:
  
  Result of the GetLink operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- getLink
  default GetLinkResponse getLink(Consumer<GetLinkRequest.Builder> getLinkRequest) throws InternalServiceException, MissingRequiredParameterException, InvalidParameterException, ResourceNotFoundException, AwsServiceException, SdkClientException, OamException
  
  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()
  
  Parameters:
  
  getLinkRequest - A Consumer that will call methods on GetLinkRequest.Builder to create a request.
  
  Returns:
  
  Result of the GetLink operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- getSink
  default GetSinkResponse getSink(GetSinkRequest getSinkRequest) throws InternalServiceException, MissingRequiredParameterException, InvalidParameterException, ResourceNotFoundException, AwsServiceException, SdkClientException, OamException
  
  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.
  
  Parameters:
  
  getSinkRequest -
  
  Returns:
  
  Result of the GetSink operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- getSink
  default GetSinkResponse getSink(Consumer<GetSinkRequest.Builder> getSinkRequest) throws InternalServiceException, MissingRequiredParameterException, InvalidParameterException, ResourceNotFoundException, AwsServiceException, SdkClientException, OamException
  
  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()
  
  Parameters:
  
  getSinkRequest - A Consumer that will call methods on GetSinkRequest.Builder to create a request.
  
  Returns:
  
  Result of the GetSink operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- getSinkPolicy
  default GetSinkPolicyResponse getSinkPolicy(GetSinkPolicyRequest getSinkPolicyRequest) throws InternalServiceException, MissingRequiredParameterException, InvalidParameterException, ResourceNotFoundException, AwsServiceException, SdkClientException, OamException
  
  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.
  
  Parameters:
  
  getSinkPolicyRequest -
  
  Returns:
  
  Result of the GetSinkPolicy operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- getSinkPolicy
  default GetSinkPolicyResponse getSinkPolicy(Consumer<GetSinkPolicyRequest.Builder> getSinkPolicyRequest) throws InternalServiceException, MissingRequiredParameterException, InvalidParameterException, ResourceNotFoundException, AwsServiceException, SdkClientException, OamException
  
  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()
  
  Parameters:
  
  getSinkPolicyRequest - A Consumer that will call methods on GetSinkPolicyRequest.Builder to create a request.
  
  Returns:
  
  Result of the GetSinkPolicy operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- listAttachedLinks
  default ListAttachedLinksResponse listAttachedLinks(ListAttachedLinksRequest listAttachedLinksRequest) throws InternalServiceException, MissingRequiredParameterException, InvalidParameterException, ResourceNotFoundException, AwsServiceException, SdkClientException, OamException
  
  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.
  
  Parameters:
  
  listAttachedLinksRequest -
  
  Returns:
  
  Result of the ListAttachedLinks operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- listAttachedLinks
  default ListAttachedLinksResponse listAttachedLinks(Consumer<ListAttachedLinksRequest.Builder> listAttachedLinksRequest) throws InternalServiceException, MissingRequiredParameterException, InvalidParameterException, ResourceNotFoundException, AwsServiceException, SdkClientException, OamException
  
  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()
  
  Parameters:
  
  listAttachedLinksRequest - A Consumer that will call methods on ListAttachedLinksRequest.Builder to create a request.
  
  Returns:
  
  Result of the ListAttachedLinks operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- listAttachedLinksPaginator
  default ListAttachedLinksIterable listAttachedLinksPaginator(ListAttachedLinksRequest listAttachedLinksRequest) throws InternalServiceException, MissingRequiredParameterException, InvalidParameterException, ResourceNotFoundException, AwsServiceException, SdkClientException, OamException
  
  This is a variant of listAttachedLinks(software.amazon.awssdk.services.oam.model.ListAttachedLinksRequest) 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.oam.paginators.ListAttachedLinksIterable responses = client.listAttachedLinksPaginator(request); responses.stream().forEach(....);
  2) Using For loop
  { @code software.amazon.awssdk.services.oam.paginators.ListAttachedLinksIterable responses = client .listAttachedLinksPaginator(request); for (software.amazon.awssdk.services.oam.model.ListAttachedLinksResponse response : responses) { // do something; } }
  3) Use iterator directly
  software.amazon.awssdk.services.oam.paginators.ListAttachedLinksIterable responses = client.listAttachedLinksPaginator(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 listAttachedLinks(software.amazon.awssdk.services.oam.model.ListAttachedLinksRequest) operation.
  
  Parameters:
  
  listAttachedLinksRequest -
  
  Returns:
  
  A custom iterable that can be used to iterate through all the response pages.
  
  See Also:
  
  AWS API Documentation
- listAttachedLinksPaginator
  default ListAttachedLinksIterable listAttachedLinksPaginator(Consumer<ListAttachedLinksRequest.Builder> listAttachedLinksRequest) throws InternalServiceException, MissingRequiredParameterException, InvalidParameterException, ResourceNotFoundException, AwsServiceException, SdkClientException, OamException
  
  This is a variant of listAttachedLinks(software.amazon.awssdk.services.oam.model.ListAttachedLinksRequest) 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.oam.paginators.ListAttachedLinksIterable responses = client.listAttachedLinksPaginator(request); responses.stream().forEach(....);
  2) Using For loop
  { @code software.amazon.awssdk.services.oam.paginators.ListAttachedLinksIterable responses = client .listAttachedLinksPaginator(request); for (software.amazon.awssdk.services.oam.model.ListAttachedLinksResponse response : responses) { // do something; } }
  3) Use iterator directly
  software.amazon.awssdk.services.oam.paginators.ListAttachedLinksIterable responses = client.listAttachedLinksPaginator(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 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()
  
  Parameters:
  
  listAttachedLinksRequest - A Consumer that will call methods on ListAttachedLinksRequest.Builder to create a request.
  
  Returns:
  
  A custom iterable that can be used to iterate through all the response pages.
  
  See Also:
  
  AWS API Documentation
- listLinks
  default ListLinksResponse listLinks(ListLinksRequest listLinksRequest) throws InternalServiceException, InvalidParameterException, ResourceNotFoundException, AwsServiceException, SdkClientException, OamException
  
  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.
  
  Parameters:
  
  listLinksRequest -
  
  Returns:
  
  Result of the ListLinks operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- listLinks
  default ListLinksResponse listLinks(Consumer<ListLinksRequest.Builder> listLinksRequest) throws InternalServiceException, InvalidParameterException, ResourceNotFoundException, AwsServiceException, SdkClientException, OamException
  
  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()
  
  Parameters:
  
  listLinksRequest - A Consumer that will call methods on ListLinksRequest.Builder to create a request.
  
  Returns:
  
  Result of the ListLinks operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- listLinksPaginator
  default ListLinksIterable listLinksPaginator(ListLinksRequest listLinksRequest) throws InternalServiceException, InvalidParameterException, ResourceNotFoundException, AwsServiceException, SdkClientException, OamException
  
  This is a variant of listLinks(software.amazon.awssdk.services.oam.model.ListLinksRequest) 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.oam.paginators.ListLinksIterable responses = client.listLinksPaginator(request); responses.stream().forEach(....);
  2) Using For loop
  { @code software.amazon.awssdk.services.oam.paginators.ListLinksIterable responses = client.listLinksPaginator(request); for (software.amazon.awssdk.services.oam.model.ListLinksResponse response : responses) { // do something; } }
  3) Use iterator directly
  software.amazon.awssdk.services.oam.paginators.ListLinksIterable responses = client.listLinksPaginator(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 listLinks(software.amazon.awssdk.services.oam.model.ListLinksRequest) operation.
  
  Parameters:
  
  listLinksRequest -
  
  Returns:
  
  A custom iterable that can be used to iterate through all the response pages.
  
  See Also:
  
  AWS API Documentation
- listLinksPaginator
  default ListLinksIterable listLinksPaginator(Consumer<ListLinksRequest.Builder> listLinksRequest) throws InternalServiceException, InvalidParameterException, ResourceNotFoundException, AwsServiceException, SdkClientException, OamException
  
  This is a variant of listLinks(software.amazon.awssdk.services.oam.model.ListLinksRequest) 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.oam.paginators.ListLinksIterable responses = client.listLinksPaginator(request); responses.stream().forEach(....);
  2) Using For loop
  { @code software.amazon.awssdk.services.oam.paginators.ListLinksIterable responses = client.listLinksPaginator(request); for (software.amazon.awssdk.services.oam.model.ListLinksResponse response : responses) { // do something; } }
  3) Use iterator directly
  software.amazon.awssdk.services.oam.paginators.ListLinksIterable responses = client.listLinksPaginator(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 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()
  
  Parameters:
  
  listLinksRequest - A Consumer that will call methods on ListLinksRequest.Builder to create a request.
  
  Returns:
  
  A custom iterable that can be used to iterate through all the response pages.
  
  See Also:
  
  AWS API Documentation
- listSinks
  default ListSinksResponse listSinks(ListSinksRequest listSinksRequest) throws InternalServiceException, InvalidParameterException, ResourceNotFoundException, AwsServiceException, SdkClientException, OamException
  
  Use this operation in a monitoring account to return the list of sinks created in that account.
  
  Parameters:
  
  listSinksRequest -
  
  Returns:
  
  Result of the ListSinks operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- listSinks
  default ListSinksResponse listSinks(Consumer<ListSinksRequest.Builder> listSinksRequest) throws InternalServiceException, InvalidParameterException, ResourceNotFoundException, AwsServiceException, SdkClientException, OamException
  
  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()
  
  Parameters:
  
  listSinksRequest - A Consumer that will call methods on ListSinksRequest.Builder to create a request.
  
  Returns:
  
  Result of the ListSinks operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- listSinksPaginator
  default ListSinksIterable listSinksPaginator(ListSinksRequest listSinksRequest) throws InternalServiceException, InvalidParameterException, ResourceNotFoundException, AwsServiceException, SdkClientException, OamException
  
  This is a variant of listSinks(software.amazon.awssdk.services.oam.model.ListSinksRequest) 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.oam.paginators.ListSinksIterable responses = client.listSinksPaginator(request); responses.stream().forEach(....);
  2) Using For loop
  { @code software.amazon.awssdk.services.oam.paginators.ListSinksIterable responses = client.listSinksPaginator(request); for (software.amazon.awssdk.services.oam.model.ListSinksResponse response : responses) { // do something; } }
  3) Use iterator directly
  software.amazon.awssdk.services.oam.paginators.ListSinksIterable responses = client.listSinksPaginator(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 listSinks(software.amazon.awssdk.services.oam.model.ListSinksRequest) operation.
  
  Parameters:
  
  listSinksRequest -
  
  Returns:
  
  A custom iterable that can be used to iterate through all the response pages.
  
  See Also:
  
  AWS API Documentation
- listSinksPaginator
  default ListSinksIterable listSinksPaginator(Consumer<ListSinksRequest.Builder> listSinksRequest) throws InternalServiceException, InvalidParameterException, ResourceNotFoundException, AwsServiceException, SdkClientException, OamException
  
  This is a variant of listSinks(software.amazon.awssdk.services.oam.model.ListSinksRequest) 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.oam.paginators.ListSinksIterable responses = client.listSinksPaginator(request); responses.stream().forEach(....);
  2) Using For loop
  { @code software.amazon.awssdk.services.oam.paginators.ListSinksIterable responses = client.listSinksPaginator(request); for (software.amazon.awssdk.services.oam.model.ListSinksResponse response : responses) { // do something; } }
  3) Use iterator directly
  software.amazon.awssdk.services.oam.paginators.ListSinksIterable responses = client.listSinksPaginator(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 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()
  
  Parameters:
  
  listSinksRequest - A Consumer that will call methods on ListSinksRequest.Builder to create a request.
  
  Returns:
  
  A custom iterable that can be used to iterate through all the response pages.
  
  See Also:
  
  AWS API Documentation
- listTagsForResource
  default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OamException
  
  Displays the tags associated with a resource. Both sinks and links support tagging.
  
  Parameters:
  
  listTagsForResourceRequest -
  
  Returns:
  
  Result of the ListTagsForResource operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- listTagsForResource
  default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OamException
  
  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()
  
  Parameters:
  
  listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.
  
  Returns:
  
  Result of the ListTagsForResource operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- putSinkPolicy
  default PutSinkPolicyResponse putSinkPolicy(PutSinkPolicyRequest putSinkPolicyRequest) throws InternalServiceException, MissingRequiredParameterException, InvalidParameterException, ResourceNotFoundException, AwsServiceException, SdkClientException, OamException
  
  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 six types of services with their respective resource 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
  
  Application Insights - Applications - Specify with AWS::ApplicationInsights::Application
  
  Internet Monitor - Specify with AWS::InternetMonitor::Monitor
  
  Application Signals - Specify with AWS::ApplicationSignals::Service and AWS::ApplicationSignals::ServiceLevelObjective
  
  See the examples in this section to see how to specify permitted source accounts and data types.
  
  Parameters:
  
  putSinkPolicyRequest -
  
  Returns:
  
  Result of the PutSinkPolicy operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- putSinkPolicy
  default PutSinkPolicyResponse putSinkPolicy(Consumer<PutSinkPolicyRequest.Builder> putSinkPolicyRequest) throws InternalServiceException, MissingRequiredParameterException, InvalidParameterException, ResourceNotFoundException, AwsServiceException, SdkClientException, OamException
  
  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 six types of services with their respective resource 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
  
  Application Insights - Applications - Specify with AWS::ApplicationInsights::Application
  
  Internet Monitor - Specify with AWS::InternetMonitor::Monitor
  
  Application Signals - Specify with AWS::ApplicationSignals::Service and AWS::ApplicationSignals::ServiceLevelObjective
  
  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()
  
  Parameters:
  
  putSinkPolicyRequest - A Consumer that will call methods on PutSinkPolicyRequest.Builder to create a request.
  
  Returns:
  
  Result of the PutSinkPolicy operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- tagResource
  default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws ValidationException, TooManyTagsException, ResourceNotFoundException, AwsServiceException, SdkClientException, OamException
  
  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.
  
  Parameters:
  
  tagResourceRequest -
  
  Returns:
  
  Result of the TagResource operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- tagResource
  default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws ValidationException, TooManyTagsException, ResourceNotFoundException, AwsServiceException, SdkClientException, OamException
  
  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()
  
  Parameters:
  
  tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.
  
  Returns:
  
  Result of the TagResource operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- untagResource
  default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OamException
  
  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.
  
  Parameters:
  
  untagResourceRequest -
  
  Returns:
  
  Result of the UntagResource operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- untagResource
  default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, OamException
  
  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()
  
  Parameters:
  
  untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.
  
  Returns:
  
  Result of the UntagResource operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- updateLink
  default UpdateLinkResponse updateLink(UpdateLinkRequest updateLinkRequest) throws InternalServiceException, MissingRequiredParameterException, InvalidParameterException, ResourceNotFoundException, AwsServiceException, SdkClientException, OamException
  
  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.
  
  When you update a link, you can optionally specify filters that specify which metric namespaces and which log groups are shared from the source account to the monitoring account.
  
  To update the list of tags associated with the sink, use TagResource.
  
  Parameters:
  
  updateLinkRequest -
  
  Returns:
  
  Result of the UpdateLink operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- updateLink
  default UpdateLinkResponse updateLink(Consumer<UpdateLinkRequest.Builder> updateLinkRequest) throws InternalServiceException, MissingRequiredParameterException, InvalidParameterException, ResourceNotFoundException, AwsServiceException, SdkClientException, OamException
  
  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.
  
  When you update a link, you can optionally specify filters that specify which metric namespaces and which log groups are shared from the source account to the monitoring account.
  
  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()
  
  Parameters:
  
  updateLinkRequest - A Consumer that will call methods on UpdateLinkRequest.Builder to create a request.
  
  Returns:
  
  Result of the UpdateLink operation returned by the service.
  
  See Also:
  
  AWS API Documentation
- create
  
  static OamClient create()
  
  Create a OamClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
- builder
  
  static OamClientBuilder builder()
  
  Create a builder that can be used to configure and create a OamClient.
- serviceMetadata
  
  static ServiceMetadata serviceMetadata()
- serviceClientConfiguration
  
  default OamServiceClientConfiguration serviceClientConfiguration()
  
  Description copied from interface: SdkClient
  
  The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
  
  Specified by:
  
  serviceClientConfiguration in interface AwsClient
  
  Specified by:
  
  serviceClientConfiguration in interface SdkClient
  
  Returns:
  
  SdkServiceClientConfiguration

Interface OamClient

Field Summary

Method Summary

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

Methods inherited from interface software.amazon.awssdk.core.SdkClient

Field Details

SERVICE_NAME

SERVICE_METADATA_ID

Method Details

createLink

createLink

createSink

createSink

deleteLink

deleteLink

deleteSink

deleteSink

getLink

getLink

getSink

getSink

getSinkPolicy

getSinkPolicy

listAttachedLinks

listAttachedLinks

listAttachedLinksPaginator

listAttachedLinksPaginator

listLinks

listLinks

listLinksPaginator

listLinksPaginator

listSinks

listSinks

listSinksPaginator

listSinksPaginator

listTagsForResource

listTagsForResource

putSinkPolicy

putSinkPolicy

tagResource

tagResource

untagResource

untagResource

updateLink

updateLink

create

builder

serviceMetadata

serviceClientConfiguration