Skip to content

delete_web_app_customization

delete_web_app_customization(
    web_app_id: WebAppId, *, config_overrides: Optional[TransferClientConfig] = None
) -> None

Deletes the WebAppCustomization object that corresponds to the web app ID specified.

Parameters:

  • web_app_id (WebAppId) –

    Provide the unique identifier for the web app that contains the customizations that you are deleting.

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 delete_web_app_customization(
    self,
    web_app_id: "capo_transfer.types.web_app_id.WebAppId",
    *,
    config_overrides: Optional[TransferClientConfig] = None,
) -> None:
    """<p>Deletes the <code>WebAppCustomization</code> object that corresponds to the web app ID specified.</p>

    Args:
        web_app_id: <p>Provide the unique identifier for the web app that contains the customizations that you are deleting.</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.delete_web_app_customization_request.DeleteWebAppCustomizationRequest]",
    ) -> OperationResponse[None]:
        import capo_transfer._operations.transfer_service.delete_web_app_customization

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteWebAppCustomization")
    )
    input_: capo_transfer.types.delete_web_app_customization_request.DeleteWebAppCustomizationRequest = {
        "web_app_id": web_app_id
    }

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