Connect / Client / list_metrics

list_metrics¶

Connect.Client.list_metrics(**kwargs)¶

Retrieves a paginated list of metric summaries for the specified Connect Customer instance. Use pagination to ensure that the operation returns quickly and successfully.

Request Syntax

response = client.list_metrics(
    InstanceId='string',
    Type='AWS_MANAGED'|'CUSTOMER_MANAGED',
    MaxResults=123,
    NextToken='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.
MaxResults (integer) – The maximum number of results to return per page.
NextToken (string) – The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

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)
        },
    ],
    'NextToken': 'string'
}

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.
- NextToken (string) –
  
  If there are additional results, this is the token for the next set of results.

Exceptions

Connect.Client.exceptions.InvalidRequestException
Connect.Client.exceptions.InvalidParameterException
Connect.Client.exceptions.ResourceNotFoundException
Connect.Client.exceptions.AccessDeniedException
Connect.Client.exceptions.ThrottlingException
Connect.Client.exceptions.InternalServiceException