set_ui_customization ¶

def set_ui_customization(
    self,
    user_pool_id: "capo_cognito_identity_provider.types.user_pool_id_type.UserPoolIdType",
    *,
    config_overrides: Optional[CognitoIdentityProviderClientConfig] = None,
    client_id: Optional[
        "capo_cognito_identity_provider.types.client_id_type.ClientIdType"
    ] = None,
    css: Optional["capo_cognito_identity_provider.types.css_type.CSSType"] = None,
    image_file: Optional[
        "capo_cognito_identity_provider.types.image_file_type.ImageFileType"
    ] = None,
) -> "capo_cognito_identity_provider.types.set_ui_customization_response.SetUICustomizationResponse":
    """<p>Configures UI branding settings for domains with the hosted UI (classic) branding version. Your user pool must have a domain. Configure a domain with .</p> <p>Set the default configuration for all clients with a <code>ClientId</code> of <code>ALL</code>. When the <code>ClientId</code> value is an app client ID, the settings you pass in this request apply to that app client and override the default <code>ALL</code> configuration.</p> <note> <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.</p> <p class="title"> <b>Learn more</b> </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html">Signing Amazon Web Services API Requests</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html">Using the Amazon Cognito user pools API and user pool endpoints</a> </p> </li> </ul> </note>

    Args:
        user_pool_id: <p>The ID of the user pool where you want to apply branding to the classic hosted UI.</p>
        client_id: <p>The ID of the app client that you want to customize. To apply a default style to all app clients not configured with client-level branding, set this parameter value to <code>ALL</code>.</p>
        css: <p>A plaintext CSS file that contains the custom fields that you want to apply to your user pool or app client. To download a template, go to the Amazon Cognito console. Navigate to your user pool <i>App clients</i> tab, select <i>Login pages</i>, edit <i>Hosted UI (classic) style</i>, and select the link to <code>CSS template.css</code>.</p>
        image_file: <p>The image that you want to set as your login in the classic hosted UI, as a Base64-formatted binary object.</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.
    """

    def _handler(
        req: "OperationRequest[capo_cognito_identity_provider.types.set_ui_customization_request.SetUICustomizationRequest]",
    ) -> OperationResponse[
        "capo_cognito_identity_provider.types.set_ui_customization_response.SetUICustomizationResponse"
    ]:
        import capo_cognito_identity_provider._operations.aws_cognito_identity_provider_service.set_ui_customization

        output, http_response = (
            capo_cognito_identity_provider._operations.aws_cognito_identity_provider_service.set_ui_customization.set_ui_customization(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_cognito_identity_provider.types.set_ui_customization_request.SetUICustomizationRequest",
    ) -> dict[str, Any]:
        import capo_cognito_identity_provider.types.set_ui_customization_request

        return capo_cognito_identity_provider.types.set_ui_customization_request.redact_sensitive(
            input_
        )

    def _redact_output(
        output: "capo_cognito_identity_provider.types.set_ui_customization_response.SetUICustomizationResponse",
    ) -> dict[str, Any]:
        import capo_cognito_identity_provider.types.set_ui_customization_response

        return capo_cognito_identity_provider.types.set_ui_customization_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "SetUICustomization",
            redact_input=_redact_input,
            redact_output=_redact_output,
        ),
    )
    input_: capo_cognito_identity_provider.types.set_ui_customization_request.SetUICustomizationRequest = {
        "user_pool_id": user_pool_id
    }
    if client_id is not None:
        input_["client_id"] = client_id
    if css is not None:
        input_["css"] = css
    if image_file is not None:
        input_["image_file"] = image_file

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