Skip to content

CreateApiKeyRequest

Source code in docs_src/capo_api_gateway/types/create_api_key_request.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
class CreateApiKeyRequest(TypedDict, closed=True):
    name: NotRequired["capo_api_gateway.types.string.String"]
    """<p>The name of the ApiKey.</p>"""
    description: NotRequired["capo_api_gateway.types.string.String"]
    """<p>The description of the ApiKey.</p>"""
    enabled: "capo_api_gateway.types.boolean.Boolean"
    """<p>Specifies whether the ApiKey can be used by callers.</p>"""
    generate_distinct_id: "capo_api_gateway.types.boolean.Boolean"
    """<p>Specifies whether (<code>true</code>) or not (<code>false</code>) the key identifier is distinct from the created API key value. This parameter is deprecated and should not be used.</p>"""
    value: NotRequired["capo_api_gateway.types.string.String"]
    """<p>Specifies a value of the API key.</p>"""
    stage_keys: NotRequired["capo_api_gateway.types.list_of_stage_keys.ListOfStageKeys"]
    """<p>DEPRECATED FOR USAGE PLANS - Specifies stages associated with 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>"""
    tags: NotRequired[
        "capo_api_gateway.types.map_of_string_to_string.MapOfStringToString"
    ]
    """<p>The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with <code>aws:</code>. The tag value can be up to 256 characters.</p>"""

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

enabled instance-attribute 

enabled: Boolean

Specifies whether the ApiKey can be used by callers.

generate_distinct_id instance-attribute 

generate_distinct_id: Boolean

Specifies whether (true) or not (false) the key identifier is distinct from the created API key value. This parameter is deprecated and should not be used.

name instance-attribute 

name: NotRequired[String]

The name of the ApiKey.

stage_keys instance-attribute 

stage_keys: NotRequired[ListOfStageKeys]

DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.

tags instance-attribute 

tags: NotRequired[MapOfStringToString]

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

value instance-attribute 

value: NotRequired[String]

Specifies a value of the API key.