EndUserMessagingSocialClient

Index > EndUserMessagingSocial > EndUserMessagingSocialClient

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

EndUserMessagingSocialClient

Type annotations and code completion for boto3.client("socialmessaging"). boto3 documentation

# EndUserMessagingSocialClient usage example

from boto3.session import Session
from mypy_boto3_socialmessaging.client import EndUserMessagingSocialClient

def get_socialmessaging_client() -> EndUserMessagingSocialClient:
    return Session().client("socialmessaging")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("socialmessaging").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("socialmessaging")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedByMetaException,
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.DependencyException,
    client.exceptions.InternalServiceException,
    client.exceptions.InvalidParametersException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ThrottledRequestException,
    client.exceptions.ValidationException,
) as e:
    print(e)

# Exceptions.exceptions type checking example

from mypy_boto3_socialmessaging.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedByMetaException) -> None:
    ...

Methods

associate_whatsapp_business_account

This is only used through the Amazon Web Services console during sign-up to associate your WhatsApp Business Account to your Amazon Web Services account.

Type annotations and code completion for boto3.client("socialmessaging").associate_whatsapp_business_account method. boto3 documentation

# associate_whatsapp_business_account method definition

def associate_whatsapp_business_account(
    self,
    *,
    signupCallback: WhatsAppSignupCallbackTypeDef = ...,  # (1)
    setupFinalization: WhatsAppSetupFinalizationTypeDef = ...,  # (2)
) -> AssociateWhatsAppBusinessAccountOutputTypeDef:  # (3)
    ...

1. See WhatsAppSignupCallbackTypeDef
2. See WhatsAppSetupFinalizationTypeDef
3. See AssociateWhatsAppBusinessAccountOutputTypeDef

# associate_whatsapp_business_account method usage example with argument unpacking

kwargs: AssociateWhatsAppBusinessAccountInputRequestTypeDef = {  # (1)
    "signupCallback": ...,
}

parent.associate_whatsapp_business_account(**kwargs)

1. See AssociateWhatsAppBusinessAccountInputRequestTypeDef

can_paginate

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("socialmessaging").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("socialmessaging").close method. boto3 documentation

# close method definition

def close(
    self,
) -> None:
    ...

delete_whatsapp_media_message

Delete a media object from the WhatsApp service.

Type annotations and code completion for boto3.client("socialmessaging").delete_whatsapp_media_message method. boto3 documentation

# delete_whatsapp_media_message method definition

def delete_whatsapp_media_message(
    self,
    *,
    mediaId: str,
    originationPhoneNumberId: str,
) -> DeleteWhatsAppMessageMediaOutputTypeDef:  # (1)
    ...

1. See DeleteWhatsAppMessageMediaOutputTypeDef

# delete_whatsapp_media_message method usage example with argument unpacking

kwargs: DeleteWhatsAppMessageMediaInputRequestTypeDef = {  # (1)
    "mediaId": ...,
    "originationPhoneNumberId": ...,
}

parent.delete_whatsapp_media_message(**kwargs)

1. See DeleteWhatsAppMessageMediaInputRequestTypeDef

disassociate_whatsapp_business_account

Disassociate a WhatsApp Business Account (WABA) from your Amazon Web Services account.

Type annotations and code completion for boto3.client("socialmessaging").disassociate_whatsapp_business_account method. boto3 documentation

# disassociate_whatsapp_business_account method definition

def disassociate_whatsapp_business_account(
    self,
    *,
    id: str,
) -> Dict[str, Any]:
    ...

# disassociate_whatsapp_business_account method usage example with argument unpacking

kwargs: DisassociateWhatsAppBusinessAccountInputRequestTypeDef = {  # (1)
    "id": ...,
}

parent.disassociate_whatsapp_business_account(**kwargs)

1. See DisassociateWhatsAppBusinessAccountInputRequestTypeDef

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("socialmessaging").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

get_linked_whatsapp_business_account

Get the details of your linked WhatsApp Business Account.

Type annotations and code completion for boto3.client("socialmessaging").get_linked_whatsapp_business_account method. boto3 documentation

# get_linked_whatsapp_business_account method definition

def get_linked_whatsapp_business_account(
    self,
    *,
    id: str,
) -> GetLinkedWhatsAppBusinessAccountOutputTypeDef:  # (1)
    ...

1. See GetLinkedWhatsAppBusinessAccountOutputTypeDef

# get_linked_whatsapp_business_account method usage example with argument unpacking

kwargs: GetLinkedWhatsAppBusinessAccountInputRequestTypeDef = {  # (1)
    "id": ...,
}

parent.get_linked_whatsapp_business_account(**kwargs)

1. See GetLinkedWhatsAppBusinessAccountInputRequestTypeDef

get_linked_whatsapp_business_account_phone_number

Use your WhatsApp phone number id to get the WABA account id and phone number details.

Type annotations and code completion for boto3.client("socialmessaging").get_linked_whatsapp_business_account_phone_number method. boto3 documentation

# get_linked_whatsapp_business_account_phone_number method definition

def get_linked_whatsapp_business_account_phone_number(
    self,
    *,
    id: str,
) -> GetLinkedWhatsAppBusinessAccountPhoneNumberOutputTypeDef:  # (1)
    ...

1. See GetLinkedWhatsAppBusinessAccountPhoneNumberOutputTypeDef

# get_linked_whatsapp_business_account_phone_number method usage example with argument unpacking

kwargs: GetLinkedWhatsAppBusinessAccountPhoneNumberInputRequestTypeDef = {  # (1)
    "id": ...,
}

parent.get_linked_whatsapp_business_account_phone_number(**kwargs)

1. See GetLinkedWhatsAppBusinessAccountPhoneNumberInputRequestTypeDef

get_whatsapp_message_media

Get a media file from the WhatsApp service.

Type annotations and code completion for boto3.client("socialmessaging").get_whatsapp_message_media method. boto3 documentation

# get_whatsapp_message_media method definition

def get_whatsapp_message_media(
    self,
    *,
    mediaId: str,
    originationPhoneNumberId: str,
    metadataOnly: bool = ...,
    destinationS3PresignedUrl: S3PresignedUrlTypeDef = ...,  # (1)
    destinationS3File: S3FileTypeDef = ...,  # (2)
) -> GetWhatsAppMessageMediaOutputTypeDef:  # (3)
    ...

1. See S3PresignedUrlTypeDef
2. See S3FileTypeDef
3. See GetWhatsAppMessageMediaOutputTypeDef

# get_whatsapp_message_media method usage example with argument unpacking

kwargs: GetWhatsAppMessageMediaInputRequestTypeDef = {  # (1)
    "mediaId": ...,
    "originationPhoneNumberId": ...,
}

parent.get_whatsapp_message_media(**kwargs)

1. See GetWhatsAppMessageMediaInputRequestTypeDef

list_linked_whatsapp_business_accounts

List all WhatsApp Business Accounts linked to your Amazon Web Services account.

Type annotations and code completion for boto3.client("socialmessaging").list_linked_whatsapp_business_accounts method. boto3 documentation

# list_linked_whatsapp_business_accounts method definition

def list_linked_whatsapp_business_accounts(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListLinkedWhatsAppBusinessAccountsOutputTypeDef:  # (1)
    ...

1. See ListLinkedWhatsAppBusinessAccountsOutputTypeDef

# list_linked_whatsapp_business_accounts method usage example with argument unpacking

kwargs: ListLinkedWhatsAppBusinessAccountsInputRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_linked_whatsapp_business_accounts(**kwargs)

1. See ListLinkedWhatsAppBusinessAccountsInputRequestTypeDef

list_tags_for_resource

List all tags associated with a resource, such as a phone number or WABA.

Type annotations and code completion for boto3.client("socialmessaging").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceOutputTypeDef:  # (1)
    ...

1. See ListTagsForResourceOutputTypeDef

# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceInputRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceInputRequestTypeDef

post_whatsapp_message_media

Upload a media file to the WhatsApp service.

Type annotations and code completion for boto3.client("socialmessaging").post_whatsapp_message_media method. boto3 documentation

# post_whatsapp_message_media method definition

def post_whatsapp_message_media(
    self,
    *,
    originationPhoneNumberId: str,
    sourceS3PresignedUrl: S3PresignedUrlTypeDef = ...,  # (1)
    sourceS3File: S3FileTypeDef = ...,  # (2)
) -> PostWhatsAppMessageMediaOutputTypeDef:  # (3)
    ...

1. See S3PresignedUrlTypeDef
2. See S3FileTypeDef
3. See PostWhatsAppMessageMediaOutputTypeDef

# post_whatsapp_message_media method usage example with argument unpacking

kwargs: PostWhatsAppMessageMediaInputRequestTypeDef = {  # (1)
    "originationPhoneNumberId": ...,
}

parent.post_whatsapp_message_media(**kwargs)

1. See PostWhatsAppMessageMediaInputRequestTypeDef

put_whatsapp_business_account_event_destinations

Add an event destination to log event data from WhatsApp for a WhatsApp Business Account (WABA).

Type annotations and code completion for boto3.client("socialmessaging").put_whatsapp_business_account_event_destinations method. boto3 documentation

# put_whatsapp_business_account_event_destinations method definition

def put_whatsapp_business_account_event_destinations(
    self,
    *,
    id: str,
    eventDestinations: Sequence[WhatsAppBusinessAccountEventDestinationTypeDef],  # (1)
) -> Dict[str, Any]:
    ...

1. See WhatsAppBusinessAccountEventDestinationTypeDef

# put_whatsapp_business_account_event_destinations method usage example with argument unpacking

kwargs: PutWhatsAppBusinessAccountEventDestinationsInputRequestTypeDef = {  # (1)
    "id": ...,
    "eventDestinations": ...,
}

parent.put_whatsapp_business_account_event_destinations(**kwargs)

1. See PutWhatsAppBusinessAccountEventDestinationsInputRequestTypeDef

send_whatsapp_message

Send a WhatsApp message.

Type annotations and code completion for boto3.client("socialmessaging").send_whatsapp_message method. boto3 documentation

# send_whatsapp_message method definition

def send_whatsapp_message(
    self,
    *,
    originationPhoneNumberId: str,
    message: BlobTypeDef,
    metaApiVersion: str,
) -> SendWhatsAppMessageOutputTypeDef:  # (1)
    ...

1. See SendWhatsAppMessageOutputTypeDef

# send_whatsapp_message method usage example with argument unpacking

kwargs: SendWhatsAppMessageInputRequestTypeDef = {  # (1)
    "originationPhoneNumberId": ...,
    "message": ...,
    "metaApiVersion": ...,
}

parent.send_whatsapp_message(**kwargs)

1. See SendWhatsAppMessageInputRequestTypeDef

tag_resource

Adds or overwrites only the specified tags for the specified resource.

Type annotations and code completion for boto3.client("socialmessaging").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Sequence[TagTypeDef],  # (1)
) -> TagResourceOutputTypeDef:  # (2)
    ...

1. See TagTypeDef
2. See TagResourceOutputTypeDef

# tag_resource method usage example with argument unpacking

kwargs: TagResourceInputRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceInputRequestTypeDef

untag_resource

Removes the specified tags from a resource.

Type annotations and code completion for boto3.client("socialmessaging").untag_resource method. boto3 documentation

# untag_resource method definition

def untag_resource(
    self,
    *,
    resourceArn: str,
    tagKeys: Sequence[str],
) -> UntagResourceOutputTypeDef:  # (1)
    ...

1. See UntagResourceOutputTypeDef

# untag_resource method usage example with argument unpacking

kwargs: UntagResourceInputRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceInputRequestTypeDef

get_paginator

Type annotations and code completion for boto3.client("socialmessaging").get_paginator method with overloads.

• client.get_paginator("list_linked_whatsapp_business_accounts") -> ListLinkedWhatsAppBusinessAccountsPaginator