[ aws . apigateway ]

create-documentation-version

Description

Creates a documentation version

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-documentation-version
--rest-api-id <value>
--documentation-version <value>
[--stage-name <value>]
[--description <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--rest-api-id (string)

The string identifier of the associated RestApi.

--documentation-version (string)

The version identifier of the new snapshot.

--stage-name (string)

The stage name to be associated with the new documentation snapshot.

--description (string)

A description about the new documentation snapshot.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

version -> (string)

The version identifier of the API documentation snapshot.

createdDate -> (timestamp)

The date when the API documentation snapshot is created.

description -> (string)

The description of the API documentation snapshot.