Package software.amazon.awssdk.services.observabilityadmin

Interface ObservabilityAdminClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

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

Service client for accessing CloudWatch Observability Admin Service. This can be created using the static builder() method.

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

Fields

Modifier and Type	Field	Description
static String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
static ObservabilityAdminClientBuilder	builder()	Create a builder that can be used to configure and create a ObservabilityAdminClient.
static ObservabilityAdminClient	create()	Create a ObservabilityAdminClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default 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.
default 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.
default GetTelemetryEvaluationStatusForOrganizationResponse	getTelemetryEvaluationStatusForOrganization(Consumer<GetTelemetryEvaluationStatusForOrganizationRequest.Builder> getTelemetryEvaluationStatusForOrganizationRequest)	This returns the onboarding status of the telemetry configuration feature for the organization.
default GetTelemetryEvaluationStatusForOrganizationResponse	getTelemetryEvaluationStatusForOrganization(GetTelemetryEvaluationStatusForOrganizationRequest getTelemetryEvaluationStatusForOrganizationRequest)	This returns the onboarding status of the telemetry configuration feature for the organization.
default ListResourceTelemetryResponse	listResourceTelemetry(Consumer<ListResourceTelemetryRequest.Builder> listResourceTelemetryRequest)	Returns a list of telemetry configurations for AWS resources supported by telemetry config.
default ListResourceTelemetryResponse	listResourceTelemetry(ListResourceTelemetryRequest listResourceTelemetryRequest)	Returns a list of telemetry configurations for AWS resources supported by telemetry config.
default ListResourceTelemetryForOrganizationResponse	listResourceTelemetryForOrganization(Consumer<ListResourceTelemetryForOrganizationRequest.Builder> listResourceTelemetryForOrganizationRequest)	Returns a list of telemetry configurations for AWS resources supported by telemetry config in the organization.
default ListResourceTelemetryForOrganizationResponse	listResourceTelemetryForOrganization(ListResourceTelemetryForOrganizationRequest listResourceTelemetryForOrganizationRequest)	Returns a list of telemetry configurations for AWS resources supported by telemetry config in the organization.
default ListResourceTelemetryForOrganizationIterable	listResourceTelemetryForOrganizationPaginator(Consumer<ListResourceTelemetryForOrganizationRequest.Builder> listResourceTelemetryForOrganizationRequest)	This is a variant of listResourceTelemetryForOrganization(software.amazon.awssdk.services.observabilityadmin.model.ListResourceTelemetryForOrganizationRequest) operation.
default ListResourceTelemetryForOrganizationIterable	listResourceTelemetryForOrganizationPaginator(ListResourceTelemetryForOrganizationRequest listResourceTelemetryForOrganizationRequest)	This is a variant of listResourceTelemetryForOrganization(software.amazon.awssdk.services.observabilityadmin.model.ListResourceTelemetryForOrganizationRequest) operation.
default ListResourceTelemetryIterable	listResourceTelemetryPaginator(Consumer<ListResourceTelemetryRequest.Builder> listResourceTelemetryRequest)	This is a variant of listResourceTelemetry(software.amazon.awssdk.services.observabilityadmin.model.ListResourceTelemetryRequest) operation.
default ListResourceTelemetryIterable	listResourceTelemetryPaginator(ListResourceTelemetryRequest listResourceTelemetryRequest)	This is a variant of listResourceTelemetry(software.amazon.awssdk.services.observabilityadmin.model.ListResourceTelemetryRequest) operation.
default ObservabilityAdminServiceClientConfiguration	serviceClientConfiguration()
static ServiceMetadata	serviceMetadata()
default StartTelemetryEvaluationResponse	startTelemetryEvaluation(Consumer<StartTelemetryEvaluationRequest.Builder> startTelemetryEvaluationRequest)	This action begins onboarding onboarding the caller AWS account to the telemetry config feature.
default StartTelemetryEvaluationResponse	startTelemetryEvaluation(StartTelemetryEvaluationRequest startTelemetryEvaluationRequest)	This action begins onboarding onboarding the caller AWS account to the telemetry config feature.
default StartTelemetryEvaluationForOrganizationResponse	startTelemetryEvaluationForOrganization(Consumer<StartTelemetryEvaluationForOrganizationRequest.Builder> startTelemetryEvaluationForOrganizationRequest)	This actions begins onboarding the organization and all member accounts to the telemetry config feature.
default StartTelemetryEvaluationForOrganizationResponse	startTelemetryEvaluationForOrganization(StartTelemetryEvaluationForOrganizationRequest startTelemetryEvaluationForOrganizationRequest)	This actions begins onboarding the organization and all member accounts to the telemetry config feature.
default StopTelemetryEvaluationResponse	stopTelemetryEvaluation(Consumer<StopTelemetryEvaluationRequest.Builder> stopTelemetryEvaluationRequest)	This action begins offboarding the caller AWS account from the telemetry config feature.
default StopTelemetryEvaluationResponse	stopTelemetryEvaluation(StopTelemetryEvaluationRequest stopTelemetryEvaluationRequest)	This action begins offboarding the caller AWS account from the telemetry config feature.
default StopTelemetryEvaluationForOrganizationResponse	stopTelemetryEvaluationForOrganization(Consumer<StopTelemetryEvaluationForOrganizationRequest.Builder> stopTelemetryEvaluationForOrganizationRequest)	This action offboards the Organization of the caller AWS account from thef telemetry config feature.
default StopTelemetryEvaluationForOrganizationResponse	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 Detail

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 Detail

getTelemetryEvaluationStatus

default GetTelemetryEvaluationStatusResponse getTelemetryEvaluationStatus(GetTelemetryEvaluationStatusRequest getTelemetryEvaluationStatusRequest)
                                                                   throws AccessDeniedException,
                                                                          InternalServerException,
                                                                          AwsServiceException,
                                                                          SdkClientException,
                                                                          ObservabilityAdminException

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:

Result of the GetTelemetryEvaluationStatus operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

getTelemetryEvaluationStatus

default GetTelemetryEvaluationStatusResponse getTelemetryEvaluationStatus(Consumer<GetTelemetryEvaluationStatusRequest.Builder> getTelemetryEvaluationStatusRequest)
                                                                   throws AccessDeniedException,
                                                                          InternalServerException,
                                                                          AwsServiceException,
                                                                          SdkClientException,
                                                                          ObservabilityAdminException

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 via GetTelemetryEvaluationStatusRequest.builder()

Parameters:

getTelemetryEvaluationStatusRequest - A Consumer that will call methods on GetTelemetryEvaluationStatusRequest.Builder to create a request.

Returns:

Result of the GetTelemetryEvaluationStatus operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

getTelemetryEvaluationStatusForOrganization

default GetTelemetryEvaluationStatusForOrganizationResponse getTelemetryEvaluationStatusForOrganization(GetTelemetryEvaluationStatusForOrganizationRequest getTelemetryEvaluationStatusForOrganizationRequest)
                                                                                                 throws AccessDeniedException,
                                                                                                        InternalServerException,
                                                                                                        ValidationException,
                                                                                                        AwsServiceException,
                                                                                                        SdkClientException,
                                                                                                        ObservabilityAdminException

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:

Result of the GetTelemetryEvaluationStatusForOrganization operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

getTelemetryEvaluationStatusForOrganization

default GetTelemetryEvaluationStatusForOrganizationResponse getTelemetryEvaluationStatusForOrganization(Consumer<GetTelemetryEvaluationStatusForOrganizationRequest.Builder> getTelemetryEvaluationStatusForOrganizationRequest)
                                                                                                 throws AccessDeniedException,
                                                                                                        InternalServerException,
                                                                                                        ValidationException,
                                                                                                        AwsServiceException,
                                                                                                        SdkClientException,
                                                                                                        ObservabilityAdminException

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 via GetTelemetryEvaluationStatusForOrganizationRequest.builder()

Parameters:

getTelemetryEvaluationStatusForOrganizationRequest - A Consumer that will call methods on GetTelemetryEvaluationStatusForOrganizationRequest.Builder to create a request.

Returns:

Result of the GetTelemetryEvaluationStatusForOrganization operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

listResourceTelemetry

default ListResourceTelemetryResponse listResourceTelemetry(ListResourceTelemetryRequest listResourceTelemetryRequest)
                                                     throws AccessDeniedException,
                                                            InternalServerException,
                                                            ValidationException,
                                                            AwsServiceException,
                                                            SdkClientException,
                                                            ObservabilityAdminException

Returns a list of telemetry configurations for AWS resources supported by telemetry config. For more information, see Auditing CloudWatch telemetry configurations.

Parameters:

listResourceTelemetryRequest -

Returns:

Result of the ListResourceTelemetry operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

listResourceTelemetry

default ListResourceTelemetryResponse listResourceTelemetry(Consumer<ListResourceTelemetryRequest.Builder> listResourceTelemetryRequest)
                                                     throws AccessDeniedException,
                                                            InternalServerException,
                                                            ValidationException,
                                                            AwsServiceException,
                                                            SdkClientException,
                                                            ObservabilityAdminException

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 via ListResourceTelemetryRequest.builder()

Parameters:

listResourceTelemetryRequest - A Consumer that will call methods on ListResourceTelemetryRequest.Builder to create a request.

Returns:

Result of the ListResourceTelemetry operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

listResourceTelemetryPaginator

default ListResourceTelemetryIterable listResourceTelemetryPaginator(ListResourceTelemetryRequest listResourceTelemetryRequest)
                                                              throws AccessDeniedException,
                                                                     InternalServerException,
                                                                     ValidationException,
                                                                     AwsServiceException,
                                                                     SdkClientException,
                                                                     ObservabilityAdminException

This is a variant of listResourceTelemetry(software.amazon.awssdk.services.observabilityadmin.model.ListResourceTelemetryRequest) 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.observabilityadmin.paginators.ListResourceTelemetryIterable responses = client.listResourceTelemetryPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.observabilityadmin.paginators.ListResourceTelemetryIterable responses = client
             .listResourceTelemetryPaginator(request);
     for (software.amazon.awssdk.services.observabilityadmin.model.ListResourceTelemetryResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.observabilityadmin.paginators.ListResourceTelemetryIterable responses = client.listResourceTelemetryPaginator(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 listResourceTelemetry(software.amazon.awssdk.services.observabilityadmin.model.ListResourceTelemetryRequest) operation.

Parameters:

listResourceTelemetryRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

listResourceTelemetryPaginator

default ListResourceTelemetryIterable listResourceTelemetryPaginator(Consumer<ListResourceTelemetryRequest.Builder> listResourceTelemetryRequest)
                                                              throws AccessDeniedException,
                                                                     InternalServerException,
                                                                     ValidationException,
                                                                     AwsServiceException,
                                                                     SdkClientException,
                                                                     ObservabilityAdminException

This is a variant of listResourceTelemetry(software.amazon.awssdk.services.observabilityadmin.model.ListResourceTelemetryRequest) 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.observabilityadmin.paginators.ListResourceTelemetryIterable responses = client.listResourceTelemetryPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.observabilityadmin.paginators.ListResourceTelemetryIterable responses = client
             .listResourceTelemetryPaginator(request);
     for (software.amazon.awssdk.services.observabilityadmin.model.ListResourceTelemetryResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.observabilityadmin.paginators.ListResourceTelemetryIterable responses = client.listResourceTelemetryPaginator(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 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 via ListResourceTelemetryRequest.builder()

Parameters:

listResourceTelemetryRequest - A Consumer that will call methods on ListResourceTelemetryRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

listResourceTelemetryForOrganization

default ListResourceTelemetryForOrganizationResponse listResourceTelemetryForOrganization(ListResourceTelemetryForOrganizationRequest listResourceTelemetryForOrganizationRequest)
                                                                                   throws AccessDeniedException,
                                                                                          InternalServerException,
                                                                                          ValidationException,
                                                                                          AwsServiceException,
                                                                                          SdkClientException,
                                                                                          ObservabilityAdminException

Returns a list of telemetry configurations for AWS resources supported by telemetry config in the organization.

Parameters:

listResourceTelemetryForOrganizationRequest -

Returns:

Result of the ListResourceTelemetryForOrganization operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

listResourceTelemetryForOrganization

default ListResourceTelemetryForOrganizationResponse listResourceTelemetryForOrganization(Consumer<ListResourceTelemetryForOrganizationRequest.Builder> listResourceTelemetryForOrganizationRequest)
                                                                                   throws AccessDeniedException,
                                                                                          InternalServerException,
                                                                                          ValidationException,
                                                                                          AwsServiceException,
                                                                                          SdkClientException,
                                                                                          ObservabilityAdminException

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 via ListResourceTelemetryForOrganizationRequest.builder()

Parameters:

listResourceTelemetryForOrganizationRequest - A Consumer that will call methods on ListResourceTelemetryForOrganizationRequest.Builder to create a request.

Returns:

Result of the ListResourceTelemetryForOrganization operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

listResourceTelemetryForOrganizationPaginator

default ListResourceTelemetryForOrganizationIterable listResourceTelemetryForOrganizationPaginator(ListResourceTelemetryForOrganizationRequest listResourceTelemetryForOrganizationRequest)
                                                                                            throws AccessDeniedException,
                                                                                                   InternalServerException,
                                                                                                   ValidationException,
                                                                                                   AwsServiceException,
                                                                                                   SdkClientException,
                                                                                                   ObservabilityAdminException

This is a variant of listResourceTelemetryForOrganization(software.amazon.awssdk.services.observabilityadmin.model.ListResourceTelemetryForOrganizationRequest) 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.observabilityadmin.paginators.ListResourceTelemetryForOrganizationIterable responses = client.listResourceTelemetryForOrganizationPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.observabilityadmin.paginators.ListResourceTelemetryForOrganizationIterable responses = client
             .listResourceTelemetryForOrganizationPaginator(request);
     for (software.amazon.awssdk.services.observabilityadmin.model.ListResourceTelemetryForOrganizationResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.observabilityadmin.paginators.ListResourceTelemetryForOrganizationIterable responses = client.listResourceTelemetryForOrganizationPaginator(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 listResourceTelemetryForOrganization(software.amazon.awssdk.services.observabilityadmin.model.ListResourceTelemetryForOrganizationRequest) operation.

Parameters:

listResourceTelemetryForOrganizationRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

listResourceTelemetryForOrganizationPaginator

default ListResourceTelemetryForOrganizationIterable listResourceTelemetryForOrganizationPaginator(Consumer<ListResourceTelemetryForOrganizationRequest.Builder> listResourceTelemetryForOrganizationRequest)
                                                                                            throws AccessDeniedException,
                                                                                                   InternalServerException,
                                                                                                   ValidationException,
                                                                                                   AwsServiceException,
                                                                                                   SdkClientException,
                                                                                                   ObservabilityAdminException

This is a variant of listResourceTelemetryForOrganization(software.amazon.awssdk.services.observabilityadmin.model.ListResourceTelemetryForOrganizationRequest) 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.observabilityadmin.paginators.ListResourceTelemetryForOrganizationIterable responses = client.listResourceTelemetryForOrganizationPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.observabilityadmin.paginators.ListResourceTelemetryForOrganizationIterable responses = client
             .listResourceTelemetryForOrganizationPaginator(request);
     for (software.amazon.awssdk.services.observabilityadmin.model.ListResourceTelemetryForOrganizationResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.observabilityadmin.paginators.ListResourceTelemetryForOrganizationIterable responses = client.listResourceTelemetryForOrganizationPaginator(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 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 via ListResourceTelemetryForOrganizationRequest.builder()

Parameters:

listResourceTelemetryForOrganizationRequest - A Consumer that will call methods on ListResourceTelemetryForOrganizationRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

startTelemetryEvaluation

default StartTelemetryEvaluationResponse startTelemetryEvaluation(StartTelemetryEvaluationRequest startTelemetryEvaluationRequest)
                                                           throws AccessDeniedException,
                                                                  InternalServerException,
                                                                  ValidationException,
                                                                  AwsServiceException,
                                                                  SdkClientException,
                                                                  ObservabilityAdminException

This action begins onboarding onboarding the caller AWS account to the telemetry config feature.

Parameters:

startTelemetryEvaluationRequest -

Returns:

Result of the StartTelemetryEvaluation operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

startTelemetryEvaluation

default StartTelemetryEvaluationResponse startTelemetryEvaluation(Consumer<StartTelemetryEvaluationRequest.Builder> startTelemetryEvaluationRequest)
                                                           throws AccessDeniedException,
                                                                  InternalServerException,
                                                                  ValidationException,
                                                                  AwsServiceException,
                                                                  SdkClientException,
                                                                  ObservabilityAdminException

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 via StartTelemetryEvaluationRequest.builder()

Parameters:

startTelemetryEvaluationRequest - A Consumer that will call methods on StartTelemetryEvaluationRequest.Builder to create a request.

Returns:

Result of the StartTelemetryEvaluation operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

startTelemetryEvaluationForOrganization

default StartTelemetryEvaluationForOrganizationResponse startTelemetryEvaluationForOrganization(StartTelemetryEvaluationForOrganizationRequest startTelemetryEvaluationForOrganizationRequest)
                                                                                         throws AccessDeniedException,
                                                                                                InternalServerException,
                                                                                                ValidationException,
                                                                                                AwsServiceException,
                                                                                                SdkClientException,
                                                                                                ObservabilityAdminException

This actions begins onboarding the organization and all member accounts to the telemetry config feature.

Parameters:

startTelemetryEvaluationForOrganizationRequest -

Returns:

Result of the StartTelemetryEvaluationForOrganization operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

startTelemetryEvaluationForOrganization

default StartTelemetryEvaluationForOrganizationResponse startTelemetryEvaluationForOrganization(Consumer<StartTelemetryEvaluationForOrganizationRequest.Builder> startTelemetryEvaluationForOrganizationRequest)
                                                                                         throws AccessDeniedException,
                                                                                                InternalServerException,
                                                                                                ValidationException,
                                                                                                AwsServiceException,
                                                                                                SdkClientException,
                                                                                                ObservabilityAdminException

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 via StartTelemetryEvaluationForOrganizationRequest.builder()

Parameters:

startTelemetryEvaluationForOrganizationRequest - A Consumer that will call methods on StartTelemetryEvaluationForOrganizationRequest.Builder to create a request.

Returns:

Result of the StartTelemetryEvaluationForOrganization operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

stopTelemetryEvaluation

default StopTelemetryEvaluationResponse stopTelemetryEvaluation(StopTelemetryEvaluationRequest stopTelemetryEvaluationRequest)
                                                         throws AccessDeniedException,
                                                                InternalServerException,
                                                                ValidationException,
                                                                AwsServiceException,
                                                                SdkClientException,
                                                                ObservabilityAdminException

This action begins offboarding the caller AWS account from the telemetry config feature.

Parameters:

stopTelemetryEvaluationRequest -

Returns:

Result of the StopTelemetryEvaluation operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

stopTelemetryEvaluation

default StopTelemetryEvaluationResponse stopTelemetryEvaluation(Consumer<StopTelemetryEvaluationRequest.Builder> stopTelemetryEvaluationRequest)
                                                         throws AccessDeniedException,
                                                                InternalServerException,
                                                                ValidationException,
                                                                AwsServiceException,
                                                                SdkClientException,
                                                                ObservabilityAdminException

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 via StopTelemetryEvaluationRequest.builder()

Parameters:

stopTelemetryEvaluationRequest - A Consumer that will call methods on StopTelemetryEvaluationRequest.Builder to create a request.

Returns:

Result of the StopTelemetryEvaluation operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

stopTelemetryEvaluationForOrganization

default StopTelemetryEvaluationForOrganizationResponse stopTelemetryEvaluationForOrganization(StopTelemetryEvaluationForOrganizationRequest stopTelemetryEvaluationForOrganizationRequest)
                                                                                       throws AccessDeniedException,
                                                                                              InternalServerException,
                                                                                              ValidationException,
                                                                                              AwsServiceException,
                                                                                              SdkClientException,
                                                                                              ObservabilityAdminException

This action offboards the Organization of the caller AWS account from thef telemetry config feature.

Parameters:

stopTelemetryEvaluationForOrganizationRequest -

Returns:

Result of the StopTelemetryEvaluationForOrganization operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

stopTelemetryEvaluationForOrganization

default StopTelemetryEvaluationForOrganizationResponse stopTelemetryEvaluationForOrganization(Consumer<StopTelemetryEvaluationForOrganizationRequest.Builder> stopTelemetryEvaluationForOrganizationRequest)
                                                                                       throws AccessDeniedException,
                                                                                              InternalServerException,
                                                                                              ValidationException,
                                                                                              AwsServiceException,
                                                                                              SdkClientException,
                                                                                              ObservabilityAdminException

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 via StopTelemetryEvaluationForOrganizationRequest.builder()

Parameters:

stopTelemetryEvaluationForOrganizationRequest - A Consumer that will call methods on StopTelemetryEvaluationForOrganizationRequest.Builder to create a request.

Returns:

Result of the StopTelemetryEvaluationForOrganization operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

create

static ObservabilityAdminClient create()

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

builder

static ObservabilityAdminClientBuilder builder()

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

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default ObservabilityAdminServiceClientConfiguration serviceClientConfiguration()

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient