Skip to content

update_web_app_customization

update_web_app_customization(
    web_app_id: WebAppId,
    *,
    config_overrides: Optional[TransferClientConfig] = None,
    title: Optional[WebAppTitle] = None,
    logo_file: Optional[WebAppLogoFile] = None,
    favicon_file: Optional[WebAppFaviconFile] = None,
) -> UpdateWebAppCustomizationResponse

Assigns new customization properties to a web app. You can modify the icon file, logo file, and title.

Parameters:

  • web_app_id (WebAppId) –

    Provide the identifier of the web app that you are updating.

  • title (Optional[WebAppTitle], default: None ) –

    Provide an updated title.

  • logo_file (Optional[WebAppLogoFile], default: None ) –

    Specify logo file data string (in base64 encoding).

  • favicon_file (Optional[WebAppFaviconFile], default: None ) –

    Specify an icon file data string (in base64 encoding).

Raises:

  • AccessDeniedException –

    You do not have sufficient access to perform this action.

  • ConflictException –

    This exception is thrown when the UpdateServer is called for a file transfer protocol-enabled server that has VPC as the endpoint type and the server's VpcEndpointID is not in the available state.

  • InternalServiceError –

    This exception is thrown when an error occurs in the Transfer Family service.

  • InvalidRequestException –

    This exception is thrown when the client submits a malformed request.

  • ResourceNotFoundException –

    This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.

  • ThrottlingException –

    The request was denied due to request throttling.

  • UnknownServiceError –

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

Source code in docs_src/capo_transfer/_services/transfer.py
def update_web_app_customization(
    self,
    web_app_id: "capo_transfer.types.web_app_id.WebAppId",
    *,
    config_overrides: Optional[TransferClientConfig] = None,
    title: Optional["capo_transfer.types.web_app_title.WebAppTitle"] = None,
    logo_file: Optional[
        "capo_transfer.types.web_app_logo_file.WebAppLogoFile"
    ] = None,
    favicon_file: Optional[
        "capo_transfer.types.web_app_favicon_file.WebAppFaviconFile"
    ] = None,
) -> "capo_transfer.types.update_web_app_customization_response.UpdateWebAppCustomizationResponse":
    """<p>Assigns new customization properties to a web app. You can modify the icon file, logo file, and title.</p>

    Args:
        web_app_id: <p>Provide the identifier of the web app that you are updating.</p>
        title: <p>Provide an updated title.</p>
        logo_file: <p>Specify logo file data string (in base64 encoding).</p>
        favicon_file: <p>Specify an icon file data string (in base64 encoding).</p>

    Raises:
        capo_transfer.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_transfer.errors.conflict_exception.ConflictException: <p>This exception is thrown when the <code>UpdateServer</code> is called for a file transfer protocol-enabled server that has VPC as the endpoint type and the server's <code>VpcEndpointID</code> is not in the available state.</p>
        capo_transfer.errors.internal_service_error.InternalServiceError: <p>This exception is thrown when an error occurs in the Transfer Family service.</p>
        capo_transfer.errors.invalid_request_exception.InvalidRequestException: <p>This exception is thrown when the client submits a malformed request.</p>
        capo_transfer.errors.resource_not_found_exception.ResourceNotFoundException: <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.</p>
        capo_transfer.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_transfer.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_transfer.types.update_web_app_customization_request.UpdateWebAppCustomizationRequest]",
    ) -> OperationResponse[
        "capo_transfer.types.update_web_app_customization_response.UpdateWebAppCustomizationResponse"
    ]:
        import capo_transfer._operations.transfer_service.update_web_app_customization

        output, http_response = (
            capo_transfer._operations.transfer_service.update_web_app_customization.update_web_app_customization(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_transfer.types.update_web_app_customization_request.UpdateWebAppCustomizationRequest",
    ) -> dict[str, Any]:
        import capo_transfer.types.update_web_app_customization_request

        return capo_transfer.types.update_web_app_customization_request.redact_sensitive(
            input_
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("UpdateWebAppCustomization", redact_input=_redact_input),
    )
    input_: capo_transfer.types.update_web_app_customization_request.UpdateWebAppCustomizationRequest = {
        "web_app_id": web_app_id
    }
    if title is not None:
        input_["title"] = title
    if logo_file is not None:
        input_["logo_file"] = logo_file
    if favicon_file is not None:
        input_["favicon_file"] = favicon_file

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