Skip to content

describe_identity_provider async

describe_identity_provider(
    user_pool_id: UserPoolIdType,
    provider_name: ProviderNameType,
    *,
    config_overrides: Optional[AsyncCognitoIdentityProviderClientConfig] = None,
) -> DescribeIdentityProviderResponse

Given a user pool ID and identity provider (IdP) name, returns details about the IdP.

Parameters:

  • user_pool_id (UserPoolIdType) –

    The ID of the user pool that has the IdP that you want to describe..

  • provider_name (ProviderNameType) –

    The name of the IdP that you want to describe.

Raises:

Source code in docs_src/capo_cognito_identity_provider/_services/async_cognito_identity_provider.py
async def describe_identity_provider(
    self,
    user_pool_id: "capo_cognito_identity_provider.types.user_pool_id_type.UserPoolIdType",
    provider_name: "capo_cognito_identity_provider.types.provider_name_type.ProviderNameType",
    *,
    config_overrides: Optional[AsyncCognitoIdentityProviderClientConfig] = None,
) -> "capo_cognito_identity_provider.types.describe_identity_provider_response.DescribeIdentityProviderResponse":
    """<p>Given a user pool ID and identity provider (IdP) name, returns details about the IdP.</p>

    Args:
        user_pool_id: <p>The ID of the user pool that has the IdP that you want to describe..</p>
        provider_name: <p>The name of the IdP that you want to describe.</p>

    Raises:
        capo_cognito_identity_provider.errors.internal_error_exception.InternalErrorException: <p>This exception is thrown when Amazon Cognito encounters an internal error.</p>
        capo_cognito_identity_provider.errors.invalid_parameter_exception.InvalidParameterException: <p>This exception is thrown when the Amazon Cognito service encounters an invalid parameter.</p>
        capo_cognito_identity_provider.errors.not_authorized_exception.NotAuthorizedException: <p>This exception is thrown when a user isn't authorized.</p>
        capo_cognito_identity_provider.errors.resource_not_found_exception.ResourceNotFoundException: <p>This exception is thrown when the Amazon Cognito service can't find the requested resource.</p>
        capo_cognito_identity_provider.errors.too_many_requests_exception.TooManyRequestsException: <p>This exception is thrown when the user has made too many requests for a given operation.</p>
        capo_cognito_identity_provider.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_cognito_identity_provider.types.describe_identity_provider_request.DescribeIdentityProviderRequest]",
    ) -> AsyncOperationResponse[
        "capo_cognito_identity_provider.types.describe_identity_provider_response.DescribeIdentityProviderResponse"
    ]:
        import capo_cognito_identity_provider._operations.aws_cognito_identity_provider_service.describe_identity_provider

        (
            output,
            http_response,
        ) = await capo_cognito_identity_provider._operations.aws_cognito_identity_provider_service.describe_identity_provider.async_describe_identity_provider(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeIdentityProvider")
    )
    input_: capo_cognito_identity_provider.types.describe_identity_provider_request.DescribeIdentityProviderRequest = {
        "user_pool_id": user_pool_id,
        "provider_name": provider_name,
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output