ApiGatewayV2 / Client / create_product_rest_endpoint_page

create_product_rest_endpoint_page

ApiGatewayV2.Client.create_product_rest_endpoint_page(**kwargs)

Creates a product REST endpoint page for a portal product.

See also: AWS API Documentation

Request Syntax

response = client.create_product_rest_endpoint_page(
    DisplayContent={
        'None': {}
        ,
        'Overrides': {
            'Body': 'string',
            'Endpoint': 'string',
            'OperationName': 'string'
        }
    },
    PortalProductId='string',
    RestEndpointIdentifier={
        'IdentifierParts': {
            'Method': 'string',
            'Path': 'string',
            'RestApiId': 'string',
            'Stage': 'string'
        }
    },
    TryItState='ENABLED'|'DISABLED'
)

Parameters:

• DisplayContent (dict) –

  The content of the product REST endpoint page.

  • None (dict) –

    If your product REST endpoint contains no overrides, the none object is returned.

  • Overrides (dict) –

    The overrides for endpoint display content.

    • Body (string) –

      By default, this is the documentation of your REST API from API Gateway. You can provide custom documentation to override this value.

    • Endpoint (string) –

      The URL for your REST API. By default, API Gateway uses the default execute API endpoint. You can provide a custom domain to override this value.

    • OperationName (string) –

      The operation name of the product REST endpoint.

• PortalProductId (string) –

  [REQUIRED]

  The portal product identifier.

• RestEndpointIdentifier (dict) –

  [REQUIRED]

  The REST endpoint identifier.

  • IdentifierParts (dict) –

    The identifier parts of the REST endpoint identifier.

    • Method (string) – [REQUIRED]

      The method of the product REST endpoint.

    • Path (string) – [REQUIRED]

      The path of the product REST endpoint.

    • RestApiId (string) – [REQUIRED]

      The REST API ID of the product REST endpoint.

    • Stage (string) – [REQUIRED]

      The stage of the product REST endpoint.

• TryItState (string) – The try it state of the product REST endpoint page.

Return type:

dict

Returns:

Response Syntax

{
    'DisplayContent': {
        'Body': 'string',
        'Endpoint': 'string',
        'OperationName': 'string'
    },
    'LastModified': datetime(2015, 1, 1),
    'ProductRestEndpointPageArn': 'string',
    'ProductRestEndpointPageId': 'string',
    'RestEndpointIdentifier': {
        'IdentifierParts': {
            'Method': 'string',
            'Path': 'string',
            'RestApiId': 'string',
            'Stage': 'string'
        }
    },
    'Status': 'AVAILABLE'|'IN_PROGRESS'|'FAILED',
    'StatusException': {
        'Exception': 'string',
        'Message': 'string'
    },
    'TryItState': 'ENABLED'|'DISABLED'
}

Response Structure

• (dict) –

  The request has succeeded and has resulted in the creation of a resource.

  • DisplayContent (dict) –

    The display content.

    • Body (string) –

      The API documentation.

    • Endpoint (string) –

      The URL to invoke your REST API.

    • OperationName (string) –

      The operation name.

  • LastModified (datetime) –

    The timestamp when the product REST endpoint page was last modified.

  • ProductRestEndpointPageArn (string) –

    The ARN of the product REST endpoint page.

  • ProductRestEndpointPageId (string) –

    The product REST endpoint page identifier.

  • RestEndpointIdentifier (dict) –

    The REST endpoint identifier.

    • IdentifierParts (dict) –

      The identifier parts of the REST endpoint identifier.

      • Method (string) –

        The method of the product REST endpoint.

      • Path (string) –

        The path of the product REST endpoint.

      • RestApiId (string) –

        The REST API ID of the product REST endpoint.

      • Stage (string) –

        The stage of the product REST endpoint.

  • Status (string) –

    The status.

  • StatusException (dict) –

    The status exception information.

    • Exception (string) –

      The exception.

    • Message (string) –

      The error message.

  • TryItState (string) –

    The try it state.

Exceptions

• ApiGatewayV2.Client.exceptions.NotFoundException

• ApiGatewayV2.Client.exceptions.TooManyRequestsException

• ApiGatewayV2.Client.exceptions.BadRequestException

• ApiGatewayV2.Client.exceptions.AccessDeniedException