Describe Data Table

connect_describe_data_table

R Documentation

Returns all properties for a data table except for attributes and values¶

Description¶

Returns all properties for a data table except for attributes and values. All properties from CreateDataTable are returned as well as properties for region replication, versioning, and system tables. "Describe" is a deprecated term but is allowed to maintain consistency with existing operations.

Usage¶

connect_describe_data_table(InstanceId, DataTableId)

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. If no alias is provided, the default behavior is identical to providing the $LATEST alias.

Value¶

A list with the following syntax:

list(
  DataTable = list(
    Name = "string",
    Id = "string",
    Arn = "string",
    TimeZone = "string",
    Description = "string",
    ValueLockLevel = "NONE"|"DATA_TABLE"|"PRIMARY_VALUE"|"ATTRIBUTE"|"VALUE",
    LockVersion = list(
      DataTable = "string",
      Attribute = "string",
      PrimaryValues = "string",
      Value = "string"
    ),
    Version = "string",
    VersionDescription = "string",
    Status = "PUBLISHED",
    CreatedTime = as.POSIXct(
      "2015-01-01"
    ),
    LastModifiedTime = as.POSIXct(
      "2015-01-01"
    ),
    LastModifiedRegion = "string",
    Tags = list(
      "string"
    )
  )
)

Request syntax¶

svc$describe_data_table(
  InstanceId = "string",
  DataTableId = "string"
)