Skip to content

AppInstanceUserEndpointSummary

Source code in docs_src/capo_chime_sdk_identity/types/app_instance_user_endpoint_summary.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
class AppInstanceUserEndpointSummary(TypedDict, closed=True):
    app_instance_user_arn: NotRequired[
        "capo_chime_sdk_identity.types.chime_arn.ChimeArn"
    ]
    """<p>The ARN of the <code>AppInstanceUser</code>.</p>"""
    endpoint_id: NotRequired["capo_chime_sdk_identity.types.string64.String64"]
    """<p>The unique identifier of the <code>AppInstanceUserEndpoint</code>.</p>"""
    name: NotRequired[
        "capo_chime_sdk_identity.types.sensitive_string1600.SensitiveString1600"
    ]
    """<p>The name of the <code>AppInstanceUserEndpoint</code>.</p>"""
    type: NotRequired[
        "capo_chime_sdk_identity.types.app_instance_user_endpoint_type.AppInstanceUserEndpointType"
    ]
    """<p>The type of the <code>AppInstanceUserEndpoint</code>.</p>"""
    allow_messages: NotRequired[
        "capo_chime_sdk_identity.types.allow_messages.AllowMessages"
    ]
    """<p>BBoolean that controls whether the <code>AppInstanceUserEndpoint</code> is opted in to receive messages. <code>ALL</code> indicates the endpoint will receive all messages. <code>NONE</code> indicates the endpoint will receive no messages.</p>"""
    endpoint_state: NotRequired[
        "capo_chime_sdk_identity.types.endpoint_state.EndpointState"
    ]
    """<p>A read-only field that represent the state of an <code>AppInstanceUserEndpoint</code>.</p>"""

allow_messages instance-attribute 

allow_messages: NotRequired[AllowMessages]

BBoolean that controls whether the AppInstanceUserEndpoint is opted in to receive messages. ALL indicates the endpoint will receive all messages. NONE indicates the endpoint will receive no messages.

app_instance_user_arn instance-attribute 

app_instance_user_arn: NotRequired[ChimeArn]

The ARN of the AppInstanceUser.

endpoint_id instance-attribute 

endpoint_id: NotRequired[String64]

The unique identifier of the AppInstanceUserEndpoint.

endpoint_state instance-attribute 

endpoint_state: NotRequired[EndpointState]

A read-only field that represent the state of an AppInstanceUserEndpoint.

name instance-attribute 

name: NotRequired[SensitiveString1600]

The name of the AppInstanceUserEndpoint.

type instance-attribute 

type: NotRequired[AppInstanceUserEndpointType]

The type of the AppInstanceUserEndpoint.