Class: Aws::APIGateway::Types::ImportApiKeysRequest

Inherits:

Struct

• Object
• Struct
• Aws::APIGateway::Types::ImportApiKeysRequest

Includes:

Structure

Defined in:

lib/aws-sdk-apigateway/types.rb

Overview

The POST request to import API keys from an external source, such as a CSV-formatted file.

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #body ⇒ String

  The payload of the POST request to import API keys.

• #fail_on_warnings ⇒ Boolean

  A query parameter to indicate whether to rollback ApiKey importation (‘true`) or not (`false`) when error is encountered.

• #format ⇒ String

  A query parameter to specify the input format to imported API keys.

Instance Attribute Details

#body ⇒ String

The payload of the POST request to import API keys. For the payload format, see API Key File Format.

Returns:

• (String)

# File 'lib/aws-sdk-apigateway/types.rb', line 3182

class ImportApiKeysRequest < Struct.new(
  :body,
  :format,
  :fail_on_warnings)
  SENSITIVE = []
  include Aws::Structure
end

#fail_on_warnings ⇒ Boolean

A query parameter to indicate whether to rollback ApiKey importation (‘true`) or not (`false`) when error is encountered.

Returns:

• (Boolean)

# File 'lib/aws-sdk-apigateway/types.rb', line 3182

class ImportApiKeysRequest < Struct.new(
  :body,
  :format,
  :fail_on_warnings)
  SENSITIVE = []
  include Aws::Structure
end

#format ⇒ String

A query parameter to specify the input format to imported API keys. Currently, only the ‘csv` format is supported.

Returns:

• (String)

# File 'lib/aws-sdk-apigateway/types.rb', line 3182

class ImportApiKeysRequest < Struct.new(
  :body,
  :format,
  :fail_on_warnings)
  SENSITIVE = []
  include Aws::Structure
end