Typed dictionaries
Index > ChimeSDKMessaging > Typed dictionaries
Auto-generated documentation for ChimeSDKMessaging type annotations stubs module types-aiobotocore-chime-sdk-messaging.
AppInstanceUserMembershipSummaryTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import AppInstanceUserMembershipSummaryTypeDef
def get_value() -> AppInstanceUserMembershipSummaryTypeDef:
return {
"Type": ...,
}
Definition
class AppInstanceUserMembershipSummaryTypeDef(TypedDict):
Type: NotRequired[ChannelMembershipTypeType], # (1)
ReadMarkerTimestamp: NotRequired[datetime],
SubChannelId: NotRequired[str],
AssociateChannelFlowRequestRequestTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import AssociateChannelFlowRequestRequestTypeDef
def get_value() -> AssociateChannelFlowRequestRequestTypeDef:
return {
"ChannelArn": ...,
"ChannelFlowArn": ...,
"ChimeBearer": ...,
}
Definition
class AssociateChannelFlowRequestRequestTypeDef(TypedDict):
ChannelArn: str,
ChannelFlowArn: str,
ChimeBearer: str,
IdentityTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import IdentityTypeDef
def get_value() -> IdentityTypeDef:
return {
"Arn": ...,
}
BatchCreateChannelMembershipErrorTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import BatchCreateChannelMembershipErrorTypeDef
def get_value() -> BatchCreateChannelMembershipErrorTypeDef:
return {
"MemberArn": ...,
}
Definition
class BatchCreateChannelMembershipErrorTypeDef(TypedDict):
MemberArn: NotRequired[str],
ErrorCode: NotRequired[ErrorCodeType], # (1)
ErrorMessage: NotRequired[str],
- See ErrorCodeType
BatchCreateChannelMembershipRequestRequestTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import BatchCreateChannelMembershipRequestRequestTypeDef
def get_value() -> BatchCreateChannelMembershipRequestRequestTypeDef:
return {
"ChannelArn": ...,
"MemberArns": ...,
"ChimeBearer": ...,
}
Definition
class BatchCreateChannelMembershipRequestRequestTypeDef(TypedDict):
ChannelArn: str,
MemberArns: Sequence[str],
ChimeBearer: str,
Type: NotRequired[ChannelMembershipTypeType], # (1)
SubChannelId: NotRequired[str],
ResponseMetadataTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import ResponseMetadataTypeDef
def get_value() -> ResponseMetadataTypeDef:
return {
"RequestId": ...,
"HostId": ...,
"HTTPStatusCode": ...,
"HTTPHeaders": ...,
"RetryAttempts": ...,
}
Definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
ChannelAssociatedWithFlowSummaryTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import ChannelAssociatedWithFlowSummaryTypeDef
def get_value() -> ChannelAssociatedWithFlowSummaryTypeDef:
return {
"Name": ...,
}
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
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import ChannelSummaryTypeDef
def get_value() -> ChannelSummaryTypeDef:
return {
"Name": ...,
}
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
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import PushNotificationPreferencesTypeDef
def get_value() -> PushNotificationPreferencesTypeDef:
return {
"AllowNotifications": ...,
}
Definition
class PushNotificationPreferencesTypeDef(TypedDict):
AllowNotifications: AllowNotificationsType, # (1)
FilterRule: NotRequired[str],
MessageAttributeValueTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import MessageAttributeValueTypeDef
def get_value() -> MessageAttributeValueTypeDef:
return {
"StringValues": ...,
}
PushNotificationConfigurationTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import PushNotificationConfigurationTypeDef
def get_value() -> PushNotificationConfigurationTypeDef:
return {
"Title": ...,
}
Definition
class PushNotificationConfigurationTypeDef(TypedDict):
Title: NotRequired[str],
Body: NotRequired[str],
Type: NotRequired[PushNotificationTypeType], # (1)
ChannelMessageStatusStructureTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import ChannelMessageStatusStructureTypeDef
def get_value() -> ChannelMessageStatusStructureTypeDef:
return {
"Value": ...,
}
Definition
class ChannelMessageStatusStructureTypeDef(TypedDict):
Value: NotRequired[ChannelMessageStatusType], # (1)
Detail: NotRequired[str],
ElasticChannelConfigurationTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import ElasticChannelConfigurationTypeDef
def get_value() -> ElasticChannelConfigurationTypeDef:
return {
"MaximumSubChannels": ...,
"TargetMembershipsPerSubChannel": ...,
"MinimumMembershipPercentage": ...,
}
Definition
class ElasticChannelConfigurationTypeDef(TypedDict):
MaximumSubChannels: int,
TargetMembershipsPerSubChannel: int,
MinimumMembershipPercentage: int,
CreateChannelBanRequestRequestTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import CreateChannelBanRequestRequestTypeDef
def get_value() -> CreateChannelBanRequestRequestTypeDef:
return {
"ChannelArn": ...,
"MemberArn": ...,
"ChimeBearer": ...,
}
Definition
class CreateChannelBanRequestRequestTypeDef(TypedDict):
ChannelArn: str,
MemberArn: str,
ChimeBearer: str,
TagTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import TagTypeDef
def get_value() -> TagTypeDef:
return {
"Key": ...,
"Value": ...,
}
CreateChannelMembershipRequestRequestTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import CreateChannelMembershipRequestRequestTypeDef
def get_value() -> CreateChannelMembershipRequestRequestTypeDef:
return {
"ChannelArn": ...,
"MemberArn": ...,
"Type": ...,
"ChimeBearer": ...,
}
Definition
class CreateChannelMembershipRequestRequestTypeDef(TypedDict):
ChannelArn: str,
MemberArn: str,
Type: ChannelMembershipTypeType, # (1)
ChimeBearer: str,
SubChannelId: NotRequired[str],
CreateChannelModeratorRequestRequestTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import CreateChannelModeratorRequestRequestTypeDef
def get_value() -> CreateChannelModeratorRequestRequestTypeDef:
return {
"ChannelArn": ...,
"ChannelModeratorArn": ...,
"ChimeBearer": ...,
}
Definition
class CreateChannelModeratorRequestRequestTypeDef(TypedDict):
ChannelArn: str,
ChannelModeratorArn: str,
ChimeBearer: str,
DeleteChannelBanRequestRequestTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import DeleteChannelBanRequestRequestTypeDef
def get_value() -> DeleteChannelBanRequestRequestTypeDef:
return {
"ChannelArn": ...,
"MemberArn": ...,
"ChimeBearer": ...,
}
Definition
class DeleteChannelBanRequestRequestTypeDef(TypedDict):
ChannelArn: str,
MemberArn: str,
ChimeBearer: str,
DeleteChannelFlowRequestRequestTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import DeleteChannelFlowRequestRequestTypeDef
def get_value() -> DeleteChannelFlowRequestRequestTypeDef:
return {
"ChannelFlowArn": ...,
}
DeleteChannelMembershipRequestRequestTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import DeleteChannelMembershipRequestRequestTypeDef
def get_value() -> DeleteChannelMembershipRequestRequestTypeDef:
return {
"ChannelArn": ...,
"MemberArn": ...,
"ChimeBearer": ...,
}
Definition
class DeleteChannelMembershipRequestRequestTypeDef(TypedDict):
ChannelArn: str,
MemberArn: str,
ChimeBearer: str,
SubChannelId: NotRequired[str],
DeleteChannelMessageRequestRequestTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import DeleteChannelMessageRequestRequestTypeDef
def get_value() -> DeleteChannelMessageRequestRequestTypeDef:
return {
"ChannelArn": ...,
"MessageId": ...,
"ChimeBearer": ...,
}
Definition
class DeleteChannelMessageRequestRequestTypeDef(TypedDict):
ChannelArn: str,
MessageId: str,
ChimeBearer: str,
SubChannelId: NotRequired[str],
DeleteChannelModeratorRequestRequestTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import DeleteChannelModeratorRequestRequestTypeDef
def get_value() -> DeleteChannelModeratorRequestRequestTypeDef:
return {
"ChannelArn": ...,
"ChannelModeratorArn": ...,
"ChimeBearer": ...,
}
Definition
class DeleteChannelModeratorRequestRequestTypeDef(TypedDict):
ChannelArn: str,
ChannelModeratorArn: str,
ChimeBearer: str,
DeleteChannelRequestRequestTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import DeleteChannelRequestRequestTypeDef
def get_value() -> DeleteChannelRequestRequestTypeDef:
return {
"ChannelArn": ...,
"ChimeBearer": ...,
}
Definition
class DeleteChannelRequestRequestTypeDef(TypedDict):
ChannelArn: str,
ChimeBearer: str,
SubChannelId: NotRequired[str],
DescribeChannelBanRequestRequestTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import DescribeChannelBanRequestRequestTypeDef
def get_value() -> DescribeChannelBanRequestRequestTypeDef:
return {
"ChannelArn": ...,
"MemberArn": ...,
"ChimeBearer": ...,
}
Definition
class DescribeChannelBanRequestRequestTypeDef(TypedDict):
ChannelArn: str,
MemberArn: str,
ChimeBearer: str,
DescribeChannelFlowRequestRequestTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import DescribeChannelFlowRequestRequestTypeDef
def get_value() -> DescribeChannelFlowRequestRequestTypeDef:
return {
"ChannelFlowArn": ...,
}
DescribeChannelMembershipForAppInstanceUserRequestRequestTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import DescribeChannelMembershipForAppInstanceUserRequestRequestTypeDef
def get_value() -> DescribeChannelMembershipForAppInstanceUserRequestRequestTypeDef:
return {
"ChannelArn": ...,
"AppInstanceUserArn": ...,
"ChimeBearer": ...,
}
Definition
class DescribeChannelMembershipForAppInstanceUserRequestRequestTypeDef(TypedDict):
ChannelArn: str,
AppInstanceUserArn: str,
ChimeBearer: str,
DescribeChannelMembershipRequestRequestTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import DescribeChannelMembershipRequestRequestTypeDef
def get_value() -> DescribeChannelMembershipRequestRequestTypeDef:
return {
"ChannelArn": ...,
"MemberArn": ...,
"ChimeBearer": ...,
}
Definition
class DescribeChannelMembershipRequestRequestTypeDef(TypedDict):
ChannelArn: str,
MemberArn: str,
ChimeBearer: str,
SubChannelId: NotRequired[str],
DescribeChannelModeratedByAppInstanceUserRequestRequestTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import DescribeChannelModeratedByAppInstanceUserRequestRequestTypeDef
def get_value() -> DescribeChannelModeratedByAppInstanceUserRequestRequestTypeDef:
return {
"ChannelArn": ...,
"AppInstanceUserArn": ...,
"ChimeBearer": ...,
}
Definition
class DescribeChannelModeratedByAppInstanceUserRequestRequestTypeDef(TypedDict):
ChannelArn: str,
AppInstanceUserArn: str,
ChimeBearer: str,
DescribeChannelModeratorRequestRequestTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import DescribeChannelModeratorRequestRequestTypeDef
def get_value() -> DescribeChannelModeratorRequestRequestTypeDef:
return {
"ChannelArn": ...,
"ChannelModeratorArn": ...,
"ChimeBearer": ...,
}
Definition
class DescribeChannelModeratorRequestRequestTypeDef(TypedDict):
ChannelArn: str,
ChannelModeratorArn: str,
ChimeBearer: str,
DescribeChannelRequestRequestTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import DescribeChannelRequestRequestTypeDef
def get_value() -> DescribeChannelRequestRequestTypeDef:
return {
"ChannelArn": ...,
"ChimeBearer": ...,
}
DisassociateChannelFlowRequestRequestTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import DisassociateChannelFlowRequestRequestTypeDef
def get_value() -> DisassociateChannelFlowRequestRequestTypeDef:
return {
"ChannelArn": ...,
"ChannelFlowArn": ...,
"ChimeBearer": ...,
}
Definition
class DisassociateChannelFlowRequestRequestTypeDef(TypedDict):
ChannelArn: str,
ChannelFlowArn: str,
ChimeBearer: str,
GetChannelMembershipPreferencesRequestRequestTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import GetChannelMembershipPreferencesRequestRequestTypeDef
def get_value() -> GetChannelMembershipPreferencesRequestRequestTypeDef:
return {
"ChannelArn": ...,
"MemberArn": ...,
"ChimeBearer": ...,
}
Definition
class GetChannelMembershipPreferencesRequestRequestTypeDef(TypedDict):
ChannelArn: str,
MemberArn: str,
ChimeBearer: str,
GetChannelMessageRequestRequestTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import GetChannelMessageRequestRequestTypeDef
def get_value() -> GetChannelMessageRequestRequestTypeDef:
return {
"ChannelArn": ...,
"MessageId": ...,
"ChimeBearer": ...,
}
Definition
class GetChannelMessageRequestRequestTypeDef(TypedDict):
ChannelArn: str,
MessageId: str,
ChimeBearer: str,
SubChannelId: NotRequired[str],
GetChannelMessageStatusRequestRequestTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import GetChannelMessageStatusRequestRequestTypeDef
def get_value() -> GetChannelMessageStatusRequestRequestTypeDef:
return {
"ChannelArn": ...,
"MessageId": ...,
"ChimeBearer": ...,
}
Definition
class GetChannelMessageStatusRequestRequestTypeDef(TypedDict):
ChannelArn: str,
MessageId: str,
ChimeBearer: str,
SubChannelId: NotRequired[str],
MessagingSessionEndpointTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import MessagingSessionEndpointTypeDef
def get_value() -> MessagingSessionEndpointTypeDef:
return {
"Url": ...,
}
LambdaConfigurationTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import LambdaConfigurationTypeDef
def get_value() -> LambdaConfigurationTypeDef:
return {
"ResourceArn": ...,
"InvocationType": ...,
}
Definition
class LambdaConfigurationTypeDef(TypedDict):
ResourceArn: str,
InvocationType: InvocationTypeType, # (1)
ListChannelBansRequestRequestTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import ListChannelBansRequestRequestTypeDef
def get_value() -> ListChannelBansRequestRequestTypeDef:
return {
"ChannelArn": ...,
"ChimeBearer": ...,
}
Definition
class ListChannelBansRequestRequestTypeDef(TypedDict):
ChannelArn: str,
ChimeBearer: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
ListChannelFlowsRequestRequestTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import ListChannelFlowsRequestRequestTypeDef
def get_value() -> ListChannelFlowsRequestRequestTypeDef:
return {
"AppInstanceArn": ...,
}
Definition
class ListChannelFlowsRequestRequestTypeDef(TypedDict):
AppInstanceArn: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
ListChannelMembershipsForAppInstanceUserRequestRequestTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import ListChannelMembershipsForAppInstanceUserRequestRequestTypeDef
def get_value() -> ListChannelMembershipsForAppInstanceUserRequestRequestTypeDef:
return {
"ChimeBearer": ...,
}
Definition
class ListChannelMembershipsForAppInstanceUserRequestRequestTypeDef(TypedDict):
ChimeBearer: str,
AppInstanceUserArn: NotRequired[str],
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
ListChannelMembershipsRequestRequestTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import ListChannelMembershipsRequestRequestTypeDef
def get_value() -> ListChannelMembershipsRequestRequestTypeDef:
return {
"ChannelArn": ...,
"ChimeBearer": ...,
}
Definition
class ListChannelMembershipsRequestRequestTypeDef(TypedDict):
ChannelArn: str,
ChimeBearer: str,
Type: NotRequired[ChannelMembershipTypeType], # (1)
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
SubChannelId: NotRequired[str],
ListChannelMessagesRequestRequestTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import ListChannelMessagesRequestRequestTypeDef
def get_value() -> ListChannelMessagesRequestRequestTypeDef:
return {
"ChannelArn": ...,
"ChimeBearer": ...,
}
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
ListChannelModeratorsRequestRequestTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import ListChannelModeratorsRequestRequestTypeDef
def get_value() -> ListChannelModeratorsRequestRequestTypeDef:
return {
"ChannelArn": ...,
"ChimeBearer": ...,
}
Definition
class ListChannelModeratorsRequestRequestTypeDef(TypedDict):
ChannelArn: str,
ChimeBearer: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
ListChannelsAssociatedWithChannelFlowRequestRequestTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import ListChannelsAssociatedWithChannelFlowRequestRequestTypeDef
def get_value() -> ListChannelsAssociatedWithChannelFlowRequestRequestTypeDef:
return {
"ChannelFlowArn": ...,
}
Definition
class ListChannelsAssociatedWithChannelFlowRequestRequestTypeDef(TypedDict):
ChannelFlowArn: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
ListChannelsModeratedByAppInstanceUserRequestRequestTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import ListChannelsModeratedByAppInstanceUserRequestRequestTypeDef
def get_value() -> ListChannelsModeratedByAppInstanceUserRequestRequestTypeDef:
return {
"ChimeBearer": ...,
}
Definition
class ListChannelsModeratedByAppInstanceUserRequestRequestTypeDef(TypedDict):
ChimeBearer: str,
AppInstanceUserArn: NotRequired[str],
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
ListChannelsRequestRequestTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import ListChannelsRequestRequestTypeDef
def get_value() -> ListChannelsRequestRequestTypeDef:
return {
"AppInstanceArn": ...,
"ChimeBearer": ...,
}
Definition
class ListChannelsRequestRequestTypeDef(TypedDict):
AppInstanceArn: str,
ChimeBearer: str,
Privacy: NotRequired[ChannelPrivacyType], # (1)
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
ListSubChannelsRequestRequestTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import ListSubChannelsRequestRequestTypeDef
def get_value() -> ListSubChannelsRequestRequestTypeDef:
return {
"ChannelArn": ...,
"ChimeBearer": ...,
}
Definition
class ListSubChannelsRequestRequestTypeDef(TypedDict):
ChannelArn: str,
ChimeBearer: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
SubChannelSummaryTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import SubChannelSummaryTypeDef
def get_value() -> SubChannelSummaryTypeDef:
return {
"SubChannelId": ...,
}
Definition
class SubChannelSummaryTypeDef(TypedDict):
SubChannelId: NotRequired[str],
MembershipCount: NotRequired[int],
ListTagsForResourceRequestRequestTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import ListTagsForResourceRequestRequestTypeDef
def get_value() -> ListTagsForResourceRequestRequestTypeDef:
return {
"ResourceARN": ...,
}
RedactChannelMessageRequestRequestTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import RedactChannelMessageRequestRequestTypeDef
def get_value() -> RedactChannelMessageRequestRequestTypeDef:
return {
"ChannelArn": ...,
"MessageId": ...,
"ChimeBearer": ...,
}
Definition
class RedactChannelMessageRequestRequestTypeDef(TypedDict):
ChannelArn: str,
MessageId: str,
ChimeBearer: str,
SubChannelId: NotRequired[str],
SearchFieldTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import SearchFieldTypeDef
def get_value() -> SearchFieldTypeDef:
return {
"Key": ...,
"Values": ...,
"Operator": ...,
}
Definition
class SearchFieldTypeDef(TypedDict):
Key: SearchFieldKeyType, # (1)
Values: Sequence[str],
Operator: SearchFieldOperatorType, # (2)
UntagResourceRequestRequestTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import UntagResourceRequestRequestTypeDef
def get_value() -> UntagResourceRequestRequestTypeDef:
return {
"ResourceARN": ...,
"TagKeys": ...,
}
Definition
class UntagResourceRequestRequestTypeDef(TypedDict):
ResourceARN: str,
TagKeys: Sequence[str],
UpdateChannelMessageRequestRequestTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import UpdateChannelMessageRequestRequestTypeDef
def get_value() -> UpdateChannelMessageRequestRequestTypeDef:
return {
"ChannelArn": ...,
"MessageId": ...,
"ChimeBearer": ...,
}
Definition
class UpdateChannelMessageRequestRequestTypeDef(TypedDict):
ChannelArn: str,
MessageId: str,
ChimeBearer: str,
Content: NotRequired[str],
Metadata: NotRequired[str],
SubChannelId: NotRequired[str],
UpdateChannelReadMarkerRequestRequestTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import UpdateChannelReadMarkerRequestRequestTypeDef
def get_value() -> UpdateChannelReadMarkerRequestRequestTypeDef:
return {
"ChannelArn": ...,
"ChimeBearer": ...,
}
Definition
class UpdateChannelReadMarkerRequestRequestTypeDef(TypedDict):
ChannelArn: str,
ChimeBearer: str,
SubChannelId: NotRequired[str],
UpdateChannelRequestRequestTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import UpdateChannelRequestRequestTypeDef
def get_value() -> UpdateChannelRequestRequestTypeDef:
return {
"ChannelArn": ...,
"ChimeBearer": ...,
}
Definition
class UpdateChannelRequestRequestTypeDef(TypedDict):
ChannelArn: str,
ChimeBearer: str,
Name: NotRequired[str],
Mode: NotRequired[ChannelModeType], # (1)
Metadata: NotRequired[str],
- See ChannelModeType
BatchChannelMembershipsTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import BatchChannelMembershipsTypeDef
def get_value() -> BatchChannelMembershipsTypeDef:
return {
"InvitedBy": ...,
}
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
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import ChannelBanSummaryTypeDef
def get_value() -> ChannelBanSummaryTypeDef:
return {
"Member": ...,
}
- See IdentityTypeDef
ChannelBanTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import ChannelBanTypeDef
def get_value() -> ChannelBanTypeDef:
return {
"Member": ...,
}
Definition
class ChannelBanTypeDef(TypedDict):
Member: NotRequired[IdentityTypeDef], # (1)
ChannelArn: NotRequired[str],
CreatedTimestamp: NotRequired[datetime],
CreatedBy: NotRequired[IdentityTypeDef], # (1)
- See IdentityTypeDef
- See IdentityTypeDef
ChannelMembershipSummaryTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import ChannelMembershipSummaryTypeDef
def get_value() -> ChannelMembershipSummaryTypeDef:
return {
"Member": ...,
}
Definition
class ChannelMembershipSummaryTypeDef(TypedDict):
Member: NotRequired[IdentityTypeDef], # (1)
- See IdentityTypeDef
ChannelMembershipTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import ChannelMembershipTypeDef
def get_value() -> ChannelMembershipTypeDef:
return {
"InvitedBy": ...,
}
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
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import ChannelModeratorSummaryTypeDef
def get_value() -> ChannelModeratorSummaryTypeDef:
return {
"Moderator": ...,
}
Definition
class ChannelModeratorSummaryTypeDef(TypedDict):
Moderator: NotRequired[IdentityTypeDef], # (1)
- See IdentityTypeDef
ChannelModeratorTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import ChannelModeratorTypeDef
def get_value() -> ChannelModeratorTypeDef:
return {
"Moderator": ...,
}
Definition
class ChannelModeratorTypeDef(TypedDict):
Moderator: NotRequired[IdentityTypeDef], # (1)
ChannelArn: NotRequired[str],
CreatedTimestamp: NotRequired[datetime],
CreatedBy: NotRequired[IdentityTypeDef], # (1)
- See IdentityTypeDef
- See IdentityTypeDef
ChannelFlowCallbackResponseTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import ChannelFlowCallbackResponseTypeDef
def get_value() -> ChannelFlowCallbackResponseTypeDef:
return {
"ChannelArn": ...,
"CallbackId": ...,
"ResponseMetadata": ...,
}
Definition
class ChannelFlowCallbackResponseTypeDef(TypedDict):
ChannelArn: str,
CallbackId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateChannelBanResponseTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import CreateChannelBanResponseTypeDef
def get_value() -> CreateChannelBanResponseTypeDef:
return {
"ChannelArn": ...,
"Member": ...,
"ResponseMetadata": ...,
}
Definition
class CreateChannelBanResponseTypeDef(TypedDict):
ChannelArn: str,
Member: IdentityTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateChannelFlowResponseTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import CreateChannelFlowResponseTypeDef
def get_value() -> CreateChannelFlowResponseTypeDef:
return {
"ChannelFlowArn": ...,
"ResponseMetadata": ...,
}
Definition
class CreateChannelFlowResponseTypeDef(TypedDict):
ChannelFlowArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateChannelMembershipResponseTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import CreateChannelMembershipResponseTypeDef
def get_value() -> CreateChannelMembershipResponseTypeDef:
return {
"ChannelArn": ...,
"Member": ...,
"SubChannelId": ...,
"ResponseMetadata": ...,
}
Definition
class CreateChannelMembershipResponseTypeDef(TypedDict):
ChannelArn: str,
Member: IdentityTypeDef, # (1)
SubChannelId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateChannelModeratorResponseTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import CreateChannelModeratorResponseTypeDef
def get_value() -> CreateChannelModeratorResponseTypeDef:
return {
"ChannelArn": ...,
"ChannelModerator": ...,
"ResponseMetadata": ...,
}
Definition
class CreateChannelModeratorResponseTypeDef(TypedDict):
ChannelArn: str,
ChannelModerator: IdentityTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateChannelResponseTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import CreateChannelResponseTypeDef
def get_value() -> CreateChannelResponseTypeDef:
return {
"ChannelArn": ...,
"ResponseMetadata": ...,
}
Definition
class CreateChannelResponseTypeDef(TypedDict):
ChannelArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
EmptyResponseMetadataTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import EmptyResponseMetadataTypeDef
def get_value() -> EmptyResponseMetadataTypeDef:
return {
"ResponseMetadata": ...,
}
Definition
class EmptyResponseMetadataTypeDef(TypedDict):
ResponseMetadata: ResponseMetadataTypeDef, # (1)
RedactChannelMessageResponseTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import RedactChannelMessageResponseTypeDef
def get_value() -> RedactChannelMessageResponseTypeDef:
return {
"ChannelArn": ...,
"MessageId": ...,
"SubChannelId": ...,
"ResponseMetadata": ...,
}
Definition
class RedactChannelMessageResponseTypeDef(TypedDict):
ChannelArn: str,
MessageId: str,
SubChannelId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateChannelFlowResponseTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import UpdateChannelFlowResponseTypeDef
def get_value() -> UpdateChannelFlowResponseTypeDef:
return {
"ChannelFlowArn": ...,
"ResponseMetadata": ...,
}
Definition
class UpdateChannelFlowResponseTypeDef(TypedDict):
ChannelFlowArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateChannelReadMarkerResponseTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import UpdateChannelReadMarkerResponseTypeDef
def get_value() -> UpdateChannelReadMarkerResponseTypeDef:
return {
"ChannelArn": ...,
"SubChannelId": ...,
"ResponseMetadata": ...,
}
Definition
class UpdateChannelReadMarkerResponseTypeDef(TypedDict):
ChannelArn: str,
SubChannelId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateChannelResponseTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import UpdateChannelResponseTypeDef
def get_value() -> UpdateChannelResponseTypeDef:
return {
"ChannelArn": ...,
"ResponseMetadata": ...,
}
Definition
class UpdateChannelResponseTypeDef(TypedDict):
ChannelArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListChannelsAssociatedWithChannelFlowResponseTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import ListChannelsAssociatedWithChannelFlowResponseTypeDef
def get_value() -> ListChannelsAssociatedWithChannelFlowResponseTypeDef:
return {
"Channels": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListChannelsAssociatedWithChannelFlowResponseTypeDef(TypedDict):
Channels: List[ChannelAssociatedWithFlowSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ChannelMembershipForAppInstanceUserSummaryTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import ChannelMembershipForAppInstanceUserSummaryTypeDef
def get_value() -> ChannelMembershipForAppInstanceUserSummaryTypeDef:
return {
"ChannelSummary": ...,
}
Definition
class ChannelMembershipForAppInstanceUserSummaryTypeDef(TypedDict):
ChannelSummary: NotRequired[ChannelSummaryTypeDef], # (1)
AppInstanceUserMembershipSummary: NotRequired[AppInstanceUserMembershipSummaryTypeDef], # (2)
ChannelModeratedByAppInstanceUserSummaryTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import ChannelModeratedByAppInstanceUserSummaryTypeDef
def get_value() -> ChannelModeratedByAppInstanceUserSummaryTypeDef:
return {
"ChannelSummary": ...,
}
Definition
class ChannelModeratedByAppInstanceUserSummaryTypeDef(TypedDict):
ChannelSummary: NotRequired[ChannelSummaryTypeDef], # (1)
ListChannelsResponseTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import ListChannelsResponseTypeDef
def get_value() -> ListChannelsResponseTypeDef:
return {
"Channels": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListChannelsResponseTypeDef(TypedDict):
Channels: List[ChannelSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
SearchChannelsResponseTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import SearchChannelsResponseTypeDef
def get_value() -> SearchChannelsResponseTypeDef:
return {
"Channels": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class SearchChannelsResponseTypeDef(TypedDict):
Channels: List[ChannelSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ChannelMembershipPreferencesTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import ChannelMembershipPreferencesTypeDef
def get_value() -> ChannelMembershipPreferencesTypeDef:
return {
"PushNotifications": ...,
}
Definition
class ChannelMembershipPreferencesTypeDef(TypedDict):
PushNotifications: NotRequired[PushNotificationPreferencesTypeDef], # (1)
ChannelMessageCallbackTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import ChannelMessageCallbackTypeDef
def get_value() -> ChannelMessageCallbackTypeDef:
return {
"MessageId": ...,
}
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],
SendChannelMessageRequestRequestTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import SendChannelMessageRequestRequestTypeDef
def get_value() -> SendChannelMessageRequestRequestTypeDef:
return {
"ChannelArn": ...,
"Content": ...,
"Type": ...,
"Persistence": ...,
"ClientRequestToken": ...,
"ChimeBearer": ...,
}
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],
- See ChannelMessageTypeType
- See ChannelMessagePersistenceTypeType
- See PushNotificationConfigurationTypeDef
- See MessageAttributeValueTypeDef
ChannelMessageSummaryTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import ChannelMessageSummaryTypeDef
def get_value() -> ChannelMessageSummaryTypeDef:
return {
"MessageId": ...,
}
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)
- See ChannelMessageTypeType
- See IdentityTypeDef
- See ChannelMessageStatusStructureTypeDef
- See MessageAttributeValueTypeDef
ChannelMessageTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import ChannelMessageTypeDef
def get_value() -> ChannelMessageTypeDef:
return {
"ChannelArn": ...,
}
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],
- See ChannelMessageTypeType
- See IdentityTypeDef
- See ChannelMessagePersistenceTypeType
- See ChannelMessageStatusStructureTypeDef
- See MessageAttributeValueTypeDef
GetChannelMessageStatusResponseTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import GetChannelMessageStatusResponseTypeDef
def get_value() -> GetChannelMessageStatusResponseTypeDef:
return {
"Status": ...,
"ResponseMetadata": ...,
}
Definition
class GetChannelMessageStatusResponseTypeDef(TypedDict):
Status: ChannelMessageStatusStructureTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
SendChannelMessageResponseTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import SendChannelMessageResponseTypeDef
def get_value() -> SendChannelMessageResponseTypeDef:
return {
"ChannelArn": ...,
"MessageId": ...,
"Status": ...,
"SubChannelId": ...,
"ResponseMetadata": ...,
}
Definition
class SendChannelMessageResponseTypeDef(TypedDict):
ChannelArn: str,
MessageId: str,
Status: ChannelMessageStatusStructureTypeDef, # (1)
SubChannelId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateChannelMessageResponseTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import UpdateChannelMessageResponseTypeDef
def get_value() -> UpdateChannelMessageResponseTypeDef:
return {
"ChannelArn": ...,
"MessageId": ...,
"Status": ...,
"SubChannelId": ...,
"ResponseMetadata": ...,
}
Definition
class UpdateChannelMessageResponseTypeDef(TypedDict):
ChannelArn: str,
MessageId: str,
Status: ChannelMessageStatusStructureTypeDef, # (1)
SubChannelId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ChannelTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import ChannelTypeDef
def get_value() -> ChannelTypeDef:
return {
"Name": ...,
}
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)
- See ChannelModeType
- See ChannelPrivacyType
- See IdentityTypeDef
- See ElasticChannelConfigurationTypeDef
CreateChannelRequestRequestTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import CreateChannelRequestRequestTypeDef
def get_value() -> CreateChannelRequestRequestTypeDef:
return {
"AppInstanceArn": ...,
"Name": ...,
"ClientRequestToken": ...,
"ChimeBearer": ...,
}
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)
ListTagsForResourceResponseTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import ListTagsForResourceResponseTypeDef
def get_value() -> ListTagsForResourceResponseTypeDef:
return {
"Tags": ...,
"ResponseMetadata": ...,
}
Definition
class ListTagsForResourceResponseTypeDef(TypedDict):
Tags: List[TagTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See TagTypeDef
- See ResponseMetadataTypeDef
TagResourceRequestRequestTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import TagResourceRequestRequestTypeDef
def get_value() -> TagResourceRequestRequestTypeDef:
return {
"ResourceARN": ...,
"Tags": ...,
}
Definition
class TagResourceRequestRequestTypeDef(TypedDict):
ResourceARN: str,
Tags: Sequence[TagTypeDef], # (1)
- See TagTypeDef
GetMessagingSessionEndpointResponseTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import GetMessagingSessionEndpointResponseTypeDef
def get_value() -> GetMessagingSessionEndpointResponseTypeDef:
return {
"Endpoint": ...,
"ResponseMetadata": ...,
}
Definition
class GetMessagingSessionEndpointResponseTypeDef(TypedDict):
Endpoint: MessagingSessionEndpointTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ProcessorConfigurationTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import ProcessorConfigurationTypeDef
def get_value() -> ProcessorConfigurationTypeDef:
return {
"Lambda": ...,
}
ListSubChannelsResponseTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import ListSubChannelsResponseTypeDef
def get_value() -> ListSubChannelsResponseTypeDef:
return {
"ChannelArn": ...,
"SubChannels": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListSubChannelsResponseTypeDef(TypedDict):
ChannelArn: str,
SubChannels: List[SubChannelSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
SearchChannelsRequestRequestTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import SearchChannelsRequestRequestTypeDef
def get_value() -> SearchChannelsRequestRequestTypeDef:
return {
"Fields": ...,
}
Definition
class SearchChannelsRequestRequestTypeDef(TypedDict):
Fields: Sequence[SearchFieldTypeDef], # (1)
ChimeBearer: NotRequired[str],
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
BatchCreateChannelMembershipResponseTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import BatchCreateChannelMembershipResponseTypeDef
def get_value() -> BatchCreateChannelMembershipResponseTypeDef:
return {
"BatchChannelMemberships": ...,
"Errors": ...,
"ResponseMetadata": ...,
}
Definition
class BatchCreateChannelMembershipResponseTypeDef(TypedDict):
BatchChannelMemberships: BatchChannelMembershipsTypeDef, # (1)
Errors: List[BatchCreateChannelMembershipErrorTypeDef], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
- See BatchChannelMembershipsTypeDef
- See BatchCreateChannelMembershipErrorTypeDef
- See ResponseMetadataTypeDef
ListChannelBansResponseTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import ListChannelBansResponseTypeDef
def get_value() -> ListChannelBansResponseTypeDef:
return {
"ChannelArn": ...,
"NextToken": ...,
"ChannelBans": ...,
"ResponseMetadata": ...,
}
Definition
class ListChannelBansResponseTypeDef(TypedDict):
ChannelArn: str,
NextToken: str,
ChannelBans: List[ChannelBanSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeChannelBanResponseTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import DescribeChannelBanResponseTypeDef
def get_value() -> DescribeChannelBanResponseTypeDef:
return {
"ChannelBan": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeChannelBanResponseTypeDef(TypedDict):
ChannelBan: ChannelBanTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListChannelMembershipsResponseTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import ListChannelMembershipsResponseTypeDef
def get_value() -> ListChannelMembershipsResponseTypeDef:
return {
"ChannelArn": ...,
"ChannelMemberships": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListChannelMembershipsResponseTypeDef(TypedDict):
ChannelArn: str,
ChannelMemberships: List[ChannelMembershipSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeChannelMembershipResponseTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import DescribeChannelMembershipResponseTypeDef
def get_value() -> DescribeChannelMembershipResponseTypeDef:
return {
"ChannelMembership": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeChannelMembershipResponseTypeDef(TypedDict):
ChannelMembership: ChannelMembershipTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListChannelModeratorsResponseTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import ListChannelModeratorsResponseTypeDef
def get_value() -> ListChannelModeratorsResponseTypeDef:
return {
"ChannelArn": ...,
"NextToken": ...,
"ChannelModerators": ...,
"ResponseMetadata": ...,
}
Definition
class ListChannelModeratorsResponseTypeDef(TypedDict):
ChannelArn: str,
NextToken: str,
ChannelModerators: List[ChannelModeratorSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeChannelModeratorResponseTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import DescribeChannelModeratorResponseTypeDef
def get_value() -> DescribeChannelModeratorResponseTypeDef:
return {
"ChannelModerator": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeChannelModeratorResponseTypeDef(TypedDict):
ChannelModerator: ChannelModeratorTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeChannelMembershipForAppInstanceUserResponseTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import DescribeChannelMembershipForAppInstanceUserResponseTypeDef
def get_value() -> DescribeChannelMembershipForAppInstanceUserResponseTypeDef:
return {
"ChannelMembership": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeChannelMembershipForAppInstanceUserResponseTypeDef(TypedDict):
ChannelMembership: ChannelMembershipForAppInstanceUserSummaryTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListChannelMembershipsForAppInstanceUserResponseTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import ListChannelMembershipsForAppInstanceUserResponseTypeDef
def get_value() -> ListChannelMembershipsForAppInstanceUserResponseTypeDef:
return {
"ChannelMemberships": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListChannelMembershipsForAppInstanceUserResponseTypeDef(TypedDict):
ChannelMemberships: List[ChannelMembershipForAppInstanceUserSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeChannelModeratedByAppInstanceUserResponseTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import DescribeChannelModeratedByAppInstanceUserResponseTypeDef
def get_value() -> DescribeChannelModeratedByAppInstanceUserResponseTypeDef:
return {
"Channel": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeChannelModeratedByAppInstanceUserResponseTypeDef(TypedDict):
Channel: ChannelModeratedByAppInstanceUserSummaryTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListChannelsModeratedByAppInstanceUserResponseTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import ListChannelsModeratedByAppInstanceUserResponseTypeDef
def get_value() -> ListChannelsModeratedByAppInstanceUserResponseTypeDef:
return {
"Channels": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListChannelsModeratedByAppInstanceUserResponseTypeDef(TypedDict):
Channels: List[ChannelModeratedByAppInstanceUserSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetChannelMembershipPreferencesResponseTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import GetChannelMembershipPreferencesResponseTypeDef
def get_value() -> GetChannelMembershipPreferencesResponseTypeDef:
return {
"ChannelArn": ...,
"Member": ...,
"Preferences": ...,
"ResponseMetadata": ...,
}
Definition
class GetChannelMembershipPreferencesResponseTypeDef(TypedDict):
ChannelArn: str,
Member: IdentityTypeDef, # (1)
Preferences: ChannelMembershipPreferencesTypeDef, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
PutChannelMembershipPreferencesRequestRequestTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import PutChannelMembershipPreferencesRequestRequestTypeDef
def get_value() -> PutChannelMembershipPreferencesRequestRequestTypeDef:
return {
"ChannelArn": ...,
"MemberArn": ...,
"ChimeBearer": ...,
"Preferences": ...,
}
Definition
class PutChannelMembershipPreferencesRequestRequestTypeDef(TypedDict):
ChannelArn: str,
MemberArn: str,
ChimeBearer: str,
Preferences: ChannelMembershipPreferencesTypeDef, # (1)
PutChannelMembershipPreferencesResponseTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import PutChannelMembershipPreferencesResponseTypeDef
def get_value() -> PutChannelMembershipPreferencesResponseTypeDef:
return {
"ChannelArn": ...,
"Member": ...,
"Preferences": ...,
"ResponseMetadata": ...,
}
Definition
class PutChannelMembershipPreferencesResponseTypeDef(TypedDict):
ChannelArn: str,
Member: IdentityTypeDef, # (1)
Preferences: ChannelMembershipPreferencesTypeDef, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
ChannelFlowCallbackRequestRequestTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import ChannelFlowCallbackRequestRequestTypeDef
def get_value() -> ChannelFlowCallbackRequestRequestTypeDef:
return {
"CallbackId": ...,
"ChannelArn": ...,
"ChannelMessage": ...,
}
Definition
class ChannelFlowCallbackRequestRequestTypeDef(TypedDict):
CallbackId: str,
ChannelArn: str,
ChannelMessage: ChannelMessageCallbackTypeDef, # (1)
DeleteResource: NotRequired[bool],
ListChannelMessagesResponseTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import ListChannelMessagesResponseTypeDef
def get_value() -> ListChannelMessagesResponseTypeDef:
return {
"ChannelArn": ...,
"NextToken": ...,
"ChannelMessages": ...,
"SubChannelId": ...,
"ResponseMetadata": ...,
}
Definition
class ListChannelMessagesResponseTypeDef(TypedDict):
ChannelArn: str,
NextToken: str,
ChannelMessages: List[ChannelMessageSummaryTypeDef], # (1)
SubChannelId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetChannelMessageResponseTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import GetChannelMessageResponseTypeDef
def get_value() -> GetChannelMessageResponseTypeDef:
return {
"ChannelMessage": ...,
"ResponseMetadata": ...,
}
Definition
class GetChannelMessageResponseTypeDef(TypedDict):
ChannelMessage: ChannelMessageTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeChannelResponseTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import DescribeChannelResponseTypeDef
def get_value() -> DescribeChannelResponseTypeDef:
return {
"Channel": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeChannelResponseTypeDef(TypedDict):
Channel: ChannelTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ProcessorTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import ProcessorTypeDef
def get_value() -> ProcessorTypeDef:
return {
"Name": ...,
"Configuration": ...,
"ExecutionOrder": ...,
"FallbackAction": ...,
}
Definition
class ProcessorTypeDef(TypedDict):
Name: str,
Configuration: ProcessorConfigurationTypeDef, # (1)
ExecutionOrder: int,
FallbackAction: FallbackActionType, # (2)
ChannelFlowSummaryTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import ChannelFlowSummaryTypeDef
def get_value() -> ChannelFlowSummaryTypeDef:
return {
"ChannelFlowArn": ...,
}
Definition
class ChannelFlowSummaryTypeDef(TypedDict):
ChannelFlowArn: NotRequired[str],
Name: NotRequired[str],
Processors: NotRequired[List[ProcessorTypeDef]], # (1)
- See ProcessorTypeDef
ChannelFlowTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import ChannelFlowTypeDef
def get_value() -> ChannelFlowTypeDef:
return {
"ChannelFlowArn": ...,
}
Definition
class ChannelFlowTypeDef(TypedDict):
ChannelFlowArn: NotRequired[str],
Processors: NotRequired[List[ProcessorTypeDef]], # (1)
Name: NotRequired[str],
CreatedTimestamp: NotRequired[datetime],
LastUpdatedTimestamp: NotRequired[datetime],
- See ProcessorTypeDef
CreateChannelFlowRequestRequestTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import CreateChannelFlowRequestRequestTypeDef
def get_value() -> CreateChannelFlowRequestRequestTypeDef:
return {
"AppInstanceArn": ...,
"Processors": ...,
"Name": ...,
"ClientRequestToken": ...,
}
Definition
class CreateChannelFlowRequestRequestTypeDef(TypedDict):
AppInstanceArn: str,
Processors: Sequence[ProcessorTypeDef], # (1)
Name: str,
ClientRequestToken: str,
Tags: NotRequired[Sequence[TagTypeDef]], # (2)
- See ProcessorTypeDef
- See TagTypeDef
UpdateChannelFlowRequestRequestTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import UpdateChannelFlowRequestRequestTypeDef
def get_value() -> UpdateChannelFlowRequestRequestTypeDef:
return {
"ChannelFlowArn": ...,
"Processors": ...,
"Name": ...,
}
Definition
class UpdateChannelFlowRequestRequestTypeDef(TypedDict):
ChannelFlowArn: str,
Processors: Sequence[ProcessorTypeDef], # (1)
Name: str,
- See ProcessorTypeDef
ListChannelFlowsResponseTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import ListChannelFlowsResponseTypeDef
def get_value() -> ListChannelFlowsResponseTypeDef:
return {
"ChannelFlows": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListChannelFlowsResponseTypeDef(TypedDict):
ChannelFlows: List[ChannelFlowSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeChannelFlowResponseTypeDef
Usage Example
from types_aiobotocore_chime_sdk_messaging.type_defs import DescribeChannelFlowResponseTypeDef
def get_value() -> DescribeChannelFlowResponseTypeDef:
return {
"ChannelFlow": ...,
"ResponseMetadata": ...,
}