AWS.Tools.ChimeSDKIdentity.XML
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.ChimeSDKIdentity</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.CHMID.AddCHMIDResourceTagCmdlet"> <summary> Applies the specified tags to the specified Amazon Chime SDK identity resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.AddCHMIDResourceTagCmdlet.ResourceARN"> <summary> <para> <para>The resource ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.AddCHMIDResourceTagCmdlet.Tag"> <summary> <para> <para>The tag key-value pairs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.AddCHMIDResourceTagCmdlet.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.ChimeSDKIdentity.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.AddCHMIDResourceTagCmdlet.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.CHMID.AddCHMIDResourceTagCmdlet.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.CHMID.GetCHMIDAppInstanceCmdlet"> <summary> Returns the full details of an <code>AppInstance</code>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.GetCHMIDAppInstanceCmdlet.AppInstanceArn"> <summary> <para> <para>The ARN of the <code>AppInstance</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.GetCHMIDAppInstanceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AppInstance'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ChimeSDKIdentity.Model.DescribeAppInstanceResponse). Specifying the name of a property of type Amazon.ChimeSDKIdentity.Model.DescribeAppInstanceResponse 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.CHMID.GetCHMIDAppInstanceCmdlet.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.CHMID.GetCHMIDAppInstanceAdminCmdlet"> <summary> Returns the full details of an <code>AppInstanceAdmin</code>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.GetCHMIDAppInstanceAdminCmdlet.AppInstanceAdminArn"> <summary> <para> <para>The ARN of the <code>AppInstanceAdmin</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.GetCHMIDAppInstanceAdminCmdlet.AppInstanceArn"> <summary> <para> <para>The ARN of the <code>AppInstance</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.GetCHMIDAppInstanceAdminCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AppInstanceAdmin'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ChimeSDKIdentity.Model.DescribeAppInstanceAdminResponse). Specifying the name of a property of type Amazon.ChimeSDKIdentity.Model.DescribeAppInstanceAdminResponse 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.CHMID.GetCHMIDAppInstanceAdminCmdlet.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.CHMID.GetCHMIDAppInstanceAdminListCmdlet"> <summary> Returns a list of the administrators in the <code>AppInstance</code>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.GetCHMIDAppInstanceAdminListCmdlet.AppInstanceArn"> <summary> <para> <para>The ARN of the <code>AppInstance</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.GetCHMIDAppInstanceAdminListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of administrators that you want to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.GetCHMIDAppInstanceAdminListCmdlet.NextToken"> <summary> <para> <para>The token returned from previous API requests until the number of administrators is reached.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.GetCHMIDAppInstanceAdminListCmdlet.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.ChimeSDKIdentity.Model.ListAppInstanceAdminsResponse). Specifying the name of a property of type Amazon.ChimeSDKIdentity.Model.ListAppInstanceAdminsResponse 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.CHMID.GetCHMIDAppInstanceAdminListCmdlet.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.CHMID.GetCHMIDAppInstanceListCmdlet"> <summary> Lists all Amazon Chime <code>AppInstance</code>s created under a single AWS account. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.GetCHMIDAppInstanceListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of <code>AppInstance</code>s that you want to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.GetCHMIDAppInstanceListCmdlet.NextToken"> <summary> <para> <para>The token passed by previous API requests until you reach the maximum number of <code>AppInstances</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.GetCHMIDAppInstanceListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AppInstances'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ChimeSDKIdentity.Model.ListAppInstancesResponse). Specifying the name of a property of type Amazon.ChimeSDKIdentity.Model.ListAppInstancesResponse 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.CHMID.GetCHMIDAppInstanceRetentionSettingCmdlet"> <summary> Gets the retention settings for an <code>AppInstance</code>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.GetCHMIDAppInstanceRetentionSettingCmdlet.AppInstanceArn"> <summary> <para> <para>The ARN of the <code>AppInstance</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.GetCHMIDAppInstanceRetentionSettingCmdlet.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.ChimeSDKIdentity.Model.GetAppInstanceRetentionSettingsResponse). Specifying the name of a property of type Amazon.ChimeSDKIdentity.Model.GetAppInstanceRetentionSettingsResponse 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.CHMID.GetCHMIDAppInstanceRetentionSettingCmdlet.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.CHMID.GetCHMIDAppInstanceUserCmdlet"> <summary> Returns the full details of an <code>AppInstanceUser</code>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.GetCHMIDAppInstanceUserCmdlet.AppInstanceUserArn"> <summary> <para> <para>The ARN of the <code>AppInstanceUser</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.GetCHMIDAppInstanceUserCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AppInstanceUser'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ChimeSDKIdentity.Model.DescribeAppInstanceUserResponse). Specifying the name of a property of type Amazon.ChimeSDKIdentity.Model.DescribeAppInstanceUserResponse 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.CHMID.GetCHMIDAppInstanceUserCmdlet.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.CHMID.GetCHMIDAppInstanceUserEndpointCmdlet"> <summary> Returns the full details of an <code>AppInstanceUserEndpoint</code>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.GetCHMIDAppInstanceUserEndpointCmdlet.AppInstanceUserArn"> <summary> <para> <para>The ARN of the <code>AppInstanceUser</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.GetCHMIDAppInstanceUserEndpointCmdlet.EndpointId"> <summary> <para> <para>The unique identifier of the <code>AppInstanceUserEndpoint</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.GetCHMIDAppInstanceUserEndpointCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AppInstanceUserEndpoint'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ChimeSDKIdentity.Model.DescribeAppInstanceUserEndpointResponse). Specifying the name of a property of type Amazon.ChimeSDKIdentity.Model.DescribeAppInstanceUserEndpointResponse 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.CHMID.GetCHMIDAppInstanceUserEndpointCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EndpointId parameter. The -PassThru parameter is deprecated, use -Select '^EndpointId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CHMID.GetCHMIDAppInstanceUserEndpointListCmdlet"> <summary> Lists all the <code>AppInstanceUserEndpoints</code> created under a single <code>AppInstanceUser</code>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.GetCHMIDAppInstanceUserEndpointListCmdlet.AppInstanceUserArn"> <summary> <para> <para>The ARN of the <code>AppInstanceUser</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.GetCHMIDAppInstanceUserEndpointListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of endpoints that you want to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.GetCHMIDAppInstanceUserEndpointListCmdlet.NextToken"> <summary> <para> <para>The token passed by previous API calls until all requested endpoints are returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.GetCHMIDAppInstanceUserEndpointListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AppInstanceUserEndpoints'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ChimeSDKIdentity.Model.ListAppInstanceUserEndpointsResponse). Specifying the name of a property of type Amazon.ChimeSDKIdentity.Model.ListAppInstanceUserEndpointsResponse 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.CHMID.GetCHMIDAppInstanceUserEndpointListCmdlet.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.CHMID.GetCHMIDAppInstanceUserListCmdlet"> <summary> List all <code>AppInstanceUsers</code> created under a single <code>AppInstance</code>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.GetCHMIDAppInstanceUserListCmdlet.AppInstanceArn"> <summary> <para> <para>The ARN of the <code>AppInstance</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.GetCHMIDAppInstanceUserListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of requests that you want returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.GetCHMIDAppInstanceUserListCmdlet.NextToken"> <summary> <para> <para>The token passed by previous API calls until all requested users are returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.GetCHMIDAppInstanceUserListCmdlet.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.ChimeSDKIdentity.Model.ListAppInstanceUsersResponse). Specifying the name of a property of type Amazon.ChimeSDKIdentity.Model.ListAppInstanceUsersResponse 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.CHMID.GetCHMIDAppInstanceUserListCmdlet.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.CHMID.GetCHMIDResourceTagCmdlet"> <summary> Lists the tags applied to an Amazon Chime SDK identity resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.GetCHMIDResourceTagCmdlet.ResourceARN"> <summary> <para> <para>The ARN of the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.GetCHMIDResourceTagCmdlet.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.ChimeSDKIdentity.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.ChimeSDKIdentity.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.CHMID.GetCHMIDResourceTagCmdlet.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.CHMID.NewCHMIDAppInstanceCmdlet"> <summary> Creates an Amazon Chime SDK messaging <code>AppInstance</code> under an AWS account. Only SDK messaging customers use this API. <code>CreateAppInstance</code> supports idempotency behavior as described in the AWS API Standard. <para> identity </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.NewCHMIDAppInstanceCmdlet.ClientRequestToken"> <summary> <para> <para>The <code>ClientRequestToken</code> of the <code>AppInstance</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.NewCHMIDAppInstanceCmdlet.Metadata"> <summary> <para> <para>The metadata of the <code>AppInstance</code>. Limited to a 1KB string in UTF-8.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.NewCHMIDAppInstanceCmdlet.Name"> <summary> <para> <para>The name of the <code>AppInstance</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.NewCHMIDAppInstanceCmdlet.Tag"> <summary> <para> <para>Tags assigned to the <code>AppInstanceUser</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.NewCHMIDAppInstanceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AppInstanceArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ChimeSDKIdentity.Model.CreateAppInstanceResponse). Specifying the name of a property of type Amazon.ChimeSDKIdentity.Model.CreateAppInstanceResponse 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.CHMID.NewCHMIDAppInstanceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.NewCHMIDAppInstanceCmdlet.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.CHMID.NewCHMIDAppInstanceAdminCmdlet"> <summary> Promotes an <code>AppInstanceUser</code> to an <code>AppInstanceAdmin</code>. The promoted user can perform the following actions. <ul><li><para><code>ChannelModerator</code> actions across all channels in the <code>AppInstance</code>. </para></li><li><para><code>DeleteChannelMessage</code> actions. </para></li></ul><para> Only an <code>AppInstanceUser</code> can be promoted to an <code>AppInstanceAdmin</code> role. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.NewCHMIDAppInstanceAdminCmdlet.AppInstanceAdminArn"> <summary> <para> <para>The ARN of the administrator of the current <code>AppInstance</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.NewCHMIDAppInstanceAdminCmdlet.AppInstanceArn"> <summary> <para> <para>The ARN of the <code>AppInstance</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.NewCHMIDAppInstanceAdminCmdlet.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.ChimeSDKIdentity.Model.CreateAppInstanceAdminResponse). Specifying the name of a property of type Amazon.ChimeSDKIdentity.Model.CreateAppInstanceAdminResponse 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.CHMID.NewCHMIDAppInstanceAdminCmdlet.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.CHMID.NewCHMIDAppInstanceAdminCmdlet.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.CHMID.NewCHMIDAppInstanceUserCmdlet"> <summary> Creates a user under an Amazon Chime <code>AppInstance</code>. The request consists of a unique <code>appInstanceUserId</code> and <code>Name</code> for that user. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.NewCHMIDAppInstanceUserCmdlet.AppInstanceArn"> <summary> <para> <para>The ARN of the <code>AppInstance</code> request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.NewCHMIDAppInstanceUserCmdlet.AppInstanceUserId"> <summary> <para> <para>The user ID of the <code>AppInstance</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.NewCHMIDAppInstanceUserCmdlet.ClientRequestToken"> <summary> <para> <para>The token assigned to the user requesting an <code>AppInstance</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.NewCHMIDAppInstanceUserCmdlet.Metadata"> <summary> <para> <para>The request's metadata. Limited to a 1KB string in UTF-8.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.NewCHMIDAppInstanceUserCmdlet.Name"> <summary> <para> <para>The user's name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.NewCHMIDAppInstanceUserCmdlet.Tag"> <summary> <para> <para>Tags assigned to the <code>AppInstanceUser</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.NewCHMIDAppInstanceUserCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AppInstanceUserArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ChimeSDKIdentity.Model.CreateAppInstanceUserResponse). Specifying the name of a property of type Amazon.ChimeSDKIdentity.Model.CreateAppInstanceUserResponse 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.CHMID.NewCHMIDAppInstanceUserCmdlet.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.CHMID.NewCHMIDAppInstanceUserCmdlet.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.CHMID.RegisterCHMIDAppInstanceUserEndpointCmdlet"> <summary> Registers an endpoint under an Amazon Chime <code>AppInstanceUser</code>. The endpoint receives messages for a user. For push notifications, the endpoint is a mobile device used to receive mobile push notifications for a user. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.RegisterCHMIDAppInstanceUserEndpointCmdlet.AllowMessage"> <summary> <para> <para>Boolean that controls whether the AppInstanceUserEndpoint is opted in to receive messages. <code>ALL</code> indicates the endpoint receives all messages. <code>NONE</code> indicates the endpoint receives no messages.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.RegisterCHMIDAppInstanceUserEndpointCmdlet.AppInstanceUserArn"> <summary> <para> <para>The ARN of the <code>AppInstanceUser</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.RegisterCHMIDAppInstanceUserEndpointCmdlet.ClientRequestToken"> <summary> <para> <para>The idempotency token for each client request. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.RegisterCHMIDAppInstanceUserEndpointCmdlet.EndpointAttributes_DeviceToken"> <summary> <para> <para>The device token for the GCM, APNS, and APNS_SANDBOX endpoint types.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.RegisterCHMIDAppInstanceUserEndpointCmdlet.Name"> <summary> <para> <para>The name of the <code>AppInstanceUserEndpoint</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.RegisterCHMIDAppInstanceUserEndpointCmdlet.ResourceArn"> <summary> <para> <para>The ARN of the resource to which the endpoint belongs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.RegisterCHMIDAppInstanceUserEndpointCmdlet.Type"> <summary> <para> <para>The type of the <code>AppInstanceUserEndpoint</code>. Supported types:</para><ul><li><para><code>APNS</code>: The mobile notification service for an Apple device.</para></li><li><para><code>APNS_SANDBOX</code>: The sandbox environment of the mobile notification service for an Apple device.</para></li><li><para><code>GCM</code>: The mobile notification service for an Android device.</para></li></ul><para>Populate the <code>ResourceArn</code> value of each type as <code>PinpointAppArn</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.RegisterCHMIDAppInstanceUserEndpointCmdlet.EndpointAttributes_VoipDeviceToken"> <summary> <para> <para>The VOIP device token for the APNS and APNS_SANDBOX endpoint types.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.RegisterCHMIDAppInstanceUserEndpointCmdlet.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.ChimeSDKIdentity.Model.RegisterAppInstanceUserEndpointResponse). Specifying the name of a property of type Amazon.ChimeSDKIdentity.Model.RegisterAppInstanceUserEndpointResponse 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.CHMID.RegisterCHMIDAppInstanceUserEndpointCmdlet.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.CHMID.RemoveCHMIDAppInstanceCmdlet"> <summary> Deletes an <code>AppInstance</code> and all associated data asynchronously. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.RemoveCHMIDAppInstanceCmdlet.AppInstanceArn"> <summary> <para> <para>The ARN of the <code>AppInstance</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.RemoveCHMIDAppInstanceCmdlet.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.ChimeSDKIdentity.Model.DeleteAppInstanceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.RemoveCHMIDAppInstanceCmdlet.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.CHMID.RemoveCHMIDAppInstanceCmdlet.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.CHMID.RemoveCHMIDAppInstanceAdminCmdlet"> <summary> Demotes an <code>AppInstanceAdmin</code> to an <code>AppInstanceUser</code>. This action does not delete the user. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.RemoveCHMIDAppInstanceAdminCmdlet.AppInstanceAdminArn"> <summary> <para> <para>The ARN of the <code>AppInstance</code>'s administrator.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.RemoveCHMIDAppInstanceAdminCmdlet.AppInstanceArn"> <summary> <para> <para>The ARN of the <code>AppInstance</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.RemoveCHMIDAppInstanceAdminCmdlet.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.ChimeSDKIdentity.Model.DeleteAppInstanceAdminResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.RemoveCHMIDAppInstanceAdminCmdlet.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.CHMID.RemoveCHMIDAppInstanceAdminCmdlet.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.CHMID.RemoveCHMIDAppInstanceUserCmdlet"> <summary> Deletes an <code>AppInstanceUser</code>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.RemoveCHMIDAppInstanceUserCmdlet.AppInstanceUserArn"> <summary> <para> <para>The ARN of the user request being deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.RemoveCHMIDAppInstanceUserCmdlet.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.ChimeSDKIdentity.Model.DeleteAppInstanceUserResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.RemoveCHMIDAppInstanceUserCmdlet.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="P:Amazon.PowerShell.Cmdlets.CHMID.RemoveCHMIDAppInstanceUserCmdlet.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.CHMID.RemoveCHMIDResourceTagCmdlet"> <summary> Removes the specified tags from the specified Amazon Chime SDK identity resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.RemoveCHMIDResourceTagCmdlet.ResourceARN"> <summary> <para> <para>The resource ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.RemoveCHMIDResourceTagCmdlet.TagKey"> <summary> <para> <para>The tag keys.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.RemoveCHMIDResourceTagCmdlet.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.ChimeSDKIdentity.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.RemoveCHMIDResourceTagCmdlet.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.CHMID.RemoveCHMIDResourceTagCmdlet.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.CHMID.UnregisterCHMIDAppInstanceUserEndpointCmdlet"> <summary> Deregisters an <code>AppInstanceUserEndpoint</code>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.UnregisterCHMIDAppInstanceUserEndpointCmdlet.AppInstanceUserArn"> <summary> <para> <para>The ARN of the <code>AppInstanceUser</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.UnregisterCHMIDAppInstanceUserEndpointCmdlet.EndpointId"> <summary> <para> <para>The unique identifier of the <code>AppInstanceUserEndpoint</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.UnregisterCHMIDAppInstanceUserEndpointCmdlet.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.ChimeSDKIdentity.Model.DeregisterAppInstanceUserEndpointResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.UnregisterCHMIDAppInstanceUserEndpointCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EndpointId parameter. The -PassThru parameter is deprecated, use -Select '^EndpointId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.UnregisterCHMIDAppInstanceUserEndpointCmdlet.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.CHMID.UpdateCHMIDAppInstanceCmdlet"> <summary> Updates <code>AppInstance</code> metadata. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.UpdateCHMIDAppInstanceCmdlet.AppInstanceArn"> <summary> <para> <para>The ARN of the <code>AppInstance</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.UpdateCHMIDAppInstanceCmdlet.Metadata"> <summary> <para> <para>The metadata that you want to change.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.UpdateCHMIDAppInstanceCmdlet.Name"> <summary> <para> <para>The name that you want to change.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.UpdateCHMIDAppInstanceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AppInstanceArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ChimeSDKIdentity.Model.UpdateAppInstanceResponse). Specifying the name of a property of type Amazon.ChimeSDKIdentity.Model.UpdateAppInstanceResponse 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.CHMID.UpdateCHMIDAppInstanceCmdlet.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.CHMID.UpdateCHMIDAppInstanceCmdlet.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.CHMID.UpdateCHMIDAppInstanceUserCmdlet"> <summary> Updates the details of an <code>AppInstanceUser</code>. You can update names and metadata. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.UpdateCHMIDAppInstanceUserCmdlet.AppInstanceUserArn"> <summary> <para> <para>The ARN of the <code>AppInstanceUser</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.UpdateCHMIDAppInstanceUserCmdlet.Metadata"> <summary> <para> <para>The metadata of the <code>AppInstanceUser</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.UpdateCHMIDAppInstanceUserCmdlet.Name"> <summary> <para> <para>The name of the <code>AppInstanceUser</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.UpdateCHMIDAppInstanceUserCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AppInstanceUserArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ChimeSDKIdentity.Model.UpdateAppInstanceUserResponse). Specifying the name of a property of type Amazon.ChimeSDKIdentity.Model.UpdateAppInstanceUserResponse 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.CHMID.UpdateCHMIDAppInstanceUserCmdlet.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="P:Amazon.PowerShell.Cmdlets.CHMID.UpdateCHMIDAppInstanceUserCmdlet.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.CHMID.UpdateCHMIDAppInstanceUserEndpointCmdlet"> <summary> Updates the details of an <code>AppInstanceUserEndpoint</code>. You can update the name and <code>AllowMessage</code> values. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.UpdateCHMIDAppInstanceUserEndpointCmdlet.AllowMessage"> <summary> <para> <para>Boolean that controls whether the <code>AppInstanceUserEndpoint</code> is opted in to receive messages. <code>ALL</code> indicates the endpoint will receive all messages. <code>NONE</code> indicates the endpoint will receive no messages.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.UpdateCHMIDAppInstanceUserEndpointCmdlet.AppInstanceUserArn"> <summary> <para> <para>The ARN of the <code>AppInstanceUser</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.UpdateCHMIDAppInstanceUserEndpointCmdlet.EndpointId"> <summary> <para> <para>The unique identifier of the <code>AppInstanceUserEndpoint</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.UpdateCHMIDAppInstanceUserEndpointCmdlet.Name"> <summary> <para> <para>The name of the <code>AppInstanceUserEndpoint</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.UpdateCHMIDAppInstanceUserEndpointCmdlet.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.ChimeSDKIdentity.Model.UpdateAppInstanceUserEndpointResponse). Specifying the name of a property of type Amazon.ChimeSDKIdentity.Model.UpdateAppInstanceUserEndpointResponse 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.CHMID.UpdateCHMIDAppInstanceUserEndpointCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EndpointId parameter. The -PassThru parameter is deprecated, use -Select '^EndpointId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.UpdateCHMIDAppInstanceUserEndpointCmdlet.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.CHMID.WriteCHMIDAppInstanceRetentionSettingCmdlet"> <summary> Sets the amount of time in days that a given <code>AppInstance</code> retains data. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.WriteCHMIDAppInstanceRetentionSettingCmdlet.AppInstanceArn"> <summary> <para> <para>The ARN of the <code>AppInstance</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.WriteCHMIDAppInstanceRetentionSettingCmdlet.ChannelRetentionSettings_RetentionDay"> <summary> <para> <para>The time in days to retain the messages in a channel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMID.WriteCHMIDAppInstanceRetentionSettingCmdlet.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.ChimeSDKIdentity.Model.PutAppInstanceRetentionSettingsResponse). Specifying the name of a property of type Amazon.ChimeSDKIdentity.Model.PutAppInstanceRetentionSettingsResponse 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.CHMID.WriteCHMIDAppInstanceRetentionSettingCmdlet.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.CHMID.WriteCHMIDAppInstanceRetentionSettingCmdlet.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> |