AWS.Tools.Chime.XML
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.Chime</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.CHM.AddCHMPhoneNumbersToVoiceConnectorCmdlet"> <summary> Associates a phone number with the specified Amazon Chime Voice Connector. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.AddCHMPhoneNumbersToVoiceConnectorCmdlet.E164PhoneNumber"> <summary> <para> <para>List of phone numbers, in E.164 format.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.AddCHMPhoneNumbersToVoiceConnectorCmdlet.VoiceConnectorId"> <summary> <para> <para>The Amazon Chime Voice Connector ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.AddCHMPhoneNumbersToVoiceConnectorCmdlet.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.CHM.AddCHMPhoneNumberToUserCmdlet"> <summary> Associates a phone number with the specified Amazon Chime user. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.AddCHMPhoneNumberToUserCmdlet.AccountId"> <summary> <para> <para>The Amazon Chime account ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.AddCHMPhoneNumberToUserCmdlet.E164PhoneNumber"> <summary> <para> <para>The phone number, in E.164 format.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.AddCHMPhoneNumberToUserCmdlet.UserId"> <summary> <para> <para>The user ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.AddCHMPhoneNumberToUserCmdlet.PassThru"> <summary> Returns the value passed to the UserId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.AddCHMPhoneNumberToUserCmdlet.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.CHM.DisableCHMUserSuspensionBatchCmdlet"> <summary> Removes the suspension from up to 50 previously suspended users for the specified Amazon Chime <code>EnterpriseLWA</code> account. Only users on <code>EnterpriseLWA</code> accounts can be unsuspended using this action. For more information about different account types, see <a href="https://docs.aws.amazon.com/chime/latest/ag/manage-chime-account.html">Managing Your Amazon Chime Accounts</a> in the <i>Amazon Chime Administration Guide</i>. <para> Previously suspended users who are unsuspended using this action are returned to <code>Registered</code> status. Users who are not previously suspended are ignored. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.DisableCHMUserSuspensionBatchCmdlet.AccountId"> <summary> <para> <para>The Amazon Chime account ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.DisableCHMUserSuspensionBatchCmdlet.UserIdList"> <summary> <para> <para>The request containing the user IDs to unsuspend.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.DisableCHMUserSuspensionBatchCmdlet.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.CHM.EnableCHMUserSuspensionBatchCmdlet"> <summary> Suspends up to 50 users from a <code>Team</code> or <code>EnterpriseLWA</code> Amazon Chime account. For more information about different account types, see <a href="https://docs.aws.amazon.com/chime/latest/ag/manage-chime-account.html">Managing Your Amazon Chime Accounts</a> in the <i>Amazon Chime Administration Guide</i>. <para> Users suspended from a <code>Team</code> account are dissasociated from the account, but they can continue to use Amazon Chime as free users. To remove the suspension from suspended <code>Team</code> account users, invite them to the <code>Team</code> account again. You can use the <a>InviteUsers</a> action to do so. </para><para> Users suspended from an <code>EnterpriseLWA</code> account are immediately signed out of Amazon Chime and can no longer sign in. To remove the suspension from suspended <code>EnterpriseLWA</code> account users, use the <a>BatchUnsuspendUser</a> action. </para><para> To sign out users without suspending them, use the <a>LogoutUser</a> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.EnableCHMUserSuspensionBatchCmdlet.AccountId"> <summary> <para> <para>The Amazon Chime account ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.EnableCHMUserSuspensionBatchCmdlet.UserIdList"> <summary> <para> <para>The request containing the user IDs to suspend.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.EnableCHMUserSuspensionBatchCmdlet.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.CHM.GetCHMAccountCmdlet"> <summary> Retrieves details for the specified Amazon Chime account, such as account type and supported licenses. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.GetCHMAccountCmdlet.AccountId"> <summary> <para> <para>The Amazon Chime account ID.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CHM.GetCHMAccountListCmdlet"> <summary> Lists the Amazon Chime accounts under the administrator's AWS account. You can filter accounts by account name prefix. To find out which Amazon Chime account a user belongs to, you can filter by the user's email address, which returns one account result.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.GetCHMAccountListCmdlet.Name"> <summary> <para> <para>Amazon Chime account name prefix with which to filter results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.GetCHMAccountListCmdlet.UserEmail"> <summary> <para> <para>User email address with which to filter results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.GetCHMAccountListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in a single call. Defaults to 100.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.GetCHMAccountListCmdlet.NextToken"> <summary> <para> <para>The token to use to retrieve the next page of results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CHM.GetCHMAccountSettingCmdlet"> <summary> Retrieves account settings for the specified Amazon Chime account ID, such as remote control and dial out settings. For more information about these settings, see <a href="https://docs.aws.amazon.com/chime/latest/ag/policies.html">Use the Policies Page</a> in the <i>Amazon Chime Administration Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.GetCHMAccountSettingCmdlet.AccountId"> <summary> <para> <para>The Amazon Chime account ID.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CHM.GetCHMBotCmdlet"> <summary> Retrieves details for the specified bot, such as bot email address, bot type, status, and display name. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.GetCHMBotCmdlet.AccountId"> <summary> <para> <para>The Amazon Chime account ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.GetCHMBotCmdlet.BotId"> <summary> <para> <para>The bot ID.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CHM.GetCHMBotListCmdlet"> <summary> Lists the bots associated with the administrator's Amazon Chime Enterprise account ID.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.GetCHMBotListCmdlet.AccountId"> <summary> <para> <para>The Amazon Chime account ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.GetCHMBotListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in a single call. Default is 10.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.GetCHMBotListCmdlet.NextToken"> <summary> <para> <para>The token to use to retrieve the next page of results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CHM.GetCHMEventsConfigurationCmdlet"> <summary> Gets details for an events configuration that allows a bot to receive outgoing events, such as an HTTPS endpoint or Lambda function ARN. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.GetCHMEventsConfigurationCmdlet.AccountId"> <summary> <para> <para>The Amazon Chime account ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.GetCHMEventsConfigurationCmdlet.BotId"> <summary> <para> <para>The bot ID.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CHM.GetCHMGlobalSettingCmdlet"> <summary> Retrieves global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CHM.GetCHMPhoneNumberCmdlet"> <summary> Retrieves details for the specified phone number ID, such as associations, capabilities, and product type. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.GetCHMPhoneNumberCmdlet.PhoneNumberId"> <summary> <para> <para>The phone number ID.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CHM.GetCHMPhoneNumberListCmdlet"> <summary> Lists the phone numbers for the specified Amazon Chime account, Amazon Chime user, or Amazon Chime Voice Connector.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.GetCHMPhoneNumberListCmdlet.FilterName"> <summary> <para> <para>The filter to use to limit the number of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.GetCHMPhoneNumberListCmdlet.FilterValue"> <summary> <para> <para>The value to use for the filter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.GetCHMPhoneNumberListCmdlet.ProductType"> <summary> <para> <para>The phone number product type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.GetCHMPhoneNumberListCmdlet.Status"> <summary> <para> <para>The phone number status.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.GetCHMPhoneNumberListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in a single call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.GetCHMPhoneNumberListCmdlet.NextToken"> <summary> <para> <para>The token to use to retrieve the next page of results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CHM.GetCHMPhoneNumberOrderCmdlet"> <summary> Retrieves details for the specified phone number order, such as order creation timestamp, phone numbers in E.164 format, product type, and order status. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.GetCHMPhoneNumberOrderCmdlet.PhoneNumberOrderId"> <summary> <para> <para>The ID for the phone number order.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CHM.GetCHMPhoneNumberOrderListCmdlet"> <summary> Lists the phone number orders for the administrator's Amazon Chime account.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.GetCHMPhoneNumberOrderListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in a single call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.GetCHMPhoneNumberOrderListCmdlet.NextToken"> <summary> <para> <para>The token to use to retrieve the next page of results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CHM.GetCHMUserCmdlet"> <summary> Retrieves details for the specified user ID, such as primary email address, license type, and personal meeting PIN. <para> To retrieve user details with an email address instead of a user ID, use the <a>ListUsers</a> action, and then filter by email address. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.GetCHMUserCmdlet.AccountId"> <summary> <para> <para>The Amazon Chime account ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.GetCHMUserCmdlet.UserId"> <summary> <para> <para>The user ID.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CHM.GetCHMUserListCmdlet"> <summary> Lists the users that belong to the specified Amazon Chime account. You can specify an email address to list only the user that the email address belongs to.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.GetCHMUserListCmdlet.AccountId"> <summary> <para> <para>The Amazon Chime account ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.GetCHMUserListCmdlet.UserEmail"> <summary> <para> <para>Optional. The user email address used to filter results. Maximum 1.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.GetCHMUserListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in a single call. Defaults to 100.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.GetCHMUserListCmdlet.NextToken"> <summary> <para> <para>The token to use to retrieve the next page of results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CHM.GetCHMUserSettingCmdlet"> <summary> Retrieves settings for the specified user ID, such as any associated phone number settings. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.GetCHMUserSettingCmdlet.AccountId"> <summary> <para> <para>The Amazon Chime account ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.GetCHMUserSettingCmdlet.UserId"> <summary> <para> <para>The user ID.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CHM.GetCHMVoiceConnectorCmdlet"> <summary> Retrieves details for the specified Amazon Chime Voice Connector, such as timestamps, name, outbound host, and encryption requirements. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.GetCHMVoiceConnectorCmdlet.VoiceConnectorId"> <summary> <para> <para>The Amazon Chime Voice Connector ID.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CHM.GetCHMVoiceConnectorListCmdlet"> <summary> Lists the Amazon Chime Voice Connectors for the administrator's AWS account.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.GetCHMVoiceConnectorListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in a single call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.GetCHMVoiceConnectorListCmdlet.NextToken"> <summary> <para> <para>The token to use to retrieve the next page of results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CHM.GetCHMVoiceConnectorOriginationCmdlet"> <summary> Retrieves origination setting details for the specified Amazon Chime Voice Connector. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.GetCHMVoiceConnectorOriginationCmdlet.VoiceConnectorId"> <summary> <para> <para>The Amazon Chime Voice Connector ID.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CHM.GetCHMVoiceConnectorTerminationCmdlet"> <summary> Retrieves termination setting details for the specified Amazon Chime Voice Connector. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.GetCHMVoiceConnectorTerminationCmdlet.VoiceConnectorId"> <summary> <para> <para>The Amazon Chime Voice Connector ID.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CHM.GetCHMVoiceConnectorTerminationCredentialListCmdlet"> <summary> Lists the SIP credentials for the specified Amazon Chime Voice Connector. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.GetCHMVoiceConnectorTerminationCredentialListCmdlet.VoiceConnectorId"> <summary> <para> <para>The Amazon Chime Voice Connector ID.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CHM.GetCHMVoiceConnectorTerminationHealthCmdlet"> <summary> Retrieves information about the last time a SIP <code>OPTIONS</code> ping was received from your SIP infrastructure for the specified Amazon Chime Voice Connector. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.GetCHMVoiceConnectorTerminationHealthCmdlet.VoiceConnectorId"> <summary> <para> <para>The Amazon Chime Voice Connector ID.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CHM.InvokeCHMUserLogoutCmdlet"> <summary> Logs out the specified user from all of the devices they are currently logged into. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.InvokeCHMUserLogoutCmdlet.AccountId"> <summary> <para> <para>The Amazon Chime account ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.InvokeCHMUserLogoutCmdlet.UserId"> <summary> <para> <para>The user ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.InvokeCHMUserLogoutCmdlet.PassThru"> <summary> Returns the value passed to the UserId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.InvokeCHMUserLogoutCmdlet.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.CHM.NewCHMAccountCmdlet"> <summary> Creates an Amazon Chime account under the administrator's AWS account. Only <code>Team</code> account types are currently supported for this action. For more information about different account types, see <a href="https://docs.aws.amazon.com/chime/latest/ag/manage-chime-account.html">Managing Your Amazon Chime Accounts</a> in the <i>Amazon Chime Administration Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.NewCHMAccountCmdlet.Name"> <summary> <para> <para>The name of the Amazon Chime account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.NewCHMAccountCmdlet.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.CHM.NewCHMBotCmdlet"> <summary> Creates a bot for an Amazon Chime Enterprise account. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.NewCHMBotCmdlet.AccountId"> <summary> <para> <para>The Amazon Chime account ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.NewCHMBotCmdlet.DisplayName"> <summary> <para> <para>The bot display name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.NewCHMBotCmdlet.Domain"> <summary> <para> <para>The domain of the Amazon Chime Enterprise account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.NewCHMBotCmdlet.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.CHM.NewCHMPhoneNumberOrderCmdlet"> <summary> Creates an order for phone numbers to be provisioned. Choose from Amazon Chime Business Calling and Amazon Chime Voice Connector product types. For toll-free numbers, you can use only the Amazon Chime Voice Connector product type. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.NewCHMPhoneNumberOrderCmdlet.E164PhoneNumber"> <summary> <para> <para>List of phone numbers, in E.164 format.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.NewCHMPhoneNumberOrderCmdlet.ProductType"> <summary> <para> <para>The phone number product type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.NewCHMPhoneNumberOrderCmdlet.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.CHM.NewCHMVoiceConnectorCmdlet"> <summary> Creates an Amazon Chime Voice Connector under the administrator's AWS account. Enabling <a>CreateVoiceConnectorRequest$RequireEncryption</a> configures your Amazon Chime Voice Connector to use TLS transport for SIP signaling and Secure RTP (SRTP) for media. Inbound calls use TLS transport, and unencrypted outbound calls are blocked. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.NewCHMVoiceConnectorCmdlet.Name"> <summary> <para> <para>The name of the Amazon Chime Voice Connector.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.NewCHMVoiceConnectorCmdlet.RequireEncryption"> <summary> <para> <para>When enabled, requires encryption for the Amazon Chime Voice Connector.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.NewCHMVoiceConnectorCmdlet.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.CHM.RemoveCHMAccountCmdlet"> <summary> Deletes the specified Amazon Chime account. You must suspend all users before deleting a <code>Team</code> account. You can use the <a>BatchSuspendUser</a> action to do so. <para> For <code>EnterpriseLWA</code> and <code>EnterpriseAD</code> accounts, you must release the claimed domains for your Amazon Chime account before deletion. As soon as you release the domain, all users under that account are suspended. </para><para> Deleted accounts appear in your <code>Disabled</code> accounts list for 90 days. To restore a deleted account from your <code>Disabled</code> accounts list, you must contact AWS Support. </para><para> After 90 days, deleted accounts are permanently removed from your <code>Disabled</code> accounts list. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.RemoveCHMAccountCmdlet.AccountId"> <summary> <para> <para>The Amazon Chime account ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.RemoveCHMAccountCmdlet.PassThru"> <summary> Returns the value passed to the AccountId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.RemoveCHMAccountCmdlet.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.CHM.RemoveCHMEventsConfigurationCmdlet"> <summary> Deletes the events configuration that allows a bot to receive outgoing events. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.RemoveCHMEventsConfigurationCmdlet.AccountId"> <summary> <para> <para>The Amazon Chime account ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.RemoveCHMEventsConfigurationCmdlet.BotId"> <summary> <para> <para>The bot ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.RemoveCHMEventsConfigurationCmdlet.PassThru"> <summary> Returns the value passed to the BotId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.RemoveCHMEventsConfigurationCmdlet.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.CHM.RemoveCHMPhoneNumberCmdlet"> <summary> Moves the specified phone number into the <b>Deletion queue</b>. A phone number must be disassociated from any users or Amazon Chime Voice Connectors before it can be deleted. <para> Deleted phone numbers remain in the <b>Deletion queue</b> for 7 days before they are deleted permanently. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.RemoveCHMPhoneNumberCmdlet.PhoneNumberId"> <summary> <para> <para>The phone number ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.RemoveCHMPhoneNumberCmdlet.PassThru"> <summary> Returns the value passed to the PhoneNumberId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.RemoveCHMPhoneNumberCmdlet.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.CHM.RemoveCHMPhoneNumberBatchCmdlet"> <summary> Moves phone numbers into the <b>Deletion queue</b>. Phone numbers must be disassociated from any users or Amazon Chime Voice Connectors before they can be deleted. <para> Phone numbers remain in the <b>Deletion queue</b> for 7 days before they are deleted permanently. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.RemoveCHMPhoneNumberBatchCmdlet.PhoneNumberId"> <summary> <para> <para>List of phone number IDs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.RemoveCHMPhoneNumberBatchCmdlet.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.CHM.RemoveCHMPhoneNumberFromUserCmdlet"> <summary> Disassociates the primary provisioned phone number from the specified Amazon Chime user. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.RemoveCHMPhoneNumberFromUserCmdlet.AccountId"> <summary> <para> <para>The Amazon Chime account ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.RemoveCHMPhoneNumberFromUserCmdlet.UserId"> <summary> <para> <para>The user ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.RemoveCHMPhoneNumberFromUserCmdlet.PassThru"> <summary> Returns the value passed to the UserId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.RemoveCHMPhoneNumberFromUserCmdlet.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.CHM.RemoveCHMPhoneNumbersFromVoiceConnectorCmdlet"> <summary> Disassociates the specified phone number from the specified Amazon Chime Voice Connector. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.RemoveCHMPhoneNumbersFromVoiceConnectorCmdlet.E164PhoneNumber"> <summary> <para> <para>List of phone numbers, in E.164 format.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.RemoveCHMPhoneNumbersFromVoiceConnectorCmdlet.VoiceConnectorId"> <summary> <para> <para>The Amazon Chime Voice Connector ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.RemoveCHMPhoneNumbersFromVoiceConnectorCmdlet.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.CHM.RemoveCHMVoiceConnectorCmdlet"> <summary> Deletes the specified Amazon Chime Voice Connector. Any phone numbers assigned to the Amazon Chime Voice Connector must be unassigned from it before it can be deleted. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.RemoveCHMVoiceConnectorCmdlet.VoiceConnectorId"> <summary> <para> <para>The Amazon Chime Voice Connector ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.RemoveCHMVoiceConnectorCmdlet.PassThru"> <summary> Returns the value passed to the VoiceConnectorId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.RemoveCHMVoiceConnectorCmdlet.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.CHM.RemoveCHMVoiceConnectorOriginationCmdlet"> <summary> Deletes the origination settings for the specified Amazon Chime Voice Connector. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.RemoveCHMVoiceConnectorOriginationCmdlet.VoiceConnectorId"> <summary> <para> <para>The Amazon Chime Voice Connector ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.RemoveCHMVoiceConnectorOriginationCmdlet.PassThru"> <summary> Returns the value passed to the VoiceConnectorId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.RemoveCHMVoiceConnectorOriginationCmdlet.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.CHM.RemoveCHMVoiceConnectorTerminationCmdlet"> <summary> Deletes the termination settings for the specified Amazon Chime Voice Connector. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.RemoveCHMVoiceConnectorTerminationCmdlet.VoiceConnectorId"> <summary> <para> <para>The Amazon Chime Voice Connector ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.RemoveCHMVoiceConnectorTerminationCmdlet.PassThru"> <summary> Returns the value passed to the VoiceConnectorId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.RemoveCHMVoiceConnectorTerminationCmdlet.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.CHM.RemoveCHMVoiceConnectorTerminationCredentialCmdlet"> <summary> Deletes the specified SIP credentials used by your equipment to authenticate during call termination. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.RemoveCHMVoiceConnectorTerminationCredentialCmdlet.Username"> <summary> <para> <para>The RFC2617 compliant username associated with the SIP credentials, in US-ASCII format.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.RemoveCHMVoiceConnectorTerminationCredentialCmdlet.VoiceConnectorId"> <summary> <para> <para>The Amazon Chime Voice Connector ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.RemoveCHMVoiceConnectorTerminationCredentialCmdlet.PassThru"> <summary> Returns the value passed to the VoiceConnectorId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.RemoveCHMVoiceConnectorTerminationCredentialCmdlet.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.CHM.ResetCHMPersonalPINCmdlet"> <summary> Resets the personal meeting PIN for the specified user on an Amazon Chime account. Returns the <a>User</a> object with the updated personal meeting PIN. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.ResetCHMPersonalPINCmdlet.AccountId"> <summary> <para> <para>The Amazon Chime account ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.ResetCHMPersonalPINCmdlet.UserId"> <summary> <para> <para>The user ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.ResetCHMPersonalPINCmdlet.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.CHM.RestoreCHMPhoneNumberCmdlet"> <summary> Moves a phone number from the <b>Deletion queue</b> back into the phone number <b>Inventory</b>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.RestoreCHMPhoneNumberCmdlet.PhoneNumberId"> <summary> <para> <para>The phone number.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.RestoreCHMPhoneNumberCmdlet.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.CHM.SearchCHMAvailablePhoneNumberCmdlet"> <summary> Searches phone numbers that can be ordered. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.SearchCHMAvailablePhoneNumberCmdlet.AreaCode"> <summary> <para> <para>The area code used to filter results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.SearchCHMAvailablePhoneNumberCmdlet.City"> <summary> <para> <para>The city used to filter results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.SearchCHMAvailablePhoneNumberCmdlet.Country"> <summary> <para> <para>The country used to filter results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.SearchCHMAvailablePhoneNumberCmdlet.State"> <summary> <para> <para>The state used to filter results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.SearchCHMAvailablePhoneNumberCmdlet.TollFreePrefix"> <summary> <para> <para>The toll-free prefix that you use to filter results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.SearchCHMAvailablePhoneNumberCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in a single call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.SearchCHMAvailablePhoneNumberCmdlet.NextToken"> <summary> <para> <para>The token to use to retrieve the next page of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.SearchCHMAvailablePhoneNumberCmdlet.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.CHM.SendCHMUserInvitationCmdlet"> <summary> Sends email invites to as many as 50 users, inviting them to the specified Amazon Chime <code>Team</code> account. Only <code>Team</code> account types are currently supported for this action. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.SendCHMUserInvitationCmdlet.AccountId"> <summary> <para> <para>The Amazon Chime account ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.SendCHMUserInvitationCmdlet.UserEmailList"> <summary> <para> <para>The user email addresses to which to send the invite.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.SendCHMUserInvitationCmdlet.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.CHM.UpdateCHMAccountCmdlet"> <summary> Updates account details for the specified Amazon Chime account. Currently, only account name updates are supported for this action. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.UpdateCHMAccountCmdlet.AccountId"> <summary> <para> <para>The Amazon Chime account ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.UpdateCHMAccountCmdlet.Name"> <summary> <para> <para>The new name for the specified Amazon Chime account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.UpdateCHMAccountCmdlet.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.CHM.UpdateCHMAccountSettingCmdlet"> <summary> Updates the settings for the specified Amazon Chime account. You can update settings for remote control of shared screens, or for the dial-out option. For more information about these settings, see <a href="https://docs.aws.amazon.com/chime/latest/ag/policies.html">Use the Policies Page</a> in the <i>Amazon Chime Administration Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.UpdateCHMAccountSettingCmdlet.AccountId"> <summary> <para> <para>The Amazon Chime account ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.UpdateCHMAccountSettingCmdlet.AccountSettings_DisableRemoteControl"> <summary> <para> <para>Setting that stops or starts remote control of shared screens during meetings.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.UpdateCHMAccountSettingCmdlet.AccountSettings_EnableDialOut"> <summary> <para> <para>Setting that allows meeting participants to choose the <b>Call me at a phone number</b> option. For more information, see <a href="https://docs.aws.amazon.com/chime/latest/ug/chime-join-meeting.html">Join a Meeting without the Amazon Chime App</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.UpdateCHMAccountSettingCmdlet.PassThru"> <summary> Returns the value passed to the AccountId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.UpdateCHMAccountSettingCmdlet.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.CHM.UpdateCHMBotCmdlet"> <summary> Updates the status of the specified bot, such as starting or stopping the bot from running in your Amazon Chime Enterprise account. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.UpdateCHMBotCmdlet.AccountId"> <summary> <para> <para>The Amazon Chime account ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.UpdateCHMBotCmdlet.BotId"> <summary> <para> <para>The bot ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.UpdateCHMBotCmdlet.Disabled"> <summary> <para> <para>When true, stops the specified bot from running in your account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.UpdateCHMBotCmdlet.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.CHM.UpdateCHMGlobalSettingCmdlet"> <summary> Updates global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.UpdateCHMGlobalSettingCmdlet.BusinessCalling_CdrBucket"> <summary> <para> <para>The Amazon S3 bucket designated for call detail record storage.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.UpdateCHMGlobalSettingCmdlet.VoiceConnector_CdrBucket"> <summary> <para> <para>The Amazon S3 bucket designated for call detail record storage.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.UpdateCHMGlobalSettingCmdlet.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.CHM.UpdateCHMPhoneNumberCmdlet"> <summary> Updates phone number details, such as product type, for the specified phone number ID. For toll-free numbers, you can use only the Amazon Chime Voice Connector product type. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.UpdateCHMPhoneNumberCmdlet.PhoneNumberId"> <summary> <para> <para>The phone number ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.UpdateCHMPhoneNumberCmdlet.ProductType"> <summary> <para> <para>The product type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.UpdateCHMPhoneNumberCmdlet.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.CHM.UpdateCHMPhoneNumberBatchCmdlet"> <summary> Updates phone number product types. Choose from Amazon Chime Business Calling and Amazon Chime Voice Connector product types. For toll-free numbers, you can use only the Amazon Chime Voice Connector product type. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.UpdateCHMPhoneNumberBatchCmdlet.UpdatePhoneNumberRequestItem"> <summary> <para> <para>The request containing the phone number IDs and product types to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.UpdateCHMPhoneNumberBatchCmdlet.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.CHM.UpdateCHMSecurityTokenCmdlet"> <summary> Regenerates the security token for a bot. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.UpdateCHMSecurityTokenCmdlet.AccountId"> <summary> <para> <para>The Amazon Chime account ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.UpdateCHMSecurityTokenCmdlet.BotId"> <summary> <para> <para>The bot ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.UpdateCHMSecurityTokenCmdlet.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.CHM.UpdateCHMUserCmdlet"> <summary> Updates user details for a specified user ID. Currently, only <code>LicenseType</code> updates are supported for this action. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.UpdateCHMUserCmdlet.AccountId"> <summary> <para> <para>The Amazon Chime account ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.UpdateCHMUserCmdlet.LicenseType"> <summary> <para> <para>The user license type to update. This must be a supported license type for the Amazon Chime account that the user belongs to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.UpdateCHMUserCmdlet.UserId"> <summary> <para> <para>The user ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.UpdateCHMUserCmdlet.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.CHM.UpdateCHMUserBatchCmdlet"> <summary> Updates user details within the <a>UpdateUserRequestItem</a> object for up to 20 users for the specified Amazon Chime account. Currently, only <code>LicenseType</code> updates are supported for this action. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.UpdateCHMUserBatchCmdlet.AccountId"> <summary> <para> <para>The Amazon Chime account ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.UpdateCHMUserBatchCmdlet.UpdateUserRequestItem"> <summary> <para> <para>The request containing the user IDs and details to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.UpdateCHMUserBatchCmdlet.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.CHM.UpdateCHMUserSettingCmdlet"> <summary> Updates the settings for the specified user, such as phone number settings. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.UpdateCHMUserSettingCmdlet.AccountId"> <summary> <para> <para>The Amazon Chime account ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.UpdateCHMUserSettingCmdlet.Telephony_InboundCalling"> <summary> <para> <para>Allows or denies inbound calling.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.UpdateCHMUserSettingCmdlet.Telephony_OutboundCalling"> <summary> <para> <para>Allows or denies outbound calling.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.UpdateCHMUserSettingCmdlet.Telephony_SMS"> <summary> <para> <para>Allows or denies SMS messaging.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.UpdateCHMUserSettingCmdlet.UserId"> <summary> <para> <para>The user ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.UpdateCHMUserSettingCmdlet.PassThru"> <summary> Returns the value passed to the UserId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.UpdateCHMUserSettingCmdlet.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.CHM.UpdateCHMVoiceConnectorCmdlet"> <summary> Updates details for the specified Amazon Chime Voice Connector. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.UpdateCHMVoiceConnectorCmdlet.Name"> <summary> <para> <para>The name of the Amazon Chime Voice Connector.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.UpdateCHMVoiceConnectorCmdlet.RequireEncryption"> <summary> <para> <para>When enabled, requires encryption for the Amazon Chime Voice Connector.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.UpdateCHMVoiceConnectorCmdlet.VoiceConnectorId"> <summary> <para> <para>The Amazon Chime Voice Connector ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.UpdateCHMVoiceConnectorCmdlet.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.CHM.WriteCHMEventsConfigurationCmdlet"> <summary> Creates an events configuration that allows a bot to receive outgoing events sent by Amazon Chime. Choose either an HTTPS endpoint or a Lambda function ARN. For more information, see <a>Bot</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.WriteCHMEventsConfigurationCmdlet.AccountId"> <summary> <para> <para>The Amazon Chime account ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.WriteCHMEventsConfigurationCmdlet.BotId"> <summary> <para> <para>The bot ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.WriteCHMEventsConfigurationCmdlet.LambdaFunctionArn"> <summary> <para> <para>Lambda function ARN that allows the bot to receive outgoing events.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.WriteCHMEventsConfigurationCmdlet.OutboundEventsHTTPSEndpoint"> <summary> <para> <para>HTTPS endpoint that allows the bot to receive outgoing events.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.WriteCHMEventsConfigurationCmdlet.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.CHM.WriteCHMVoiceConnectorOriginationCmdlet"> <summary> Adds origination settings for the specified Amazon Chime Voice Connector. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.WriteCHMVoiceConnectorOriginationCmdlet.Origination_Disabled"> <summary> <para> <para>When origination settings are disabled, inbound calls are not enabled for your Amazon Chime Voice Connector.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.WriteCHMVoiceConnectorOriginationCmdlet.Origination_Route"> <summary> <para> <para>The call distribution properties defined for your SIP hosts. Valid range: Minimum value of 1. Maximum value of 20.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.WriteCHMVoiceConnectorOriginationCmdlet.VoiceConnectorId"> <summary> <para> <para>The Amazon Chime Voice Connector ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.WriteCHMVoiceConnectorOriginationCmdlet.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.CHM.WriteCHMVoiceConnectorTerminationCmdlet"> <summary> Adds termination settings for the specified Amazon Chime Voice Connector. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.WriteCHMVoiceConnectorTerminationCmdlet.Termination_CallingRegion"> <summary> <para> <para>The countries to which calls are allowed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.WriteCHMVoiceConnectorTerminationCmdlet.Termination_CidrAllowedList"> <summary> <para> <para>The IP addresses allowed to make calls, in CIDR format.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.WriteCHMVoiceConnectorTerminationCmdlet.Termination_CpsLimit"> <summary> <para> <para>The limit on calls per second. Max value based on account service limit. Default value of 1.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.WriteCHMVoiceConnectorTerminationCmdlet.Termination_DefaultPhoneNumber"> <summary> <para> <para>The default caller ID phone number.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.WriteCHMVoiceConnectorTerminationCmdlet.Termination_Disabled"> <summary> <para> <para>When termination settings are disabled, outbound calls can not be made.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.WriteCHMVoiceConnectorTerminationCmdlet.VoiceConnectorId"> <summary> <para> <para>The Amazon Chime Voice Connector ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.WriteCHMVoiceConnectorTerminationCmdlet.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.CHM.WriteCHMVoiceConnectorTerminationCredentialCmdlet"> <summary> Adds termination SIP credentials for the specified Amazon Chime Voice Connector. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.WriteCHMVoiceConnectorTerminationCredentialCmdlet.TerminationCredential"> <summary> <para> <para>The termination SIP credentials.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.WriteCHMVoiceConnectorTerminationCredentialCmdlet.VoiceConnectorId"> <summary> <para> <para>The Amazon Chime Voice Connector ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.WriteCHMVoiceConnectorTerminationCredentialCmdlet.PassThru"> <summary> Returns the value passed to the VoiceConnectorId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHM.WriteCHMVoiceConnectorTerminationCredentialCmdlet.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> |