aws apigateway put-rest-api
A feature of the API Gateway control service for updating an existing API with an input of external API definitions. The update can take the form of merging the supplied definition into the existing API or overwriting the existing API
Options
| Name | Description |
|---|---|
--rest-api-id <string> | [Required] The string identifier of the associated RestApi |
--mode <string> | The mode query parameter to specify the update mode. Valid values are "merge" and "overwrite". By default, the update mode is "merge" |
--fail-on-warnings | A query parameter to indicate whether to rollback the API update (true) or not (false) when a warning is encountered. The default value is false |
--no-fail-on-warnings | A query parameter to indicate whether to rollback the API update (true) or not (false) when a warning is encountered. The default value is false |
--parameters <map> | Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set ignore=documentation as a parameters value, as in the AWS CLI command of aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json' |
--body <blob> | [Required] The PUT request body containing external API definitions. Currently, only OpenAPI definition JSON/YAML files are supported. The maximum size of the API definition file is 6MB |
--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 |