Class: Aws::APIGateway::Types::ImportApiKeysRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::APIGateway::Types::ImportApiKeysRequest
- Defined in:
- gems/aws-sdk-apigateway/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
-
#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.
4080 4081 4082 4083 4084 4085 4086 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 4080 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.
4080 4081 4082 4083 4084 4085 4086 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 4080 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.
4080 4081 4082 4083 4084 4085 4086 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 4080 class ImportApiKeysRequest < Struct.new( :body, :format, :fail_on_warnings) SENSITIVE = [] include Aws::Structure end |