PrometheusService / Client / update_scraper_logging_configuration

update_scraper_logging_configuration

PrometheusService.Client.update_scraper_logging_configuration(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.update_scraper_logging_configuration(
    scraperId='string',
    loggingDestination={
        'cloudWatchLogs': {
            'logGroupArn': 'string'
        }
    },
    scraperComponents=[
        {
            'type': 'SERVICE_DISCOVERY'|'COLLECTOR'|'EXPORTER',
            'config': {
                'options': {
                    'string': 'string'
                }
            }
        },
    ]
)

Parameters:

• scraperId (string) –

  [REQUIRED]

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

• loggingDestination (dict) –

  [REQUIRED]

  The destination where scraper logs will be sent.

  Note

  This is a Tagged Union structure. Only one of the following top level keys can be set: cloudWatchLogs.

  • cloudWatchLogs (dict) –

    The CloudWatch Logs configuration for the scraper logging destination.

    • logGroupArn (string) – [REQUIRED]

      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 to configure for logging.

  • (dict) –

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

    • type (string) – [REQUIRED]

      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) –

Return type:

dict

Returns:

Response Syntax

{
    'status': {
        'statusCode': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'CREATION_FAILED'|'UPDATE_FAILED',
        'statusReason': 'string'
    }
}

Response Structure

• (dict) –

  • status (dict) –

    The status of the updated 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.

Exceptions

• PrometheusService.Client.exceptions.ConflictException

• PrometheusService.Client.exceptions.ValidationException

• PrometheusService.Client.exceptions.ResourceNotFoundException

• PrometheusService.Client.exceptions.AccessDeniedException

• PrometheusService.Client.exceptions.InternalServerException