Skip to content

delete_portal_product

delete_portal_product(
    portal_product_id: __string,
    *,
    config_overrides: Optional[ApiGatewayV2ClientConfig] = None,
) -> None

Deletes a portal product.

Parameters:

  • portal_product_id (__string) –

    The portal product identifier.

Raises:

  • BadRequestException –

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

  • NotFoundException –

    The resource specified in the request was not found. See the message field for more information.

  • 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_product(
    self,
    portal_product_id: "capo_apigatewayv2.types.__string.__string",
    *,
    config_overrides: Optional[ApiGatewayV2ClientConfig] = None,
) -> None:
    """<p>Deletes a portal product.</p>

    Args:
        portal_product_id: <p>The portal product 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.not_found_exception.NotFoundException: <p>The resource specified in the request was not found. See the message field for more information.</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_product_request.DeletePortalProductRequest]",
    ) -> OperationResponse[None]:
        import capo_apigatewayv2._operations.api_gateway_v2.delete_portal_product

        output, http_response = (
            capo_apigatewayv2._operations.api_gateway_v2.delete_portal_product.delete_portal_product(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeletePortalProduct")
    )
    input_: capo_apigatewayv2.types.delete_portal_product_request.DeletePortalProductRequest = {
        "portal_product_id": portal_product_id
    }

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