Note:
You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.
[ aws . socialmessaging ]
get-whatsapp-flow¶
Description¶
Retrieves the metadata and status of a WhatsApp Flow, including validation errors, preview information, and health status.
See also: AWS API Documentation
Synopsis¶
get-whatsapp-flow
--id <value>
--flow-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>]
[--v2-debug]
Options¶
--id (string)
The ID of the WhatsApp Business Account associated with this Flow.
--flow-id (string)
The unique identifier of the Flow to retrieve.
--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.
--v2-debug (boolean)
Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.
Output¶
flowId -> (string)
The unique identifier of the Flow.
flowName -> (string)
The name of the Flow.
flowStatus -> (string)
The lifecycle status of the Flow. Valid values are DRAFT, PUBLISHED, DEPRECATED, BLOCKED, and THROTTLED.
categories -> (list)
The categories that classify the business purpose of the Flow.
(string)
The category that classifies the business purpose of a WhatsApp Flow.
validationErrors -> (list)
A list of validation errors from Meta, if any.
(string)
jsonVersion -> (string)
The version of the Flow JSON schema used by this Flow (for example, 7.3).
dataApiVersion -> (string)
The data API version for data exchange endpoint Flows.
endpointUri -> (string)
The endpoint URI for data exchange Flows, if configured.
preview -> (structure)
The preview URL and its expiration timestamp for testing the Flow.
previewUrl -> (string)
The web URL for previewing the Flow. Can be shared with stakeholders for review.expiresAt -> (string)
The timestamp when the preview URL expires.
whatsAppBusinessAccount -> (structure)
The WhatsApp Business Account information from Meta associated with this Flow.
id -> (string)
The WhatsApp Business Account ID from Meta.name -> (string)
The name of the WhatsApp Business Account.currency -> (string)
The currency code for the WhatsApp Business Account (for example, USD).timezoneId -> (string)
The timezone ID for the WhatsApp Business Account.messageTemplateNamespace -> (string)
The message template namespace for the WhatsApp Business Account.
application -> (structure)
The Meta application information associated with this Flow.
link -> (string)
The URL link for the Meta application.name -> (string)
The name of the Meta application.id -> (string)
The unique identifier of the Meta application.
healthStatus -> (structure)
The health status information for this Flow from Meta.
canSendMessage -> (string)
The overall messaging availability status (for example, AVAILABLE, LIMITED, or BLOCKED).entities -> (list)
A list of health status entities with per-entity availability information.
(structure)
Represents a single entity in the health status check for a WhatsApp Flow.
entityType -> (string)
The type of entity (for example, FLOW, WABA, BUSINESS, or APP).id -> (string)
The unique identifier of the entity.canSendMessage -> (string)
The messaging availability status for this entity (for example, AVAILABLE, LIMITED, or BLOCKED).