import { Command as $Command } from "@smithy/smithy-client"; import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { IVSRealTimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IVSRealTimeClient"; import type { GetCompositionRequest, GetCompositionResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link GetCompositionCommand}. */ export interface GetCompositionCommandInput extends GetCompositionRequest { } /** * @public * * The output of {@link GetCompositionCommand}. */ export interface GetCompositionCommandOutput extends GetCompositionResponse, __MetadataBearer { } declare const GetCompositionCommand_base: { new (input: GetCompositionCommandInput): import("@smithy/smithy-client").CommandImpl; new (input: GetCompositionCommandInput): import("@smithy/smithy-client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** *

Get information about the specified Composition resource.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { IVSRealTimeClient, GetCompositionCommand } from "@aws-sdk/client-ivs-realtime"; // ES Modules import * // const { IVSRealTimeClient, GetCompositionCommand } = require("@aws-sdk/client-ivs-realtime"); // CommonJS import * // import type { IVSRealTimeClientConfig } from "@aws-sdk/client-ivs-realtime"; * const config = {}; // type is IVSRealTimeClientConfig * 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"), * // participantOrderAttribute: "STRING_VALUE", * // }, * // 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"), * // participantOrderAttribute: "STRING_VALUE", * // }, * // }, * // 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 * // "": "STRING_VALUE", * // }, * // startTime: new Date("TIMESTAMP"), * // endTime: new Date("TIMESTAMP"), * // }, * // }; * * ``` * * @param GetCompositionCommandInput - {@link GetCompositionCommandInput} * @returns {@link GetCompositionCommandOutput} * @see {@link GetCompositionCommandInput} for command's `input` shape. * @see {@link GetCompositionCommandOutput} for command's `response` shape. * @see {@link IVSRealTimeClientResolvedConfig | config} for IVSRealTimeClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) *

* * @throws {@link ConflictException} (client fault) *

* * @throws {@link InternalServerException} (server fault) *

* * @throws {@link ResourceNotFoundException} (client fault) *

* * @throws {@link ServiceQuotaExceededException} (client fault) *

* * @throws {@link ValidationException} (client fault) *

* * @throws {@link IVSRealTimeServiceException} *

Base exception class for all service exceptions from IVSRealTime service.

* * * @public */ export declare class GetCompositionCommand extends GetCompositionCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: GetCompositionRequest; output: GetCompositionResponse; }; sdk: { input: GetCompositionCommandInput; output: GetCompositionCommandOutput; }; }; }