GetEncoderConfigurationCommand

Suggest an Edit

Gets information about the specified EncoderConfiguration resource.

Example Syntax

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

import { IVSRealTimeClient, GetEncoderConfigurationCommand } from "@aws-sdk/client-ivs-realtime"; // ES Modules import
// const { IVSRealTimeClient, GetEncoderConfigurationCommand } = require("@aws-sdk/client-ivs-realtime"); // CommonJS import
const client = new IVSRealTimeClient(config);
const input = { // GetEncoderConfigurationRequest
  arn: "STRING_VALUE", // required
};
const command = new GetEncoderConfigurationCommand(input);
const response = await client.send(command);
// { // GetEncoderConfigurationResponse
//   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",
//     },
//   },
// };

GetEncoderConfigurationCommand Input

See GetEncoderConfigurationCommandInput for more details

Parameter
Type
Description
arn
Required
string | undefined

ARN of the EncoderConfiguration resource.

GetEncoderConfigurationCommand Output

See GetEncoderConfigurationCommandOutput for details

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

The EncoderConfiguration that was returned.

Throws

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