Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . personalize ]

update-metric-attribution

Description

Updates a metric attribution.

See also: AWS API Documentation

Synopsis

  update-metric-attribution
[--add-metrics <value>]
[--remove-metrics <value>]
[--metrics-output-config <value>]
[--metric-attribution-arn <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--add-metrics (list)

Add new metric attributes to the metric attribution.

(structure)

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

Shorthand Syntax:

eventType=string,metricName=string,expression=string ...

JSON Syntax:

[
  {
    "eventType": "string",
    "metricName": "string",
    "expression": "string"
  }
  ...
]

--remove-metrics (list)

Remove metric attributes from the metric attribution.

(string)

Syntax:

"string" "string" ...

--metrics-output-config (structure)

An output config for the metric attribution.

s3DataDestination -> (structure)

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

path -> (string)

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)

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 .

Shorthand Syntax:

s3DataDestination={path=string,kmsKeyArn=string},roleArn=string

JSON Syntax:

{
  "s3DataDestination": {
    "path": "string",
    "kmsKeyArn": "string"
  },
  "roleArn": "string"
}

--metric-attribution-arn (string)

The Amazon Resource Name (ARN) for the metric attribution to update.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

metricAttributionArn -> (string)

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