Skip to content

Create Metric Attribution

personalize_create_metric_attribution R Documentation

Creates a metric attribution

Description

Creates a metric attribution. A metric attribution creates reports on the data that you import into Amazon Personalize. Depending on how you imported the data, you can view reports in Amazon CloudWatch or Amazon S3. For more information, see Measuring impact of recommendations.

Usage

personalize_create_metric_attribution(name, datasetGroupArn, metrics,
  metricsOutputConfig)

Arguments

name

[required] A name for the metric attribution.

datasetGroupArn

[required] The Amazon Resource Name (ARN) of the destination dataset group for the metric attribution.

metrics

[required] A list of metric attributes for the metric attribution. Each metric attribute specifies an event type to track and a function. 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).

metricsOutputConfig

[required] The output configuration details for the metric attribution.

Value

A list with the following syntax:

list(
  metricAttributionArn = "string"
)

Request syntax

svc$create_metric_attribution(
  name = "string",
  datasetGroupArn = "string",
  metrics = list(
    list(
      eventType = "string",
      metricName = "string",
      expression = "string"
    )
  ),
  metricsOutputConfig = list(
    s3DataDestination = list(
      path = "string",
      kmsKeyArn = "string"
    ),
    roleArn = "string"
  )
)