AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.
[ aws . socialmessaging ]
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.
See also: AWS API Documentation
associate-whatsapp-business-account
[--signup-callback <value>]
[--setup-finalization <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
--signup-callback
(structure)
Contains the callback access token.
accessToken -> (string)
The access token for your WhatsApp Business Account. TheaccessToken
value is provided by Meta.
Shorthand Syntax:
accessToken=string
JSON Syntax:
{
"accessToken": "string"
}
--setup-finalization
(structure)
A JSON object that contains the phone numbers and WhatsApp Business Account to link to your account.
associateInProgressToken -> (string)
An Amazon Web Services access token generated byWhatsAppSignupCallback
and used byWhatsAppSetupFinalization
.phoneNumbers -> (list)
An array of WabaPhoneNumberSetupFinalization objects containing the details of each phone number associated with the WhatsApp Business Account.
(structure)
The registration details for a linked phone number.
id -> (string)
The unique identifier of the originating phone number associated with the media. Phone number identifiers are formatted asphone-number-id-01234567890123456789012345678901
. Use GetLinkedWhatsAppBusinessAccount to find a phone number's id.twoFactorPin -> (string)
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 -> (string)
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
tags -> (list)
An array of key and value pair tags.
(structure)
The tag for a resource.
key -> (string)
The tag key.value -> (string)
The tag value.phoneNumberParent -> (string)
Used to add a new phone number to an existing WhatsApp Business Account. This field can't be used when thewaba
field is present.waba -> (structure)
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.id -> (string)
The ID of the linked WhatsApp Business Account, formatted aswaba-01234567890123456789012345678901
.eventDestinations -> (list)
The event destinations for the linked WhatsApp Business Account.
(structure)
Contains information on the event destination.
eventDestinationArn -> (string)
The ARN of the event destination.tags -> (list)
An array of key and value pair tags.
(structure)
The tag for a resource.
key -> (string)
The tag key.value -> (string)
The tag value.
JSON Syntax:
{
"associateInProgressToken": "string",
"phoneNumbers": [
{
"id": "string",
"twoFactorPin": "string",
"dataLocalizationRegion": "string",
"tags": [
{
"key": "string",
"value": "string"
}
...
]
}
...
],
"phoneNumberParent": "string",
"waba": {
"id": "string",
"eventDestinations": [
{
"eventDestinationArn": "string"
}
...
],
"tags": [
{
"key": "string",
"value": "string"
}
...
]
}
}
--cli-input-json
(string)
Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
--debug
(boolean)
Turn on debug logging.
--endpoint-url
(string)
Override command's default URL with the given URL.
--no-verify-ssl
(boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate
(boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output
(string)
The formatting style for command output.
--query
(string)
A JMESPath query to use in filtering the response data.
--profile
(string)
Use a specific profile from your credential file.
--region
(string)
The region to use. Overrides config/env settings.
--version
(string)
Display the version of this tool.
--color
(string)
Turn on/off color output.
--no-sign-request
(boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle
(string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout
(int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout
(int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
signupCallbackResult -> (structure)
Contains your WhatsApp registration status.
associateInProgressToken -> (string)
An Amazon Web Services access token generated byWhatsAppSignupCallback
and used byWhatsAppSetupFinalization
.linkedAccountsWithIncompleteSetup -> (map)
A LinkedWhatsAppBusinessAccountIdMetaData object map containing the details of any WhatsAppBusiness accounts that have incomplete setup.
key -> (string)
value -> (structure)
Contains your WhatsApp registration status and details of any unregistered WhatsApp phone number.
accountName -> (string)
The name of your account.registrationStatus -> (string)
The registration status of the linked WhatsApp Business Account.unregisteredWhatsAppPhoneNumbers -> (list)
The details for unregistered WhatsApp phone numbers.
(structure)
The details of your WhatsApp phone number.
arn -> (string)
The ARN of the WhatsApp phone number.phoneNumber -> (string)
The phone number for sending WhatsApp.phoneNumberId -> (string)
The phone number ID. Phone number identifiers are formatted asphone-number-id-01234567890123456789012345678901
.metaPhoneNumberId -> (string)
The phone number ID from Meta.displayPhoneNumberName -> (string)
The display name for this phone number.displayPhoneNumber -> (string)
The phone number that appears in the recipients display.qualityRating -> (string)
The quality rating of the phone number.
statusCode -> (integer)
The status code for the response.