UpdateFlowMediaStream
Updates an existing media stream.
Request Syntax
PUT /v1/flows/flowArn/mediaStreams/mediaStreamName HTTP/1.1
Content-type: application/json
{
"attributes": {
"fmtp": {
"channelOrder": "string",
"colorimetry": "string",
"exactFramerate": "string",
"par": "string",
"range": "string",
"scanMode": "string",
"tcs": "string"
},
"lang": "string"
},
"clockRate": number,
"description": "string",
"mediaStreamType": "string",
"videoFormat": "string"
}URI Request Parameters
The request uses the following URI parameters.
- flowArn
-
The Amazon Resource Name (ARN) of the flow that is associated with the media stream that you updated.
Pattern:
arn:.+:mediaconnect.+:flow:.+Required: Yes
- mediaStreamName
-
The media stream that you updated.
Required: Yes
Request Body
The request accepts the following data in JSON format.
- attributes
-
The attributes that you want to assign to the media stream.
Type: MediaStreamAttributesRequest object
Required: No
- clockRate
-
The sample rate for the stream. This value in measured in kHz.
Type: Integer
Required: No
- description
-
A description that can help you quickly identify what your media stream is used for.
Type: String
Required: No
- mediaStreamType
-
The type of media stream.
Type: String
Valid Values:
video | audio | ancillary-dataRequired: No
- videoFormat
-
The resolution of the video.
Type: String
Required: No
Response Syntax
HTTP/1.1 202
Content-type: application/json
{
"flowArn": "string",
"mediaStream": {
"attributes": {
"fmtp": {
"channelOrder": "string",
"colorimetry": "string",
"exactFramerate": "string",
"par": "string",
"range": "string",
"scanMode": "string",
"tcs": "string"
},
"lang": "string"
},
"clockRate": number,
"description": "string",
"fmt": number,
"mediaStreamId": number,
"mediaStreamName": "string",
"mediaStreamType": "string",
"videoFormat": "string"
}
}Response Elements
If the action is successful, the service sends back an HTTP 202 response.
The following data is returned in JSON format by the service.
- flowArn
-
The ARN of the flow that is associated with the media stream that you updated.
Type: String
- mediaStream
-
The media stream that you updated.
Type: MediaStream object
Errors
For information about the errors that are common to all actions, see Common Errors.
- BadRequestException
-
This exception is thrown if the request contains a semantic error. The precise meaning depends on the API, and is documented in the error message.
HTTP Status Code: 400
- ForbiddenException
-
You do not have sufficient access to perform this action.
HTTP Status Code: 403
- InternalServerErrorException
-
The server encountered an internal error and is unable to complete the request.
HTTP Status Code: 500
- NotFoundException
-
One or more of the resources in the request does not exist in the system.
HTTP Status Code: 404
- ServiceUnavailableException
-
The service is currently unavailable or busy.
HTTP Status Code: 503
- TooManyRequestsException
-
The request was denied due to request throttling.
HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
