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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-apigateway/types.rb

Overview

Note:

When making an API call, you may pass ImportApiKeysRequest data as a hash:

{
  body: "data", # required
  format: "csv", # required, accepts csv
  fail_on_warnings: false,
}

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

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#body ⇒ String

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

[1]: docs.aws.amazon.com/apigateway/latest/developerguide/api-key-file-format.html

Returns:

  • (String) 


4474
4475
4476
4477
4478
4479
4480
 
# File 'lib/aws-sdk-apigateway/types.rb', line 4474

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) 


4474
4475
4476
4477
4478
4479
4480
 
# File 'lib/aws-sdk-apigateway/types.rb', line 4474

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) 


4474
4475
4476
4477
4478
4479
4480
 
# File 'lib/aws-sdk-apigateway/types.rb', line 4474

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