DescribeFlow, DeleteFlow
URI
/v1/flows/flowArn
HTTP Methods
GET
Operation ID: DescribeFlow
Displays the details of a flow. The response includes the flow ARN, name, and Availability Zone, as well as details about the source, outputs, and entitlements.
Path Parameters
Name | Type | Required | Description |
---|---|---|---|
flowArn |
String | True |
The Amazon Resource Name (ARN) of the flow. |
Responses
Status Code | Response Model | Description |
---|---|---|
200 |
DescribeFlowResponse |
AWS Elemental MediaConnect returned the flow details successfully. |
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. |
DELETE
Operation ID: DeleteFlow
Deletes a flow. Before you can delete a flow, you must stop the 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 |
DeleteFlowResponse |
AWS Elemental MediaConnect is deleting 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 DescribeFlowResponse
{ "messages": { "errors": [ "string" ] }, "flow": { "entitlements": [ { "encryption": { "resourceId": "string", "roleArn": "string", "secretArn": "string", "constantInitializationVector": "string", "keyType": enum, "region": "string", "deviceId": "string", "url": "string", "algorithm": enum }, "subscribers": [ "string" ], "name": "string", "description": "string", "dataTransferSubscriberFeePercent": integer, "entitlementArn": "string" } ], "outputs": [ { "outputArn": "string", "encryption": { "resourceId": "string", "roleArn": "string", "secretArn": "string", "constantInitializationVector": "string", "keyType": enum, "region": "string", "deviceId": "string", "url": "string", "algorithm": enum }, "port": integer, "destination": "string", "name": "string", "description": "string", "dataTransferSubscriberFeePercent": integer, "entitlementArn": "string", "transport": { "protocol": enum, "streamId": "string", "maxLatency": integer, "maxBitrate": integer, "smoothingLatency": integer, "cidrAllowList": [ "string" ], "remoteId": "string" }, "mediaLiveInputArn": "string" } ], "flowArn": "string", "name": "string", "description": "string", "egressIp": "string", "source": { "sourceArn": "string", "name": "string", "description": "string", "dataTransferSubscriberFeePercent": integer, "entitlementArn": "string", "ingestIp": "string", "transport": { "protocol": enum, "streamId": "string", "maxLatency": integer, "maxBitrate": integer, "smoothingLatency": integer, "cidrAllowList": [ "string" ], "remoteId": "string" }, "decryption": { "resourceId": "string", "roleArn": "string", "secretArn": "string", "constantInitializationVector": "string", "keyType": enum, "region": "string", "deviceId": "string", "url": "string", "algorithm": enum }, "ingestPort": integer, "whitelistCidr": "string" }, "availabilityZone": "string", "status": enum } }
Example DeleteFlowResponse
{ "flowArn": "string", "status": enum }
Example ResponseError
{ "message": "string" }
Properties
DeleteFlowResponse
The result of a successful DeleteFlow request.
DescribeFlowResponse
The result of a successful DescribeFlow request.
Encryption
Information about the encryption of the flow.
Entitlement
The settings for a flow entitlement.
Flow
The settings for a flow, including its source, outputs, and entitlements.
Property | Type | Required | Description |
---|---|---|---|
entitlements |
Array of type Entitlement |
True |
The entitlements in the flow. |
outputs |
Array of type Output |
True |
The outputs in the flow. |
flowArn |
string |
True |
The Amazon Resource Name (ARN) of the flow. |
name |
string |
True |
The name of the flow. |
description |
string |
False |
A description of the flow. This description appears only on the AWS Elemental MediaConnect console and is not visible outside of the current AWS account. |
egressIp |
string |
False |
The outgoing IP address that AWS Elemental MediaConnect uses to send video from the flow. |
source |
True |
The source for the flow. |
|
availabilityZone |
string |
True |
The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current AWS Region. |
status |
string Values: |
True |
The current status of the flow. |
Messages
Messages that provide the state of the flow.
Output
The settings for an output.
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.
Source
The settings for the source of the flow.
Transport
Attributes that are related to the transport stream.
See Also
For more information about using this API in one of the language-specific AWS SDKs and references, see the following: