AWS.Tools.ChimeSDKMessaging.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.ChimeSDKMessaging</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.CHMMG.AddCHMMGResourceTagCmdlet"> <summary> Applies the specified tags to the specified Amazon Chime SDK messaging resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.AddCHMMGResourceTagCmdlet.ResourceARN"> <summary> <para> <para>The resource ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.AddCHMMGResourceTagCmdlet.Tag"> <summary> <para> <para>The tag key-value pairs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.AddCHMMGResourceTagCmdlet.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.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.AddCHMMGResourceTagCmdlet.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.CHMMG.AddCHMMGResourceTagCmdlet.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.GetCHMMGChannelCmdlet"> <summary> Returns the full details of a channel in an Amazon Chime <c>AppInstance</c>. <note><para> The <c>x-amz-chime-bearer</c> request header is mandatory. Use the ARN of the <c>AppInstanceUser</c> or <c>AppInstanceBot</c> 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 ARN of the <c>AppInstanceUser</c> or <c>AppInstanceBot</c> 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 <c>x-amz-chime-bearer</c> request header is mandatory. Use the ARN of the <c>AppInstanceUser</c> or <c>AppInstanceBot</c> 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 ARN of the <c>AppInstanceUser</c> or <c>AppInstanceBot</c> that makes the API call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelBanCmdlet.MemberArn"> <summary> <para> <para>The <c>AppInstanceUserArn</c> 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 and bots banned from a particular channel. <note><para> The <c>x-amz-chime-bearer</c> request header is mandatory. Use the ARN of the <c>AppInstanceUser</c> or <c>AppInstanceBot</c> 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 ARN of the <c>AppInstanceUser</c> or <c>AppInstanceBot</c> 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.GetCHMMGChannelFlowCmdlet"> <summary> Returns the full details of a channel flow in an Amazon Chime <c>AppInstance</c>. This is a developer API. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelFlowCmdlet.ChannelFlowArn"> <summary> <para> <para>The ARN of the channel flow.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelFlowCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ChannelFlow'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ChimeSDKMessaging.Model.DescribeChannelFlowResponse). Specifying the name of a property of type Amazon.ChimeSDKMessaging.Model.DescribeChannelFlowResponse 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.GetCHMMGChannelFlowCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ChannelFlowArn parameter. The -PassThru parameter is deprecated, use -Select '^ChannelFlowArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelFlowListCmdlet"> <summary> Returns a paginated lists of all the channel flows created under a single Chime. This is a developer API. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelFlowListCmdlet.AppInstanceArn"> <summary> <para> <para>The ARN of the app instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelFlowListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of channel flows that you want to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelFlowListCmdlet.NextToken"> <summary> <para> <para>The token passed by previous API calls until all requested channel flows are returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelFlowListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ChannelFlows'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ChimeSDKMessaging.Model.ListChannelFlowsResponse). Specifying the name of a property of type Amazon.ChimeSDKMessaging.Model.ListChannelFlowsResponse 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.GetCHMMGChannelFlowListCmdlet.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.GetCHMMGChannelListCmdlet"> <summary> Lists all Channels created under a single Chime App as a paginated list. You can specify filters to narrow results. <para><b>Functionality & restrictions</b></para><ul><li><para> Use privacy = <c>PUBLIC</c> to retrieve all public channels in the account. </para></li><li><para> Only an <c>AppInstanceAdmin</c> can set privacy = <c>PRIVATE</c> to list the private channels in an account. </para></li></ul><note><para> The <c>x-amz-chime-bearer</c> request header is mandatory. Use the ARN of the <c>AppInstanceUser</c> or <c>AppInstanceBot</c> that makes the API call as the value in the header. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelListCmdlet.AppInstanceArn"> <summary> <para> <para>The ARN of the <c>AppInstance</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelListCmdlet.ChimeBearer"> <summary> <para> <para>The ARN of the <c>AppInstanceUser</c> or <c>AppInstanceBot</c> that makes the API call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelListCmdlet.Privacy"> <summary> <para> <para>The privacy setting. <c>PUBLIC</c> retrieves all the public channels. <c>PRIVATE</c> retrieves private channels. Only an <c>AppInstanceAdmin</c> 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 <c>x-amz-chime-bearer</c> request header is mandatory. Use the ARN of the <c>AppInstanceUser</c> or <c>AppInstanceBot</c> 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 ARN of the <c>AppInstanceUser</c> or <c>AppInstanceBot</c> that makes the API call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelMembershipCmdlet.MemberArn"> <summary> <para> <para>The <c>AppInstanceUserArn</c> of the member.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelMembershipCmdlet.SubChannelId"> <summary> <para> <para>The ID of the SubChannel in the request. The response contains an <c>ElasticChannelConfiguration</c> object.</para><note><para>Only required to get a user’s SubChannel membership details.</para></note> </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 <c>AppInstanceUser</c> or <c>AppInstanceBot</c>. <note><para> The <c>x-amz-chime-bearer</c> request header is mandatory. Use the ARN of the <c>AppInstanceUser</c> or <c>AppInstanceBot</c> 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 or bot 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 ARN of the <c>AppInstanceUser</c> or <c>AppInstanceBot</c> 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 <c>x-amz-chime-bearer</c> request header is mandatory. Use the ARN of the <c>AppInstanceUser</c> or <c>AppInstanceBot</c> that makes the API call as the value in the header. </para></note><para> If you want to list the channels to which a specific app instance user belongs, see the <a href="https://docs.aws.amazon.com/chime/latest/APIReference/API_messaging-chime_ListChannelMembershipsForAppInstanceUser.html">ListChannelMembershipsForAppInstanceUser</a> API. </para> </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 ARN of the <c>AppInstanceUser</c> or <c>AppInstanceBot</c> that makes the API call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelMembershipListCmdlet.SubChannelId"> <summary> <para> <para>The ID of the SubChannel in the request.</para><note><para>Only required when listing a user's memberships in a particular sub-channel of an elastic channel.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelMembershipListCmdlet.Type"> <summary> <para> <para>The membership type of a user, <c>DEFAULT</c> or <c>HIDDEN</c>. Default members are returned as part of <c>ListChannelMemberships</c> if no type is specified. Hidden members are only returned if the type filter in <c>ListChannelMemberships</c> equals <c>HIDDEN</c>.</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.GetCHMMGChannelMembershipPreferenceCmdlet"> <summary> Gets the membership preferences of an <c>AppInstanceUser</c> or <c>AppInstanceBot</c> for the specified channel. A user or a bot must be a member of the channel and own the membership in order to retrieve membership preferences. Users or bots in the <c>AppInstanceAdmin</c> and channel moderator roles can't retrieve preferences for other users or bots. Banned users or bots can't retrieve membership preferences for the channel from which they are banned. <note><para> The <c>x-amz-chime-bearer</c> request header is mandatory. Use the ARN of the <c>AppInstanceUser</c> or <c>AppInstanceBot</c> that makes the API call as the value in the header. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelMembershipPreferenceCmdlet.ChannelArn"> <summary> <para> <para>The ARN of the channel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelMembershipPreferenceCmdlet.ChimeBearer"> <summary> <para> <para>The ARN of the <c>AppInstanceUser</c> or <c>AppInstanceBot</c> that makes the API call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelMembershipPreferenceCmdlet.MemberArn"> <summary> <para> <para>The <c>AppInstanceUserArn</c> of the member retrieving the preferences.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelMembershipPreferenceCmdlet.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.GetChannelMembershipPreferencesResponse). Specifying the name of a property of type Amazon.ChimeSDKMessaging.Model.GetChannelMembershipPreferencesResponse 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.GetCHMMGChannelMembershipPreferenceCmdlet.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 an <c>AppInstanceUser</c> or <c>AppInstanceBot</c> is a part of. Only an <c>AppInstanceAdmin</c> can call the API with a user ARN that is not their own. <note><para> The <c>x-amz-chime-bearer</c> request header is mandatory. Use the ARN of the <c>AppInstanceUser</c> or <c>AppInstanceBot</c> 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 user or bot.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelMembershipsForAppInstanceUserListCmdlet.ChimeBearer"> <summary> <para> <para>The ARN of the <c>AppInstanceUser</c> or <c>AppInstanceBot</c> 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 <c>x-amz-chime-bearer</c> request header is mandatory. Use the ARN of the <c>AppInstanceUser</c> or <c>AppInstanceBot</c> 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 ARN of the <c>AppInstanceUser</c> or <c>AppInstanceBot</c> 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.SubChannelId"> <summary> <para> <para>The ID of the SubChannel in the request.</para><note><para>Only required when getting messages in a SubChannel that the user belongs to.</para></note> </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 <c>ChannelMessages</c>. 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 <c>x-amz-chime-bearer</c> request header is mandatory. Use the ARN of the <c>AppInstanceUser</c> or <c>AppInstanceBot</c> 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 ARN of the <c>AppInstanceUser</c> or <c>AppInstanceBot</c> 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.SubChannelId"> <summary> <para> <para>The ID of the SubChannel in the request.</para><note><para>Only required when listing the messages in a SubChannel that the user belongs to.</para></note> </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.GetCHMMGChannelMessageStatusCmdlet"> <summary> Gets message status for a specified <c>messageId</c>. Use this API to determine the intermediate status of messages going through channel flow processing. The API provides an alternative to retrieving message status if the event was not received because a client wasn't connected to a websocket. <para> Messages can have any one of these statuses. </para><dl><dt>SENT</dt><dd><para> Message processed successfully </para></dd><dt>PENDING</dt><dd><para> Ongoing processing </para></dd><dt>FAILED</dt><dd><para> Processing failed </para></dd><dt>DENIED</dt><dd><para> Message denied by the processor </para></dd></dl><note><ul><li><para> This API does not return statuses for denied messages, because we don't store them once the processor denies them. </para></li><li><para> Only the message sender can invoke this API. </para></li><li><para> The <c>x-amz-chime-bearer</c> request header is mandatory. Use the ARN of the <c>AppInstanceUser</c> or <c>AppInstanceBot</c> that makes the API call as the value in the header. </para></li></ul></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelMessageStatusCmdlet.ChannelArn"> <summary> <para> <para>The ARN of the channel</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelMessageStatusCmdlet.ChimeBearer"> <summary> <para> <para>The <c>AppInstanceUserArn</c> of the user making the API call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelMessageStatusCmdlet.MessageId"> <summary> <para> <para>The ID of the message.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelMessageStatusCmdlet.SubChannelId"> <summary> <para> <para>The ID of the SubChannel in the request.</para><note><para>Only required when getting message status in a SubChannel that the user belongs to.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelMessageStatusCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Status'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ChimeSDKMessaging.Model.GetChannelMessageStatusResponse). Specifying the name of a property of type Amazon.ChimeSDKMessaging.Model.GetChannelMessageStatusResponse 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.GetCHMMGChannelMessageStatusCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the MessageId parameter. The -PassThru parameter is deprecated, use -Select '^MessageId' 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 <c>AppInstanceUser</c> or <c>AppInstanceBot</c>. <note><para> The <c>x-amz-chime-bearer</c> request header is mandatory. Use the ARN of the <c>AppInstanceUser</c> or <c>AppInstanceBot</c> 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 user or bot 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 ARN of the <c>AppInstanceUser</c> or <c>AppInstanceBot</c> 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 <c>x-amz-chime-bearer</c> request header is mandatory. Use the <c>AppInstanceUserArn</c> 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 <c>AppInstanceUserArn</c> of the channel moderator.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelModeratorCmdlet.ChimeBearer"> <summary> <para> <para>The ARN of the <c>AppInstanceUser</c> or <c>AppInstanceBot</c> 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 <c>x-amz-chime-bearer</c> request header is mandatory. Use the ARN of the <c>AppInstanceUser</c> or <c>AppInstanceBot</c> 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 ARN of the <c>AppInstanceUser</c> or <c>AppInstanceBot</c> 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.GetCHMMGChannelsAssociatedWithChannelFlowListCmdlet"> <summary> Lists all channels associated with a specified channel flow. You can associate a channel flow with multiple channels, but you can only associate a channel with one channel flow. This is a developer API. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelsAssociatedWithChannelFlowListCmdlet.ChannelFlowArn"> <summary> <para> <para>The ARN of the channel flow.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelsAssociatedWithChannelFlowListCmdlet.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.GetCHMMGChannelsAssociatedWithChannelFlowListCmdlet.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.GetCHMMGChannelsAssociatedWithChannelFlowListCmdlet.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.ListChannelsAssociatedWithChannelFlowResponse). Specifying the name of a property of type Amazon.ChimeSDKMessaging.Model.ListChannelsAssociatedWithChannelFlowResponse 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.GetCHMMGChannelsAssociatedWithChannelFlowListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ChannelFlowArn parameter. The -PassThru parameter is deprecated, use -Select '^ChannelFlowArn' 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 <c>AppInstanceUser</c>. <note><para> The <c>x-amz-chime-bearer</c> request header is mandatory. Use the ARN of the <c>AppInstanceUser</c> or <c>AppInstanceBot</c> 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 or bot in the moderated channel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGChannelsModeratedByAppInstanceUserListCmdlet.ChimeBearer"> <summary> <para> <para>The ARN of the <c>AppInstanceUser</c> or <c>AppInstanceBot</c> 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.GetCHMMGMessagingStreamingConfigurationCmdlet"> <summary> Retrieves the data streaming configuration for an <c>AppInstance</c>. For more information, see <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/streaming-export.html">Streaming messaging data</a> in the <i>Amazon Chime SDK Developer Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGMessagingStreamingConfigurationCmdlet.AppInstanceArn"> <summary> <para> <para>The ARN of the streaming configurations.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGMessagingStreamingConfigurationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'StreamingConfigurations'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ChimeSDKMessaging.Model.GetMessagingStreamingConfigurationsResponse). Specifying the name of a property of type Amazon.ChimeSDKMessaging.Model.GetMessagingStreamingConfigurationsResponse 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.GetCHMMGMessagingStreamingConfigurationCmdlet.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.GetCHMMGResourceTagCmdlet"> <summary> Lists the tags applied to an Amazon Chime SDK messaging resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGResourceTagCmdlet.ResourceARN"> <summary> <para> <para>The ARN of the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGResourceTagCmdlet.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.ChimeSDKMessaging.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.ChimeSDKMessaging.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.CHMMG.GetCHMMGResourceTagCmdlet.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.CHMMG.GetCHMMGSubChannelListCmdlet"> <summary> Lists all the SubChannels in an elastic channel when given a channel ID. Available only to the app instance admins and channel moderators of elastic channels. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGSubChannelListCmdlet.ChannelArn"> <summary> <para> <para>The ARN of elastic channel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGSubChannelListCmdlet.ChimeBearer"> <summary> <para> <para>The <c>AppInstanceUserArn</c> of the user making the API call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGSubChannelListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of sub-channels that you want to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGSubChannelListCmdlet.NextToken"> <summary> <para> <para>The token passed by previous API calls until all requested sub-channels are returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.GetCHMMGSubChannelListCmdlet.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.ListSubChannelsResponse). Specifying the name of a property of type Amazon.ChimeSDKMessaging.Model.ListSubChannelsResponse 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.GetCHMMGSubChannelListCmdlet.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.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 <c>x-amz-chime-bearer</c> request header is mandatory. Use the ARN of the <c>AppInstanceUser</c> or <c>AppInstanceBot</c> 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 ARN of the <c>AppInstanceUser</c> or <c>AppInstanceBot</c> 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.SubChannelId"> <summary> <para> <para>The ID of the SubChannel in the request.</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 <c>x-amz-chime-bearer</c> request header is mandatory. Use the ARN of the <c>AppInstanceUser</c> or <c>AppInstanceBot</c> 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.ChannelId"> <summary> <para> <para>The ID of the channel in the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.NewCHMMGChannelCmdlet.ChimeBearer"> <summary> <para> <para>The ARN of the <c>AppInstanceUser</c> or <c>AppInstanceBot</c> 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 <c>Idempotency</c> token.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.NewCHMMGChannelCmdlet.ExpirationSettings_ExpirationCriterion"> <summary> <para> <para>The conditions that must be met for a channel to expire.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.NewCHMMGChannelCmdlet.ExpirationSettings_ExpirationDay"> <summary> <para> <para>The period in days after which the system automatically deletes a channel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.NewCHMMGChannelCmdlet.ElasticChannelConfiguration_MaximumSubChannel"> <summary> <para> <para>The maximum number of SubChannels that you want to allow in the elastic channel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.NewCHMMGChannelCmdlet.MemberArn"> <summary> <para> <para>The ARNs of the channel members in the request.</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.ElasticChannelConfiguration_MinimumMembershipPercentage"> <summary> <para> <para>The minimum allowed percentage of TargetMembershipsPerSubChannel users. Ceil of the calculated value is used in balancing members among SubChannels of the elastic channel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.NewCHMMGChannelCmdlet.Mode"> <summary> <para> <para>The channel mode: <c>UNRESTRICTED</c> or <c>RESTRICTED</c>. 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.ModeratorArn"> <summary> <para> <para>The ARNs of the channel moderators in the request.</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: <c>PUBLIC</c> or <c>PRIVATE</c>. Private channels aren't discoverable by users outside the channel. Public channels are discoverable by anyone in the <c>AppInstance</c>.</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.ElasticChannelConfiguration_TargetMembershipsPerSubChannel"> <summary> <para> <para>The maximum number of members allowed in a SubChannel.</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 <c>DeleteChannelBan</c>, and then <c>CreateChannelMembership</c>. 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 <c>x-amz-chime-bearer</c> request header is mandatory. Use the ARN of the <c>AppInstanceUser</c> or <c>AppInstanceBot</c> 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 ARN of the <c>AppInstanceUser</c> or <c>AppInstanceBot</c> that makes the API call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.NewCHMMGChannelBanCmdlet.MemberArn"> <summary> <para> <para>The <c>AppInstanceUserArn</c> 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.NewCHMMGChannelFlowCmdlet"> <summary> Creates a channel flow, a container for processors. Processors are AWS Lambda functions that perform actions on chat messages, such as stripping out profanity. You can associate channel flows with channels, and the processors in the channel flow then take action on all messages sent to that channel. This is a developer API. <para> Channel flows process the following items: </para><ol><li><para> New and updated messages </para></li><li><para> Persistent and non-persistent messages </para></li><li><para> The Standard message type </para></li></ol><note><para> Channel flows don't process Control or System messages. For more information about the message types provided by Chime SDK messaging, refer to <a href="https://docs.aws.amazon.com/chime/latest/dg/using-the-messaging-sdk.html#msg-types">Message types</a> in the <i>Amazon Chime developer guide</i>. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.NewCHMMGChannelFlowCmdlet.AppInstanceArn"> <summary> <para> <para>The ARN of the channel flow request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.NewCHMMGChannelFlowCmdlet.ClientRequestToken"> <summary> <para> <para>The client token for the request. An Idempotency token.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.NewCHMMGChannelFlowCmdlet.Name"> <summary> <para> <para>The name of the channel flow.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.NewCHMMGChannelFlowCmdlet.Processor"> <summary> <para> <para>Information about the processor Lambda functions.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.NewCHMMGChannelFlowCmdlet.Tag"> <summary> <para> <para>The tags for the creation request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.NewCHMMGChannelFlowCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ChannelFlowArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ChimeSDKMessaging.Model.CreateChannelFlowResponse). Specifying the name of a property of type Amazon.ChimeSDKMessaging.Model.CreateChannelFlowResponse 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.NewCHMMGChannelFlowCmdlet.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.NewCHMMGChannelFlowCmdlet.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 member to a channel. The <c>InvitedBy</c> field in <c>ChannelMembership</c> 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 <c>x-amz-chime-bearer</c> request header is mandatory. Use the ARN of the <c>AppInstanceUserArn</c> or <c>AppInstanceBot</c> 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 ARN of the <c>AppInstanceUser</c> or <c>AppInstanceBot</c> that makes the API call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.NewCHMMGChannelMembershipCmdlet.MemberArn"> <summary> <para> <para>The <c>AppInstanceUserArn</c> of the member you want to add to the channel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.NewCHMMGChannelMembershipCmdlet.SubChannelId"> <summary> <para> <para>The ID of the SubChannel in the request.</para><note><para>Only required when creating membership in a SubChannel for a moderator in an elastic channel.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.NewCHMMGChannelMembershipCmdlet.Type"> <summary> <para> <para>The membership type of a user, <c>DEFAULT</c> or <c>HIDDEN</c>. Default members are always returned as part of <c>ListChannelMemberships</c>. Hidden members are only returned if the type filter in <c>ListChannelMemberships</c> equals <c>HIDDEN</c>. 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 <c>ChannelModerator</c>. 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 <c>x-amz-chime-bearer</c> request header is mandatory. Use the ARN of the <c>AppInstanceUser</c> or <c>AppInstanceBot</c>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 <c>AppInstanceUserArn</c> of the moderator.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.NewCHMMGChannelModeratorCmdlet.ChimeBearer"> <summary> <para> <para>The ARN of the <c>AppInstanceUser</c> or <c>AppInstanceBot</c> 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 and bots 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 or bots.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.NewCHMMGCreateChannelMembershipCmdlet.ChimeBearer"> <summary> <para> <para>The ARN of the <c>AppInstanceUser</c> or <c>AppInstanceBot</c> 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. Only <c>AppInstanceUsers</c> and <c>AppInstanceBots</c> can be added as a channel member.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.NewCHMMGCreateChannelMembershipCmdlet.SubChannelId"> <summary> <para> <para>The ID of the SubChannel in the request. </para><note><para>Only required when creating membership in a SubChannel for a moderator in an elastic channel.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.NewCHMMGCreateChannelMembershipCmdlet.Type"> <summary> <para> <para>The membership type of a user, <c>DEFAULT</c> or <c>HIDDEN</c>. Default members are always returned as part of <c>ListChannelMemberships</c>. Hidden members are only returned if the type filter in <c>ListChannelMemberships</c> equals <c>HIDDEN</c>. 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.RegisterCHMMGChannelFlowCmdlet"> <summary> Associates a channel flow with a channel. Once associated, all messages to that channel go through channel flow processors. To stop processing, use the <c>DisassociateChannelFlow</c> API. <note><para> Only administrators or channel moderators can associate a channel flow. The <c>x-amz-chime-bearer</c> request header is mandatory. Use the ARN of the <c>AppInstanceUser</c> or <c>AppInstanceBot</c> that makes the API call as the value in the header. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.RegisterCHMMGChannelFlowCmdlet.ChannelArn"> <summary> <para> <para>The ARN of the channel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.RegisterCHMMGChannelFlowCmdlet.ChannelFlowArn"> <summary> <para> <para>The ARN of the channel flow.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.RegisterCHMMGChannelFlowCmdlet.ChimeBearer"> <summary> <para> <para>The <c>AppInstanceUserArn</c> of the user making the API call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.RegisterCHMMGChannelFlowCmdlet.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.AssociateChannelFlowResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.RegisterCHMMGChannelFlowCmdlet.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.RegisterCHMMGChannelFlowCmdlet.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 <c>x-amz-chime-bearer</c> request header is mandatory. Use the ARN of the <c>AppInstanceUserArn</c> or <c>AppInstanceBot</c> 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 ARN of the <c>AppInstanceUser</c> or <c>AppInstanceBot</c> 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 member from a channel's ban list. <note><para> The <c>x-amz-chime-bearer</c> request header is mandatory. Use the ARN of the <c>AppInstanceUser</c> or <c>AppInstanceBot</c> 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 <c>AppInstanceUser</c> was banned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.RemoveCHMMGChannelBanCmdlet.ChimeBearer"> <summary> <para> <para>The ARN of the <c>AppInstanceUser</c> or <c>AppInstanceBot</c> 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 <c>AppInstanceUser</c> 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.RemoveCHMMGChannelFlowCmdlet"> <summary> Deletes a channel flow, an irreversible process. This is a developer API. <note><para> This API works only when the channel flow is not associated with any channel. To get a list of all channels that a channel flow is associated with, use the <c>ListChannelsAssociatedWithChannelFlow</c> API. Use the <c>DisassociateChannelFlow</c> API to disassociate a channel flow from all channels. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.RemoveCHMMGChannelFlowCmdlet.ChannelFlowArn"> <summary> <para> <para>The ARN of the channel flow.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.RemoveCHMMGChannelFlowCmdlet.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.DeleteChannelFlowResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.RemoveCHMMGChannelFlowCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ChannelFlowArn parameter. The -PassThru parameter is deprecated, use -Select '^ChannelFlowArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.RemoveCHMMGChannelFlowCmdlet.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 <c>x-amz-chime-bearer</c> request header is mandatory. Use the <c>AppInstanceUserArn</c> 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 ARN of the <c>AppInstanceUser</c> or <c>AppInstanceBot</c> that makes the API call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.RemoveCHMMGChannelMembershipCmdlet.MemberArn"> <summary> <para> <para>The <c>AppInstanceUserArn</c> of the member that you're removing from the channel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.RemoveCHMMGChannelMembershipCmdlet.SubChannelId"> <summary> <para> <para>The ID of the SubChannel in the request.</para><note><para>Only for use by moderators.</para></note> </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 <c>UpdateChannelMessage</c>. <note><para> The <c>x-amz-chime-bearer</c> request header is mandatory. Use the ARN of the <c>AppInstanceUser</c> or <c>AppInstanceBot</c> 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 ARN of the <c>AppInstanceUser</c> or <c>AppInstanceBot</c> 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.SubChannelId"> <summary> <para> <para>The ID of the SubChannel in the request.</para><note><para>Only required when deleting messages in a SubChannel that the user belongs to.</para></note> </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 <c>x-amz-chime-bearer</c> request header is mandatory. Use the ARN of the <c>AppInstanceUser</c> or <c>AppInstanceBot</c> 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 <c>AppInstanceUserArn</c> of the moderator being deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.RemoveCHMMGChannelModeratorCmdlet.ChimeBearer"> <summary> <para> <para>The ARN of the <c>AppInstanceUser</c> or <c>AppInstanceBot</c> 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.RemoveCHMMGMessagingStreamingConfigurationCmdlet"> <summary> Deletes the streaming configurations for an <c>AppInstance</c>. For more information, see <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/streaming-export.html">Streaming messaging data</a> in the <i>Amazon Chime SDK Developer Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.RemoveCHMMGMessagingStreamingConfigurationCmdlet.AppInstanceArn"> <summary> <para> <para>The ARN of the streaming configurations being deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.RemoveCHMMGMessagingStreamingConfigurationCmdlet.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.DeleteMessagingStreamingConfigurationsResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.RemoveCHMMGMessagingStreamingConfigurationCmdlet.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.RemoveCHMMGMessagingStreamingConfigurationCmdlet.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.RemoveCHMMGResourceTagCmdlet"> <summary> Removes the specified tags from the specified Amazon Chime SDK messaging resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.RemoveCHMMGResourceTagCmdlet.ResourceARN"> <summary> <para> <para>The resource ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.RemoveCHMMGResourceTagCmdlet.TagKey"> <summary> <para> <para>The tag keys.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.RemoveCHMMGResourceTagCmdlet.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.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.RemoveCHMMGResourceTagCmdlet.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.CHMMG.RemoveCHMMGResourceTagCmdlet.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.SearchCHMMGChannelCmdlet"> <summary> Allows the <c>ChimeBearer</c> to search channels by channel members. Users or bots can search across the channels that they belong to. Users in the <c>AppInstanceAdmin</c> role can search across all channels. <para> The <c>x-amz-chime-bearer</c> request header is mandatory. Use the ARN of the <c>AppInstanceUser</c> or <c>AppInstanceBot</c> that makes the API call as the value in the header. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.SearchCHMMGChannelCmdlet.ChimeBearer"> <summary> <para> <para>The <c>AppInstanceUserArn</c> of the user making the API call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.SearchCHMMGChannelCmdlet.Field"> <summary> <para> <para>A list of the <c>Field</c> objects in the channel being searched.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.SearchCHMMGChannelCmdlet.MaxResult"> <summary> <para> <para>The maximum number of channels that you want returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.SearchCHMMGChannelCmdlet.NextToken"> <summary> <para> <para>The token returned from previous API requests until the number of channels is reached.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.SearchCHMMGChannelCmdlet.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.SearchChannelsResponse). Specifying the name of a property of type Amazon.ChimeSDKMessaging.Model.SearchChannelsResponse 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.SearchCHMMGChannelCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ChimeBearer parameter. The -PassThru parameter is deprecated, use -Select '^ChimeBearer' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.SearchCHMMGChannelCmdlet.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.SendCHMMGChannelFlowCallbackCmdlet"> <summary> Calls back Amazon Chime SDK messaging with a processing response message. This should be invoked from the processor Lambda. This is a developer API. <para> You can return one of the following processing responses: </para><ul><li><para> Update message content or metadata </para></li><li><para> Deny a message </para></li><li><para> Make no changes to the message </para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.SendCHMMGChannelFlowCallbackCmdlet.PushNotification_Body"> <summary> <para> <para>The body of the push notification.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.SendCHMMGChannelFlowCallbackCmdlet.CallbackId"> <summary> <para> <para>The identifier passed to the processor by the service when invoked. Use the identifier to call back the service.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.SendCHMMGChannelFlowCallbackCmdlet.ChannelArn"> <summary> <para> <para>The ARN of the channel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.SendCHMMGChannelFlowCallbackCmdlet.ChannelMessage_Content"> <summary> <para> <para>The message content. For Amazon Lex V2 bot responses, this field holds a list of messages originating from the bot. For more information, refer to <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/appinstance-bots#process-response.html">Processing responses from an AppInstanceBot</a> in the <i>Amazon Chime SDK Messaging Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.SendCHMMGChannelFlowCallbackCmdlet.ChannelMessage_ContentType"> <summary> <para> <para>The content type of the call-back message. For Amazon Lex V2 bot responses, the content type is <c>application/amz-chime-lex-msgs</c> for success responses and <c>application/amz-chime-lex-error</c> for failure responses. For more information, refer to <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/appinstance-bots#process-response.html">Processing responses from an AppInstanceBot</a> in the <i>Amazon Chime SDK Messaging Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.SendCHMMGChannelFlowCallbackCmdlet.DeleteResource"> <summary> <para> <para>When a processor determines that a message needs to be <c>DENIED</c>, pass this parameter with a value of true.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.SendCHMMGChannelFlowCallbackCmdlet.ChannelMessage_MessageAttribute"> <summary> <para> <para>The attributes for the channel message. For Amazon Lex V2 bot responses, the attributes are mapped to specific fields from the bot. For more information, refer to <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/appinstance-bots#process-response.html">Processing responses from an AppInstanceBot</a> in the <i>Amazon Chime SDK Messaging Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.SendCHMMGChannelFlowCallbackCmdlet.ChannelMessage_MessageId"> <summary> <para> <para>The message ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.SendCHMMGChannelFlowCallbackCmdlet.ChannelMessage_Metadata"> <summary> <para> <para>The message metadata.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.SendCHMMGChannelFlowCallbackCmdlet.ChannelMessage_SubChannelId"> <summary> <para> <para>The ID of the SubChannel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.SendCHMMGChannelFlowCallbackCmdlet.PushNotification_Title"> <summary> <para> <para>The title of the push notification.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.SendCHMMGChannelFlowCallbackCmdlet.PushNotification_Type"> <summary> <para> <para>Enum value that indicates the type of the push notification for a message. <c>DEFAULT</c>: Normal mobile push notification. <c>VOIP</c>: VOIP mobile push notification.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.SendCHMMGChannelFlowCallbackCmdlet.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.ChannelFlowCallbackResponse). Specifying the name of a property of type Amazon.ChimeSDKMessaging.Model.ChannelFlowCallbackResponse 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.SendCHMMGChannelFlowCallbackCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ChannelMessage_MessageId parameter. The -PassThru parameter is deprecated, use -Select '^ChannelMessage_MessageId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.SendCHMMGChannelFlowCallbackCmdlet.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 <c>x-amz-chime-bearer</c> request header is mandatory. Use the ARN of the <c>AppInstanceUser</c> or <c>AppInstanceBot</c> that makes the API call as the value in the header. </para><para> Also, <c>STANDARD</c> messages can be up to 4KB in size and contain metadata. Metadata is arbitrary, and you can use it in a variety of ways, such as containing a link to an attachment. </para><para><c>CONTROL</c> messages are limited to 30 bytes and do not contain metadata. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.SendCHMMGChannelMessageCmdlet.PushNotification_Body"> <summary> <para> <para>The body of the push notification.</para> </para> </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 ARN of the <c>AppInstanceUser</c> or <c>AppInstanceBot</c> that makes the API call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.SendCHMMGChannelMessageCmdlet.ClientRequestToken"> <summary> <para> <para>The <c>Idempotency</c> 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 channel message.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.SendCHMMGChannelMessageCmdlet.ContentType"> <summary> <para> <para>The content type of the channel message.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.SendCHMMGChannelMessageCmdlet.MessageAttribute"> <summary> <para> <para>The attributes for the message, used for message filtering along with a <c>FilterRule</c> defined in the <c>PushNotificationPreferences</c>.</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.SubChannelId"> <summary> <para> <para>The ID of the SubChannel in the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.SendCHMMGChannelMessageCmdlet.Target"> <summary> <para> <para>The target of a message. Must be a member of the channel, such as another user, a bot, or the sender. Only the target and the sender can view targeted messages. Only users who can see targeted messages can take actions on them. However, administrators can delete targeted messages that they can’t see. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.SendCHMMGChannelMessageCmdlet.PushNotification_Title"> <summary> <para> <para>The title of the push notification.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.SendCHMMGChannelMessageCmdlet.PushNotification_Type"> <summary> <para> <para>Enum value that indicates the type of the push notification for a message. <c>DEFAULT</c>: Normal mobile push notification. <c>VOIP</c>: VOIP mobile push notification.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.SendCHMMGChannelMessageCmdlet.Type"> <summary> <para> <para>The type of message, <c>STANDARD</c> or <c>CONTROL</c>.</para><para><c>STANDARD</c> messages can be up to 4KB in size and contain metadata. Metadata is arbitrary, and you can use it in a variety of ways, such as containing a link to an attachment.</para><para><c>CONTROL</c> messages are limited to 30 bytes and do not contain metadata.</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.UnregisterCHMMGChannelFlowCmdlet"> <summary> Disassociates a channel flow from all its channels. Once disassociated, all messages to that channel stop going through the channel flow processor. <note><para> Only administrators or channel moderators can disassociate a channel flow. </para><para> The <c>x-amz-chime-bearer</c> request header is mandatory. Use the ARN of the <c>AppInstanceUser</c> or <c>AppInstanceBot</c> that makes the API call as the value in the header. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.UnregisterCHMMGChannelFlowCmdlet.ChannelArn"> <summary> <para> <para>The ARN of the channel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.UnregisterCHMMGChannelFlowCmdlet.ChannelFlowArn"> <summary> <para> <para>The ARN of the channel flow.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.UnregisterCHMMGChannelFlowCmdlet.ChimeBearer"> <summary> <para> <para>The <c>AppInstanceUserArn</c> of the user making the API call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.UnregisterCHMMGChannelFlowCmdlet.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.DisassociateChannelFlowResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.UnregisterCHMMGChannelFlowCmdlet.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.UnregisterCHMMGChannelFlowCmdlet.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 <c>x-amz-chime-bearer</c> request header is mandatory. Use the ARN of the <c>AppInstanceUser</c> or <c>AppInstanceBot</c> 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 ARN of the <c>AppInstanceUser</c> or <c>AppInstanceBot</c> 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.UpdateCHMMGChannelFlowCmdlet"> <summary> Updates channel flow attributes. This is a developer API. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.UpdateCHMMGChannelFlowCmdlet.ChannelFlowArn"> <summary> <para> <para>The ARN of the channel flow.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.UpdateCHMMGChannelFlowCmdlet.Name"> <summary> <para> <para>The name of the channel flow.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.UpdateCHMMGChannelFlowCmdlet.Processor"> <summary> <para> <para>Information about the processor Lambda functions </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.UpdateCHMMGChannelFlowCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ChannelFlowArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ChimeSDKMessaging.Model.UpdateChannelFlowResponse). Specifying the name of a property of type Amazon.ChimeSDKMessaging.Model.UpdateChannelFlowResponse 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.UpdateCHMMGChannelFlowCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ChannelFlowArn parameter. The -PassThru parameter is deprecated, use -Select '^ChannelFlowArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.UpdateCHMMGChannelFlowCmdlet.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 <c>x-amz-chime-bearer</c> request header is mandatory. Use the ARN of the <c>AppInstanceUser</c> or <c>AppInstanceBot</c> 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 ARN of the <c>AppInstanceUser</c> or <c>AppInstanceBot</c> 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 channel message. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.UpdateCHMMGChannelMessageCmdlet.ContentType"> <summary> <para> <para>The content type of the channel message.</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.SubChannelId"> <summary> <para> <para>The ID of the SubChannel in the request.</para><note><para>Only required when updating messages in a SubChannel that the user belongs to.</para></note> </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 <c>x-amz-chime-bearer</c> request header is mandatory. Use the ARN of the <c>AppInstanceUser</c> or <c>AppInstanceBot</c> 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 ARN of the <c>AppInstanceUser</c> or <c>AppInstanceBot</c> 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> <member name="T:Amazon.PowerShell.Cmdlets.CHMMG.WriteCHMMGChannelExpirationSettingCmdlet"> <summary> Sets the number of days before the channel is automatically deleted. <note><ul><li><para> A background process deletes expired channels within 6 hours of expiration. Actual deletion times may vary. </para></li><li><para> Expired channels that have not yet been deleted appear as active, and you can update their expiration settings. The system honors the new settings. </para></li><li><para> The <c>x-amz-chime-bearer</c> request header is mandatory. Use the ARN of the <c>AppInstanceUser</c> or <c>AppInstanceBot</c> that makes the API call as the value in the header. </para></li></ul></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.WriteCHMMGChannelExpirationSettingCmdlet.ChannelArn"> <summary> <para> <para>The ARN of the channel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.WriteCHMMGChannelExpirationSettingCmdlet.ChimeBearer"> <summary> <para> <para>The ARN of the <c>AppInstanceUser</c> or <c>AppInstanceBot</c> that makes the API call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.WriteCHMMGChannelExpirationSettingCmdlet.ExpirationSettings_ExpirationCriterion"> <summary> <para> <para>The conditions that must be met for a channel to expire.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.WriteCHMMGChannelExpirationSettingCmdlet.ExpirationSettings_ExpirationDay"> <summary> <para> <para>The period in days after which the system automatically deletes a channel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.WriteCHMMGChannelExpirationSettingCmdlet.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.PutChannelExpirationSettingsResponse). Specifying the name of a property of type Amazon.ChimeSDKMessaging.Model.PutChannelExpirationSettingsResponse 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.WriteCHMMGChannelExpirationSettingCmdlet.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.WriteCHMMGChannelExpirationSettingCmdlet.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.WriteCHMMGChannelMembershipPreferenceCmdlet"> <summary> Sets the membership preferences of an <c>AppInstanceUser</c> or <c>AppInstanceBot</c> for the specified channel. The user or bot must be a member of the channel. Only the user or bot who owns the membership can set preferences. Users or bots in the <c>AppInstanceAdmin</c> and channel moderator roles can't set preferences for other users. Banned users or bots can't set membership preferences for the channel from which they are banned. <note><para> The x-amz-chime-bearer request header is mandatory. Use the ARN of an <c>AppInstanceUser</c> or <c>AppInstanceBot</c> that makes the API call as the value in the header. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.WriteCHMMGChannelMembershipPreferenceCmdlet.PushNotifications_AllowNotification"> <summary> <para> <para>Enum value that indicates which push notifications to send to the requested member of a channel. <c>ALL</c> sends all push notifications, <c>NONE</c> sends no push notifications, <c>FILTERED</c> sends only filtered push notifications. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.WriteCHMMGChannelMembershipPreferenceCmdlet.ChannelArn"> <summary> <para> <para>The ARN of the channel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.WriteCHMMGChannelMembershipPreferenceCmdlet.ChimeBearer"> <summary> <para> <para>The ARN of the <c>AppInstanceUser</c> or <c>AppInstanceBot</c> that makes the API call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.WriteCHMMGChannelMembershipPreferenceCmdlet.PushNotifications_FilterRule"> <summary> <para> <para>The simple JSON object used to send a subset of a push notification to the requested member.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.WriteCHMMGChannelMembershipPreferenceCmdlet.MemberArn"> <summary> <para> <para>The ARN of the member setting the preferences.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.WriteCHMMGChannelMembershipPreferenceCmdlet.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.PutChannelMembershipPreferencesResponse). Specifying the name of a property of type Amazon.ChimeSDKMessaging.Model.PutChannelMembershipPreferencesResponse 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.WriteCHMMGChannelMembershipPreferenceCmdlet.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.WriteCHMMGChannelMembershipPreferenceCmdlet.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.WriteCHMMGMessagingStreamingConfigurationCmdlet"> <summary> Sets the data streaming configuration for an <c>AppInstance</c>. For more information, see <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/streaming-export.html">Streaming messaging data</a> in the <i>Amazon Chime SDK Developer Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.WriteCHMMGMessagingStreamingConfigurationCmdlet.AppInstanceArn"> <summary> <para> <para>The ARN of the streaming configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.WriteCHMMGMessagingStreamingConfigurationCmdlet.StreamingConfiguration"> <summary> <para> <para>The streaming configurations.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMG.WriteCHMMGMessagingStreamingConfigurationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'StreamingConfigurations'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ChimeSDKMessaging.Model.PutMessagingStreamingConfigurationsResponse). Specifying the name of a property of type Amazon.ChimeSDKMessaging.Model.PutMessagingStreamingConfigurationsResponse 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.WriteCHMMGMessagingStreamingConfigurationCmdlet.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.WriteCHMMGMessagingStreamingConfigurationCmdlet.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> |