Update Data Table Attribute
| connect_update_data_table_attribute | R Documentation |
Updates all properties for an attribute using all properties from CreateDataTableAttribute¶
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.
Usage¶
connect_update_data_table_attribute(InstanceId, DataTableId,
AttributeName, Name, ValueType, Description, Primary, Validation)
Arguments¶
InstanceId |
[required] The unique identifier for the Amazon Connect instance. |
DataTableId |
[required] The unique identifier for the data table. Must also accept the table ARN with or without a version alias. |
AttributeName |
[required] The current name of the attribute to update. Used as an identifier since attribute names can be changed. |
Name |
[required] The new name for the attribute. Must conform to Connect human readable string specification and be unique within the data table. |
ValueType |
[required] The updated value type for the attribute. When changing value types, existing values are not deleted but may return default values if incompatible. |
Description |
The updated description for the attribute. |
Primary |
Whether the attribute should be treated as a primary key. Converting to primary attribute requires existing values to maintain uniqueness. |
Validation |
The updated validation rules for the attribute. Changes do not affect existing values until they are modified. |
Value¶
A list with the following syntax:
list(
Name = "string",
LockVersion = list(
DataTable = "string",
Attribute = "string",
PrimaryValues = "string",
Value = "string"
)
)
Request syntax¶
svc$update_data_table_attribute(
InstanceId = "string",
DataTableId = "string",
AttributeName = "string",
Name = "string",
ValueType = "TEXT"|"NUMBER"|"BOOLEAN"|"TEXT_LIST"|"NUMBER_LIST",
Description = "string",
Primary = TRUE|FALSE,
Validation = list(
MinLength = 123,
MaxLength = 123,
MinValues = 123,
MaxValues = 123,
IgnoreCase = TRUE|FALSE,
Minimum = 123.0,
Maximum = 123.0,
ExclusiveMinimum = 123.0,
ExclusiveMaximum = 123.0,
MultipleOf = 123.0,
Enum = list(
Strict = TRUE|FALSE,
Values = list(
"string"
)
)
)
)