Type definitions#
Index > EndUserMessagingSocial > Type definitions
Auto-generated documentation for EndUserMessagingSocial type annotations stubs module mypy-boto3-socialmessaging.
BlobTypeDef#
# BlobTypeDef Union usage example
from mypy_boto3_socialmessaging.type_defs import BlobTypeDef
def get_value() -> BlobTypeDef:
return ...
# BlobTypeDef definition
BlobTypeDef = Union[
str,
bytes,
IO[Any],
botocore.response.StreamingBody,
]
WhatsAppSignupCallbackTypeDef#
# WhatsAppSignupCallbackTypeDef TypedDict usage example
from mypy_boto3_socialmessaging.type_defs import WhatsAppSignupCallbackTypeDef
def get_value() -> WhatsAppSignupCallbackTypeDef:
return {
"accessToken": ...,
}
# WhatsAppSignupCallbackTypeDef definition
class WhatsAppSignupCallbackTypeDef(TypedDict):
accessToken: str,
callbackUrl: NotRequired[str],
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef TypedDict usage example
from mypy_boto3_socialmessaging.type_defs import ResponseMetadataTypeDef
def get_value() -> ResponseMetadataTypeDef:
return {
"RequestId": ...,
}
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
HostId: NotRequired[str],
S3FileTypeDef#
# S3FileTypeDef TypedDict usage example
from mypy_boto3_socialmessaging.type_defs import S3FileTypeDef
def get_value() -> S3FileTypeDef:
return {
"bucketName": ...,
}
# S3FileTypeDef definition
class S3FileTypeDef(TypedDict):
bucketName: str,
key: str,
DeleteWhatsAppMessageMediaInputTypeDef#
# DeleteWhatsAppMessageMediaInputTypeDef TypedDict usage example
from mypy_boto3_socialmessaging.type_defs import DeleteWhatsAppMessageMediaInputTypeDef
def get_value() -> DeleteWhatsAppMessageMediaInputTypeDef:
return {
"mediaId": ...,
}
# DeleteWhatsAppMessageMediaInputTypeDef definition
class DeleteWhatsAppMessageMediaInputTypeDef(TypedDict):
mediaId: str,
originationPhoneNumberId: str,
DeleteWhatsAppMessageTemplateInputTypeDef#
# DeleteWhatsAppMessageTemplateInputTypeDef TypedDict usage example
from mypy_boto3_socialmessaging.type_defs import DeleteWhatsAppMessageTemplateInputTypeDef
def get_value() -> DeleteWhatsAppMessageTemplateInputTypeDef:
return {
"id": ...,
}
# DeleteWhatsAppMessageTemplateInputTypeDef definition
class DeleteWhatsAppMessageTemplateInputTypeDef(TypedDict):
id: str,
templateName: str,
metaTemplateId: NotRequired[str],
deleteAllLanguages: NotRequired[bool],
DisassociateWhatsAppBusinessAccountInputTypeDef#
# DisassociateWhatsAppBusinessAccountInputTypeDef TypedDict usage example
from mypy_boto3_socialmessaging.type_defs import DisassociateWhatsAppBusinessAccountInputTypeDef
def get_value() -> DisassociateWhatsAppBusinessAccountInputTypeDef:
return {
"id": ...,
}
# DisassociateWhatsAppBusinessAccountInputTypeDef definition
class DisassociateWhatsAppBusinessAccountInputTypeDef(TypedDict):
id: str,
GetLinkedWhatsAppBusinessAccountInputTypeDef#
# GetLinkedWhatsAppBusinessAccountInputTypeDef TypedDict usage example
from mypy_boto3_socialmessaging.type_defs import GetLinkedWhatsAppBusinessAccountInputTypeDef
def get_value() -> GetLinkedWhatsAppBusinessAccountInputTypeDef:
return {
"id": ...,
}
# GetLinkedWhatsAppBusinessAccountInputTypeDef definition
class GetLinkedWhatsAppBusinessAccountInputTypeDef(TypedDict):
id: str,
GetLinkedWhatsAppBusinessAccountPhoneNumberInputTypeDef#
# GetLinkedWhatsAppBusinessAccountPhoneNumberInputTypeDef TypedDict usage example
from mypy_boto3_socialmessaging.type_defs import GetLinkedWhatsAppBusinessAccountPhoneNumberInputTypeDef
def get_value() -> GetLinkedWhatsAppBusinessAccountPhoneNumberInputTypeDef:
return {
"id": ...,
}
# GetLinkedWhatsAppBusinessAccountPhoneNumberInputTypeDef definition
class GetLinkedWhatsAppBusinessAccountPhoneNumberInputTypeDef(TypedDict):
id: str,
WhatsAppPhoneNumberDetailTypeDef#
# WhatsAppPhoneNumberDetailTypeDef TypedDict usage example
from mypy_boto3_socialmessaging.type_defs import WhatsAppPhoneNumberDetailTypeDef
def get_value() -> WhatsAppPhoneNumberDetailTypeDef:
return {
"arn": ...,
}
# WhatsAppPhoneNumberDetailTypeDef definition
class WhatsAppPhoneNumberDetailTypeDef(TypedDict):
arn: str,
phoneNumber: str,
phoneNumberId: str,
metaPhoneNumberId: str,
displayPhoneNumberName: str,
displayPhoneNumber: str,
qualityRating: str,
dataLocalizationRegion: NotRequired[str],
S3PresignedUrlTypeDef#
# S3PresignedUrlTypeDef TypedDict usage example
from mypy_boto3_socialmessaging.type_defs import S3PresignedUrlTypeDef
def get_value() -> S3PresignedUrlTypeDef:
return {
"url": ...,
}
# S3PresignedUrlTypeDef definition
class S3PresignedUrlTypeDef(TypedDict):
url: str,
headers: Mapping[str, str],
GetWhatsAppMessageTemplateInputTypeDef#
# GetWhatsAppMessageTemplateInputTypeDef TypedDict usage example
from mypy_boto3_socialmessaging.type_defs import GetWhatsAppMessageTemplateInputTypeDef
def get_value() -> GetWhatsAppMessageTemplateInputTypeDef:
return {
"metaTemplateId": ...,
}
# GetWhatsAppMessageTemplateInputTypeDef definition
class GetWhatsAppMessageTemplateInputTypeDef(TypedDict):
metaTemplateId: str,
id: str,
LibraryTemplateBodyInputsTypeDef#
# LibraryTemplateBodyInputsTypeDef TypedDict usage example
from mypy_boto3_socialmessaging.type_defs import LibraryTemplateBodyInputsTypeDef
def get_value() -> LibraryTemplateBodyInputsTypeDef:
return {
"addContactNumber": ...,
}
# LibraryTemplateBodyInputsTypeDef definition
class LibraryTemplateBodyInputsTypeDef(TypedDict):
addContactNumber: NotRequired[bool],
addLearnMoreLink: NotRequired[bool],
addSecurityRecommendation: NotRequired[bool],
addTrackPackageLink: NotRequired[bool],
codeExpirationMinutes: NotRequired[int],
LibraryTemplateButtonInputTypeDef#
# LibraryTemplateButtonInputTypeDef TypedDict usage example
from mypy_boto3_socialmessaging.type_defs import LibraryTemplateButtonInputTypeDef
def get_value() -> LibraryTemplateButtonInputTypeDef:
return {
"type": ...,
}
# LibraryTemplateButtonInputTypeDef definition
class LibraryTemplateButtonInputTypeDef(TypedDict):
type: NotRequired[str],
phoneNumber: NotRequired[str],
url: NotRequired[Mapping[str, str]],
otpType: NotRequired[str],
zeroTapTermsAccepted: NotRequired[bool],
supportedApps: NotRequired[Sequence[Mapping[str, str]]],
LibraryTemplateButtonListTypeDef#
# LibraryTemplateButtonListTypeDef TypedDict usage example
from mypy_boto3_socialmessaging.type_defs import LibraryTemplateButtonListTypeDef
def get_value() -> LibraryTemplateButtonListTypeDef:
return {
"type": ...,
}
# LibraryTemplateButtonListTypeDef definition
class LibraryTemplateButtonListTypeDef(TypedDict):
type: NotRequired[str],
text: NotRequired[str],
phoneNumber: NotRequired[str],
url: NotRequired[str],
otpType: NotRequired[str],
zeroTapTermsAccepted: NotRequired[bool],
supportedApps: NotRequired[List[Dict[str, str]]],
WhatsAppBusinessAccountEventDestinationTypeDef#
# WhatsAppBusinessAccountEventDestinationTypeDef TypedDict usage example
from mypy_boto3_socialmessaging.type_defs import WhatsAppBusinessAccountEventDestinationTypeDef
def get_value() -> WhatsAppBusinessAccountEventDestinationTypeDef:
return {
"eventDestinationArn": ...,
}
# WhatsAppBusinessAccountEventDestinationTypeDef definition
class WhatsAppBusinessAccountEventDestinationTypeDef(TypedDict):
eventDestinationArn: str,
roleArn: NotRequired[str],
WhatsAppPhoneNumberSummaryTypeDef#
# WhatsAppPhoneNumberSummaryTypeDef TypedDict usage example
from mypy_boto3_socialmessaging.type_defs import WhatsAppPhoneNumberSummaryTypeDef
def get_value() -> WhatsAppPhoneNumberSummaryTypeDef:
return {
"arn": ...,
}
# WhatsAppPhoneNumberSummaryTypeDef definition
class WhatsAppPhoneNumberSummaryTypeDef(TypedDict):
arn: str,
phoneNumber: str,
phoneNumberId: str,
metaPhoneNumberId: str,
displayPhoneNumberName: str,
displayPhoneNumber: str,
qualityRating: str,
dataLocalizationRegion: NotRequired[str],
PaginatorConfigTypeDef#
# PaginatorConfigTypeDef TypedDict usage example
from mypy_boto3_socialmessaging.type_defs import PaginatorConfigTypeDef
def get_value() -> PaginatorConfigTypeDef:
return {
"MaxItems": ...,
}
# PaginatorConfigTypeDef definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],
ListLinkedWhatsAppBusinessAccountsInputTypeDef#
# ListLinkedWhatsAppBusinessAccountsInputTypeDef TypedDict usage example
from mypy_boto3_socialmessaging.type_defs import ListLinkedWhatsAppBusinessAccountsInputTypeDef
def get_value() -> ListLinkedWhatsAppBusinessAccountsInputTypeDef:
return {
"nextToken": ...,
}
# ListLinkedWhatsAppBusinessAccountsInputTypeDef definition
class ListLinkedWhatsAppBusinessAccountsInputTypeDef(TypedDict):
nextToken: NotRequired[str],
maxResults: NotRequired[int],
ListTagsForResourceInputTypeDef#
# ListTagsForResourceInputTypeDef TypedDict usage example
from mypy_boto3_socialmessaging.type_defs import ListTagsForResourceInputTypeDef
def get_value() -> ListTagsForResourceInputTypeDef:
return {
"resourceArn": ...,
}
# ListTagsForResourceInputTypeDef definition
class ListTagsForResourceInputTypeDef(TypedDict):
resourceArn: str,
TagTypeDef#
# TagTypeDef TypedDict usage example
from mypy_boto3_socialmessaging.type_defs import TagTypeDef
def get_value() -> TagTypeDef:
return {
"key": ...,
}
# TagTypeDef definition
class TagTypeDef(TypedDict):
key: str,
value: NotRequired[str],
ListWhatsAppMessageTemplatesInputTypeDef#
# ListWhatsAppMessageTemplatesInputTypeDef TypedDict usage example
from mypy_boto3_socialmessaging.type_defs import ListWhatsAppMessageTemplatesInputTypeDef
def get_value() -> ListWhatsAppMessageTemplatesInputTypeDef:
return {
"id": ...,
}
# ListWhatsAppMessageTemplatesInputTypeDef definition
class ListWhatsAppMessageTemplatesInputTypeDef(TypedDict):
id: str,
nextToken: NotRequired[str],
maxResults: NotRequired[int],
TemplateSummaryTypeDef#
# TemplateSummaryTypeDef TypedDict usage example
from mypy_boto3_socialmessaging.type_defs import TemplateSummaryTypeDef
def get_value() -> TemplateSummaryTypeDef:
return {
"templateName": ...,
}
# TemplateSummaryTypeDef definition
class TemplateSummaryTypeDef(TypedDict):
templateName: NotRequired[str],
metaTemplateId: NotRequired[str],
templateStatus: NotRequired[str],
templateQualityScore: NotRequired[str],
templateLanguage: NotRequired[str],
templateCategory: NotRequired[str],
ListWhatsAppTemplateLibraryInputTypeDef#
# ListWhatsAppTemplateLibraryInputTypeDef TypedDict usage example
from mypy_boto3_socialmessaging.type_defs import ListWhatsAppTemplateLibraryInputTypeDef
def get_value() -> ListWhatsAppTemplateLibraryInputTypeDef:
return {
"id": ...,
}
# ListWhatsAppTemplateLibraryInputTypeDef definition
class ListWhatsAppTemplateLibraryInputTypeDef(TypedDict):
id: str,
nextToken: NotRequired[str],
maxResults: NotRequired[int],
filters: NotRequired[Mapping[str, str]],
UntagResourceInputTypeDef#
# UntagResourceInputTypeDef TypedDict usage example
from mypy_boto3_socialmessaging.type_defs import UntagResourceInputTypeDef
def get_value() -> UntagResourceInputTypeDef:
return {
"resourceArn": ...,
}
# UntagResourceInputTypeDef definition
class UntagResourceInputTypeDef(TypedDict):
resourceArn: str,
tagKeys: Sequence[str],
CreateWhatsAppMessageTemplateFromLibraryOutputTypeDef#
# CreateWhatsAppMessageTemplateFromLibraryOutputTypeDef TypedDict usage example
from mypy_boto3_socialmessaging.type_defs import CreateWhatsAppMessageTemplateFromLibraryOutputTypeDef
def get_value() -> CreateWhatsAppMessageTemplateFromLibraryOutputTypeDef:
return {
"metaTemplateId": ...,
}
# CreateWhatsAppMessageTemplateFromLibraryOutputTypeDef definition
class CreateWhatsAppMessageTemplateFromLibraryOutputTypeDef(TypedDict):
metaTemplateId: str,
templateStatus: str,
category: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateWhatsAppMessageTemplateMediaOutputTypeDef#
# CreateWhatsAppMessageTemplateMediaOutputTypeDef TypedDict usage example
from mypy_boto3_socialmessaging.type_defs import CreateWhatsAppMessageTemplateMediaOutputTypeDef
def get_value() -> CreateWhatsAppMessageTemplateMediaOutputTypeDef:
return {
"metaHeaderHandle": ...,
}
# CreateWhatsAppMessageTemplateMediaOutputTypeDef definition
class CreateWhatsAppMessageTemplateMediaOutputTypeDef(TypedDict):
metaHeaderHandle: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateWhatsAppMessageTemplateOutputTypeDef#
# CreateWhatsAppMessageTemplateOutputTypeDef TypedDict usage example
from mypy_boto3_socialmessaging.type_defs import CreateWhatsAppMessageTemplateOutputTypeDef
def get_value() -> CreateWhatsAppMessageTemplateOutputTypeDef:
return {
"metaTemplateId": ...,
}
# CreateWhatsAppMessageTemplateOutputTypeDef definition
class CreateWhatsAppMessageTemplateOutputTypeDef(TypedDict):
metaTemplateId: str,
templateStatus: str,
category: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DeleteWhatsAppMessageMediaOutputTypeDef#
# DeleteWhatsAppMessageMediaOutputTypeDef TypedDict usage example
from mypy_boto3_socialmessaging.type_defs import DeleteWhatsAppMessageMediaOutputTypeDef
def get_value() -> DeleteWhatsAppMessageMediaOutputTypeDef:
return {
"success": ...,
}
# DeleteWhatsAppMessageMediaOutputTypeDef definition
class DeleteWhatsAppMessageMediaOutputTypeDef(TypedDict):
success: bool,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetWhatsAppMessageMediaOutputTypeDef#
# GetWhatsAppMessageMediaOutputTypeDef TypedDict usage example
from mypy_boto3_socialmessaging.type_defs import GetWhatsAppMessageMediaOutputTypeDef
def get_value() -> GetWhatsAppMessageMediaOutputTypeDef:
return {
"mimeType": ...,
}
# GetWhatsAppMessageMediaOutputTypeDef definition
class GetWhatsAppMessageMediaOutputTypeDef(TypedDict):
mimeType: str,
fileSize: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetWhatsAppMessageTemplateOutputTypeDef#
# GetWhatsAppMessageTemplateOutputTypeDef TypedDict usage example
from mypy_boto3_socialmessaging.type_defs import GetWhatsAppMessageTemplateOutputTypeDef
def get_value() -> GetWhatsAppMessageTemplateOutputTypeDef:
return {
"template": ...,
}
# GetWhatsAppMessageTemplateOutputTypeDef definition
class GetWhatsAppMessageTemplateOutputTypeDef(TypedDict):
template: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
PostWhatsAppMessageMediaOutputTypeDef#
# PostWhatsAppMessageMediaOutputTypeDef TypedDict usage example
from mypy_boto3_socialmessaging.type_defs import PostWhatsAppMessageMediaOutputTypeDef
def get_value() -> PostWhatsAppMessageMediaOutputTypeDef:
return {
"mediaId": ...,
}
# PostWhatsAppMessageMediaOutputTypeDef definition
class PostWhatsAppMessageMediaOutputTypeDef(TypedDict):
mediaId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
SendWhatsAppMessageOutputTypeDef#
# SendWhatsAppMessageOutputTypeDef TypedDict usage example
from mypy_boto3_socialmessaging.type_defs import SendWhatsAppMessageOutputTypeDef
def get_value() -> SendWhatsAppMessageOutputTypeDef:
return {
"messageId": ...,
}
# SendWhatsAppMessageOutputTypeDef definition
class SendWhatsAppMessageOutputTypeDef(TypedDict):
messageId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
TagResourceOutputTypeDef#
# TagResourceOutputTypeDef TypedDict usage example
from mypy_boto3_socialmessaging.type_defs import TagResourceOutputTypeDef
def get_value() -> TagResourceOutputTypeDef:
return {
"statusCode": ...,
}
# TagResourceOutputTypeDef definition
class TagResourceOutputTypeDef(TypedDict):
statusCode: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UntagResourceOutputTypeDef#
# UntagResourceOutputTypeDef TypedDict usage example
from mypy_boto3_socialmessaging.type_defs import UntagResourceOutputTypeDef
def get_value() -> UntagResourceOutputTypeDef:
return {
"statusCode": ...,
}
# UntagResourceOutputTypeDef definition
class UntagResourceOutputTypeDef(TypedDict):
statusCode: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateWhatsAppMessageTemplateInputTypeDef#
# CreateWhatsAppMessageTemplateInputTypeDef TypedDict usage example
from mypy_boto3_socialmessaging.type_defs import CreateWhatsAppMessageTemplateInputTypeDef
def get_value() -> CreateWhatsAppMessageTemplateInputTypeDef:
return {
"templateDefinition": ...,
}
# CreateWhatsAppMessageTemplateInputTypeDef definition
class CreateWhatsAppMessageTemplateInputTypeDef(TypedDict):
templateDefinition: BlobTypeDef,
id: str,
SendWhatsAppMessageInputTypeDef#
# SendWhatsAppMessageInputTypeDef TypedDict usage example
from mypy_boto3_socialmessaging.type_defs import SendWhatsAppMessageInputTypeDef
def get_value() -> SendWhatsAppMessageInputTypeDef:
return {
"originationPhoneNumberId": ...,
}
# SendWhatsAppMessageInputTypeDef definition
class SendWhatsAppMessageInputTypeDef(TypedDict):
originationPhoneNumberId: str,
message: BlobTypeDef,
metaApiVersion: str,
UpdateWhatsAppMessageTemplateInputTypeDef#
# UpdateWhatsAppMessageTemplateInputTypeDef TypedDict usage example
from mypy_boto3_socialmessaging.type_defs import UpdateWhatsAppMessageTemplateInputTypeDef
def get_value() -> UpdateWhatsAppMessageTemplateInputTypeDef:
return {
"id": ...,
}
# UpdateWhatsAppMessageTemplateInputTypeDef definition
class UpdateWhatsAppMessageTemplateInputTypeDef(TypedDict):
id: str,
metaTemplateId: str,
templateCategory: NotRequired[str],
templateComponents: NotRequired[BlobTypeDef],
CreateWhatsAppMessageTemplateMediaInputTypeDef#
# CreateWhatsAppMessageTemplateMediaInputTypeDef TypedDict usage example
from mypy_boto3_socialmessaging.type_defs import CreateWhatsAppMessageTemplateMediaInputTypeDef
def get_value() -> CreateWhatsAppMessageTemplateMediaInputTypeDef:
return {
"id": ...,
}
# CreateWhatsAppMessageTemplateMediaInputTypeDef definition
class CreateWhatsAppMessageTemplateMediaInputTypeDef(TypedDict):
id: str,
sourceS3File: NotRequired[S3FileTypeDef], # (1)
- See S3FileTypeDef
GetLinkedWhatsAppBusinessAccountPhoneNumberOutputTypeDef#
# GetLinkedWhatsAppBusinessAccountPhoneNumberOutputTypeDef TypedDict usage example
from mypy_boto3_socialmessaging.type_defs import GetLinkedWhatsAppBusinessAccountPhoneNumberOutputTypeDef
def get_value() -> GetLinkedWhatsAppBusinessAccountPhoneNumberOutputTypeDef:
return {
"phoneNumber": ...,
}
# GetLinkedWhatsAppBusinessAccountPhoneNumberOutputTypeDef definition
class GetLinkedWhatsAppBusinessAccountPhoneNumberOutputTypeDef(TypedDict):
phoneNumber: WhatsAppPhoneNumberDetailTypeDef, # (1)
linkedWhatsAppBusinessAccountId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
LinkedWhatsAppBusinessAccountIdMetaDataTypeDef#
# LinkedWhatsAppBusinessAccountIdMetaDataTypeDef TypedDict usage example
from mypy_boto3_socialmessaging.type_defs import LinkedWhatsAppBusinessAccountIdMetaDataTypeDef
def get_value() -> LinkedWhatsAppBusinessAccountIdMetaDataTypeDef:
return {
"accountName": ...,
}
# LinkedWhatsAppBusinessAccountIdMetaDataTypeDef definition
class LinkedWhatsAppBusinessAccountIdMetaDataTypeDef(TypedDict):
accountName: NotRequired[str],
registrationStatus: NotRequired[RegistrationStatusType], # (1)
unregisteredWhatsAppPhoneNumbers: NotRequired[List[WhatsAppPhoneNumberDetailTypeDef]], # (2)
wabaId: NotRequired[str],
- See RegistrationStatusType
- See
List[WhatsAppPhoneNumberDetailTypeDef]
GetWhatsAppMessageMediaInputTypeDef#
# GetWhatsAppMessageMediaInputTypeDef TypedDict usage example
from mypy_boto3_socialmessaging.type_defs import GetWhatsAppMessageMediaInputTypeDef
def get_value() -> GetWhatsAppMessageMediaInputTypeDef:
return {
"mediaId": ...,
}
# GetWhatsAppMessageMediaInputTypeDef definition
class GetWhatsAppMessageMediaInputTypeDef(TypedDict):
mediaId: str,
originationPhoneNumberId: str,
metadataOnly: NotRequired[bool],
destinationS3PresignedUrl: NotRequired[S3PresignedUrlTypeDef], # (1)
destinationS3File: NotRequired[S3FileTypeDef], # (2)
- See S3PresignedUrlTypeDef
- See S3FileTypeDef
PostWhatsAppMessageMediaInputTypeDef#
# PostWhatsAppMessageMediaInputTypeDef TypedDict usage example
from mypy_boto3_socialmessaging.type_defs import PostWhatsAppMessageMediaInputTypeDef
def get_value() -> PostWhatsAppMessageMediaInputTypeDef:
return {
"originationPhoneNumberId": ...,
}
# PostWhatsAppMessageMediaInputTypeDef definition
class PostWhatsAppMessageMediaInputTypeDef(TypedDict):
originationPhoneNumberId: str,
sourceS3PresignedUrl: NotRequired[S3PresignedUrlTypeDef], # (1)
sourceS3File: NotRequired[S3FileTypeDef], # (2)
- See S3PresignedUrlTypeDef
- See S3FileTypeDef
MetaLibraryTemplateTypeDef#
# MetaLibraryTemplateTypeDef TypedDict usage example
from mypy_boto3_socialmessaging.type_defs import MetaLibraryTemplateTypeDef
def get_value() -> MetaLibraryTemplateTypeDef:
return {
"templateName": ...,
}
# MetaLibraryTemplateTypeDef definition
class MetaLibraryTemplateTypeDef(TypedDict):
templateName: str,
libraryTemplateName: str,
templateCategory: str,
templateLanguage: str,
libraryTemplateButtonInputs: NotRequired[Sequence[LibraryTemplateButtonInputTypeDef]], # (1)
libraryTemplateBodyInputs: NotRequired[LibraryTemplateBodyInputsTypeDef], # (2)
- See
Sequence[LibraryTemplateButtonInputTypeDef]
- See LibraryTemplateBodyInputsTypeDef
MetaLibraryTemplateDefinitionTypeDef#
# MetaLibraryTemplateDefinitionTypeDef TypedDict usage example
from mypy_boto3_socialmessaging.type_defs import MetaLibraryTemplateDefinitionTypeDef
def get_value() -> MetaLibraryTemplateDefinitionTypeDef:
return {
"templateName": ...,
}
# MetaLibraryTemplateDefinitionTypeDef definition
class MetaLibraryTemplateDefinitionTypeDef(TypedDict):
templateName: NotRequired[str],
templateLanguage: NotRequired[str],
templateCategory: NotRequired[str],
templateTopic: NotRequired[str],
templateUseCase: NotRequired[str],
templateIndustry: NotRequired[List[str]],
templateHeader: NotRequired[str],
templateBody: NotRequired[str],
templateButtons: NotRequired[List[LibraryTemplateButtonListTypeDef]], # (1)
templateId: NotRequired[str],
- See
List[LibraryTemplateButtonListTypeDef]
LinkedWhatsAppBusinessAccountSummaryTypeDef#
# LinkedWhatsAppBusinessAccountSummaryTypeDef TypedDict usage example
from mypy_boto3_socialmessaging.type_defs import LinkedWhatsAppBusinessAccountSummaryTypeDef
def get_value() -> LinkedWhatsAppBusinessAccountSummaryTypeDef:
return {
"arn": ...,
}
# LinkedWhatsAppBusinessAccountSummaryTypeDef definition
class LinkedWhatsAppBusinessAccountSummaryTypeDef(TypedDict):
arn: str,
id: str,
wabaId: str,
registrationStatus: RegistrationStatusType, # (1)
linkDate: datetime.datetime,
wabaName: str,
eventDestinations: List[WhatsAppBusinessAccountEventDestinationTypeDef], # (2)
- See RegistrationStatusType
- See
List[WhatsAppBusinessAccountEventDestinationTypeDef]
PutWhatsAppBusinessAccountEventDestinationsInputTypeDef#
# PutWhatsAppBusinessAccountEventDestinationsInputTypeDef TypedDict usage example
from mypy_boto3_socialmessaging.type_defs import PutWhatsAppBusinessAccountEventDestinationsInputTypeDef
def get_value() -> PutWhatsAppBusinessAccountEventDestinationsInputTypeDef:
return {
"id": ...,
}
# PutWhatsAppBusinessAccountEventDestinationsInputTypeDef definition
class PutWhatsAppBusinessAccountEventDestinationsInputTypeDef(TypedDict):
id: str,
eventDestinations: Sequence[WhatsAppBusinessAccountEventDestinationTypeDef], # (1)
- See
Sequence[WhatsAppBusinessAccountEventDestinationTypeDef]
LinkedWhatsAppBusinessAccountTypeDef#
# LinkedWhatsAppBusinessAccountTypeDef TypedDict usage example
from mypy_boto3_socialmessaging.type_defs import LinkedWhatsAppBusinessAccountTypeDef
def get_value() -> LinkedWhatsAppBusinessAccountTypeDef:
return {
"arn": ...,
}
# LinkedWhatsAppBusinessAccountTypeDef definition
class LinkedWhatsAppBusinessAccountTypeDef(TypedDict):
arn: str,
id: str,
wabaId: str,
registrationStatus: RegistrationStatusType, # (1)
linkDate: datetime.datetime,
wabaName: str,
eventDestinations: List[WhatsAppBusinessAccountEventDestinationTypeDef], # (2)
phoneNumbers: List[WhatsAppPhoneNumberSummaryTypeDef], # (3)
- See RegistrationStatusType
- See
List[WhatsAppBusinessAccountEventDestinationTypeDef]
- See
List[WhatsAppPhoneNumberSummaryTypeDef]
ListLinkedWhatsAppBusinessAccountsInputPaginateTypeDef#
# ListLinkedWhatsAppBusinessAccountsInputPaginateTypeDef TypedDict usage example
from mypy_boto3_socialmessaging.type_defs import ListLinkedWhatsAppBusinessAccountsInputPaginateTypeDef
def get_value() -> ListLinkedWhatsAppBusinessAccountsInputPaginateTypeDef:
return {
"PaginationConfig": ...,
}
# ListLinkedWhatsAppBusinessAccountsInputPaginateTypeDef definition
class ListLinkedWhatsAppBusinessAccountsInputPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListWhatsAppMessageTemplatesInputPaginateTypeDef#
# ListWhatsAppMessageTemplatesInputPaginateTypeDef TypedDict usage example
from mypy_boto3_socialmessaging.type_defs import ListWhatsAppMessageTemplatesInputPaginateTypeDef
def get_value() -> ListWhatsAppMessageTemplatesInputPaginateTypeDef:
return {
"id": ...,
}
# ListWhatsAppMessageTemplatesInputPaginateTypeDef definition
class ListWhatsAppMessageTemplatesInputPaginateTypeDef(TypedDict):
id: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListWhatsAppTemplateLibraryInputPaginateTypeDef#
# ListWhatsAppTemplateLibraryInputPaginateTypeDef TypedDict usage example
from mypy_boto3_socialmessaging.type_defs import ListWhatsAppTemplateLibraryInputPaginateTypeDef
def get_value() -> ListWhatsAppTemplateLibraryInputPaginateTypeDef:
return {
"id": ...,
}
# ListWhatsAppTemplateLibraryInputPaginateTypeDef definition
class ListWhatsAppTemplateLibraryInputPaginateTypeDef(TypedDict):
id: str,
filters: NotRequired[Mapping[str, str]],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListTagsForResourceOutputTypeDef#
# ListTagsForResourceOutputTypeDef TypedDict usage example
from mypy_boto3_socialmessaging.type_defs import ListTagsForResourceOutputTypeDef
def get_value() -> ListTagsForResourceOutputTypeDef:
return {
"statusCode": ...,
}
# ListTagsForResourceOutputTypeDef definition
class ListTagsForResourceOutputTypeDef(TypedDict):
statusCode: int,
tags: List[TagTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See
List[TagTypeDef]
- See ResponseMetadataTypeDef
TagResourceInputTypeDef#
# TagResourceInputTypeDef TypedDict usage example
from mypy_boto3_socialmessaging.type_defs import TagResourceInputTypeDef
def get_value() -> TagResourceInputTypeDef:
return {
"resourceArn": ...,
}
# TagResourceInputTypeDef definition
class TagResourceInputTypeDef(TypedDict):
resourceArn: str,
tags: Sequence[TagTypeDef], # (1)
- See
Sequence[TagTypeDef]
WabaPhoneNumberSetupFinalizationTypeDef#
# WabaPhoneNumberSetupFinalizationTypeDef TypedDict usage example
from mypy_boto3_socialmessaging.type_defs import WabaPhoneNumberSetupFinalizationTypeDef
def get_value() -> WabaPhoneNumberSetupFinalizationTypeDef:
return {
"id": ...,
}
# WabaPhoneNumberSetupFinalizationTypeDef definition
class WabaPhoneNumberSetupFinalizationTypeDef(TypedDict):
id: str,
twoFactorPin: str,
dataLocalizationRegion: NotRequired[str],
tags: NotRequired[Sequence[TagTypeDef]], # (1)
- See
Sequence[TagTypeDef]
WabaSetupFinalizationTypeDef#
# WabaSetupFinalizationTypeDef TypedDict usage example
from mypy_boto3_socialmessaging.type_defs import WabaSetupFinalizationTypeDef
def get_value() -> WabaSetupFinalizationTypeDef:
return {
"id": ...,
}
# WabaSetupFinalizationTypeDef definition
class WabaSetupFinalizationTypeDef(TypedDict):
id: NotRequired[str],
eventDestinations: NotRequired[Sequence[WhatsAppBusinessAccountEventDestinationTypeDef]], # (1)
tags: NotRequired[Sequence[TagTypeDef]], # (2)
- See
Sequence[WhatsAppBusinessAccountEventDestinationTypeDef]
- See
Sequence[TagTypeDef]
ListWhatsAppMessageTemplatesOutputTypeDef#
# ListWhatsAppMessageTemplatesOutputTypeDef TypedDict usage example
from mypy_boto3_socialmessaging.type_defs import ListWhatsAppMessageTemplatesOutputTypeDef
def get_value() -> ListWhatsAppMessageTemplatesOutputTypeDef:
return {
"templates": ...,
}
# ListWhatsAppMessageTemplatesOutputTypeDef definition
class ListWhatsAppMessageTemplatesOutputTypeDef(TypedDict):
templates: List[TemplateSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],
- See
List[TemplateSummaryTypeDef]
- See ResponseMetadataTypeDef
WhatsAppSignupCallbackResultTypeDef#
# WhatsAppSignupCallbackResultTypeDef TypedDict usage example
from mypy_boto3_socialmessaging.type_defs import WhatsAppSignupCallbackResultTypeDef
def get_value() -> WhatsAppSignupCallbackResultTypeDef:
return {
"associateInProgressToken": ...,
}
# WhatsAppSignupCallbackResultTypeDef definition
class WhatsAppSignupCallbackResultTypeDef(TypedDict):
associateInProgressToken: NotRequired[str],
linkedAccountsWithIncompleteSetup: NotRequired[Dict[str, LinkedWhatsAppBusinessAccountIdMetaDataTypeDef]], # (1)
- See
Dict[str, LinkedWhatsAppBusinessAccountIdMetaDataTypeDef]
CreateWhatsAppMessageTemplateFromLibraryInputTypeDef#
# CreateWhatsAppMessageTemplateFromLibraryInputTypeDef TypedDict usage example
from mypy_boto3_socialmessaging.type_defs import CreateWhatsAppMessageTemplateFromLibraryInputTypeDef
def get_value() -> CreateWhatsAppMessageTemplateFromLibraryInputTypeDef:
return {
"metaLibraryTemplate": ...,
}
# CreateWhatsAppMessageTemplateFromLibraryInputTypeDef definition
class CreateWhatsAppMessageTemplateFromLibraryInputTypeDef(TypedDict):
metaLibraryTemplate: MetaLibraryTemplateTypeDef, # (1)
id: str,
ListWhatsAppTemplateLibraryOutputTypeDef#
# ListWhatsAppTemplateLibraryOutputTypeDef TypedDict usage example
from mypy_boto3_socialmessaging.type_defs import ListWhatsAppTemplateLibraryOutputTypeDef
def get_value() -> ListWhatsAppTemplateLibraryOutputTypeDef:
return {
"metaLibraryTemplates": ...,
}
# ListWhatsAppTemplateLibraryOutputTypeDef definition
class ListWhatsAppTemplateLibraryOutputTypeDef(TypedDict):
metaLibraryTemplates: List[MetaLibraryTemplateDefinitionTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],
- See
List[MetaLibraryTemplateDefinitionTypeDef]
- See ResponseMetadataTypeDef
ListLinkedWhatsAppBusinessAccountsOutputTypeDef#
# ListLinkedWhatsAppBusinessAccountsOutputTypeDef TypedDict usage example
from mypy_boto3_socialmessaging.type_defs import ListLinkedWhatsAppBusinessAccountsOutputTypeDef
def get_value() -> ListLinkedWhatsAppBusinessAccountsOutputTypeDef:
return {
"linkedAccounts": ...,
}
# ListLinkedWhatsAppBusinessAccountsOutputTypeDef definition
class ListLinkedWhatsAppBusinessAccountsOutputTypeDef(TypedDict):
linkedAccounts: List[LinkedWhatsAppBusinessAccountSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],
- See
List[LinkedWhatsAppBusinessAccountSummaryTypeDef]
- See ResponseMetadataTypeDef
GetLinkedWhatsAppBusinessAccountOutputTypeDef#
# GetLinkedWhatsAppBusinessAccountOutputTypeDef TypedDict usage example
from mypy_boto3_socialmessaging.type_defs import GetLinkedWhatsAppBusinessAccountOutputTypeDef
def get_value() -> GetLinkedWhatsAppBusinessAccountOutputTypeDef:
return {
"account": ...,
}
# GetLinkedWhatsAppBusinessAccountOutputTypeDef definition
class GetLinkedWhatsAppBusinessAccountOutputTypeDef(TypedDict):
account: LinkedWhatsAppBusinessAccountTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
WhatsAppSetupFinalizationTypeDef#
# WhatsAppSetupFinalizationTypeDef TypedDict usage example
from mypy_boto3_socialmessaging.type_defs import WhatsAppSetupFinalizationTypeDef
def get_value() -> WhatsAppSetupFinalizationTypeDef:
return {
"associateInProgressToken": ...,
}
# WhatsAppSetupFinalizationTypeDef definition
class WhatsAppSetupFinalizationTypeDef(TypedDict):
associateInProgressToken: str,
phoneNumbers: Sequence[WabaPhoneNumberSetupFinalizationTypeDef], # (1)
phoneNumberParent: NotRequired[str],
waba: NotRequired[WabaSetupFinalizationTypeDef], # (2)
- See
Sequence[WabaPhoneNumberSetupFinalizationTypeDef]
- See WabaSetupFinalizationTypeDef
AssociateWhatsAppBusinessAccountOutputTypeDef#
# AssociateWhatsAppBusinessAccountOutputTypeDef TypedDict usage example
from mypy_boto3_socialmessaging.type_defs import AssociateWhatsAppBusinessAccountOutputTypeDef
def get_value() -> AssociateWhatsAppBusinessAccountOutputTypeDef:
return {
"signupCallbackResult": ...,
}
# AssociateWhatsAppBusinessAccountOutputTypeDef definition
class AssociateWhatsAppBusinessAccountOutputTypeDef(TypedDict):
signupCallbackResult: WhatsAppSignupCallbackResultTypeDef, # (1)
statusCode: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
AssociateWhatsAppBusinessAccountInputTypeDef#
# AssociateWhatsAppBusinessAccountInputTypeDef TypedDict usage example
from mypy_boto3_socialmessaging.type_defs import AssociateWhatsAppBusinessAccountInputTypeDef
def get_value() -> AssociateWhatsAppBusinessAccountInputTypeDef:
return {
"signupCallback": ...,
}
# AssociateWhatsAppBusinessAccountInputTypeDef definition
class AssociateWhatsAppBusinessAccountInputTypeDef(TypedDict):
signupCallback: NotRequired[WhatsAppSignupCallbackTypeDef], # (1)
setupFinalization: NotRequired[WhatsAppSetupFinalizationTypeDef], # (2)