Skip to content

Type definitions#

Index > ChimeSDKMessaging > Type definitions

Auto-generated documentation for ChimeSDKMessaging type annotations stubs module mypy-boto3-chime-sdk-messaging.

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

MessageAttributeValueUnionTypeDef#

# MessageAttributeValueUnionTypeDef definition

MessageAttributeValueUnionTypeDef = Union[
    MessageAttributeValueTypeDef,  # (1)
    MessageAttributeValueOutputTypeDef,  # (2)
]
  1. See MessageAttributeValueTypeDef
  2. See MessageAttributeValueOutputTypeDef

AppInstanceUserMembershipSummaryTypeDef#

# AppInstanceUserMembershipSummaryTypeDef definition

class AppInstanceUserMembershipSummaryTypeDef(TypedDict):
    Type: NotRequired[ChannelMembershipTypeType],  # (1)
    ReadMarkerTimestamp: NotRequired[datetime],
    SubChannelId: NotRequired[str],
  1. See ChannelMembershipTypeType

AssociateChannelFlowRequestRequestTypeDef#

# AssociateChannelFlowRequestRequestTypeDef definition

class AssociateChannelFlowRequestRequestTypeDef(TypedDict):
    ChannelArn: str,
    ChannelFlowArn: str,
    ChimeBearer: str,

IdentityTypeDef#

# IdentityTypeDef definition

class IdentityTypeDef(TypedDict):
    Arn: NotRequired[str],
    Name: NotRequired[str],

BatchCreateChannelMembershipErrorTypeDef#

# BatchCreateChannelMembershipErrorTypeDef definition

class BatchCreateChannelMembershipErrorTypeDef(TypedDict):
    MemberArn: NotRequired[str],
    ErrorCode: NotRequired[ErrorCodeType],  # (1)
    ErrorMessage: NotRequired[str],
  1. See ErrorCodeType

BatchCreateChannelMembershipRequestRequestTypeDef#

# BatchCreateChannelMembershipRequestRequestTypeDef definition

class BatchCreateChannelMembershipRequestRequestTypeDef(TypedDict):
    ChannelArn: str,
    MemberArns: Sequence[str],
    ChimeBearer: str,
    Type: NotRequired[ChannelMembershipTypeType],  # (1)
    SubChannelId: NotRequired[str],
  1. See ChannelMembershipTypeType

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

ChannelAssociatedWithFlowSummaryTypeDef#

# ChannelAssociatedWithFlowSummaryTypeDef definition

class ChannelAssociatedWithFlowSummaryTypeDef(TypedDict):
    Name: NotRequired[str],
    ChannelArn: NotRequired[str],
    Mode: NotRequired[ChannelModeType],  # (1)
    Privacy: NotRequired[ChannelPrivacyType],  # (2)
    Metadata: NotRequired[str],
  1. See ChannelModeType
  2. See ChannelPrivacyType

ChannelSummaryTypeDef#

# ChannelSummaryTypeDef definition

class ChannelSummaryTypeDef(TypedDict):
    Name: NotRequired[str],
    ChannelArn: NotRequired[str],
    Mode: NotRequired[ChannelModeType],  # (1)
    Privacy: NotRequired[ChannelPrivacyType],  # (2)
    Metadata: NotRequired[str],
    LastMessageTimestamp: NotRequired[datetime],
  1. See ChannelModeType
  2. See ChannelPrivacyType

PushNotificationPreferencesTypeDef#

# PushNotificationPreferencesTypeDef definition

class PushNotificationPreferencesTypeDef(TypedDict):
    AllowNotifications: AllowNotificationsType,  # (1)
    FilterRule: NotRequired[str],
  1. See AllowNotificationsType

MessageAttributeValueTypeDef#

# MessageAttributeValueTypeDef definition

class MessageAttributeValueTypeDef(TypedDict):
    StringValues: NotRequired[Sequence[str]],

PushNotificationConfigurationTypeDef#

# PushNotificationConfigurationTypeDef definition

class PushNotificationConfigurationTypeDef(TypedDict):
    Title: NotRequired[str],
    Body: NotRequired[str],
    Type: NotRequired[PushNotificationTypeType],  # (1)
  1. See PushNotificationTypeType

ChannelMessageStatusStructureTypeDef#

# ChannelMessageStatusStructureTypeDef definition

class ChannelMessageStatusStructureTypeDef(TypedDict):
    Value: NotRequired[ChannelMessageStatusType],  # (1)
    Detail: NotRequired[str],
  1. See ChannelMessageStatusType

MessageAttributeValueOutputTypeDef#

# MessageAttributeValueOutputTypeDef definition

class MessageAttributeValueOutputTypeDef(TypedDict):
    StringValues: NotRequired[List[s