Amazon Web Services, Inc.

CloudWatch Observability Admin Service

You can use Amazon CloudWatch Observability Admin to discover and understand the state of telemetry configuration in CloudWatch for your Amazon Web Services…

Developer tools#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

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.

Endpoints 45

Telemetry pipeline

  • POSTCreate telemetry pipeline/CreateTelemetryPipelineCreates a telemetry pipeline for processing and transforming telemetry data. The pipeline defines how data flows from sources through processors to…
  • POSTDelete telemetry pipeline/DeleteTelemetryPipelineDeletes a telemetry pipeline and its associated resources. This operation stops data processing and removes the pipeline configuration.
  • POSTGet telemetry pipeline/GetTelemetryPipelineRetrieves information about a specific telemetry pipeline, including its configuration, status, and metadata.
  • POSTList telemetry pipelines/ListTelemetryPipelinesReturns 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…
  • POSTUpdate telemetry pipeline/UpdateTelemetryPipelineUpdates the configuration of an existing telemetry pipeline. The following attributes cannot be updated after pipeline creation: Pipeline name - The pipeline…
  • POSTCreate centralization rule for organization/CreateCentralizationRuleForOrganizationCreates a centralization rule that applies across an Amazon Web Services Organization. This operation can only be called by the organization's management…
  • POSTCreate dataset integration/CreateDatasetIntegrationCreates a dataset integration for the caller's account in the current region and returns its ARN. To use this operation, you must have permission to access…
  • POSTCreate s3 table integration/CreateS3TableIntegrationCreates an integration between CloudWatch and S3 Tables for analytics. This integration enables querying CloudWatch telemetry data using analytics engines…
  • POSTCreate telemetry rule/CreateTelemetryRuleCreates a telemetry rule that defines how telemetry should be configured for Amazon Web Services resources in your account. The rule specifies which resources…
  • POSTCreate telemetry rule for organization/CreateTelemetryRuleForOrganizationCreates a telemetry rule that applies across an Amazon Web Services Organization. This operation can only be called by the organization's management account…
  • POSTDelete centralization rule for organization/DeleteCentralizationRuleForOrganizationDeletes an organization-wide centralization rule. This operation can only be called by the organization's management account or a delegated administrator…
  • POSTDelete dataset integration/DeleteDatasetIntegrationDeletes a dataset integration for the caller's account in the current region. This operation is idempotent; if you submit the same delete more than once, each…
  • POSTDelete s3 table integration/DeleteS3TableIntegrationDeletes an S3 Table integration and its associated data. This operation removes the connection between CloudWatch Observability Admin and S3 Tables.
  • POSTDelete telemetry rule/DeleteTelemetryRuleDeletes a telemetry rule from your account. Any telemetry configurations previously created by the rule will remain but no new resources will be configured by…
  • POSTDelete telemetry rule for organization/DeleteTelemetryRuleForOrganizationDeletes an organization-wide telemetry rule. This operation can only be called by the organization's management account or a delegated administrator account.
  • POSTGet centralization rule for organization/GetCentralizationRuleForOrganizationRetrieves the details of a specific organization centralization rule. This operation can only be called by the organization's management account or a…
  • POSTGet dataset integration/GetDatasetIntegrationReturns the dataset integration for the caller's account in the current region.
  • POSTGet s3 table integration/GetS3TableIntegrationRetrieves information about a specific S3 Table integration, including its configuration, status, and metadata.
  • POSTGet telemetry enrichment status/GetTelemetryEnrichmentStatusReturns the current status of the resource tags for telemetry feature, which enhances telemetry data with additional resource metadata from Resource Explorer.
  • POSTGet telemetry evaluation status/GetTelemetryEvaluationStatusReturns the current onboarding status of the telemetry config feature, including the status of the feature and reason the feature failed to start or stop.
  • POSTGet telemetry evaluation status for organization/GetTelemetryEvaluationStatusForOrganizationThis 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…
  • POSTGet telemetry rule/GetTelemetryRuleRetrieves the details of a specific telemetry rule in your account.
  • POSTGet telemetry rule for organization/GetTelemetryRuleForOrganizationRetrieves the details of a specific organization telemetry rule. This operation can only be called by the organization's management account or a delegated…
  • POSTList centralization rules for organization/ListCentralizationRulesForOrganizationLists all centralization rules in your organization. This operation can only be called by the organization's management account or a delegated administrator…
  • POSTList dataset integrations/ListDatasetIntegrationsReturns the dataset integrations in your account.
  • POSTList resource telemetry/ListResourceTelemetryReturns a list of telemetry configurations for Amazon Web Services resources supported by telemetry config. For more information, see Auditing CloudWatch…
  • POSTList resource telemetry for organization/ListResourceTelemetryForOrganizationReturns a list of telemetry configurations for Amazon Web Services resources supported by telemetry config in the organization.
  • POSTList s3 table integrations/ListS3TableIntegrationsLists all S3 Table integrations in your account. We recommend using pagination to ensure that the operation returns quickly and successfully.
  • POSTList tags for resource/ListTagsForResourceLists all tags attached to the specified resource. Supports telemetry rule resources and telemetry pipeline resources.
  • POSTList telemetry rules/ListTelemetryRulesLists all telemetry rules in your account. You can filter the results by specifying a rule name prefix.
  • POSTList telemetry rules for organization/ListTelemetryRulesForOrganizationLists all telemetry rules in your organization. This operation can only be called by the organization's management account or a delegated administrator account.
  • POSTStart telemetry enrichment/StartTelemetryEnrichmentEnables the resource tags for telemetry feature for your account, which enhances telemetry data with additional resource metadata from Resource Explorer to…
  • POSTStart telemetry evaluation/StartTelemetryEvaluationThis action begins onboarding the caller Amazon Web Services account to the telemetry config feature.
  • POSTStart telemetry evaluation for organization/StartTelemetryEvaluationForOrganizationThis actions begins onboarding the organization and all member accounts to the telemetry config feature.
  • POSTStop telemetry enrichment/StopTelemetryEnrichmentDisables the resource tags for telemetry feature for your account, stopping the enhancement of telemetry data with additional resource metadata.
  • POSTStop telemetry evaluation/StopTelemetryEvaluationThis action begins offboarding the caller Amazon Web Services account from the telemetry config feature.
  • POSTStop telemetry evaluation for organization/StopTelemetryEvaluationForOrganizationThis action offboards the Organization of the caller Amazon Web Services account from the telemetry config feature.
  • POSTTag resource/TagResourceAdds or updates tags for a resource. Supports telemetry rule resources and telemetry pipeline resources.
  • POSTTest telemetry pipeline/TestTelemetryPipelineTests a pipeline configuration with sample records to validate data processing before deployment. This operation helps ensure your pipeline configuration…
  • POSTUntag resource/UntagResourceRemoves tags from a resource. Supports telemetry rule resources and telemetry pipeline resources.
  • POSTUpdate centralization rule for organization/UpdateCentralizationRuleForOrganizationUpdates an existing centralization rule that applies across an Amazon Web Services Organization. This operation can only be called by the organization's…
  • POSTUpdate dataset integration/UpdateDatasetIntegrationUpdates a dataset integration for the caller's account in the current region. This operation is idempotent; if you submit the same update more than once, each…
  • POSTUpdate telemetry rule/UpdateTelemetryRuleUpdates an existing telemetry rule in your account. If multiple users attempt to modify the same telemetry rule simultaneously, a ConflictException is…
  • POSTUpdate telemetry rule for organization/UpdateTelemetryRuleForOrganizationUpdates an existing telemetry rule that applies across an Amazon Web Services Organization. This operation can only be called by the organization's management…
  • POSTValidate telemetry pipeline configuration/ValidateTelemetryPipelineConfigurationValidates a pipeline configuration without creating the pipeline. This operation checks the configuration for syntax errors and compatibility issues.

API details

Base URL
https://observabilityadmin.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
45 operations on 45 pathsPOST 45
Main resources
Telemetry pipeline 5
Description format
AWS Smithy model, API version 2018-05-10

How to test the CloudWatch Observability Admin Service in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the CloudWatch Observability Admin Service collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Create telemetry pipeline” (POST /CreateTelemetryPipeline), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the CloudWatch Observability Admin Service?

You can use Amazon CloudWatch Observability Admin to discover and understand the state of telemetry configuration in CloudWatch for your Amazon Web Services… It is listed under Developer tools and has 45 endpoints.

Who publishes the CloudWatch Observability Admin Service?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the CloudWatch Observability Admin Service?

Requests go to https://observabilityadmin.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the CloudWatch Observability Admin Service?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the CloudWatch Observability Admin Service have?

45 operations on 45 paths (45 POST). The largest groups are Telemetry pipeline.

Is forking the CloudWatch Observability Admin Service free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.