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],
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],
- See ErrorCodeType
BatchCreateChannelMembershipRequestRequestTypeDef#
# BatchCreateChannelMembershipRequestRequestTypeDef definition
class BatchCreateChannelMembershipRequestRequestTypeDef(TypedDict):
ChannelArn: str,
MemberArns: Sequence[str],
ChimeBearer: str,
Type: NotRequired[ChannelMembershipTypeType], # (1)
SubChannelId: NotRequired[str],
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
ChannelAssociatedWithFlowSummaryTypeDef#
# ChannelAssociatedWithFlowSummaryTypeDef definition
class ChannelAssociatedWithFlowSummaryTypeDef(TypedDict):
Name: NotRequired[str],
ChannelArn: NotRequired[str],
Mode: NotRequired[ChannelModeType], # (1)
Privacy: NotRequired[ChannelPrivacyType], # (2)
Metadata: NotRequired[str],
- See ChannelModeType
- 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],
- See ChannelModeType
- See ChannelPrivacyType
PushNotificationPreferencesTypeDef#
# PushNotificationPreferencesTypeDef definition
class PushNotificationPreferencesTypeDef(TypedDict):
AllowNotifications: AllowNotificationsType, # (1)
FilterRule: NotRequired[str],
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)
ChannelMessageStatusStructureTypeDef#
# ChannelMessageStatusStructureTypeDef definition
class ChannelMessageStatusStructureTypeDef(TypedDict):
Value: NotRequired[ChannelMessageStatusType], # (1)
Detail: NotRequired[str],
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)
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],
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,
LambdaConfigurationTypeDef#
# LambdaConfigurationTypeDef definition
class LambdaConfigurationTypeDef(TypedDict):
ResourceArn: str,
InvocationType: InvocationTypeType, # (1)
ListChannelBansRequestRequestTypeDef#
# ListChannelBansRequestRequestTypeDef definition
class ListChannelBansRequestRequestTypeDef(TypedDict):
ChannelArn: str,
ChimeBearer: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
ListChannelFlowsRequestRequestTypeDef#
# ListChannelFlowsRequestRequestTypeDef definition
class ListChannelFlowsRequestRequestTypeDef(TypedDict):
AppInstanceArn: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
ListChannelMembershipsForAppInstanceUserRequestRequestTypeDef#
# ListChannelMembershipsForAppInstanceUserRequestRequestTypeDef definition
class ListChannelMembershipsForAppInstanceUserRequestRequestTypeDef(TypedDict):
ChimeBearer: str,
AppInstanceUserArn: NotRequired[str],
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
ListChannelMembershipsRequestRequestTypeDef#
# ListChannelMembershipsRequestRequestTypeDef definition
class ListChannelMembershipsRequestRequestTypeDef(TypedDict):
ChannelArn: str,
ChimeBearer: str,
Type: NotRequired[ChannelMembershipTypeType], # (1)
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
SubChannelId: NotRequired[str],
ListChannelModeratorsRequestRequestTypeDef#
# ListChannelModeratorsRequestRequestTypeDef definition
class ListChannelModeratorsRequestRequestTypeDef(TypedDict):
ChannelArn: str,
ChimeBearer: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
ListChannelsAssociatedWithChannelFlowRequestRequestTypeDef#
# ListChannelsAssociatedWithChannelFlowRequestRequestTypeDef definition
class ListChannelsAssociatedWithChannelFlowRequestRequestTypeDef(TypedDict):
ChannelFlowArn: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
ListChannelsModeratedByAppInstanceUserRequestRequestTypeDef#
# ListChannelsModeratedByAppInstanceUserRequestRequestTypeDef definition
class ListChannelsModeratedByAppInstanceUserRequestRequestTypeDef(TypedDict):
ChimeBearer: str,
AppInstanceUserArn: NotRequired[str],
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
ListChannelsRequestRequestTypeDef#
# ListChannelsRequestRequestTypeDef definition
class ListChannelsRequestRequestTypeDef(TypedDict):
AppInstanceArn: str,
ChimeBearer: str,
Privacy: NotRequired[ChannelPrivacyType], # (1)
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
ListSubChannelsRequestRequestTypeDef#
# ListSubChannelsRequestRequestTypeDef definition
class ListSubChannelsRequestRequestTypeDef(TypedDict):
ChannelArn: str,
ChimeBearer: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
SubChannelSummaryTypeDef#
# SubChannelSummaryTypeDef definition
class SubChannelSummaryTypeDef(TypedDict):
SubChannelId: NotRequired[str],
MembershipCount: NotRequired[int],
ListTagsForResourceRequestRequestTypeDef#
# ListTagsForResourceRequestRequestTypeDef definition
class ListTagsForResourceRequestRequestTypeDef(TypedDict):
ResourceARN: str,
RedactChannelMessageRequestRequestTypeDef#
# RedactChannelMessageRequestRequestTypeDef definition
class RedactChannelMessageRequestRequestTypeDef(TypedDict):
ChannelArn: str,
MessageId: str,
ChimeBearer: str,
SubChannelId: NotRequired[str],
SearchFieldTypeDef#
# SearchFieldTypeDef definition
class SearchFieldTypeDef(TypedDict):
Key: SearchFieldKeyType, # (1)
Values: Sequence[str],
Operator: SearchFieldOperatorType, # (2)
UntagResourceRequestRequestTypeDef#
# UntagResourceRequestRequestTypeDef definition
class UntagResourceRequestRequestTypeDef(TypedDict):
ResourceARN: str,
TagKeys: Sequence[str],
UpdateChannelMessageRequestRequestTypeDef#
# UpdateChannelMessageRequestRequestTypeDef definition
class UpdateChannelMessageRequestRequestTypeDef(TypedDict):
ChannelArn: str,
MessageId: str,
Content: str,
ChimeBearer: str,
Metadata: NotRequired[str],
SubChannelId: NotRequired[str],
ContentType: NotRequired[str],
UpdateChannelReadMarkerRequestRequestTypeDef#
# UpdateChannelReadMarkerRequestRequestTypeDef definition
class UpdateChannelReadMarkerRequestRequestTypeDef(TypedDict):
ChannelArn: str,
ChimeBearer: str,
UpdateChannelRequestRequestTypeDef#
# UpdateChannelRequestRequestTypeDef definition
class UpdateChannelRequestRequestTypeDef(TypedDict):
ChannelArn: str,
ChimeBearer: str,
Name: NotRequired[str],
Mode: NotRequired[ChannelModeType], # (1)
Metadata: NotRequired[str],
- See ChannelModeType
BatchChannelMembershipsTypeDef#
# BatchChannelMembershipsTypeDef definition
class BatchChannelMembershipsTypeDef(TypedDict):
InvitedBy: NotRequired[IdentityTypeDef], # (1)
Type: NotRequired[ChannelMembershipTypeType], # (2)
Members: NotRequired[List[IdentityTypeDef]], # (3)
ChannelArn: NotRequired[str],
SubChannelId: NotRequired[str],
- See IdentityTypeDef
- See ChannelMembershipTypeType
- See IdentityTypeDef
ChannelBanSummaryTypeDef#
# ChannelBanSummaryTypeDef definition
class ChannelBanSummaryTypeDef(TypedDict):
Member: NotRequired[IdentityTypeDef], # (1)
- See IdentityTypeDef
ChannelBanTypeDef#
# ChannelBanTypeDef definition
class ChannelBanTypeDef(TypedDict):
Member: NotRequired[IdentityTypeDef], # (1)
ChannelArn: NotRequired[str],
CreatedTimestamp: NotRequired[datetime],
CreatedBy: NotRequired[IdentityTypeDef], # (1)
- See IdentityTypeDef
- See IdentityTypeDef
ChannelMembershipSummaryTypeDef#
# ChannelMembershipSummaryTypeDef definition
class ChannelMembershipSummaryTypeDef(TypedDict):
Member: NotRequired[IdentityTypeDef], # (1)
- See IdentityTypeDef
ChannelMembershipTypeDef#
# ChannelMembershipTypeDef definition
class ChannelMembershipTypeDef(TypedDict):
InvitedBy: NotRequired[IdentityTypeDef], # (1)
Type: NotRequired[ChannelMembershipTypeType], # (2)
Member: NotRequired[IdentityTypeDef], # (1)
ChannelArn: NotRequired[str],
CreatedTimestamp: NotRequired[datetime],
LastUpdatedTimestamp: NotRequired[datetime],
SubChannelId: NotRequired[str],
- See IdentityTypeDef
- See