PrometheusService / Client / describe_scraper_logging_configuration

describe_scraper_logging_configuration

PrometheusService.Client.describe_scraper_logging_configuration(**kwargs)

Describes the logging configuration for a Amazon Managed Service for Prometheus scraper.

See also: AWS API Documentation

Request Syntax

response = client.describe_scraper_logging_configuration(
    scraperId='string'
)

Parameters:

scraperId (string) –

[REQUIRED]

The ID of the scraper whose logging configuration will be described.

Return type:

dict

Returns:

Response Syntax

{
    'status': {
        'statusCode': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'CREATION_FAILED'|'UPDATE_FAILED',
        'statusReason': 'string'
    },
    'scraperId': 'string',
    'loggingDestination': {
        'cloudWatchLogs': {
            'logGroupArn': 'string'
        }
    },
    'scraperComponents': [
        {
            'type': 'SERVICE_DISCOVERY'|'COLLECTOR'|'EXPORTER',
            'config': {
                'options': {
                    'string': 'string'
                }
            }
        },
    ],
    'modifiedAt': datetime(2015, 1, 1)
}

Response Structure

• (dict) –

  • status (dict) –

    The status of the scraper logging configuration.

    • statusCode (string) –

      The status code of the scraper logging configuration.

    • statusReason (string) –

      The reason for the current status of the scraper logging configuration.

  • scraperId (string) –

    The ID of the scraper.

  • loggingDestination (dict) –

    The destination where scraper logs are sent.

    Note

    This is a Tagged Union structure. Only one of the following top level keys will be set: cloudWatchLogs. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

    'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
    

    • cloudWatchLogs (dict) –

      The CloudWatch Logs configuration for the scraper logging destination.

      • logGroupArn (string) –

        The ARN of the CloudWatch log group to which the vended log data will be published. This log group must exist prior to calling this operation.

  • scraperComponents (list) –

    The list of scraper components configured for logging.

    • (dict) –

      A component of a Amazon Managed Service for Prometheus scraper that can be configured for logging.

      • type (string) –

        The type of the scraper component.

      • config (dict) –

        The configuration settings for the scraper component.

        • options (dict) –

          Configuration options for the scraper component.

          • (string) –

            • (string) –

  • modifiedAt (datetime) –

    The date and time when the logging configuration was last modified.

Exceptions

• PrometheusService.Client.exceptions.ValidationException

• PrometheusService.Client.exceptions.ResourceNotFoundException

• PrometheusService.Client.exceptions.AccessDeniedException

• PrometheusService.Client.exceptions.InternalServerException