Reimport Api

apigatewayv2_reimport_api

R Documentation

Puts an Api resource

Description

Puts an Api resource.

Usage

apigatewayv2_reimport_api(ApiId, Basepath, Body, FailOnWarnings)

Arguments

ApiId

[required] The API identifier.

Basepath

Specifies how to interpret the base path of the API during import. Valid values are ignore, prepend, and split. The default value is ignore. To learn more, see Set the OpenAPI basePath Property. Supported only for HTTP APIs.

Body

[required] The OpenAPI definition. Supported only for HTTP APIs.

FailOnWarnings

Specifies whether to rollback the API creation when a warning is encountered. By default, API creation continues if a warning is encountered.

Value

A list with the following syntax:

list(
  ApiEndpoint = "string",
  ApiGatewayManaged = TRUE|FALSE,
  ApiId = "string",
  ApiKeySelectionExpression = "string",
  CorsConfiguration = list(
    AllowCredentials = TRUE|FALSE,
    AllowHeaders = list(
      "string"
    ),
    AllowMethods = list(
      "string"
    ),
    AllowOrigins = list(
      "string"
    ),
    ExposeHeaders = list(
      "string"
    ),
    MaxAge = 123
  ),
  CreatedDate = as.POSIXct(
    "2015-01-01"
  ),
  Description = "string",
  DisableSchemaValidation = TRUE|FALSE,
  DisableExecuteApiEndpoint = TRUE|FALSE,
  ImportInfo = list(
    "string"
  ),
  Name = "string",
  ProtocolType = "WEBSOCKET"|"HTTP",
  RouteSelectionExpression = "string",
  Tags = list(
    "string"
  ),
  Version = "string",
  Warnings = list(
    "string"
  )
)

Request syntax

svc$reimport_api(
  ApiId = "string",
  Basepath = "string",
  Body = "string",
  FailOnWarnings = TRUE|FALSE
)