observabilityadmin/aws.sdk.kotlin.services.observabilityadmin

Package-level declarations

Types

interface ObservabilityAdminClient : SdkClient

Amazon CloudWatch Obsersavability Admin to control temletry config for your AWS Organization or account. Telemetry config conﬁg to discover and understand the state of telemetry conﬁguration for your AWS resources from a central view in the CloudWatch console. Telemetry conﬁg simpliﬁes the process of auditing your telemetry collection conﬁgurations across multiple resource types across your AWS Organization or account. For more information, see Auditing CloudWatch telemetry conﬁgurations in the CloudWatch User Guide.

Properties

SdkVersion

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

ServiceId

const val ServiceId: String

Functions

getTelemetryEvaluationStatus

inline suspend fun ObservabilityAdminClient.getTelemetryEvaluationStatus(crossinline block: GetTelemetryEvaluationStatusRequest.Builder.() -> Unit): GetTelemetryEvaluationStatusResponse

Returns the current onboarding status of the telemetry config feature, including the status of the feature and reason the feature failed to start or stop.

getTelemetryEvaluationStatusForOrganization

inline suspend fun ObservabilityAdminClient.getTelemetryEvaluationStatusForOrganization(crossinline block: GetTelemetryEvaluationStatusForOrganizationRequest.Builder.() -> Unit): GetTelemetryEvaluationStatusForOrganizationResponse

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.

listResourceTelemetry

inline suspend fun ObservabilityAdminClient.listResourceTelemetry(crossinline block: ListResourceTelemetryRequest.Builder.() -> Unit): ListResourceTelemetryResponse

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

listResourceTelemetryForOrganization

inline suspend fun ObservabilityAdminClient.listResourceTelemetryForOrganization(crossinline block: ListResourceTelemetryForOrganizationRequest.Builder.() -> Unit): ListResourceTelemetryForOrganizationResponse

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

startTelemetryEvaluation

inline suspend fun ObservabilityAdminClient.startTelemetryEvaluation(crossinline block: StartTelemetryEvaluationRequest.Builder.() -> Unit): StartTelemetryEvaluationResponse

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

startTelemetryEvaluationForOrganization

inline suspend fun ObservabilityAdminClient.startTelemetryEvaluationForOrganization(crossinline block: StartTelemetryEvaluationForOrganizationRequest.Builder.() -> Unit): StartTelemetryEvaluationForOrganizationResponse

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

stopTelemetryEvaluation

inline suspend fun ObservabilityAdminClient.stopTelemetryEvaluation(crossinline block: StopTelemetryEvaluationRequest.Builder.() -> Unit): StopTelemetryEvaluationResponse

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

stopTelemetryEvaluationForOrganization

inline suspend fun ObservabilityAdminClient.stopTelemetryEvaluationForOrganization(crossinline block: StopTelemetryEvaluationForOrganizationRequest.Builder.() -> Unit): StopTelemetryEvaluationForOrganizationResponse

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

withConfig

fun ObservabilityAdminClient.withConfig(block: ObservabilityAdminClient.Config.Builder.() -> Unit): ObservabilityAdminClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.