Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . apigateway ]

update-documentation-version

Description

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  update-documentation-version
--rest-api-id <value>
--documentation-version <value>
[--patch-operations <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--rest-api-id (string)

[Required] The string identifier of the associated RestApi ..

--documentation-version (string)

[Required] The version identifier of the to-be-updated documentation version.

--patch-operations (list)

A list of update operations to be applied to the specified resource and in the order specified in this list.

Shorthand Syntax:

op=string,path=string,value=string,from=string ...

JSON Syntax:

[
  {
    "op": "add"|"remove"|"replace"|"move"|"copy"|"test",
    "path": "string",
    "value": "string",
    "from": "string"
  }
  ...
]

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. 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.