Skip to content

GetApiKeysRequest

Source code in docs_src/capo_api_gateway/types/get_api_keys_request.py 
13
14
15
16
17
18
19
20
21
22
23
24
25
class GetApiKeysRequest(TypedDict, closed=True):
    position: NotRequired["capo_api_gateway.types.string.String"]
    """<p>The current pagination position in the paged result set.</p>"""
    limit: NotRequired["capo_api_gateway.types.nullable_integer.NullableInteger"]
    """<p>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</p>"""
    name_query: NotRequired["capo_api_gateway.types.string.String"]
    """<p>The name of queried API keys.</p>"""
    customer_id: NotRequired["capo_api_gateway.types.string.String"]
    """<p>The identifier of a customer in Amazon Web Services Marketplace or an external system, such as a developer portal.</p>"""
    include_values: NotRequired[
        "capo_api_gateway.types.nullable_boolean.NullableBoolean"
    ]
    """<p>A boolean flag to specify whether (<code>true</code>) or not (<code>false</code>) the result contains key values.</p>"""

customer_id instance-attribute 

customer_id: NotRequired[String]

The identifier of a customer in Amazon Web Services Marketplace or an external system, such as a developer portal.

include_values instance-attribute 

include_values: NotRequired[NullableBoolean]

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

limit instance-attribute 

limit: NotRequired[NullableInteger]

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

name_query instance-attribute 

name_query: NotRequired[String]

The name of queried API keys.

position instance-attribute 

position: NotRequired[String]

The current pagination position in the paged result set.