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.
" }, "DeleteWhatsAppMessageMedia":{ "name":"DeleteWhatsAppMessageMedia", "http":{ "method":"DELETE", "requestUri":"/v1/whatsapp/media", "responseCode":200 }, "input":{"shape":"DeleteWhatsAppMessageMediaInput"}, "output":{"shape":"DeleteWhatsAppMessageMediaOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParametersException"}, {"shape":"ThrottledRequestException"}, {"shape":"AccessDeniedByMetaException"}, {"shape":"InternalServiceException"}, {"shape":"DependencyException"} ], "documentation":"Delete a media object from the WhatsApp service. If the object is still in an Amazon S3 bucket you should delete it from there too.
", "idempotent":true }, "DisassociateWhatsAppBusinessAccount":{ "name":"DisassociateWhatsAppBusinessAccount", "http":{ "method":"DELETE", "requestUri":"/v1/whatsapp/waba/disassociate", "responseCode":200 }, "input":{"shape":"DisassociateWhatsAppBusinessAccountInput"}, "output":{"shape":"DisassociateWhatsAppBusinessAccountOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParametersException"}, {"shape":"ThrottledRequestException"}, {"shape":"DependencyException"} ], "documentation":"Disassociate a WhatsApp Business Account (WABA) from your Amazon Web Services account.
", "idempotent":true }, "GetLinkedWhatsAppBusinessAccount":{ "name":"GetLinkedWhatsAppBusinessAccount", "http":{ "method":"GET", "requestUri":"/v1/whatsapp/waba/details", "responseCode":200 }, "input":{"shape":"GetLinkedWhatsAppBusinessAccountInput"}, "output":{"shape":"GetLinkedWhatsAppBusinessAccountOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParametersException"}, {"shape":"ThrottledRequestException"}, {"shape":"InternalServiceException"}, {"shape":"DependencyException"} ], "documentation":"Get the details of your linked WhatsApp Business Account.
" }, "GetLinkedWhatsAppBusinessAccountPhoneNumber":{ "name":"GetLinkedWhatsAppBusinessAccountPhoneNumber", "http":{ "method":"GET", "requestUri":"/v1/whatsapp/waba/phone/details", "responseCode":200 }, "input":{"shape":"GetLinkedWhatsAppBusinessAccountPhoneNumberInput"}, "output":{"shape":"GetLinkedWhatsAppBusinessAccountPhoneNumberOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParametersException"}, {"shape":"ThrottledRequestException"}, {"shape":"InternalServiceException"}, {"shape":"DependencyException"} ], "documentation":"Use your WhatsApp phone number id to get the WABA account id and phone number details.
" }, "GetWhatsAppMessageMedia":{ "name":"GetWhatsAppMessageMedia", "http":{ "method":"POST", "requestUri":"/v1/whatsapp/media/get", "responseCode":200 }, "input":{"shape":"GetWhatsAppMessageMediaInput"}, "output":{"shape":"GetWhatsAppMessageMediaOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParametersException"}, {"shape":"ThrottledRequestException"}, {"shape":"AccessDeniedByMetaException"}, {"shape":"InternalServiceException"}, {"shape":"DependencyException"} ], "documentation":"Get a media file from the WhatsApp service. On successful completion the media file is retrieved from Meta and stored in the specified Amazon S3 bucket. Use either destinationS3File or destinationS3PresignedUrl for the destination. If both are used then an InvalidParameterException is returned.
List all WhatsApp Business Accounts linked to your Amazon Web Services account.
" }, "ListTagsForResource":{ "name":"ListTagsForResource", "http":{ "method":"GET", "requestUri":"/v1/tags/list", "responseCode":200 }, "input":{"shape":"ListTagsForResourceInput"}, "output":{"shape":"ListTagsForResourceOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InvalidParametersException"}, {"shape":"ThrottledRequestException"}, {"shape":"InternalServiceException"} ], "documentation":"List all tags associated with a resource, such as a phone number or WABA.
" }, "PostWhatsAppMessageMedia":{ "name":"PostWhatsAppMessageMedia", "http":{ "method":"POST", "requestUri":"/v1/whatsapp/media", "responseCode":200 }, "input":{"shape":"PostWhatsAppMessageMediaInput"}, "output":{"shape":"PostWhatsAppMessageMediaOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParametersException"}, {"shape":"ThrottledRequestException"}, {"shape":"AccessDeniedByMetaException"}, {"shape":"InternalServiceException"}, {"shape":"DependencyException"} ], "documentation":"Upload a media file to the WhatsApp service. Only the specified originationPhoneNumberId has the permissions to send the media file when using SendWhatsAppMessage. You must use either sourceS3File or sourceS3PresignedUrl for the source. If both or neither are specified then an InvalidParameterException is returned.
Add an event destination to log event data from WhatsApp for a WhatsApp Business Account (WABA). A WABA can only have one event destination at a time. All resources associated with the WABA use the same event destination.
", "idempotent":true }, "SendWhatsAppMessage":{ "name":"SendWhatsAppMessage", "http":{ "method":"POST", "requestUri":"/v1/whatsapp/send", "responseCode":200 }, "input":{"shape":"SendWhatsAppMessageInput"}, "output":{"shape":"SendWhatsAppMessageOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParametersException"}, {"shape":"ThrottledRequestException"}, {"shape":"InternalServiceException"}, {"shape":"DependencyException"} ], "documentation":"Send a WhatsApp message. For examples of sending a message using the Amazon Web Services CLI, see Sending messages in the Amazon Web Services End User Messaging Social User Guide .
" }, "TagResource":{ "name":"TagResource", "http":{ "method":"POST", "requestUri":"/v1/tags/tag-resource", "responseCode":200 }, "input":{"shape":"TagResourceInput"}, "output":{"shape":"TagResourceOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InvalidParametersException"}, {"shape":"ThrottledRequestException"}, {"shape":"InternalServiceException"} ], "documentation":"Adds or overwrites only the specified tags for the specified resource. When you specify an existing tag key, the value is overwritten with the new value.
" }, "UntagResource":{ "name":"UntagResource", "http":{ "method":"POST", "requestUri":"/v1/tags/untag-resource", "responseCode":200 }, "input":{"shape":"UntagResourceInput"}, "output":{"shape":"UntagResourceOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"InvalidParametersException"}, {"shape":"ThrottledRequestException"}, {"shape":"InternalServiceException"} ], "documentation":"Removes the specified tags from a resource.
" } }, "shapes":{ "AccessDeniedByMetaException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"You do not have sufficient access to perform this action.
", "error":{ "httpStatusCode":403, "senderFault":true }, "exception":true }, "AccessDeniedException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"You do not have sufficient access to perform this action.
", "error":{ "httpStatusCode":403, "senderFault":true }, "exception":true }, "Arn":{ "type":"string", "max":2048, "min":0, "pattern":"arn:.*" }, "AssociateInProgressToken":{ "type":"string", "max":50, "min":0, "sensitive":true }, "AssociateWhatsAppBusinessAccountInput":{ "type":"structure", "members":{ "signupCallback":{ "shape":"WhatsAppSignupCallback", "documentation":"Contains the callback access token.
" }, "setupFinalization":{ "shape":"WhatsAppSetupFinalization", "documentation":"A JSON object that contains the phone numbers and WhatsApp Business Account to link to your account.
" } } }, "AssociateWhatsAppBusinessAccountOutput":{ "type":"structure", "members":{ "signupCallbackResult":{ "shape":"WhatsAppSignupCallbackResult", "documentation":"Contains your WhatsApp registration status.
" }, "statusCode":{ "shape":"Integer", "documentation":"The status code for the response.
" } } }, "Boolean":{ "type":"boolean", "box":true }, "DeleteWhatsAppMessageMediaInput":{ "type":"structure", "required":[ "mediaId", "originationPhoneNumberId" ], "members":{ "mediaId":{ "shape":"WhatsAppMediaId", "documentation":"The unique identifier of the media file to delete. Use the mediaId returned from PostWhatsAppMessageMedia.
The unique identifier of the originating phone number associated with the media. Phone number identifiers are formatted as phone-number-id-01234567890123456789012345678901. Use GetLinkedWhatsAppBusinessAccount to find a phone number's id.
Success indicator for deleting the media file.
" } } }, "DependencyException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"Thrown when performing an action because a dependency would be broken.
", "error":{"httpStatusCode":502}, "exception":true, "fault":true, "retryable":{"throttling":false} }, "DisassociateWhatsAppBusinessAccountInput":{ "type":"structure", "required":["id"], "members":{ "id":{ "shape":"LinkedWhatsAppBusinessAccountId", "documentation":"The unique identifier of your WhatsApp Business Account. WABA identifiers are formatted as waba-01234567890123456789012345678901. Use ListLinkedWhatsAppBusinessAccounts to list all WABAs and their details.
The unique identifier, from Amazon Web Services, of the linked WhatsApp Business Account. WABA identifiers are formatted as waba-01234567890123456789012345678901. Use ListLinkedWhatsAppBusinessAccounts to list all WABAs and their details.
The details of the linked WhatsApp Business Account.
" } } }, "GetLinkedWhatsAppBusinessAccountPhoneNumberInput":{ "type":"structure", "required":["id"], "members":{ "id":{ "shape":"WhatsAppPhoneNumberId", "documentation":"The unique identifier of the phone number. Phone number identifiers are formatted as phone-number-id-01234567890123456789012345678901. Use GetLinkedWhatsAppBusinessAccount to find a phone number's id.
The WABA identifier linked to the phone number, formatted as waba-01234567890123456789012345678901.
The unique identifier for the media file.
" }, "originationPhoneNumberId":{ "shape":"WhatsAppPhoneNumberId", "documentation":"The unique identifier of the originating phone number for the WhatsApp message media. The phone number identifiers are formatted as phone-number-id-01234567890123456789012345678901. Use GetLinkedWhatsAppBusinessAccount to find a phone number's id.
Set to True to get only the metadata for the file.
The presign url of the media file.
" }, "destinationS3File":{ "shape":"S3File", "documentation":"The bucketName and key of the S3 media file.
The MIME type of the media.
" }, "fileSize":{ "shape":"Long", "documentation":"The file size of the media, in KB.
" } } }, "Headers":{ "type":"map", "key":{"shape":"String"}, "value":{"shape":"String"} }, "Integer":{ "type":"integer", "box":true }, "InternalServiceException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"The request processing has failed because of an unknown error, exception, or failure.
", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "retryable":{"throttling":false} }, "InvalidParametersException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"One or more parameters provided to the action are not valid.
", "error":{ "httpStatusCode":400, "senderFault":true }, "exception":true }, "IsoCountryCode":{ "type":"string", "pattern":"[A-Z]{2}" }, "LinkedAccountWithIncompleteSetup":{ "type":"map", "key":{"shape":"WhatsAppBusinessAccountId"}, "value":{"shape":"LinkedWhatsAppBusinessAccountIdMetaData"} }, "LinkedWhatsAppBusinessAccount":{ "type":"structure", "required":[ "arn", "id", "wabaId", "registrationStatus", "linkDate", "wabaName", "eventDestinations", "phoneNumbers" ], "members":{ "arn":{ "shape":"LinkedWhatsAppBusinessAccountArn", "documentation":"The ARN of the linked WhatsApp Business Account.
" }, "id":{ "shape":"LinkedWhatsAppBusinessAccountId", "documentation":"The ID of the linked WhatsApp Business Account, formatted as waba-01234567890123456789012345678901.
The WhatsApp Business Account ID from meta.
" }, "registrationStatus":{ "shape":"RegistrationStatus", "documentation":"The registration status of the linked WhatsApp Business Account.
" }, "linkDate":{ "shape":"WhatsAppBusinessAccountLinkDate", "documentation":"The date the WhatsApp Business Account was linked.
" }, "wabaName":{ "shape":"WhatsAppBusinessAccountName", "documentation":"The name of the linked WhatsApp Business Account.
" }, "eventDestinations":{ "shape":"WhatsAppBusinessAccountEventDestinations", "documentation":"The event destinations for the linked WhatsApp Business Account.
" }, "phoneNumbers":{ "shape":"WhatsAppPhoneNumberSummaryList", "documentation":"The phone numbers associated with the Linked WhatsApp Business Account.
" } }, "documentation":"The details of your linked WhatsApp Business Account.
" }, "LinkedWhatsAppBusinessAccountArn":{ "type":"string", "max":2048, "min":0, "pattern":"arn:.*:waba/[0-9a-zA-Z]+" }, "LinkedWhatsAppBusinessAccountId":{ "type":"string", "max":100, "min":1, "pattern":".*(^waba-.*$)|(^arn:.*:waba/[0-9a-zA-Z]+$).*" }, "LinkedWhatsAppBusinessAccountIdMetaData":{ "type":"structure", "members":{ "accountName":{ "shape":"WhatsAppBusinessAccountName", "documentation":"The name of your account.
" }, "registrationStatus":{ "shape":"RegistrationStatus", "documentation":"The registration status of the linked WhatsApp Business Account.
" }, "unregisteredWhatsAppPhoneNumbers":{ "shape":"WhatsAppPhoneNumberDetailList", "documentation":"The details for unregistered WhatsApp phone numbers.
" }, "wabaId":{ "shape":"LinkedWhatsAppBusinessAccountId", "documentation":"The Amazon Resource Name (ARN) of the WhatsApp Business Account ID.
" } }, "documentation":"Contains your WhatsApp registration status and details of any unregistered WhatsApp phone number.
" }, "LinkedWhatsAppBusinessAccountSummary":{ "type":"structure", "required":[ "arn", "id", "wabaId", "registrationStatus", "linkDate", "wabaName", "eventDestinations" ], "members":{ "arn":{ "shape":"LinkedWhatsAppBusinessAccountArn", "documentation":"The ARN of the linked WhatsApp Business Account.
" }, "id":{ "shape":"LinkedWhatsAppBusinessAccountId", "documentation":"The ID of the linked WhatsApp Business Account, formatted as waba-01234567890123456789012345678901.
The WhatsApp Business Account ID provided by Meta.
" }, "registrationStatus":{ "shape":"RegistrationStatus", "documentation":"The registration status of the linked WhatsApp Business Account.
" }, "linkDate":{ "shape":"WhatsAppBusinessAccountLinkDate", "documentation":"The date the WhatsApp Business Account was linked.
" }, "wabaName":{ "shape":"WhatsAppBusinessAccountName", "documentation":"The name of the linked WhatsApp Business Account.
" }, "eventDestinations":{ "shape":"WhatsAppBusinessAccountEventDestinations", "documentation":"The event destinations for the linked WhatsApp Business Account.
" } }, "documentation":"The details of a linked WhatsApp Business Account.
" }, "LinkedWhatsAppBusinessAccountSummaryList":{ "type":"list", "member":{"shape":"LinkedWhatsAppBusinessAccountSummary"} }, "LinkedWhatsAppPhoneNumberArn":{ "type":"string", "max":2048, "min":0, "pattern":"arn:.*:phone-number-id/[0-9a-zA-Z]+" }, "ListLinkedWhatsAppBusinessAccountsInput":{ "type":"structure", "members":{ "nextToken":{ "shape":"NextToken", "documentation":"The next token for pagination.
", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", "documentation":"The maximum number of results to return.
", "location":"querystring", "locationName":"maxResults" } } }, "ListLinkedWhatsAppBusinessAccountsOutput":{ "type":"structure", "members":{ "linkedAccounts":{ "shape":"LinkedWhatsAppBusinessAccountSummaryList", "documentation":"A list of WhatsApp Business Accounts linked to your Amazon Web Services account.
" }, "nextToken":{ "shape":"NextToken", "documentation":"The next token for pagination.
" } } }, "ListTagsForResourceInput":{ "type":"structure", "required":["resourceArn"], "members":{ "resourceArn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the resource to retrieve the tags from.
", "location":"querystring", "locationName":"resourceArn" } } }, "ListTagsForResourceOutput":{ "type":"structure", "members":{ "statusCode":{ "shape":"Integer", "documentation":"The status code of the response.
" }, "tags":{ "shape":"TagList", "documentation":"The tags for the resource.
" } } }, "Long":{ "type":"long", "box":true }, "MaxResults":{ "type":"integer", "box":true, "max":100, "min":1 }, "NextToken":{ "type":"string", "max":600, "min":1 }, "PhoneNumber":{ "type":"string", "max":20, "min":1 }, "PostWhatsAppMessageMediaInput":{ "type":"structure", "required":["originationPhoneNumberId"], "members":{ "originationPhoneNumberId":{ "shape":"WhatsAppPhoneNumberId", "documentation":"The ID of the phone number to associate with the WhatsApp media file. The phone number identifiers are formatted as phone-number-id-01234567890123456789012345678901. Use GetLinkedWhatsAppBusinessAccount to find a phone number's id.
The source presign url of the media file.
" }, "sourceS3File":{ "shape":"S3File", "documentation":"The source S3 url for the media file.
" } } }, "PostWhatsAppMessageMediaOutput":{ "type":"structure", "members":{ "mediaId":{ "shape":"WhatsAppMediaId", "documentation":"The unique identifier of the posted WhatsApp message.
" } } }, "PutWhatsAppBusinessAccountEventDestinationsInput":{ "type":"structure", "required":[ "id", "eventDestinations" ], "members":{ "id":{ "shape":"LinkedWhatsAppBusinessAccountId", "documentation":"The unique identifier of your WhatsApp Business Account. WABA identifiers are formatted as waba-01234567890123456789012345678901. Use ListLinkedWhatsAppBusinessAccounts to list all WABAs and their details.
An array of WhatsAppBusinessAccountEventDestination event destinations.
The resource was not found.
", "error":{ "httpStatusCode":404, "senderFault":true }, "exception":true }, "RoleArn":{ "type":"string", "pattern":"arn:aws:iam::\\d{12}:role\\/[a-zA-Z0-9+=,.@\\-_]+" }, "S3File":{ "type":"structure", "required":[ "bucketName", "key" ], "members":{ "bucketName":{ "shape":"S3FileBucketNameString", "documentation":"The bucket name.
" }, "key":{ "shape":"S3FileKeyString", "documentation":"The object key of the media file.
" } }, "documentation":"Contains information for the S3 bucket that contains media files.
", "sensitive":true }, "S3FileBucketNameString":{ "type":"string", "max":63, "min":3, "pattern":"[a-z0-9][a-z0-9.-]*[a-z0-9]" }, "S3FileKeyString":{ "type":"string", "max":1024, "min":0 }, "S3PresignedUrl":{ "type":"structure", "required":[ "url", "headers" ], "members":{ "url":{ "shape":"S3PresignedUrlUrlString", "documentation":"The presign url to the object.
" }, "headers":{ "shape":"Headers", "documentation":"A map of headers and their values. You must specify the Content-Type header when using PostWhatsAppMessageMedia. For a list of common headers, see Common Request Headers in the Amazon S3 API Reference
You can use presigned URLs to grant time-limited access to objects in Amazon S3 without updating your bucket policy. For more information, see Working with presigned URLs in the Amazon S3 User Guide.
", "sensitive":true }, "S3PresignedUrlUrlString":{ "type":"string", "max":2000, "min":1, "pattern":"https://(.*)s3(.*).amazonaws.com/(.*)" }, "SendWhatsAppMessageInput":{ "type":"structure", "required":[ "originationPhoneNumberId", "message", "metaApiVersion" ], "members":{ "originationPhoneNumberId":{ "shape":"WhatsAppPhoneNumberId", "documentation":"The ID of the phone number used to send the WhatsApp message. If you are sending a media file only the originationPhoneNumberId used to upload the file can be used. Phone number identifiers are formatted as phone-number-id-01234567890123456789012345678901. Use GetLinkedWhatsAppBusinessAccount to find a phone number's id.
The message to send through WhatsApp. The length is in KB. The message field passes through a WhatsApp Message object, see Messages in the WhatsApp Business Platform Cloud API Reference.
" }, "metaApiVersion":{ "shape":"String", "documentation":"The API version for the request formatted as v{VersionNumber}. For a list of supported API versions and Amazon Web Services Regions, see Amazon Web Services End User Messaging Social API Service Endpoints in the Amazon Web Services General Reference.
The unique identifier of the message.
" } } }, "String":{"type":"string"}, "StringList":{ "type":"list", "member":{"shape":"String"} }, "Tag":{ "type":"structure", "required":["key"], "members":{ "key":{ "shape":"TagKeyString", "documentation":"The tag key.
" }, "value":{ "shape":"TagValueString", "documentation":"The tag value.
" } }, "documentation":"The tag for a resource.
" }, "TagKeyString":{ "type":"string", "max":128, "min":1 }, "TagList":{ "type":"list", "member":{"shape":"Tag"} }, "TagResourceInput":{ "type":"structure", "required":[ "resourceArn", "tags" ], "members":{ "resourceArn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the resource to tag.
" }, "tags":{ "shape":"TagList", "documentation":"The tags to add to the resource.
" } } }, "TagResourceOutput":{ "type":"structure", "members":{ "statusCode":{ "shape":"Integer", "documentation":"The status code of the tag resource operation.
" } } }, "TagValueString":{ "type":"string", "max":256, "min":0 }, "ThrottledRequestException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"The request was denied due to request throttling.
", "error":{ "httpStatusCode":429, "senderFault":true }, "exception":true, "retryable":{"throttling":false} }, "TwoFactorPin":{ "type":"string", "max":6, "min":1, "sensitive":true }, "UntagResourceInput":{ "type":"structure", "required":[ "resourceArn", "tagKeys" ], "members":{ "resourceArn":{ "shape":"Arn", "documentation":"The Amazon Resource Name (ARN) of the resource to remove tags from.
" }, "tagKeys":{ "shape":"StringList", "documentation":"The keys of the tags to remove from the resource.
" } } }, "UntagResourceOutput":{ "type":"structure", "members":{ "statusCode":{ "shape":"Integer", "documentation":"The status code of the untag resource operation.
" } } }, "ValidationException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"The request contains an invalid parameter value.
", "error":{ "httpStatusCode":400, "senderFault":true }, "exception":true }, "WabaPhoneNumberSetupFinalization":{ "type":"structure", "required":[ "id", "twoFactorPin" ], "members":{ "id":{ "shape":"WhatsAppPhoneNumber", "documentation":"The unique identifier of the originating phone number associated with the media. Phone number identifiers are formatted as phone-number-id-01234567890123456789012345678901. Use GetLinkedWhatsAppBusinessAccount to find a phone number's id.
The PIN to use for two-step verification. To reset your PIN follow the directions in Updating PIN in the WhatsApp Business Platform Cloud API Reference.
" }, "dataLocalizationRegion":{ "shape":"IsoCountryCode", "documentation":"The two letter ISO region for the location of where Meta will store data.
Asia–Pacific (APAC)
Australia AU
Indonesia ID
India IN
Japan JP
Singapore SG
South Korea KR
Europe
Germany DE
Switzerland CH
United Kingdom GB
Latin America (LATAM)
Brazil BR
Middle East and Africa (MEA)
Bahrain BH
South Africa ZA
United Arab Emirates AE
North America (NORAM)
Canada CA
An array of key and value pair tags.
" } }, "documentation":"The registration details for a linked phone number.
" }, "WabaPhoneNumberSetupFinalizationList":{ "type":"list", "member":{"shape":"WabaPhoneNumberSetupFinalization"} }, "WabaSetupFinalization":{ "type":"structure", "members":{ "id":{ "shape":"WhatsAppBusinessAccountId", "documentation":"The ID of the linked WhatsApp Business Account, formatted as waba-01234567890123456789012345678901.
The event destinations for the linked WhatsApp Business Account.
" }, "tags":{ "shape":"TagList", "documentation":"An array of key and value pair tags.
" } }, "documentation":"The registration details for a linked WhatsApp Business Account.
" }, "WhatsAppBusinessAccountEventDestination":{ "type":"structure", "required":["eventDestinationArn"], "members":{ "eventDestinationArn":{ "shape":"EventDestinationArn", "documentation":"The ARN of the event destination.
" }, "roleArn":{ "shape":"RoleArn", "documentation":"The Amazon Resource Name (ARN) of an Identity and Access Management role that is able to import phone numbers and write events.
" } }, "documentation":"Contains information on the event destination.
" }, "WhatsAppBusinessAccountEventDestinations":{ "type":"list", "member":{"shape":"WhatsAppBusinessAccountEventDestination"}, "max":1, "min":0 }, "WhatsAppBusinessAccountId":{ "type":"string", "max":100, "min":1 }, "WhatsAppBusinessAccountLinkDate":{"type":"timestamp"}, "WhatsAppBusinessAccountName":{ "type":"string", "max":200, "min":0 }, "WhatsAppDisplayPhoneNumber":{ "type":"string", "max":20, "min":0 }, "WhatsAppMediaId":{ "type":"string", "max":100, "min":1, "pattern":"[A-Za-z0-9]+" }, "WhatsAppMessageBlob":{ "type":"blob", "max":2048000, "min":1, "sensitive":true }, "WhatsAppPhoneNumber":{ "type":"string", "max":100, "min":1 }, "WhatsAppPhoneNumberDetail":{ "type":"structure", "required":[ "arn", "phoneNumber", "phoneNumberId", "metaPhoneNumberId", "displayPhoneNumberName", "displayPhoneNumber", "qualityRating" ], "members":{ "arn":{ "shape":"LinkedWhatsAppPhoneNumberArn", "documentation":"The ARN of the WhatsApp phone number.
" }, "phoneNumber":{ "shape":"PhoneNumber", "documentation":"The phone number for sending WhatsApp.
" }, "phoneNumberId":{ "shape":"WhatsAppPhoneNumberId", "documentation":"The phone number ID. Phone number identifiers are formatted as phone-number-id-01234567890123456789012345678901.
The phone number ID from Meta.
" }, "displayPhoneNumberName":{ "shape":"WhatsAppPhoneNumberName", "documentation":"The display name for this phone number.
" }, "displayPhoneNumber":{ "shape":"WhatsAppDisplayPhoneNumber", "documentation":"The phone number that appears in the recipients display.
" }, "qualityRating":{ "shape":"WhatsAppPhoneNumberQualityRating", "documentation":"The quality rating of the phone number.
" } }, "documentation":"The details of your WhatsApp phone number.
" }, "WhatsAppPhoneNumberDetailList":{ "type":"list", "member":{"shape":"WhatsAppPhoneNumberDetail"} }, "WhatsAppPhoneNumberId":{ "type":"string", "max":100, "min":1, "pattern":".*(^phone-number-id-.*$)|(^arn:.*:phone-number-id/[0-9a-zA-Z]+$).*" }, "WhatsAppPhoneNumberName":{ "type":"string", "max":200, "min":0 }, "WhatsAppPhoneNumberQualityRating":{ "type":"string", "max":10, "min":0 }, "WhatsAppPhoneNumberSummary":{ "type":"structure", "required":[ "arn", "phoneNumber", "phoneNumberId", "metaPhoneNumberId", "displayPhoneNumberName", "displayPhoneNumber", "qualityRating" ], "members":{ "arn":{ "shape":"LinkedWhatsAppPhoneNumberArn", "documentation":"The full Amazon Resource Name (ARN) for the phone number.
" }, "phoneNumber":{ "shape":"PhoneNumber", "documentation":"The phone number associated with the Linked WhatsApp Business Account.
" }, "phoneNumberId":{ "shape":"WhatsAppPhoneNumberId", "documentation":"The phone number ID. Phone number identifiers are formatted as phone-number-id-01234567890123456789012345678901.
The phone number ID from Meta.
" }, "displayPhoneNumberName":{ "shape":"WhatsAppPhoneNumberName", "documentation":"The display name for this phone number.
" }, "displayPhoneNumber":{ "shape":"WhatsAppDisplayPhoneNumber", "documentation":"The phone number that appears in the recipients display.
" }, "qualityRating":{ "shape":"WhatsAppPhoneNumberQualityRating", "documentation":"The quality rating of the phone number. This is from Meta.
" } }, "documentation":"The details of a linked phone number.
" }, "WhatsAppPhoneNumberSummaryList":{ "type":"list", "member":{"shape":"WhatsAppPhoneNumberSummary"} }, "WhatsAppSetupFinalization":{ "type":"structure", "required":[ "associateInProgressToken", "phoneNumbers" ], "members":{ "associateInProgressToken":{ "shape":"AssociateInProgressToken", "documentation":"An Amazon Web Services access token generated by WhatsAppSignupCallback and used by WhatsAppSetupFinalization.
An array of WabaPhoneNumberSetupFinalization objects containing the details of each phone number associated with the WhatsApp Business Account.
" }, "phoneNumberParent":{ "shape":"LinkedWhatsAppBusinessAccountId", "documentation":"Used to add a new phone number to an existing WhatsApp Business Account. This field can't be used when the waba field is present.
Used to create a new WhatsApp Business Account and add a phone number. This field can't be used when the phoneNumberParent field is present.
The details of linking a WhatsApp Business Account to your Amazon Web Services account.
" }, "WhatsAppSignupCallback":{ "type":"structure", "required":["accessToken"], "members":{ "accessToken":{ "shape":"WhatsAppSignupCallbackAccessTokenString", "documentation":"The access token for your WhatsApp Business Account. The accessToken value is provided by Meta.
Contains the accessToken provided by Meta during signup.
An Amazon Web Services access token generated by WhatsAppSignupCallback and used by WhatsAppSetupFinalization.
A LinkedWhatsAppBusinessAccountIdMetaData object map containing the details of any WhatsAppBusiness accounts that have incomplete setup.
" } }, "documentation":"Contains the results of WhatsAppSignupCallback.
" } }, "documentation":"Amazon Web Services End User Messaging Social, also referred to as Social messaging, is a messaging service that enables application developers to incorporate WhatsApp into their existing workflows. The Amazon Web Services End User Messaging Social API provides information about the Amazon Web Services End User Messaging Social API resources, including supported HTTP methods, parameters, and schemas.
The Amazon Web Services End User Messaging Social API provides programmatic access to options that are unique to the WhatsApp Business Platform.
If you're new to the Amazon Web Services End User Messaging Social API, it's also helpful to review What is Amazon Web Services End User Messaging Social in the Amazon Web Services End User Messaging Social User Guide. The Amazon Web Services End User Messaging Social User Guide provides tutorials, code samples, and procedures that demonstrate how to use Amazon Web Services End User Messaging Social API features programmatically and how to integrate functionality into applications. The guide also provides key information, such as integration with other Amazon Web Services services, and the quotas that apply to use of the service.
Regional availability
The Amazon Web Services End User Messaging Social API is available across several Amazon Web Services Regions and it provides a dedicated endpoint for each of these Regions. For a list of all the Regions and endpoints where the API is currently available, see Amazon Web Services Service Endpoints and Amazon Web Services End User Messaging endpoints and quotas in the Amazon Web Services General Reference. To learn more about Amazon Web Services Regions, see Managing Amazon Web Services Regions in the Amazon Web Services General Reference.
In each Region, Amazon Web Services maintains multiple Availability Zones. These Availability Zones are physically isolated from each other, but are united by private, low-latency, high-throughput, and highly redundant network connections. These Availability Zones enable us to provide very high levels of availability and redundancy, while also minimizing latency. To learn more about the number of Availability Zones that are available in each Region, see Amazon Web Services Global Infrastructure.
" }