List Data Table Attributes

connect_list_data_table_attributes

R Documentation

Returns all attributes for a specified data table

Description

Returns all attributes for a specified data table. A maximum of 100 attributes per data table is allowed. Customers can request an increase by using Amazon Web Services Service Quotas. The response can be filtered by specific attribute IDs for CloudFormation integration.

Usage

connect_list_data_table_attributes(InstanceId, DataTableId,
  AttributeIds, NextToken, MaxResults)

Arguments

InstanceId	[required] The unique identifier for the Amazon Connect instance.
DataTableId	[required] The unique identifier for the data table whose attributes should be listed.
AttributeIds	Optional list of specific attribute IDs to retrieve. Used for CloudFormation to effectively describe attributes by ID. If NextToken is provided, this parameter is ignored.
NextToken	Specify the pagination token from a previous request to retrieve the next page of results.
MaxResults	The maximum number of data table attributes to return in one page of results.

Value

A list with the following syntax:

list(
  NextToken = "string",
  Attributes = list(
    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$list_data_table_attributes(
  InstanceId = "string",
  DataTableId = "string",
  AttributeIds = list(
    "string"
  ),
  NextToken = "string",
  MaxResults = 123
)