Skip to content

Lists values stored in a data table with optional filtering by record IDs or primary attribute values

Description

Lists values stored in a data table with optional filtering by record IDs or primary attribute values. Returns the raw stored values along with metadata such as lock versions and modification timestamps.

Usage

connect_list_data_table_values(InstanceId, DataTableId, RecordIds,
  PrimaryAttributeValues, NextToken, MaxResults)

Arguments

  • InstanceId

[required] The unique identifier for the Amazon Connect instance.

  • DataTableId

[required] The unique identifier for the data table whose values should be listed.

  • RecordIds

Optional list of specific record IDs to retrieve values for.

  • PrimaryAttributeValues

Optional filter to retrieve values for records matching specific primary attribute criteria.

  • NextToken

Specify the pagination token from a previous request to retrieve the next page of results.

  • MaxResults

The maximum number of data table values to return in one page of results.

Value

A list with the following syntax:

list(
  NextToken = "string",
  Values = list(
    list(
      RecordId = "string",
      AttributeId = "string",
      PrimaryValues = list(
        list(
          AttributeName = "string",
          AttributeId = "string",
          Value = "string"
        )
      ),
      AttributeName = "string",
      ValueType = "TEXT"|"NUMBER"|"BOOLEAN"|"TEXT_LIST"|"NUMBER_LIST",
      Value = "string",
      LockVersion = list(
        DataTable = "string",
        Attribute = "string",
        PrimaryValues = "string",
        Value = "string"
      ),
      LastModifiedTime = as.POSIXct(
        "2015-01-01"
      ),
      LastModifiedRegion = "string"
    )
  )
)

Request syntax

svc$list_data_table_values(
  InstanceId = "string",
  DataTableId = "string",
  RecordIds = list(
    "string"
  ),
  PrimaryAttributeValues = list(
    list(
      AttributeName = "string",
      Values = list(
        "string"
      )
    )
  ),
  NextToken = "string",
  MaxResults = 123
)