Skip to content

Type definitions#

Index > EndUserMessagingSocial > Type definitions

Auto-generated documentation for EndUserMessagingSocial type annotations stubs module mypy-boto3-socialmessaging.

BlobTypeDef#

# BlobTypeDef definition

BlobTypeDef = Union[
    str,
    bytes,
    IO[Any],
    StreamingBody,
]

WhatsAppSignupCallbackTypeDef#

# WhatsAppSignupCallbackTypeDef definition

class WhatsAppSignupCallbackTypeDef(TypedDict):
    accessToken: str,

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

DeleteWhatsAppMessageMediaInputRequestTypeDef#

# DeleteWhatsAppMessageMediaInputRequestTypeDef definition

class DeleteWhatsAppMessageMediaInputRequestTypeDef(TypedDict):
    mediaId: str,
    originationPhoneNumberId: str,

DisassociateWhatsAppBusinessAccountInputRequestTypeDef#

# DisassociateWhatsAppBusinessAccountInputRequestTypeDef definition

class DisassociateWhatsAppBusinessAccountInputRequestTypeDef(TypedDict):
    id: str,

GetLinkedWhatsAppBusinessAccountInputRequestTypeDef#

# GetLinkedWhatsAppBusinessAccountInputRequestTypeDef definition

class GetLinkedWhatsAppBusinessAccountInputRequestTypeDef(TypedDict):
    id: str,

GetLinkedWhatsAppBusinessAccountPhoneNumberInputRequestTypeDef#

# GetLinkedWhatsAppBusinessAccountPhoneNumberInputRequestTypeDef definition

class GetLinkedWhatsAppBusinessAccountPhoneNumberInputRequestTypeDef(TypedDict):
    id: str,

WhatsAppPhoneNumberDetailTypeDef#

# WhatsAppPhoneNumberDetailTypeDef definition

class WhatsAppPhoneNumberDetailTypeDef(TypedDict):
    arn: str,
    phoneNumber: str,
    phoneNumberId: str,
    metaPhoneNumberId: str,
    displayPhoneNumberName: str,
    displayPhoneNumber: str,
    qualityRating: str,

S3FileTypeDef#

# S3FileTypeDef definition

class S3FileTypeDef(TypedDict):
    bucketName: str,
    key: str,

S3PresignedUrlTypeDef#

# S3PresignedUrlTypeDef definition

class S3PresignedUrlTypeDef(TypedDict):
    url: str,
    headers: Mapping[str, str],

WhatsAppBusinessAccountEventDestinationTypeDef#

# WhatsAppBusinessAccountEventDestinationTypeDef definition

class WhatsAppBusinessAccountEventDestinationTypeDef(TypedDict):
    eventDestinationArn: str,
    roleArn: NotRequired[str],

WhatsAppPhoneNumberSummaryTypeDef#

# WhatsAppPhoneNumberSummaryTypeDef definition

class WhatsAppPhoneNumberSummaryTypeDef(TypedDict):
    arn: str,
    phoneNumber: str,
    phoneNumberId: str,
    metaPhoneNumberId: str,
    displayPhoneNumberName: str,
    displayPhoneNumber: str,
    qualityRating: str,

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ListLinkedWhatsAppBusinessAccountsInputRequestTypeDef#

# ListLinkedWhatsAppBusinessAccountsInputRequestTypeDef definition

class ListLinkedWhatsAppBusinessAccountsInputRequestTypeDef(TypedDict):
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ListTagsForResourceInputRequestTypeDef#

# ListTagsForResourceInputRequestTypeDef definition

class ListTagsForResourceInputRequestTypeDef(TypedDict):
    resourceArn: str,

TagTypeDef#

# TagTypeDef definition

class TagTypeDef(TypedDict):
    key: str,
    value: NotRequired[str],

UntagResourceInputRequestTypeDef#

# UntagResourceInputRequestTypeDef definition

class UntagResourceInputRequestTypeDef(TypedDict):
    resourceArn: str,
    tagKeys: Sequence[str],

DeleteWhatsAppMessageMediaOutputTypeDef#

# DeleteWhatsAppMessageMediaOutputTypeDef definition

class DeleteWhatsAppMessageMediaOutputTypeDef(TypedDict):
    success: bool,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetWhatsAppMessageMediaOutputTypeDef#

# GetWhatsAppMessageMediaOutputTypeDef definition

class GetWhatsAppMessageMediaOutputTypeDef(TypedDict):
    mimeType: str,
    fileSize: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

PostWhatsAppMessageMediaOutputTypeDef#

# PostWhatsAppMessageMediaOutputTypeDef definition

class PostWhatsAppMessageMediaOutputTypeDef(TypedDict):
    mediaId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

SendWhatsAppMessageOutputTypeDef#

# SendWhatsAppMessageOutputTypeDef definition

class SendWhatsAppMessageOutputTypeDef(TypedDict):
    messageId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

TagResourceOutputTypeDef#

# TagResourceOutputTypeDef definition

class TagResourceOutputTypeDef(TypedDict):
    statusCode: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UntagResourceOutputTypeDef#

# UntagResourceOutputTypeDef definition

class UntagResourceOutputTypeDef(TypedDict):
    statusCode: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

SendWhatsAppMessageInputRequestTypeDef#

# SendWhatsAppMessageInputRequestTypeDef definition

class SendWhatsAppMessageInputRequestTypeDef(TypedDict):
    originationPhoneNumberId: str,
    message: BlobTypeDef,
    metaApiVersion: str,

GetLinkedWhatsAppBusinessAccountPhoneNumberOutputTypeDef#

# GetLinkedWhatsAppBusinessAccountPhoneNumberOutputTypeDef definition

class GetLinkedWhatsAppBusinessAccountPhoneNumberOutputTypeDef(TypedDict):
    phoneNumber: WhatsAppPhoneNumberDetailTypeDef,  # (1)
    linkedWhatsAppBusinessAccountId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See WhatsAppPhoneNumberDetailTypeDef
  2. See ResponseMetadataTypeDef

LinkedWhatsAppBusinessAccountIdMetaDataTypeDef#

# LinkedWhatsAppBusinessAccountIdMetaDataTypeDef definition

class LinkedWhatsAppBusinessAccountIdMetaDataTypeDef(TypedDict):
    accountName: NotRequired[str],
    registrationStatus: NotRequired[RegistrationStatusType],  # (1)
    unregisteredWhatsAppPhoneNumbers: NotRequired[list[WhatsAppPhoneNumberDetailTypeDef]],  # (2)
    wabaId: NotRequired[str],
  1. See RegistrationStatusType
  2. See WhatsAppPhoneNumberDetailTypeDef

GetWhatsAppMessageMediaInputRequestTypeDef#

# GetWhatsAppMessageMediaInputRequestTypeDef definition

class GetWhatsAppMessageMediaInputRequestTypeDef(TypedDict):
    mediaId: str,
    originationPhoneNumberId: str,
    metadataOnly: NotRequired[bool],
    destinationS3PresignedUrl: NotRequired[S3PresignedUrlTypeDef],  # (1)
    destinationS3File: NotRequired[S3FileTypeDef],  # (2)
  1. See S3PresignedUrlTypeDef
  2. See S3FileTypeDef

PostWhatsAppMessageMediaInputRequestTypeDef#

# PostWhatsAppMessageMediaInputRequestTypeDef definition

class PostWhatsAppMessageMediaInputRequestTypeDef(TypedDict):
    originationPhoneNumberId: str,
    sourceS3PresignedUrl: NotRequired[S3PresignedUrlTypeDef],  # (1)
    sourceS3File: NotRequired[S3FileTypeDef],  # (2)
  1. See S3PresignedUrlTypeDef
  2. See S3FileTypeDef

LinkedWhatsAppBusinessAccountSummaryTypeDef#

# LinkedWhatsAppBusinessAccountSummaryTypeDef definition

class LinkedWhatsAppBusinessAccountSummaryTypeDef(TypedDict):
    arn: str,
    id: str,
    wabaId: str,
    registrationStatus: RegistrationStatusType,  # (1)
    linkDate: datetime,
    wabaName: str,
    eventDestinations: list[WhatsAppBusinessAccountEventDestinationTypeDef],  # (2)
  1. See RegistrationStatusType
  2. See WhatsAppBusinessAccountEventDestinationTypeDef

PutWhatsAppBusinessAccountEventDestinationsInputRequestTypeDef#

# PutWhatsAppBusinessAccountEventDestinationsInputRequestTypeDef definition

class PutWhatsAppBusinessAccountEventDestinationsInputRequestTypeDef(TypedDict):
    id: str,
    eventDestinations: Sequence[WhatsAppBusinessAccountEventDestinationTypeDef],  # (1)
  1. See WhatsAppBusinessAccountEventDestinationTypeDef

LinkedWhatsAppBusinessAccountTypeDef#

# LinkedWhatsAppBusinessAccountTypeDef definition

class LinkedWhatsAppBusinessAccountTypeDef(TypedDict):
    arn: str,
    id: str,
    wabaId: str,
    registrationStatus: RegistrationStatusType,  # (1)
    linkDate: datetime,
    wabaName: str,
    eventDestinations: list[WhatsAppBusinessAccountEventDestinationTypeDef],  # (2)
    phoneNumbers: list[WhatsAppPhoneNumberSummaryTypeDef],  # (3)
  1. See RegistrationStatusType
  2. See WhatsAppBusinessAccountEventDestinationTypeDef
  3. See WhatsAppPhoneNumberSummaryTypeDef

ListLinkedWhatsAppBusinessAccountsInputPaginateTypeDef#

# ListLinkedWhatsAppBusinessAccountsInputPaginateTypeDef definition

class ListLinkedWhatsAppBusinessAccountsInputPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListTagsForResourceOutputTypeDef#

# ListTagsForResourceOutputTypeDef definition

class ListTagsForResourceOutputTypeDef(TypedDict):
    statusCode: int,
    tags: list[TagTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TagTypeDef
  2. See ResponseMetadataTypeDef

TagResourceInputRequestTypeDef#

# TagResourceInputRequestTypeDef definition

class TagResourceInputRequestTypeDef(TypedDict):
    resourceArn: str,
    tags: Sequence[TagTypeDef],  # (1)
  1. See TagTypeDef

WabaPhoneNumberSetupFinalizationTypeDef#

# WabaPhoneNumberSetupFinalizationTypeDef definition

class WabaPhoneNumberSetupFinalizationTypeDef(TypedDict):
    id: str,
    twoFactorPin: str,
    dataLocalizationRegion: NotRequired[str],
    tags: NotRequired[Sequence[TagTypeDef]],  # (1)
  1. See TagTypeDef

WabaSetupFinalizationTypeDef#

# WabaSetupFinalizationTypeDef definition

class WabaSetupFinalizationTypeDef(TypedDict):
    id: NotRequired[str],
    eventDestinations: NotRequired[Sequence[WhatsAppBusinessAccountEventDestinationTypeDef]],  # (1)
    tags: NotRequired[Sequence[TagTypeDef]],  # (2)
  1. See WhatsAppBusinessAccountEventDestinationTypeDef
  2. See TagTypeDef

WhatsAppSignupCallbackResultTypeDef#

# WhatsAppSignupCallbackResultTypeDef definition

class WhatsAppSignupCallbackResultTypeDef(TypedDict):
    associateInProgressToken: NotRequired[str],
    linkedAccountsWithIncompleteSetup: NotRequired[dict[str, LinkedWhatsAppBusinessAccountIdMetaDataTypeDef]],  # (1)
  1. See LinkedWhatsAppBusinessAccountIdMetaDataTypeDef

ListLinkedWhatsAppBusinessAccountsOutputTypeDef#

# ListLinkedWhatsAppBusinessAccountsOutputTypeDef definition

class ListLinkedWhatsAppBusinessAccountsOutputTypeDef(TypedDict):
    linkedAccounts: list[LinkedWhatsAppBusinessAccountSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See LinkedWhatsAppBusinessAccountSummaryTypeDef
  2. See ResponseMetadataTypeDef

GetLinkedWhatsAppBusinessAccountOutputTypeDef#

# GetLinkedWhatsAppBusinessAccountOutputTypeDef definition

class GetLinkedWhatsAppBusinessAccountOutputTypeDef(TypedDict):
    account: LinkedWhatsAppBusinessAccountTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See LinkedWhatsAppBusinessAccountTypeDef
  2. See ResponseMetadataTypeDef

WhatsAppSetupFinalizationTypeDef#

# WhatsAppSetupFinalizationTypeDef definition

class WhatsAppSetupFinalizationTypeDef(TypedDict):
    associateInProgressToken: str,
    phoneNumbers: Sequence[WabaPhoneNumberSetupFinalizationTypeDef],  # (1)
    phoneNumberParent: NotRequired[str],
    waba: NotRequired[WabaSetupFinalizationTypeDef],  # (2)
  1. See WabaPhoneNumberSetupFinalizationTypeDef
  2. See WabaSetupFinalizationTypeDef

AssociateWhatsAppBusinessAccountOutputTypeDef#

# AssociateWhatsAppBusinessAccountOutputTypeDef definition

class AssociateWhatsAppBusinessAccountOutputTypeDef(TypedDict):
    signupCallbackResult: WhatsAppSignupCallbackResultTypeDef,  # (1)
    statusCode: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See WhatsAppSignupCallbackResultTypeDef
  2. See ResponseMetadataTypeDef

AssociateWhatsAppBusinessAccountInputRequestTypeDef#

# AssociateWhatsAppBusinessAccountInputRequestTypeDef definition

class AssociateWhatsAppBusinessAccountInputRequestTypeDef(TypedDict):
    signupCallback: NotRequired[WhatsAppSignupCallbackTypeDef],  # (1)
    setupFinalization: NotRequired[WhatsAppSetupFinalizationTypeDef],  # (2)
  1. See WhatsAppSignupCallbackTypeDef
  2. See WhatsAppSetupFinalizationTypeDef