Skip to content

ChannelNamespace

Source code in docs_src/capo_appsync/types/channel_namespace.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
class ChannelNamespace(TypedDict, closed=True):
    api_id: NotRequired["capo_appsync.types.string.String"]
    """<p>The <code>Api</code> ID.</p>"""
    name: NotRequired["capo_appsync.types.namespace.Namespace"]
    """<p>The name of the channel namespace. This name must be unique within the <code>Api</code>.</p>"""
    subscribe_auth_modes: NotRequired["capo_appsync.types.auth_modes.AuthModes"]
    """<p>The authorization mode to use for subscribing to messages on the channel namespace. This configuration overrides the default <code>Api</code>authorization configuration.</p>"""
    publish_auth_modes: NotRequired["capo_appsync.types.auth_modes.AuthModes"]
    """<p>The authorization mode to use for publishing messages on the channel namespace. This configuration overrides the default <code>Api</code>authorization configuration.</p>"""
    code_handlers: NotRequired["capo_appsync.types.code.Code"]
    """<p>The event handler functions that run custom business logic to process published events and subscribe requests.</p>"""
    tags: NotRequired["capo_appsync.types.tag_map.TagMap"]
    channel_namespace_arn: NotRequired["capo_appsync.types.string.String"]
    """<p>The Amazon Resource Name (ARN) for the <code>ChannelNamespace</code>.</p>"""
    created: NotRequired["capo_appsync.types.timestamp.Timestamp"]
    """<p>The date and time that the <code>ChannelNamespace</code> was created.</p>"""
    last_modified: NotRequired["capo_appsync.types.timestamp.Timestamp"]
    """<p>The date and time that the <code>ChannelNamespace</code> was last changed.</p>"""
    handler_configs: NotRequired["capo_appsync.types.handler_configs.HandlerConfigs"]
    """<p>The configuration for the <code>OnPublish</code> and <code>OnSubscribe</code> handlers.</p>"""

api_id instance-attribute 

api_id: NotRequired[String]

The Api ID.

channel_namespace_arn instance-attribute 

channel_namespace_arn: NotRequired[String]

The Amazon Resource Name (ARN) for the ChannelNamespace.

code_handlers instance-attribute 

code_handlers: NotRequired[Code]

The event handler functions that run custom business logic to process published events and subscribe requests.

created instance-attribute 

created: NotRequired[Timestamp]

The date and time that the ChannelNamespace was created.

handler_configs instance-attribute 

handler_configs: NotRequired[HandlerConfigs]

The configuration for the OnPublish and OnSubscribe handlers.

last_modified instance-attribute 

last_modified: NotRequired[Timestamp]

The date and time that the ChannelNamespace was last changed.

name instance-attribute 

name: NotRequired[Namespace]

The name of the channel namespace. This name must be unique within the Api.

publish_auth_modes instance-attribute 

publish_auth_modes: NotRequired[AuthModes]

The authorization mode to use for publishing messages on the channel namespace. This configuration overrides the default Apiauthorization configuration.

subscribe_auth_modes instance-attribute 

subscribe_auth_modes: NotRequired[AuthModes]

The authorization mode to use for subscribing to messages on the channel namespace. This configuration overrides the default Apiauthorization configuration.

tags instance-attribute 

tags: NotRequired[TagMap]