CreateEncoderConfiguration
Creates an EncoderConfiguration object.
Request Syntax
POST /CreateEncoderConfiguration HTTP/1.1
Content-type: application/json
{
"name": "string",
"tags": {
"string" : "string"
},
"video": {
"bitrate": number,
"framerate": number,
"height": number,
"width": number
}
}URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- name
-
Optional name to identify the resource.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 128.
Pattern:
[a-zA-Z0-9-_]*Required: No
-
Tags attached to the resource. Array of maps, each of the form
string:string (key:value). See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.Type: String to string map
Map Entries: Minimum number of 0 items. Maximum number of 50 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Value Length Constraints: Minimum length of 0. Maximum length of 256.
Required: No
- video
-
Video configuration. Default: video resolution 1280x720, bitrate 2500 kbps, 30 fps.
Type: Video object
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"encoderConfiguration": {
"arn": "string",
"name": "string",
"tags": {
"string" : "string"
},
"video": {
"bitrate": number,
"framerate": number,
"height": number,
"width": number
}
}
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- encoderConfiguration
-
The EncoderConfiguration that was created.
Type: EncoderConfiguration object
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
HTTP Status Code: 403
- ConflictException
-
HTTP Status Code: 409
- InternalServerException
-
HTTP Status Code: 500
- PendingVerification
-
HTTP Status Code: 403
- ResourceNotFoundException
-
HTTP Status Code: 404
- ServiceQuotaExceededException
-
HTTP Status Code: 402
- ValidationException
-
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
