Interface ObservabilityAdminAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.The asynchronous client performs non-blocking I/O when configured with any
SdkAsyncHttpClient
supported in the SDK. However, full non-blocking is not guaranteed as the async client may
perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API
call.
Amazon CloudWatch Obsersavability Admin to control temletry config for your AWS Organization or account. Telemetry config config to discover and understand the state of telemetry configuration for your AWS resources from a central view in the CloudWatch console. Telemetry config simplifies the process of auditing your telemetry collection configurations across multiple resource types across your AWS Organization or account. For more information, see Auditing CloudWatch telemetry configurations in the CloudWatch User Guide.
For information on the permissions you need to use this API, see Identity and access management for Amazon CloudWatch in the CloudWatch User Guide.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
Create a builder that can be used to configure and create aObservabilityAdminAsyncClient
.create()
Create aObservabilityAdminAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.getTelemetryEvaluationStatus
(Consumer<GetTelemetryEvaluationStatusRequest.Builder> getTelemetryEvaluationStatusRequest) Returns the current onboarding status of the telemetry config feature, including the status of the feature and reason the feature failed to start or stop.getTelemetryEvaluationStatus
(GetTelemetryEvaluationStatusRequest getTelemetryEvaluationStatusRequest) Returns the current onboarding status of the telemetry config feature, including the status of the feature and reason the feature failed to start or stop.getTelemetryEvaluationStatusForOrganization
(Consumer<GetTelemetryEvaluationStatusForOrganizationRequest.Builder> getTelemetryEvaluationStatusForOrganizationRequest) This returns the onboarding status of the telemetry configuration feature for the organization.getTelemetryEvaluationStatusForOrganization
(GetTelemetryEvaluationStatusForOrganizationRequest getTelemetryEvaluationStatusForOrganizationRequest) This returns the onboarding status of the telemetry configuration feature for the organization.listResourceTelemetry
(Consumer<ListResourceTelemetryRequest.Builder> listResourceTelemetryRequest) Returns a list of telemetry configurations for AWS resources supported by telemetry config.listResourceTelemetry
(ListResourceTelemetryRequest listResourceTelemetryRequest) Returns a list of telemetry configurations for AWS resources supported by telemetry config.listResourceTelemetryForOrganization
(Consumer<ListResourceTelemetryForOrganizationRequest.Builder> listResourceTelemetryForOrganizationRequest) Returns a list of telemetry configurations for AWS resources supported by telemetry config in the organization.listResourceTelemetryForOrganization
(ListResourceTelemetryForOrganizationRequest listResourceTelemetryForOrganizationRequest) Returns a list of telemetry configurations for AWS resources supported by telemetry config in the organization.listResourceTelemetryForOrganizationPaginator
(Consumer<ListResourceTelemetryForOrganizationRequest.Builder> listResourceTelemetryForOrganizationRequest) listResourceTelemetryForOrganizationPaginator
(ListResourceTelemetryForOrganizationRequest listResourceTelemetryForOrganizationRequest) default ListResourceTelemetryPublisher
listResourceTelemetryPaginator
(Consumer<ListResourceTelemetryRequest.Builder> listResourceTelemetryRequest) This is a variant oflistResourceTelemetry(software.amazon.awssdk.services.observabilityadmin.model.ListResourceTelemetryRequest)
operation.default ListResourceTelemetryPublisher
listResourceTelemetryPaginator
(ListResourceTelemetryRequest listResourceTelemetryRequest) This is a variant oflistResourceTelemetry(software.amazon.awssdk.services.observabilityadmin.model.ListResourceTelemetryRequest)
operation.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstartTelemetryEvaluation
(Consumer<StartTelemetryEvaluationRequest.Builder> startTelemetryEvaluationRequest) This action begins onboarding onboarding the caller AWS account to the telemetry config feature.startTelemetryEvaluation
(StartTelemetryEvaluationRequest startTelemetryEvaluationRequest) This action begins onboarding onboarding the caller AWS account to the telemetry config feature.startTelemetryEvaluationForOrganization
(Consumer<StartTelemetryEvaluationForOrganizationRequest.Builder> startTelemetryEvaluationForOrganizationRequest) This actions begins onboarding the organization and all member accounts to the telemetry config feature.startTelemetryEvaluationForOrganization
(StartTelemetryEvaluationForOrganizationRequest startTelemetryEvaluationForOrganizationRequest) This actions begins onboarding the organization and all member accounts to the telemetry config feature.stopTelemetryEvaluation
(Consumer<StopTelemetryEvaluationRequest.Builder> stopTelemetryEvaluationRequest) This action begins offboarding the caller AWS account from the telemetry config feature.stopTelemetryEvaluation
(StopTelemetryEvaluationRequest stopTelemetryEvaluationRequest) This action begins offboarding the caller AWS account from the telemetry config feature.stopTelemetryEvaluationForOrganization
(Consumer<StopTelemetryEvaluationForOrganizationRequest.Builder> stopTelemetryEvaluationForOrganizationRequest) This action offboards the Organization of the caller AWS account from thef telemetry config feature.stopTelemetryEvaluationForOrganization
(StopTelemetryEvaluationForOrganizationRequest stopTelemetryEvaluationForOrganizationRequest) This action offboards the Organization of the caller AWS account from thef telemetry config feature.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
getTelemetryEvaluationStatus
default CompletableFuture<GetTelemetryEvaluationStatusResponse> getTelemetryEvaluationStatus(GetTelemetryEvaluationStatusRequest getTelemetryEvaluationStatusRequest) Returns the current onboarding status of the telemetry config feature, including the status of the feature and reason the feature failed to start or stop.
- Parameters:
getTelemetryEvaluationStatusRequest
-- Returns:
- A Java Future containing the result of the GetTelemetryEvaluationStatus operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException Indicates you don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access management for AWS resources in the IAM user guide.
- InternalServerException Indicates the request has failed to process because of an unknown server error, exception, or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ObservabilityAdminException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getTelemetryEvaluationStatus
default CompletableFuture<GetTelemetryEvaluationStatusResponse> getTelemetryEvaluationStatus(Consumer<GetTelemetryEvaluationStatusRequest.Builder> getTelemetryEvaluationStatusRequest) Returns the current onboarding status of the telemetry config feature, including the status of the feature and reason the feature failed to start or stop.
This is a convenience which creates an instance of the
GetTelemetryEvaluationStatusRequest.Builder
avoiding the need to create one manually viaGetTelemetryEvaluationStatusRequest.builder()
- Parameters:
getTelemetryEvaluationStatusRequest
- AConsumer
that will call methods onGetTelemetryEvaluationStatusRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetTelemetryEvaluationStatus operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException Indicates you don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access management for AWS resources in the IAM user guide.
- InternalServerException Indicates the request has failed to process because of an unknown server error, exception, or failure.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ObservabilityAdminException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getTelemetryEvaluationStatusForOrganization
default CompletableFuture<GetTelemetryEvaluationStatusForOrganizationResponse> getTelemetryEvaluationStatusForOrganization(GetTelemetryEvaluationStatusForOrganizationRequest getTelemetryEvaluationStatusForOrganizationRequest) This returns the onboarding status of the telemetry configuration feature for the organization. It can only be called by a Management Account of an AWS Organization or an assigned Delegated Admin Account of AWS CloudWatch telemetry config.
- Parameters:
getTelemetryEvaluationStatusForOrganizationRequest
-- Returns:
- A Java Future containing the result of the GetTelemetryEvaluationStatusForOrganization operation returned
by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException Indicates you don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access management for AWS resources in the IAM user guide.
- InternalServerException Indicates the request has failed to process because of an unknown server error, exception, or failure.
- ValidationException Indicates input validation failed. Check your request parameters and retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ObservabilityAdminException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getTelemetryEvaluationStatusForOrganization
default CompletableFuture<GetTelemetryEvaluationStatusForOrganizationResponse> getTelemetryEvaluationStatusForOrganization(Consumer<GetTelemetryEvaluationStatusForOrganizationRequest.Builder> getTelemetryEvaluationStatusForOrganizationRequest) This returns the onboarding status of the telemetry configuration feature for the organization. It can only be called by a Management Account of an AWS Organization or an assigned Delegated Admin Account of AWS CloudWatch telemetry config.
This is a convenience which creates an instance of the
GetTelemetryEvaluationStatusForOrganizationRequest.Builder
avoiding the need to create one manually viaGetTelemetryEvaluationStatusForOrganizationRequest.builder()
- Parameters:
getTelemetryEvaluationStatusForOrganizationRequest
- AConsumer
that will call methods onGetTelemetryEvaluationStatusForOrganizationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetTelemetryEvaluationStatusForOrganization operation returned
by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException Indicates you don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access management for AWS resources in the IAM user guide.
- InternalServerException Indicates the request has failed to process because of an unknown server error, exception, or failure.
- ValidationException Indicates input validation failed. Check your request parameters and retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ObservabilityAdminException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listResourceTelemetry
default CompletableFuture<ListResourceTelemetryResponse> listResourceTelemetry(ListResourceTelemetryRequest listResourceTelemetryRequest) Returns a list of telemetry configurations for AWS resources supported by telemetry config. For more information, see Auditing CloudWatch telemetry configurations.
- Parameters:
listResourceTelemetryRequest
-- Returns:
- A Java Future containing the result of the ListResourceTelemetry operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException Indicates you don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access management for AWS resources in the IAM user guide.
- InternalServerException Indicates the request has failed to process because of an unknown server error, exception, or failure.
- ValidationException Indicates input validation failed. Check your request parameters and retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ObservabilityAdminException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listResourceTelemetry
default CompletableFuture<ListResourceTelemetryResponse> listResourceTelemetry(Consumer<ListResourceTelemetryRequest.Builder> listResourceTelemetryRequest) Returns a list of telemetry configurations for AWS resources supported by telemetry config. For more information, see Auditing CloudWatch telemetry configurations.
This is a convenience which creates an instance of the
ListResourceTelemetryRequest.Builder
avoiding the need to create one manually viaListResourceTelemetryRequest.builder()
- Parameters:
listResourceTelemetryRequest
- AConsumer
that will call methods onListResourceTelemetryRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListResourceTelemetry operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException Indicates you don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access management for AWS resources in the IAM user guide.
- InternalServerException Indicates the request has failed to process because of an unknown server error, exception, or failure.
- ValidationException Indicates input validation failed. Check your request parameters and retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ObservabilityAdminException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listResourceTelemetryForOrganization
default CompletableFuture<ListResourceTelemetryForOrganizationResponse> listResourceTelemetryForOrganization(ListResourceTelemetryForOrganizationRequest listResourceTelemetryForOrganizationRequest) Returns a list of telemetry configurations for AWS resources supported by telemetry config in the organization.
- Parameters:
listResourceTelemetryForOrganizationRequest
-- Returns:
- A Java Future containing the result of the ListResourceTelemetryForOrganization operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException Indicates you don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access management for AWS resources in the IAM user guide.
- InternalServerException Indicates the request has failed to process because of an unknown server error, exception, or failure.
- ValidationException Indicates input validation failed. Check your request parameters and retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ObservabilityAdminException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listResourceTelemetryForOrganization
default CompletableFuture<ListResourceTelemetryForOrganizationResponse> listResourceTelemetryForOrganization(Consumer<ListResourceTelemetryForOrganizationRequest.Builder> listResourceTelemetryForOrganizationRequest) Returns a list of telemetry configurations for AWS resources supported by telemetry config in the organization.
This is a convenience which creates an instance of the
ListResourceTelemetryForOrganizationRequest.Builder
avoiding the need to create one manually viaListResourceTelemetryForOrganizationRequest.builder()
- Parameters:
listResourceTelemetryForOrganizationRequest
- AConsumer
that will call methods onListResourceTelemetryForOrganizationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListResourceTelemetryForOrganization operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException Indicates you don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access management for AWS resources in the IAM user guide.
- InternalServerException Indicates the request has failed to process because of an unknown server error, exception, or failure.
- ValidationException Indicates input validation failed. Check your request parameters and retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ObservabilityAdminException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listResourceTelemetryForOrganizationPaginator
default ListResourceTelemetryForOrganizationPublisher listResourceTelemetryForOrganizationPaginator(ListResourceTelemetryForOrganizationRequest listResourceTelemetryForOrganizationRequest) This is a variant of
listResourceTelemetryForOrganization(software.amazon.awssdk.services.observabilityadmin.model.ListResourceTelemetryForOrganizationRequest)
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 newSubscription
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 methodsoftware.amazon.awssdk.services.observabilityadmin.paginators.ListResourceTelemetryForOrganizationPublisher publisher = client.listResourceTelemetryForOrganizationPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.observabilityadmin.paginators.ListResourceTelemetryForOrganizationPublisher publisher = client.listResourceTelemetryForOrganizationPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.observabilityadmin.model.ListResourceTelemetryForOrganizationResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.observabilityadmin.model.ListResourceTelemetryForOrganizationResponse response) { //... }; });
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
listResourceTelemetryForOrganization(software.amazon.awssdk.services.observabilityadmin.model.ListResourceTelemetryForOrganizationRequest)
operation.- Parameters:
listResourceTelemetryForOrganizationRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException Indicates you don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access management for AWS resources in the IAM user guide.
- InternalServerException Indicates the request has failed to process because of an unknown server error, exception, or failure.
- ValidationException Indicates input validation failed. Check your request parameters and retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ObservabilityAdminException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listResourceTelemetryForOrganizationPaginator
default ListResourceTelemetryForOrganizationPublisher listResourceTelemetryForOrganizationPaginator(Consumer<ListResourceTelemetryForOrganizationRequest.Builder> listResourceTelemetryForOrganizationRequest) This is a variant of
listResourceTelemetryForOrganization(software.amazon.awssdk.services.observabilityadmin.model.ListResourceTelemetryForOrganizationRequest)
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 newSubscription
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 methodsoftware.amazon.awssdk.services.observabilityadmin.paginators.ListResourceTelemetryForOrganizationPublisher publisher = client.listResourceTelemetryForOrganizationPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.observabilityadmin.paginators.ListResourceTelemetryForOrganizationPublisher publisher = client.listResourceTelemetryForOrganizationPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.observabilityadmin.model.ListResourceTelemetryForOrganizationResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.observabilityadmin.model.ListResourceTelemetryForOrganizationResponse response) { //... }; });
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
listResourceTelemetryForOrganization(software.amazon.awssdk.services.observabilityadmin.model.ListResourceTelemetryForOrganizationRequest)
operation.
This is a convenience which creates an instance of the
ListResourceTelemetryForOrganizationRequest.Builder
avoiding the need to create one manually viaListResourceTelemetryForOrganizationRequest.builder()
- Parameters:
listResourceTelemetryForOrganizationRequest
- AConsumer
that will call methods onListResourceTelemetryForOrganizationRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException Indicates you don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access management for AWS resources in the IAM user guide.
- InternalServerException Indicates the request has failed to process because of an unknown server error, exception, or failure.
- ValidationException Indicates input validation failed. Check your request parameters and retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ObservabilityAdminException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listResourceTelemetryPaginator
default ListResourceTelemetryPublisher listResourceTelemetryPaginator(ListResourceTelemetryRequest listResourceTelemetryRequest) This is a variant of
listResourceTelemetry(software.amazon.awssdk.services.observabilityadmin.model.ListResourceTelemetryRequest)
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 newSubscription
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 methodsoftware.amazon.awssdk.services.observabilityadmin.paginators.ListResourceTelemetryPublisher publisher = client.listResourceTelemetryPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.observabilityadmin.paginators.ListResourceTelemetryPublisher publisher = client.listResourceTelemetryPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.observabilityadmin.model.ListResourceTelemetryResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.observabilityadmin.model.ListResourceTelemetryResponse response) { //... }; });
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
listResourceTelemetry(software.amazon.awssdk.services.observabilityadmin.model.ListResourceTelemetryRequest)
operation.- Parameters:
listResourceTelemetryRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException Indicates you don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access management for AWS resources in the IAM user guide.
- InternalServerException Indicates the request has failed to process because of an unknown server error, exception, or failure.
- ValidationException Indicates input validation failed. Check your request parameters and retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ObservabilityAdminException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listResourceTelemetryPaginator
default ListResourceTelemetryPublisher listResourceTelemetryPaginator(Consumer<ListResourceTelemetryRequest.Builder> listResourceTelemetryRequest) This is a variant of
listResourceTelemetry(software.amazon.awssdk.services.observabilityadmin.model.ListResourceTelemetryRequest)
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 newSubscription
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 methodsoftware.amazon.awssdk.services.observabilityadmin.paginators.ListResourceTelemetryPublisher publisher = client.listResourceTelemetryPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.observabilityadmin.paginators.ListResourceTelemetryPublisher publisher = client.listResourceTelemetryPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.observabilityadmin.model.ListResourceTelemetryResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.observabilityadmin.model.ListResourceTelemetryResponse response) { //... }; });
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
listResourceTelemetry(software.amazon.awssdk.services.observabilityadmin.model.ListResourceTelemetryRequest)
operation.
This is a convenience which creates an instance of the
ListResourceTelemetryRequest.Builder
avoiding the need to create one manually viaListResourceTelemetryRequest.builder()
- Parameters:
listResourceTelemetryRequest
- AConsumer
that will call methods onListResourceTelemetryRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException Indicates you don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access management for AWS resources in the IAM user guide.
- InternalServerException Indicates the request has failed to process because of an unknown server error, exception, or failure.
- ValidationException Indicates input validation failed. Check your request parameters and retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ObservabilityAdminException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startTelemetryEvaluation
default CompletableFuture<StartTelemetryEvaluationResponse> startTelemetryEvaluation(StartTelemetryEvaluationRequest startTelemetryEvaluationRequest) This action begins onboarding onboarding the caller AWS account to the telemetry config feature.
- Parameters:
startTelemetryEvaluationRequest
-- Returns:
- A Java Future containing the result of the StartTelemetryEvaluation operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException Indicates you don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access management for AWS resources in the IAM user guide.
- InternalServerException Indicates the request has failed to process because of an unknown server error, exception, or failure.
- ValidationException Indicates input validation failed. Check your request parameters and retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ObservabilityAdminException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startTelemetryEvaluation
default CompletableFuture<StartTelemetryEvaluationResponse> startTelemetryEvaluation(Consumer<StartTelemetryEvaluationRequest.Builder> startTelemetryEvaluationRequest) This action begins onboarding onboarding the caller AWS account to the telemetry config feature.
This is a convenience which creates an instance of the
StartTelemetryEvaluationRequest.Builder
avoiding the need to create one manually viaStartTelemetryEvaluationRequest.builder()
- Parameters:
startTelemetryEvaluationRequest
- AConsumer
that will call methods onStartTelemetryEvaluationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StartTelemetryEvaluation operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException Indicates you don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access management for AWS resources in the IAM user guide.
- InternalServerException Indicates the request has failed to process because of an unknown server error, exception, or failure.
- ValidationException Indicates input validation failed. Check your request parameters and retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ObservabilityAdminException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startTelemetryEvaluationForOrganization
default CompletableFuture<StartTelemetryEvaluationForOrganizationResponse> startTelemetryEvaluationForOrganization(StartTelemetryEvaluationForOrganizationRequest startTelemetryEvaluationForOrganizationRequest) This actions begins onboarding the organization and all member accounts to the telemetry config feature.
- Parameters:
startTelemetryEvaluationForOrganizationRequest
-- Returns:
- A Java Future containing the result of the StartTelemetryEvaluationForOrganization operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException Indicates you don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access management for AWS resources in the IAM user guide.
- InternalServerException Indicates the request has failed to process because of an unknown server error, exception, or failure.
- ValidationException Indicates input validation failed. Check your request parameters and retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ObservabilityAdminException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startTelemetryEvaluationForOrganization
default CompletableFuture<StartTelemetryEvaluationForOrganizationResponse> startTelemetryEvaluationForOrganization(Consumer<StartTelemetryEvaluationForOrganizationRequest.Builder> startTelemetryEvaluationForOrganizationRequest) This actions begins onboarding the organization and all member accounts to the telemetry config feature.
This is a convenience which creates an instance of the
StartTelemetryEvaluationForOrganizationRequest.Builder
avoiding the need to create one manually viaStartTelemetryEvaluationForOrganizationRequest.builder()
- Parameters:
startTelemetryEvaluationForOrganizationRequest
- AConsumer
that will call methods onStartTelemetryEvaluationForOrganizationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StartTelemetryEvaluationForOrganization operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException Indicates you don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access management for AWS resources in the IAM user guide.
- InternalServerException Indicates the request has failed to process because of an unknown server error, exception, or failure.
- ValidationException Indicates input validation failed. Check your request parameters and retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ObservabilityAdminException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
stopTelemetryEvaluation
default CompletableFuture<StopTelemetryEvaluationResponse> stopTelemetryEvaluation(StopTelemetryEvaluationRequest stopTelemetryEvaluationRequest) This action begins offboarding the caller AWS account from the telemetry config feature.
- Parameters:
stopTelemetryEvaluationRequest
-- Returns:
- A Java Future containing the result of the StopTelemetryEvaluation operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException Indicates you don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access management for AWS resources in the IAM user guide.
- InternalServerException Indicates the request has failed to process because of an unknown server error, exception, or failure.
- ValidationException Indicates input validation failed. Check your request parameters and retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ObservabilityAdminException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
stopTelemetryEvaluation
default CompletableFuture<StopTelemetryEvaluationResponse> stopTelemetryEvaluation(Consumer<StopTelemetryEvaluationRequest.Builder> stopTelemetryEvaluationRequest) This action begins offboarding the caller AWS account from the telemetry config feature.
This is a convenience which creates an instance of the
StopTelemetryEvaluationRequest.Builder
avoiding the need to create one manually viaStopTelemetryEvaluationRequest.builder()
- Parameters:
stopTelemetryEvaluationRequest
- AConsumer
that will call methods onStopTelemetryEvaluationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StopTelemetryEvaluation operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException Indicates you don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access management for AWS resources in the IAM user guide.
- InternalServerException Indicates the request has failed to process because of an unknown server error, exception, or failure.
- ValidationException Indicates input validation failed. Check your request parameters and retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ObservabilityAdminException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
stopTelemetryEvaluationForOrganization
default CompletableFuture<StopTelemetryEvaluationForOrganizationResponse> stopTelemetryEvaluationForOrganization(StopTelemetryEvaluationForOrganizationRequest stopTelemetryEvaluationForOrganizationRequest) This action offboards the Organization of the caller AWS account from thef telemetry config feature.
- Parameters:
stopTelemetryEvaluationForOrganizationRequest
-- Returns:
- A Java Future containing the result of the StopTelemetryEvaluationForOrganization operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException Indicates you don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access management for AWS resources in the IAM user guide.
- InternalServerException Indicates the request has failed to process because of an unknown server error, exception, or failure.
- ValidationException Indicates input validation failed. Check your request parameters and retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ObservabilityAdminException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
stopTelemetryEvaluationForOrganization
default CompletableFuture<StopTelemetryEvaluationForOrganizationResponse> stopTelemetryEvaluationForOrganization(Consumer<StopTelemetryEvaluationForOrganizationRequest.Builder> stopTelemetryEvaluationForOrganizationRequest) This action offboards the Organization of the caller AWS account from thef telemetry config feature.
This is a convenience which creates an instance of the
StopTelemetryEvaluationForOrganizationRequest.Builder
avoiding the need to create one manually viaStopTelemetryEvaluationForOrganizationRequest.builder()
- Parameters:
stopTelemetryEvaluationForOrganizationRequest
- AConsumer
that will call methods onStopTelemetryEvaluationForOrganizationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StopTelemetryEvaluationForOrganization operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException Indicates you don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access management for AWS resources in the IAM user guide.
- InternalServerException Indicates the request has failed to process because of an unknown server error, exception, or failure.
- ValidationException Indicates input validation failed. Check your request parameters and retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ObservabilityAdminException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aObservabilityAdminAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aObservabilityAdminAsyncClient
.
-