Describe Principal Mapping

kendra_describe_principal_mapping

R Documentation

Describes the processing of PUT and DELETE actions for mapping users to their groups¶

Description¶

Describes the processing of PUT and DELETE actions for mapping users to their groups. This includes information on the status of actions currently processing or yet to be processed, when actions were last updated, when actions were received by Amazon Kendra, the latest action that should process and apply after other actions, and useful error messages if an action could not be processed.

describe_principal_mapping is currently not supported in the Amazon Web Services GovCloud (US-West) region.

Usage¶

kendra_describe_principal_mapping(IndexId, DataSourceId, GroupId)

Arguments¶

IndexId: [required] The identifier of the index required to check the processing of PUT and DELETE actions for mapping users to their groups.
DataSourceId: The identifier of the data source to check the processing of PUT and DELETE actions for mapping users to their groups.
GroupId: [required] The identifier of the group required to check the processing of PUT and DELETE actions for mapping users to their groups.

Value¶

A list with the following syntax:

list(
  IndexId = "string",
  DataSourceId = "string",
  GroupId = "string",
  GroupOrderingIdSummaries = list(
    list(
      Status = "FAILED"|"SUCCEEDED"|"PROCESSING"|"DELETING"|"DELETED",
      LastUpdatedAt = as.POSIXct(
        "2015-01-01"
      ),
      ReceivedAt = as.POSIXct(
        "2015-01-01"
      ),
      OrderingId = 123,
      FailureReason = "string"
    )
  )
)

Request syntax¶

svc$describe_principal_mapping(
  IndexId = "string",
  DataSourceId = "string",
  GroupId = "string"
)