Skip to content

describe_identity_store

describe_identity_store(
    identity_store_id: IdentityStoreId,
    *,
    config_overrides: Optional[identitystoreClientConfig] = None,
) -> DescribeIdentityStoreResponse

Retrieves details about the specified identity store, including its Amazon Resource Name (ARN) and network configuration.

Parameters:

  • identity_store_id (IdentityStoreId) –

    The globally unique identifier for the identity store.

    You can specify the identity store by ID or by Amazon Resource Name (ARN). For example, identity store ID d-1234567890 or identity store ARN arn:aws:identitystore::111122223333:identitystore/d-1234567890.

Raises:

Source code in docs_src/capo_identitystore/_services/identitystore.py
def describe_identity_store(
    self,
    identity_store_id: "capo_identitystore.types.identity_store_id.IdentityStoreId",
    *,
    config_overrides: Optional[identitystoreClientConfig] = None,
) -> "capo_identitystore.types.describe_identity_store_response.DescribeIdentityStoreResponse":
    """<p>Retrieves details about the specified identity store, including its Amazon Resource Name (ARN) and network configuration.</p>

    Args:
        identity_store_id: <p>The globally unique identifier for the identity store.</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>

    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_identity_store_request.DescribeIdentityStoreRequest]",
    ) -> OperationResponse[
        "capo_identitystore.types.describe_identity_store_response.DescribeIdentityStoreResponse"
    ]:
        import capo_identitystore._operations.aws_identity_store.describe_identity_store

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeIdentityStore")
    )
    input_: capo_identitystore.types.describe_identity_store_request.DescribeIdentityStoreRequest = {
        "identity_store_id": identity_store_id
    }

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