apigateway/aws.sdk.kotlin.services.apigateway.model/ImportRestApiRequest

ImportRestApiRequest

class ImportRestApiRequest

A POST request to import an API to API Gateway using an input of an API definition file.

Types

Builder

class Builder

Companion

object Companion

Properties

body

val body: ByteArray?

The POST 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.

failOnWarnings

val failOnWarnings: Boolean?

A query parameter to indicate whether to rollback the API creation (true) or not (false) when a warning is encountered. The default value is false.

parameters

val parameters: Map<String, String>?

A key-value map of context-specific query string parameters specifying the behavior of different API importing operations. The following shows operation-specific parameters and their supported values.

Functions

copy

inline fun copy(block: ImportRestApiRequest.Builder.() -> Unit = {}): ImportRestApiRequest

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String