AWS.Tools.ChimeSDKMessaging.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.ChimeSDKMessaging</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelCmdlet"> <summary> Returns the full details of a channel in an Amazon Chime <code>AppInstance</code>. <note><para> The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelCmdlet.ChannelArn"> <summary> <para> <para>The ARN of the channel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelCmdlet.ChimeBearer"> <summary> <para> <para>The <code>AppInstanceUserArn</code> of the user that makes the API call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Channel'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ChimeSDKMessaging.Model.DescribeChannelResponse). Specifying the name of a property of type Amazon.ChimeSDKMessaging.Model.DescribeChannelResponse 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.CHMMG.GetCHMMGChannelCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ChannelArn parameter. The -PassThru parameter is deprecated, use -Select '^ChannelArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelBanCmdlet"> <summary> Returns the full details of a channel ban. <note><para> The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelBanCmdlet.ChannelArn"> <summary> <para> <para>The ARN of the channel from which the user is banned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelBanCmdlet.ChimeBearer"> <summary> <para> <para>The <code>AppInstanceUserArn</code> of the user that makes the API call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelBanCmdlet.MemberArn"> <summary> <para> <para>The ARN of the member being banned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelBanCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ChannelBan'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ChimeSDKMessaging.Model.DescribeChannelBanResponse). Specifying the name of a property of type Amazon.ChimeSDKMessaging.Model.DescribeChannelBanResponse 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.CHMMG.GetCHMMGChannelBanCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ChannelArn parameter. The -PassThru parameter is deprecated, use -Select '^ChannelArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelBanListCmdlet"> <summary> Lists all the users banned from a particular channel. <note><para> The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelBanListCmdlet.ChannelArn"> <summary> <para> <para>The ARN of the channel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelBanListCmdlet.ChimeBearer"> <summary> <para> <para>The <code>AppInstanceUserArn</code> of the user that makes the API call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelBanListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of bans that you want returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelBanListCmdlet.NextToken"> <summary> <para> <para>The token passed by previous API calls until all requested bans are returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelBanListCmdlet.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.ChimeSDKMessaging.Model.ListChannelBansResponse). Specifying the name of a property of type Amazon.ChimeSDKMessaging.Model.ListChannelBansResponse 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.CHMMG.GetCHMMGChannelBanListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ChannelArn parameter. The -PassThru parameter is deprecated, use -Select '^ChannelArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelListCmdlet"> <summary> Amazon.ChimeSDKMessaging.IAmazonChimeSDKMessaging.ListChannels </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelListCmdlet.AppInstanceArn"> <summary> <para> <para>The ARN of the <code>AppInstance</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelListCmdlet.ChimeBearer"> <summary> <para> <para>The <code>AppInstanceUserArn</code> of the user that makes the API call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelListCmdlet.Privacy"> <summary> <para> <para>The privacy setting. <code>PUBLIC</code> retrieves all the public channels. <code>PRIVATE</code> retrieves private channels. Only an <code>AppInstanceAdmin</code> can retrieve private channels. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of channels that you want to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelListCmdlet.NextToken"> <summary> <para> <para>The token passed by previous API calls until all requested channels are returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Channels'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ChimeSDKMessaging.Model.ListChannelsResponse). Specifying the name of a property of type Amazon.ChimeSDKMessaging.Model.ListChannelsResponse 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.CHMMG.GetCHMMGChannelListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AppInstanceArn parameter. The -PassThru parameter is deprecated, use -Select '^AppInstanceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelMembershipCmdlet"> <summary> Returns the full details of a user's channel membership. <note><para> The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelMembershipCmdlet.ChannelArn"> <summary> <para> <para>The ARN of the channel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelMembershipCmdlet.ChimeBearer"> <summary> <para> <para>The <code>AppInstanceUserArn</code> of the user that makes the API call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelMembershipCmdlet.MemberArn"> <summary> <para> <para>The ARN of the member.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelMembershipCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ChannelMembership'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ChimeSDKMessaging.Model.DescribeChannelMembershipResponse). Specifying the name of a property of type Amazon.ChimeSDKMessaging.Model.DescribeChannelMembershipResponse 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.CHMMG.GetCHMMGChannelMembershipCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ChannelArn parameter. The -PassThru parameter is deprecated, use -Select '^ChannelArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelMembershipForAppInstanceUserCmdlet"> <summary> Returns the details of a channel based on the membership of the specified <code>AppInstanceUser</code>. <note><para> The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelMembershipForAppInstanceUserCmdlet.AppInstanceUserArn"> <summary> <para> <para>The ARN of the user in a channel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelMembershipForAppInstanceUserCmdlet.ChannelArn"> <summary> <para> <para>The ARN of the channel to which the user belongs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelMembershipForAppInstanceUserCmdlet.ChimeBearer"> <summary> <para> <para>The <code>AppInstanceUserArn</code> of the user that makes the API call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelMembershipForAppInstanceUserCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ChannelMembership'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ChimeSDKMessaging.Model.DescribeChannelMembershipForAppInstanceUserResponse). Specifying the name of a property of type Amazon.ChimeSDKMessaging.Model.DescribeChannelMembershipForAppInstanceUserResponse 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.CHMMG.GetCHMMGChannelMembershipForAppInstanceUserCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ChannelArn parameter. The -PassThru parameter is deprecated, use -Select '^ChannelArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelMembershipListCmdlet"> <summary> Lists all channel memberships in a channel. <note><para> The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelMembershipListCmdlet.ChannelArn"> <summary> <para> <para>The maximum number of channel memberships that you want returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelMembershipListCmdlet.ChimeBearer"> <summary> <para> <para>The <code>AppInstanceUserArn</code> of the user that makes the API call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelMembershipListCmdlet.Type"> <summary> <para> <para>The membership type of a user, <code>DEFAULT</code> or <code>HIDDEN</code>. Default members are always returned as part of <code>ListChannelMemberships</code>. Hidden members are only returned if the type filter in <code>ListChannelMemberships</code> equals <code>HIDDEN</code>. Otherwise hidden members are not returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelMembershipListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of channel memberships that you want returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelMembershipListCmdlet.NextToken"> <summary> <para> <para>The token passed by previous API calls until all requested channel memberships are returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelMembershipListCmdlet.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.ChimeSDKMessaging.Model.ListChannelMembershipsResponse). Specifying the name of a property of type Amazon.ChimeSDKMessaging.Model.ListChannelMembershipsResponse 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.CHMMG.GetCHMMGChannelMembershipListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ChannelArn parameter. The -PassThru parameter is deprecated, use -Select '^ChannelArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelMembershipsForAppInstanceUserListCmdlet"> <summary> Lists all channels that a particular <code>AppInstanceUser</code> is a part of. Only an <code>AppInstanceAdmin</code> can call the API with a user ARN that is not their own. <note><para> The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelMembershipsForAppInstanceUserListCmdlet.AppInstanceUserArn"> <summary> <para> <para>The ARN of the <code>AppInstanceUser</code>s</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelMembershipsForAppInstanceUserListCmdlet.ChimeBearer"> <summary> <para> <para>The <code>AppInstanceUserArn</code> of the user that makes the API call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelMembershipsForAppInstanceUserListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of users that you want returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelMembershipsForAppInstanceUserListCmdlet.NextToken"> <summary> <para> <para>The token returned from previous API requests until the number of channel memberships is reached.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelMembershipsForAppInstanceUserListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ChannelMemberships'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ChimeSDKMessaging.Model.ListChannelMembershipsForAppInstanceUserResponse). Specifying the name of a property of type Amazon.ChimeSDKMessaging.Model.ListChannelMembershipsForAppInstanceUserResponse 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.CHMMG.GetCHMMGChannelMembershipsForAppInstanceUserListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AppInstanceUserArn parameter. The -PassThru parameter is deprecated, use -Select '^AppInstanceUserArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelMessageCmdlet"> <summary> Gets the full details of a channel message. <note><para> The x-amz-chime-bearer request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelMessageCmdlet.ChannelArn"> <summary> <para> <para>The ARN of the channel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelMessageCmdlet.ChimeBearer"> <summary> <para> <para>The <code>AppInstanceUserArn</code> of the user that makes the API call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelMessageCmdlet.MessageId"> <summary> <para> <para>The ID of the message.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelMessageCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ChannelMessage'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ChimeSDKMessaging.Model.GetChannelMessageResponse). Specifying the name of a property of type Amazon.ChimeSDKMessaging.Model.GetChannelMessageResponse 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.CHMMG.GetCHMMGChannelMessageCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ChannelArn parameter. The -PassThru parameter is deprecated, use -Select '^ChannelArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelMessageListCmdlet"> <summary> List all the messages in a channel. Returns a paginated list of <code>ChannelMessages</code>. By default, sorted by creation timestamp in descending order. <note><para> Redacted messages appear in the results as empty, since they are only redacted, not deleted. Deleted messages do not appear in the results. This action always returns the latest version of an edited message. </para><para> Also, the x-amz-chime-bearer request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelMessageListCmdlet.ChannelArn"> <summary> <para> <para>The ARN of the channel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelMessageListCmdlet.ChimeBearer"> <summary> <para> <para>The <code>AppInstanceUserArn</code> of the user that makes the API call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelMessageListCmdlet.NotAfter"> <summary> <para> <para>The final or ending time stamp for your requested messages.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelMessageListCmdlet.NotBefore"> <summary> <para> <para>The initial or starting time stamp for your requested messages.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelMessageListCmdlet.SortOrder"> <summary> <para> <para>The order in which you want messages sorted. Default is Descending, based on time created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelMessageListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of messages that you want returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelMessageListCmdlet.NextToken"> <summary> <para> <para>The token passed by previous API calls until all requested messages are returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelMessageListCmdlet.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.ChimeSDKMessaging.Model.ListChannelMessagesResponse). Specifying the name of a property of type Amazon.ChimeSDKMessaging.Model.ListChannelMessagesResponse 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.CHMMG.GetCHMMGChannelMessageListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ChannelArn parameter. The -PassThru parameter is deprecated, use -Select '^ChannelArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelModeratedByAppInstanceUserCmdlet"> <summary> Returns the full details of a channel moderated by the specified <code>AppInstanceUser</code>. <note><para> The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelModeratedByAppInstanceUserCmdlet.AppInstanceUserArn"> <summary> <para> <para>The ARN of the <code>AppInstanceUser</code> in the moderated channel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelModeratedByAppInstanceUserCmdlet.ChannelArn"> <summary> <para> <para>The ARN of the moderated channel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelModeratedByAppInstanceUserCmdlet.ChimeBearer"> <summary> <para> <para>The <code>AppInstanceUserArn</code> of the user that makes the API call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelModeratedByAppInstanceUserCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Channel'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ChimeSDKMessaging.Model.DescribeChannelModeratedByAppInstanceUserResponse). Specifying the name of a property of type Amazon.ChimeSDKMessaging.Model.DescribeChannelModeratedByAppInstanceUserResponse 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.CHMMG.GetCHMMGChannelModeratedByAppInstanceUserCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ChannelArn parameter. The -PassThru parameter is deprecated, use -Select '^ChannelArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelModeratorCmdlet"> <summary> Returns the full details of a single ChannelModerator. <note><para> The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelModeratorCmdlet.ChannelArn"> <summary> <para> <para>The ARN of the channel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelModeratorCmdlet.ChannelModeratorArn"> <summary> <para> <para>The ARN of the channel moderator.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelModeratorCmdlet.ChimeBearer"> <summary> <para> <para>The <code>AppInstanceUserArn</code> of the user that makes the API call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelModeratorCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ChannelModerator'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ChimeSDKMessaging.Model.DescribeChannelModeratorResponse). Specifying the name of a property of type Amazon.ChimeSDKMessaging.Model.DescribeChannelModeratorResponse 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.CHMMG.GetCHMMGChannelModeratorCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ChannelArn parameter. The -PassThru parameter is deprecated, use -Select '^ChannelArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelModeratorListCmdlet"> <summary> Lists all the moderators for a channel. <note><para> The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelModeratorListCmdlet.ChannelArn"> <summary> <para> <para>The ARN of the channel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelModeratorListCmdlet.ChimeBearer"> <summary> <para> <para>The <code>AppInstanceUserArn</code> of the user that makes the API call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelModeratorListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of moderators that you want returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelModeratorListCmdlet.NextToken"> <summary> <para> <para>The token passed by previous API calls until all requested moderators are returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelModeratorListCmdlet.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.ChimeSDKMessaging.Model.ListChannelModeratorsResponse). Specifying the name of a property of type Amazon.ChimeSDKMessaging.Model.ListChannelModeratorsResponse 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.CHMMG.GetCHMMGChannelModeratorListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ChannelArn parameter. The -PassThru parameter is deprecated, use -Select '^ChannelArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelsModeratedByAppInstanceUserListCmdlet"> <summary> A list of the channels moderated by an <code>AppInstanceUser</code>. <note><para> The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelsModeratedByAppInstanceUserListCmdlet.AppInstanceUserArn"> <summary> <para> <para>The ARN of the user in the moderated channel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelsModeratedByAppInstanceUserListCmdlet.ChimeBearer"> <summary> <para> <para>The <code>AppInstanceUserArn</code> of the user that makes the API call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelsModeratedByAppInstanceUserListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of channels in the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelsModeratedByAppInstanceUserListCmdlet.NextToken"> <summary> <para> <para>The token returned from previous API requests until the number of channels moderated by the user is reached.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelsModeratedByAppInstanceUserListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Channels'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ChimeSDKMessaging.Model.ListChannelsModeratedByAppInstanceUserResponse). Specifying the name of a property of type Amazon.ChimeSDKMessaging.Model.ListChannelsModeratedByAppInstanceUserResponse 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.CHMMG.GetCHMMGChannelsModeratedByAppInstanceUserListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AppInstanceUserArn parameter. The -PassThru parameter is deprecated, use -Select '^AppInstanceUserArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGMessagingSessionEndpointCmdlet"> <summary> The details of the endpoint for the messaging session. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGMessagingSessionEndpointCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Endpoint'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ChimeSDKMessaging.Model.GetMessagingSessionEndpointResponse). Specifying the name of a property of type Amazon.ChimeSDKMessaging.Model.GetMessagingSessionEndpointResponse 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="T:Amazon.PowerShell.Cmdlets.CHMMG.HideCHMMGChannelMessageCmdlet"> <summary> Redacts message content, but not metadata. The message exists in the back end, but the action returns null content, and the state shows as redacted. <note><para> The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.HideCHMMGChannelMessageCmdlet.ChannelArn"> <summary> <para> <para>The ARN of the channel containing the messages that you want to redact.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.HideCHMMGChannelMessageCmdlet.ChimeBearer"> <summary> <para> <para>The <code>AppInstanceUserArn</code> of the user that makes the API call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.HideCHMMGChannelMessageCmdlet.MessageId"> <summary> <para> <para>The ID of the message being redacted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.HideCHMMGChannelMessageCmdlet.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.ChimeSDKMessaging.Model.RedactChannelMessageResponse). Specifying the name of a property of type Amazon.ChimeSDKMessaging.Model.RedactChannelMessageResponse 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.CHMMG.HideCHMMGChannelMessageCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ChannelArn parameter. The -PassThru parameter is deprecated, use -Select '^ChannelArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.HideCHMMGChannelMessageCmdlet.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.CHMMG.NewCHMMGChannelCmdlet"> <summary> Creates a channel to which you can add users and send messages. <para><b>Restriction</b>: You can't change a channel's privacy. </para><note><para> The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.NewCHMMGChannelCmdlet.AppInstanceArn"> <summary> <para> <para>The ARN of the channel request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.NewCHMMGChannelCmdlet.ChimeBearer"> <summary> <para> <para>The <code>AppInstanceUserArn</code> of the user that makes the API call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.NewCHMMGChannelCmdlet.ClientRequestToken"> <summary> <para> <para>The client token for the request. An <code>Idempotency</code> token.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.NewCHMMGChannelCmdlet.Metadata"> <summary> <para> <para>The metadata of the creation request. Limited to 1KB and UTF-8.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.NewCHMMGChannelCmdlet.Mode"> <summary> <para> <para>The channel mode: <code>UNRESTRICTED</code> or <code>RESTRICTED</code>. Administrators, moderators, and channel members can add themselves and other members to unrestricted channels. Only administrators and moderators can add members to restricted channels.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.NewCHMMGChannelCmdlet.Name"> <summary> <para> <para>The name of the channel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.NewCHMMGChannelCmdlet.Privacy"> <summary> <para> <para>The channel's privacy level: <code>PUBLIC</code> or <code>PRIVATE</code>. Private channels aren't discoverable by users outside the channel. Public channels are discoverable by anyone in the <code>AppInstance</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.NewCHMMGChannelCmdlet.Tag"> <summary> <para> <para>The tags for the creation request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.NewCHMMGChannelCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ChannelArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ChimeSDKMessaging.Model.CreateChannelResponse). Specifying the name of a property of type Amazon.ChimeSDKMessaging.Model.CreateChannelResponse 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.CHMMG.NewCHMMGChannelCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AppInstanceArn parameter. The -PassThru parameter is deprecated, use -Select '^AppInstanceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.NewCHMMGChannelCmdlet.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.CHMMG.NewCHMMGChannelBanCmdlet"> <summary> Permanently bans a member from a channel. Moderators can't add banned members to a channel. To undo a ban, you first have to <code>DeleteChannelBan</code>, and then <code>CreateChannelMembership</code>. Bans are cleaned up when you delete users or channels. <para> If you ban a user who is already part of a channel, that user is automatically kicked from the channel. </para><note><para> The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.NewCHMMGChannelBanCmdlet.ChannelArn"> <summary> <para> <para>The ARN of the ban request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.NewCHMMGChannelBanCmdlet.ChimeBearer"> <summary> <para> <para>The <code>AppInstanceUserArn</code> of the user that makes the API call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.NewCHMMGChannelBanCmdlet.MemberArn"> <summary> <para> <para>The ARN of the member being banned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.NewCHMMGChannelBanCmdlet.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.ChimeSDKMessaging.Model.CreateChannelBanResponse). Specifying the name of a property of type Amazon.ChimeSDKMessaging.Model.CreateChannelBanResponse 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.CHMMG.NewCHMMGChannelBanCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ChannelArn parameter. The -PassThru parameter is deprecated, use -Select '^ChannelArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.NewCHMMGChannelBanCmdlet.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.CHMMG.NewCHMMGChannelMembershipCmdlet"> <summary> Adds a user to a channel. The <code>InvitedBy</code> response field is derived from the request header. A channel member can: <ul><li><para> List messages </para></li><li><para> Send messages </para></li><li><para> Receive messages </para></li><li><para> Edit their own messages </para></li><li><para> Leave the channel </para></li></ul><para> Privacy settings impact this action as follows: </para><ul><li><para> Public Channels: You do not need to be a member to list messages, but you must be a member to send messages. </para></li><li><para> Private Channels: You must be a member to list or send messages. </para></li></ul><note><para> The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.NewCHMMGChannelMembershipCmdlet.ChannelArn"> <summary> <para> <para>The ARN of the channel to which you're adding users.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.NewCHMMGChannelMembershipCmdlet.ChimeBearer"> <summary> <para> <para>The <code>AppInstanceUserArn</code> of the user that makes the API call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.NewCHMMGChannelMembershipCmdlet.MemberArn"> <summary> <para> <para>The ARN of the member you want to add to the channel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.NewCHMMGChannelMembershipCmdlet.Type"> <summary> <para> <para>The membership type of a user, <code>DEFAULT</code> or <code>HIDDEN</code>. Default members are always returned as part of <code>ListChannelMemberships</code>. Hidden members are only returned if the type filter in <code>ListChannelMemberships</code> equals <code>HIDDEN</code>. Otherwise hidden members are not returned. This is only supported by moderators.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.NewCHMMGChannelMembershipCmdlet.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.ChimeSDKMessaging.Model.CreateChannelMembershipResponse). Specifying the name of a property of type Amazon.ChimeSDKMessaging.Model.CreateChannelMembershipResponse 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.CHMMG.NewCHMMGChannelMembershipCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ChannelArn parameter. The -PassThru parameter is deprecated, use -Select '^ChannelArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.NewCHMMGChannelMembershipCmdlet.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.CHMMG.NewCHMMGChannelModeratorCmdlet"> <summary> Creates a new <code>ChannelModerator</code>. A channel moderator can: <ul><li><para> Add and remove other members of the channel. </para></li><li><para> Add and remove other moderators of the channel. </para></li><li><para> Add and remove user bans for the channel. </para></li><li><para> Redact messages in the channel. </para></li><li><para> List messages in the channel. </para></li></ul><note><para> The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.NewCHMMGChannelModeratorCmdlet.ChannelArn"> <summary> <para> <para>The ARN of the channel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.NewCHMMGChannelModeratorCmdlet.ChannelModeratorArn"> <summary> <para> <para>The ARN of the moderator.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.NewCHMMGChannelModeratorCmdlet.ChimeBearer"> <summary> <para> <para>The <code>AppInstanceUserArn</code> of the user that makes the API call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.NewCHMMGChannelModeratorCmdlet.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.ChimeSDKMessaging.Model.CreateChannelModeratorResponse). Specifying the name of a property of type Amazon.ChimeSDKMessaging.Model.CreateChannelModeratorResponse 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.CHMMG.NewCHMMGChannelModeratorCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ChannelArn parameter. The -PassThru parameter is deprecated, use -Select '^ChannelArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.NewCHMMGChannelModeratorCmdlet.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.CHMMG.NewCHMMGCreateChannelMembershipCmdlet"> <summary> Adds a specified number of users to a channel. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.NewCHMMGCreateChannelMembershipCmdlet.ChannelArn"> <summary> <para> <para>The ARN of the channel to which you're adding users.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.NewCHMMGCreateChannelMembershipCmdlet.ChimeBearer"> <summary> <para> <para>The <code>AppInstanceUserArn</code> of the user that makes the API call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.NewCHMMGCreateChannelMembershipCmdlet.MemberArn"> <summary> <para> <para>The ARNs of the members you want to add to the channel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.NewCHMMGCreateChannelMembershipCmdlet.Type"> <summary> <para> <para>The membership type of a user, <code>DEFAULT</code> or <code>HIDDEN</code>. Default members are always returned as part of <code>ListChannelMemberships</code>. Hidden members are only returned if the type filter in <code>ListChannelMemberships</code> equals <code>HIDDEN</code>. Otherwise hidden members are not returned. This is only supported by moderators.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.NewCHMMGCreateChannelMembershipCmdlet.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.ChimeSDKMessaging.Model.BatchCreateChannelMembershipResponse). Specifying the name of a property of type Amazon.ChimeSDKMessaging.Model.BatchCreateChannelMembershipResponse 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.CHMMG.NewCHMMGCreateChannelMembershipCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ChannelArn parameter. The -PassThru parameter is deprecated, use -Select '^ChannelArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.NewCHMMGCreateChannelMembershipCmdlet.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.CHMMG.RemoveCHMMGChannelCmdlet"> <summary> Immediately makes a channel and its memberships inaccessible and marks them for deletion. This is an irreversible process. <note><para> The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.RemoveCHMMGChannelCmdlet.ChannelArn"> <summary> <para> <para>The ARN of the channel being deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.RemoveCHMMGChannelCmdlet.ChimeBearer"> <summary> <para> <para>The <code>AppInstanceUserArn</code> of the user that makes the API call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.RemoveCHMMGChannelCmdlet.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.ChimeSDKMessaging.Model.DeleteChannelResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.RemoveCHMMGChannelCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ChannelArn parameter. The -PassThru parameter is deprecated, use -Select '^ChannelArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.RemoveCHMMGChannelCmdlet.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.CHMMG.RemoveCHMMGChannelBanCmdlet"> <summary> Removes a user from a channel's ban list. <note><para> The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.RemoveCHMMGChannelBanCmdlet.ChannelArn"> <summary> <para> <para>The ARN of the channel from which the <code>AppInstanceUser</code> was banned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.RemoveCHMMGChannelBanCmdlet.ChimeBearer"> <summary> <para> <para>The <code>AppInstanceUserArn</code> of the user that makes the API call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.RemoveCHMMGChannelBanCmdlet.MemberArn"> <summary> <para> <para>The ARN of the <code>AppInstanceUser</code> that you want to reinstate.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.RemoveCHMMGChannelBanCmdlet.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.ChimeSDKMessaging.Model.DeleteChannelBanResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.RemoveCHMMGChannelBanCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ChannelArn parameter. The -PassThru parameter is deprecated, use -Select '^ChannelArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.RemoveCHMMGChannelBanCmdlet.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.CHMMG.RemoveCHMMGChannelMembershipCmdlet"> <summary> Removes a member from a channel. <note><para> The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.RemoveCHMMGChannelMembershipCmdlet.ChannelArn"> <summary> <para> <para>The ARN of the channel from which you want to remove the user.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.RemoveCHMMGChannelMembershipCmdlet.ChimeBearer"> <summary> <para> <para>The <code>AppInstanceUserArn</code> of the user that makes the API call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.RemoveCHMMGChannelMembershipCmdlet.MemberArn"> <summary> <para> <para>The ARN of the member that you're removing from the channel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.RemoveCHMMGChannelMembershipCmdlet.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.ChimeSDKMessaging.Model.DeleteChannelMembershipResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.RemoveCHMMGChannelMembershipCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ChannelArn parameter. The -PassThru parameter is deprecated, use -Select '^ChannelArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.RemoveCHMMGChannelMembershipCmdlet.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.CHMMG.RemoveCHMMGChannelMessageCmdlet"> <summary> Deletes a channel message. Only admins can perform this action. Deletion makes messages inaccessible immediately. A background process deletes any revisions created by <code>UpdateChannelMessage</code>. <note><para> The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.RemoveCHMMGChannelMessageCmdlet.ChannelArn"> <summary> <para> <para>The ARN of the channel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.RemoveCHMMGChannelMessageCmdlet.ChimeBearer"> <summary> <para> <para>The <code>AppInstanceUserArn</code> of the user that makes the API call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.RemoveCHMMGChannelMessageCmdlet.MessageId"> <summary> <para> <para>The ID of the message being deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.RemoveCHMMGChannelMessageCmdlet.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.ChimeSDKMessaging.Model.DeleteChannelMessageResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.RemoveCHMMGChannelMessageCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ChannelArn parameter. The -PassThru parameter is deprecated, use -Select '^ChannelArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.RemoveCHMMGChannelMessageCmdlet.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.CHMMG.RemoveCHMMGChannelModeratorCmdlet"> <summary> Deletes a channel moderator. <note><para> The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.RemoveCHMMGChannelModeratorCmdlet.ChannelArn"> <summary> <para> <para>The ARN of the channel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.RemoveCHMMGChannelModeratorCmdlet.ChannelModeratorArn"> <summary> <para> <para>The ARN of the moderator being deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.RemoveCHMMGChannelModeratorCmdlet.ChimeBearer"> <summary> <para> <para>The <code>AppInstanceUserArn</code> of the user that makes the API call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.RemoveCHMMGChannelModeratorCmdlet.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.ChimeSDKMessaging.Model.DeleteChannelModeratorResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.RemoveCHMMGChannelModeratorCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ChannelArn parameter. The -PassThru parameter is deprecated, use -Select '^ChannelArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.RemoveCHMMGChannelModeratorCmdlet.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.CHMMG.SendCHMMGChannelMessageCmdlet"> <summary> Sends a message to a particular channel that the member is a part of. <note><para> The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header. </para><para> Also, <code>STANDARD</code> messages can contain 4KB of data and the 1KB of metadata. <code>CONTROL</code> messages can contain 30 bytes of data and no metadata. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.SendCHMMGChannelMessageCmdlet.ChannelArn"> <summary> <para> <para>The ARN of the channel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.SendCHMMGChannelMessageCmdlet.ChimeBearer"> <summary> <para> <para>The <code>AppInstanceUserArn</code> of the user that makes the API call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.SendCHMMGChannelMessageCmdlet.ClientRequestToken"> <summary> <para> <para>The <code>Idempotency</code> token for each client request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.SendCHMMGChannelMessageCmdlet.Content"> <summary> <para> <para>The content of the message.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.SendCHMMGChannelMessageCmdlet.Metadata"> <summary> <para> <para>The optional metadata for each message.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.SendCHMMGChannelMessageCmdlet.Persistence"> <summary> <para> <para>Boolean that controls whether the message is persisted on the back end. Required.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.SendCHMMGChannelMessageCmdlet.Type"> <summary> <para> <para>The type of message, <code>STANDARD</code> or <code>CONTROL</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.SendCHMMGChannelMessageCmdlet.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.ChimeSDKMessaging.Model.SendChannelMessageResponse). Specifying the name of a property of type Amazon.ChimeSDKMessaging.Model.SendChannelMessageResponse 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.CHMMG.SendCHMMGChannelMessageCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ChannelArn parameter. The -PassThru parameter is deprecated, use -Select '^ChannelArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.SendCHMMGChannelMessageCmdlet.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.CHMMG.UpdateCHMMGChannelCmdlet"> <summary> Update a channel's attributes. <para><b>Restriction</b>: You can't change a channel's privacy. </para><note><para> The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.UpdateCHMMGChannelCmdlet.ChannelArn"> <summary> <para> <para>The ARN of the channel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.UpdateCHMMGChannelCmdlet.ChimeBearer"> <summary> <para> <para>The <code>AppInstanceUserArn</code> of the user that makes the API call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.UpdateCHMMGChannelCmdlet.Metadata"> <summary> <para> <para>The metadata for the update request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.UpdateCHMMGChannelCmdlet.Mode"> <summary> <para> <para>The mode of the update request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.UpdateCHMMGChannelCmdlet.Name"> <summary> <para> <para>The name of the channel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.UpdateCHMMGChannelCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ChannelArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ChimeSDKMessaging.Model.UpdateChannelResponse). Specifying the name of a property of type Amazon.ChimeSDKMessaging.Model.UpdateChannelResponse 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.CHMMG.UpdateCHMMGChannelCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ChannelArn parameter. The -PassThru parameter is deprecated, use -Select '^ChannelArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.UpdateCHMMGChannelCmdlet.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.CHMMG.UpdateCHMMGChannelMessageCmdlet"> <summary> Updates the content of a message. <note><para> The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.UpdateCHMMGChannelMessageCmdlet.ChannelArn"> <summary> <para> <para>The ARN of the channel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.UpdateCHMMGChannelMessageCmdlet.ChimeBearer"> <summary> <para> <para>The <code>AppInstanceUserArn</code> of the user that makes the API call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.UpdateCHMMGChannelMessageCmdlet.Content"> <summary> <para> <para>The content of the message being updated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.UpdateCHMMGChannelMessageCmdlet.MessageId"> <summary> <para> <para>The ID string of the message being updated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.UpdateCHMMGChannelMessageCmdlet.Metadata"> <summary> <para> <para>The metadata of the message being updated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.UpdateCHMMGChannelMessageCmdlet.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.ChimeSDKMessaging.Model.UpdateChannelMessageResponse). Specifying the name of a property of type Amazon.ChimeSDKMessaging.Model.UpdateChannelMessageResponse 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.CHMMG.UpdateCHMMGChannelMessageCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ChannelArn parameter. The -PassThru parameter is deprecated, use -Select '^ChannelArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.UpdateCHMMGChannelMessageCmdlet.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.CHMMG.UpdateCHMMGChannelReadMarkerCmdlet"> <summary> The details of the time when a user last read messages in a channel. <note><para> The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.UpdateCHMMGChannelReadMarkerCmdlet.ChannelArn"> <summary> <para> <para>The ARN of the channel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.UpdateCHMMGChannelReadMarkerCmdlet.ChimeBearer"> <summary> <para> <para>The <code>AppInstanceUserArn</code> of the user that makes the API call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.UpdateCHMMGChannelReadMarkerCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ChannelArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ChimeSDKMessaging.Model.UpdateChannelReadMarkerResponse). Specifying the name of a property of type Amazon.ChimeSDKMessaging.Model.UpdateChannelReadMarkerResponse 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.CHMMG.UpdateCHMMGChannelReadMarkerCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ChannelArn parameter. The -PassThru parameter is deprecated, use -Select '^ChannelArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.UpdateCHMMGChannelReadMarkerCmdlet.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> |