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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing PutRestApiRequest as input to an Aws::Client method, you can use a vanilla 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

#body ⇒ String

[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.

Returns:

  • (String) —

    [Required] 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. The default value is false.

Returns:

  • (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. Valid values are \"merge\" and \"overwrite\". By default, the update mode is \"merge\".

Possible values:

  • merge
  • overwrite

Returns:

  • (String) —

    The mode query parameter to specify the update mode.

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

Returns:

  • (Hash<String,String>) —

    Custom header parameters as part of the request.

#rest_api_id ⇒ String

[Required] The string identifier of the associated RestApi.

Returns:

  • (String) —

    [Required] The string identifier of the associated RestApi.