describe-access-control-configuration¶
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.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
describe-access-control-configuration
--index-id <value>
--id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
Options¶
--index-id (string)
The identifier of the index for an access control configuration.
--id (string)
The identifier of the access control configuration you want to get information on.
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
See ‘aws help’ for descriptions of global parameters.
Output¶
Name -> (string)
The name for the access control configuration.
Description -> (string)
The description for the access control configuration.
ErrorMessage -> (string)
The error message containing details if there are issues processing the access control configuration.
AccessControlList -> (list)
Information on principals (users and/or groups) and which documents they should have access to. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.
(structure)
Provides user and group information for user context filtering .
Name -> (string)
The name of the user or group.
Type -> (string)
The type of principal.
Access -> (string)
Whether to allow or deny document access to the principal.
DataSourceId -> (string)
The identifier of the data source the principal should access documents from.
HierarchicalAccessControlList -> (list)
The list of principal lists that define the hierarchy for which documents users should have access to.
(structure)
Information to define the hierarchy for which documents users should have access to.
PrincipalList -> (list)
A list of principal lists that define the hierarchy for which documents users should have access to. Each hierarchical list specifies which user or group has allow or deny access for each document.
(structure)
Provides user and group information for user context filtering .
Name -> (string)
The name of the user or group.
Type -> (string)
The type of principal.
Access -> (string)
Whether to allow or deny document access to the principal.
DataSourceId -> (string)
The identifier of the data source the principal should access documents from.