Flows: stop - AWS Elemental MediaConnect

Flows: stop

URI

/v1/flows/stop/flowArn

HTTP methods

POST

Operation ID: StopFlow

Stops a flow.

Path parameters
NameTypeRequiredDescription
flowArnStringTrue

The Amazon Resource Name (ARN) of the flow.

Responses
Status codeResponse modelDescription
202StopFlowResponse

MediaConnect is stopping the flow.

400ResponseError

The request that you submitted is not valid.

403ResponseError

You don't have the required permissions to perform this operation.

404ResponseError

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

429ResponseError

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

500ResponseError

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

503ResponseError

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.

PropertyTypeRequiredDescription
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.

PropertyTypeRequiredDescription
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