APIGateway / Client / create_documentation_version

create_documentation_version#

APIGateway.Client.create_documentation_version(**kwargs)#

Creates a documentation version

See also: AWS API Documentation

Request Syntax

response = client.create_documentation_version(
    restApiId='string',
    documentationVersion='string',
    stageName='string',
    description='string'
)
Parameters:

  • restApiId (string) –

    [REQUIRED]

    The string identifier of the associated RestApi.

  • documentationVersion (string) –

    [REQUIRED]

    The version identifier of the new snapshot.

  • stageName (string) – The stage name to be associated with the new documentation snapshot.

  • description (string) – A description about the new documentation snapshot.

Return type:

dict

Returns:

Response Syntax

{
    'version': 'string',
    'createdDate': datetime(2015, 1, 1),
    'description': 'string'
}

Response Structure

  • (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

  • APIGateway.Client.exceptions.BadRequestException

  • APIGateway.Client.exceptions.ConflictException

  • APIGateway.Client.exceptions.LimitExceededException

  • APIGateway.Client.exceptions.NotFoundException

  • APIGateway.Client.exceptions.UnauthorizedException

  • APIGateway.Client.exceptions.TooManyRequestsException