Api Gateway  >  Operations  >  get_api_key

get_api_key

Operation

get_api_key async

get_api_key(input: GetApiKeyInput, plugins: list[Plugin] | None = None) -> GetApiKeyOutput

Gets information about the current ApiKey resource.

Parameters:

Name	Type	Description	Default
input	GetApiKeyInput	An instance of GetApiKeyInput.	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
GetApiKeyOutput	An instance of GetApiKeyOutput.

Input

GetApiKeyInput dataclass

A request to get information about the current ApiKey resource.

Attributes

api_key class-attribute instance-attribute

api_key: str | None = None

The identifier of the ApiKey resource.

include_value class-attribute instance-attribute

include_value: bool | None = None

A boolean flag to specify whether (true) or not (false) the result contains the key value.

Output

GetApiKeyOutput dataclass

A resource that can be distributed to callers for executing Method resources that require an API key. API keys can be mapped to any Stage on any RestApi, which indicates that the callers with the API key can make requests to that stage.

Attributes

created_date class-attribute instance-attribute

created_date: datetime | None = None

The timestamp when the API Key was created.

customer_id class-attribute instance-attribute

customer_id: str | None = None

An Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services SaaS Marketplace.

description class-attribute instance-attribute

description: str | None = None

The description of the API Key.

enabled class-attribute instance-attribute

enabled: bool = False

Specifies whether the API Key can be used by callers.

id class-attribute instance-attribute

id: str | None = None

The identifier of the API Key.

last_updated_date class-attribute instance-attribute

last_updated_date: datetime | None = None

The timestamp when the API Key was last updated.

name class-attribute instance-attribute

name: str | None = None

The name of the API Key.

stage_keys class-attribute instance-attribute

stage_keys: list[str] | None = None

A list of Stage resources that are associated with the ApiKey resource.

tags class-attribute instance-attribute

tags: dict[str, str] | None = None

The collection of tags. Each tag element is associated with a given resource.

value class-attribute instance-attribute

value: str | None = None

The value of the API Key.