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

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 centralization rule that applies across an Amazon Web Services Organization.

Creates an integration between CloudWatch and S3 Tables for analytics.

Creates a telemetry pipeline for processing and transforming telemetry data.

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 an organization-wide centralization rule.

Deletes an S3 Table integration and its associated data.

Deletes a telemetry pipeline and its associated resources.

Deletes a telemetry rule from your account.

Deletes an organization-wide telemetry rule.

Retrieves the details of a specific organization centralization rule.

Retrieves information about a specific S3 Table integration, including its configuration, status, and metadata.

Returns the current status of the resource tags for telemetry feature, which enhances telemetry data with additional resource metadata from Resource Explorer.

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 information about a specific telemetry pipeline, including its configuration, status, and metadata.

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

Retrieves the details of a specific organization telemetry rule.

Lists all centralization rules in your organization.

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 S3 Table integrations in your account.

Lists all tags attached to the specified resource.

Returns a list of telemetry pipelines in your account.

Lists all telemetry rules in your account.

Lists all telemetry rules in your organization.

Enables the resource tags for telemetry feature for your account, which enhances telemetry data with additional resource metadata from Resource Explorer to provide richer context for monitoring and observability.

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.

Disables the resource tags for telemetry feature for your account, stopping the enhancement of telemetry data with additional resource metadata.

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 resource.

Tests a pipeline configuration with sample records to validate data processing before deployment.

Removes tags from a resource.

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

Updates the configuration of an existing telemetry pipeline.

Updates an existing telemetry rule in your account.

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

Validates a pipeline configuration without creating the pipeline.

Link to this section Functions

Link to this function

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

View Source

Creates a centralization 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

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

View Source

Creates an integration between CloudWatch and S3 Tables for analytics.

This integration enables querying CloudWatch telemetry data using analytics engines like Amazon Athena, Amazon Redshift, and Apache Spark.

Link to this function

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

View Source

Creates a telemetry pipeline for processing and transforming telemetry data.

The pipeline defines how data flows from sources through processors to destinations, enabling data transformation and delivering capabilities.

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_centralization_rule_for_organization(client, input, options \\ [])

View Source

Deletes an organization-wide centralization rule.

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

Link to this function

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

View Source

Deletes an S3 Table integration and its associated data.

This operation removes the connection between CloudWatch Observability Admin and S3 Tables.

Link to this function

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

View Source

Deletes a telemetry pipeline and its associated resources.

This operation stops data processing and removes the pipeline configuration.

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_centralization_rule_for_organization(client, input, options \\ [])

View Source

Retrieves the details of a specific organization centralization rule.

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

Link to this function

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

View Source

Retrieves information about a specific S3 Table integration, including its configuration, status, and metadata.

Link to this function

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

View Source

Returns the current status of the resource tags for telemetry feature, which enhances telemetry data with additional resource metadata from Resource Explorer.

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_pipeline(client, input, options \\ [])

View Source

Retrieves information about a specific telemetry pipeline, including its configuration, status, and metadata.

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_centralization_rules_for_organization(client, input, options \\ [])

View Source

Lists all centralization 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

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_s3_table_integrations(client, input, options \\ [])

View Source

Lists all S3 Table integrations in your account.

We recommend using pagination to ensure that the operation returns quickly and successfully.

Link to this function

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

View Source

Lists all tags attached to the specified resource.

Supports telemetry rule resources and telemetry pipeline resources.

Link to this function

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

View Source

Returns a list of telemetry pipelines in your account.

Returns up to 100 results. If more than 100 telemetry pipelines exist, include the NextToken value from the response to retrieve the next set of results.

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_enrichment(client, input, options \\ [])

View Source

Enables the resource tags for telemetry feature for your account, which enhances telemetry data with additional resource metadata from Resource Explorer to provide richer context for monitoring and observability.

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_enrichment(client, input, options \\ [])

View Source

Disables the resource tags for telemetry feature for your account, stopping the enhancement of telemetry data with additional resource metadata.

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 resource.

Supports telemetry rule resources and telemetry pipeline resources.

Link to this function

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

View Source

Tests a pipeline configuration with sample records to validate data processing before deployment.

This operation helps ensure your pipeline configuration works as expected.

Link to this function

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

View Source

Removes tags from a resource.

Supports telemetry rule resources and telemetry pipeline resources.

Link to this function

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

View Source

Updates an existing centralization 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

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

View Source

Updates the configuration of an existing telemetry pipeline.

The following attributes cannot be updated after pipeline creation:

Pipeline name - The pipeline name is immutable

Pipeline ARN - The ARN is automatically generated and cannot be changed

Source type - Once a pipeline is created with a specific source type (such as S3, CloudWatch Logs, GitHub, or third-party sources), it cannot be changed to a different source type

Processors can be added, removed, or modified. However, some processors are not supported for third-party pipelines and cannot be added through updates.

source-specific-update-rules

Source-Specific Update Rules

definitions

Definitions

cloudwatch-logs-sources-vended-and-custom

CloudWatch Logs Sources (Vended and Custom)

Updatable: sts_role_arn

Fixed: data_source_name, data_source_type, sink (must remain @original)

s3-sources-crowdstrike-zscaler-sentinelone-custom

S3 Sources (Crowdstrike, Zscaler, SentinelOne, Custom)

Updatable: All SQS configuration parameters, sts_role_arn, codec settings, compression type, bucket ownership settings, sink log group

Fixed: notification_type, aws.region

github-audit-logs

GitHub Audit Logs

Updatable: All Amazon Web Services Secrets Manager attributes, scope (can switch between ORGANIZATION/ENTERPRISE), organization or enterprise name, range, authentication credentials (PAT or GitHub App)

microsoft-sources-entra-id-office365-windows

Microsoft Sources (Entra ID, Office365, Windows)

Updatable: All Amazon Web Services Secrets Manager attributes, tenant_id, workspace_id (Windows only), OAuth2 credentials (client_id, client_secret)

okta-sources-sso-auth0

Okta Sources (SSO, Auth0)

Updatable: All Amazon Web Services Secrets Manager attributes, domain, range, OAuth2 credentials (client_id, client_secret)

palo-alto-networks

Palo Alto Networks

Updatable: All Amazon Web Services Secrets Manager attributes, hostname, basic authentication credentials (username, password)

servicenow-cmdb

ServiceNow CMDB

Updatable: All Amazon Web Services Secrets Manager attributes, instance_url, range, OAuth2 credentials (client_id, client_secret)

wiz-cnapp

Wiz CNAPP

Updatable: All Amazon Web Services Secrets Manager attributes, region, range, OAuth2 credentials (client_id, client_secret)

Link to this function

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

View Source

Updates an existing telemetry rule in your account.

If multiple users attempt to modify the same telemetry rule simultaneously, a ConflictException is returned to provide specific error information for concurrent modification scenarios.

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.

Link to this function

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

View Source

Validates a pipeline configuration without creating the pipeline.

This operation checks the configuration for syntax errors and compatibility issues.