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.

You can use Amazon CloudWatch Observability Admin to discover and understand the state of telemetry configuration in CloudWatch for your Amazon Web Services Organization or account. This simplifies the process of auditing your telemetry collection configurations across multiple resource types within your Amazon Web Services Organization or account. By providing a consolidated view, it allows you to easily review and manage telemetry settings, helping you ensure proper monitoring and data collection across your Amazon Web Services environment. 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 final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
static 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 CreateTelemetryRuleResponse	createTelemetryRule(Consumer<CreateTelemetryRuleRequest.Builder> createTelemetryRuleRequest)	Creates a telemetry rule that defines how telemetry should be configured for Amazon Web Services resources in your account.
default CreateTelemetryRuleResponse	createTelemetryRule(CreateTelemetryRuleRequest createTelemetryRuleRequest)	Creates a telemetry rule that defines how telemetry should be configured for Amazon Web Services resources in your account.
default CreateTelemetryRuleForOrganizationResponse	createTelemetryRuleForOrganization(Consumer<CreateTelemetryRuleForOrganizationRequest.Builder> createTelemetryRuleForOrganizationRequest)	Creates a telemetry rule that applies across an Amazon Web Services Organization.
default CreateTelemetryRuleForOrganizationResponse	createTelemetryRuleForOrganization(CreateTelemetryRuleForOrganizationRequest createTelemetryRuleForOrganizationRequest)	Creates a telemetry rule that applies across an Amazon Web Services Organization.
default DeleteTelemetryRuleResponse	deleteTelemetryRule(Consumer<DeleteTelemetryRuleRequest.Builder> deleteTelemetryRuleRequest)	Deletes a telemetry rule from your account.
default DeleteTelemetryRuleResponse	deleteTelemetryRule(DeleteTelemetryRuleRequest deleteTelemetryRuleRequest)	Deletes a telemetry rule from your account.
default DeleteTelemetryRuleForOrganizationResponse	deleteTelemetryRuleForOrganization(Consumer<DeleteTelemetryRuleForOrganizationRequest.Builder> deleteTelemetryRuleForOrganizationRequest)	Deletes an organization-wide telemetry rule.
default DeleteTelemetryRuleForOrganizationResponse	deleteTelemetryRuleForOrganization(DeleteTelemetryRuleForOrganizationRequest deleteTelemetryRuleForOrganizationRequest)	Deletes an organization-wide telemetry rule.
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 GetTelemetryRuleResponse	getTelemetryRule(Consumer<GetTelemetryRuleRequest.Builder> getTelemetryRuleRequest)	Retrieves the details of a specific telemetry rule in your account.
default GetTelemetryRuleResponse	getTelemetryRule(GetTelemetryRuleRequest getTelemetryRuleRequest)	Retrieves the details of a specific telemetry rule in your account.
default GetTelemetryRuleForOrganizationResponse	getTelemetryRuleForOrganization(Consumer<GetTelemetryRuleForOrganizationRequest.Builder> getTelemetryRuleForOrganizationRequest)	Retrieves the details of a specific organization telemetry rule.
default GetTelemetryRuleForOrganizationResponse	getTelemetryRuleForOrganization(GetTelemetryRuleForOrganizationRequest getTelemetryRuleForOrganizationRequest)	Retrieves the details of a specific organization telemetry rule.
default ListResourceTelemetryResponse	listResourceTelemetry(Consumer<ListResourceTelemetryRequest.Builder> listResourceTelemetryRequest)	Returns a list of telemetry configurations for Amazon Web Services resources supported by telemetry config.
default ListResourceTelemetryResponse	listResourceTelemetry(ListResourceTelemetryRequest listResourceTelemetryRequest)	Returns a list of telemetry configurations for Amazon Web Services resources supported by telemetry config.
default ListResourceTelemetryForOrganizationResponse	listResourceTelemetryForOrganization(Consumer<ListResourceTelemetryForOrganizationRequest.Builder> listResourceTelemetryForOrganizationRequest)	Returns a list of telemetry configurations for Amazon Web Services resources supported by telemetry config in the organization.
default ListResourceTelemetryForOrganizationResponse	listResourceTelemetryForOrganization(ListResourceTelemetryForOrganizationRequest listResourceTelemetryForOrganizationRequest)	Returns a list of telemetry configurations for Amazon Web Services 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 ListTagsForResourceResponse	listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)	Lists all tags attached to the specified telemetry rule resource.
default ListTagsForResourceResponse	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)	Lists all tags attached to the specified telemetry rule resource.
default ListTelemetryRulesResponse	listTelemetryRules(Consumer<ListTelemetryRulesRequest.Builder> listTelemetryRulesRequest)	Lists all telemetry rules in your account.
default ListTelemetryRulesResponse	listTelemetryRules(ListTelemetryRulesRequest listTelemetryRulesRequest)	Lists all telemetry rules in your account.
default ListTelemetryRulesForOrganizationResponse	listTelemetryRulesForOrganization(Consumer<ListTelemetryRulesForOrganizationRequest.Builder> listTelemetryRulesForOrganizationRequest)	Lists all telemetry rules in your organization.
default ListTelemetryRulesForOrganizationResponse	listTelemetryRulesForOrganization(ListTelemetryRulesForOrganizationRequest listTelemetryRulesForOrganizationRequest)	Lists all telemetry rules in your organization.
default ListTelemetryRulesForOrganizationIterable	listTelemetryRulesForOrganizationPaginator(Consumer<ListTelemetryRulesForOrganizationRequest.Builder> listTelemetryRulesForOrganizationRequest)	This is a variant of listTelemetryRulesForOrganization(software.amazon.awssdk.services.observabilityadmin.model.ListTelemetryRulesForOrganizationRequest) operation.
default ListTelemetryRulesForOrganizationIterable	listTelemetryRulesForOrganizationPaginator(ListTelemetryRulesForOrganizationRequest listTelemetryRulesForOrganizationRequest)	This is a variant of listTelemetryRulesForOrganization(software.amazon.awssdk.services.observabilityadmin.model.ListTelemetryRulesForOrganizationRequest) operation.
default ListTelemetryRulesIterable	listTelemetryRulesPaginator(Consumer<ListTelemetryRulesRequest.Builder> listTelemetryRulesRequest)	This is a variant of listTelemetryRules(software.amazon.awssdk.services.observabilityadmin.model.ListTelemetryRulesRequest) operation.
default ListTelemetryRulesIterable	listTelemetryRulesPaginator(ListTelemetryRulesRequest listTelemetryRulesRequest)	This is a variant of listTelemetryRules(software.amazon.awssdk.services.observabilityadmin.model.ListTelemetryRulesRequest) operation.
default ObservabilityAdminServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()
default StartTelemetryEvaluationResponse	startTelemetryEvaluation(Consumer<StartTelemetryEvaluationRequest.Builder> startTelemetryEvaluationRequest)	This action begins onboarding the caller Amazon Web Services account to the telemetry config feature.
default StartTelemetryEvaluationResponse	startTelemetryEvaluation(StartTelemetryEvaluationRequest startTelemetryEvaluationRequest)	This action begins onboarding the caller Amazon Web Services 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 Amazon Web Services account from the telemetry config feature.
default StopTelemetryEvaluationResponse	stopTelemetryEvaluation(StopTelemetryEvaluationRequest stopTelemetryEvaluationRequest)	This action begins offboarding the caller Amazon Web Services account from the telemetry config feature.
default StopTelemetryEvaluationForOrganizationResponse	stopTelemetryEvaluationForOrganization(Consumer<StopTelemetryEvaluationForOrganizationRequest.Builder> stopTelemetryEvaluationForOrganizationRequest)	This action offboards the Organization of the caller Amazon Web Services account from the telemetry config feature.
default StopTelemetryEvaluationForOrganizationResponse	stopTelemetryEvaluationForOrganization(StopTelemetryEvaluationForOrganizationRequest stopTelemetryEvaluationForOrganizationRequest)	This action offboards the Organization of the caller Amazon Web Services account from the telemetry config feature.
default TagResourceResponse	tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)	Adds or updates tags for a telemetry rule resource.
default TagResourceResponse	tagResource(TagResourceRequest tagResourceRequest)	Adds or updates tags for a telemetry rule resource.
default UntagResourceResponse	untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)	Removes tags from a telemetry rule resource.
default UntagResourceResponse	untagResource(UntagResourceRequest untagResourceRequest)	Removes tags from a telemetry rule resource.
default UpdateTelemetryRuleResponse	updateTelemetryRule(Consumer<UpdateTelemetryRuleRequest.Builder> updateTelemetryRuleRequest)	Updates an existing telemetry rule in your account.
default UpdateTelemetryRuleResponse	updateTelemetryRule(UpdateTelemetryRuleRequest updateTelemetryRuleRequest)	Updates an existing telemetry rule in your account.
default UpdateTelemetryRuleForOrganizationResponse	updateTelemetryRuleForOrganization(Consumer<UpdateTelemetryRuleForOrganizationRequest.Builder> updateTelemetryRuleForOrganizationRequest)	Updates an existing telemetry rule that applies across an Amazon Web Services Organization.
default UpdateTelemetryRuleForOrganizationResponse	updateTelemetryRuleForOrganization(UpdateTelemetryRuleForOrganizationRequest updateTelemetryRuleForOrganizationRequest)	Updates an existing telemetry rule that applies across an Amazon Web Services Organization.

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

close

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

serviceName

Field Details

SERVICE_NAME

static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

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

See Also:

• Constant Field Values

Method Details

createTelemetryRule

default CreateTelemetryRuleResponse createTelemetryRule(CreateTelemetryRuleRequest createTelemetryRuleRequest)
                                                 throws ServiceQuotaExceededException,
ConflictException,
AccessDeniedException,
InternalServerException,
ValidationException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ObservabilityAdminException

Creates a telemetry rule that defines how telemetry should be configured for Amazon Web Services resources in your account. The rule specifies which resources should have telemetry enabled and how that telemetry data should be collected based on resource type, telemetry type, and selection criteria.

Parameters:

createTelemetryRuleRequest -

Returns:

Result of the CreateTelemetryRule operation returned by the service.

See Also:

• AWS API Documentation

createTelemetryRule

default CreateTelemetryRuleResponse createTelemetryRule(Consumer<CreateTelemetryRuleRequest.Builder> createTelemetryRuleRequest)
                                                 throws ServiceQuotaExceededException,
ConflictException,
AccessDeniedException,
InternalServerException,
ValidationException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ObservabilityAdminException

Creates a telemetry rule that defines how telemetry should be configured for Amazon Web Services resources in your account. The rule specifies which resources should have telemetry enabled and how that telemetry data should be collected based on resource type, telemetry type, and selection criteria.

This is a convenience which creates an instance of the CreateTelemetryRuleRequest.Builder avoiding the need to create one manually via CreateTelemetryRuleRequest.builder()

Parameters:

createTelemetryRuleRequest - A Consumer that will call methods on CreateTelemetryRuleRequest.Builder to create a request.

Returns:

Result of the CreateTelemetryRule operation returned by the service.

See Also:

• AWS API Documentation

createTelemetryRuleForOrganization

default CreateTelemetryRuleForOrganizationResponse createTelemetryRuleForOrganization(CreateTelemetryRuleForOrganizationRequest createTelemetryRuleForOrganizationRequest)
                                                                               throws ServiceQuotaExceededException,
ConflictException,
AccessDeniedException,
InternalServerException,
ValidationException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ObservabilityAdminException

Creates a telemetry rule that applies across an Amazon Web Services Organization. This operation can only be called by the organization's management account or a delegated administrator account.

Parameters:

createTelemetryRuleForOrganizationRequest -

Returns:

Result of the CreateTelemetryRuleForOrganization operation returned by the service.

See Also:

• AWS API Documentation

createTelemetryRuleForOrganization

default CreateTelemetryRuleForOrganizationResponse createTelemetryRuleForOrganization(Consumer<CreateTelemetryRuleForOrganizationRequest.Builder> createTelemetryRuleForOrganizationRequest)
                                                                               throws ServiceQuotaExceededException,
ConflictException,
AccessDeniedException,
InternalServerException,
ValidationException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ObservabilityAdminException

Creates a telemetry rule that applies across an Amazon Web Services Organization. This operation can only be called by the organization's management account or a delegated administrator account.

This is a convenience which creates an instance of the CreateTelemetryRuleForOrganizationRequest.Builder avoiding the need to create one manually via CreateTelemetryRuleForOrganizationRequest.builder()

Parameters:

createTelemetryRuleForOrganizationRequest - A Consumer that will call methods on CreateTelemetryRuleForOrganizationRequest.Builder to create a request.

Returns:

Result of the CreateTelemetryRuleForOrganization operation returned by the service.

See Also:

• AWS API Documentation

deleteTelemetryRule

default DeleteTelemetryRuleResponse deleteTelemetryRule(DeleteTelemetryRuleRequest deleteTelemetryRuleRequest)
                                                 throws ResourceNotFoundException,
AccessDeniedException,
InternalServerException,
ValidationException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ObservabilityAdminException

Deletes a telemetry rule from your account. Any telemetry configurations previously created by the rule will remain but no new resources will be configured by this rule.

Parameters:

deleteTelemetryRuleRequest -

Returns:

Result of the DeleteTelemetryRule operation returned by the service.

See Also:

• AWS API Documentation

deleteTelemetryRule

default DeleteTelemetryRuleResponse deleteTelemetryRule(Consumer<DeleteTelemetryRuleRequest.Builder> deleteTelemetryRuleRequest)
                                                 throws ResourceNotFoundException,
AccessDeniedException,
InternalServerException,
ValidationException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ObservabilityAdminException

Deletes a telemetry rule from your account. Any telemetry configurations previously created by the rule will remain but no new resources will be configured by this rule.

This is a convenience which creates an instance of the DeleteTelemetryRuleRequest.Builder avoiding the need to create one manually via DeleteTelemetryRuleRequest.builder()

Parameters:

deleteTelemetryRuleRequest - A Consumer that will call methods on DeleteTelemetryRuleRequest.Builder to create a request.

Returns:

Result of the DeleteTelemetryRule operation returned by the service.

See Also:

• AWS API Documentation

deleteTelemetryRuleForOrganization

default DeleteTelemetryRuleForOrganizationResponse deleteTelemetryRuleForOrganization(DeleteTelemetryRuleForOrganizationRequest deleteTelemetryRuleForOrganizationRequest)
                                                                               throws ResourceNotFoundException,
AccessDeniedException,
InternalServerException,
ValidationException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ObservabilityAdminException

Deletes an organization-wide telemetry rule. This operation can only be called by the organization's management account or a delegated administrator account.

Parameters:

deleteTelemetryRuleForOrganizationRequest -

Returns:

Result of the DeleteTelemetryRuleForOrganization operation returned by the service.

See Also:

• AWS API Documentation

deleteTelemetryRuleForOrganization

default DeleteTelemetryRuleForOrganizationResponse deleteTelemetryRuleForOrganization(Consumer<DeleteTelemetryRuleForOrganizationRequest.Builder> deleteTelemetryRuleForOrganizationRequest)
                                                                               throws ResourceNotFoundException,
AccessDeniedException,
InternalServerException,
ValidationException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ObservabilityAdminException

Deletes an organization-wide telemetry rule. This operation can only be called by the organization's management account or a delegated administrator account.

This is a convenience which creates an instance of the DeleteTelemetryRuleForOrganizationRequest.Builder avoiding the need to create one manually via DeleteTelemetryRuleForOrganizationRequest.builder()

Parameters:

deleteTelemetryRuleForOrganizationRequest - A Consumer that will call methods on DeleteTelemetryRuleForOrganizationRequest.Builder to create a request.

Returns:

Result of the DeleteTelemetryRuleForOrganization operation returned by the service.

See Also:

• AWS API Documentation

getTelemetryEvaluationStatus

default GetTelemetryEvaluationStatusResponse getTelemetryEvaluationStatus(GetTelemetryEvaluationStatusRequest getTelemetryEvaluationStatusRequest)
                                                                   throws AccessDeniedException,
InternalServerException,
TooManyRequestsException,
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.

See Also:

• AWS API Documentation

getTelemetryEvaluationStatus

default GetTelemetryEvaluationStatusResponse getTelemetryEvaluationStatus(Consumer<GetTelemetryEvaluationStatusRequest.Builder> getTelemetryEvaluationStatusRequest)
                                                                   throws AccessDeniedException,
InternalServerException,
TooManyRequestsException,
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.

See Also:

• AWS API Documentation

getTelemetryEvaluationStatusForOrganization

default GetTelemetryEvaluationStatusForOrganizationResponse getTelemetryEvaluationStatusForOrganization(GetTelemetryEvaluationStatusForOrganizationRequest getTelemetryEvaluationStatusForOrganizationRequest)
                                                                                                 throws AccessDeniedException,
InternalServerException,
ValidationException,
TooManyRequestsException,
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 Amazon Web Services Organization or an assigned Delegated Admin Account of Amazon CloudWatch telemetry config.

Parameters:

getTelemetryEvaluationStatusForOrganizationRequest -

Returns:

Result of the GetTelemetryEvaluationStatusForOrganization operation returned by the service.

See Also:

• AWS API Documentation

getTelemetryEvaluationStatusForOrganization

default GetTelemetryEvaluationStatusForOrganizationResponse getTelemetryEvaluationStatusForOrganization(Consumer<GetTelemetryEvaluationStatusForOrganizationRequest.Builder> getTelemetryEvaluationStatusForOrganizationRequest)
                                                                                                 throws AccessDeniedException,
InternalServerException,
ValidationException,
TooManyRequestsException,
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 Amazon Web Services Organization or an assigned Delegated Admin Account of Amazon 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.

See Also:

• AWS API Documentation

getTelemetryRule

default GetTelemetryRuleResponse getTelemetryRule(GetTelemetryRuleRequest getTelemetryRuleRequest)
                                           throws ResourceNotFoundException,
AccessDeniedException,
InternalServerException,
ValidationException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ObservabilityAdminException

Retrieves the details of a specific telemetry rule in your account.

Parameters:

getTelemetryRuleRequest -

Returns:

Result of the GetTelemetryRule operation returned by the service.

See Also:

• AWS API Documentation

getTelemetryRule

default GetTelemetryRuleResponse getTelemetryRule(Consumer<GetTelemetryRuleRequest.Builder> getTelemetryRuleRequest)
                                           throws ResourceNotFoundException,
AccessDeniedException,
InternalServerException,
ValidationException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ObservabilityAdminException

Retrieves the details of a specific telemetry rule in your account.

This is a convenience which creates an instance of the GetTelemetryRuleRequest.Builder avoiding the need to create one manually via GetTelemetryRuleRequest.builder()

Parameters:

getTelemetryRuleRequest - A Consumer that will call methods on GetTelemetryRuleRequest.Builder to create a request.

Returns:

Result of the GetTelemetryRule operation returned by the service.

See Also:

• AWS API Documentation

getTelemetryRuleForOrganization

default GetTelemetryRuleForOrganizationResponse getTelemetryRuleForOrganization(GetTelemetryRuleForOrganizationRequest getTelemetryRuleForOrganizationRequest)
                                                                         throws ResourceNotFoundException,
AccessDeniedException,
InternalServerException,
ValidationException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ObservabilityAdminException

Retrieves the details of a specific organization telemetry rule. This operation can only be called by the organization's management account or a delegated administrator account.

Parameters:

getTelemetryRuleForOrganizationRequest -

Returns:

Result of the GetTelemetryRuleForOrganization operation returned by the service.

See Also:

• AWS API Documentation

getTelemetryRuleForOrganization

default GetTelemetryRuleForOrganizationResponse getTelemetryRuleForOrganization(Consumer<GetTelemetryRuleForOrganizationRequest.Builder> getTelemetryRuleForOrganizationRequest)
                                                                         throws ResourceNotFoundException,
AccessDeniedException,
InternalServerException,
ValidationException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ObservabilityAdminException

Retrieves the details of a specific organization telemetry rule. This operation can only be called by the organization's management account or a delegated administrator account.

This is a convenience which creates an instance of the GetTelemetryRuleForOrganizationRequest.Builder avoiding the need to create one manually via GetTelemetryRuleForOrganizationRequest.builder()

Parameters:

getTelemetryRuleForOrganizationRequest - A Consumer that will call methods on GetTelemetryRuleForOrganizationRequest.Builder to create a request.

Returns:

Result of the GetTelemetryRuleForOrganization operation returned by the service.

See Also:

• AWS API Documentation

listResourceTelemetry

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

Returns a list of telemetry configurations for Amazon Web Services 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.

See Also:

• AWS API Documentation

listResourceTelemetry

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

Returns a list of telemetry configurations for Amazon Web Services 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.

See Also:

• AWS API Documentation

listResourceTelemetryPaginator

default ListResourceTelemetryIterable listResourceTelemetryPaginator(ListResourceTelemetryRequest listResourceTelemetryRequest)
                                                              throws AccessDeniedException,
InternalServerException,
ValidationException,
TooManyRequestsException,
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.

See Also:

• AWS API Documentation

listResourceTelemetryPaginator

default ListResourceTelemetryIterable listResourceTelemetryPaginator(Consumer<ListResourceTelemetryRequest.Builder> listResourceTelemetryRequest)
                                                              throws AccessDeniedException,
InternalServerException,
ValidationException,
TooManyRequestsException,
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.

See Also:

• AWS API Documentation

listResourceTelemetryForOrganization

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

Returns a list of telemetry configurations for Amazon Web Services resources supported by telemetry config in the organization.

Parameters:

listResourceTelemetryForOrganizationRequest -

Returns:

Result of the ListResourceTelemetryForOrganization operation returned by the service.

See Also:

• AWS API Documentation

listResourceTelemetryForOrganization

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

Returns a list of telemetry configurations for Amazon Web Services 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.

See Also:

• AWS API Documentation

listResourceTelemetryForOrganizationPaginator

default ListResourceTelemetryForOrganizationIterable listResourceTelemetryForOrganizationPaginator(ListResourceTelemetryForOrganizationRequest listResourceTelemetryForOrganizationRequest)
                                                                                            throws AccessDeniedException,
InternalServerException,
ValidationException,
TooManyRequestsException,
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.

See Also:

• AWS API Documentation

listResourceTelemetryForOrganizationPaginator

default ListResourceTelemetryForOrganizationIterable listResourceTelemetryForOrganizationPaginator(Consumer<ListResourceTelemetryForOrganizationRequest.Builder> listResourceTelemetryForOrganizationRequest)
                                                                                            throws AccessDeniedException,
InternalServerException,
ValidationException,
TooManyRequestsException,
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.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
                                                 throws ResourceNotFoundException,
AccessDeniedException,
InternalServerException,
ValidationException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ObservabilityAdminException

Lists all tags attached to the specified telemetry rule resource.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
                                                 throws ResourceNotFoundException,
AccessDeniedException,
InternalServerException,
ValidationException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ObservabilityAdminException

Lists all tags attached to the specified telemetry rule resource.

This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the need to create one manually via ListTagsForResourceRequest.builder()

Parameters:

listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

listTelemetryRules

default ListTelemetryRulesResponse listTelemetryRules(ListTelemetryRulesRequest listTelemetryRulesRequest)
                                               throws AccessDeniedException,
InternalServerException,
ValidationException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ObservabilityAdminException

Lists all telemetry rules in your account. You can filter the results by specifying a rule name prefix.

Parameters:

listTelemetryRulesRequest -

Returns:

Result of the ListTelemetryRules operation returned by the service.

See Also:

• AWS API Documentation

listTelemetryRules

default ListTelemetryRulesResponse listTelemetryRules(Consumer<ListTelemetryRulesRequest.Builder> listTelemetryRulesRequest)
                                               throws AccessDeniedException,
InternalServerException,
ValidationException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ObservabilityAdminException

Lists all telemetry rules in your account. You can filter the results by specifying a rule name prefix.

This is a convenience which creates an instance of the ListTelemetryRulesRequest.Builder avoiding the need to create one manually via ListTelemetryRulesRequest.builder()

Parameters:

listTelemetryRulesRequest - A Consumer that will call methods on ListTelemetryRulesRequest.Builder to create a request.

Returns:

Result of the ListTelemetryRules operation returned by the service.

See Also:

• AWS API Documentation

listTelemetryRulesPaginator

default ListTelemetryRulesIterable listTelemetryRulesPaginator(ListTelemetryRulesRequest listTelemetryRulesRequest)
                                                        throws AccessDeniedException,
InternalServerException,
ValidationException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ObservabilityAdminException

This is a variant of listTelemetryRules(software.amazon.awssdk.services.observabilityadmin.model.ListTelemetryRulesRequest) 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.ListTelemetryRulesIterable responses = client.listTelemetryRulesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

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

3) Use iterator directly

 
 software.amazon.awssdk.services.observabilityadmin.paginators.ListTelemetryRulesIterable responses = client.listTelemetryRulesPaginator(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 listTelemetryRules(software.amazon.awssdk.services.observabilityadmin.model.ListTelemetryRulesRequest) operation.

Parameters:

listTelemetryRulesRequest -

Returns:

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

See Also:

• AWS API Documentation

listTelemetryRulesPaginator

default ListTelemetryRulesIterable listTelemetryRulesPaginator(Consumer<ListTelemetryRulesRequest.Builder> listTelemetryRulesRequest)
                                                        throws AccessDeniedException,
InternalServerException,
ValidationException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ObservabilityAdminException

This is a variant of listTelemetryRules(software.amazon.awssdk.services.observabilityadmin.model.ListTelemetryRulesRequest) 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.ListTelemetryRulesIterable responses = client.listTelemetryRulesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

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

3) Use iterator directly

 
 software.amazon.awssdk.services.observabilityadmin.paginators.ListTelemetryRulesIterable responses = client.listTelemetryRulesPaginator(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 listTelemetryRules(software.amazon.awssdk.services.observabilityadmin.model.ListTelemetryRulesRequest) operation.

This is a convenience which creates an instance of the ListTelemetryRulesRequest.Builder avoiding the need to create one manually via ListTelemetryRulesRequest.builder()

Parameters:

listTelemetryRulesRequest - A Consumer that will call methods on ListTelemetryRulesRequest.Builder to create a request.

Returns:

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

See Also:

• AWS API Documentation

listTelemetryRulesForOrganization

default ListTelemetryRulesForOrganizationResponse listTelemetryRulesForOrganization(ListTelemetryRulesForOrganizationRequest listTelemetryRulesForOrganizationRequest)
                                                                             throws AccessDeniedException,
InternalServerException,
ValidationException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ObservabilityAdminException

Lists all telemetry rules in your organization. This operation can only be called by the organization's management account or a delegated administrator account.

Parameters:

listTelemetryRulesForOrganizationRequest -

Returns:

Result of the ListTelemetryRulesForOrganization operation returned by the service.

See Also:

• AWS API Documentation

listTelemetryRulesForOrganization

default ListTelemetryRulesForOrganizationResponse listTelemetryRulesForOrganization(Consumer<ListTelemetryRulesForOrganizationRequest.Builder> listTelemetryRulesForOrganizationRequest)
                                                                             throws AccessDeniedException,
InternalServerException,
ValidationException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ObservabilityAdminException

Lists all telemetry rules in your organization. This operation can only be called by the organization's management account or a delegated administrator account.

This is a convenience which creates an instance of the ListTelemetryRulesForOrganizationRequest.Builder avoiding the need to create one manually via ListTelemetryRulesForOrganizationRequest.builder()

Parameters:

listTelemetryRulesForOrganizationRequest - A Consumer that will call methods on ListTelemetryRulesForOrganizationRequest.Builder to create a request.

Returns:

Result of the ListTelemetryRulesForOrganization operation returned by the service.

See Also:

• AWS API Documentation

listTelemetryRulesForOrganizationPaginator

default ListTelemetryRulesForOrganizationIterable listTelemetryRulesForOrganizationPaginator(ListTelemetryRulesForOrganizationRequest listTelemetryRulesForOrganizationRequest)
                                                                                      throws AccessDeniedException,
InternalServerException,
ValidationException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ObservabilityAdminException

This is a variant of listTelemetryRulesForOrganization(software.amazon.awssdk.services.observabilityadmin.model.ListTelemetryRulesForOrganizationRequest) 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.ListTelemetryRulesForOrganizationIterable responses = client.listTelemetryRulesForOrganizationPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

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

3) Use iterator directly

 
 software.amazon.awssdk.services.observabilityadmin.paginators.ListTelemetryRulesForOrganizationIterable responses = client.listTelemetryRulesForOrganizationPaginator(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 listTelemetryRulesForOrganization(software.amazon.awssdk.services.observabilityadmin.model.ListTelemetryRulesForOrganizationRequest) operation.

Parameters:

listTelemetryRulesForOrganizationRequest -

Returns:

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

See Also:

• AWS API Documentation

listTelemetryRulesForOrganizationPaginator

default ListTelemetryRulesForOrganizationIterable listTelemetryRulesForOrganizationPaginator(Consumer<ListTelemetryRulesForOrganizationRequest.Builder> listTelemetryRulesForOrganizationRequest)
                                                                                      throws AccessDeniedException,
InternalServerException,
ValidationException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ObservabilityAdminException

This is a variant of listTelemetryRulesForOrganization(software.amazon.awssdk.services.observabilityadmin.model.ListTelemetryRulesForOrganizationRequest) 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.ListTelemetryRulesForOrganizationIterable responses = client.listTelemetryRulesForOrganizationPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

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

3) Use iterator directly

 
 software.amazon.awssdk.services.observabilityadmin.paginators.ListTelemetryRulesForOrganizationIterable responses = client.listTelemetryRulesForOrganizationPaginator(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 listTelemetryRulesForOrganization(software.amazon.awssdk.services.observabilityadmin.model.ListTelemetryRulesForOrganizationRequest) operation.

This is a convenience which creates an instance of the ListTelemetryRulesForOrganizationRequest.Builder avoiding the need to create one manually via ListTelemetryRulesForOrganizationRequest.builder()

Parameters:

listTelemetryRulesForOrganizationRequest - A Consumer that will call methods on ListTelemetryRulesForOrganizationRequest.Builder to create a request.

Returns:

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

See Also:

• AWS API Documentation

startTelemetryEvaluation

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

This action begins onboarding the caller Amazon Web Services account to the telemetry config feature.

Parameters:

startTelemetryEvaluationRequest -

Returns:

Result of the StartTelemetryEvaluation operation returned by the service.

See Also:

• AWS API Documentation

startTelemetryEvaluation

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

This action begins onboarding the caller Amazon Web Services 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.

See Also:

• AWS API Documentation

startTelemetryEvaluationForOrganization

default StartTelemetryEvaluationForOrganizationResponse startTelemetryEvaluationForOrganization(StartTelemetryEvaluationForOrganizationRequest startTelemetryEvaluationForOrganizationRequest)
                                                                                         throws AccessDeniedException,
InternalServerException,
ValidationException,
TooManyRequestsException,
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.

See Also:

• AWS API Documentation

startTelemetryEvaluationForOrganization

default StartTelemetryEvaluationForOrganizationResponse startTelemetryEvaluationForOrganization(Consumer<StartTelemetryEvaluationForOrganizationRequest.Builder> startTelemetryEvaluationForOrganizationRequest)
                                                                                         throws AccessDeniedException,
InternalServerException,
ValidationException,
TooManyRequestsException,
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.

See Also:

• AWS API Documentation

stopTelemetryEvaluation

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

This action begins offboarding the caller Amazon Web Services account from the telemetry config feature.

Parameters:

stopTelemetryEvaluationRequest -

Returns:

Result of the StopTelemetryEvaluation operation returned by the service.

See Also:

• AWS API Documentation

stopTelemetryEvaluation

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

This action begins offboarding the caller Amazon Web Services 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.

See Also:

• AWS API Documentation

stopTelemetryEvaluationForOrganization

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

This action offboards the Organization of the caller Amazon Web Services account from the telemetry config feature.

Parameters:

stopTelemetryEvaluationForOrganizationRequest -

Returns:

Result of the StopTelemetryEvaluationForOrganization operation returned by the service.

See Also:

• AWS API Documentation

stopTelemetryEvaluationForOrganization

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

This action offboards the Organization of the caller Amazon Web Services account from the 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.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest)
                                 throws ServiceQuotaExceededException,
ResourceNotFoundException,
AccessDeniedException,
InternalServerException,
ValidationException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ObservabilityAdminException

Adds or updates tags for a telemetry rule resource.

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
                                 throws ServiceQuotaExceededException,
ResourceNotFoundException,
AccessDeniedException,
InternalServerException,
ValidationException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ObservabilityAdminException

Adds or updates tags for a telemetry rule resource.

This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to create one manually via TagResourceRequest.builder()

Parameters:

tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest)
                                     throws ResourceNotFoundException,
AccessDeniedException,
InternalServerException,
ValidationException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ObservabilityAdminException

Removes tags from a telemetry rule resource.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
                                     throws ResourceNotFoundException,
AccessDeniedException,
InternalServerException,
ValidationException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ObservabilityAdminException

Removes tags from a telemetry rule resource.

This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to create one manually via UntagResourceRequest.builder()

Parameters:

untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

updateTelemetryRule

default UpdateTelemetryRuleResponse updateTelemetryRule(UpdateTelemetryRuleRequest updateTelemetryRuleRequest)
                                                 throws ServiceQuotaExceededException,
ResourceNotFoundException,
AccessDeniedException,
InternalServerException,
ValidationException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ObservabilityAdminException

Updates an existing telemetry rule in your account.

Parameters:

updateTelemetryRuleRequest -

Returns:

Result of the UpdateTelemetryRule operation returned by the service.

See Also:

• AWS API Documentation

updateTelemetryRule

default UpdateTelemetryRuleResponse updateTelemetryRule(Consumer<UpdateTelemetryRuleRequest.Builder> updateTelemetryRuleRequest)
                                                 throws ServiceQuotaExceededException,
ResourceNotFoundException,
AccessDeniedException,
InternalServerException,
ValidationException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ObservabilityAdminException

Updates an existing telemetry rule in your account.

This is a convenience which creates an instance of the UpdateTelemetryRuleRequest.Builder avoiding the need to create one manually via UpdateTelemetryRuleRequest.builder()

Parameters:

updateTelemetryRuleRequest - A Consumer that will call methods on UpdateTelemetryRuleRequest.Builder to create a request.

Returns:

Result of the UpdateTelemetryRule operation returned by the service.

See Also:

• AWS API Documentation

updateTelemetryRuleForOrganization

default UpdateTelemetryRuleForOrganizationResponse updateTelemetryRuleForOrganization(UpdateTelemetryRuleForOrganizationRequest updateTelemetryRuleForOrganizationRequest)
                                                                               throws ServiceQuotaExceededException,
ResourceNotFoundException,
AccessDeniedException,
InternalServerException,
ValidationException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ObservabilityAdminException

Updates an existing telemetry rule that applies across an Amazon Web Services Organization. This operation can only be called by the organization's management account or a delegated administrator account.

Parameters:

updateTelemetryRuleForOrganizationRequest -

Returns:

Result of the UpdateTelemetryRuleForOrganization operation returned by the service.

See Also:

• AWS API Documentation

updateTelemetryRuleForOrganization

default UpdateTelemetryRuleForOrganizationResponse updateTelemetryRuleForOrganization(Consumer<UpdateTelemetryRuleForOrganizationRequest.Builder> updateTelemetryRuleForOrganizationRequest)
                                                                               throws ServiceQuotaExceededException,
ResourceNotFoundException,
AccessDeniedException,
InternalServerException,
ValidationException,
TooManyRequestsException,
AwsServiceException,
SdkClientException,
ObservabilityAdminException

Updates an existing telemetry rule that applies across an Amazon Web Services Organization. This operation can only be called by the organization's management account or a delegated administrator account.

This is a convenience which creates an instance of the UpdateTelemetryRuleForOrganizationRequest.Builder avoiding the need to create one manually via UpdateTelemetryRuleForOrganizationRequest.builder()

Parameters:

updateTelemetryRuleForOrganizationRequest - A Consumer that will call methods on UpdateTelemetryRuleForOrganizationRequest.Builder to create a request.

Returns:

Result of the UpdateTelemetryRuleForOrganization operation returned by the service.

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()

Description copied from interface: SdkClient

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

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration