UpdateFlowOutput, RemoveFlowOutput
URI
/v1/flows/flowArn
/outputs/outputArn
HTTP Methods
PUT
Operation ID: UpdateFlowOutput
Updates an existing flow output.
Path Parameters
Name | Type | Required | Description |
---|---|---|---|
flowArn |
String | True |
The Amazon Resource Name (ARN) of the flow. |
outputArn |
String | True |
The ARN of the output that you want to update. |
Responses
Status Code | Response Model | Description |
---|---|---|
202 |
UpdateFlowOutputResponse |
AWS Elemental MediaConnect is updating the output. |
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: RemoveFlowOutput
Removes an output from an existing flow. This request can be made only on an output that does not have an entitlement associated with it. If the output has an entitlement, you must revoke the entitlement instead. When an entitlement is revoked from a flow, the service automatically removes the associated output.
Path Parameters
Name | Type | Required | Description |
---|---|---|---|
flowArn |
String | True |
The Amazon Resource Name (ARN) of the flow. |
outputArn |
String | True |
The ARN of the output that you want to update. |
Responses
Status Code | Response Model | Description |
---|---|---|
202 |
RemoveFlowOutputResponse |
AWS Elemental MediaConnect is removing the output. |
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
Request Bodies
Example PUT
{ "protocol": enum, "encryption": { "resourceId": "string", "roleArn": "string", "secretArn": "string", "constantInitializationVector": "string", "keyType": enum, "region": "string", "deviceId": "string", "url": "string", "algorithm": enum }, "streamId": "string", "port": integer, "destination": "string", "maxLatency": integer, "description": "string", "smoothingLatency": integer, "cidrAllowList": [ "string" ], "remoteId": "string" }
Response Bodies
Example UpdateFlowOutputResponse
{ "output": { "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" }
Example RemoveFlowOutputResponse
{ "outputArn": "string", "flowArn": "string" }
Example ResponseError
{ "message": "string" }
Properties
Encryption
Information about the encryption of the flow.
Output
The settings for an output.
RemoveFlowOutputResponse
The result of a successful RemoveFlowOutput request including the flow ARN and the output ARN that was removed.
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.
Transport
Attributes that are related to the transport stream.
UpdateEncryption
Information about the encryption of the flow.
UpdateFlowOutputRequest
The updates that you want to make to an existing output of an existing flow.
UpdateFlowOutputResponse
The result of a successful UpdateFlowOutput request including the flow ARN and the updated output.
See Also
For more information about using this API in one of the language-specific AWS SDKs and references, see the following: