AppRunner / Client / describe_observability_configuration

describe_observability_configuration#

AppRunner.Client.describe_observability_configuration(**kwargs)#

Return a full description of an App Runner observability configuration resource.

See also: AWS API Documentation

Request Syntax

response = client.describe_observability_configuration(
    ObservabilityConfigurationArn='string'
)
Parameters:

ObservabilityConfigurationArn (string) –

[REQUIRED]

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 .../name or ``…/name/revision ``. If a revision isn’t specified, the latest active revision is described.

Return type:

dict

Returns:

Response Syntax

{
    'ObservabilityConfiguration': {
        'ObservabilityConfigurationArn': 'string',
        'ObservabilityConfigurationName': 'string',
        'TraceConfiguration': {
            'Vendor': 'AWSXRAY'
        },
        'ObservabilityConfigurationRevision': 123,
        'Latest': True|False,
        'Status': 'ACTIVE'|'INACTIVE',
        'CreatedAt': datetime(2015, 1, 1),
        'DeletedAt': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) –

    • ObservabilityConfiguration (dict) –

      A full description of the App Runner observability configuration that you specified in this request.

      • ObservabilityConfigurationArn (string) –

        The Amazon Resource Name (ARN) of this observability configuration.

      • ObservabilityConfigurationName (string) –

        The customer-provided observability configuration name. It can be used in multiple revisions of a configuration.

      • TraceConfiguration (dict) –

        The configuration of the tracing feature within this observability configuration. If not specified, tracing isn’t enabled.

        • Vendor (string) –

          The implementation provider chosen for tracing App Runner services.

      • ObservabilityConfigurationRevision (integer) –

        The revision of this observability configuration. It’s unique among all the active configurations ( "Status": "ACTIVE") that share the same ObservabilityConfigurationName.

      • Latest (boolean) –

        It’s set to true for the configuration with the highest Revision among all configurations that share the same ObservabilityConfigurationName. It’s set to false otherwise.

      • Status (string) –

        The current state of the observability configuration. If the status of a configuration revision is INACTIVE, it was deleted and can’t be used. Inactive configuration revisions are permanently removed some time after they are deleted.

      • CreatedAt (datetime) –

        The time when the observability configuration was created. It’s in Unix time stamp format.

      • DeletedAt (datetime) –

        The time when the observability configuration was deleted. It’s in Unix time stamp format.

Exceptions

  • AppRunner.Client.exceptions.InvalidRequestException

  • AppRunner.Client.exceptions.InternalServiceErrorException

  • AppRunner.Client.exceptions.ResourceNotFoundException