Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

ListObservabilityConfigurations

Returns a list of active AWS App Runner observability configurations in your AWS account. You can query the revisions for a specific configuration name or the revisions for all active configurations in your account. You can optionally query only the latest revision of each requested name.

To retrieve a full description of a particular configuration revision, call DescribeObservabilityConfiguration and provide one of the ARNs returned by ListObservabilityConfigurations.

Request Syntax


{
   "LatestOnly": boolean,
   "MaxResults": number,
   "NextToken": "string",
   "ObservabilityConfigurationName": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

LatestOnly

Set to true to list only the latest revision for each requested configuration name.

Set to false to list all revisions for each requested configuration name.

Default: true

Type: Boolean

Required: No

MaxResults

The maximum number of results to include in each response (result page). It's used for a paginated request.

If you don't specify MaxResults, the request retrieves all available results in a single response.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

NextToken

A token from a previous result page. It's used for a paginated request. The request retrieves the next result page. All other parameter values must be identical to the ones that are specified in the initial request.

If you don't specify NextToken, the request retrieves the first result page.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: .*

Required: No

ObservabilityConfigurationName

The name of the App Runner observability configuration that you want to list. If specified, App Runner lists revisions that share this name. If not specified, App Runner returns revisions of all active configurations.

Type: String

Length Constraints: Minimum length of 4. Maximum length of 32.

Pattern: [A-Za-z0-9][A-Za-z0-9\-_]{3,31}

Required: No

Response Syntax


{
   "NextToken": "string",
   "ObservabilityConfigurationSummaryList": [ 
      { 
         "ObservabilityConfigurationArn": "string",
         "ObservabilityConfigurationName": "string",
         "ObservabilityConfigurationRevision": number
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NextToken

The token that you can pass in a subsequent request to get the next result page. It's returned in a paginated request.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: .*

ObservabilityConfigurationSummaryList

A list of summary information records for observability configurations. In a paginated request, the request returns up to MaxResults records for each call.

Type: Array of ObservabilityConfigurationSummary objects

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServiceErrorException

An unexpected service exception occurred.

HTTP Status Code: 500

InvalidRequestException

One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.

HTTP Status Code: 400

Examples

Paginated listing of App Runner observability configurations

This example illustrates how to list all App Runner observability configurations in your AWS account. Up to five observability configurations are listed in each response. We set LatestOnly to false to get all revisions of all active configurations.

In this example, the response includes two results and there aren't additional ones, so no NextToken is returned.

Sample Request


$ aws apprunner list-observability-configurations --cli-input-json "`cat`"
{
  "LatestOnly": false,
  "MaxResults": 5
}

Sample Response


{
  "ObservabilityConfigurationSummaryList": [
    {
      "ObservabilityConfigurationArn": "arn:aws:apprunner:us-east-1:123456789012:observabilityconfiguration/xray-tracing/1/2f50e7656d7819fead0f59672e68042e",
      "ObservabilityConfigurationName": "xray-tracing",
      "ObservabilityConfigurationRevision": 1
    },
    {
      "ObservabilityConfigurationArn": "arn:aws:apprunner:us-east-1:123456789012:observabilityconfiguration/xray-tracing/2/e76562f50d78042e819fead0f59672e6",
      "ObservabilityConfigurationName": "xray-tracing",
      "ObservabilityConfigurationRevision": 2
    }
  ]
}