Amazon Prometheus Service

2025/09/11 - Amazon Prometheus Service - 3 new api methods

Changes  Add Vended Logs APIs for Amazon Prometheus Managed Collector

UpdateScraperLoggingConfiguration (new) Link ¶

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

See also: AWS API Documentation

Request Syntax

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

string

param scraperId:

[REQUIRED]

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

type loggingDestination:

dict

param loggingDestination:

[REQUIRED]

The destination where scraper logs will be sent.

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

type scraperComponents:

list

param scraperComponents:

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

rtype:

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.

DeleteScraperLoggingConfiguration (new) Link ¶

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

See also: AWS API Documentation

Request Syntax

client.delete_scraper_logging_configuration(
    scraperId='string',
    clientToken='string'
)
type scraperId:

string

param scraperId:

[REQUIRED]

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

type clientToken:

string

param clientToken:

A unique, case-sensitive identifier that you provide to ensure the request is processed exactly once.

This field is autopopulated if not provided.

returns:

None

DescribeScraperLoggingConfiguration (new) Link ¶

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

See also: AWS API Documentation

Request Syntax

client.describe_scraper_logging_configuration(
    scraperId='string'
)
type scraperId:

string

param scraperId:

[REQUIRED]

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

rtype:

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.

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