LookoutMetrics / Client / list_metric_sets

list_metric_sets#

LookoutMetrics.Client.list_metric_sets(**kwargs)#

Lists the datasets in the current AWS Region.

Amazon Lookout for Metrics API actions are eventually consistent. If you do a read operation on a resource immediately after creating or modifying it, use retries to allow time for the write operation to complete.

Request Syntax

response = client.list_metric_sets(
    AnomalyDetectorArn='string',
    MaxResults=123,
    NextToken='string'
)

Parameters:

AnomalyDetectorArn (string) – The ARN of the anomaly detector containing the metrics sets to list.
MaxResults (integer) – The maximum number of results to return.
NextToken (string) – If the result of the previous request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.

Return type:

dict

Returns:

Response Syntax

{
    'MetricSetSummaryList': [
        {
            'MetricSetArn': 'string',
            'AnomalyDetectorArn': 'string',
            'MetricSetDescription': 'string',
            'MetricSetName': 'string',
            'CreationTime': datetime(2015, 1, 1),
            'LastModificationTime': datetime(2015, 1, 1),
            'Tags': {
                'string': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- MetricSetSummaryList (list) –
  
  A list of the datasets in the AWS Region, with configuration details for each.
  - (dict) –
    
    Contains information about a dataset.
    - MetricSetArn (string) –
      
      The ARN of the dataset.
    - AnomalyDetectorArn (string) –
      
      The ARN of the detector to which the dataset belongs.
    - MetricSetDescription (string) –
      
      The description of the dataset.
    - MetricSetName (string) –
      
      The name of the dataset.
    - CreationTime (datetime) –
      
      The time at which the dataset was created.
    - LastModificationTime (datetime) –
      
      The time at which the dataset was last modified.
    - Tags (dict) –
      
      The dataset’s tags.
      - (string) –
        
        (string) –
- NextToken (string) –
  
  If the response is truncated, the list call returns this token. To retrieve the next set of results, use the token in the next list request.

Exceptions

LookoutMetrics.Client.exceptions.ResourceNotFoundException
LookoutMetrics.Client.exceptions.ValidationException
LookoutMetrics.Client.exceptions.AccessDeniedException
LookoutMetrics.Client.exceptions.TooManyRequestsException
LookoutMetrics.Client.exceptions.InternalServerException