Personalize / Paginator / ListMetricAttributionMetrics

ListMetricAttributionMetrics

class Personalize.Paginator.ListMetricAttributionMetrics

paginator = client.get_paginator('list_metric_attribution_metrics')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Personalize.Client.list_metric_attribution_metrics().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    metricAttributionArn='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

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

• 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

{
    '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) –

    A token to resume pagination.