delete_portal ¶

delete_portal(
    portal_id: __string, *, config_overrides: Optional[ApiGatewayV2ClientConfig] = None
) -> None

Deletes a portal.

Parameters:

portal_id (__string) –

The portal identifier.

Raises:

BadRequestException –

The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
TooManyRequestsException –

A limit has been exceeded. See the accompanying error message for details.
UnknownServiceError –

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

Source code in docs_src/capo_apigatewayv2/_services/api_gateway_v2.py

def delete_portal(
    self,
    portal_id: "capo_apigatewayv2.types.__string.__string",
    *,
    config_overrides: Optional[ApiGatewayV2ClientConfig] = None,
) -> None:
    """<p>Deletes a portal.</p>

    Args:
        portal_id: <p>The portal identifier.</p>

    Raises:
        capo_apigatewayv2.errors.access_denied_exception.AccessDeniedException
        capo_apigatewayv2.errors.bad_request_exception.BadRequestException: <p>The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.</p>
        capo_apigatewayv2.errors.too_many_requests_exception.TooManyRequestsException: <p>A limit has been exceeded. See the accompanying error message for details.</p>
        capo_apigatewayv2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_apigatewayv2.types.delete_portal_request.DeletePortalRequest]",
    ) -> OperationResponse[None]:
        import capo_apigatewayv2._operations.api_gateway_v2.delete_portal

        output, http_response = (
            capo_apigatewayv2._operations.api_gateway_v2.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_apigatewayv2.types.delete_portal_request.DeletePortalRequest = {
        "portal_id": portal_id
    }

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