delete_portal ¶

delete_portal(
    portal_arn: ARN, *, config_overrides: Optional[WorkSpacesWebClientConfig] = None
) -> DeletePortalResponse

Deletes a web portal.

Parameters:

portal_arn (ARN) –

The ARN of the web portal.

Raises:

AccessDeniedException –

Access is denied.
ConflictException –

There is a conflict.
InternalServerException –

There is an internal server error.
ThrottlingException –

There is a throttling error.
ValidationException –

There is a validation error.
UnknownServiceError –

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

Source code in docs_src/capo_workspaces_web/_services/work_spaces_web.py

def delete_portal(
    self,
    portal_arn: "capo_workspaces_web.types.arn.ARN",
    *,
    config_overrides: Optional[WorkSpacesWebClientConfig] = None,
) -> "capo_workspaces_web.types.delete_portal_response.DeletePortalResponse":
    """<p>Deletes a web portal.</p>

    Args:
        portal_arn: <p>The ARN of the web portal.</p>

    Raises:
        capo_workspaces_web.errors.access_denied_exception.AccessDeniedException: <p>Access is denied.</p>
        capo_workspaces_web.errors.conflict_exception.ConflictException: <p>There is a conflict.</p>
        capo_workspaces_web.errors.internal_server_exception.InternalServerException: <p>There is an internal server error.</p>
        capo_workspaces_web.errors.throttling_exception.ThrottlingException: <p>There is a throttling error.</p>
        capo_workspaces_web.errors.validation_exception.ValidationException: <p>There is a validation error.</p>
        capo_workspaces_web.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_workspaces_web.types.delete_portal_request.DeletePortalRequest]",
    ) -> OperationResponse[
        "capo_workspaces_web.types.delete_portal_response.DeletePortalResponse"
    ]:
        import capo_workspaces_web._operations.aws_ermine_control_plane_service.delete_portal

        output, http_response = (
            capo_workspaces_web._operations.aws_ermine_control_plane_service.delete_portal.delete_portal(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeletePortal")
    )
    input_: capo_workspaces_web.types.delete_portal_request.DeletePortalRequest = {
        "portal_arn": portal_arn
    }

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