PutRestApiRequest

public struct PutRestApiRequest : AWSShape

Undocumented

  • The key for the payload

    Declaration

    Swift

    public static let payloadPath: String?

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

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

    Declaration

    Swift

    public let body: Data

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

    Declaration

    Swift

    public let failOnWarnings: Bool?

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

    Declaration

    Swift

    public let mode: PutMode?

  • 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’.

    Declaration

    Swift

    public let parameters: [String : String]?

  • [Required] The string identifier of the associated RestApi.

    Declaration

    Swift

    public let restApiId: String

  • Undocumented

    Declaration

    Swift

    public init(body: Data, failOnWarnings: Bool? = nil, mode: PutMode? = nil, parameters: [String : String]? = nil, restApiId: String)