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,
]

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

TargetTypeDef#

# TargetTypeDef definition

class TargetTypeDef(TypedDict):
    MemberArn: NotRequired[str],

ElasticChannelConfigurationTypeDef#

# ElasticChannelConfigurationTypeDef definition

class ElasticChannelConfigurationTypeDef(TypedDict):
    MaximumSubChannels: int,
    TargetMembershipsPerSubChannel: int,
    MinimumMembershipPercentage: int,

ExpirationSettingsTypeDef#

# ExpirationSettingsTypeDef definition

class ExpirationSettingsTypeDef(TypedDict):
    ExpirationDays: int,
    ExpirationCriterion: ExpirationCriterionType,  # (1)
  1. See ExpirationCriterionType

CreateChannelBanRequestRequestTypeDef#

# CreateChannelBanRequestRequestTypeDef definition

class CreateChannelBanRequestRequestTypeDef(TypedDict):
    ChannelArn: str,
    MemberArn: str,
    ChimeBearer: str,

TagTypeDef#

# TagTypeDef definition

class TagTypeDef(TypedDict):
    Key: str,
    Value: str,

CreateChannelMembershipRequestRequestTypeDef#

# CreateChannelMembershipRequestRequestTypeDef definition

class CreateChannelMembershipRequestRequestTypeDef(TypedDict):
    ChannelArn: str,
    MemberArn: str,
    Type: ChannelMembershipTypeType,  # (1)
    ChimeBearer: str,
    SubChannelId: NotRequired[str],
  1. See ChannelMembershipTypeType

CreateChannelModeratorRequestRequestTypeDef#

# CreateChannelModeratorRequestRequestTypeDef definition

class CreateChannelModeratorRequestRequestTypeDef(TypedDict):
    ChannelArn: str,
    ChannelModeratorArn: str,
    ChimeBearer: str,

DeleteChannelBanRequestRequestTypeDef#

# DeleteChannelBanRequestRequestTypeDef definition

class DeleteChannelBanRequestRequestTypeDef(TypedDict):
    ChannelArn: str,
    MemberArn: str,
    ChimeBearer: str,

DeleteChannelFlowRequestRequestTypeDef#

# DeleteChannelFlowRequestRequestTypeDef definition

class DeleteChannelFlowRequestRequestTypeDef(TypedDict):
    ChannelFlowArn: str,

DeleteChannelMembershipRequestRequestTypeDef#

# DeleteChannelMembershipRequestRequestTypeDef definition

class DeleteChannelMembershipRequestRequestTypeDef(TypedDict):
    ChannelArn: str,
    MemberArn: str,
    ChimeBearer: str,
    SubChannelId: NotRequired[str],

DeleteChannelMessageRequestRequestTypeDef#

# DeleteChannelMessageRequestRequestTypeDef definition

class DeleteChannelMessageRequestRequestTypeDef(TypedDict):
    ChannelArn: str,
    MessageId: str,
    ChimeBearer: str,
    SubChannelId: NotRequired[str],

DeleteChannelModeratorRequestRequestTypeDef#

# DeleteChannelModeratorRequestRequestTypeDef definition

class DeleteChannelModeratorRequestRequestTypeDef(TypedDict):
    ChannelArn: str,
    ChannelModeratorArn: str,
    ChimeBearer: str,

DeleteChannelRequestRequestTypeDef#

# DeleteChannelRequestRequestTypeDef definition

class DeleteChannelRequestRequestTypeDef(TypedDict):
    ChannelArn: str,
    ChimeBearer: str,

DeleteMessagingStreamingConfigurationsRequestRequestTypeDef#

# DeleteMessagingStreamingConfigurationsRequestRequestTypeDef definition

class DeleteMessagingStreamingConfigurationsRequestRequestTypeDef(TypedDict):
    AppInstanceArn: str,

DescribeChannelBanRequestRequestTypeDef#

# DescribeChannelBanRequestRequestTypeDef definition

class DescribeChannelBanRequestRequestTypeDef(TypedDict):
    ChannelArn: str,
    MemberArn: str,
    ChimeBearer: str,

DescribeChannelFlowRequestRequestTypeDef#

# DescribeChannelFlowRequestRequestTypeDef definition

class DescribeChannelFlowRequestRequestTypeDef(TypedDict):
    ChannelFlowArn: str,

DescribeChannelMembershipForAppInstanceUserRequestRequestTypeDef#

# DescribeChannelMembershipForAppInstanceUserRequestRequestTypeDef definition

class DescribeChannelMembershipForAppInstanceUserRequestRequestTypeDef(TypedDict):
    ChannelArn: str,
    AppInstanceUserArn: str,
    ChimeBearer: str,

DescribeChannelMembershipRequestRequestTypeDef#

# DescribeChannelMembershipRequestRequestTypeDef definition

class DescribeChannelMembershipRequestRequestTypeDef(TypedDict):
    ChannelArn: str,
    MemberArn: str,
    ChimeBearer: str,
    SubChannelId: NotRequired[str],

DescribeChannelModeratedByAppInstanceUserRequestRequestTypeDef#

# DescribeChannelModeratedByAppInstanceUserRequestRequestTypeDef definition

class DescribeChannelModeratedByAppInstanceUserRequestRequestTypeDef(TypedDict):
    ChannelArn: str,
    AppInstanceUserArn: str,
    ChimeBearer: str,

DescribeChannelModeratorRequestRequestTypeDef#

# DescribeChannelModeratorRequestRequestTypeDef definition

class DescribeChannelModeratorRequestRequestTypeDef(TypedDict):
    ChannelArn: str,
    ChannelModeratorArn: str,
    ChimeBearer: str,

DescribeChannelRequestRequestTypeDef#

# DescribeChannelRequestRequestTypeDef definition

class DescribeChannelRequestRequestTypeDef(TypedDict):
    ChannelArn: str,
    ChimeBearer: str,

DisassociateChannelFlowRequestRequestTypeDef#

# DisassociateChannelFlowRequestRequestTypeDef definition

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

GetChannelMembershipPreferencesRequestRequestTypeDef#

# GetChannelMembershipPreferencesRequestRequestTypeDef definition

class GetChannelMembershipPreferencesRequestRequestTypeDef(TypedDict):
    ChannelArn: str,
    MemberArn: str,
    ChimeBearer: str,

GetChannelMessageRequestRequestTypeDef#

# GetChannelMessageRequestRequestTypeDef definition

class GetChannelMessageRequestRequestTypeDef(TypedDict):
    ChannelArn: str,
    MessageId: str,
    ChimeBearer: str,
    SubChannelId: NotRequired[str],

GetChannelMessageStatusRequestRequestTypeDef#

# GetChannelMessageStatusRequestRequestTypeDef definition

class GetChannelMessageStatusRequestRequestTypeDef(TypedDict):
    ChannelArn: str,
    MessageId: str,
    ChimeBearer: str,
    SubChannelId: NotRequired[str],

MessagingSessionEndpointTypeDef#

# MessagingSessionEndpointTypeDef definition

class MessagingSessionEndpointTypeDef(TypedDict):
    Url: NotRequired[str],

GetMessagingStreamingConfigurationsRequestRequestTypeDef#

# GetMessagingStreamingConfigurationsRequestRequestTypeDef definition

class GetMessagingStreamingConfigurationsRequestRequestTypeDef(TypedDict):
    AppInstanceArn: str,

StreamingConfigurationTypeDef#

# StreamingConfigurationTypeDef definition

class StreamingConfigurationTypeDef(TypedDict):
    DataType: MessagingDataTypeType,  # (1)
    ResourceArn: str,
  1. See MessagingDataTypeType

LambdaConfigurationTypeDef#

# LambdaConfigurationTypeDef definition

class LambdaConfigurationTypeDef(TypedDict):
    ResourceArn: str,
    InvocationType: InvocationTypeType,  # (1)
  1. See