[ aws . connect ]

update-metric-content

Description

Updates the calculation, unit, and/or trend indicator of an existing metric in the specified Connect Customer instance.

See also: AWS API Documentation

Synopsis

  update-metric-content
--instance-id <value>
--metric-id <value>
[--metric-calculation <value>]
[--unit <value>]
[--positive-trend-indicator <value>]
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options

--instance-id (string) [required]

The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Constraints:

• min: 1
• max: 100

--metric-id (string) [required]

The identifier of the metric to update. Adding the $SAVED qualifier will update the saved version of the metric. Adding $LATEST or omitting a qualifier will update the published version.

Constraints:

• min: 1
• max: 150

--metric-calculation (structure)

The updated calculation definition for the metric.

CalculationComponents -> (list) [required]

The list of component metrics referenced in the calculation formula. Each component has an alias used in the formula expression.

Constraints:

• min: 1
• max: 5

(structure)

Represents a component metric referenced in a custom metric calculation formula.

Alias -> (string) [required]

The alias used to reference this component in the calculation expression.

Constraints:

• min: 1
• max: 128

MetricName -> (string)

The name of an AWS-managed metric used in this calculation component (for example, CONTACTS_HANDLED ). Mutually exclusive with MetricId .

Constraints:

• min: 1
• max: 128

MetricId -> (string)

The ARN of an AWS-managed metric used in this calculation component. Mutually exclusive with MetricName .

Constraints:

• min: 1
• max: 150

MetricFilters -> (list)

The filters applied to the calculation component.

Constraints:

• min: 0
• max: 5

(structure)

A filter condition applied to a metric component in a calculation. Filters restrict the data included in the metric computation.

MetricFilterKey -> (string) [required]

The key identifying the field to filter on.

Constraints:

• min: 1
• max: 100

Negate -> (boolean)

Specifies whether the filter condition is negated. When set to true , the filter excludes matching data instead of including it.

NumberCondition -> (structure)

A numeric comparison condition.

Comparison -> (string) [required]

The comparison operator. Valid values: LESSER (less than) | LESSER_OR_EQUAL (less than or equal to) | GREATER (greater than) | GREATER_OR_EQUAL (greater than or equal to).

Possible values:

• LESSER
• LESSER_OR_EQUAL
• GREATER
• GREATER_OR_EQUAL

Values -> (list) [required]

The numeric values to compare against.

Constraints:

• min: 1
• max: 10

(double)

StringCondition -> (structure)

A string comparison condition.

Comparison -> (string) [required]

The comparison operator. Valid values: MATCHES_ANY (matches any of the specified values) | MATCHES_NONE (matches none of the specified values).

Possible values:

• MATCHES_ANY
• MATCHES_NONE

Values -> (list) [required]

The string values to compare against.

Constraints:

• min: 1
• max: 10

(string)

BooleanCondition -> (structure)

A boolean comparison condition.

Comparison -> (string) [required]

The comparison operator. Valid values: IS_TRUE (matches when the field is true) | IS_FALSE (matches when the field is false).

Possible values:

• IS_TRUE
• IS_FALSE

Calculation -> (string) [required]

The formula expression that defines how the metric is calculated. Uses component aliases (for example, 100 * SUM(M1) / SUM(M2) ).

Constraints:

• min: 1
• max: 1024

JSON Syntax:

{
  "CalculationComponents": [
    {
      "Alias": "string",
      "MetricName": "string",
      "MetricId": "string",
      "MetricFilters": [
        {
          "MetricFilterKey": "string",
          "Negate": true|false,
          "NumberCondition": {
            "Comparison": "LESSER"|"LESSER_OR_EQUAL"|"GREATER"|"GREATER_OR_EQUAL",
            "Values": [double, ...]
          },
          "StringCondition": {
            "Comparison": "MATCHES_ANY"|"MATCHES_NONE",
            "Values": ["string", ...]
          },
          "BooleanCondition": {
            "Comparison": "IS_TRUE"|"IS_FALSE"
          }
        }
        ...
      ]
    }
    ...
  ],
  "Calculation": "string"
}

--unit (string)

The updated display unit for the metric.

Possible values:

• INTEGER
• DOUBLE
• PERCENT
• SECONDS

--positive-trend-indicator (string)

How an increase in the metric value should be interpreted. Valid values: POSITIVE , NEUTRAL , NEGATIVE .

Possible values:

• POSITIVE
• NEGATIVE
• NEUTRAL

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

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. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

• json
• text
• table
• yaml
• yaml-stream
• off

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

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

• legacy
• json
• yaml
• text
• table
• enhanced

Output

None