describe_user ¶

def describe_user(
    self,
    identity_store_id: "capo_identitystore.types.identity_store_id.IdentityStoreId",
    user_id: "capo_identitystore.types.resource_id.ResourceId",
    *,
    config_overrides: Optional[identitystoreClientConfig] = None,
    extensions: Optional[
        "capo_identitystore.types.extension_names.ExtensionNames"
    ] = None,
) -> "capo_identitystore.types.describe_user_response.DescribeUserResponse":
    """<p>Retrieves the user metadata and attributes from the <code>UserId</code> in an identity store.</p> <note> <p>If you have access to a member account, you can use this API operation from the member account. For more information, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/manage-your-accounts.html#limiting-access-from-member-accounts">Limiting access to the identity store from member accounts</a> in the <i> IAM Identity Center User Guide</i>.</p> </note>

    Args:
        identity_store_id: <p>The globally unique identifier for the identity store, such as <code>d-1234567890</code>. In this example, <code>d-</code> is a fixed prefix, and <code>1234567890</code> is a randomly generated string that contains numbers and lower case letters. This value is generated at the time that a new identity store is created.</p> <p>You can specify the identity store by ID or by Amazon Resource Name (ARN). For example, identity store ID <code>d-1234567890</code> or identity store ARN <code>arn:aws:identitystore::111122223333:identitystore/d-1234567890</code>.</p>
        user_id: <p>The identifier for a user in the identity store.</p> <p>You can specify the user by ID or by Amazon Resource Name (ARN). For example, user ID <code>a1b2c3d4-5678-90ab-cdef-EXAMPLE11111</code> or user ARN <code>arn:aws:identitystore:::user/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111</code>.</p>
        extensions: <p>A collection of extension names indicating what extensions the service should retrieve alongside other user attributes. <code>aws:identitystore:enterprise</code> is the only supported extension name.</p>

    Raises:
        capo_identitystore.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_identitystore.errors.internal_server_exception.InternalServerException: <p>The request processing has failed because of an unknown error, exception or failure with an internal server.</p>
        capo_identitystore.errors.throttling_exception.ThrottlingException: <p>Indicates that the principal has crossed the throttling limits of the API operations.</p>
        capo_identitystore.errors.resource_not_found_exception.ResourceNotFoundException: <p>Indicates that a requested resource is not found.</p>
        capo_identitystore.errors.validation_exception.ValidationException: <p>The request failed because it contains a syntax error.</p>
        capo_identitystore.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_identitystore.types.describe_user_request.DescribeUserRequest]",
    ) -> OperationResponse[
        "capo_identitystore.types.describe_user_response.DescribeUserResponse"
    ]:
        import capo_identitystore._operations.aws_identity_store.describe_user

        output, http_response = (
            capo_identitystore._operations.aws_identity_store.describe_user.describe_user(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_identitystore.types.describe_user_response.DescribeUserResponse",
    ) -> dict[str, Any]:
        import capo_identitystore.types.describe_user_response

        return capo_identitystore.types.describe_user_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("DescribeUser", redact_output=_redact_output),
    )
    input_: capo_identitystore.types.describe_user_request.DescribeUserRequest = {
        "identity_store_id": identity_store_id,
        "user_id": user_id,
    }
    if extensions is not None:
        input_["extensions"] = extensions

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