PrometheusService / Client / list_scrapers

list_scrapers

PrometheusService.Client.list_scrapers(**kwargs)

Lists all scrapers in a customer account, including scrapers being created or deleted. You may provide filters to return a more specific list of results.

See also: AWS API Documentation

Request Syntax

response = client.list_scrapers(
    filters={
        'string': [
            'string',
        ]
    },
    nextToken='string',
    maxResults=123
)

Parameters:

• filters (dict) –

  A list of scraper filters.

  • (string) –

    The name of the key to filter by. Currently supported filter keys are ‘status’, ‘sourceArn’, ‘destinationArn’, and ‘alias’.

    • (list) –

      The values of the given key to filter by.

      • (string) –

        The value of a given key to filter by.

• nextToken (string) – Pagination token to request the next page in a paginated list. This token is obtained from the output of the previous ListScrapers request.

• maxResults (integer) – Maximum results to return in response (default=100, maximum=1000).

Return type:

dict

Returns:

Response Syntax

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

Response Structure

• (dict) –

  Represents the output of a ListScrapers operation.

  • scrapers (list) –

    The list of scrapers, filtered down if a set of filters was provided in the request.

    • (dict) –

      Represents a summary of the properties of a scraper.

      • alias (string) –

        Alias of this scraper.

      • scraperId (string) –

        Unique string identifying this scraper.

      • arn (string) –

        The Amazon Resource Name (ARN) of this scraper.

      • roleArn (string) –

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

      • status (dict) –

        The status of this scraper.

        • statusCode (string) –

          Status code of this scraper.

      • createdAt (datetime) –

        The time when the scraper was created.

      • lastModifiedAt (datetime) –

        The time when the scraper was last modified.

      • tags (dict) –

        The tags of this scraper.

        • (string) –

          The key of the tag.

          Constraints: Tag keys are case-sensitive and accept a maximum of 128 Unicode characters. Valid characters are Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @ May not begin with aws:.

          • (string) –

            The value of the tag.

            Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. Valid characters are Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @

      • statusReason (string) –

        The reason for failure if any.

      • source (dict) –

        The source that the scraper is discovering and collecting metrics from.

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

          A representation of an EKS source.

          • clusterArn (string) –

            The ARN of an EKS cluster.

          • securityGroupIds (list) –

            A list of security group IDs specified for VPC configuration.

            • (string) –

              ID of a VPC security group.

          • subnetIds (list) –

            A list of subnet IDs specified for VPC configuration.

            • (string) –

              ID of a VPC subnet.

      • destination (dict) –

        The destination that the scraper is producing 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) –

          A representation of an AMP destination.

          • workspaceArn (string) –

            The ARN of an AMP workspace.

  • nextToken (string) –

    Pagination token to use when requesting the next page in this list.

Exceptions

• PrometheusService.Client.exceptions.ThrottlingException

• PrometheusService.Client.exceptions.ValidationException

• PrometheusService.Client.exceptions.AccessDeniedException

• PrometheusService.Client.exceptions.InternalServerException