Skip to content

get_api_key

Operation

get_api_key

get_api_key(request: GetApiKeyInput | GetApiKeyInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetApiKeyInputDict]) -> GetApiKeyOutput

Gets information about the current ApiKey resource.

Parameters:

Name Type Description Default
request GetApiKeyInput | GetApiKeyInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[GetApiKeyInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetApiKeyOutput

An instance of GetApiKeyOutput.

get_api_key async

get_api_key(request: GetApiKeyInput | GetApiKeyInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetApiKeyInputDict]) -> GetApiKeyOutput

Gets information about the current ApiKey resource.

Parameters:

Name Type Description Default
request GetApiKeyInput | GetApiKeyInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[GetApiKeyInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetApiKeyOutput

An instance of GetApiKeyOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

GetApiKeyInputDict

Bases: TypedDict

Dictionary form of GetApiKeyInput.

Attributes

api_key instance-attribute
api_key: Required[str]

The identifier of the ApiKey resource.

include_value instance-attribute
include_value: bool | None

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

GetApiKeyInput dataclass

Bases: _SerdeShape

A request to get information about the current ApiKey resource.

Attributes

api_key class-attribute instance-attribute
api_key: str | None = ...

The identifier of the ApiKey resource.

include_value class-attribute instance-attribute
include_value: bool | None = ...

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

Output

GetApiKeyOutput dataclass

Bases: _SerdeShape

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 = ...

The timestamp when the API Key was created.

customer_id class-attribute instance-attribute
customer_id: str | 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 = ...

The description of the API Key.

enabled class-attribute instance-attribute
enabled: bool = ...

Specifies whether the API Key can be used by callers.

id class-attribute instance-attribute
id: str | None = ...

The identifier of the API Key.

last_updated_date class-attribute instance-attribute
last_updated_date: datetime | None = ...

The timestamp when the API Key was last updated.

name class-attribute instance-attribute
name: str | None = ...

The name of the API Key.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

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.

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

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

tags class-attribute instance-attribute
tags: dict[str, str] | None = ...

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

value class-attribute instance-attribute
value: str | None = ...

The value of the API Key.