Connect / Paginator / ListMetrics

ListMetrics

class Connect.Paginator.ListMetrics

paginator = client.get_paginator('list_metrics')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Connect.Client.list_metrics().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    InstanceId='string',
    Type='AWS_MANAGED'|'CUSTOMER_MANAGED',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• InstanceId (string) –

  [REQUIRED]

  The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

• Type (string) – The type of metrics to list. Valid values: AWS_MANAGED | CUSTOMER_MANAGED.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'MetricSummaryList': [
        {
            'Arn': 'string',
            'Id': 'string',
            'Name': 'string',
            'Status': 'PUBLISHED'|'SAVED',
            'Type': 'AWS_MANAGED'|'CUSTOMER_MANAGED',
            'LastModifiedRegion': 'string',
            'LastModifiedTime': datetime(2015, 1, 1)
        },
    ],

}

Response Structure

• (dict) –

  • MetricSummaryList (list) –

    The list of metric summaries.

    • (dict) –

      Contains summary information about a metric.

      • Arn (string) –

        The Amazon Resource Name (ARN) of the metric.

      • Id (string) –

        The identifier of the metric.

      • Name (string) –

        The name of the metric.

      • Status (string) –

        The publish status of the metric.

      • Type (string) –

        The type of the metric.

      • LastModifiedRegion (string) –

        The region where the metric was last modified.

      • LastModifiedTime (datetime) –

        The timestamp of when the metric was last modified.