Personalize / Client / update_metric_attribution

update_metric_attribution#

Personalize.Client.update_metric_attribution(**kwargs)#

Updates a metric attribution.

See also: AWS API Documentation

Request Syntax

response = client.update_metric_attribution(
    addMetrics=[
        {
            'eventType': 'string',
            'metricName': 'string',
            'expression': 'string'
        },
    ],
    removeMetrics=[
        'string',
    ],
    metricsOutputConfig={
        's3DataDestination': {
            'path': 'string',
            'kmsKeyArn': 'string'
        },
        'roleArn': 'string'
    },
    metricAttributionArn='string'
)
Parameters:

  • addMetrics (list) –

    Add new metric attributes to the metric attribution.

    • (dict) –

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

      • eventType (string) – [REQUIRED]

        The metric’s event type.

      • metricName (string) – [REQUIRED]

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

      • expression (string) – [REQUIRED]

        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).

  • removeMetrics (list) –

    Remove metric attributes from the metric attribution.

    • (string) –

  • metricsOutputConfig (dict) –

    An output config for the metric attribution.

    • s3DataDestination (dict) –

      The configuration details of an Amazon S3 input or output bucket.

      • path (string) – [REQUIRED]

        The file path of the Amazon S3 bucket.

      • kmsKeyArn (string) –

        The Amazon Resource Name (ARN) of the Key Management Service (KMS) key that Amazon Personalize uses to encrypt or decrypt the input and output files.

    • roleArn (string) – [REQUIRED]

      The Amazon Resource Name (ARN) of the IAM service role that has permissions to add data to your output Amazon S3 bucket and add metrics to Amazon CloudWatch. For more information, see Measuring impact of recommendations.

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

Return type:

dict

Returns:

Response Syntax

{
    'metricAttributionArn': 'string'
}

Response Structure

  • (dict) –

    • metricAttributionArn (string) –

      The Amazon Resource Name (ARN) for the metric attribution that you updated.

Exceptions

  • Personalize.Client.exceptions.InvalidInputException

  • Personalize.Client.exceptions.ResourceNotFoundException

  • Personalize.Client.exceptions.ResourceInUseException

  • Personalize.Client.exceptions.ResourceAlreadyExistsException