[ aws . mediaconnect ]
Stops a flow.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
stop-flow
--flow-arn <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
--flow-arn
(string)
The ARN of the flow that you want to stop.
--cli-input-json
| --cli-input-yaml
(string)
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 --cli-input-yaml
.
--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
. 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.
See ‘aws help’ for descriptions of global parameters.
To stop a flow
The following stop-flow
example stops the specified flow.
aws mediaconnect stop-flow \
--flow-arn arn:aws:mediaconnect:us-east-1:123456789012:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:AwardsShow
Output:
{
"Status": "STOPPING",
"FlowArn": "arn:aws:mediaconnect:us-east-1:123456789012:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:AwardsShow"
}
For more information, see Stopping a Flow in the AWS Elemental MediaConnect User Guide.
FlowArn -> (string)
The ARN of the flow that you stopped.
Status -> (string)
The status of the flow when the StopFlow process begins.