UpdateStageCommand

Suggest an Edit

Updates a stage’s configuration.

Example Syntax

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

import { IVSRealTimeClient, UpdateStageCommand } from "@aws-sdk/client-ivs-realtime"; // ES Modules import
// const { IVSRealTimeClient, UpdateStageCommand } = require("@aws-sdk/client-ivs-realtime"); // CommonJS import
const client = new IVSRealTimeClient(config);
const input = { // UpdateStageRequest
  arn: "STRING_VALUE", // required
  name: "STRING_VALUE",
  autoParticipantRecordingConfiguration: { // AutoParticipantRecordingConfiguration
    storageConfigurationArn: "STRING_VALUE", // required
    mediaTypes: [ // ParticipantRecordingMediaTypeList
      "AUDIO_VIDEO" || "AUDIO_ONLY" || "NONE",
    ],
    thumbnailConfiguration: { // ParticipantThumbnailConfiguration
      targetIntervalSeconds: Number("int"),
      storage: [ // ThumbnailStorageTypeList
        "SEQUENTIAL" || "LATEST",
      ],
      recordingMode: "INTERVAL" || "DISABLED",
    },
    recordingReconnectWindowSeconds: Number("int"),
    hlsConfiguration: { // ParticipantRecordingHlsConfiguration
      targetSegmentDurationSeconds: Number("int"),
    },
  },
};
const command = new UpdateStageCommand(input);
const response = await client.send(command);
// { // UpdateStageResponse
//   stage: { // Stage
//     arn: "STRING_VALUE", // required
//     name: "STRING_VALUE",
//     activeSessionId: "STRING_VALUE",
//     tags: { // Tags
//       "<keys>": "STRING_VALUE",
//     },
//     autoParticipantRecordingConfiguration: { // AutoParticipantRecordingConfiguration
//       storageConfigurationArn: "STRING_VALUE", // required
//       mediaTypes: [ // ParticipantRecordingMediaTypeList
//         "AUDIO_VIDEO" || "AUDIO_ONLY" || "NONE",
//       ],
//       thumbnailConfiguration: { // ParticipantThumbnailConfiguration
//         targetIntervalSeconds: Number("int"),
//         storage: [ // ThumbnailStorageTypeList
//           "SEQUENTIAL" || "LATEST",
//         ],
//         recordingMode: "INTERVAL" || "DISABLED",
//       },
//       recordingReconnectWindowSeconds: Number("int"),
//       hlsConfiguration: { // ParticipantRecordingHlsConfiguration
//         targetSegmentDurationSeconds: Number("int"),
//       },
//     },
//     endpoints: { // StageEndpoints
//       events: "STRING_VALUE",
//       whip: "STRING_VALUE",
//       rtmp: "STRING_VALUE",
//       rtmps: "STRING_VALUE",
//     },
//   },
// };

UpdateStageCommand Input

See UpdateStageCommandInput for more details

Parameter
Type
Description
arn
Required
string | undefined

ARN of the stage to be updated.

autoParticipantRecordingConfiguration
AutoParticipantRecordingConfiguration | undefined

Configuration object for individual participant recording, to attach to the stage. Note that this cannot be updated while recording is active.

name
string | undefined

Name of the stage to be updated.

UpdateStageCommand Output

See UpdateStageCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
stage
Stage | undefined

The updated stage.

Throws

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