Personalize / Client / list_metric_attribution_metrics

list_metric_attribution_metrics#

Personalize.Client.list_metric_attribution_metrics(**kwargs)#

Lists the metrics for the metric attribution.

See also: AWS API Documentation

Request Syntax

response = client.list_metric_attribution_metrics(
    metricAttributionArn='string',
    nextToken='string',
    maxResults=123
)
Parameters:

  • metricAttributionArn (string) – The Amazon Resource Name (ARN) of the metric attribution to retrieve attributes for.

  • nextToken (string) – Specify the pagination token from a previous request to retrieve the next page of results.

  • maxResults (integer) – The maximum number of metrics to return in one page of results.

Return type:

dict

Returns:

Response Syntax

{
    'metrics': [
        {
            'eventType': 'string',
            'metricName': 'string',
            'expression': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • metrics (list) –

      The metrics for the specified metric attribution.

      • (dict) –

        Contains information on a metric that a metric attribution reports on. For more information, see Measuring impact of recommendations.

        • eventType (string) –

          The metric’s event type.

        • metricName (string) –

          The metric’s name. The name helps you identify the metric in Amazon CloudWatch or Amazon S3.

        • expression (string) –

          The attribute’s expression. Available functions are SUM() or SAMPLECOUNT(). For SUM() functions, provide the dataset type (either Interactions or Items) and column to sum as a parameter. For example SUM(Items.PRICE).

    • nextToken (string) –

      Specify the pagination token from a previous ListMetricAttributionMetricsResponse request to retrieve the next page of results.

Exceptions

  • Personalize.Client.exceptions.InvalidInputException

  • Personalize.Client.exceptions.InvalidNextTokenException