You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::APIGateway::Types::PutRestApiRequestWhen passing PutRestApiRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
rest_api_id: "String", mode: "merge", fail_on_warnings: false,
parameters: {
"String" => "String",
},
body: "data", }
A PUT request to update an existing API, with external API definitions specified as the request body.
Instance Attribute Summary collapse[Required] The PUT request body containing external API definitions.
A query parameter to indicate whether to rollback the API update (true
) or not (false
) when a warning is encountered.
The mode
query parameter to specify the update mode.
Custom header parameters as part of the request.
[Required] The string identifier of the associated RestApi.
[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.
#fail_on_warnings ⇒ BooleanA query parameter to indicate whether to rollback the API update (true
) or not (false
) when a warning is encountered. The default value is false
.
The mode
query parameter to specify the update mode. Valid values are \"merge\" and \"overwrite\". By default, the update mode is \"merge\".
Possible values:
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'
.
[Required] The string identifier of the associated RestApi.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4