AWS Documentation » AWS Elemental MediaConnect » API Reference » Resources » UpdateFlowOutput, RemoveFlowOutput

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.

See Also

• AWS SDK for JavaScript

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go - Pilot

• AWS SDK for Go

• AWS SDK for Java

• AWS SDK for PHP V3

• AWS SDK for Ruby V2

• AWS Command Line Interface

• AWS SDK for Python

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.

See Also

• AWS SDK for JavaScript

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go - Pilot

• AWS SDK for Go

• AWS SDK for Java

• AWS SDK for PHP V3

• AWS SDK for Ruby V2

• AWS Command Line Interface

• AWS SDK for Python

Schemas

Request Bodies

Example PUT

{
  "protocol": enum,
  "encryption": {
    "roleArn": "string",
    "secretArn": "string",
    "keyType": enum,
    "algorithm": enum
  },
  "streamId": "string",
  "port": integer,
  "destination": "string",
  "maxLatency": integer,
  "description": "string",
  "smoothingLatency": integer
}

Response Bodies

Example UpdateFlowOutputResponse

{
  "output": {
    "outputArn": "string",
    "encryption": {
      "roleArn": "string",
      "secretArn": "string",
      "keyType": enum,
      "algorithm": enum
    },
    "port": integer,
    "destination": "string",
    "name": "string",
    "description": "string",
    "entitlementArn": "string",
    "transport": {
      "protocol": enum,
      "streamId": "string",
      "maxLatency": integer,
      "maxBitrate": integer,
      "smoothingLatency": integer
    },
    "mediaLiveInputArn": "string"
  },
  "flowArn": "string"
}

Example RemoveFlowOutputResponse

{
  "outputArn": "string",
  "flowArn": "string"
}

Example ResponseError

{
  "message": "string"
}

Properties

Encryption

Information about the encryption of the flow.

Property	Type	Required	Description
roleArn	string	True	The Amazon Resource Name (ARN) of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
secretArn	string	True	The ARN of the secret that you created in AWS Secrets Manager to store the encryption key.
keyType	string Values: static-key	False	The type of key that is used for the encryption. If you don't specify a keyType value, the service uses the default setting (static-key).
algorithm	string Values: aes128 | aes192 | aes256	True	The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).

See Also

• AWS SDK for C++

• AWS SDK for Go - Pilot

• AWS SDK for Go

• AWS SDK for Java

• AWS SDK for Ruby V2

Output

The settings for an output.

Property	Type	Required	Description
outputArn	string	True	The ARN of the output.
encryption	Encryption	False	The encryption credentials that you want to use for the output.
port	integer	False	The port to use when content is distributed to the output.
destination	string	False	The address where you want to send the output.
name	string	True	The name of the output. This value must be unique within the current flow.
description	string	False	A description of the output. This description is not visible outside of the current AWS account even if the account grants entitlements to other accounts.
entitlementArn	string	False	The ARN of the entitlement on the originator's flow. This value is relevant only on entitled flows.
transport	Transport	False	Attributes that are related to the transport stream.
mediaLiveInputArn	string	False	The input ARN of the AWS Elemental MediaLive channel. This parameter is relevant only for outputs that AWS Elemental MediaConnect added to send content to a MediaLive input.

See Also

• AWS SDK for C++

• AWS SDK for Go - Pilot

• AWS SDK for Go

• AWS SDK for Java

• AWS SDK for Ruby V2

RemoveFlowOutputResponse

The result of a successful RemoveFlowOutput request including the flow ARN and the output ARN that was removed.

Property	Type	Required	Description
outputArn	string	True	The ARN of the output that you removed.
flowArn	string	True	The ARN of the flow that is associated with the output you removed.

See Also

• AWS SDK for C++

• AWS SDK for Go - Pilot

• AWS SDK for Go

• AWS SDK for Java

• AWS SDK for Ruby V2

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.

See Also

• AWS SDK for Ruby V2

Transport

Attributes that are related to the transport stream.

Property	Type	Required	Description
protocol	string Values: zixi-push | rtp-fec | rtp	True	The protocol that is used by the source or output.
streamId	string	False	The stream ID that you want to use for the transport. This parameter applies only to Zixi-based streams.
maxLatency	integer Format: int64	False	The maximum latency in milliseconds for Zixi-based streams.
maxBitrate	integer Format: int64	False	The smoothing max bitrate for RTP and RTP-FEC streams.
smoothingLatency	integer Format: int64	False	The smoothing latency in milliseconds for RTP and RTP-FEC streams.

See Also

• AWS SDK for C++

• AWS SDK for Go - Pilot

• AWS SDK for Go

• AWS SDK for Java

• AWS SDK for Ruby V2

UpdateEncryption

Information about the encryption of the flow.

Property	Type	Required	Description
roleArn	string	False	The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
secretArn	string	False	The ARN of the secret that you created in AWS Secrets Manager to store the encryption key.
keyType	string Values: static-key	False	The type of key that is used for the encryption. If you don't specify a keyType value, the service uses the default setting (static-key).
algorithm	string Values: aes128 | aes192 | aes256	False	The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).

See Also

• AWS SDK for C++

• AWS SDK for Go - Pilot

• AWS SDK for Go

• AWS SDK for Java

• AWS SDK for Ruby V2

UpdateFlowOutputRequest

The updates that you want to make to an existing output of an existing flow.

Property	Type	Required	Description
protocol	string Values: zixi-push | rtp-fec | rtp	False	The protocol to use for the output.
encryption	UpdateEncryption	False	The encryption credentials that you want to use for the output.
streamId	string	False	The stream ID that you want to use for the transport. This parameter applies only to Zixi-based streams.
port	integer	False	The port to use when AWS Elemental MediaConnect distributes content to the output.
destination	string	False	The IP address where you want to send the output.
maxLatency	integer Format: int64	False	The maximum latency in milliseconds for Zixi-based streams.
description	string	False	A description of the output. This description is not visible outside of the current AWS account even if the account grants entitlements to other accounts.
smoothingLatency	integer Format: int64	False	The smoothing latency in milliseconds for RTP and RTP-FEC streams.

See Also

• AWS SDK for C++

• AWS SDK for Go - Pilot

• AWS SDK for Go

• AWS SDK for Java

• AWS SDK for Ruby V2

UpdateFlowOutputResponse

The result of a successful UpdateFlowOutput request including the flow ARN and the updated output.

Property	Type	Required	Description
output	Output	True
flowArn	string	True	The ARN of the flow that is associated with the updated output.

See Also

• AWS SDK for C++

• AWS SDK for Go - Pilot

• AWS SDK for Go

• AWS SDK for Java

• AWS SDK for Ruby V2