Skip to content

ApiKey

Source code in docs_src/capo_api_gateway/types/api_key.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
class ApiKey(TypedDict, closed=True):
    id: NotRequired["capo_api_gateway.types.string.String"]
    """<p>The identifier of the API Key.</p>"""
    value: NotRequired["capo_api_gateway.types.string.String"]
    """<p>The value of the API Key.</p>"""
    name: NotRequired["capo_api_gateway.types.string.String"]
    """<p>The name of the API Key.</p>"""
    customer_id: NotRequired["capo_api_gateway.types.string.String"]
    """<p>An Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services SaaS Marketplace.</p>"""
    description: NotRequired["capo_api_gateway.types.string.String"]
    """<p>The description of the API Key.</p>"""
    enabled: "capo_api_gateway.types.boolean.Boolean"
    """<p>Specifies whether the API Key can be used by callers.</p>"""
    created_date: NotRequired["capo_api_gateway.types.timestamp.Timestamp"]
    """<p>The timestamp when the API Key was created.</p>"""
    last_updated_date: NotRequired["capo_api_gateway.types.timestamp.Timestamp"]
    """<p>The timestamp when the API Key was last updated.</p>"""
    stage_keys: NotRequired["capo_api_gateway.types.list_of_string.ListOfString"]
    """<p>A list of Stage resources that are associated with the ApiKey resource.</p>"""
    tags: NotRequired[
        "capo_api_gateway.types.map_of_string_to_string.MapOfStringToString"
    ]
    """<p>The collection of tags. Each tag element is associated with a given resource.</p>"""

created_date instance-attribute 

created_date: NotRequired[Timestamp]

The timestamp when the API Key was created.

customer_id instance-attribute 

customer_id: NotRequired[String]

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

description instance-attribute 

description: NotRequired[String]

The description of the API Key.

enabled instance-attribute 

enabled: Boolean

Specifies whether the API Key can be used by callers.

id instance-attribute 

id: NotRequired[String]

The identifier of the API Key.

last_updated_date instance-attribute 

last_updated_date: NotRequired[Timestamp]

The timestamp when the API Key was last updated.

name instance-attribute 

name: NotRequired[String]

The name of the API Key.

stage_keys instance-attribute 

stage_keys: NotRequired[ListOfString]

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

tags instance-attribute 

tags: NotRequired[MapOfStringToString]

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

value instance-attribute 

value: NotRequired[String]

The value of the API Key.