Skip to content

Api

Source code in docs_src/capo_appsync/types/api.py 
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
class Api(TypedDict, closed=True):
    api_id: NotRequired["capo_appsync.types.string.String"]
    """<p>The <code>Api</code> ID.</p>"""
    name: NotRequired["capo_appsync.types.api_name.ApiName"]
    """<p>The name of the <code>Api</code>.</p>"""
    owner_contact: NotRequired["capo_appsync.types.owner_contact.OwnerContact"]
    """<p>The owner contact information for the <code>Api</code> </p>"""
    tags: NotRequired["capo_appsync.types.tag_map.TagMap"]
    dns: NotRequired["capo_appsync.types.map_of_string_to_string.MapOfStringToString"]
    """<p>The DNS records for the API. This will include an HTTP and a real-time endpoint.</p>"""
    api_arn: NotRequired["capo_appsync.types.string.String"]
    """<p>The Amazon Resource Name (ARN) for the <code>Api</code>.</p>"""
    created: NotRequired["capo_appsync.types.timestamp.Timestamp"]
    """<p>The date and time that the <code>Api</code> was created.</p>"""
    xray_enabled: "capo_appsync.types.boolean.Boolean"
    """<p>A flag indicating whether to use X-Ray tracing for this <code>Api</code>.</p>"""
    waf_web_acl_arn: NotRequired["capo_appsync.types.string.String"]
    """<p>The Amazon Resource Name (ARN) of the WAF web access control list (web ACL) associated with this <code>Api</code>, if one exists.</p>"""
    event_config: NotRequired["capo_appsync.types.event_config.EventConfig"]
    """<p>The Event API configuration. This includes the default authorization configuration for connecting, publishing, and subscribing to an Event API.</p>"""

api_arn instance-attribute 

api_arn: NotRequired[String]

The Amazon Resource Name (ARN) for the Api.

api_id instance-attribute 

api_id: NotRequired[String]

The Api ID.

created instance-attribute 

created: NotRequired[Timestamp]

The date and time that the Api was created.

dns instance-attribute 

dns: NotRequired[MapOfStringToString]

The DNS records for the API. This will include an HTTP and a real-time endpoint.

event_config instance-attribute 

event_config: NotRequired[EventConfig]

The Event API configuration. This includes the default authorization configuration for connecting, publishing, and subscribing to an Event API.

name instance-attribute 

name: NotRequired[ApiName]

The name of the Api.

owner_contact instance-attribute 

owner_contact: NotRequired[OwnerContact]

The owner contact information for the Api

tags instance-attribute 

tags: NotRequired[TagMap]

waf_web_acl_arn instance-attribute 

waf_web_acl_arn: NotRequired[String]

The Amazon Resource Name (ARN) of the WAF web access control list (web ACL) associated with this Api, if one exists.

xray_enabled instance-attribute 

xray_enabled: Boolean

A flag indicating whether to use X-Ray tracing for this Api.