Amazon Web Services, Inc.

Amazon CloudWatch Application Signals

Use CloudWatch Application Signals for comprehensive observability of your cloud-based applications. It enables real-time service health dashboards and helps…

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

Use CloudWatch Application Signals for comprehensive observability of your cloud-based applications. It enables real-time service health dashboards and helps you track long-term performance trends against your business goals. The application-centric view provides you with unified visibility across your applications, services, and dependencies, so you can proactively monitor and efficiently triage any issues that may arise, ensuring optimal customer experience. Application Signals provides the following benefits: Automatically collect metrics and traces from your applications, and display key metrics such as call volume, availability, latency, faults, and errors. Create and monitor service level objectives (SLOs). See a map of your application topology that Application Signals automatically discovers, that gives you a visual representation of your applications, dependencies, and their connectivity. Application Signals works with CloudWatch RUM, CloudWatch Synthetics canaries, and Amazon Web Services Service Catalog AppRegistry, to display your client pages, Synthetics canaries, and application names within dashboards and maps.

Endpoints 30

Service level objective

  • POSTCreate service level objective/sloCreates a service level objective (SLO), which can help you ensure that your critical business operations are meeting customer expectations. Use SLOs to set…
  • GETGet service level objective/slo/:IdReturns information about one SLO created in the account.
  • DELETEDelete service level objective/slo/:IdDeletes the specified service level objective.
  • PATCHUpdate service level objective/slo/:IdUpdates an existing service level objective (SLO). If you omit parameters, the previous values of those parameters are retained. You cannot change from a…
  • POSTList service level objectives/slos?OperationName=string&MaxResults=0&NextToken=string&IncludeLinkedAccounts=true&SloOwnerAwsAccountId=stringReturns a list of SLOs created in this account.
  • POSTBatch delete instrumentation configurations/batch-delete-instrumentation-configurationsDeletes multiple instrumentation configurations in a single request. Supports two mutually exclusive selection methods: By scope: Delete all configurations…
  • POSTBatch get service level objective budget report/budget-reportUse this operation to retrieve one or more service level objective (SLO) budget reports . An error budget is the amount of time or requests in an unhealthy…
  • PATCHBatch update exclusion windows/exclusion-windowsAdd or remove time window exclusions for one or more Service Level Objectives (SLOs).
  • POSTCreate instrumentation configuration/create-instrumentation-configurationCreates a dynamic instrumentation configuration for a specific code or endpoint location within a service and environment. Configurations are immutable after…
  • PUTPut grouping configuration/grouping-configurationCreates or updates the grouping configuration for this account. This operation allows you to define custom grouping attributes that determine how services are…
  • DELETEDelete grouping configuration/grouping-configurationDeletes the grouping configuration for this account. This removes all custom grouping attribute definitions that were previously configured.
  • POSTDelete instrumentation configuration/delete-instrumentation-configurationDeletes the specified instrumentation configuration. SDKs remove the instrumentation during their next sync after the configuration is deleted or expires.
  • POSTGet instrumentation configuration/get-instrumentation-configurationReturns the details of a single instrumentation configuration identified by service, environment, signal type, and location. Use this to audit or display…
  • POSTGet instrumentation configuration status/get-instrumentation-configuration-statusRetrieves the status history for a single instrumentation configuration during a specified time range. The response lists when the configuration was ACTIVE,…
  • POSTGet service/service?StartTime=string&EndTime=stringReturns information about a service discovered by Application Signals.
  • POSTList audit findings/auditFindings?StartTime=string&EndTime=stringReturns a list of audit findings that provide automated analysis of service behavior and root cause analysis. These findings help identify the most…
  • POSTList entity events/events?MaxResults=0&NextToken=stringReturns a list of change events for a specific entity, such as deployments, configuration changes, or other state-changing activities. This operation helps…
  • POSTList grouping attribute definitions/grouping-attribute-definitions?NextToken=string&AwsAccountId=string&IncludeLinkedAccounts=trueReturns the current grouping configuration for this account, including all custom grouping attribute definitions that have been configured. These definitions…
  • POSTList instrumentation configurations/list-instrumentation-configurationsReturns all active instrumentation configurations for a service and environment. SDKs use this operation to sync configurations and apply client-side filters…
  • POSTList service dependencies/service-dependencies?StartTime=string&EndTime=string&MaxResults=0&NextToken=stringReturns a list of service dependencies of the service that you specify. A dependency is an infrastructure component that an operation of this service connects…
  • POSTList service dependents/service-dependents?StartTime=string&EndTime=string&MaxResults=0&NextToken=stringReturns the list of dependents that invoked the specified service during the provided time range. Dependents include other services, CloudWatch Synthetics…
  • GETList service level objective exclusion windows/slo/:Id/exclusion-windows?MaxResults=0&NextToken=stringRetrieves all exclusion windows configured for a specific SLO.
  • POSTList service operations/service-operations?StartTime=string&EndTime=string&MaxResults=0&NextToken=stringReturns a list of the operations of this service that have been discovered by Application Signals. Only the operations that were invoked during the specified…
  • POSTList service states/service/statesReturns information about the last deployment and other change states of services. This API provides visibility into recent changes that may have affected…
  • GETList services/services?StartTime=string&EndTime=string&MaxResults=0&NextToken=string&IncludeLinkedAccounts=true&AwsAccountId=stringReturns a list of services that have been discovered by Application Signals. A service represents a minimum logical and transactional unit that completes a…
  • GETList tags for resource/tags?ResourceArn=stringDisplays the tags associated with a CloudWatch resource. Tags can be assigned to service level objectives.
  • POSTReport instrumentation configuration status/report-instrumentation-configuration-statusReports the status of one or more instrumentation configurations from SDK instances. Use this to record when configurations become ready, hit errors, become…
  • POSTStart discovery/start-discoveryEnables this Amazon Web Services account to be able to use CloudWatch Application Signals by creating the AWSServiceRoleForCloudWatchApplicationSignals…
  • POSTTag resource/tag-resourceAssigns one or more tags (key-value pairs) to the specified CloudWatch resource, such as a service level objective. Tags can help you organize and categorize…
  • POSTUntag resource/untag-resourceRemoves one or more tags from the specified resource.

API details

Base URL
https://application-signals.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
30 operations on 27 pathsPOST 21GET 4PATCH 2DELETE 2PUT 1
Main resources
Service level objective 5
Description format
AWS Smithy model, API version 2024-04-15

How to test the Amazon CloudWatch Application Signals 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 Amazon CloudWatch Application Signals 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 service level objective” (POST /slo), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Amazon CloudWatch Application Signals?

Use CloudWatch Application Signals for comprehensive observability of your cloud-based applications. It enables real-time service health dashboards and helps… It is listed under Developer tools and has 30 endpoints.

Who publishes the Amazon CloudWatch Application Signals?

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 Amazon CloudWatch Application Signals?

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

How do I authenticate with the Amazon CloudWatch Application Signals?

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

How many endpoints does the Amazon CloudWatch Application Signals have?

30 operations on 27 paths (21 POST, 4 GET, 2 PATCH, 2 DELETE, 1 PUT). The largest groups are Service level objective.

Is forking the Amazon CloudWatch Application Signals 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.