Describe Access Control Configuration

kendra_describe_access_control_configuration

R Documentation

Gets information about an access control configuration that you created for your documents in an index¶

Description¶

Gets information about an access control configuration that you created for your documents in an index. This includes user and group access information for your documents. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.

Usage¶

kendra_describe_access_control_configuration(IndexId, Id)

Arguments¶

IndexId: [required] The identifier of the index for an access control configuration.
Id: [required] The identifier of the access control configuration you want to get information on.

Value¶

A list with the following syntax:

list(
  Name = "string",
  Description = "string",
  ErrorMessage = "string",
  AccessControlList = list(
    list(
      Name = "string",
      Type = "USER"|"GROUP",
      Access = "ALLOW"|"DENY",
      DataSourceId = "string"
    )
  ),
  HierarchicalAccessControlList = list(
    list(
      PrincipalList = list(
        list(
          Name = "string",
          Type = "USER"|"GROUP",
          Access = "ALLOW"|"DENY",
          DataSourceId = "string"
        )
      )
    )
  )
)

Request syntax¶

svc$describe_access_control_configuration(
  IndexId = "string",
  Id = "string"
)