ObservabilityAdminClient

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.

Installation

NPM
npm install @aws-sdk/client-observabilityadmin
Yarn
yarn add @aws-sdk/client-observabilityadmin
pnpm
pnpm add @aws-sdk/client-observabilityadmin

ObservabilityAdminClient Operations

Command
Summary
GetTelemetryEvaluationStatusCommand

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.

GetTelemetryEvaluationStatusForOrganizationCommand

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.

ListResourceTelemetryCommand

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

ListResourceTelemetryForOrganizationCommand

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

StartTelemetryEvaluationCommand

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

StartTelemetryEvaluationForOrganizationCommand

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

StopTelemetryEvaluationCommand

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

StopTelemetryEvaluationForOrganizationCommand

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

ObservabilityAdminClient Configuration

Parameter
Type
Description
defaultsMode
Optional
DefaultsMode | Provider<DefaultsMode>
The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK.
disableHostPrefix
Optional
boolean
Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation.
extensions
Optional
RuntimeExtension[]
Optional extensions
logger
Optional
Logger
Optional logger for logging debug/info/warn/error.
maxAttempts
Optional
number | Provider<number>
Value for how many times a request will be made at most in case of retry.
profile
Optional
string
Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options.
region
Optional
string | Provider<string>
The AWS region to which this client will send requests
requestHandler
Optional
__HttpHandlerUserInput
The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs.
retryMode
Optional
string | Provider<string>
Specifies which retry algorithm to use.
useDualstackEndpoint
Optional
boolean | Provider<boolean>
Enables IPv6/IPv4 dualstack endpoint.
useFipsEndpoint
Optional
boolean | Provider<boolean>
Enables FIPS compatible endpoints.
Additional config fields are described in the full configuration type: ObservabilityAdminClientConfig