URI HTTP methods Schemas Properties See also

Flows: stop

URI

/v1/flows/stop/flowArn

HTTP methods

POST

Operation ID: StopFlow

Stops a flow.

Path parameters
Name	Type	Required	Description
`flowArn`	String	True	The Amazon Resource Name (ARN) of the flow.

Responses
Status code	Response model	Description
`202`	`StopFlowResponse`	MediaConnect is stopping the flow.
`400`	`ResponseError`	The request that you submitted is not valid.
`403`	`ResponseError`	You don't have the required permissions to perform this operation.
`404`	`ResponseError`	MediaConnect did not find the resource that you specified in the request.
`429`	`ResponseError`	You have exceeded the service request rate limit for your MediaConnect account.
`500`	`ResponseError`	MediaConnect can't fulfill your request because it encountered an unexpected condition.
`503`	`ResponseError`	MediaConnect is currently unavailable. Try again later.

Schemas

Response bodies


{
  "flowArn": "string",
  "status": enum
}


{
  "message": "string"
}

Properties

ResponseError

An exception raised by MediaConnect when you submit a request that cannot be completed. For more information, see the error message and documentation for the operation.

Property	Type	Required	Description
`message`	string	True	The specific error message that MediaConnect returns to help you understand the reason that the request did not succeed.

StopFlowResponse

The result of a successful StopFlow request.

Property Type Required Description

Property	Type	Required	Description
`flowArn`	string	True	The ARN of the flow that you stopped.
`status`	string Values: `STANDBY \| ACTIVE \| UPDATING \| DELETING \| STARTING \| STOPPING \| ERROR`	True	The status of the flow when the StopFlow process begins.

flowArn

string

True

The ARN of the flow that you stopped.

status

string

True

The status of the flow when the StopFlow process begins.