class Aws::APIGateway::Types::PutRestApiRequest
A PUT request to update an existing API, with external API definitions specified as the request body.
@note When making an API call, you may pass PutRestApiRequest
data as a hash: { rest_api_id: "String", # required mode: "merge", # accepts merge, overwrite fail_on_warnings: false, parameters: { "String" => "String", }, body: "data", # required }
@!attribute [rw] rest_api_id
\[Required\] The string identifier of the associated RestApi. @return [String]
@!attribute [rw] mode
The `mode` query parameter to specify the update mode. Valid values are "merge" and "overwrite". By default, the update mode is "merge". @return [String]
@!attribute [rw] 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`. @return [Boolean]
@!attribute [rw] parameters
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'`. @return [Hash<String,String>]
@!attribute [rw] body
\[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. @return [String]
Constants
- SENSITIVE