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 Chime SDK Media Pipelines CreateMediaCapturePipeline API operation.

Syntax

New-CHMMPMediaCapturePipeline
-ActiveSpeakerOnlyConfiguration_ActiveSpeakerPosition <ActiveSpeakerPosition>
-SelectedVideoStreams_AttendeeId <String[]>
-SseAwsKeyManagementParams_AwsKmsEncryptionContext <String>
-SseAwsKeyManagementParams_AwsKmsKeyId <String>
-VideoAttribute_BorderColor <BorderColor>
-VideoAttribute_BorderThickness <Int32>
-GridViewConfiguration_CanvasOrientation <CanvasOrientation>
-ClientRequestToken <String>
-GridViewConfiguration_ContentShareLayout <ContentShareLayoutOption>
-VideoAttribute_CornerRadius <Int32>
-SelectedVideoStreams_ExternalUserId <String[]>
-VideoAttribute_HighlightColor <HighlightColor>
-CompositedVideo_Layout <LayoutOption>
-Audio_MuxType <AudioMuxType>
-Content_MuxType <ContentMuxType>
-Video_MuxType <VideoMuxType>
-PresenterOnlyConfiguration_PresenterPosition <PresenterPosition>
-CompositedVideo_Resolution <ResolutionOption>
-SinkArn <String>
-SinkIamRoleArn <String>
-SinkType <MediaPipelineSinkType>
-SourceArn <String>
-SourceType <MediaPipelineSourceType>
-Content_State <ArtifactsState>
-Video_State <ArtifactsState>
-Tag <Tag[]>
-HorizontalLayoutConfiguration_TileAspectRatio <String>
-VerticalLayoutConfiguration_TileAspectRatio <String>
-HorizontalLayoutConfiguration_TileCount <Int32>
-VerticalLayoutConfiguration_TileCount <Int32>
-HorizontalLayoutConfiguration_TileOrder <TileOrder>
-VerticalLayoutConfiguration_TileOrder <TileOrder>
-HorizontalLayoutConfiguration_TilePosition <HorizontalTilePosition>
-VerticalLayoutConfiguration_TilePosition <VerticalTilePosition>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonChimeSDKMediaPipelinesConfig>

Description

Creates a media pipeline.

Parameters

-ActiveSpeakerOnlyConfiguration_ActiveSpeakerPosition <ActiveSpeakerPosition>
The position of the ActiveSpeakerOnly video tile.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesChimeSdkMeetingConfiguration_ArtifactsConfiguration_CompositedVideo_GridViewConfiguration_ActiveSpeakerOnlyConfiguration_ActiveSpeakerPosition
-Audio_MuxType <AudioMuxType>
The MUX type of the audio artifact configuration object.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesChimeSdkMeetingConfiguration_ArtifactsConfiguration_Audio_MuxType
-ClientConfig <AmazonChimeSDKMediaPipelinesConfig>
Amazon.PowerShell.Cmdlets.CHMMP.AmazonChimeSDKMediaPipelinesClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientRequestToken <String>
The unique identifier for the client request. The token makes the API request idempotent. Use a unique token for each media pipeline request.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CompositedVideo_Layout <LayoutOption>
The layout setting, such as GridView in the configuration object.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesChimeSdkMeetingConfiguration_ArtifactsConfiguration_CompositedVideo_Layout
-CompositedVideo_Resolution <ResolutionOption>
The video resolution setting in the configuration object. Default: HD at 1280 x 720. FHD resolution: 1920 x 1080.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesChimeSdkMeetingConfiguration_ArtifactsConfiguration_CompositedVideo_Resolution
-Content_MuxType <ContentMuxType>
The MUX type of the artifact configuration.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesChimeSdkMeetingConfiguration_ArtifactsConfiguration_Content_MuxType
-Content_State <ArtifactsState>
Indicates whether the content artifact is enabled or disabled.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesChimeSdkMeetingConfiguration_ArtifactsConfiguration_Content_State
-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)
-GridViewConfiguration_CanvasOrientation <CanvasOrientation>
The orientation setting, horizontal or vertical.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesChimeSdkMeetingConfiguration_ArtifactsConfiguration_CompositedVideo_GridViewConfiguration_CanvasOrientation
-GridViewConfiguration_ContentShareLayout <ContentShareLayoutOption>
Defines the layout of the video tiles when content sharing is enabled.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesChimeSdkMeetingConfiguration_ArtifactsConfiguration_CompositedVideo_GridViewConfiguration_ContentShareLayout
-HorizontalLayoutConfiguration_TileAspectRatio <String>
Specifies the aspect ratio of all video tiles.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesChimeSdkMeetingConfiguration_ArtifactsConfiguration_CompositedVideo_GridViewConfiguration_HorizontalLayoutConfiguration_TileAspectRatio
-HorizontalLayoutConfiguration_TileCount <Int32>
The maximum number of video tiles to display.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesChimeSdkMeetingConfiguration_ArtifactsConfiguration_CompositedVideo_GridViewConfiguration_HorizontalLayoutConfiguration_TileCount
-HorizontalLayoutConfiguration_TileOrder <TileOrder>
Sets the automatic ordering of the video tiles.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesChimeSdkMeetingConfiguration_ArtifactsConfiguration_CompositedVideo_GridViewConfiguration_HorizontalLayoutConfiguration_TileOrder
-HorizontalLayoutConfiguration_TilePosition <HorizontalTilePosition>
Sets the position of horizontal tiles.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesChimeSdkMeetingConfiguration_ArtifactsConfiguration_CompositedVideo_GridViewConfiguration_HorizontalLayoutConfiguration_TilePosition
-PresenterOnlyConfiguration_PresenterPosition <PresenterPosition>
Defines the position of the presenter video tile. Default: TopRight.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesChimeSdkMeetingConfiguration_ArtifactsConfiguration_CompositedVideo_GridViewConfiguration_PresenterOnlyConfiguration_PresenterPosition
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'MediaCapturePipeline'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ChimeSDKMediaPipelines.Model.CreateMediaCapturePipelineResponse). Specifying the name of a property of type Amazon.ChimeSDKMediaPipelines.Model.CreateMediaCapturePipelineResponse 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)
-SelectedVideoStreams_AttendeeId <String[]>
The attendee IDs of the streams selected for a media pipeline. 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)
AliasesChimeSdkMeetingConfiguration_SourceConfiguration_SelectedVideoStreams_AttendeeIds
-SelectedVideoStreams_ExternalUserId <String[]>
The external user IDs of the streams selected for a media pipeline. 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)
AliasesChimeSdkMeetingConfiguration_SourceConfiguration_SelectedVideoStreams_ExternalUserIds
-SinkArn <String>
The ARN of the sink type.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-SinkIamRoleArn <String>
The Amazon Resource Name (ARN) of the sink role to be used with AwsKmsKeyId in SseAwsKeyManagementParams. Can only interact with S3Bucket sink type. The role must belong to the caller’s account and be able to act on behalf of the caller during the API call. All minimum policy permissions requirements for the caller to perform sink-related actions are the same for SinkIamRoleArn.Additionally, the role must have permission to kms:GenerateDataKey using KMS key supplied as AwsKmsKeyId in SseAwsKeyManagementParams. If media concatenation will be required later, the role must also have permission to kms:Decrypt for the same KMS key.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SinkType <MediaPipelineSinkType>
Destination type to which the media artifacts are saved. You must use an S3 bucket.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-SourceArn <String>
ARN of the source from which the media artifacts are captured.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-SourceType <MediaPipelineSourceType>
Source type from which the media artifacts are captured. A Chime SDK Meeting is the only supported source.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-SseAwsKeyManagementParams_AwsKmsEncryptionContext <String>
Base64-encoded string of a UTF-8 encoded JSON, which contains the encryption context as non-secret key-value pair known as encryption context pairs, that provides an added layer of security for your data. For more information, see KMS encryption context and Asymmetric keys in KMS in the Key Management Service Developer Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SseAwsKeyManagementParams_AwsKmsKeyId <String>
The KMS key you want to use to encrypt your media pipeline output. Decryption is required for concatenation pipeline. If using a key located in the current Amazon Web Services account, you can specify your KMS key in one of four ways:
  • Use the KMS key ID itself. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
  • Use an alias for the KMS key ID. For example, alias/ExampleAlias.
  • Use the Amazon Resource Name (ARN) for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.
  • Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias.
If using a key located in a different Amazon Web Services account than the current Amazon Web Services account, you can specify your KMS key in one of two ways:
  • Use the ARN for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.
  • Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias.
If you don't specify an encryption key, your output is encrypted with the default Amazon S3 key (SSE-S3).Note that the role specified in the SinkIamRoleArn request parameter must have permission to use the specified KMS key.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Tag <Tag[]>
The tag key-value pairs. 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
-VerticalLayoutConfiguration_TileAspectRatio <String>
Sets the aspect ratio of the video tiles, such as 16:9.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesChimeSdkMeetingConfiguration_ArtifactsConfiguration_CompositedVideo_GridViewConfiguration_VerticalLayoutConfiguration_TileAspectRatio
-VerticalLayoutConfiguration_TileCount <Int32>
The maximum number of tiles to display.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesChimeSdkMeetingConfiguration_ArtifactsConfiguration_CompositedVideo_GridViewConfiguration_VerticalLayoutConfiguration_TileCount
-VerticalLayoutConfiguration_TileOrder <TileOrder>
Sets the automatic ordering of the video tiles.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesChimeSdkMeetingConfiguration_ArtifactsConfiguration_CompositedVideo_GridViewConfiguration_VerticalLayoutConfiguration_TileOrder
-VerticalLayoutConfiguration_TilePosition <VerticalTilePosition>
Sets the position of vertical tiles.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesChimeSdkMeetingConfiguration_ArtifactsConfiguration_CompositedVideo_GridViewConfiguration_VerticalLayoutConfiguration_TilePosition
-Video_MuxType <VideoMuxType>
The MUX type of the video artifact configuration object.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesChimeSdkMeetingConfiguration_ArtifactsConfiguration_Video_MuxType
-Video_State <ArtifactsState>
Indicates whether the video artifact is enabled or disabled.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesChimeSdkMeetingConfiguration_ArtifactsConfiguration_Video_State
-VideoAttribute_BorderColor <BorderColor>
Defines the border color of all video tiles.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesChimeSdkMeetingConfiguration_ArtifactsConfiguration_CompositedVideo_GridViewConfiguration_VideoAttribute_BorderColor
-VideoAttribute_BorderThickness <Int32>
Defines the border thickness for all video tiles.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesChimeSdkMeetingConfiguration_ArtifactsConfiguration_CompositedVideo_GridViewConfiguration_VideoAttribute_BorderThickness
-VideoAttribute_CornerRadius <Int32>
Sets the corner radius of all video tiles.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesChimeSdkMeetingConfiguration_ArtifactsConfiguration_CompositedVideo_GridViewConfiguration_VideoAttribute_CornerRadius
-VideoAttribute_HighlightColor <HighlightColor>
Defines the highlight color for the active video tile.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesChimeSdkMeetingConfiguration_ArtifactsConfiguration_CompositedVideo_GridViewConfiguration_VideoAttribute_HighlightColor

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.ChimeSDKMediaPipelines.Model.MediaCapturePipeline or Amazon.ChimeSDKMediaPipelines.Model.CreateMediaCapturePipelineResponse
This cmdlet returns an Amazon.ChimeSDKMediaPipelines.Model.MediaCapturePipeline object. The service call response (type Amazon.ChimeSDKMediaPipelines.Model.CreateMediaCapturePipelineResponse) can be returned by specifying '-Select *'.
AWS Tools for PowerShell User Guide

Supported Version

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