Skip to content

ApiGatewayApiAsset

Source code in docs_src/capo_dataexchange/types/api_gateway_api_asset.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
class ApiGatewayApiAsset(TypedDict, closed=True):
    api_description: NotRequired[
        "capo_dataexchange.types.api_description.ApiDescription"
    ]
    """<p>The API description of the API asset.</p>"""
    api_endpoint: NotRequired["capo_dataexchange.types.__string.__string"]
    """<p>The API endpoint of the API asset.</p>"""
    api_id: NotRequired["capo_dataexchange.types.__string.__string"]
    """<p>The unique identifier of the API asset.</p>"""
    api_key: NotRequired["capo_dataexchange.types.__string.__string"]
    """<p>The API key of the API asset.</p>"""
    api_name: NotRequired["capo_dataexchange.types.__string.__string"]
    """<p>The API name of the API asset.</p>"""
    api_specification_download_url: NotRequired[
        "capo_dataexchange.types.__string.__string"
    ]
    """<p>The download URL of the API specification of the API asset.</p>"""
    api_specification_download_url_expires_at: NotRequired[
        "capo_dataexchange.types.timestamp.Timestamp"
    ]
    """<p>The date and time that the upload URL expires, in ISO 8601 format.</p>"""
    protocol_type: NotRequired["capo_dataexchange.types.protocol_type.ProtocolType"]
    """<p>The protocol type of the API asset.</p>"""
    stage: NotRequired["capo_dataexchange.types.__string.__string"]
    """<p>The stage of the API asset.</p>"""

api_description instance-attribute 

api_description: NotRequired[ApiDescription]

The API description of the API asset.

api_endpoint instance-attribute 

api_endpoint: NotRequired[__string]

The API endpoint of the API asset.

api_id instance-attribute 

api_id: NotRequired[__string]

The unique identifier of the API asset.

api_key instance-attribute 

api_key: NotRequired[__string]

The API key of the API asset.

api_name instance-attribute 

api_name: NotRequired[__string]

The API name of the API asset.

api_specification_download_url instance-attribute 

api_specification_download_url: NotRequired[__string]

The download URL of the API specification of the API asset.

api_specification_download_url_expires_at instance-attribute 

api_specification_download_url_expires_at: NotRequired[Timestamp]

The date and time that the upload URL expires, in ISO 8601 format.

protocol_type instance-attribute 

protocol_type: NotRequired[ProtocolType]

The protocol type of the API asset.

stage instance-attribute 

stage: NotRequired[__string]

The stage of the API asset.