ListLinkedWhatsAppBusinessAccounts
List all WhatsApp Business Accounts linked to your AWS account.
Request Syntax
GET /v1/whatsapp/waba/list?maxResults=maxResults&nextToken=nextToken HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- maxResults
-
The maximum number of results to return.
Valid Range: Minimum value of 1. Maximum value of 100.
- nextToken
-
The next token for pagination.
Length Constraints: Minimum length of 1. Maximum length of 600.
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"linkedAccounts": [
{
"arn": "string",
"eventDestinations": [
{
"eventDestinationArn": "string",
"roleArn": "string"
}
],
"id": "string",
"linkDate": number,
"registrationStatus": "string",
"wabaId": "string",
"wabaName": "string"
}
],
"nextToken": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- linkedAccounts
-
A list of WhatsApp Business Accounts linked to your AWS account.
Type: Array of LinkedWhatsAppBusinessAccountSummary objects
- nextToken
-
The next token for pagination.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 600.
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have sufficient access to perform this action.
HTTP Status Code: 403
- InternalServiceException
-
The request processing has failed because of an unknown error, exception, or failure.
HTTP Status Code: 500
- InvalidParametersException
-
One or more parameters provided to the action are not valid.
HTTP Status Code: 400
- ResourceNotFoundException
-
The resource was not found.
HTTP Status Code: 404
- ThrottledRequestException
-
The request was denied due to request throttling.
HTTP Status Code: 429
- ValidationException
-
The request contains an invalid parameter value.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
