describe_principal_mapping ¶

def describe_principal_mapping(
    self,
    index_id: "capo_kendra.types.index_id.IndexId",
    group_id: "capo_kendra.types.group_id.GroupId",
    *,
    config_overrides: Optional[kendraClientConfig] = None,
    data_source_id: Optional[
        "capo_kendra.types.data_source_id.DataSourceId"
    ] = None,
) -> "capo_kendra.types.describe_principal_mapping_response.DescribePrincipalMappingResponse":
    """<p>Describes the processing of <code>PUT</code> and <code>DELETE</code> 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.</p> <p> <code>DescribePrincipalMapping</code> is currently not supported in the Amazon Web Services GovCloud (US-West) region.</p>

    Args:
        index_id: <p>The identifier of the index required to check the processing of <code>PUT</code> and <code>DELETE</code> actions for mapping users to their groups.</p>
        data_source_id: <p>The identifier of the data source to check the processing of <code>PUT</code> and <code>DELETE</code> actions for mapping users to their groups.</p>
        group_id: <p>The identifier of the group required to check the processing of <code>PUT</code> and <code>DELETE</code> actions for mapping users to their groups.</p>

    Raises:
        capo_kendra.errors.access_denied_exception.AccessDeniedException: <p>You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.</p>
        capo_kendra.errors.internal_server_exception.InternalServerException: <p>An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
        capo_kendra.errors.resource_not_found_exception.ResourceNotFoundException: <p>The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.</p>
        capo_kendra.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling. Please reduce the number of requests and try again.</p>
        capo_kendra.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.</p>
        capo_kendra.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_kendra.types.describe_principal_mapping_request.DescribePrincipalMappingRequest]",
    ) -> OperationResponse[
        "capo_kendra.types.describe_principal_mapping_response.DescribePrincipalMappingResponse"
    ]:
        import capo_kendra._operations.aws_kendra_frontend_service.describe_principal_mapping

        output, http_response = (
            capo_kendra._operations.aws_kendra_frontend_service.describe_principal_mapping.describe_principal_mapping(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribePrincipalMapping")
    )
    input_: capo_kendra.types.describe_principal_mapping_request.DescribePrincipalMappingRequest = {
        "index_id": index_id,
        "group_id": group_id,
    }
    if data_source_id is not None:
        input_["data_source_id"] = data_source_id

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output