GetIngestConfigurationCommand

Suggest an Edit

Gets information about the specified IngestConfiguration.

Example Syntax

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

import { IVSRealTimeClient, GetIngestConfigurationCommand } from "@aws-sdk/client-ivs-realtime"; // ES Modules import
// const { IVSRealTimeClient, GetIngestConfigurationCommand } = require("@aws-sdk/client-ivs-realtime"); // CommonJS import
const client = new IVSRealTimeClient(config);
const input = { // GetIngestConfigurationRequest
  arn: "STRING_VALUE", // required
};
const command = new GetIngestConfigurationCommand(input);
const response = await client.send(command);
// { // GetIngestConfigurationResponse
//   ingestConfiguration: { // IngestConfiguration
//     name: "STRING_VALUE",
//     arn: "STRING_VALUE", // required
//     ingestProtocol: "RTMP" || "RTMPS", // required
//     streamKey: "STRING_VALUE", // required
//     stageArn: "STRING_VALUE", // required
//     participantId: "STRING_VALUE", // required
//     state: "STRING_VALUE", // required
//     userId: "STRING_VALUE",
//     attributes: { // ParticipantAttributes
//       "<keys>": "STRING_VALUE",
//     },
//     tags: { // Tags
//       "<keys>": "STRING_VALUE",
//     },
//   },
// };

GetIngestConfigurationCommand Input

See GetIngestConfigurationCommandInput for more details

Parameter
Type
Description
arn
Required
string | undefined

ARN of the ingest for which the information is to be retrieved.

GetIngestConfigurationCommand Output

See GetIngestConfigurationCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
ingestConfiguration
IngestConfiguration | undefined

The IngestConfiguration that was returned.

Throws

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