AWS Elemental MediaConnect
API Reference

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

StopFlow

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

AWS Elemental 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

AWS Elemental MediaConnect did not find the resource that you specified in the request.

429 ResponseError

You have exceeded the service request rate limit for your AWS Elemental MediaConnect account.

500 ResponseError

AWS Elemental MediaConnect can't fulfill your request because it encountered an unexpected condition.

503 ResponseError

AWS Elemental MediaConnect is currently unavailable. Try again later.

Schemas

Response Bodies

Example StopFlowResponse

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

Example ResponseError

{ "message": "string" }

Properties

ResponseError

An exception raised by AWS Elemental 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 AWS Elemental 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
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.

See Also

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

StopFlow