DescribeObservabilityConfiguration
Return a full description of an AWS App Runner observability configuration resource.
Request Syntax
{
"ObservabilityConfigurationArn": "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.
- ObservabilityConfigurationArn
-
The Amazon Resource Name (ARN) of the App Runner observability configuration that you want a description for.
The ARN can be a full observability configuration ARN, or a partial ARN ending with either
.../nameor.../name/revision. If a revision isn't specified, the latest active revision is described.Type: String
Length Constraints: Minimum length of 1. Maximum length of 1011.
Pattern:
arn:aws(-[\w]+)*:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[0-9]{12}:(\w|\/|-){1,1011}Required: Yes
Response Syntax
{
"ObservabilityConfiguration": {
"CreatedAt": number,
"DeletedAt": number,
"Latest": boolean,
"ObservabilityConfigurationArn": "string",
"ObservabilityConfigurationName": "string",
"ObservabilityConfigurationRevision": number,
"Status": "string",
"TraceConfiguration": {
"Vendor": "string"
}
}
}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.
- ObservabilityConfiguration
-
A full description of the App Runner observability configuration that you specified in this request.
Type: ObservabilityConfiguration object
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
- ResourceNotFoundException
-
A resource doesn't exist for the specified Amazon Resource Name (ARN) in your AWS account.
HTTP Status Code: 400
Examples
Describe the latest active revision of an observability configuration
This example illustrates how to get a description of the latest active revision of an App Runner observability configuration. To describe the latest active revision, specify an ARN that ends with the configuration name, without the revision component.
In the example, two revisions exist. Therefore, revision 2 (the latest) is described. The resulting object shows "Latest":
true.
Note
The two revisions in our examples are identical, because App Runner doesn't yet support enough observability functionality to demonstrate two significantly different revisions (for example, multiple tracing vendors). We're including the two examples only to demonstrate the revisioning behavior during retrieval.
Sample Request
$ aws apprunner describe-observability-configuration --cli-input-json "`cat`"
{
"ObservabilityConfigurationArn": "arn:aws:apprunner:us-east-1:123456789012:observabilityconfiguration/xray-tracing"
}Sample Response
{
"ObservabilityConfiguration": {
"ObservabilityConfigurationArn": "arn:aws:apprunner:us-east-1:123456789012:observabilityconfiguration/xray-tracing/2/e76562f50d78042e819fead0f59672e6",
"ObservabilityConfigurationName": "xray-tracing",
"ObservabilityConfigurationRevision": 2,
"CreatedAt": "2021-02-25T17:42:59Z",
"Latest": true,
"Status": "ACTIVE",
"TraceConfiguration": {
"Vendor": "AWSXRAY"
}
}
}Describe a specific revision of an observability configuration
This example illustrates how to get a description of a specific revision of an App Runner observability configuration. To describe a specific revision, specify an ARN that includes the revision number.
In the example, several revisions exist and revision 1 is queried. The resulting object shows "Latest": false.
Sample Request
$ aws apprunner describe-observability-configuration --cli-input-json "`cat`"
{
"ObservabilityConfigurationArn": "arn:aws:apprunner:us-east-1:123456789012:observabilityconfiguration/xray-tracing/1"
}Sample Response
{
"ObservabilityConfiguration": {
"ObservabilityConfigurationArn": "arn:aws:apprunner:us-east-1:123456789012:observabilityconfiguration/xray-tracing/1/2f50e7656d7819fead0f59672e68042e",
"ObservabilityConfigurationName": "xray-tracing",
"ObservabilityConfigurationRevision": 1,
"CreatedAt": "2020-11-03T00:29:17Z",
"Latest": false,
"Status": "ACTIVE",
"TraceConfiguration": {
"Vendor": "AWSXRAY"
}
}
}See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
