LookoutMetrics / Client / describe_metric_set

describe_metric_set#

LookoutMetrics.Client.describe_metric_set(**kwargs)#

Describes a dataset.

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.describe_metric_set(
    MetricSetArn='string'
)

Parameters:

MetricSetArn (string) –

[REQUIRED]

The ARN of the dataset.

Return type:

dict

Returns:

Response Syntax

{
    'MetricSetArn': 'string',
    'AnomalyDetectorArn': 'string',
    'MetricSetName': 'string',
    'MetricSetDescription': 'string',
    'CreationTime': datetime(2015, 1, 1),
    'LastModificationTime': datetime(2015, 1, 1),
    'Offset': 123,
    'MetricList': [
        {
            'MetricName': 'string',
            'AggregationFunction': 'AVG'|'SUM',
            'Namespace': 'string'
        },
    ],
    'TimestampColumn': {
        'ColumnName': 'string',
        'ColumnFormat': 'string'
    },
    'DimensionList': [
        'string',
    ],
    'MetricSetFrequency': 'P1D'|'PT1H'|'PT10M'|'PT5M',
    'Timezone': 'string',
    'MetricSource': {
        'S3SourceConfig': {
            'RoleArn': 'string',
            'TemplatedPathList': [
                'string',
            ],
            'HistoricalDataPathList': [
                'string',
            ],
            'FileFormatDescriptor': {
                'CsvFormatDescriptor': {
                    'FileCompression': 'NONE'|'GZIP',
                    'Charset': 'string',
                    'ContainsHeader': True|False,
                    'Delimiter': 'string',
                    'HeaderList': [
                        'string',
                    ],
                    'QuoteSymbol': 'string'
                },
                'JsonFormatDescriptor': {
                    'FileCompression': 'NONE'|'GZIP',
                    'Charset': 'string'
                }
            }
        },
        'AppFlowConfig': {
            'RoleArn': 'string',
            'FlowName': 'string'
        },
        'CloudWatchConfig': {
            'RoleArn': 'string',
            'BackTestConfiguration': {
                'RunBackTestMode': True|False
            }
        },
        'RDSSourceConfig': {
            'DBInstanceIdentifier': 'string',
            'DatabaseHost': 'string',
            'DatabasePort': 123,
            'SecretManagerArn': 'string',
            'DatabaseName': 'string',
            'TableName': 'string',
            'RoleArn': 'string',
            'VpcConfiguration': {
                'SubnetIdList': [
                    'string',
                ],
                'SecurityGroupIdList': [
                    'string',
                ]
            }
        },
        'RedshiftSourceConfig': {
            'ClusterIdentifier': 'string',
            'DatabaseHost': 'string',
            'DatabasePort': 123,
            'SecretManagerArn': 'string',
            'DatabaseName': 'string',
            'TableName': 'string',
            'RoleArn': 'string',
            'VpcConfiguration': {
                'SubnetIdList': [
                    'string',
                ],
                'SecurityGroupIdList': [
                    'string',
                ]
            }
        },
        'AthenaSourceConfig': {
            'RoleArn': 'string',
            'DatabaseName': 'string',
            'DataCatalog': 'string',
            'TableName': 'string',
            'WorkGroupName': 'string',
            'S3ResultsPath': 'string',
            'BackTestConfiguration': {
                'RunBackTestMode': True|False
            }
        }
    },
    'DimensionFilterList': [
        {
            'Name': 'string',
            'FilterList': [
                {
                    'DimensionValue': 'string',
                    'FilterOperation': 'EQUALS'
                },
            ]
        },
    ]
}

Response Structure

(dict) –
- MetricSetArn (string) –
  
  The ARN of the dataset.
- AnomalyDetectorArn (string) –
  
  The ARN of the detector that contains the dataset.
- MetricSetName (string) –
  
  The name of the dataset.
- MetricSetDescription (string) –
  
  The dataset’s description.
- CreationTime (datetime) –
  
  The time at which the dataset was created.
- LastModificationTime (datetime) –
  
  The time at which the dataset was last modified.
- Offset (integer) –
  
  After an interval ends, the amount of seconds that the detector waits before importing data. Offset is only supported for S3, Redshift, Athena and datasources.
- MetricList (list) –
  
  A list of the metrics defined by the dataset.
  - (dict) –
    
    A calculation made by contrasting a measure and a dimension from your source data.
    - MetricName (string) –
      
      The name of the metric.
    - AggregationFunction (string) –
      
      The function with which the metric is calculated.
    - Namespace (string) –
      
      The namespace for the metric.
- TimestampColumn (dict) –
  
  Contains information about the column used for tracking time in your source data.
  - ColumnName (string) –
    
    The name of the timestamp column.
  - ColumnFormat (string) –
    
    The format of the timestamp column.
- DimensionList (list) –
  
  A list of the dimensions chosen for analysis.
  - (string) –
- MetricSetFrequency (string) –
  
  The interval at which the data will be analyzed for anomalies.
- Timezone (string) –
  
  The time zone in which the dataset’s data was recorded.
- MetricSource (dict) –
  
  Contains information about the dataset’s source data.
  - S3SourceConfig (dict) –
    
    Contains information about the configuration of the S3 bucket that contains source files.
    - RoleArn (string) –
      
      The ARN of an IAM role that has read and write access permissions to the source S3 bucket.
    - TemplatedPathList (list) –
      
      A list of templated paths to the source files.
      - (string) –
    - HistoricalDataPathList (list) –
      
      A list of paths to the historical data files.
      - (string) –
    - FileFormatDescriptor (dict) –
      
      Contains information about a source file’s formatting.
      - CsvFormatDescriptor (dict) –
        
        Contains information about how a source CSV data file should be analyzed.
        
        FileCompression (string) –
        
        The level of compression of the source CSV file.
        
        Charset (string) –
        
        The character set in which the source CSV file is written.
        
        ContainsHeader (boolean) –
        
        Whether or not the source CSV file contains a header.
        
        Delimiter (string) –
        
        The character used to delimit the source CSV file.
        
        HeaderList (list) –
        
        A list of the source CSV file’s headers, if any.
        
        (string) –
        
        QuoteSymbol (string) –
        
        The character used as a quote character.
      - JsonFormatDescriptor (dict) –
        
        Contains information about how a source JSON data file should be analyzed.
        
        FileCompression (string) –
        
        The level of compression of the source CSV file.
        
        Charset (string) –
        
        The character set in which the source JSON file is written.
  - AppFlowConfig (dict) –
    
    Details about an AppFlow datasource.
    - RoleArn (string) –
      
      An IAM role that gives Amazon Lookout for Metrics permission to access the flow.
    - FlowName (string) –
      
      name of the flow.
  - CloudWatchConfig (dict) –
    
    Details about an Amazon CloudWatch monitoring datasource.
    - RoleArn (string) –
      
      An IAM role that gives Amazon Lookout for Metrics permission to access data in Amazon CloudWatch.
    - BackTestConfiguration (dict) –
      
      Settings for backtest mode.
      - RunBackTestMode (boolean) –
        
        Run a backtest instead of monitoring new data.
  - RDSSourceConfig (dict) –
    
    Details about an Amazon Relational Database Service (RDS) datasource.
    - DBInstanceIdentifier (string) –
      
      A string identifying the database instance.
    - DatabaseHost (string) –
      
      The host name of the database.
    - DatabasePort (integer) –
      
      The port number where the database can be accessed.
    - SecretManagerArn (string) –
      
      The Amazon Resource Name (ARN) of the AWS Secrets Manager role.
    - DatabaseName (string) –
      
      The name of the RDS database.
    - TableName (string) –
      
      The name of the table in the database.
    - RoleArn (string) –
      
      The Amazon Resource Name (ARN) of the role.
    - VpcConfiguration (dict) –
      
      An object containing information about the Amazon Virtual Private Cloud (VPC) configuration.
      - SubnetIdList (list) –
        
        An array of strings containing the Amazon VPC subnet IDs (e.g., subnet-0bb1c79de3EXAMPLE.
        
        (string) –
      - SecurityGroupIdList (list) –
        
        An array of strings containing the list of security groups.
        
        (string) –
  - RedshiftSourceConfig (dict) –
    
    Details about an Amazon Redshift database datasource.
    - ClusterIdentifier (string) –
      
      A string identifying the Redshift cluster.
    - DatabaseHost (string) –
      
      The name of the database host.
    - DatabasePort (integer) –
      
      The port number where the database can be accessed.
    - SecretManagerArn (string) –
      
      The Amazon Resource Name (ARN) of the AWS Secrets Manager role.
    - DatabaseName (string) –
      
      The Redshift database name.
    - TableName (string) –
      
      The table name of the Redshift database.
    - RoleArn (string) –
      
      The Amazon Resource Name (ARN) of the role providing access to the database.
    - VpcConfiguration (dict) –
      
      Contains information about the Amazon Virtual Private Cloud (VPC) configuration.
      - SubnetIdList (list) –
        
        An array of strings containing the Amazon VPC subnet IDs (e.g., subnet-0bb1c79de3EXAMPLE.
        
        (string) –
      - SecurityGroupIdList (list) –
        
        An array of strings containing the list of security groups.
        
        (string) –
  - AthenaSourceConfig (dict) –
    
    Details about an Amazon Athena datasource.
    - RoleArn (string) –
      
      An IAM role that gives Amazon Lookout for Metrics permission to access the data.
    - DatabaseName (string) –
      
      The database’s name.
    - DataCatalog (string) –
      
      The database’s data catalog.
    - TableName (string) –
      
      The database’s table name.
    - WorkGroupName (string) –
      
      The database’s work group name.
    - S3ResultsPath (string) –
      
      The database’s results path.
    - BackTestConfiguration (dict) –
      
      Settings for backtest mode.
      - RunBackTestMode (boolean) –
        
        Run a backtest instead of monitoring new data.
- DimensionFilterList (list) –
  
  The dimensions and their values that were used to filter the dataset.
  - (dict) –
    
    Describes a list of filters for choosing a subset of dimension values. Each filter consists of the dimension and one of its values that you want to include. When multiple dimensions or values are specified, the dimensions are joined with an AND operation and the values are joined with an OR operation.
    - Name (string) –
      
      The dimension that you want to filter on.
    - FilterList (list) –
      
      The list of filters that you are applying.
      - (dict) –
        
        Describes a filter for choosing a subset of dimension values. Each filter consists of the dimension that you want to include and the condition statement. The condition statement is specified in the FilterOperation object.
        
        DimensionValue (string) –
        
        The value that you want to include in the filter.
        
        FilterOperation (string) –
        
        The condition to apply.

describe_metric_set#

Request Syntax

Response Syntax

Response Structure

Exceptions