MediaConnect / Client / stop_flow

stop_flow#

MediaConnect.Client.stop_flow(**kwargs)#

Stops a flow.

See also: AWS API Documentation

Request Syntax

response = client.stop_flow(
    FlowArn='string'
)
Parameters:

FlowArn (string) –

[REQUIRED]

The Amazon Resource Name (ARN) of the flow that you want to stop.

Return type:

dict

Returns:

Response Syntax

{
    'FlowArn': 'string',
    'Status': 'STANDBY'|'ACTIVE'|'UPDATING'|'DELETING'|'STARTING'|'STOPPING'|'ERROR'
}

Response Structure

  • (dict) –

    • FlowArn (string) –

      The ARN of the flow that you stopped.

    • Status (string) –

      The status of the flow when the StopFlow process begins.

Exceptions