describe_managed_login_branding `async` ¶

describe_managed_login_branding(
    user_pool_id: UserPoolIdType,
    managed_login_branding_id: ManagedLoginBrandingIdType,
    *,
    config_overrides: Optional[AsyncCognitoIdentityProviderClientConfig] = None,
    return_merged_resources: Optional[BooleanType] = None,
) -> DescribeManagedLoginBrandingResponse

Given the ID of a managed login branding style, returns detailed information about the style.

Parameters:

user_pool_id (UserPoolIdType) –

The ID of the user pool that contains the managed login branding style that you want to get information about.
managed_login_branding_id (ManagedLoginBrandingIdType) –

The ID of the managed login branding style that you want to get more information about.
return_merged_resources (Optional[BooleanType], default: None ) –

When true, returns values for branding options that are unchanged from Amazon Cognito defaults. When false or when you omit this parameter, returns only values that you customized in your branding style.

Raises:

InternalErrorException –

This exception is thrown when Amazon Cognito encounters an internal error.
InvalidParameterException –

This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
NotAuthorizedException –

This exception is thrown when a user isn't authorized.
OperationNotEnabledException –

This exception is thrown when an operation is not available in the current region or for the current user pool configuration. This can occur when attempting to perform operations that are not supported in secondary replica regions.
ResourceNotFoundException –

This exception is thrown when the Amazon Cognito service can't find the requested resource.
TooManyRequestsException –

This exception is thrown when the user has made too many requests for a given operation.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_cognito_identity_provider/_services/async_cognito_identity_provider.py

async def describe_managed_login_branding(
    self,
    user_pool_id: "capo_cognito_identity_provider.types.user_pool_id_type.UserPoolIdType",
    managed_login_branding_id: "capo_cognito_identity_provider.types.managed_login_branding_id_type.ManagedLoginBrandingIdType",
    *,
    config_overrides: Optional[AsyncCognitoIdentityProviderClientConfig] = None,
    return_merged_resources: Optional[
        "capo_cognito_identity_provider.types.boolean_type.BooleanType"
    ] = None,
) -> "capo_cognito_identity_provider.types.describe_managed_login_branding_response.DescribeManagedLoginBrandingResponse":
    """<p>Given the ID of a managed login branding style, returns detailed information about the style.</p>

    Args:
        user_pool_id: <p>The ID of the user pool that contains the managed login branding style that you want to get information about.</p>
        managed_login_branding_id: <p>The ID of the managed login branding style that you want to get more information about.</p>
        return_merged_resources: <p>When <code>true</code>, returns values for branding options that are unchanged from Amazon Cognito defaults. When <code>false</code> or when you omit this parameter, returns only values that you customized in your branding style.</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.operation_not_enabled_exception.OperationNotEnabledException: <p>This exception is thrown when an operation is not available in the current region or for the current user pool configuration. This can occur when attempting to perform operations that are not supported in secondary replica regions.</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_managed_login_branding_request.DescribeManagedLoginBrandingRequest]",
    ) -> AsyncOperationResponse[
        "capo_cognito_identity_provider.types.describe_managed_login_branding_response.DescribeManagedLoginBrandingResponse"
    ]:
        import capo_cognito_identity_provider._operations.aws_cognito_identity_provider_service.describe_managed_login_branding

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeManagedLoginBranding")
    )
    input_: capo_cognito_identity_provider.types.describe_managed_login_branding_request.DescribeManagedLoginBrandingRequest = {
        "user_pool_id": user_pool_id,
        "managed_login_branding_id": managed_login_branding_id,
    }
    if return_merged_resources is not None:
        input_["return_merged_resources"] = return_merged_resources

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

describe_managed_login_branding async ¶

describe_managed_login_branding `async` ¶