APIGateway / Client / get_documentation_versions

get_documentation_versions#

APIGateway.Client.get_documentation_versions(**kwargs)#

Gets documentation versions.

See also: AWS API Documentation

Request Syntax

response = client.get_documentation_versions(
    restApiId='string',
    position='string',
    limit=123
)
Parameters:

  • restApiId (string) –

    [REQUIRED]

    The string identifier of the associated RestApi.

  • position (string) – The current pagination position in the paged result set.

  • limit (integer) – The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

Return type:

dict

Returns:

Response Syntax

{
    'position': 'string',
    'items': [
        {
            'version': 'string',
            'createdDate': datetime(2015, 1, 1),
            'description': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    The collection of documentation snapshots of an API.

    • position (string) –

    • items (list) –

      The current page of elements from this collection.

      • (dict) –

        A snapshot of the documentation of an API.

        • version (string) –

          The version identifier of the API documentation snapshot.

        • createdDate (datetime) –

          The date when the API documentation snapshot is created.

        • description (string) –

          The description of the API documentation snapshot.

Exceptions