Skip to content

API Gateway  >  Operations  >  import_api_keys

import_api_keys

Operation

import_api_keys async 

import_api_keys(input: ImportApiKeysInput, plugins: list[Plugin] | None = None) -> ImportApiKeysOutput

Import API keys from an external source, such as a CSV-formatted file.

Parameters:

Name Type Description Default
input ImportApiKeysInput

An instance of ImportApiKeysInput.

 required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

 None

Returns:

Type Description
ImportApiKeysOutput

An instance of ImportApiKeysOutput.

Input

ImportApiKeysInput dataclass

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

Attributes

body class-attribute instance-attribute 
body: bytes | None = None

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

fail_on_warnings class-attribute instance-attribute 
fail_on_warnings: bool = False

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

format class-attribute instance-attribute 
format: str | None = None

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

Output

ImportApiKeysOutput dataclass

The identifier of an ApiKey used in a UsagePlan.

Attributes

ids class-attribute instance-attribute 
ids: list[str] | None = None

A list of all the ApiKey identifiers.

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = field(default=EMPTY_RESPONSE_METADATA, repr=False, compare=False)

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

warnings class-attribute instance-attribute 
warnings: list[str] | None = None

A list of warning messages.