[ aws . customer-profiles ]

create-calculated-attribute-definition

Description

Creates a new calculated attribute definition. After creation, new object data ingested into Customer Profiles will be included in the calculated attribute, which can be retrieved for a profile using the GetCalculatedAttributeForProfile API. Defining a calculated attribute makes it available for all profiles within a domain. Each calculated attribute can only reference one ObjectType and at most, two fields from that ObjectType .

See also: AWS API Documentation

Synopsis

  create-calculated-attribute-definition
--domain-name <value>
--calculated-attribute-name <value>
[--display-name <value>]
[--description <value>]
--attribute-details <value>
[--conditions <value>]
[--filter <value>]
--statistic <value>
[--tags <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]

Options

--domain-name (string)

The unique name of the domain.

--calculated-attribute-name (string)

The unique name of the calculated attribute.

--display-name (string)

The display name of the calculated attribute.

--description (string)

The description of the calculated attribute.

--attribute-details (structure)

Mathematical expression and a list of attribute items specified in that expression.

Attributes -> (list)

A list of attribute items specified in the mathematical expression.

(structure)

The details of a single attribute item specified in the mathematical expression.

Name -> (string)

The name of an attribute defined in a profile object type.

Expression -> (string)

Mathematical expression that is performed on attribute items provided in the attribute list. Each element in the expression should follow the structure of “{ObjectTypeName.AttributeName}”.

Shorthand Syntax:

Attributes=[{Name=string},{Name=string}],Expression=string

JSON Syntax:

{
  "Attributes": [
    {
      "Name": "string"
    }
    ...
  ],
  "Expression": "string"
}

--conditions (structure)

The conditions including range, object count, and threshold for the calculated attribute.

Range -> (structure)

The relative time period over which data is included in the aggregation.

Value -> (integer)

The amount of time of the specified unit.

Unit -> (string)

The unit of time.

ObjectCount -> (integer)

The number of profile objects used for the calculated attribute.

Threshold -> (structure)

The threshold for the calculated attribute.

Value -> (string)

The value of the threshold.

Operator -> (string)

The operator of the threshold.

Shorthand Syntax:

Range={Value=integer,Unit=string},ObjectCount=integer,Threshold={Value=string,Operator=string}

JSON Syntax:

{
  "Range": {
    "Value": integer,
    "Unit": "DAYS"
  },
  "ObjectCount": integer,
  "Threshold": {
    "Value": "string",
    "Operator": "EQUAL_TO"|"GREATER_THAN"|"LESS_THAN"|"NOT_EQUAL_TO"
  }
}

--filter (structure)

Defines how to filter incoming objects to include part of the Calculated Attribute.

Include -> (string)

Define whether to include or exclude objects for Calculated Attributed calculation that fit the filter groups criteria.

Groups -> (list)

Holds the list of Filter groups within the Filter definition.

(structure)

Object that holds the dimensions to filter on.

Type -> (string)

The type of logical relationship between the dimensions of the Filter group.

Dimensions -> (list)

Object that holds the attributes to filter on.

(structure)

Contains the map of attribute names to attribute dimensions.

Attributes -> (map)

Is the attribute within the FilterDimension map

key -> (string)

value -> (structure)

Object that defines how to filter the incoming objects for the calculated attribute.

DimensionType -> (string)

The action to filter with.

Values -> (list)

The values to apply the DimensionType on.

(string)

JSON Syntax:

{
  "Include": "ALL"|"ANY"|"NONE",
  "Groups": [
    {
      "Type": "ALL"|"ANY"|"NONE",
      "Dimensions": [
        {
          "Attributes": {"string": {
                "DimensionType": "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEGINS_WITH"|"ENDS_WITH"|"BEFORE"|"AFTER"|"BETWEEN"|"NOT_BETWEEN"|"ON"|"GREATER_THAN"|"LESS_THAN"|"GREATER_THAN_OR_EQUAL"|"LESS_THAN_OR_EQUAL"|"EQUAL",
                "Values": ["string", ...]
              }
            ...}
        }
        ...
      ]
    }
    ...
  ]
}

--statistic (string)

The aggregation operation to perform for the calculated attribute.

Possible values:

• FIRST_OCCURRENCE
• LAST_OCCURRENCE
• COUNT
• SUM
• MINIMUM
• MAXIMUM
• AVERAGE
• MAX_OCCURRENCE

--tags (map)

The tags used to organize, track, or control access for this resource.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

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

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

Output

CalculatedAttributeName -> (string)

The unique name of the calculated attribute.

DisplayName -> (string)

The display name of the calculated attribute.

Description -> (string)

The description of the calculated attribute.

AttributeDetails -> (structure)

Mathematical expression and a list of attribute items specified in that expression.

Attributes -> (list)

A list of attribute items specified in the mathematical expression.

(structure)

The details of a single attribute item specified in the mathematical expression.

Name -> (string)

The name of an attribute defined in a profile object type.

Expression -> (string)

Mathematical expression that is performed on attribute items provided in the attribute list. Each element in the expression should follow the structure of “{ObjectTypeName.AttributeName}”.

Conditions -> (structure)

The conditions including range, object count, and threshold for the calculated attribute.

Range -> (structure)

The relative time period over which data is included in the aggregation.

Value -> (integer)

The amount of time of the specified unit.

Unit -> (string)

The unit of time.

ObjectCount -> (integer)

The number of profile objects used for the calculated attribute.

Threshold -> (structure)

The threshold for the calculated attribute.

Value -> (string)

The value of the threshold.

Operator -> (string)

The operator of the threshold.

Filter -> (structure)

The filter that was used as part of the request.

Include -> (string)

Define whether to include or exclude objects for Calculated Attributed calculation that fit the filter groups criteria.

Groups -> (list)

Holds the list of Filter groups within the Filter definition.

(structure)

Object that holds the dimensions to filter on.

Type -> (string)

The type of logical relationship between the dimensions of the Filter group.

Dimensions -> (list)

Object that holds the attributes to filter on.

(structure)

Contains the map of attribute names to attribute dimensions.

Attributes -> (map)

Is the attribute within the FilterDimension map

key -> (string)

value -> (structure)

Object that defines how to filter the incoming objects for the calculated attribute.

DimensionType -> (string)

The action to filter with.

Values -> (list)

The values to apply the DimensionType on.

(string)

Statistic -> (string)

The aggregation operation to perform for the calculated attribute.

CreatedAt -> (timestamp)

The timestamp of when the calculated attribute definition was created.

LastUpdatedAt -> (timestamp)

The timestamp of when the calculated attribute definition was most recently edited.

Tags -> (map)

The tags used to organize, track, or control access for this resource.

key -> (string)

value -> (string)