Flows: start
URI
/v1/flows/start/flowArn
HTTP methods
POST
Operation ID: StartFlow
Starts a flow.
| Name | Type | Required | Description |
|---|---|---|---|
flowArn | String | True | The Amazon Resource Name (ARN) of the flow. |
| Status code | Response model | Description |
|---|---|---|
202 | StartFlowResponse | MediaConnect is starting 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
{ "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. |
StartFlowResponse
The result of a successful StartFlow request.
| Property | Type | Required | Description |
|---|---|---|---|
flowArn | string | True | The ARN of the flow that you started. |
status | string Values: | True | The status of the flow when the StartFlow process begins. |
See also
For more information about using this API in one of the language-specific AWS SDKs and references, see the following:
StartFlow
