Skip to content

CreateChannelNamespaceRequest

Source code in docs_src/capo_appsync/types/create_channel_namespace_request.py 
18
19
20
21
22
23
24
25
26
27
28
29
30
31
class CreateChannelNamespaceRequest(TypedDict, closed=True):
    api_id: "capo_appsync.types.string.String"
    """<p>The <code>Api</code> ID.</p>"""
    name: "capo_appsync.types.namespace.Namespace"
    """<p>The name of the <code>ChannelNamespace</code>. 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"]
    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: String

The Api ID.

code_handlers instance-attribute 

code_handlers: NotRequired[Code]

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

handler_configs instance-attribute 

handler_configs: NotRequired[HandlerConfigs]

The configuration for the OnPublish and OnSubscribe handlers.

name instance-attribute 

name: Namespace

The name of the ChannelNamespace. 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 Api authorization 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 Api authorization configuration.

tags instance-attribute 

tags: NotRequired[TagMap]