[ aws . connect ]

update-data-table-attribute

Description

Updates all properties for an attribute using all properties from CreateDataTableAttribute. There are no other granular update endpoints. It does not act as a patch operation - all properties must be provided. System managed attributes are not mutable by customers. Changing an attribute’s validation does not invalidate existing values since validation only runs when values are created or updated.

See also: AWS API Documentation

Synopsis

  update-data-table-attribute
--instance-id <value>
--data-table-id <value>
--attribute-name <value>
--name <value>
--value-type <value>
[--description <value>]
[--primary | --no-primary]
[--validation <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

--instance-id (string) [required]

The unique identifier for the Amazon Connect instance.

Constraints:

• min: 1
• max: 100

--data-table-id (string) [required]

The unique identifier for the data table. Must also accept the table ARN with or without a version alias.

Constraints:

• min: 1
• max: 256

--attribute-name (string) [required]

The current name of the attribute to update. Used as an identifier since attribute names can be changed.

Constraints:

• min: 1
• max: 127
• pattern: ^[\p{L}\p{Z}\p{N}\-_.:=@'|]+$

--name (string) [required]

The new name for the attribute. Must conform to Connect human readable string specification and be unique within the data table.

Constraints:

• min: 1
• max: 127
• pattern: ^[\p{L}\p{Z}\p{N}\-_.:=@'|]+$

--value-type (string) [required]

The updated value type for the attribute. When changing value types, existing values are not deleted but may return default values if incompatible.

Possible values:

• TEXT
• NUMBER
• BOOLEAN
• TEXT_LIST
• NUMBER_LIST

--description (string)

The updated description for the attribute.

Constraints:

• min: 0
• max: 250
• pattern: ^[\\P{C}\r\n\t]+$

--primary | --no-primary (boolean)

Whether the attribute should be treated as a primary key. Converting to primary attribute requires existing values to maintain uniqueness.

--validation (structure)

The updated validation rules for the attribute. Changes do not affect existing values until they are modified.

MinLength -> (integer)

The minimum number of characters a text value can contain. Applies to TEXT value type and values within a TEXT_LIST. Must be less than or equal to MaxLength.

Constraints:

• min: 0
• max: 1000

MaxLength -> (integer)

The maximum number of characters a text value can contain. Applies to TEXT value type and values within a TEXT_LIST. Must be greater than or equal to MinLength.

Constraints:

• min: 0
• max: 1000

MinValues -> (integer)

The minimum number of values in a list. Must be an integer greater than or equal to 0 and less than or equal to MaxValues. Applies to all list types.

Constraints:

• min: 0
• max: 100

MaxValues -> (integer)

The maximum number of values in a list. Must be an integer greater than or equal to 0 and greater than or equal to MinValues. Applies to all list types.

Constraints:

• min: 0
• max: 100

IgnoreCase -> (boolean)

Boolean that defaults to false. Applies to text lists and text primary attributes. When true, enforces case-insensitive uniqueness for primary attributes and allows case-insensitive lookups.

Minimum -> (double)

The smallest inclusive numeric value for NUMBER value type. Cannot be provided when ExclusiveMinimum is also provided. Must be less than or equal to Maximum and less than ExclusiveMaximum. Applies to NUMBER and values within NUMBER_LIST.

Maximum -> (double)

The largest inclusive numeric value for NUMBER value type. Can be provided alongside ExclusiveMaximum where both operate independently. Must be greater than or equal to Minimum and greater than ExclusiveMinimum. Applies to NUMBER and values within NUMBER_LIST.

ExclusiveMinimum -> (double)

The smallest exclusive numeric value for NUMBER value type. Can be provided alongside Minimum where both operate independently. Must be less than ExclusiveMaximum and Maximum. Applies to NUMBER and values within NUMBER_LIST.

ExclusiveMaximum -> (double)

The largest exclusive numeric value for NUMBER value type. Can be provided alongside Maximum where both operate independently. Must be greater than ExclusiveMinimum and Minimum. Applies to NUMBER and values within NUMBER_LIST.

MultipleOf -> (double)

Specifies that numeric values must be multiples of this number. Must be greater than 0. The result of dividing a value by this multiple must result in an integer. Applies to NUMBER and values within NUMBER_LIST.

Constraints:

• min: 0

Enum -> (structure)

Defines enumeration constraints for attribute values. Can specify a list of allowed values and whether custom values are permitted beyond the enumerated list.

Strict -> (boolean)

Boolean that defaults to false. When true, only values specified in the enum list are allowed. When false, custom values beyond the enumerated list are permitted.

Values -> (list)

A list of predefined values that are allowed for this attribute. These values are always permitted regardless of the Strict setting.

(string)

Shorthand Syntax:

MinLength=integer,MaxLength=integer,MinValues=integer,MaxValues=integer,IgnoreCase=boolean,Minimum=double,Maximum=double,ExclusiveMinimum=double,ExclusiveMaximum=double,MultipleOf=double,Enum={Strict=boolean,Values=[string,string]}

JSON Syntax:

{
  "MinLength": integer,
  "MaxLength": integer,
  "MinValues": integer,
  "MaxValues": integer,
  "IgnoreCase": true|false,
  "Minimum": double,
  "Maximum": double,
  "ExclusiveMinimum": double,
  "ExclusiveMaximum": double,
  "MultipleOf": double,
  "Enum": {
    "Strict": true|false,
    "Values": ["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

Name -> (string)

The trimmed name and identifier for the updated attribute.

Constraints:

• min: 1
• max: 127
• pattern: ^[\p{L}\p{Z}\p{N}\-_.:=@'|]+$

LockVersion -> (structure)

The new lock version for the attribute after the update.

DataTable -> (string)

The lock version for the data table itself. Used for optimistic locking and table versioning. Changes with each update to the table’s metadata or structure.

Attribute -> (string)

The lock version for a specific attribute. When the ValueLockLevel is ATTRIBUTE, this version changes when any value for the attribute changes. For other lock levels, it only changes when the attribute’s properties are directly updated.

PrimaryValues -> (string)

The lock version for a specific set of primary values (record). This includes the default record even if the table does not have any primary attributes. Used for record-level locking.

Value -> (string)

The lock version for a specific value. Changes each time the individual value is modified. Used for the finest-grained locking control.