You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::APIGateway::Types::PutRestApiRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb

Overview

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
}

A PUT request to update an existing API, with external API definitions specified as the request body.

Instance Attribute Summary collapse

Instance Attribute Details

#bodyString

The PUT request body containing external API definitions. Currently, only Swagger definition JSON files are supported. The maximum size of the API definition file is 2MB.

Returns:

  • (String)


5094
5095
5096
5097
5098
5099
5100
5101
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 5094

class PutRestApiRequest < Struct.new(
  :rest_api_id,
  :mode,
  :fail_on_warnings,
  :parameters,
  :body)
  include Aws::Structure
end

#fail_on_warningsBoolean

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.

Returns:

  • (Boolean)


5094
5095
5096
5097
5098
5099
5100
5101
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 5094

class PutRestApiRequest < Struct.new(
  :rest_api_id,
  :mode,
  :fail_on_warnings,
  :parameters,
  :body)
  include Aws::Structure
end

#modeString

The mode query parameter to specify the update mode. Valid values are "merge" and "overwrite". By default, the update mode is "merge".

Returns:

  • (String)


5094
5095
5096
5097
5098
5099
5100
5101
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 5094

class PutRestApiRequest < Struct.new(
  :rest_api_id,
  :mode,
  :fail_on_warnings,
  :parameters,
  :body)
  include Aws::Structure
end

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

Returns:

  • (Hash<String,String>)


5094
5095
5096
5097
5098
5099
5100
5101
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 5094

class PutRestApiRequest < Struct.new(
  :rest_api_id,
  :mode,
  :fail_on_warnings,
  :parameters,
  :body)
  include Aws::Structure
end

#rest_api_idString

The string identifier of the associated RestApi.

Returns:

  • (String)


5094
5095
5096
5097
5098
5099
5100
5101
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 5094

class PutRestApiRequest < Struct.new(
  :rest_api_id,
  :mode,
  :fail_on_warnings,
  :parameters,
  :body)
  include Aws::Structure
end