Skip to content

ApiKey

Structure Class

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

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.