Skip to content

create_product_rest_endpoint_page

create_product_rest_endpoint_page(
    portal_product_id: __string,
    *,
    config_overrides: Optional[ApiGatewayV2ClientConfig] = None,
    display_content: Optional[EndpointDisplayContent] = None,
    rest_endpoint_identifier: Optional[RestEndpointIdentifier] = None,
    try_it_state: Optional[TryItState] = None,
) -> CreateProductRestEndpointPageResponse

Creates a product REST endpoint page for a portal product.

Parameters:

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 create_product_rest_endpoint_page(
    self,
    portal_product_id: "capo_apigatewayv2.types.__string.__string",
    *,
    config_overrides: Optional[ApiGatewayV2ClientConfig] = None,
    display_content: Optional[
        "capo_apigatewayv2.types.endpoint_display_content.EndpointDisplayContent"
    ] = None,
    rest_endpoint_identifier: Optional[
        "capo_apigatewayv2.types.rest_endpoint_identifier.RestEndpointIdentifier"
    ] = None,
    try_it_state: Optional[
        "capo_apigatewayv2.types.try_it_state.TryItState"
    ] = None,
) -> "capo_apigatewayv2.types.create_product_rest_endpoint_page_response.CreateProductRestEndpointPageResponse":
    """<p>Creates a product REST endpoint page for a portal product.</p>

    Args:
        display_content: <p>The content of the product REST endpoint page.</p>
        portal_product_id: <p>The portal product identifier.</p>
        rest_endpoint_identifier: <p>The REST endpoint identifier.</p>
        try_it_state: <p>The try it state of the product REST endpoint page.</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.create_product_rest_endpoint_page_request.CreateProductRestEndpointPageRequest]",
    ) -> OperationResponse[
        "capo_apigatewayv2.types.create_product_rest_endpoint_page_response.CreateProductRestEndpointPageResponse"
    ]:
        import capo_apigatewayv2._operations.api_gateway_v2.create_product_rest_endpoint_page

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateProductRestEndpointPage")
    )
    input_: capo_apigatewayv2.types.create_product_rest_endpoint_page_request.CreateProductRestEndpointPageRequest = {
        "portal_product_id": portal_product_id
    }
    if display_content is not None:
        input_["display_content"] = display_content
    if rest_endpoint_identifier is not None:
        input_["rest_endpoint_identifier"] = rest_endpoint_identifier
    if try_it_state is not None:
        input_["try_it_state"] = try_it_state

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