ApiGatewayV2 / Client / get_portal_product

get_portal_product

ApiGatewayV2.Client.get_portal_product(**kwargs)

Gets a portal product.

See also: AWS API Documentation

Request Syntax

response = client.get_portal_product(
    PortalProductId='string',
    ResourceOwnerAccountId='string'
)
Parameters:

  • PortalProductId (string) –

    [REQUIRED]

    The portal product identifier.

  • ResourceOwnerAccountId (string) – The account ID of the resource owner of the portal product.

Return type:

dict

Returns:

Response Syntax

{
    'Description': 'string',
    'DisplayName': 'string',
    'DisplayOrder': {
        'Contents': [
            {
                'ProductRestEndpointPageArns': [
                    'string',
                ],
                'SectionName': 'string'
            },
        ],
        'OverviewPageArn': 'string',
        'ProductPageArns': [
            'string',
        ]
    },
    'LastModified': datetime(2015, 1, 1),
    'PortalProductArn': 'string',
    'PortalProductId': 'string',
    'Tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) –

    Success

    • Description (string) –

      The description of a portal product.

    • DisplayName (string) –

      The display name.

    • DisplayOrder (dict) –

      The display order.

      • Contents (list) –

        Represents a list of sections which include section name and list of product REST endpoints for a product.

        • (dict) –

          Contains the section name and list of product REST endpoints for a product.

          • ProductRestEndpointPageArns (list) –

            The ARNs of the product REST endpoint pages in a portal product.

            • (string) –

          • SectionName (string) –

            The section name.

      • OverviewPageArn (string) –

        The ARN of the overview page.

      • ProductPageArns (list) –

        The product page ARNs.

        • (string) –

    • LastModified (datetime) –

      The timestamp when the portal product was last modified.

    • PortalProductArn (string) –

      The ARN of the portal product.

    • PortalProductId (string) –

      The portal product identifier.

    • Tags (dict) –

      The collection of tags. Each tag element is associated with a given resource.

      • (string) –

        • (string) –

          A string with a length between [0-1600].

Exceptions