AppRunner / Client / list_observability_configurations

list_observability_configurations#

AppRunner.Client.list_observability_configurations(**kwargs)#

Returns a list of active App Runner observability configurations in your Amazon Web Services 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 and provide one of the ARNs returned by ListObservabilityConfigurations.

See also: AWS API Documentation

Request Syntax

response = client.list_observability_configurations(
    ObservabilityConfigurationName='string',
    LatestOnly=True|False,
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • ObservabilityConfigurationName (string) – 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.

  • LatestOnly (boolean) –

    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

  • MaxResults (integer) –

    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.

  • NextToken (string) –

    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.

Return type:

dict

Returns:

Response Syntax

{
    'ObservabilityConfigurationSummaryList': [
        {
            'ObservabilityConfigurationArn': 'string',
            'ObservabilityConfigurationName': 'string',
            'ObservabilityConfigurationRevision': 123
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • ObservabilityConfigurationSummaryList (list) –

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

      • (dict) –

        Provides summary information about an App Runner observability configuration resource.

        This type contains limited information about an observability configuration. It includes only identification information, without configuration details. It’s returned by the ListObservabilityConfigurations action. Complete configuration information is returned by the CreateObservabilityConfiguration, DescribeObservabilityConfiguration, and DeleteObservabilityConfiguration actions using the ObservabilityConfiguration type.

        • 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.

        • ObservabilityConfigurationRevision (integer) –

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

    • NextToken (string) –

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

Exceptions

  • AppRunner.Client.exceptions.InvalidRequestException

  • AppRunner.Client.exceptions.InternalServiceErrorException