You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
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.

Instance Attribute Summary collapse

Instance Attribute Details

#bodyString

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

Returns:

  • (String)


3713
3714
3715
3716
3717
3718
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 3713

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

#fail_on_warningsBoolean

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

Returns:

  • (Boolean)


3713
3714
3715
3716
3717
3718
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 3713

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

#formatString

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

Returns:

  • (String)


3713
3714
3715
3716
3717
3718
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 3713

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