Skip to content

List Data Table Primary Values

connect_list_data_table_primary_values R Documentation

Lists all primary value combinations for a given data table

Description

Lists all primary value combinations for a given data table. Returns the unique combinations of primary attribute values that identify records in the table. Up to 100 records are returned per request.

Usage

connect_list_data_table_primary_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 primary values should be listed.

RecordIds

Optional list of specific record IDs to retrieve. Used for CloudFormation to effectively describe records by ID. If NextToken is provided, this parameter is ignored.

PrimaryAttributeValues

Optional filter to retrieve primary values matching specific criteria.

NextToken

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

MaxResults

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

Value

A list with the following syntax:

list(
  NextToken = "string",
  PrimaryValuesList = list(
    list(
      RecordId = "string",
      PrimaryValues = list(
        list(
          AttributeName = "string",
          AttributeId = "string",
          Value = "string"
        )
      ),
      LastModifiedTime = as.POSIXct(
        "2015-01-01"
      ),
      LastModifiedRegion = "string"
    )
  )
)

Request syntax

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