NAME

Paws::Chime - Perl Interface to AWS Amazon Chime

SYNOPSIS

  use Paws;

  my $obj = Paws->service('Chime');
  my $res = $obj->Method(
    Arg1 => $val1,
    Arg2 => [ 'V1', 'V2' ],
    # if Arg3 is an object, the HashRef will be used as arguments to the constructor
    # of the arguments type
    Arg3 => { Att1 => 'Val1' },
    # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
    # the constructor of the arguments type
    Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
  );

DESCRIPTION

The Amazon Chime API (application programming interface) is designed for administrators to use to perform key tasks, such as creating and managing Amazon Chime accounts and users. This guide provides detailed information about the Amazon Chime API, including operations, types, inputs and outputs, and error codes.

You can use an AWS SDK, the AWS Command Line Interface (AWS CLI), or the REST API to make API calls. We recommend using an AWS SDK or the AWS CLI. Each API operation includes links to information about using it with a language-specific AWS SDK or the AWS CLI.

Using an AWS SDK

You don't need to write code to calculate a signature for request authentication. The SDK clients authenticate your requests by using access keys that you provide. For more information about AWS SDKs, see the AWS Developer Center (http://aws.amazon.com/developer/).

Using the AWS CLI

Use your access keys with the AWS CLI to make API calls. For information about setting up the AWS CLI, see Installing the AWS Command Line Interface (https://docs.aws.amazon.com/cli/latest/userguide/installing.html) in the AWS Command Line Interface User Guide. For a list of available Amazon Chime commands, see the Amazon Chime commands (https://docs.aws.amazon.com/cli/latest/reference/chime/index.html) in the AWS CLI Command Reference.

Using REST API

If you use REST to make API calls, you must authenticate your request by providing a signature. Amazon Chime supports signature version 4. For more information, see Signature Version 4 Signing Process (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) in the Amazon Web Services General Reference.

When making REST API calls, use the service name chime and REST endpoint https://service.chime.aws.amazon.com.

Administrative permissions are controlled using AWS Identity and Access Management (IAM). For more information, see Control Access to the Amazon Chime Console (https://docs.aws.amazon.com/chime/latest/ag/control-access.html) in the Amazon Chime Administration Guide.

For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01

METHODS

AssociatePhoneNumbersWithVoiceConnector

VoiceConnectorId => Str
[E164PhoneNumbers => ArrayRef[Str|Undef]]

Each argument is described in detail in: Paws::Chime::AssociatePhoneNumbersWithVoiceConnector

Returns: a Paws::Chime::AssociatePhoneNumbersWithVoiceConnectorResponse instance

Associates a phone number with the specified Amazon Chime Voice Connector.

AssociatePhoneNumberWithUser

AccountId => Str
E164PhoneNumber => Str
UserId => Str

Each argument is described in detail in: Paws::Chime::AssociatePhoneNumberWithUser

Returns: a Paws::Chime::AssociatePhoneNumberWithUserResponse instance

Associates a phone number with the specified Amazon Chime user.

BatchDeletePhoneNumber

PhoneNumberIds => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::Chime::BatchDeletePhoneNumber

Returns: a Paws::Chime::BatchDeletePhoneNumberResponse instance

Moves phone numbers into the Deletion queue. Phone numbers must be disassociated from any users or Amazon Chime Voice Connectors before they can be deleted.

Phone numbers remain in the Deletion queue for 7 days before they are deleted permanently.

BatchSuspendUser

AccountId => Str
UserIdList => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::Chime::BatchSuspendUser

Returns: a Paws::Chime::BatchSuspendUserResponse instance

Suspends up to 50 users from a Team or EnterpriseLWA Amazon Chime account. For more information about different account types, see Managing Your Amazon Chime Accounts (https://docs.aws.amazon.com/chime/latest/ag/manage-chime-account.html) in the Amazon Chime Administration Guide.

Users suspended from a Team account are dissasociated from the account, but they can continue to use Amazon Chime as free users. To remove the suspension from suspended Team account users, invite them to the Team account again. You can use the InviteUsers action to do so.

Users suspended from an EnterpriseLWA account are immediately signed out of Amazon Chime and can no longer sign in. To remove the suspension from suspended EnterpriseLWA account users, use the BatchUnsuspendUser action.

To sign out users without suspending them, use the LogoutUser action.

BatchUnsuspendUser

AccountId => Str
UserIdList => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::Chime::BatchUnsuspendUser

Returns: a Paws::Chime::BatchUnsuspendUserResponse instance

Removes the suspension from up to 50 previously suspended users for the specified Amazon Chime EnterpriseLWA account. Only users on EnterpriseLWA accounts can be unsuspended using this action. For more information about different account types, see Managing Your Amazon Chime Accounts (https://docs.aws.amazon.com/chime/latest/ag/manage-chime-account.html) in the Amazon Chime Administration Guide.

Previously suspended users who are unsuspended using this action are returned to Registered status. Users who are not previously suspended are ignored.

BatchUpdatePhoneNumber

UpdatePhoneNumberRequestItems => ArrayRef[Paws::Chime::UpdatePhoneNumberRequestItem]

Each argument is described in detail in: Paws::Chime::BatchUpdatePhoneNumber

Returns: a Paws::Chime::BatchUpdatePhoneNumberResponse instance

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.

BatchUpdateUser

AccountId => Str
UpdateUserRequestItems => ArrayRef[Paws::Chime::UpdateUserRequestItem]

Each argument is described in detail in: Paws::Chime::BatchUpdateUser

Returns: a Paws::Chime::BatchUpdateUserResponse instance

Updates user details within the UpdateUserRequestItem object for up to 20 users for the specified Amazon Chime account. Currently, only LicenseType updates are supported for this action.

CreateAccount

Name => Str

Each argument is described in detail in: Paws::Chime::CreateAccount

Returns: a Paws::Chime::CreateAccountResponse instance

Creates an Amazon Chime account under the administrator's AWS account. Only Team account types are currently supported for this action. For more information about different account types, see Managing Your Amazon Chime Accounts (https://docs.aws.amazon.com/chime/latest/ag/manage-chime-account.html) in the Amazon Chime Administration Guide.

CreateBot

AccountId => Str
DisplayName => Str
[Domain => Str]

Each argument is described in detail in: Paws::Chime::CreateBot

Returns: a Paws::Chime::CreateBotResponse instance

Creates a bot for an Amazon Chime Enterprise account.

CreatePhoneNumberOrder

E164PhoneNumbers => ArrayRef[Str|Undef]
ProductType => Str

Each argument is described in detail in: Paws::Chime::CreatePhoneNumberOrder

Returns: a Paws::Chime::CreatePhoneNumberOrderResponse instance

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.

CreateVoiceConnector

Name => Str
RequireEncryption => Bool

Each argument is described in detail in: Paws::Chime::CreateVoiceConnector

Returns: a Paws::Chime::CreateVoiceConnectorResponse instance

Creates an Amazon Chime Voice Connector under the administrator's AWS account. Enabling CreateVoiceConnectorRequest$RequireEncryption 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.

DeleteAccount

AccountId => Str

Each argument is described in detail in: Paws::Chime::DeleteAccount

Returns: a Paws::Chime::DeleteAccountResponse instance

Deletes the specified Amazon Chime account. You must suspend all users before deleting a Team account. You can use the BatchSuspendUser action to do so.

For EnterpriseLWA and EnterpriseAD 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.

Deleted accounts appear in your Disabled accounts list for 90 days. To restore a deleted account from your Disabled accounts list, you must contact AWS Support.

After 90 days, deleted accounts are permanently removed from your Disabled accounts list.

DeleteEventsConfiguration

AccountId => Str
BotId => Str

Each argument is described in detail in: Paws::Chime::DeleteEventsConfiguration

Returns: nothing

Deletes the events configuration that allows a bot to receive outgoing events.

DeletePhoneNumber

PhoneNumberId => Str

Each argument is described in detail in: Paws::Chime::DeletePhoneNumber

Returns: nothing

Moves the specified phone number into the Deletion queue. A phone number must be disassociated from any users or Amazon Chime Voice Connectors before it can be deleted.

Deleted phone numbers remain in the Deletion queue for 7 days before they are deleted permanently.

DeleteVoiceConnector

VoiceConnectorId => Str

Each argument is described in detail in: Paws::Chime::DeleteVoiceConnector

Returns: nothing

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.

DeleteVoiceConnectorOrigination

VoiceConnectorId => Str

Each argument is described in detail in: Paws::Chime::DeleteVoiceConnectorOrigination

Returns: nothing

Deletes the origination settings for the specified Amazon Chime Voice Connector.

DeleteVoiceConnectorTermination

VoiceConnectorId => Str

Each argument is described in detail in: Paws::Chime::DeleteVoiceConnectorTermination

Returns: nothing

Deletes the termination settings for the specified Amazon Chime Voice Connector.

DeleteVoiceConnectorTerminationCredentials

VoiceConnectorId => Str
[Usernames => ArrayRef[Str|Undef]]

Each argument is described in detail in: Paws::Chime::DeleteVoiceConnectorTerminationCredentials

Returns: nothing

Deletes the specified SIP credentials used by your equipment to authenticate during call termination.

DisassociatePhoneNumberFromUser

AccountId => Str
UserId => Str

Each argument is described in detail in: Paws::Chime::DisassociatePhoneNumberFromUser

Returns: a Paws::Chime::DisassociatePhoneNumberFromUserResponse instance

Disassociates the primary provisioned phone number from the specified Amazon Chime user.

DisassociatePhoneNumbersFromVoiceConnector

VoiceConnectorId => Str
[E164PhoneNumbers => ArrayRef[Str|Undef]]

Each argument is described in detail in: Paws::Chime::DisassociatePhoneNumbersFromVoiceConnector

Returns: a Paws::Chime::DisassociatePhoneNumbersFromVoiceConnectorResponse instance

Disassociates the specified phone number from the specified Amazon Chime Voice Connector.

GetAccount

AccountId => Str

Each argument is described in detail in: Paws::Chime::GetAccount

Returns: a Paws::Chime::GetAccountResponse instance

Retrieves details for the specified Amazon Chime account, such as account type and supported licenses.

GetAccountSettings

AccountId => Str

Each argument is described in detail in: Paws::Chime::GetAccountSettings

Returns: a Paws::Chime::GetAccountSettingsResponse instance

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 Use the Policies Page (https://docs.aws.amazon.com/chime/latest/ag/policies.html) in the Amazon Chime Administration Guide.

GetBot

AccountId => Str
BotId => Str

Each argument is described in detail in: Paws::Chime::GetBot

Returns: a Paws::Chime::GetBotResponse instance

Retrieves details for the specified bot, such as bot email address, bot type, status, and display name.

GetEventsConfiguration

AccountId => Str
BotId => Str

Each argument is described in detail in: Paws::Chime::GetEventsConfiguration

Returns: a Paws::Chime::GetEventsConfigurationResponse instance

Gets details for an events configuration that allows a bot to receive outgoing events, such as an HTTPS endpoint or Lambda function ARN.

GetGlobalSettings

=>

Each argument is described in detail in: Paws::Chime::GetGlobalSettings

Returns: a Paws::Chime::GetGlobalSettingsResponse instance

Retrieves global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.

GetPhoneNumber

PhoneNumberId => Str

Each argument is described in detail in: Paws::Chime::GetPhoneNumber

Returns: a Paws::Chime::GetPhoneNumberResponse instance

Retrieves details for the specified phone number ID, such as associations, capabilities, and product type.

GetPhoneNumberOrder

PhoneNumberOrderId => Str

Each argument is described in detail in: Paws::Chime::GetPhoneNumberOrder

Returns: a Paws::Chime::GetPhoneNumberOrderResponse instance

Retrieves details for the specified phone number order, such as order creation timestamp, phone numbers in E.164 format, product type, and order status.

GetUser

AccountId => Str
UserId => Str

Each argument is described in detail in: Paws::Chime::GetUser

Returns: a Paws::Chime::GetUserResponse instance

Retrieves details for the specified user ID, such as primary email address, license type, and personal meeting PIN.

To retrieve user details with an email address instead of a user ID, use the ListUsers action, and then filter by email address.

GetUserSettings

AccountId => Str
UserId => Str

Each argument is described in detail in: Paws::Chime::GetUserSettings

Returns: a Paws::Chime::GetUserSettingsResponse instance

Retrieves settings for the specified user ID, such as any associated phone number settings.

GetVoiceConnector

VoiceConnectorId => Str

Each argument is described in detail in: Paws::Chime::GetVoiceConnector

Returns: a Paws::Chime::GetVoiceConnectorResponse instance

Retrieves details for the specified Amazon Chime Voice Connector, such as timestamps, name, outbound host, and encryption requirements.

GetVoiceConnectorOrigination

VoiceConnectorId => Str

Each argument is described in detail in: Paws::Chime::GetVoiceConnectorOrigination

Returns: a Paws::Chime::GetVoiceConnectorOriginationResponse instance

Retrieves origination setting details for the specified Amazon Chime Voice Connector.

GetVoiceConnectorTermination

VoiceConnectorId => Str

Each argument is described in detail in: Paws::Chime::GetVoiceConnectorTermination

Returns: a Paws::Chime::GetVoiceConnectorTerminationResponse instance

Retrieves termination setting details for the specified Amazon Chime Voice Connector.

GetVoiceConnectorTerminationHealth

VoiceConnectorId => Str

Each argument is described in detail in: Paws::Chime::GetVoiceConnectorTerminationHealth

Returns: a Paws::Chime::GetVoiceConnectorTerminationHealthResponse instance

Retrieves information about the last time a SIP OPTIONS ping was received from your SIP infrastructure for the specified Amazon Chime Voice Connector.

InviteUsers

AccountId => Str
UserEmailList => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::Chime::InviteUsers

Returns: a Paws::Chime::InviteUsersResponse instance

Sends email invites to as many as 50 users, inviting them to the specified Amazon Chime Team account. Only Team account types are currently supported for this action.

ListAccounts

[MaxResults => Int]
[Name => Str]
[NextToken => Str]
[UserEmail => Str]

Each argument is described in detail in: Paws::Chime::ListAccounts

Returns: a Paws::Chime::ListAccountsResponse instance

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.

ListBots

AccountId => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::Chime::ListBots

Returns: a Paws::Chime::ListBotsResponse instance

Lists the bots associated with the administrator's Amazon Chime Enterprise account ID.

ListPhoneNumberOrders

[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::Chime::ListPhoneNumberOrders

Returns: a Paws::Chime::ListPhoneNumberOrdersResponse instance

Lists the phone number orders for the administrator's Amazon Chime account.

ListPhoneNumbers

[FilterName => Str]
[FilterValue => Str]
[MaxResults => Int]
[NextToken => Str]
[ProductType => Str]
[Status => Str]

Each argument is described in detail in: Paws::Chime::ListPhoneNumbers

Returns: a Paws::Chime::ListPhoneNumbersResponse instance

Lists the phone numbers for the specified Amazon Chime account, Amazon Chime user, or Amazon Chime Voice Connector.

ListUsers

AccountId => Str
[MaxResults => Int]
[NextToken => Str]
[UserEmail => Str]

Each argument is described in detail in: Paws::Chime::ListUsers

Returns: a Paws::Chime::ListUsersResponse instance

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.

ListVoiceConnectors

[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::Chime::ListVoiceConnectors

Returns: a Paws::Chime::ListVoiceConnectorsResponse instance

Lists the Amazon Chime Voice Connectors for the administrator's AWS account.

ListVoiceConnectorTerminationCredentials

VoiceConnectorId => Str

Each argument is described in detail in: Paws::Chime::ListVoiceConnectorTerminationCredentials

Returns: a Paws::Chime::ListVoiceConnectorTerminationCredentialsResponse instance

Lists the SIP credentials for the specified Amazon Chime Voice Connector.

LogoutUser

AccountId => Str
UserId => Str

Each argument is described in detail in: Paws::Chime::LogoutUser

Returns: a Paws::Chime::LogoutUserResponse instance

Logs out the specified user from all of the devices they are currently logged into.

PutEventsConfiguration

AccountId => Str
BotId => Str
[LambdaFunctionArn => Str]
[OutboundEventsHTTPSEndpoint => Str]

Each argument is described in detail in: Paws::Chime::PutEventsConfiguration

Returns: a Paws::Chime::PutEventsConfigurationResponse instance

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 Bot.

PutVoiceConnectorOrigination

Origination => Paws::Chime::Origination
VoiceConnectorId => Str

Each argument is described in detail in: Paws::Chime::PutVoiceConnectorOrigination

Returns: a Paws::Chime::PutVoiceConnectorOriginationResponse instance

Adds origination settings for the specified Amazon Chime Voice Connector.

PutVoiceConnectorTermination

Termination => Paws::Chime::Termination
VoiceConnectorId => Str

Each argument is described in detail in: Paws::Chime::PutVoiceConnectorTermination

Returns: a Paws::Chime::PutVoiceConnectorTerminationResponse instance

Adds termination settings for the specified Amazon Chime Voice Connector.

PutVoiceConnectorTerminationCredentials

VoiceConnectorId => Str
[Credentials => ArrayRef[Paws::Chime::Credential]]

Each argument is described in detail in: Paws::Chime::PutVoiceConnectorTerminationCredentials

Returns: nothing

Adds termination SIP credentials for the specified Amazon Chime Voice Connector.

RegenerateSecurityToken

AccountId => Str
BotId => Str

Each argument is described in detail in: Paws::Chime::RegenerateSecurityToken

Returns: a Paws::Chime::RegenerateSecurityTokenResponse instance

Regenerates the security token for a bot.

ResetPersonalPIN

AccountId => Str
UserId => Str

Each argument is described in detail in: Paws::Chime::ResetPersonalPIN

Returns: a Paws::Chime::ResetPersonalPINResponse instance

Resets the personal meeting PIN for the specified user on an Amazon Chime account. Returns the User object with the updated personal meeting PIN.

RestorePhoneNumber

PhoneNumberId => Str

Each argument is described in detail in: Paws::Chime::RestorePhoneNumber

Returns: a Paws::Chime::RestorePhoneNumberResponse instance

Moves a phone number from the Deletion queue back into the phone number Inventory.

SearchAvailablePhoneNumbers

[AreaCode => Str]
[City => Str]
[Country => Str]
[MaxResults => Int]
[NextToken => Str]
[State => Str]
[TollFreePrefix => Str]

Each argument is described in detail in: Paws::Chime::SearchAvailablePhoneNumbers

Returns: a Paws::Chime::SearchAvailablePhoneNumbersResponse instance

Searches phone numbers that can be ordered.

UpdateAccount

AccountId => Str
[Name => Str]

Each argument is described in detail in: Paws::Chime::UpdateAccount

Returns: a Paws::Chime::UpdateAccountResponse instance

Updates account details for the specified Amazon Chime account. Currently, only account name updates are supported for this action.

UpdateAccountSettings

AccountId => Str
AccountSettings => Paws::Chime::AccountSettings

Each argument is described in detail in: Paws::Chime::UpdateAccountSettings

Returns: a Paws::Chime::UpdateAccountSettingsResponse instance

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 Use the Policies Page (https://docs.aws.amazon.com/chime/latest/ag/policies.html) in the Amazon Chime Administration Guide.

UpdateBot

AccountId => Str
BotId => Str
[Disabled => Bool]

Each argument is described in detail in: Paws::Chime::UpdateBot

Returns: a Paws::Chime::UpdateBotResponse instance

Updates the status of the specified bot, such as starting or stopping the bot from running in your Amazon Chime Enterprise account.

UpdateGlobalSettings

BusinessCalling => Paws::Chime::BusinessCallingSettings
VoiceConnector => Paws::Chime::VoiceConnectorSettings

Each argument is described in detail in: Paws::Chime::UpdateGlobalSettings

Returns: nothing

Updates global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.

UpdatePhoneNumber

PhoneNumberId => Str
[ProductType => Str]

Each argument is described in detail in: Paws::Chime::UpdatePhoneNumber

Returns: a Paws::Chime::UpdatePhoneNumberResponse instance

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.

UpdateUser

AccountId => Str
UserId => Str
[LicenseType => Str]

Each argument is described in detail in: Paws::Chime::UpdateUser

Returns: a Paws::Chime::UpdateUserResponse instance

Updates user details for a specified user ID. Currently, only LicenseType updates are supported for this action.

UpdateUserSettings

AccountId => Str
UserId => Str
UserSettings => Paws::Chime::UserSettings

Each argument is described in detail in: Paws::Chime::UpdateUserSettings

Returns: nothing

Updates the settings for the specified user, such as phone number settings.

UpdateVoiceConnector

Name => Str
RequireEncryption => Bool
VoiceConnectorId => Str

Each argument is described in detail in: Paws::Chime::UpdateVoiceConnector

Returns: a Paws::Chime::UpdateVoiceConnectorResponse instance

Updates details for the specified Amazon Chime Voice Connector.

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results

ListAllAccounts(sub { },[MaxResults => Int, Name => Str, NextToken => Str, UserEmail => Str])

ListAllAccounts([MaxResults => Int, Name => Str, NextToken => Str, UserEmail => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - Accounts, passing the object as the first parameter, and the string 'Accounts' as the second parameter 

If not, it will return a a Paws::Chime::ListAccountsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllUsers(sub { },AccountId => Str, [MaxResults => Int, NextToken => Str, UserEmail => Str])

ListAllUsers(AccountId => Str, [MaxResults => Int, NextToken => Str, UserEmail => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - Users, passing the object as the first parameter, and the string 'Users' as the second parameter 

If not, it will return a a Paws::Chime::ListUsersResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

SEE ALSO

This service class forms part of Paws

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues