CreateEncoderConfigurationCommand

Suggest an Edit

Creates an EncoderConfiguration object.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { IVSRealTimeClient, CreateEncoderConfigurationCommand } from "@aws-sdk/client-ivs-realtime"; // ES Modules import
// const { IVSRealTimeClient, CreateEncoderConfigurationCommand } = require("@aws-sdk/client-ivs-realtime"); // CommonJS import
const client = new IVSRealTimeClient(config);
const input = { // CreateEncoderConfigurationRequest
  name: "STRING_VALUE",
  video: { // Video
    width: Number("int"),
    height: Number("int"),
    framerate: Number("float"),
    bitrate: Number("int"),
  },
  tags: { // Tags
    "<keys>": "STRING_VALUE",
  },
};
const command = new CreateEncoderConfigurationCommand(input);
const response = await client.send(command);
// { // CreateEncoderConfigurationResponse
//   encoderConfiguration: { // EncoderConfiguration
//     arn: "STRING_VALUE", // required
//     name: "STRING_VALUE",
//     video: { // Video
//       width: Number("int"),
//       height: Number("int"),
//       framerate: Number("float"),
//       bitrate: Number("int"),
//     },
//     tags: { // Tags
//       "<keys>": "STRING_VALUE",
//     },
//   },
// };

CreateEncoderConfigurationCommand Input

See CreateEncoderConfigurationCommandInput for more details

Parameter
Type
Description
name
string | undefined

Optional name to identify the resource.

tags
Record<string, string> | undefined

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.

video
Video | undefined

Video configuration. Default: video resolution 1280x720, bitrate 2500 kbps, 30 fps.

CreateEncoderConfigurationCommand Output

See CreateEncoderConfigurationCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
encoderConfiguration
EncoderConfiguration | undefined

The EncoderConfiguration that was created.

Throws

Name
Fault
Details
AccessDeniedException
client
<p/>
ConflictException
client
<p/>
InternalServerException
server
<p/>
PendingVerification
client
<p/>
ResourceNotFoundException
client
<p/>
ServiceQuotaExceededException
client
<p/>
ValidationException
client
<p/>
IVSRealTimeServiceException
Base exception class for all service exceptions from IVSRealTime service.