update_portal_product ¶

def update_portal_product(
    self,
    portal_product_id: "capo_apigatewayv2.types.__string.__string",
    *,
    config_overrides: Optional[ApiGatewayV2ClientConfig] = None,
    description: Optional[
        "capo_apigatewayv2.types.__string_min0_max1024.__stringMin0Max1024"
    ] = None,
    display_name: Optional[
        "capo_apigatewayv2.types.__string_min1_max255.__stringMin1Max255"
    ] = None,
    display_order: Optional[
        "capo_apigatewayv2.types.display_order.DisplayOrder"
    ] = None,
) -> "capo_apigatewayv2.types.update_portal_product_response.UpdatePortalProductResponse":
    """<p>Updates the portal product.</p>

    Args:
        description: <p>The description.</p>
        display_name: <p>The displayName.</p>
        display_order: <p>The display order.</p>
        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.update_portal_product_request.UpdatePortalProductRequest]",
    ) -> OperationResponse[
        "capo_apigatewayv2.types.update_portal_product_response.UpdatePortalProductResponse"
    ]:
        import capo_apigatewayv2._operations.api_gateway_v2.update_portal_product

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdatePortalProduct")
    )
    input_: capo_apigatewayv2.types.update_portal_product_request.UpdatePortalProductRequest = {
        "portal_product_id": portal_product_id
    }
    if description is not None:
        input_["description"] = description
    if display_name is not None:
        input_["display_name"] = display_name
    if display_order is not None:
        input_["display_order"] = display_order

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