Returns the full details of a channel flow in an Amazon Chime
AppInstance . This is a developer API.
See also: AWS API Documentation
describe-channel-flow --channel-flow-arn <value> [--cli-input-json | --cli-input-yaml] [--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>] [--cli-binary-format <value>] [--no-cli-pager] [--cli-auto-prompt] [--no-cli-auto-prompt]
The ARN of the channel flow.
Reads arguments from the JSON string provided. The JSON string follows the format provided by
--generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with
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. Similarly, if provided
yaml-input it will print a sample input YAML that can be used with
--cli-input-yaml. If provided with the value
output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
Turn on debug logging.
Override command’s default URL with the given URL.
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.
Disable automatic pagination.
The formatting style for command output.
A JMESPath query to use in filtering the response data.
Use a specific profile from your credential file.
The region to use. Overrides config/env settings.
Display the version of this tool.
Turn on/off color output.
Do not sign requests. Credentials will not be loaded if this argument is provided.
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
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.
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.
The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob
fileb:// will always be treated as binary and use the file contents directly regardless of the
cli-binary-format setting. When using
file:// the file contents will need to properly formatted for the configured
Disable cli pager for output.
Automatically prompt for CLI input parameters.
Disable automatically prompt for CLI input parameters.
ChannelFlow -> (structure)
The channel flow details.
ChannelFlowArn -> (string)The ARN of the channel flow.
Processors -> (list)
Information about the processor Lambda functions.
The information about a processor in a channel flow.
Name -> (string)The name of the channel flow.
Configuration -> (structure)
The information about the type of processor and its identifier.
Lambda -> (structure)
Indicates that the processor is of type Lambda.
ResourceArn -> (string)The ARN of the Lambda message processing function.
InvocationType -> (string)Controls how the Lambda function is invoked.
ExecutionOrder -> (integer)The sequence in which processors run. If you have multiple processors in a channel flow, message processing goes through each processor in the sequence. The value determines the sequence. At this point, we support only 1 processor within a flow.
FallbackAction -> (string)Determines whether to continue with message processing or stop it in cases where communication with a processor fails. If a processor has a fallback action of
ABORTand communication with it fails, the processor sets the message status to
FAILEDand does not send the message to any recipients. Note that if the last processor in the channel flow sequence has a fallback action of
CONTINUEand communication with the processor fails, then the message is considered processed and sent to recipients of the channel.
Name -> (string)The name of the channel flow.
CreatedTimestamp -> (timestamp)The time at which the channel flow was created.
LastUpdatedTimestamp -> (timestamp)The time at which a channel flow was updated.