GetCompositionCommand

Get information about the specified Composition resource.

Example Syntax

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

import { IVSRealTimeClient, GetCompositionCommand } from "@aws-sdk/client-ivs-realtime"; // ES Modules import
// const { IVSRealTimeClient, GetCompositionCommand } = require("@aws-sdk/client-ivs-realtime"); // CommonJS import
const client = new IVSRealTimeClient(config);
const input = { // GetCompositionRequest
  arn: "STRING_VALUE", // required
};
const command = new GetCompositionCommand(input);
const response = await client.send(command);
// { // GetCompositionResponse
//   composition: { // Composition
//     arn: "STRING_VALUE", // required
//     stageArn: "STRING_VALUE", // required
//     state: "STRING_VALUE", // required
//     layout: { // LayoutConfiguration
//       grid: { // GridConfiguration
//         featuredParticipantAttribute: "STRING_VALUE",
//         omitStoppedVideo: true || false,
//         videoAspectRatio: "AUTO" || "VIDEO" || "SQUARE" || "PORTRAIT",
//         videoFillMode: "FILL" || "COVER" || "CONTAIN",
//         gridGap: Number("int"),
//       },
//       pip: { // PipConfiguration
//         featuredParticipantAttribute: "STRING_VALUE",
//         omitStoppedVideo: true || false,
//         videoFillMode: "FILL" || "COVER" || "CONTAIN",
//         gridGap: Number("int"),
//         pipParticipantAttribute: "STRING_VALUE",
//         pipBehavior: "STATIC" || "DYNAMIC",
//         pipOffset: Number("int"),
//         pipPosition: "TOP_LEFT" || "TOP_RIGHT" || "BOTTOM_LEFT" || "BOTTOM_RIGHT",
//         pipWidth: Number("int"),
//         pipHeight: Number("int"),
//       },
//     },
//     destinations: [ // DestinationList // required
//       { // Destination
//         id: "STRING_VALUE", // required
//         state: "STRING_VALUE", // required
//         startTime: new Date("TIMESTAMP"),
//         endTime: new Date("TIMESTAMP"),
//         configuration: { // DestinationConfiguration
//           name: "STRING_VALUE",
//           channel: { // ChannelDestinationConfiguration
//             channelArn: "STRING_VALUE", // required
//             encoderConfigurationArn: "STRING_VALUE",
//           },
//           s3: { // S3DestinationConfiguration
//             storageConfigurationArn: "STRING_VALUE", // required
//             encoderConfigurationArns: [ // EncoderConfigurationArnList // required
//               "STRING_VALUE",
//             ],
//             recordingConfiguration: { // RecordingConfiguration
//               hlsConfiguration: { // CompositionRecordingHlsConfiguration
//                 targetSegmentDurationSeconds: Number("int"),
//               },
//               format: "STRING_VALUE",
//             },
//             thumbnailConfigurations: [ // CompositionThumbnailConfigurationList
//               { // CompositionThumbnailConfiguration
//                 targetIntervalSeconds: Number("int"),
//                 storage: [ // ThumbnailStorageTypeList
//                   "SEQUENTIAL" || "LATEST",
//                 ],
//               },
//             ],
//           },
//         },
//         detail: { // DestinationDetail
//           s3: { // S3Detail
//             recordingPrefix: "STRING_VALUE", // required
//           },
//         },
//       },
//     ],
//     tags: { // Tags
//       "<keys>": "STRING_VALUE",
//     },
//     startTime: new Date("TIMESTAMP"),
//     endTime: new Date("TIMESTAMP"),
//   },
// };

GetCompositionCommand Input

See GetCompositionCommandInput for more details

Parameter
Type
Description
arn
Required
string | undefined

ARN of the Composition resource.

GetCompositionCommand Output

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
composition
Composition | undefined

The Composition 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.