PrometheusService / Client / describe_scraper

describe_scraper

PrometheusService.Client.describe_scraper(**kwargs)

The DescribeScraper operation displays information about an existing scraper.

See also: AWS API Documentation

Request Syntax

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

Parameters:

scraperId (string) –

[REQUIRED]

The ID of the scraper to describe.

Return type:

dict

Returns:

Response Syntax

{
    'scraper': {
        'alias': 'string',
        'arn': 'string',
        'createdAt': datetime(2015, 1, 1),
        'destination': {
            'ampConfiguration': {
                'workspaceArn': 'string'
            }
        },
        'lastModifiedAt': datetime(2015, 1, 1),
        'roleArn': 'string',
        'scrapeConfiguration': {
            'configurationBlob': b'bytes'
        },
        'scraperId': 'string',
        'source': {
            'eksConfiguration': {
                'clusterArn': 'string',
                'securityGroupIds': [
                    'string',
                ],
                'subnetIds': [
                    'string',
                ]
            }
        },
        'status': {
            'statusCode': 'CREATING'|'UPDATING'|'ACTIVE'|'DELETING'|'CREATION_FAILED'|'UPDATE_FAILED'|'DELETION_FAILED'
        },
        'statusReason': 'string',
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

• (dict) –

  Represents the output of a DescribeScraper operation.

  • scraper (dict) –

    Contains details about the scraper.

    • alias (string) –

      (Optional) A name associated with the scraper.

    • arn (string) –

      The Amazon Resource Name (ARN) of the scraper. For example, arn:aws:aps:<region>:123456798012:scraper/s-example1-1234-abcd-5678-ef9012abcd34.

    • createdAt (datetime) –

      The date and time that the scraper was created.

    • destination (dict) –

      The Amazon Managed Service for Prometheus workspace the scraper sends metrics to.

      Note

      This is a Tagged Union structure. Only one of the following top level keys will be set: ampConfiguration. 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'}
      

      • ampConfiguration (dict) –

        The Amazon Managed Service for Prometheus workspace to send metrics to.

        • workspaceArn (string) –

          ARN of the Amazon Managed Service for Prometheus workspace.

    • lastModifiedAt (datetime) –

      The date and time that the scraper was last modified.

    • roleArn (string) –

      The Amazon Resource Name (ARN) of the IAM role that provides permissions for the scraper to discover and collect metrics on your behalf.

      For example, arn:aws:iam::123456789012:role/service-role/AmazonGrafanaServiceRole-12example.

    • scrapeConfiguration (dict) –

      The configuration in use by the scraper.

      Note

      This is a Tagged Union structure. Only one of the following top level keys will be set: configurationBlob. 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'}
      

      • configurationBlob (bytes) –

        The base 64 encoded scrape configuration file.

    • scraperId (string) –

      The ID of the scraper. For example, s-example1-1234-abcd-5678-ef9012abcd34.

    • source (dict) –

      The Amazon EKS cluster from which the scraper collects metrics.

      Note

      This is a Tagged Union structure. Only one of the following top level keys will be set: eksConfiguration. 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'}
      

      • eksConfiguration (dict) –

        The Amazon EKS cluster from which a scraper collects metrics.

        • clusterArn (string) –

          ARN of the Amazon EKS cluster.

        • securityGroupIds (list) –

          A list of the security group IDs for the Amazon EKS cluster VPC configuration.

          • (string) –

            ID of a VPC security group.

        • subnetIds (list) –

          A list of subnet IDs for the Amazon EKS cluster VPC configuration.

          • (string) –

            ID of a VPC subnet.

    • status (dict) –

      A structure that contains the current status of the scraper.

      • statusCode (string) –

        The current status of the scraper.

    • statusReason (string) –

      If there is a failure, the reason for the failure.

    • tags (dict) –

      (Optional) The list of tag keys and values associated with the scraper.

      • (string) –

        The key of the tag. Must not begin with aws:.

        • (string) –

          The value of the tag.

Exceptions

• PrometheusService.Client.exceptions.ThrottlingException

• PrometheusService.Client.exceptions.ValidationException

• PrometheusService.Client.exceptions.ResourceNotFoundException

• PrometheusService.Client.exceptions.AccessDeniedException

• PrometheusService.Client.exceptions.InternalServerException