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 (http://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 (http://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 (http://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 (http://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

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 (http://docs.aws.amazon.com/chime/latest/ag/manage-chime-account.html) in the Amazon Chime Administration Guide.

Users suspended from a Team account are dissociated 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 are no longer able to 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 (http://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.

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 (http://docs.aws.amazon.com/chime/latest/ag/manage-chime-account.html) in the Amazon Chime Administration Guide.

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.

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

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.

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.

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.

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.

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.

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

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.

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])