Describe Data Table Attribute

connect_describe_data_table_attribute

R Documentation

Returns detailed information for a specific data table attribute including its configuration, validation rules, and metadata

Description

Returns detailed information for a specific data table attribute including its configuration, validation rules, and metadata. "Describe" is a deprecated term but is allowed to maintain consistency with existing operations.

Usage

connect_describe_data_table_attribute(InstanceId, DataTableId,
  AttributeName)

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 name of the attribute to retrieve detailed information for.

Value

A list with the following syntax:

list(
  Attribute = list(
    AttributeId = "string",
    Name = "string",
    ValueType = "TEXT"|"NUMBER"|"BOOLEAN"|"TEXT_LIST"|"NUMBER_LIST",
    Description = "string",
    DataTableId = "string",
    DataTableArn = "string",
    Primary = TRUE|FALSE,
    Version = "string",
    LockVersion = list(
      DataTable = "string",
      Attribute = "string",
      PrimaryValues = "string",
      Value = "string"
    ),
    LastModifiedTime = as.POSIXct(
      "2015-01-01"
    ),
    LastModifiedRegion = "string",
    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"
        )
      )
    )
  )
)

Request syntax

svc$describe_data_table_attribute(
  InstanceId = "string",
  DataTableId = "string",
  AttributeName = "string"
)