View Source AWS.ObservabilityAdmin (aws-elixir v1.0.9)

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.

Link to this section Summary

Functions

Creates a telemetry rule that defines how telemetry should be configured for Amazon Web Services resources in your account.

Creates a telemetry rule that applies across an Amazon Web Services Organization.

Deletes a telemetry rule from your account.

Deletes an organization-wide telemetry rule.

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 returns the onboarding status of the telemetry configuration feature for the organization.

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

Retrieves the details of a specific organization telemetry rule.

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

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

Lists all tags attached to the specified telemetry rule resource.

Lists all telemetry rules in your account.

Lists all telemetry rules in your organization.

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

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

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

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

Adds or updates tags for a telemetry rule resource.

Removes tags from a telemetry rule resource.

Updates an existing telemetry rule in your account.

Updates an existing telemetry rule that applies across an Amazon Web Services Organization.

Link to this section Functions

Link to this function

create_telemetry_rule(client, input, options \\ [])

View Source

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.

Link to this function

create_telemetry_rule_for_organization(client, input, options \\ [])

View Source

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.

Link to this function

delete_telemetry_rule(client, input, options \\ [])

View Source

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.

Link to this function

delete_telemetry_rule_for_organization(client, input, options \\ [])

View Source

Deletes an organization-wide telemetry rule.

This operation can only be called by the organization's management account or a delegated administrator account.

Link to this function

get_telemetry_evaluation_status(client, input, options \\ [])

View Source

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.

Link to this function

get_telemetry_evaluation_status_for_organization(client, input, options \\ [])

View Source

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.

Link to this function

get_telemetry_rule(client, input, options \\ [])

View Source

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

Link to this function

get_telemetry_rule_for_organization(client, input, options \\ [])

View Source

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.

Link to this function

list_resource_telemetry(client, input, options \\ [])

View Source

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

For more information, see Auditing CloudWatch telemetry configurations.

Link to this function

list_resource_telemetry_for_organization(client, input, options \\ [])

View Source

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

Link to this function

list_tags_for_resource(client, input, options \\ [])

View Source

Lists all tags attached to the specified telemetry rule resource.

Link to this function

list_telemetry_rules(client, input, options \\ [])

View Source

Lists all telemetry rules in your account.

You can filter the results by specifying a rule name prefix.

Link to this function

list_telemetry_rules_for_organization(client, input, options \\ [])

View Source

Lists all telemetry rules in your organization.

This operation can only be called by the organization's management account or a delegated administrator account.

Link to this function

start_telemetry_evaluation(client, input, options \\ [])

View Source

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

Link to this function

start_telemetry_evaluation_for_organization(client, input, options \\ [])

View Source

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

Link to this function

stop_telemetry_evaluation(client, input, options \\ [])

View Source

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

Link to this function

stop_telemetry_evaluation_for_organization(client, input, options \\ [])

View Source

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

Link to this function

tag_resource(client, input, options \\ [])

View Source

Adds or updates tags for a telemetry rule resource.

Link to this function

untag_resource(client, input, options \\ [])

View Source

Removes tags from a telemetry rule resource.

Link to this function

update_telemetry_rule(client, input, options \\ [])

View Source

Updates an existing telemetry rule in your account.

Link to this function

update_telemetry_rule_for_organization(client, input, options \\ [])

View Source

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.