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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing ImportApiKeysRequest as input to an Aws::Client method, you can use a vanilla 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)

    The payload of the POST request to import API keys.

#fail_on_warningsBoolean

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

Returns:

  • (Boolean)

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

#formatString

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

Possible values:

  • csv

Returns:

  • (String)

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