AWS.Tools.ChimeSDKMeetings.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.ChimeSDKMeetings</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.CHMTG.AddCHMTGResourceTagCmdlet"> <summary> The resource that supports tags. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.AddCHMTGResourceTagCmdlet.ResourceARN"> <summary> <para> <para>The ARN of the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.AddCHMTGResourceTagCmdlet.Tag"> <summary> <para> <para>Lists the requested tags.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.AddCHMTGResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ChimeSDKMeetings.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.AddCHMTGResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceARN parameter. The -PassThru parameter is deprecated, use -Select '^ResourceARN' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.AddCHMTGResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CHMTG.GetCHMTGAttendeeCmdlet"> <summary> Gets the Amazon Chime SDK attendee details for a specified meeting ID and attendee ID. For more information about the Amazon Chime SDK, see <a href="https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html">Using the Amazon Chime SDK</a> in the <i>Amazon Chime Developer Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.GetCHMTGAttendeeCmdlet.AttendeeId"> <summary> <para> <para>The Amazon Chime SDK attendee ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.GetCHMTGAttendeeCmdlet.MeetingId"> <summary> <para> <para>The Amazon Chime SDK meeting ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.GetCHMTGAttendeeCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Attendee'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ChimeSDKMeetings.Model.GetAttendeeResponse). Specifying the name of a property of type Amazon.ChimeSDKMeetings.Model.GetAttendeeResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.GetCHMTGAttendeeCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AttendeeId parameter. The -PassThru parameter is deprecated, use -Select '^AttendeeId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CHMTG.GetCHMTGAttendeeListCmdlet"> <summary> Lists the attendees for the specified Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see <a href="https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html">Using the Amazon Chime SDK</a> in the <i>Amazon Chime Developer Guide</i>.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.GetCHMTGAttendeeListCmdlet.MeetingId"> <summary> <para> <para>The Amazon Chime SDK meeting ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.GetCHMTGAttendeeListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in a single call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.GetCHMTGAttendeeListCmdlet.NextToken"> <summary> <para> <para>The token to use to retrieve the next page of results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.GetCHMTGAttendeeListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Attendees'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ChimeSDKMeetings.Model.ListAttendeesResponse). Specifying the name of a property of type Amazon.ChimeSDKMeetings.Model.ListAttendeesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.GetCHMTGAttendeeListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the MeetingId parameter. The -PassThru parameter is deprecated, use -Select '^MeetingId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.GetCHMTGAttendeeListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CHMTG.GetCHMTGMeetingCmdlet"> <summary> Gets the Amazon Chime SDK meeting details for the specified meeting ID. For more information about the Amazon Chime SDK, see <a href="https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html">Using the Amazon Chime SDK</a> in the <i>Amazon Chime Developer Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.GetCHMTGMeetingCmdlet.MeetingId"> <summary> <para> <para>The Amazon Chime SDK meeting ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.GetCHMTGMeetingCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Meeting'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ChimeSDKMeetings.Model.GetMeetingResponse). Specifying the name of a property of type Amazon.ChimeSDKMeetings.Model.GetMeetingResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.GetCHMTGMeetingCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the MeetingId parameter. The -PassThru parameter is deprecated, use -Select '^MeetingId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CHMTG.GetCHMTGResourceTagCmdlet"> <summary> Returns a list of the tags available for the specified resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.GetCHMTGResourceTagCmdlet.ResourceARN"> <summary> <para> <para>The ARN of the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.GetCHMTGResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Tags'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ChimeSDKMeetings.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.ChimeSDKMeetings.Model.ListTagsForResourceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.GetCHMTGResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceARN parameter. The -PassThru parameter is deprecated, use -Select '^ResourceARN' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CHMTG.NewCHMTGAttendeeCmdlet"> <summary> Creates a new attendee for an active Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see <a href="https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html">Using the Amazon Chime SDK</a> in the <i>Amazon Chime Developer Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.NewCHMTGAttendeeCmdlet.Capabilities_Audio"> <summary> <para> <para>The audio capability assigned to an attendee.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.NewCHMTGAttendeeCmdlet.Capabilities_Content"> <summary> <para> <para>The content capability assigned to an attendee.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.NewCHMTGAttendeeCmdlet.ExternalUserId"> <summary> <para> <para>The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.</para><para>Pattern: <c>[-_&@+=,(){}\[\]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*</c></para><para>Values that begin with <c>aws:</c> are reserved. You can't configure a value that uses this prefix.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.NewCHMTGAttendeeCmdlet.MeetingId"> <summary> <para> <para>The unique ID of the meeting.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.NewCHMTGAttendeeCmdlet.Capabilities_Video"> <summary> <para> <para>The video capability assigned to an attendee.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.NewCHMTGAttendeeCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Attendee'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ChimeSDKMeetings.Model.CreateAttendeeResponse). Specifying the name of a property of type Amazon.ChimeSDKMeetings.Model.CreateAttendeeResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.NewCHMTGAttendeeCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ExternalUserId parameter. The -PassThru parameter is deprecated, use -Select '^ExternalUserId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.NewCHMTGAttendeeCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CHMTG.NewCHMTGAttendeeBatchCmdlet"> <summary> Creates up to 100 attendees for an active Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see <a href="https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html">Using the Amazon Chime SDK</a> in the <i>Amazon Chime Developer Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.NewCHMTGAttendeeBatchCmdlet.Attendee"> <summary> <para> <para>The attendee information, including attendees' IDs and join tokens.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.NewCHMTGAttendeeBatchCmdlet.MeetingId"> <summary> <para> <para>The Amazon Chime SDK ID of the meeting to which you're adding attendees.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.NewCHMTGAttendeeBatchCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ChimeSDKMeetings.Model.BatchCreateAttendeeResponse). Specifying the name of a property of type Amazon.ChimeSDKMeetings.Model.BatchCreateAttendeeResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.NewCHMTGAttendeeBatchCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the MeetingId parameter. The -PassThru parameter is deprecated, use -Select '^MeetingId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.NewCHMTGAttendeeBatchCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CHMTG.NewCHMTGMeetingCmdlet"> <summary> Creates a new Amazon Chime SDK meeting in the specified media Region with no initial attendees. For more information about specifying media Regions, see <a href="https://docs.aws.amazon.com/chime/latest/dg/chime-sdk-meetings-regions.html">Amazon Chime SDK Media Regions</a> in the <i>Amazon Chime Developer Guide</i>. For more information about the Amazon Chime SDK, see <a href="https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html">Using the Amazon Chime SDK</a> in the <i>Amazon Chime Developer Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.NewCHMTGMeetingCmdlet.ClientRequestToken"> <summary> <para> <para>The unique identifier for the client request. Use a different token for different meetings.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.NewCHMTGMeetingCmdlet.Audio_EchoReduction"> <summary> <para> <para>Makes echo reduction available to clients who connect to the meeting.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.NewCHMTGMeetingCmdlet.ExternalMeetingId"> <summary> <para> <para>The external meeting ID.</para><para>Pattern: <c>[-_&@+=,(){}\[\]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*</c></para><para>Values that begin with <c>aws:</c> are reserved. You can't configure a value that uses this prefix. Case insensitive.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.NewCHMTGMeetingCmdlet.NotificationsConfiguration_LambdaFunctionArn"> <summary> <para> <para>The ARN of the Amazon Web Services Lambda function in the notifications configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.NewCHMTGMeetingCmdlet.Attendee_MaxCount"> <summary> <para> <para>The maximum number of attendees allowed into the meeting.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.NewCHMTGMeetingCmdlet.Content_MaxResolution"> <summary> <para> <para>The maximum resolution for the meeting content.</para><note><para>Defaults to <c>FHD</c>. To use <c>UHD</c>, you must also provide a <c>MeetingFeatures:Attendee:MaxCount</c> value and override the default size limit of 250 attendees.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.NewCHMTGMeetingCmdlet.Video_MaxResolution"> <summary> <para> <para>The maximum video resolution for the meeting. Applies to all attendees.</para><note><para>Defaults to <c>HD</c>. To use <c>FHD</c>, you must also provide a <c>MeetingFeatures:Attendee:MaxCount</c> value and override the default size limit of 250 attendees.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.NewCHMTGMeetingCmdlet.MediaRegion"> <summary> <para> <para>The Region in which to create the meeting.</para><para> Available values: <c>af-south-1</c>, <c>ap-northeast-1</c>, <c>ap-northeast-2</c>, <c>ap-south-1</c>, <c>ap-southeast-1</c>, <c>ap-southeast-2</c>, <c>ca-central-1</c>, <c>eu-central-1</c>, <c>eu-north-1</c>, <c>eu-south-1</c>, <c>eu-west-1</c>, <c>eu-west-2</c>, <c>eu-west-3</c>, <c>sa-east-1</c>, <c>us-east-1</c>, <c>us-east-2</c>, <c>us-west-1</c>, <c>us-west-2</c>. </para><para>Available values in Amazon Web Services GovCloud (US) Regions: <c>us-gov-east-1</c>, <c>us-gov-west-1</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.NewCHMTGMeetingCmdlet.MeetingHostId"> <summary> <para> <para>Reserved.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.NewCHMTGMeetingCmdlet.PrimaryMeetingId"> <summary> <para> <para>When specified, replicates the media from the primary meeting to the new meeting.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.NewCHMTGMeetingCmdlet.NotificationsConfiguration_SnsTopicArn"> <summary> <para> <para>The ARN of the SNS topic.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.NewCHMTGMeetingCmdlet.NotificationsConfiguration_SqsQueueArn"> <summary> <para> <para>The ARN of the SQS queue.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.NewCHMTGMeetingCmdlet.Tag"> <summary> <para> <para>Applies one or more tags to an Amazon Chime SDK meeting. Note the following:</para><ul><li><para>Not all resources have tags. For a list of services with resources that support tagging using this operation, see <a href="https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/supported-services.html">Services that support the Resource Groups Tagging API</a>. If the resource doesn't yet support this operation, the resource's service might support tagging using its own API operations. For more information, refer to the documentation for that service.</para></li><li><para>Each resource can have up to 50 tags. For other limits, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions">Tag Naming and Usage Conventions</a> in the <i>AWS General Reference</i>.</para></li><li><para>You can only tag resources that are located in the specified Amazon Web Services Region for the Amazon Web Services account.</para></li><li><para>To add tags to a resource, you need the necessary permissions for the service that the resource belongs to as well as permissions for adding tags. For more information, see the documentation for each service.</para></li></ul><important><para>Do not store personally identifiable information (PII) or other confidential or sensitive information in tags. We use tags to provide you with billing and administration services. Tags are not intended to be used for private or sensitive data.</para></important><para><b>Minimum permissions</b></para><para>In addition to the <c>tag:TagResources</c> permission required by this operation, you must also have the tagging permission defined by the service that created the resource. For example, to tag a <c>ChimeSDKMeetings</c> instance using the <c>TagResources</c> operation, you must have both of the following permissions:</para><para><c>tag:TagResources</c></para><para><c>ChimeSDKMeetings:CreateTags</c></para><note><para>Some services might have specific requirements for tagging some resources. For example, to tag an Amazon S3 bucket, you must also have the <c>s3:GetBucketTagging</c> permission. If the expected minimum permissions don't work, check the documentation for that service's tagging APIs for more information.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.NewCHMTGMeetingCmdlet.TenantId"> <summary> <para> <para>A consistent and opaque identifier, created and maintained by the builder to represent a segment of their users.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.NewCHMTGMeetingCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Meeting'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ChimeSDKMeetings.Model.CreateMeetingResponse). Specifying the name of a property of type Amazon.ChimeSDKMeetings.Model.CreateMeetingResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.NewCHMTGMeetingCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ClientRequestToken parameter. The -PassThru parameter is deprecated, use -Select '^ClientRequestToken' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.NewCHMTGMeetingCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CHMTG.NewCHMTGMeetingWithAttendeeCmdlet"> <summary> Creates a new Amazon Chime SDK meeting in the specified media Region, with attendees. For more information about specifying media Regions, see <a href="https://docs.aws.amazon.com/chime/latest/dg/chime-sdk-meetings-regions.html">Amazon Chime SDK Media Regions</a> in the <i>Amazon Chime Developer Guide</i>. For more information about the Amazon Chime SDK, see <a href="https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html">Using the Amazon Chime SDK</a> in the <i>Amazon Chime Developer Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.NewCHMTGMeetingWithAttendeeCmdlet.Attendee"> <summary> <para> <para>The attendee information, including attendees' IDs and join tokens.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.NewCHMTGMeetingWithAttendeeCmdlet.ClientRequestToken"> <summary> <para> <para>The unique identifier for the client request. Use a different token for different meetings.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.NewCHMTGMeetingWithAttendeeCmdlet.Audio_EchoReduction"> <summary> <para> <para>Makes echo reduction available to clients who connect to the meeting.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.NewCHMTGMeetingWithAttendeeCmdlet.ExternalMeetingId"> <summary> <para> <para>The external meeting ID.</para><para>Pattern: <c>[-_&@+=,(){}\[\]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*</c></para><para>Values that begin with <c>aws:</c> are reserved. You can't configure a value that uses this prefix. Case insensitive.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.NewCHMTGMeetingWithAttendeeCmdlet.NotificationsConfiguration_LambdaFunctionArn"> <summary> <para> <para>The ARN of the Amazon Web Services Lambda function in the notifications configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.NewCHMTGMeetingWithAttendeeCmdlet.Attendee_MaxCount"> <summary> <para> <para>The maximum number of attendees allowed into the meeting.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.NewCHMTGMeetingWithAttendeeCmdlet.Content_MaxResolution"> <summary> <para> <para>The maximum resolution for the meeting content.</para><note><para>Defaults to <c>FHD</c>. To use <c>UHD</c>, you must also provide a <c>MeetingFeatures:Attendee:MaxCount</c> value and override the default size limit of 250 attendees.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.NewCHMTGMeetingWithAttendeeCmdlet.Video_MaxResolution"> <summary> <para> <para>The maximum video resolution for the meeting. Applies to all attendees.</para><note><para>Defaults to <c>HD</c>. To use <c>FHD</c>, you must also provide a <c>MeetingFeatures:Attendee:MaxCount</c> value and override the default size limit of 250 attendees.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.NewCHMTGMeetingWithAttendeeCmdlet.MediaRegion"> <summary> <para> <para>The Region in which to create the meeting.</para><para> Available values: <c>af-south-1</c>, <c>ap-northeast-1</c>, <c>ap-northeast-2</c>, <c>ap-south-1</c>, <c>ap-southeast-1</c>, <c>ap-southeast-2</c>, <c>ca-central-1</c>, <c>eu-central-1</c>, <c>eu-north-1</c>, <c>eu-south-1</c>, <c>eu-west-1</c>, <c>eu-west-2</c>, <c>eu-west-3</c>, <c>sa-east-1</c>, <c>us-east-1</c>, <c>us-east-2</c>, <c>us-west-1</c>, <c>us-west-2</c>. </para><para>Available values in Amazon Web Services GovCloud (US) Regions: <c>us-gov-east-1</c>, <c>us-gov-west-1</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.NewCHMTGMeetingWithAttendeeCmdlet.MeetingHostId"> <summary> <para> <para>Reserved.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.NewCHMTGMeetingWithAttendeeCmdlet.PrimaryMeetingId"> <summary> <para> <para>When specified, replicates the media from the primary meeting to the new meeting.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.NewCHMTGMeetingWithAttendeeCmdlet.NotificationsConfiguration_SnsTopicArn"> <summary> <para> <para>The ARN of the SNS topic.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.NewCHMTGMeetingWithAttendeeCmdlet.NotificationsConfiguration_SqsQueueArn"> <summary> <para> <para>The ARN of the SQS queue.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.NewCHMTGMeetingWithAttendeeCmdlet.Tag"> <summary> <para> <para>The tags in the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.NewCHMTGMeetingWithAttendeeCmdlet.TenantId"> <summary> <para> <para>A consistent and opaque identifier, created and maintained by the builder to represent a segment of their users.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.NewCHMTGMeetingWithAttendeeCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ChimeSDKMeetings.Model.CreateMeetingWithAttendeesResponse). Specifying the name of a property of type Amazon.ChimeSDKMeetings.Model.CreateMeetingWithAttendeesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.NewCHMTGMeetingWithAttendeeCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ClientRequestToken parameter. The -PassThru parameter is deprecated, use -Select '^ClientRequestToken' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.NewCHMTGMeetingWithAttendeeCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CHMTG.RemoveCHMTGAttendeeCmdlet"> <summary> Deletes an attendee from the specified Amazon Chime SDK meeting and deletes their <c>JoinToken</c>. Attendees are automatically deleted when a Amazon Chime SDK meeting is deleted. For more information about the Amazon Chime SDK, see <a href="https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html">Using the Amazon Chime SDK</a> in the <i>Amazon Chime Developer Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.RemoveCHMTGAttendeeCmdlet.AttendeeId"> <summary> <para> <para>The Amazon Chime SDK attendee ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.RemoveCHMTGAttendeeCmdlet.MeetingId"> <summary> <para> <para>The Amazon Chime SDK meeting ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.RemoveCHMTGAttendeeCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ChimeSDKMeetings.Model.DeleteAttendeeResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.RemoveCHMTGAttendeeCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AttendeeId parameter. The -PassThru parameter is deprecated, use -Select '^AttendeeId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.RemoveCHMTGAttendeeCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CHMTG.RemoveCHMTGMeetingCmdlet"> <summary> Deletes the specified Amazon Chime SDK meeting. The operation deletes all attendees, disconnects all clients, and prevents new clients from joining the meeting. For more information about the Amazon Chime SDK, see <a href="https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html">Using the Amazon Chime SDK</a> in the <i>Amazon Chime Developer Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.RemoveCHMTGMeetingCmdlet.MeetingId"> <summary> <para> <para>The Amazon Chime SDK meeting ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.RemoveCHMTGMeetingCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ChimeSDKMeetings.Model.DeleteMeetingResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.RemoveCHMTGMeetingCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the MeetingId parameter. The -PassThru parameter is deprecated, use -Select '^MeetingId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.RemoveCHMTGMeetingCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CHMTG.RemoveCHMTGResourceTagCmdlet"> <summary> Removes the specified tags from the specified resources. When you specify a tag key, the action removes both that key and its associated value. The operation succeeds even if you attempt to remove tags from a resource that were already removed. Note the following: <ul><li><para> To remove tags from a resource, you need the necessary permissions for the service that the resource belongs to as well as permissions for removing tags. For more information, see the documentation for the service whose resource you want to untag. </para></li><li><para> You can only tag resources that are located in the specified Amazon Web Services Region for the calling Amazon Web Services account. </para></li></ul><para><b>Minimum permissions</b></para><para> In addition to the <c>tag:UntagResources</c> permission required by this operation, you must also have the remove tags permission defined by the service that created the resource. For example, to remove the tags from an Amazon EC2 instance using the <c>UntagResources</c> operation, you must have both of the following permissions: </para><para><c>tag:UntagResource</c></para><para><c>ChimeSDKMeetings:DeleteTags</c></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.RemoveCHMTGResourceTagCmdlet.ResourceARN"> <summary> <para> <para>The ARN of the resource that you're removing tags from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.RemoveCHMTGResourceTagCmdlet.TagKey"> <summary> <para> <para>The tag keys being removed from the resources.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.RemoveCHMTGResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ChimeSDKMeetings.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.RemoveCHMTGResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceARN parameter. The -PassThru parameter is deprecated, use -Select '^ResourceARN' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.RemoveCHMTGResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CHMTG.StartCHMTGMeetingTranscriptionCmdlet"> <summary> Starts transcription for the specified <c>meetingId</c>. For more information, refer to <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/meeting-transcription.html"> Using Amazon Chime SDK live transcription </a> in the <i>Amazon Chime SDK Developer Guide</i>. <para> If you specify an invalid configuration, a <c>TranscriptFailed</c> event will be sent with the contents of the <c>BadRequestException</c> generated by Amazon Transcribe. For more information on each parameter and which combinations are valid, refer to the <a href="https://docs.aws.amazon.com/transcribe/latest/APIReference/API_streaming_StartStreamTranscription.html">StartStreamTranscription</a> API in the <i>Amazon Transcribe Developer Guide</i>. </para><note><para> By default, Amazon Transcribe may use and store audio content processed by the service to develop and improve Amazon Web Services AI/ML services as further described in section 50 of the <a href="https://aws.amazon.com/service-terms/">Amazon Web Services Service Terms</a>. Using Amazon Transcribe may be subject to federal and state laws or regulations regarding the recording or interception of electronic communications. It is your and your end users’ responsibility to comply with all applicable laws regarding the recording, including properly notifying all participants in a recorded session or communication that the session or communication is being recorded, and obtaining all necessary consents. You can opt out from Amazon Web Services using audio content to develop and improve AWS AI/ML services by configuring an AI services opt out policy using Amazon Web Services Organizations. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.StartCHMTGMeetingTranscriptionCmdlet.EngineTranscribeMedicalSettings_ContentIdentificationType"> <summary> <para> <para>Set this field to <c>PHI</c> to identify personal health information in the transcription output.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.StartCHMTGMeetingTranscriptionCmdlet.EngineTranscribeSettings_ContentIdentificationType"> <summary> <para> <para>Labels all personally identifiable information (PII) identified in your transcript. If you don't include <c>PiiEntityTypes</c>, all PII is identified.</para><note><para>You can’t set <c>ContentIdentificationType</c> and <c>ContentRedactionType</c>.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.StartCHMTGMeetingTranscriptionCmdlet.EngineTranscribeSettings_ContentRedactionType"> <summary> <para> <para>Content redaction is performed at the segment level. If you don't include <c>PiiEntityTypes</c>, all PII is redacted.</para><note><para>You can’t set <c>ContentRedactionType</c> and <c>ContentIdentificationType</c>.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.StartCHMTGMeetingTranscriptionCmdlet.EngineTranscribeSettings_EnablePartialResultsStabilization"> <summary> <para> <para>Enables partial result stabilization for your transcription. Partial result stabilization can reduce latency in your output, but may impact accuracy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.StartCHMTGMeetingTranscriptionCmdlet.EngineTranscribeSettings_IdentifyLanguage"> <summary> <para> <para>Enables automatic language identification for your transcription.</para><para>If you include <c>IdentifyLanguage</c>, you can optionally use <c>LanguageOptions</c> to include a list of language codes that you think may be present in your audio stream. Including language options can improve transcription accuracy.</para><para>You can also use <c>PreferredLanguage</c> to include a preferred language. Doing so can help Amazon Transcribe identify the language faster.</para><para>You must include either <c>LanguageCode</c> or <c>IdentifyLanguage</c>.</para><para>Language identification can't be combined with custom language models or redaction.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.StartCHMTGMeetingTranscriptionCmdlet.EngineTranscribeMedicalSettings_LanguageCode"> <summary> <para> <para>The language code specified for the Amazon Transcribe Medical engine.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.StartCHMTGMeetingTranscriptionCmdlet.EngineTranscribeSettings_LanguageCode"> <summary> <para> <para>Specify the language code that represents the language spoken.</para><para>If you're unsure of the language spoken in your audio, consider using <c>IdentifyLanguage</c> to enable automatic language identification.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.StartCHMTGMeetingTranscriptionCmdlet.EngineTranscribeSettings_LanguageModelName"> <summary> <para> <para>Specify the name of the custom language model that you want to use when processing your transcription. Note that language model names are case sensitive.</para><para>The language of the specified language model must match the language code. If the languages don't match, the custom language model isn't applied. There are no errors or warnings associated with a language mismatch.</para><para>If you use Amazon Transcribe in multiple Regions, the custom language model must be available in Amazon Transcribe in each Region.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.StartCHMTGMeetingTranscriptionCmdlet.EngineTranscribeSettings_LanguageOption"> <summary> <para> <para>Specify two or more language codes that represent the languages you think may be present in your media; including more than five is not recommended. If you're unsure what languages are present, do not include this parameter.</para><para>Including language options can improve the accuracy of language identification.</para><para>If you include <c>LanguageOptions</c>, you must also include <c>IdentifyLanguage</c>.</para><important><para>You can only include one language dialect per language. For example, you cannot include <c>en-US</c> and <c>en-AU</c>.</para></important> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.StartCHMTGMeetingTranscriptionCmdlet.MeetingId"> <summary> <para> <para>The unique ID of the meeting being transcribed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.StartCHMTGMeetingTranscriptionCmdlet.EngineTranscribeSettings_PartialResultsStability"> <summary> <para> <para>Specify the level of stability to use when you enable partial results stabilization (<c>EnablePartialResultsStabilization</c>).</para><para>Low stability provides the highest accuracy. High stability transcribes faster, but with slightly lower accuracy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.StartCHMTGMeetingTranscriptionCmdlet.EngineTranscribeSettings_PiiEntityType"> <summary> <para> <para>Specify which types of personally identifiable information (PII) you want to redact in your transcript. You can include as many types as you'd like, or you can select <c>ALL</c>.</para><para>Values must be comma-separated and can include: <c>ADDRESS</c>, <c>BANK_ACCOUNT_NUMBER</c>, <c>BANK_ROUTING</c>, <c>CREDIT_DEBIT_CVV</c>, <c>CREDIT_DEBIT_EXPIRY</c><c>CREDIT_DEBIT_NUMBER</c>, <c>EMAIL</c>,<c>NAME</c>, <c>PHONE</c>, <c>PIN</c>, <c>SSN</c>, or <c>ALL</c>.</para><para>Note that if you include <c>PiiEntityTypes</c>, you must also include <c>ContentIdentificationType</c> or <c>ContentRedactionType</c>.</para><para>If you include <c>ContentRedactionType</c> or <c>ContentIdentificationType</c>, but do not include PiiEntityTypes, all PII is redacted or identified.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.StartCHMTGMeetingTranscriptionCmdlet.EngineTranscribeSettings_PreferredLanguage"> <summary> <para> <para>Specify a preferred language from the subset of languages codes you specified in <c>LanguageOptions</c>.</para><para>You can only use this parameter if you include <c>IdentifyLanguage</c> and <c>LanguageOptions</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.StartCHMTGMeetingTranscriptionCmdlet.EngineTranscribeMedicalSettings_Region"> <summary> <para> <para>The Amazon Web Services Region passed to Amazon Transcribe Medical. If you don't specify a Region, Amazon Chime uses the meeting's Region. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.StartCHMTGMeetingTranscriptionCmdlet.EngineTranscribeSettings_Region"> <summary> <para> <para>The Amazon Web Services Region in which to use Amazon Transcribe.</para><para>If you don't specify a Region, then the <a href="https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_meeting-chime_CreateMeeting.html">MediaRegion</a> of the meeting is used. However, if Amazon Transcribe is not available in the <c>MediaRegion</c>, then a <c>TranscriptFailed</c> event is sent.</para><para>Use <c>auto</c> to use Amazon Transcribe in a Region near the meeting’s <c>MediaRegion</c>. For more information, refer to <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/transcription-options.html#choose-region">Choosing a transcription Region</a> in the <i>Amazon Chime SDK Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.StartCHMTGMeetingTranscriptionCmdlet.EngineTranscribeMedicalSettings_Specialty"> <summary> <para> <para>The specialty specified for the Amazon Transcribe Medical engine.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.StartCHMTGMeetingTranscriptionCmdlet.EngineTranscribeMedicalSettings_Type"> <summary> <para> <para>The type of transcription.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.StartCHMTGMeetingTranscriptionCmdlet.EngineTranscribeSettings_VocabularyFilterMethod"> <summary> <para> <para>Specify how you want your vocabulary filter applied to your transcript.</para><para>To replace words with <c>***</c>, choose <c>mask</c>.</para><para>To delete words, choose <c>remove</c>.</para><para>To flag words without changing them, choose <c>tag</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.StartCHMTGMeetingTranscriptionCmdlet.EngineTranscribeSettings_VocabularyFilterName"> <summary> <para> <para>Specify the name of the custom vocabulary filter that you want to use when processing your transcription. Note that vocabulary filter names are case sensitive. </para><para>If you use Amazon Transcribe in multiple Regions, the vocabulary filter must be available in Amazon Transcribe in each Region.</para><para>If you include <c>IdentifyLanguage</c> and want to use one or more vocabulary filters with your transcription, use the <c>VocabularyFilterNames</c> parameter instead.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.StartCHMTGMeetingTranscriptionCmdlet.TranscriptionConfiguration_EngineTranscribeSettings_VocabularyFilterNames"> <summary> <para> <para>Specify the names of the custom vocabulary filters that you want to use when processing your transcription. Note that vocabulary filter names are case sensitive.</para><para>If you use Amazon Transcribe in multiple Regions, the vocabulary filter must be available in Amazon Transcribe in each Region.</para><para> If you're <i>not</i> including <c>IdentifyLanguage</c> and want to use a custom vocabulary filter with your transcription, use the <c>VocabularyFilterName</c> parameter instead.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.StartCHMTGMeetingTranscriptionCmdlet.EngineTranscribeMedicalSettings_VocabularyName"> <summary> <para> <para>The name of the vocabulary passed to Amazon Transcribe Medical.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.StartCHMTGMeetingTranscriptionCmdlet.EngineTranscribeSettings_VocabularyName"> <summary> <para> <para>Specify the name of the custom vocabulary that you want to use when processing your transcription. Note that vocabulary names are case sensitive.</para><para>If you use Amazon Transcribe multiple Regions, the vocabulary must be available in Amazon Transcribe in each Region.</para><para>If you include <c>IdentifyLanguage</c> and want to use one or more custom vocabularies with your transcription, use the <c>VocabularyNames</c> parameter instead.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.StartCHMTGMeetingTranscriptionCmdlet.TranscriptionConfiguration_EngineTranscribeSettings_VocabularyNames"> <summary> <para> <para>Specify the names of the custom vocabularies that you want to use when processing your transcription. Note that vocabulary names are case sensitive.</para><para>If you use Amazon Transcribe in multiple Regions, the vocabulary must be available in Amazon Transcribe in each Region.</para><para>If you don't include <c>IdentifyLanguage</c> and want to use a custom vocabulary with your transcription, use the <c>VocabularyName</c> parameter instead.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.StartCHMTGMeetingTranscriptionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ChimeSDKMeetings.Model.StartMeetingTranscriptionResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.StartCHMTGMeetingTranscriptionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the MeetingId parameter. The -PassThru parameter is deprecated, use -Select '^MeetingId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.StartCHMTGMeetingTranscriptionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CHMTG.StopCHMTGMeetingTranscriptionCmdlet"> <summary> Stops transcription for the specified <c>meetingId</c>. For more information, refer to <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/meeting-transcription.html"> Using Amazon Chime SDK live transcription </a> in the <i>Amazon Chime SDK Developer Guide</i>. <important><para> By default, Amazon Transcribe may use and store audio content processed by the service to develop and improve Amazon Web Services AI/ML services as further described in section 50 of the <a href="https://aws.amazon.com/service-terms/">Amazon Web Services Service Terms</a>. Using Amazon Transcribe may be subject to federal and state laws or regulations regarding the recording or interception of electronic communications. It is your and your end users’ responsibility to comply with all applicable laws regarding the recording, including properly notifying all participants in a recorded session or communication that the session or communication is being recorded, and obtaining all necessary consents. You can opt out from Amazon Web Services using audio content to develop and improve Amazon Web Services AI/ML services by configuring an AI services opt out policy using Amazon Web Services Organizations. </para></important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.StopCHMTGMeetingTranscriptionCmdlet.MeetingId"> <summary> <para> <para>The unique ID of the meeting for which you stop transcription.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.StopCHMTGMeetingTranscriptionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ChimeSDKMeetings.Model.StopMeetingTranscriptionResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.StopCHMTGMeetingTranscriptionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the MeetingId parameter. The -PassThru parameter is deprecated, use -Select '^MeetingId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.StopCHMTGMeetingTranscriptionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CHMTG.UpdateCHMTGAttendeeCapabilityCmdlet"> <summary> The capabilities that you want to update. <note><para> You use the capabilities with a set of values that control what the capabilities can do, such as <c>SendReceive</c> data. For more information about those values, see . </para></note><para> When using capabilities, be aware of these corner cases: </para><ul><li><para> If you specify <c>MeetingFeatures:Video:MaxResolution:None</c> when you create a meeting, all API requests that include <c>SendReceive</c>, <c>Send</c>, or <c>Receive</c> for <c>AttendeeCapabilities:Video</c> will be rejected with <c>ValidationError 400</c>. </para></li><li><para> If you specify <c>MeetingFeatures:Content:MaxResolution:None</c> when you create a meeting, all API requests that include <c>SendReceive</c>, <c>Send</c>, or <c>Receive</c> for <c>AttendeeCapabilities:Content</c> will be rejected with <c>ValidationError 400</c>. </para></li><li><para> You can't set <c>content</c> capabilities to <c>SendReceive</c> or <c>Receive</c> unless you also set <c>video</c> capabilities to <c>SendReceive</c> or <c>Receive</c>. If you don't set the <c>video</c> capability to receive, the response will contain an HTTP 400 Bad Request status code. However, you can set your <c>video</c> capability to receive and you set your <c>content</c> capability to not receive. </para></li><li><para> When you change an <c>audio</c> capability from <c>None</c> or <c>Receive</c> to <c>Send</c> or <c>SendReceive</c> , and if the attendee left their microphone unmuted, audio will flow from the attendee to the other meeting participants. </para></li><li><para> When you change a <c>video</c> or <c>content</c> capability from <c>None</c> or <c>Receive</c> to <c>Send</c> or <c>SendReceive</c> , and if the attendee turned on their video or content streams, remote attendees can receive those streams, but only after media renegotiation between the client and the Amazon Chime back-end server. </para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.UpdateCHMTGAttendeeCapabilityCmdlet.AttendeeId"> <summary> <para> <para>The ID of the attendee associated with the update request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.UpdateCHMTGAttendeeCapabilityCmdlet.Capabilities_Audio"> <summary> <para> <para>The audio capability assigned to an attendee.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.UpdateCHMTGAttendeeCapabilityCmdlet.Capabilities_Content"> <summary> <para> <para>The content capability assigned to an attendee.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.UpdateCHMTGAttendeeCapabilityCmdlet.MeetingId"> <summary> <para> <para>The ID of the meeting associated with the update request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.UpdateCHMTGAttendeeCapabilityCmdlet.Capabilities_Video"> <summary> <para> <para>The video capability assigned to an attendee.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.UpdateCHMTGAttendeeCapabilityCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Attendee'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ChimeSDKMeetings.Model.UpdateAttendeeCapabilitiesResponse). Specifying the name of a property of type Amazon.ChimeSDKMeetings.Model.UpdateAttendeeCapabilitiesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.UpdateCHMTGAttendeeCapabilityCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the MeetingId parameter. The -PassThru parameter is deprecated, use -Select '^MeetingId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.UpdateCHMTGAttendeeCapabilityCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CHMTG.UpdateCHMTGUpdateAttendeeCapabilitiesExceptCmdlet"> <summary> Updates <c>AttendeeCapabilities</c> except the capabilities listed in an <c>ExcludedAttendeeIds</c> table. <note><para> You use the capabilities with a set of values that control what the capabilities can do, such as <c>SendReceive</c> data. For more information about those values, see . </para></note><para> When using capabilities, be aware of these corner cases: </para><ul><li><para> If you specify <c>MeetingFeatures:Video:MaxResolution:None</c> when you create a meeting, all API requests that include <c>SendReceive</c>, <c>Send</c>, or <c>Receive</c> for <c>AttendeeCapabilities:Video</c> will be rejected with <c>ValidationError 400</c>. </para></li><li><para> If you specify <c>MeetingFeatures:Content:MaxResolution:None</c> when you create a meeting, all API requests that include <c>SendReceive</c>, <c>Send</c>, or <c>Receive</c> for <c>AttendeeCapabilities:Content</c> will be rejected with <c>ValidationError 400</c>. </para></li><li><para> You can't set <c>content</c> capabilities to <c>SendReceive</c> or <c>Receive</c> unless you also set <c>video</c> capabilities to <c>SendReceive</c> or <c>Receive</c>. If you don't set the <c>video</c> capability to receive, the response will contain an HTTP 400 Bad Request status code. However, you can set your <c>video</c> capability to receive and you set your <c>content</c> capability to not receive. </para></li><li><para> When you change an <c>audio</c> capability from <c>None</c> or <c>Receive</c> to <c>Send</c> or <c>SendReceive</c> , and if the attendee left their microphone unmuted, audio will flow from the attendee to the other meeting participants. </para></li><li><para> When you change a <c>video</c> or <c>content</c> capability from <c>None</c> or <c>Receive</c> to <c>Send</c> or <c>SendReceive</c> , and if the attendee turned on their video or content streams, remote attendees can receive those streams, but only after media renegotiation between the client and the Amazon Chime back-end server. </para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.UpdateCHMTGUpdateAttendeeCapabilitiesExceptCmdlet.Capabilities_Audio"> <summary> <para> <para>The audio capability assigned to an attendee.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.UpdateCHMTGUpdateAttendeeCapabilitiesExceptCmdlet.Capabilities_Content"> <summary> <para> <para>The content capability assigned to an attendee.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.UpdateCHMTGUpdateAttendeeCapabilitiesExceptCmdlet.ExcludedAttendeeId"> <summary> <para> <para>The <c>AttendeeIDs</c> that you want to exclude from one or more capabilities.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.UpdateCHMTGUpdateAttendeeCapabilitiesExceptCmdlet.MeetingId"> <summary> <para> <para>The ID of the meeting associated with the update request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.UpdateCHMTGUpdateAttendeeCapabilitiesExceptCmdlet.Capabilities_Video"> <summary> <para> <para>The video capability assigned to an attendee.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.UpdateCHMTGUpdateAttendeeCapabilitiesExceptCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ChimeSDKMeetings.Model.BatchUpdateAttendeeCapabilitiesExceptResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.UpdateCHMTGUpdateAttendeeCapabilitiesExceptCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the MeetingId parameter. The -PassThru parameter is deprecated, use -Select '^MeetingId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMTG.UpdateCHMTGUpdateAttendeeCapabilitiesExceptCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> </members> </doc> |