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,
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],
- 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 ChannelMembershipTypeType
- See IdentityTypeDef
ChannelModeratorSummaryTypeDef#
# ChannelModeratorSummaryTypeDef definition
class ChannelModeratorSummaryTypeDef(TypedDict):
Moderator: NotRequired[IdentityTypeDef], # (1)
- See IdentityTypeDef
ChannelModeratorTypeDef#
# ChannelModeratorTypeDef definition
class ChannelModeratorTypeDef(TypedDict):
Moderator: NotRequired[IdentityTypeDef], # (1)
ChannelArn: NotRequired[str],
CreatedTimestamp: NotRequired[datetime],
CreatedBy: NotRequired[IdentityTypeDef], # (1)
- See IdentityTypeDef
- See IdentityTypeDef
ChannelFlowCallbackResponseTypeDef#
# ChannelFlowCallbackResponseTypeDef definition
class ChannelFlowCallbackResponseTypeDef(TypedDict):
ChannelArn: str,
CallbackId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateChannelBanResponseTypeDef#
# CreateChannelBanResponseTypeDef definition
class CreateChannelBanResponseTypeDef(TypedDict):
ChannelArn: str,
Member: IdentityTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateChannelFlowResponseTypeDef#
# CreateChannelFlowResponseTypeDef definition
class CreateChannelFlowResponseTypeDef(TypedDict):
ChannelFlowArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateChannelMembershipResponseTypeDef#
# CreateChannelMembershipResponseTypeDef definition
class CreateChannelMembershipResponseTypeDef(TypedDict):
ChannelArn: str,
Member: IdentityTypeDef, # (1)
SubChannelId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateChannelModeratorResponseTypeDef#
# CreateChannelModeratorResponseTypeDef definition
class CreateChannelModeratorResponseTypeDef(TypedDict):
ChannelArn: str,
ChannelModerator: IdentityTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateChannelResponseTypeDef#
# CreateChannelResponseTypeDef definition
class CreateChannelResponseTypeDef(TypedDict):
ChannelArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
EmptyResponseMetadataTypeDef#
# EmptyResponseMetadataTypeDef definition
class EmptyResponseMetadataTypeDef(TypedDict):
ResponseMetadata: ResponseMetadataTypeDef, # (1)
RedactChannelMessageResponseTypeDef#
# RedactChannelMessageResponseTypeDef definition
class RedactChannelMessageResponseTypeDef(TypedDict):
ChannelArn: str,
MessageId: str,
SubChannelId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateChannelFlowResponseTypeDef#
# UpdateChannelFlowResponseTypeDef definition
class UpdateChannelFlowResponseTypeDef(TypedDict):
ChannelFlowArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateChannelReadMarkerResponseTypeDef#
# UpdateChannelReadMarkerResponseTypeDef definition
class UpdateChannelReadMarkerResponseTypeDef(TypedDict):
ChannelArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateChannelResponseTypeDef#
# UpdateChannelResponseTypeDef definition
class UpdateChannelResponseTypeDef(TypedDict):
ChannelArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListChannelsAssociatedWithChannelFlowResponseTypeDef#
# ListChannelsAssociatedWithChannelFlowResponseTypeDef definition
class ListChannelsAssociatedWithChannelFlowResponseTypeDef(TypedDict):
Channels: List[ChannelAssociatedWithFlowSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ChannelMembershipForAppInstanceUserSummaryTypeDef#
# ChannelMembershipForAppInstanceUserSummaryTypeDef definition
class ChannelMembershipForAppInstanceUserSummaryTypeDef(TypedDict):
ChannelSummary: NotRequired[ChannelSummaryTypeDef], # (1)
AppInstanceUserMembershipSummary: NotRequired[AppInstanceUserMembershipSummaryTypeDef], # (2)
ChannelModeratedByAppInstanceUserSummaryTypeDef#
# ChannelModeratedByAppInstanceUserSummaryTypeDef definition
class ChannelModeratedByAppInstanceUserSummaryTypeDef(TypedDict):
ChannelSummary: NotRequired[ChannelSummaryTypeDef], # (1)
ListChannelsResponseTypeDef#
# ListChannelsResponseTypeDef definition
class ListChannelsResponseTypeDef(TypedDict):
Channels: List[ChannelSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
SearchChannelsResponseTypeDef#
# SearchChannelsResponseTypeDef definition
class SearchChannelsResponseTypeDef(TypedDict):
Channels: List[ChannelSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ChannelMembershipPreferencesTypeDef#
# ChannelMembershipPreferencesTypeDef definition
class ChannelMembershipPreferencesTypeDef(TypedDict):
PushNotifications: NotRequired[PushNotificationPreferencesTypeDef], # (1)
ChannelMessageCallbackTypeDef#
# ChannelMessageCallbackTypeDef definition
class ChannelMessageCallbackTypeDef(TypedDict):
MessageId: str,
Content: NotRequired[str],
Metadata: NotRequired[str],
PushNotification: NotRequired[PushNotificationConfigurationTypeDef], # (1)
MessageAttributes: NotRequired[Mapping[str, MessageAttributeValueTypeDef]], # (2)
SubChannelId: NotRequired[str],
ContentType: NotRequired[str],
GetChannelMessageStatusResponseTypeDef#
# GetChannelMessageStatusResponseTypeDef definition
class GetChannelMessageStatusResponseTypeDef(TypedDict):
Status: ChannelMessageStatusStructureTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
SendChannelMessageResponseTypeDef#
# SendChannelMessageResponseTypeDef definition
class SendChannelMessageResponseTypeDef(TypedDict):
ChannelArn: str,
MessageId: str,
Status: ChannelMessageStatusStructureTypeDef, # (1)
SubChannelId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateChannelMessageResponseTypeDef#
# UpdateChannelMessageResponseTypeDef definition
class UpdateChannelMessageResponseTypeDef(TypedDict):
ChannelArn: str,
MessageId: str,
Status: ChannelMessageStatusStructureTypeDef, # (1)
SubChannelId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ChannelMessageSummaryTypeDef#
# ChannelMessageSummaryTypeDef definition
class ChannelMessageSummaryTypeDef(TypedDict):
MessageId: NotRequired[str],
Content: NotRequired[str],
Metadata: NotRequired[str],
Type: NotRequired[ChannelMessageTypeType], # (1)
CreatedTimestamp: NotRequired[datetime],
LastUpdatedTimestamp: NotRequired[datetime],
LastEditedTimestamp: NotRequired[datetime],
Sender: NotRequired[IdentityTypeDef], # (2)
Redacted: NotRequired[bool],
Status: NotRequired[ChannelMessageStatusStructureTypeDef], # (3)
MessageAttributes: NotRequired[Dict[str, MessageAttributeValueTypeDef]], # (4)
ContentType: NotRequired[str],
Target: NotRequired[List[TargetTypeDef]], # (5)
- See ChannelMessageTypeType
- See IdentityTypeDef
- See ChannelMessageStatusStructureTypeDef
- See MessageAttributeValueTypeDef
- See TargetTypeDef
ChannelMessageTypeDef#
# ChannelMessageTypeDef definition
class ChannelMessageTypeDef(TypedDict):
ChannelArn: NotRequired[str],
MessageId: NotRequired[str],
Content: NotRequired[str],
Metadata: NotRequired[str],
Type: NotRequired[ChannelMessageTypeType], # (1)
CreatedTimestamp: NotRequired[datetime],
LastEditedTimestamp: NotRequired[datetime],
LastUpdatedTimestamp: NotRequired[datetime],
Sender: NotRequired[IdentityTypeDef], # (2)
Redacted: NotRequired[bool],
Persistence: NotRequired[ChannelMessagePersistenceTypeType], # (3)
Status: NotRequired[ChannelMessageStatusStructureTypeDef], # (4)
MessageAttributes: NotRequired[Dict[str, MessageAttributeValueTypeDef]], # (5)
SubChannelId: NotRequired[str],
ContentType: NotRequired[str],
Target: NotRequired[List[TargetTypeDef]], # (6)
- See ChannelMessageTypeType
- See IdentityTypeDef
- See ChannelMessagePersistenceTypeType
- See ChannelMessageStatusStructureTypeDef
- See MessageAttributeValueTypeDef
- See TargetTypeDef
SendChannelMessageRequestRequestTypeDef#
# SendChannelMessageRequestRequestTypeDef definition
class SendChannelMessageRequestRequestTypeDef(TypedDict):
ChannelArn: str,
Content: str,
Type: ChannelMessageTypeType, # (1)
Persistence: ChannelMessagePersistenceTypeType, # (2)
ClientRequestToken: str,
ChimeBearer: str,
Metadata: NotRequired[str],
PushNotification: NotRequired[PushNotificationConfigurationTypeDef], # (3)
MessageAttributes: NotRequired[Mapping[str, MessageAttributeValueTypeDef]], # (4)
SubChannelId: NotRequired[str],
ContentType: NotRequired[str],
Target: NotRequired[Sequence[TargetTypeDef]], # (5)
- See ChannelMessageTypeType
- See ChannelMessagePersistenceTypeType
- See PushNotificationConfigurationTypeDef
- See MessageAttributeValueTypeDef
- See TargetTypeDef
ChannelTypeDef#
# ChannelTypeDef definition
class ChannelTypeDef(TypedDict):
Name: NotRequired[str],
ChannelArn: NotRequired[str],
Mode: NotRequired[ChannelModeType], # (1)
Privacy: NotRequired[ChannelPrivacyType], # (2)
Metadata: NotRequired[str],
CreatedBy: NotRequired[IdentityTypeDef], # (3)
CreatedTimestamp: NotRequired[datetime],
LastMessageTimestamp: NotRequired[datetime],
LastUpdatedTimestamp: NotRequired[datetime],
ChannelFlowArn: NotRequired[str],
ElasticChannelConfiguration: NotRequired[ElasticChannelConfigurationTypeDef], # (4)
ExpirationSettings: NotRequired[ExpirationSettingsTypeDef], # (5)
- See ChannelModeType
- See ChannelPrivacyType
- See IdentityTypeDef
- See ElasticChannelConfigurationTypeDef
- See ExpirationSettingsTypeDef
PutChannelExpirationSettingsRequestRequestTypeDef#
# PutChannelExpirationSettingsRequestRequestTypeDef definition
class PutChannelExpirationSettingsRequestRequestTypeDef(TypedDict):
ChannelArn: str,
ChimeBearer: NotRequired[str],
ExpirationSettings: NotRequired[ExpirationSettingsTypeDef], # (1)
PutChannelExpirationSettingsResponseTypeDef#
# PutChannelExpirationSettingsResponseTypeDef definition
class PutChannelExpirationSettingsResponseTypeDef(TypedDict):
ChannelArn: str,
ExpirationSettings: ExpirationSettingsTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateChannelRequestRequestTypeDef#
# CreateChannelRequestRequestTypeDef definition
class CreateChannelRequestRequestTypeDef(TypedDict):
AppInstanceArn: str,
Name: str,
ClientRequestToken: str,
ChimeBearer: str,
Mode: NotRequired[ChannelModeType], # (1)
Privacy: NotRequired[ChannelPrivacyType], # (2)
Metadata: NotRequired[str],
Tags: NotRequired[Sequence[TagTypeDef]], # (3)
ChannelId: NotRequired[str],
MemberArns: NotRequired[Sequence[str]],
ModeratorArns: NotRequired[Sequence[str]],
ElasticChannelConfiguration: NotRequired[ElasticChannelConfigurationTypeDef], # (4)
ExpirationSettings: NotRequired[ExpirationSettingsTypeDef], # (5)
- See ChannelModeType
- See ChannelPrivacyType
- See TagTypeDef
- See ElasticChannelConfigurationTypeDef
- See ExpirationSettingsTypeDef
ListTagsForResourceResponseTypeDef#
# ListTagsForResourceResponseTypeDef definition
class ListTagsForResourceResponseTypeDef(TypedDict):
Tags: List[TagTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See TagTypeDef
- See ResponseMetadataTypeDef
TagResourceRequestRequestTypeDef#
# TagResourceRequestRequestTypeDef definition
class TagResourceRequestRequestTypeDef(TypedDict):
ResourceARN: str,
Tags: Sequence[TagTypeDef], # (1)
- See TagTypeDef
GetMessagingSessionEndpointResponseTypeDef#
# GetMessagingSessionEndpointResponseTypeDef definition
class GetMessagingSessionEndpointResponseTypeDef(TypedDict):
Endpoint: MessagingSessionEndpointTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetMessagingStreamingConfigurationsResponseTypeDef#
# GetMessagingStreamingConfigurationsResponseTypeDef definition
class GetMessagingStreamingConfigurationsResponseTypeDef(TypedDict):
StreamingConfigurations: List[StreamingConfigurationTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
PutMessagingStreamingConfigurationsRequestRequestTypeDef#
# PutMessagingStreamingConfigurationsRequestRequestTypeDef definition
class PutMessagingStreamingConfigurationsRequestRequestTypeDef(TypedDict):
AppInstanceArn: str,
StreamingConfigurations: Sequence[StreamingConfigurationTypeDef], # (1)
PutMessagingStreamingConfigurationsResponseTypeDef#
# PutMessagingStreamingConfigurationsResponseTypeDef definition
class PutMessagingStreamingConfigurationsResponseTypeDef(TypedDict):
StreamingConfigurations: List[StreamingConfigurationTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ProcessorConfigurationTypeDef#
# ProcessorConfigurationTypeDef definition
class ProcessorConfigurationTypeDef(TypedDict):
Lambda: LambdaConfigurationTypeDef, # (1)
ListChannelMessagesRequestRequestTypeDef#
# ListChannelMessagesRequestRequestTypeDef definition
class ListChannelMessagesRequestRequestTypeDef(TypedDict):
ChannelArn: str,
ChimeBearer: str,
SortOrder: NotRequired[SortOrderType], # (1)
NotBefore: NotRequired[Union[datetime, str]],
NotAfter: NotRequired[Union[datetime, str]],
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
SubChannelId: NotRequired[str],
- See SortOrderType
ListSubChannelsResponseTypeDef#
# ListSubChannelsResponseTypeDef definition
class ListSubChannelsResponseTypeDef(TypedDict):
ChannelArn: str,
SubChannels: List[SubChannelSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
SearchChannelsRequestRequestTypeDef#
# SearchChannelsRequestRequestTypeDef definition
class SearchChannelsRequestRequestTypeDef(TypedDict):
Fields: Sequence[SearchFieldTypeDef], # (1)
ChimeBearer: NotRequired[str],
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
BatchCreateChannelMembershipResponseTypeDef#
# BatchCreateChannelMembershipResponseTypeDef definition
class BatchCreateChannelMembershipResponseTypeDef(TypedDict):
BatchChannelMemberships: BatchChannelMembershipsTypeDef, # (1)
Errors: List[BatchCreateChannelMembershipErrorTypeDef], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
- See BatchChannelMembershipsTypeDef
- See BatchCreateChannelMembershipErrorTypeDef
- See ResponseMetadataTypeDef
ListChannelBansResponseTypeDef#
# ListChannelBansResponseTypeDef definition
class ListChannelBansResponseTypeDef(TypedDict):
ChannelArn: str,
NextToken: str,
ChannelBans: List[ChannelBanSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeChannelBanResponseTypeDef#
# DescribeChannelBanResponseTypeDef definition
class DescribeChannelBanResponseTypeDef(TypedDict):
ChannelBan: ChannelBanTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListChannelMembershipsResponseTypeDef#
# ListChannelMembershipsResponseTypeDef definition
class ListChannelMembershipsResponseTypeDef(TypedDict):
ChannelArn: str,
ChannelMemberships: List[ChannelMembershipSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeChannelMembershipResponseTypeDef#
# DescribeChannelMembershipResponseTypeDef definition
class DescribeChannelMembershipResponseTypeDef(TypedDict):
ChannelMembership: ChannelMembershipTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListChannelModeratorsResponseTypeDef#
# ListChannelModeratorsResponseTypeDef definition
class ListChannelModeratorsResponseTypeDef(TypedDict):
ChannelArn: str,
NextToken: str,
ChannelModerators: List[ChannelModeratorSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeChannelModeratorResponseTypeDef#
# DescribeChannelModeratorResponseTypeDef definition
class DescribeChannelModeratorResponseTypeDef(TypedDict):
ChannelModerator: ChannelModeratorTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeChannelMembershipForAppInstanceUserResponseTypeDef#
# DescribeChannelMembershipForAppInstanceUserResponseTypeDef definition
class DescribeChannelMembershipForAppInstanceUserResponseTypeDef(TypedDict):
ChannelMembership: ChannelMembershipForAppInstanceUserSummaryTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListChannelMembershipsForAppInstanceUserResponseTypeDef#
# ListChannelMembershipsForAppInstanceUserResponseTypeDef definition
class ListChannelMembershipsForAppInstanceUserResponseTypeDef(TypedDict):
ChannelMemberships: List[ChannelMembershipForAppInstanceUserSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeChannelModeratedByAppInstanceUserResponseTypeDef#
# DescribeChannelModeratedByAppInstanceUserResponseTypeDef definition
class DescribeChannelModeratedByAppInstanceUserResponseTypeDef(TypedDict):
Channel: ChannelModeratedByAppInstanceUserSummaryTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListChannelsModeratedByAppInstanceUserResponseTypeDef#
# ListChannelsModeratedByAppInstanceUserResponseTypeDef definition
class ListChannelsModeratedByAppInstanceUserResponseTypeDef(TypedDict):
Channels: List[ChannelModeratedByAppInstanceUserSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetChannelMembershipPreferencesResponseTypeDef#
# GetChannelMembershipPreferencesResponseTypeDef definition
class GetChannelMembershipPreferencesResponseTypeDef(TypedDict):
ChannelArn: str,
Member: IdentityTypeDef, # (1)
Preferences: ChannelMembershipPreferencesTypeDef, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
PutChannelMembershipPreferencesRequestRequestTypeDef#
# PutChannelMembershipPreferencesRequestRequestTypeDef definition
class PutChannelMembershipPreferencesRequestRequestTypeDef(TypedDict):
ChannelArn: str,
MemberArn: str,
ChimeBearer: str,
Preferences: ChannelMembershipPreferencesTypeDef, # (1)
PutChannelMembershipPreferencesResponseTypeDef#
# PutChannelMembershipPreferencesResponseTypeDef definition
class PutChannelMembershipPreferencesResponseTypeDef(TypedDict):
ChannelArn: str,
Member: IdentityTypeDef, # (1)
Preferences: ChannelMembershipPreferencesTypeDef, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
ChannelFlowCallbackRequestRequestTypeDef#
# ChannelFlowCallbackRequestRequestTypeDef definition
class ChannelFlowCallbackRequestRequestTypeDef(TypedDict):
CallbackId: str,
ChannelArn: str,
ChannelMessage: ChannelMessageCallbackTypeDef, # (1)
DeleteResource: NotRequired[bool],
ListChannelMessagesResponseTypeDef#
# ListChannelMessagesResponseTypeDef definition
class ListChannelMessagesResponseTypeDef(TypedDict):
ChannelArn: str,
NextToken: str,
ChannelMessages: List[ChannelMessageSummaryTypeDef], # (1)
SubChannelId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetChannelMessageResponseTypeDef#
# GetChannelMessageResponseTypeDef definition
class GetChannelMessageResponseTypeDef(TypedDict):
ChannelMessage: ChannelMessageTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeChannelResponseTypeDef#
# DescribeChannelResponseTypeDef definition
class DescribeChannelResponseTypeDef(TypedDict):
Channel: ChannelTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ProcessorTypeDef#
# ProcessorTypeDef definition
class ProcessorTypeDef(TypedDict):
Name: str,
Configuration: ProcessorConfigurationTypeDef, # (1)
ExecutionOrder: int,
FallbackAction: FallbackActionType, # (2)
ChannelFlowSummaryTypeDef#
# ChannelFlowSummaryTypeDef definition
class ChannelFlowSummaryTypeDef(TypedDict):
ChannelFlowArn: NotRequired[str],
Name: NotRequired[str],
Processors: NotRequired[List[ProcessorTypeDef]], # (1)
- See ProcessorTypeDef
ChannelFlowTypeDef#
# ChannelFlowTypeDef definition
class ChannelFlowTypeDef(TypedDict):
ChannelFlowArn: NotRequired[str],
Processors: NotRequired[List[ProcessorTypeDef]], # (1)
Name: NotRequired[str],
CreatedTimestamp: NotRequired[datetime],
LastUpdatedTimestamp: NotRequired[datetime],
- See ProcessorTypeDef
CreateChannelFlowRequestRequestTypeDef#
# CreateChannelFlowRequestRequestTypeDef definition
class CreateChannelFlowRequestRequestTypeDef(TypedDict):
AppInstanceArn: str,
Processors: Sequence[ProcessorTypeDef], # (1)
Name: str,
ClientRequestToken: str,
Tags: NotRequired[Sequence[TagTypeDef]], # (2)
- See ProcessorTypeDef
- See TagTypeDef
UpdateChannelFlowRequestRequestTypeDef#
# UpdateChannelFlowRequestRequestTypeDef definition
class UpdateChannelFlowRequestRequestTypeDef(TypedDict):
ChannelFlowArn: str,
Processors: Sequence[ProcessorTypeDef], # (1)
Name: str,
- See ProcessorTypeDef
ListChannelFlowsResponseTypeDef#
# ListChannelFlowsResponseTypeDef definition
class ListChannelFlowsResponseTypeDef(TypedDict):
ChannelFlows: List[ChannelFlowSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeChannelFlowResponseTypeDef#
# DescribeChannelFlowResponseTypeDef definition
class DescribeChannelFlowResponseTypeDef(TypedDict):
ChannelFlow: ChannelFlowTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)