Class: Aws::APIGateway::Types::PutRestApiRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::APIGateway::Types::PutRestApiRequest
- Defined in:
- gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb
Overview
A PUT request to update an existing API, with external API definitions specified as the request body.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#body ⇒ String
The PUT request body containing external API definitions.
-
#fail_on_warnings ⇒ Boolean
A query parameter to indicate whether to rollback the API update (
true
) or not (false
) when a warning is encountered. -
#mode ⇒ String
The
mode
query parameter to specify the update mode. -
#parameters ⇒ Hash<String,String>
Custom header parameters as part of the request.
-
#rest_api_id ⇒ String
The string identifier of the associated RestApi.
Instance Attribute Details
#body ⇒ String
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.
4548 4549 4550 4551 4552 4553 4554 4555 4556 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 4548 class PutRestApiRequest < Struct.new( :rest_api_id, :mode, :fail_on_warnings, :parameters, :body) SENSITIVE = [] include Aws::Structure end |
#fail_on_warnings ⇒ Boolean
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
.
4548 4549 4550 4551 4552 4553 4554 4555 4556 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 4548 class PutRestApiRequest < Struct.new( :rest_api_id, :mode, :fail_on_warnings, :parameters, :body) SENSITIVE = [] include Aws::Structure end |
#mode ⇒ String
The mode
query parameter to specify the update mode. Valid values
are "merge" and "overwrite". By default, the update mode is
"merge".
4548 4549 4550 4551 4552 4553 4554 4555 4556 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 4548 class PutRestApiRequest < Struct.new( :rest_api_id, :mode, :fail_on_warnings, :parameters, :body) SENSITIVE = [] include Aws::Structure end |
#parameters ⇒ Hash<String,String>
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'
.
4548 4549 4550 4551 4552 4553 4554 4555 4556 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 4548 class PutRestApiRequest < Struct.new( :rest_api_id, :mode, :fail_on_warnings, :parameters, :body) SENSITIVE = [] include Aws::Structure end |
#rest_api_id ⇒ String
The string identifier of the associated RestApi.
4548 4549 4550 4551 4552 4553 4554 4555 4556 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 4548 class PutRestApiRequest < Struct.new( :rest_api_id, :mode, :fail_on_warnings, :parameters, :body) SENSITIVE = [] include Aws::Structure end |