AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon Interactive Video Service RealTime StartComposition API operation.

Syntax

Start-IVSRTComposition
-StageArn <String>
-Destination <DestinationConfiguration[]>
-Grid_FeaturedParticipantAttribute <String>
-Pip_FeaturedParticipantAttribute <String>
-Grid_GridGap <Int32>
-Pip_GridGap <Int32>
-IdempotencyToken <String>
-Grid_OmitStoppedVideo <Boolean>
-Pip_OmitStoppedVideo <Boolean>
-Grid_ParticipantOrderAttribute <String>
-Pip_ParticipantOrderAttribute <String>
-Pip_PipBehavior <PipBehavior>
-Pip_PipHeight <Int32>
-Pip_PipOffset <Int32>
-Pip_PipParticipantAttribute <String>
-Pip_PipPosition <PipPosition>
-Pip_PipWidth <Int32>
-Tag <Hashtable>
-Grid_VideoAspectRatio <VideoAspectRatio>
-Grid_VideoFillMode <VideoFillMode>
-Pip_VideoFillMode <VideoFillMode>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonIVSRealTimeConfig>

Description

Starts a Composition from a stage based on the configuration provided in the request. A Composition is an ephemeral resource that exists after this operation returns successfully. Composition stops and the resource is deleted:
  • When StopComposition is called.
  • After a 1-minute timeout, when all participants are disconnected from the stage.
  • After a 1-minute timeout, if there are no participants in the stage when StartComposition is called.
  • When broadcasting to the IVS channel fails and all retries are exhausted.
  • When broadcasting is disconnected and all attempts to reconnect are exhausted.

Parameters

-ClientConfig <AmazonIVSRealTimeConfig>
Amazon.PowerShell.Cmdlets.IVSRT.AmazonIVSRealTimeClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Destination <DestinationConfiguration[]>
Array of destination configuration. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDestinations
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Grid_FeaturedParticipantAttribute <String>
This attribute name identifies the featured slot. A participant with this attribute set to "true" (as a string value) in ParticipantTokenConfiguration is placed in the featured slot. Default: "" (no featured participant).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLayout_Grid_FeaturedParticipantAttribute
-Grid_GridGap <Int32>
Specifies the spacing between participant tiles in pixels. Default: 2.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLayout_Grid_GridGap
-Grid_OmitStoppedVideo <Boolean>
Determines whether to omit participants with stopped video in the composition. Default: false.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLayout_Grid_OmitStoppedVideo
-Grid_ParticipantOrderAttribute <String>
Attribute name in ParticipantTokenConfiguration identifying the participant ordering key. Participants with participantOrderAttribute set to "" or not specified are ordered based on their arrival time into the stage.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLayout_Grid_ParticipantOrderAttribute
-Grid_VideoAspectRatio <VideoAspectRatio>
Sets the non-featured participant display mode, to control the aspect ratio of video tiles. VIDEO is 16:9, SQUARE is 1:1, and PORTRAIT is 3:4. Default: VIDEO.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLayout_Grid_VideoAspectRatio
-Grid_VideoFillMode <VideoFillMode>
Defines how video content fits within the participant tile: FILL (stretched), COVER (cropped), or CONTAIN (letterboxed). When not set, videoFillMode defaults to COVER fill mode for participants in the grid and to CONTAIN fill mode for featured participants.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLayout_Grid_VideoFillMode
-IdempotencyToken <String>
Idempotency token.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Pip_FeaturedParticipantAttribute <String>
This attribute name identifies the featured slot. A participant with this attribute set to "true" (as a string value) in ParticipantTokenConfiguration is placed in the featured slot. Default: "" (no featured participant).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLayout_Pip_FeaturedParticipantAttribute
-Pip_GridGap <Int32>
Specifies the spacing between participant tiles in pixels. Default: 0.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLayout_Pip_GridGap
-Pip_OmitStoppedVideo <Boolean>
Determines whether to omit participants with stopped video in the composition. Default: false.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLayout_Pip_OmitStoppedVideo
-Pip_ParticipantOrderAttribute <String>
Attribute name in ParticipantTokenConfiguration identifying the participant ordering key. Participants with participantOrderAttribute set to "" or not specified are ordered based on their arrival time into the stage.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLayout_Pip_ParticipantOrderAttribute
-Pip_PipBehavior <PipBehavior>
Defines PiP behavior when all participants have left: STATIC (maintains original position/size) or DYNAMIC (expands to full composition). Default: STATIC.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLayout_Pip_PipBehavior
-Pip_PipHeight <Int32>
Specifies the height of the PiP window in pixels. When this is not set explicitly, pipHeight’s value will be based on the size of the composition and the aspect ratio of the participant’s video.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLayout_Pip_PipHeight
-Pip_PipOffset <Int32>
Sets the PiP window’s offset position in pixels from the closest edges determined by PipPosition. Default: 0.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLayout_Pip_PipOffset
-Pip_PipParticipantAttribute <String>
Specifies the participant for the PiP window. A participant with this attribute set to "true" (as a string value) in ParticipantTokenConfiguration is placed in the PiP slot. Default: "" (no PiP participant).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLayout_Pip_PipParticipantAttribute
-Pip_PipPosition <PipPosition>
Determines the corner position of the PiP window. Default: BOTTOM_RIGHT.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLayout_Pip_PipPosition
-Pip_PipWidth <Int32>
Specifies the width of the PiP window in pixels. When this is not set explicitly, pipWidth’s value will be based on the size of the composition and the aspect ratio of the participant’s video.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLayout_Pip_PipWidth
-Pip_VideoFillMode <VideoFillMode>
Defines how video content fits within the participant tile: FILL (stretched), COVER (cropped), or CONTAIN (letterboxed). Default: COVER.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLayout_Pip_VideoFillMode
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'Composition'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IVSRealTime.Model.StartCompositionResponse). Specifying the name of a property of type Amazon.IVSRealTime.Model.StartCompositionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-StageArn <String>
ARN of the stage to be used for compositing.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-Tag <Hashtable>
Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.IVSRealTime.Model.Composition or Amazon.IVSRealTime.Model.StartCompositionResponse
This cmdlet returns an Amazon.IVSRealTime.Model.Composition object. The service call response (type Amazon.IVSRealTime.Model.StartCompositionResponse) can be returned by specifying '-Select *'.
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z