Put Rest Api

apigateway_put_rest_api

R Documentation

A feature of the API Gateway control service for updating an existing API with an input of external API definitions¶

Description¶

A feature of the API Gateway control service for updating an existing API with an input of external API definitions. The update can take the form of merging the supplied definition into the existing API or overwriting the existing API.

Usage¶

apigateway_put_rest_api(restApiId, mode, failOnWarnings, parameters,
  body)

Arguments¶

restApiId

[required] The string identifier of the associated RestApi.

mode

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

failOnWarnings

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.

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

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.

Value¶

A list with the following syntax:

list(
  id = "string",
  name = "string",
  description = "string",
  createdDate = as.POSIXct(
    "2015-01-01"
  ),
  version = "string",
  warnings = list(
    "string"
  ),
  binaryMediaTypes = list(
    "string"
  ),
  minimumCompressionSize = 123,
  apiKeySource = "HEADER"|"AUTHORIZER",
  endpointConfiguration = list(
    types = list(
      "REGIONAL"|"EDGE"|"PRIVATE"
    ),
    vpcEndpointIds = list(
      "string"
    )
  ),
  policy = "string",
  tags = list(
    "string"
  ),
  disableExecuteApiEndpoint = TRUE|FALSE,
  rootResourceId = "string"
)

Request syntax¶

svc$put_rest_api(
  restApiId = "string",
  mode = "merge"|"overwrite",
  failOnWarnings = TRUE|FALSE,
  parameters = list(
    "string"
  ),
  body = raw
)