AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

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 ]

get-linked-whatsapp-business-account

Description

Get the details of your linked WhatsApp Business Account.

See also: AWS API Documentation

Synopsis

  get-linked-whatsapp-business-account
--id <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>]

Options

--id (string)

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.

--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.

Global Options

--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.

  • json
  • text
  • table

--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.

  • on
  • off
  • auto

--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.

Output

account -> (structure)

The details of the linked WhatsApp Business Account.

arn -> (string)

The ARN of the linked WhatsApp Business Account.

id -> (string)

The ID of the linked WhatsApp Business Account, formatted as waba-01234567890123456789012345678901 .

wabaId -> (string)

The WhatsApp Business Account ID from meta.

registrationStatus -> (string)

The registration status of the linked WhatsApp Business Account.

linkDate -> (timestamp)

The date the WhatsApp Business Account was linked.

wabaName -> (string)

The name of the linked WhatsApp Business Account.

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.

phoneNumbers -> (list)

The phone numbers associated with the Linked WhatsApp Business Account.

(structure)

The details of a linked phone number.

arn -> (string)

The full Amazon Resource Name (ARN) for the phone number.

phoneNumber -> (string)

The phone number associated with the Linked WhatsApp Business Account.

phoneNumberId -> (string)

The phone number ID. Phone number identifiers are formatted as phone-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. This is from Meta.