AssociatePhoneNumberWithUser

$result = $client->associatePhoneNumberWithUser([/* ... */]);
$promise = $client->associatePhoneNumberWithUserAsync([/* ... */]);

Associates a phone number with the specified Amazon Chime user.

Parameter Syntax

$result = $client->associatePhoneNumberWithUser([
    'AccountId' => '<string>', // REQUIRED
    'E164PhoneNumber' => '<string>', // REQUIRED
    'UserId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

UnauthorizedClientException:

The client is not currently authorized to make the request.

NotFoundException:

One or more of the resources in the request does not exist in the system.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

AccessDeniedException:

You don't have permissions to perform the requested operation.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

AssociateSigninDelegateGroupsWithAccount

$result = $client->associateSigninDelegateGroupsWithAccount([/* ... */]);
$promise = $client->associateSigninDelegateGroupsWithAccountAsync([/* ... */]);

Associates the specified sign-in delegate groups with the specified Amazon Chime account.

Parameter Syntax

$result = $client->associateSigninDelegateGroupsWithAccount([
    'AccountId' => '<string>', // REQUIRED
    'SigninDelegateGroups' => [ // REQUIRED
        [
            'GroupName' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

UnauthorizedClientException:

The client is not currently authorized to make the request.

NotFoundException:

One or more of the resources in the request does not exist in the system.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

BatchCreateRoomMembership

$result = $client->batchCreateRoomMembership([/* ... */]);
$promise = $client->batchCreateRoomMembershipAsync([/* ... */]);

Adds up to 50 members to a chat room in an Amazon Chime Enterprise account. Members can be users or bots. The member role designates whether the member is a chat room administrator or a general chat room member.

Parameter Syntax

$result = $client->batchCreateRoomMembership([
    'AccountId' => '<string>', // REQUIRED
    'MembershipItemList' => [ // REQUIRED
        [
            'MemberId' => '<string>',
            'Role' => 'Administrator|Member',
        ],
        // ...
    ],
    'RoomId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Errors' => [
        [
            'ErrorCode' => 'BadRequest|Conflict|Forbidden|NotFound|PreconditionFailed|ResourceLimitExceeded|ServiceFailure|AccessDenied|ServiceUnavailable|Throttled|Throttling|Unauthorized|Unprocessable|VoiceConnectorGroupAssociationsExist|PhoneNumberAssociationsExist',
            'ErrorMessage' => '<string>',
            'MemberId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

UnauthorizedClientException:

The client is not currently authorized to make the request.

NotFoundException:

One or more of the resources in the request does not exist in the system.

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

BatchDeletePhoneNumber

$result = $client->batchDeletePhoneNumber([/* ... */]);
$promise = $client->batchDeletePhoneNumberAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->batchDeletePhoneNumber([
    'PhoneNumberIds' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'PhoneNumberErrors' => [
        [
            'ErrorCode' => 'BadRequest|Conflict|Forbidden|NotFound|PreconditionFailed|ResourceLimitExceeded|ServiceFailure|AccessDenied|ServiceUnavailable|Throttled|Throttling|Unauthorized|Unprocessable|VoiceConnectorGroupAssociationsExist|PhoneNumberAssociationsExist',
            'ErrorMessage' => '<string>',
            'PhoneNumberId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

UnauthorizedClientException:

The client is not currently authorized to make the request.

NotFoundException:

One or more of the resources in the request does not exist in the system.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

BatchSuspendUser

$result = $client->batchSuspendUser([/* ... */]);
$promise = $client->batchSuspendUserAsync([/* ... */]);

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 in the Amazon Chime Administration Guide.

Users suspended from a Team account are disassociated 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.

Parameter Syntax

$result = $client->batchSuspendUser([
    'AccountId' => '<string>', // REQUIRED
    'UserIdList' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'UserErrors' => [
        [
            'ErrorCode' => 'BadRequest|Conflict|Forbidden|NotFound|PreconditionFailed|ResourceLimitExceeded|ServiceFailure|AccessDenied|ServiceUnavailable|Throttled|Throttling|Unauthorized|Unprocessable|VoiceConnectorGroupAssociationsExist|PhoneNumberAssociationsExist',
            'ErrorMessage' => '<string>',
            'UserId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

UnauthorizedClientException:

The client is not currently authorized to make the request.

NotFoundException:

One or more of the resources in the request does not exist in the system.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

BatchUnsuspendUser

$result = $client->batchUnsuspendUser([/* ... */]);
$promise = $client->batchUnsuspendUserAsync([/* ... */]);

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 in the account types, 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.

Parameter Syntax

$result = $client->batchUnsuspendUser([
    'AccountId' => '<string>', // REQUIRED
    'UserIdList' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'UserErrors' => [
        [
            'ErrorCode' => 'BadRequest|Conflict|Forbidden|NotFound|PreconditionFailed|ResourceLimitExceeded|ServiceFailure|AccessDenied|ServiceUnavailable|Throttled|Throttling|Unauthorized|Unprocessable|VoiceConnectorGroupAssociationsExist|PhoneNumberAssociationsExist',
            'ErrorMessage' => '<string>',
            'UserId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

UnauthorizedClientException:

The client is not currently authorized to make the request.

NotFoundException:

One or more of the resources in the request does not exist in the system.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

BatchUpdatePhoneNumber

$result = $client->batchUpdatePhoneNumber([/* ... */]);
$promise = $client->batchUpdatePhoneNumberAsync([/* ... */]);

Updates phone number product types or calling names. You can update one attribute at a time for each UpdatePhoneNumberRequestItem. For example, you can update the product type or the calling name.

For toll-free numbers, you cannot use the Amazon Chime Business Calling product type. For numbers outside the U.S., you must use the Amazon Chime SIP Media Application Dial-In product type.

Updates to outbound calling names can take up to 72 hours to complete. Pending updates to outbound calling names must be complete before you can request another update.

Parameter Syntax

$result = $client->batchUpdatePhoneNumber([
    'UpdatePhoneNumberRequestItems' => [ // REQUIRED
        [
            'CallingName' => '<string>',
            'PhoneNumberId' => '<string>', // REQUIRED
            'ProductType' => 'BusinessCalling|VoiceConnector|SipMediaApplicationDialIn',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'PhoneNumberErrors' => [
        [
            'ErrorCode' => 'BadRequest|Conflict|Forbidden|NotFound|PreconditionFailed|ResourceLimitExceeded|ServiceFailure|AccessDenied|ServiceUnavailable|Throttled|Throttling|Unauthorized|Unprocessable|VoiceConnectorGroupAssociationsExist|PhoneNumberAssociationsExist',
            'ErrorMessage' => '<string>',
            'PhoneNumberId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

UnauthorizedClientException:

The client is not currently authorized to make the request.

NotFoundException:

One or more of the resources in the request does not exist in the system.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

BatchUpdateUser

$result = $client->batchUpdateUser([/* ... */]);
$promise = $client->batchUpdateUserAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->batchUpdateUser([
    'AccountId' => '<string>', // REQUIRED
    'UpdateUserRequestItems' => [ // REQUIRED
        [
            'AlexaForBusinessMetadata' => [
                'AlexaForBusinessRoomArn' => '<string>',
                'IsAlexaForBusinessEnabled' => true || false,
            ],
            'LicenseType' => 'Basic|Plus|Pro|ProTrial',
            'UserId' => '<string>', // REQUIRED
            'UserType' => 'PrivateUser|SharedDevice',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'UserErrors' => [
        [
            'ErrorCode' => 'BadRequest|Conflict|Forbidden|NotFound|PreconditionFailed|ResourceLimitExceeded|ServiceFailure|AccessDenied|ServiceUnavailable|Throttled|Throttling|Unauthorized|Unprocessable|VoiceConnectorGroupAssociationsExist|PhoneNumberAssociationsExist',
            'ErrorMessage' => '<string>',
            'UserId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

UnauthorizedClientException:

The client is not currently authorized to make the request.

NotFoundException:

One or more of the resources in the request does not exist in the system.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

CreateAccount

$result = $client->createAccount([/* ... */]);
$promise = $client->createAccountAsync([/* ... */]);

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 in the Amazon Chime Administration Guide.

Parameter Syntax

$result = $client->createAccount([
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Account' => [
        'AccountId' => '<string>',
        'AccountStatus' => 'Suspended|Active',
        'AccountType' => 'Team|EnterpriseDirectory|EnterpriseLWA|EnterpriseOIDC',
        'AwsAccountId' => '<string>',
        'CreatedTimestamp' => <DateTime>,
        'DefaultLicense' => 'Basic|Plus|Pro|ProTrial',
        'Name' => '<string>',
        'SigninDelegateGroups' => [
            [
                'GroupName' => '<string>',
            ],
            // ...
        ],
        'SupportedLicenses' => ['<string>', ...],
    ],
]

Result Details

Errors

UnauthorizedClientException:

The client is not currently authorized to make the request.

NotFoundException:

One or more of the resources in the request does not exist in the system.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

CreateBot

$result = $client->createBot([/* ... */]);
$promise = $client->createBotAsync([/* ... */]);

Creates a bot for an Amazon Chime Enterprise account.

Parameter Syntax

$result = $client->createBot([
    'AccountId' => '<string>', // REQUIRED
    'DisplayName' => '<string>', // REQUIRED
    'Domain' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Bot' => [
        'BotEmail' => '<string>',
        'BotId' => '<string>',
        'BotType' => 'ChatBot',
        'CreatedTimestamp' => <DateTime>,
        'Disabled' => true || false,
        'DisplayName' => '<string>',
        'SecurityToken' => '<string>',
        'UpdatedTimestamp' => <DateTime>,
        'UserId' => '<string>',
    ],
]

Result Details

Errors

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ResourceLimitExceededException:

The request exceeds the resource limit.

NotFoundException:

One or more of the resources in the request does not exist in the system.

ThrottledClientException:

The client exceeded its request rate limit.

CreateMeetingDialOut

$result = $client->createMeetingDialOut([/* ... */]);
$promise = $client->createMeetingDialOutAsync([/* ... */]);

Uses the join token and call metadata in a meeting request (From number, To number, and so forth) to initiate an outbound call to a public switched telephone network (PSTN) and join them into a Chime meeting. Also ensures that the From number belongs to the customer.

To play welcome audio or implement an interactive voice response (IVR), use the CreateSipMediaApplicationCall action with the corresponding SIP media application ID.

Parameter Syntax

$result = $client->createMeetingDialOut([
    'FromPhoneNumber' => '<string>', // REQUIRED
    'JoinToken' => '<string>', // REQUIRED
    'MeetingId' => '<string>', // REQUIRED
    'ToPhoneNumber' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'TransactionId' => '<string>',
]

Result Details

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

ResourceLimitExceededException:

The request exceeds the resource limit.

ThrottledClientException:

The client exceeded its request rate limit.

UnauthorizedClientException:

The client is not currently authorized to make the request.

AccessDeniedException:

You don't have permissions to perform the requested operation.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

CreatePhoneNumberOrder

$result = $client->createPhoneNumberOrder([/* ... */]);
$promise = $client->createPhoneNumberOrderAsync([/* ... */]);

Creates an order for phone numbers to be provisioned. For toll-free numbers, you cannot use the Amazon Chime Business Calling product type. For numbers outside the U.S., you must use the Amazon Chime SIP Media Application Dial-In product type.

Parameter Syntax

$result = $client->createPhoneNumberOrder([
    'E164PhoneNumbers' => ['<string>', ...], // REQUIRED
    'ProductType' => 'BusinessCalling|VoiceConnector|SipMediaApplicationDialIn', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'PhoneNumberOrder' => [
        'CreatedTimestamp' => <DateTime>,
        'OrderedPhoneNumbers' => [
            [
                'E164PhoneNumber' => '<string>',
                'Status' => 'Processing|Acquired|Failed',
            ],
            // ...
        ],
        'PhoneNumberOrderId' => '<string>',
        'ProductType' => 'BusinessCalling|VoiceConnector|SipMediaApplicationDialIn',
        'Status' => 'Processing|Successful|Failed|Partial',
        'UpdatedTimestamp' => <DateTime>,
    ],
]

Result Details

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

AccessDeniedException:

You don't have permissions to perform the requested operation.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ThrottledClientException:

The client exceeded its request rate limit.

ResourceLimitExceededException:

The request exceeds the resource limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

CreateRoom

$result = $client->createRoom([/* ... */]);
$promise = $client->createRoomAsync([/* ... */]);

Creates a chat room for the specified Amazon Chime Enterprise account.

Parameter Syntax

$result = $client->createRoom([
    'AccountId' => '<string>', // REQUIRED
    'ClientRequestToken' => '<string>',
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Room' => [
        'AccountId' => '<string>',
        'CreatedBy' => '<string>',
        'CreatedTimestamp' => <DateTime>,
        'Name' => '<string>',
        'RoomId' => '<string>',
        'UpdatedTimestamp' => <DateTime>,
    ],
]

Result Details

Errors

NotFoundException:

One or more of the resources in the request does not exist in the system.

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ResourceLimitExceededException:

The request exceeds the resource limit.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

CreateRoomMembership

$result = $client->createRoomMembership([/* ... */]);
$promise = $client->createRoomMembershipAsync([/* ... */]);

Adds a member to a chat room in an Amazon Chime Enterprise account. A member can be either a user or a bot. The member role designates whether the member is a chat room administrator or a general chat room member.

Parameter Syntax

$result = $client->createRoomMembership([
    'AccountId' => '<string>', // REQUIRED
    'MemberId' => '<string>', // REQUIRED
    'Role' => 'Administrator|Member',
    'RoomId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'RoomMembership' => [
        'InvitedBy' => '<string>',
        'Member' => [
            'AccountId' => '<string>',
            'Email' => '<string>',
            'FullName' => '<string>',
            'MemberId' => '<string>',
            'MemberType' => 'User|Bot|Webhook',
        ],
        'Role' => 'Administrator|Member',
        'RoomId' => '<string>',
        'UpdatedTimestamp' => <DateTime>,
    ],
]

Result Details

Errors

ConflictException:

The request could not be processed because of conflict in the current state of the resource.

UnauthorizedClientException:

The client is not currently authorized to make the request.

NotFoundException:

One or more of the resources in the request does not exist in the system.

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

ResourceLimitExceededException:

The request exceeds the resource limit.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

CreateUser

$result = $client->createUser([/* ... */]);
$promise = $client->createUserAsync([/* ... */]);

Creates a user under the specified Amazon Chime account.

Parameter Syntax

$result = $client->createUser([
    'AccountId' => '<string>', // REQUIRED
    'Email' => '<string>',
    'UserType' => 'PrivateUser|SharedDevice',
    'Username' => '<string>',
]);

Parameter Details

Result Syntax

[
    'User' => [
        'AccountId' => '<string>',
        'AlexaForBusinessMetadata' => [
            'AlexaForBusinessRoomArn' => '<string>',
            'IsAlexaForBusinessEnabled' => true || false,
        ],
        'DisplayName' => '<string>',
        'InvitedOn' => <DateTime>,
        'LicenseType' => 'Basic|Plus|Pro|ProTrial',
        'PersonalPIN' => '<string>',
        'PrimaryEmail' => '<string>',
        'PrimaryProvisionedNumber' => '<string>',
        'RegisteredOn' => <DateTime>,
        'UserId' => '<string>',
        'UserInvitationStatus' => 'Pending|Accepted|Failed',
        'UserRegistrationStatus' => 'Unregistered|Registered|Suspended',
        'UserType' => 'PrivateUser|SharedDevice',
    ],
]

Result Details

Errors

UnauthorizedClientException:

The client is not currently authorized to make the request.

NotFoundException:

One or more of the resources in the request does not exist in the system.

ConflictException:

The request could not be processed because of conflict in the current state of the resource.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

DeleteAccount

$result = $client->deleteAccount([/* ... */]);
$promise = $client->deleteAccountAsync([/* ... */]);

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

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

Parameter Syntax

$result = $client->deleteAccount([
    'AccountId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

UnauthorizedClientException:

The client is not currently authorized to make the request.

NotFoundException:

One or more of the resources in the request does not exist in the system.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ThrottledClientException:

The client exceeded its request rate limit.

UnprocessableEntityException:

The request was well-formed but was unable to be followed due to semantic errors.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

DeleteEventsConfiguration

$result = $client->deleteEventsConfiguration([/* ... */]);
$promise = $client->deleteEventsConfigurationAsync([/* ... */]);

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

Parameter Syntax

$result = $client->deleteEventsConfiguration([
    'AccountId' => '<string>', // REQUIRED
    'BotId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ResourceLimitExceededException:

The request exceeds the resource limit.

DeletePhoneNumber

$result = $client->deletePhoneNumber([/* ... */]);
$promise = $client->deletePhoneNumberAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deletePhoneNumber([
    'PhoneNumberId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

UnauthorizedClientException:

The client is not currently authorized to make the request.

NotFoundException:

One or more of the resources in the request does not exist in the system.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

DeleteRoom

$result = $client->deleteRoom([/* ... */]);
$promise = $client->deleteRoomAsync([/* ... */]);

Deletes a chat room in an Amazon Chime Enterprise account.

Parameter Syntax

$result = $client->deleteRoom([
    'AccountId' => '<string>', // REQUIRED
    'RoomId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

NotFoundException:

One or more of the resources in the request does not exist in the system.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

DeleteRoomMembership

$result = $client->deleteRoomMembership([/* ... */]);
$promise = $client->deleteRoomMembershipAsync([/* ... */]);

Removes a member from a chat room in an Amazon Chime Enterprise account.

Parameter Syntax

$result = $client->deleteRoomMembership([
    'AccountId' => '<string>', // REQUIRED
    'MemberId' => '<string>', // REQUIRED
    'RoomId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

UnauthorizedClientException:

The client is not currently authorized to make the request.

NotFoundException:

One or more of the resources in the request does not exist in the system.

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

DisassociatePhoneNumberFromUser

$result = $client->disassociatePhoneNumberFromUser([/* ... */]);
$promise = $client->disassociatePhoneNumberFromUserAsync([/* ... */]);

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

Parameter Syntax

$result = $client->disassociatePhoneNumberFromUser([
    'AccountId' => '<string>', // REQUIRED
    'UserId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

UnauthorizedClientException:

The client is not currently authorized to make the request.

NotFoundException:

One or more of the resources in the request does not exist in the system.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

DisassociateSigninDelegateGroupsFromAccount

$result = $client->disassociateSigninDelegateGroupsFromAccount([/* ... */]);
$promise = $client->disassociateSigninDelegateGroupsFromAccountAsync([/* ... */]);

Disassociates the specified sign-in delegate groups from the specified Amazon Chime account.

Parameter Syntax

$result = $client->disassociateSigninDelegateGroupsFromAccount([
    'AccountId' => '<string>', // REQUIRED
    'GroupNames' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

UnauthorizedClientException:

The client is not currently authorized to make the request.

NotFoundException:

One or more of the resources in the request does not exist in the system.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

GetAccount

$result = $client->getAccount([/* ... */]);
$promise = $client->getAccountAsync([/* ... */]);

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

Parameter Syntax

$result = $client->getAccount([
    'AccountId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Account' => [
        'AccountId' => '<string>',
        'AccountStatus' => 'Suspended|Active',
        'AccountType' => 'Team|EnterpriseDirectory|EnterpriseLWA|EnterpriseOIDC',
        'AwsAccountId' => '<string>',
        'CreatedTimestamp' => <DateTime>,
        'DefaultLicense' => 'Basic|Plus|Pro|ProTrial',
        'Name' => '<string>',
        'SigninDelegateGroups' => [
            [
                'GroupName' => '<string>',
            ],
            // ...
        ],
        'SupportedLicenses' => ['<string>', ...],
    ],
]

Result Details

Errors

UnauthorizedClientException:

The client is not currently authorized to make the request.

NotFoundException:

One or more of the resources in the request does not exist in the system.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

GetAccountSettings

$result = $client->getAccountSettings([/* ... */]);
$promise = $client->getAccountSettingsAsync([/* ... */]);

Retrieves account settings for the specified Amazon Chime account ID, such as remote control and dialout settings. For more information about these settings, see Use the Policies Page in the Amazon Chime Administration Guide.

Parameter Syntax

$result = $client->getAccountSettings([
    'AccountId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'AccountSettings' => [
        'DisableRemoteControl' => true || false,
        'EnableDialOut' => true || false,
    ],
]

Result Details

Errors

UnauthorizedClientException:

The client is not currently authorized to make the request.

NotFoundException:

One or more of the resources in the request does not exist in the system.

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

GetBot

$result = $client->getBot([/* ... */]);
$promise = $client->getBotAsync([/* ... */]);

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

Parameter Syntax

$result = $client->getBot([
    'AccountId' => '<string>', // REQUIRED
    'BotId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Bot' => [
        'BotEmail' => '<string>',
        'BotId' => '<string>',
        'BotType' => 'ChatBot',
        'CreatedTimestamp' => <DateTime>,
        'Disabled' => true || false,
        'DisplayName' => '<string>',
        'SecurityToken' => '<string>',
        'UpdatedTimestamp' => <DateTime>,
        'UserId' => '<string>',
    ],
]

Result Details

Errors

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

ForbiddenException:

The client is permanently forbidden from making the request.

UnauthorizedClientException:

The client is not currently authorized to make the request.

NotFoundException:

One or more of the resources in the request does not exist in the system.

BadRequestException:

The input parameters don't match the service's restrictions.

ThrottledClientException:

The client exceeded its request rate limit.

GetEventsConfiguration

$result = $client->getEventsConfiguration([/* ... */]);
$promise = $client->getEventsConfigurationAsync([/* ... */]);

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

Parameter Syntax

$result = $client->getEventsConfiguration([
    'AccountId' => '<string>', // REQUIRED
    'BotId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'EventsConfiguration' => [
        'BotId' => '<string>',
        'LambdaFunctionArn' => '<string>',
        'OutboundEventsHTTPSEndpoint' => '<string>',
    ],
]

Result Details

Errors

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ResourceLimitExceededException:

The request exceeds the resource limit.

NotFoundException:

One or more of the resources in the request does not exist in the system.

GetGlobalSettings

$result = $client->getGlobalSettings([/* ... */]);
$promise = $client->getGlobalSettingsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->getGlobalSettings([
]);

Parameter Details

Result Syntax

[
    'BusinessCalling' => [
        'CdrBucket' => '<string>',
    ],
    'VoiceConnector' => [
        'CdrBucket' => '<string>',
    ],
]

Result Details

Errors

UnauthorizedClientException:

The client is not currently authorized to make the request.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

GetPhoneNumber

$result = $client->getPhoneNumber([/* ... */]);
$promise = $client->getPhoneNumberAsync([/* ... */]);

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

Parameter Syntax

$result = $client->getPhoneNumber([
    'PhoneNumberId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'PhoneNumber' => [
        'Associations' => [
            [
                'AssociatedTimestamp' => <DateTime>,
                'Name' => 'AccountId|UserId|VoiceConnectorId|VoiceConnectorGroupId|SipRuleId',
                'Value' => '<string>',
            ],
            // ...
        ],
        'CallingName' => '<string>',
        'CallingNameStatus' => 'Unassigned|UpdateInProgress|UpdateSucceeded|UpdateFailed',
        'Capabilities' => [
            'InboundCall' => true || false,
            'InboundMMS' => true || false,
            'InboundSMS' => true || false,
            'OutboundCall' => true || false,
            'OutboundMMS' => true || false,
            'OutboundSMS' => true || false,
        ],
        'Country' => '<string>',
        'CreatedTimestamp' => <DateTime>,
        'DeletionTimestamp' => <DateTime>,
        'E164PhoneNumber' => '<string>',
        'PhoneNumberId' => '<string>',
        'ProductType' => 'BusinessCalling|VoiceConnector|SipMediaApplicationDialIn',
        'Status' => 'AcquireInProgress|AcquireFailed|Unassigned|Assigned|ReleaseInProgress|DeleteInProgress|ReleaseFailed|DeleteFailed',
        'Type' => 'Local|TollFree',
        'UpdatedTimestamp' => <DateTime>,
    ],
]

Result Details

Errors

UnauthorizedClientException:

The client is not currently authorized to make the request.

NotFoundException:

One or more of the resources in the request does not exist in the system.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

GetPhoneNumberOrder

$result = $client->getPhoneNumberOrder([/* ... */]);
$promise = $client->getPhoneNumberOrderAsync([/* ... */]);

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

Parameter Syntax

$result = $client->getPhoneNumberOrder([
    'PhoneNumberOrderId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'PhoneNumberOrder' => [
        'CreatedTimestamp' => <DateTime>,
        'OrderedPhoneNumbers' => [
            [
                'E164PhoneNumber' => '<string>',
                'Status' => 'Processing|Acquired|Failed',
            ],
            // ...
        ],
        'PhoneNumberOrderId' => '<string>',
        'ProductType' => 'BusinessCalling|VoiceConnector|SipMediaApplicationDialIn',
        'Status' => 'Processing|Successful|Failed|Partial',
        'UpdatedTimestamp' => <DateTime>,
    ],
]

Result Details

Errors

UnauthorizedClientException:

The client is not currently authorized to make the request.

NotFoundException:

One or more of the resources in the request does not exist in the system.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

GetPhoneNumberSettings

$result = $client->getPhoneNumberSettings([/* ... */]);
$promise = $client->getPhoneNumberSettingsAsync([/* ... */]);

Retrieves the phone number settings for the administrator's AWS account, such as the default outbound calling name.

Parameter Syntax

$result = $client->getPhoneNumberSettings([
]);

Parameter Details

Result Syntax

[
    'CallingName' => '<string>',
    'CallingNameUpdatedTimestamp' => <DateTime>,
]

Result Details

Errors

UnauthorizedClientException:

The client is not currently authorized to make the request.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

GetRetentionSettings

$result = $client->getRetentionSettings([/* ... */]);
$promise = $client->getRetentionSettingsAsync([/* ... */]);

Gets the retention settings for the specified Amazon Chime Enterprise account. For more information about retention settings, see Managing Chat Retention Policies in the Amazon Chime Administration Guide.

Parameter Syntax

$result = $client->getRetentionSettings([
    'AccountId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'InitiateDeletionTimestamp' => <DateTime>,
    'RetentionSettings' => [
        'ConversationRetentionSettings' => [
            'RetentionDays' => <integer>,
        ],
        'RoomRetentionSettings' => [
            'RetentionDays' => <integer>,
        ],
    ],
]

Result Details

Errors

UnauthorizedClientException:

The client is not currently authorized to make the request.

NotFoundException:

One or more of the resources in the request does not exist in the system.

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

GetRoom

$result = $client->getRoom([/* ... */]);
$promise = $client->getRoomAsync([/* ... */]);

Retrieves room details, such as the room name, for a room in an Amazon Chime Enterprise account.

Parameter Syntax

$result = $client->getRoom([
    'AccountId' => '<string>', // REQUIRED
    'RoomId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Room' => [
        'AccountId' => '<string>',
        'CreatedBy' => '<string>',
        'CreatedTimestamp' => <DateTime>,
        'Name' => '<string>',
        'RoomId' => '<string>',
        'UpdatedTimestamp' => <DateTime>,
    ],
]

Result Details

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

NotFoundException:

One or more of the resources in the request does not exist in the system.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

GetUser

$result = $client->getUser([/* ... */]);
$promise = $client->getUserAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getUser([
    'AccountId' => '<string>', // REQUIRED
    'UserId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'User' => [
        'AccountId' => '<string>',
        'AlexaForBusinessMetadata' => [
            'AlexaForBusinessRoomArn' => '<string>',
            'IsAlexaForBusinessEnabled' => true || false,
        ],
        'DisplayName' => '<string>',
        'InvitedOn' => <DateTime>,
        'LicenseType' => 'Basic|Plus|Pro|ProTrial',
        'PersonalPIN' => '<string>',
        'PrimaryEmail' => '<string>',
        'PrimaryProvisionedNumber' => '<string>',
        'RegisteredOn' => <DateTime>,
        'UserId' => '<string>',
        'UserInvitationStatus' => 'Pending|Accepted|Failed',
        'UserRegistrationStatus' => 'Unregistered|Registered|Suspended',
        'UserType' => 'PrivateUser|SharedDevice',
    ],
]

Result Details

Errors

UnauthorizedClientException:

The client is not currently authorized to make the request.

NotFoundException:

One or more of the resources in the request does not exist in the system.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

GetUserSettings

$result = $client->getUserSettings([/* ... */]);
$promise = $client->getUserSettingsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->getUserSettings([
    'AccountId' => '<string>', // REQUIRED
    'UserId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'UserSettings' => [
        'Telephony' => [
            'InboundCalling' => true || false,
            'OutboundCalling' => true || false,
            'SMS' => true || false,
        ],
    ],
]

Result Details

Errors

UnauthorizedClientException:

The client is not currently authorized to make the request.

NotFoundException:

One or more of the resources in the request does not exist in the system.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

InviteUsers

$result = $client->inviteUsers([/* ... */]);
$promise = $client->inviteUsersAsync([/* ... */]);

Sends email to a maximum of 50 users, inviting them to the specified Amazon Chime Team account. Only Team account types are currently supported for this action.

Parameter Syntax

$result = $client->inviteUsers([
    'AccountId' => '<string>', // REQUIRED
    'UserEmailList' => ['<string>', ...], // REQUIRED
    'UserType' => 'PrivateUser|SharedDevice',
]);

Parameter Details

Result Syntax

[
    'Invites' => [
        [
            'EmailAddress' => '<string>',
            'EmailStatus' => 'NotSent|Sent|Failed',
            'InviteId' => '<string>',
            'Status' => 'Pending|Accepted|Failed',
        ],
        // ...
    ],
]

Result Details

Errors

UnauthorizedClientException:

The client is not currently authorized to make the request.

NotFoundException:

One or more of the resources in the request does not exist in the system.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

ListAccounts

$result = $client->listAccounts([/* ... */]);
$promise = $client->listAccountsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listAccounts([
    'MaxResults' => <integer>,
    'Name' => '<string>',
    'NextToken' => '<string>',
    'UserEmail' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Accounts' => [
        [
            'AccountId' => '<string>',
            'AccountStatus' => 'Suspended|Active',
            'AccountType' => 'Team|EnterpriseDirectory|EnterpriseLWA|EnterpriseOIDC',
            'AwsAccountId' => '<string>',
            'CreatedTimestamp' => <DateTime>,
            'DefaultLicense' => 'Basic|Plus|Pro|ProTrial',
            'Name' => '<string>',
            'SigninDelegateGroups' => [
                [
                    'GroupName' => '<string>',
                ],
                // ...
            ],
            'SupportedLicenses' => ['<string>', ...],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

UnauthorizedClientException:

The client is not currently authorized to make the request.

NotFoundException:

One or more of the resources in the request does not exist in the system.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

ListBots

$result = $client->listBots([/* ... */]);
$promise = $client->listBotsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listBots([
    'AccountId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Bots' => [
        [
            'BotEmail' => '<string>',
            'BotId' => '<string>',
            'BotType' => 'ChatBot',
            'CreatedTimestamp' => <DateTime>,
            'Disabled' => true || false,
            'DisplayName' => '<string>',
            'SecurityToken' => '<string>',
            'UpdatedTimestamp' => <DateTime>,
            'UserId' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

ForbiddenException:

The client is permanently forbidden from making the request.

UnauthorizedClientException:

The client is not currently authorized to make the request.

BadRequestException:

The input parameters don't match the service's restrictions.

NotFoundException:

One or more of the resources in the request does not exist in the system.

ThrottledClientException:

The client exceeded its request rate limit.

ListPhoneNumberOrders

$result = $client->listPhoneNumberOrders([/* ... */]);
$promise = $client->listPhoneNumberOrdersAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listPhoneNumberOrders([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'PhoneNumberOrders' => [
        [
            'CreatedTimestamp' => <DateTime>,
            'OrderedPhoneNumbers' => [
                [
                    'E164PhoneNumber' => '<string>',
                    'Status' => 'Processing|Acquired|Failed',
                ],
                // ...
            ],
            'PhoneNumberOrderId' => '<string>',
            'ProductType' => 'BusinessCalling|VoiceConnector|SipMediaApplicationDialIn',
            'Status' => 'Processing|Successful|Failed|Partial',
            'UpdatedTimestamp' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

UnauthorizedClientException:

The client is not currently authorized to make the request.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

ListPhoneNumbers

$result = $client->listPhoneNumbers([/* ... */]);
$promise = $client->listPhoneNumbersAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listPhoneNumbers([
    'FilterName' => 'AccountId|UserId|VoiceConnectorId|VoiceConnectorGroupId|SipRuleId',
    'FilterValue' => '<string>',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ProductType' => 'BusinessCalling|VoiceConnector|SipMediaApplicationDialIn',
    'Status' => 'AcquireInProgress|AcquireFailed|Unassigned|Assigned|ReleaseInProgress|DeleteInProgress|ReleaseFailed|DeleteFailed',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'PhoneNumbers' => [
        [
            'Associations' => [
                [
                    'AssociatedTimestamp' => <DateTime>,
                    'Name' => 'AccountId|UserId|VoiceConnectorId|VoiceConnectorGroupId|SipRuleId',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'CallingName' => '<string>',
            'CallingNameStatus' => 'Unassigned|UpdateInProgress|UpdateSucceeded|UpdateFailed',
            'Capabilities' => [
                'InboundCall' => true || false,
                'InboundMMS' => true || false,
                'InboundSMS' => true || false,
                'OutboundCall' => true || false,
                'OutboundMMS' => true || false,
                'OutboundSMS' => true || false,
            ],
            'Country' => '<string>',
            'CreatedTimestamp' => <DateTime>,
            'DeletionTimestamp' => <DateTime>,
            'E164PhoneNumber' => '<string>',
            'PhoneNumberId' => '<string>',
            'ProductType' => 'BusinessCalling|VoiceConnector|SipMediaApplicationDialIn',
            'Status' => 'AcquireInProgress|AcquireFailed|Unassigned|Assigned|ReleaseInProgress|DeleteInProgress|ReleaseFailed|DeleteFailed',
            'Type' => 'Local|TollFree',
            'UpdatedTimestamp' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

UnauthorizedClientException:

The client is not currently authorized to make the request.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

NotFoundException:

One or more of the resources in the request does not exist in the system.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

ListRoomMemberships

$result = $client->listRoomMemberships([/* ... */]);
$promise = $client->listRoomMembershipsAsync([/* ... */]);

Lists the membership details for the specified room in an Amazon Chime Enterprise account, such as the members' IDs, email addresses, and names.

Parameter Syntax

$result = $client->listRoomMemberships([
    'AccountId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'RoomId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'RoomMemberships' => [
        [
            'InvitedBy' => '<string>',
            'Member' => [
                'AccountId' => '<string>',
                'Email' => '<string>',
                'FullName' => '<string>',
                'MemberId' => '<string>',
                'MemberType' => 'User|Bot|Webhook',
            ],
            'Role' => 'Administrator|Member',
            'RoomId' => '<string>',
            'UpdatedTimestamp' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

NotFoundException:

One or more of the resources in the request does not exist in the system.

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

ListRooms

$result = $client->listRooms([/* ... */]);
$promise = $client->listRoomsAsync([/* ... */]);

Lists the room details for the specified Amazon Chime Enterprise account. Optionally, filter the results by a member ID (user ID or bot ID) to see a list of rooms that the member belongs to.

Parameter Syntax

$result = $client->listRooms([
    'AccountId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'MemberId' => '<string>',
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'Rooms' => [
        [
            'AccountId' => '<string>',
            'CreatedBy' => '<string>',
            'CreatedTimestamp' => <DateTime>,
            'Name' => '<string>',
            'RoomId' => '<string>',
            'UpdatedTimestamp' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

NotFoundException:

One or more of the resources in the request does not exist in the system.

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

ListSupportedPhoneNumberCountries

$result = $client->listSupportedPhoneNumberCountries([/* ... */]);
$promise = $client->listSupportedPhoneNumberCountriesAsync([/* ... */]);

Lists supported phone number countries.

Parameter Syntax

$result = $client->listSupportedPhoneNumberCountries([
    'ProductType' => 'BusinessCalling|VoiceConnector|SipMediaApplicationDialIn', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'PhoneNumberCountries' => [
        [
            'CountryCode' => '<string>',
            'SupportedPhoneNumberTypes' => ['<string>', ...],
        ],
        // ...
    ],
]

Result Details

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

AccessDeniedException:

You don't have permissions to perform the requested operation.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

ListUsers

$result = $client->listUsers([/* ... */]);
$promise = $client->listUsersAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listUsers([
    'AccountId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'UserEmail' => '<string>',
    'UserType' => 'PrivateUser|SharedDevice',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'Users' => [
        [
            'AccountId' => '<string>',
            'AlexaForBusinessMetadata' => [
                'AlexaForBusinessRoomArn' => '<string>',
                'IsAlexaForBusinessEnabled' => true || false,
            ],
            'DisplayName' => '<string>',
            'InvitedOn' => <DateTime>,
            'LicenseType' => 'Basic|Plus|Pro|ProTrial',
            'PersonalPIN' => '<string>',
            'PrimaryEmail' => '<string>',
            'PrimaryProvisionedNumber' => '<string>',
            'RegisteredOn' => <DateTime>,
            'UserId' => '<string>',
            'UserInvitationStatus' => 'Pending|Accepted|Failed',
            'UserRegistrationStatus' => 'Unregistered|Registered|Suspended',
            'UserType' => 'PrivateUser|SharedDevice',
        ],
        // ...
    ],
]

Result Details

Errors

UnauthorizedClientException:

The client is not currently authorized to make the request.

NotFoundException:

One or more of the resources in the request does not exist in the system.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

LogoutUser

$result = $client->logoutUser([/* ... */]);
$promise = $client->logoutUserAsync([/* ... */]);

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

Parameter Syntax

$result = $client->logoutUser([
    'AccountId' => '<string>', // REQUIRED
    'UserId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

UnauthorizedClientException:

The client is not currently authorized to make the request.

NotFoundException:

One or more of the resources in the request does not exist in the system.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

PutEventsConfiguration

$result = $client->putEventsConfiguration([/* ... */]);
$promise = $client->putEventsConfigurationAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->putEventsConfiguration([
    'AccountId' => '<string>', // REQUIRED
    'BotId' => '<string>', // REQUIRED
    'LambdaFunctionArn' => '<string>',
    'OutboundEventsHTTPSEndpoint' => '<string>',
]);

Parameter Details

Result Syntax

[
    'EventsConfiguration' => [
        'BotId' => '<string>',
        'LambdaFunctionArn' => '<string>',
        'OutboundEventsHTTPSEndpoint' => '<string>',
    ],
]

Result Details

Errors

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ResourceLimitExceededException:

The request exceeds the resource limit.

NotFoundException:

One or more of the resources in the request does not exist in the system.

PutRetentionSettings

$result = $client->putRetentionSettings([/* ... */]);
$promise = $client->putRetentionSettingsAsync([/* ... */]);

Puts retention settings for the specified Amazon Chime Enterprise account. We recommend using AWS CloudTrail to monitor usage of this API for your account. For more information, see Logging Amazon Chime API Calls with AWS CloudTrail in the Amazon Chime Administration Guide.

To turn off existing retention settings, remove the number of days from the corresponding RetentionDays field in the RetentionSettings object. For more information about retention settings, see Managing Chat Retention Policies in the Amazon Chime Administration Guide.

Parameter Syntax

$result = $client->putRetentionSettings([
    'AccountId' => '<string>', // REQUIRED
    'RetentionSettings' => [ // REQUIRED
        'ConversationRetentionSettings' => [
            'RetentionDays' => <integer>,
        ],
        'RoomRetentionSettings' => [
            'RetentionDays' => <integer>,
        ],
    ],
]);

Parameter Details

Result Syntax

[
    'InitiateDeletionTimestamp' => <DateTime>,
    'RetentionSettings' => [
        'ConversationRetentionSettings' => [
            'RetentionDays' => <integer>,
        ],
        'RoomRetentionSettings' => [
            'RetentionDays' => <integer>,
        ],
    ],
]

Result Details

Errors

UnauthorizedClientException:

The client is not currently authorized to make the request.

NotFoundException:

One or more of the resources in the request does not exist in the system.

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

ConflictException:

The request could not be processed because of conflict in the current state of the resource.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

RedactConversationMessage

$result = $client->redactConversationMessage([/* ... */]);
$promise = $client->redactConversationMessageAsync([/* ... */]);

Redacts the specified message from the specified Amazon Chime conversation.

Parameter Syntax

$result = $client->redactConversationMessage([
    'AccountId' => '<string>', // REQUIRED
    'ConversationId' => '<string>', // REQUIRED
    'MessageId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

NotFoundException:

One or more of the resources in the request does not exist in the system.

ForbiddenException:

The client is permanently forbidden from making the request.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ThrottledClientException:

The client exceeded its request rate limit.

BadRequestException:

The input parameters don't match the service's restrictions.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

RedactRoomMessage

$result = $client->redactRoomMessage([/* ... */]);
$promise = $client->redactRoomMessageAsync([/* ... */]);

Redacts the specified message from the specified Amazon Chime channel.

Parameter Syntax

$result = $client->redactRoomMessage([
    'AccountId' => '<string>', // REQUIRED
    'MessageId' => '<string>', // REQUIRED
    'RoomId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

NotFoundException:

One or more of the resources in the request does not exist in the system.

ForbiddenException:

The client is permanently forbidden from making the request.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ThrottledClientException:

The client exceeded its request rate limit.

BadRequestException:

The input parameters don't match the service's restrictions.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

RegenerateSecurityToken

$result = $client->regenerateSecurityToken([/* ... */]);
$promise = $client->regenerateSecurityTokenAsync([/* ... */]);

Regenerates the security token for a bot.

Parameter Syntax

$result = $client->regenerateSecurityToken([
    'AccountId' => '<string>', // REQUIRED
    'BotId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Bot' => [
        'BotEmail' => '<string>',
        'BotId' => '<string>',
        'BotType' => 'ChatBot',
        'CreatedTimestamp' => <DateTime>,
        'Disabled' => true || false,
        'DisplayName' => '<string>',
        'SecurityToken' => '<string>',
        'UpdatedTimestamp' => <DateTime>,
        'UserId' => '<string>',
    ],
]

Result Details

Errors

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

UnauthorizedClientException:

The client is not currently authorized to make the request.

NotFoundException:

One or more of the resources in the request does not exist in the system.

ThrottledClientException:

The client exceeded its request rate limit.

ResetPersonalPIN

$result = $client->resetPersonalPIN([/* ... */]);
$promise = $client->resetPersonalPINAsync([/* ... */]);

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

Parameter Syntax

$result = $client->resetPersonalPIN([
    'AccountId' => '<string>', // REQUIRED
    'UserId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'User' => [
        'AccountId' => '<string>',
        'AlexaForBusinessMetadata' => [
            'AlexaForBusinessRoomArn' => '<string>',
            'IsAlexaForBusinessEnabled' => true || false,
        ],
        'DisplayName' => '<string>',
        'InvitedOn' => <DateTime>,
        'LicenseType' => 'Basic|Plus|Pro|ProTrial',
        'PersonalPIN' => '<string>',
        'PrimaryEmail' => '<string>',
        'PrimaryProvisionedNumber' => '<string>',
        'RegisteredOn' => <DateTime>,
        'UserId' => '<string>',
        'UserInvitationStatus' => 'Pending|Accepted|Failed',
        'UserRegistrationStatus' => 'Unregistered|Registered|Suspended',
        'UserType' => 'PrivateUser|SharedDevice',
    ],
]

Result Details

Errors

UnauthorizedClientException:

The client is not currently authorized to make the request.

NotFoundException:

One or more of the resources in the request does not exist in the system.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

RestorePhoneNumber

$result = $client->restorePhoneNumber([/* ... */]);
$promise = $client->restorePhoneNumberAsync([/* ... */]);

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

Parameter Syntax

$result = $client->restorePhoneNumber([
    'PhoneNumberId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'PhoneNumber' => [
        'Associations' => [
            [
                'AssociatedTimestamp' => <DateTime>,
                'Name' => 'AccountId|UserId|VoiceConnectorId|VoiceConnectorGroupId|SipRuleId',
                'Value' => '<string>',
            ],
            // ...
        ],
        'CallingName' => '<string>',
        'CallingNameStatus' => 'Unassigned|UpdateInProgress|UpdateSucceeded|UpdateFailed',
        'Capabilities' => [
            'InboundCall' => true || false,
            'InboundMMS' => true || false,
            'InboundSMS' => true || false,
            'OutboundCall' => true || false,
            'OutboundMMS' => true || false,
            'OutboundSMS' => true || false,
        ],
        'Country' => '<string>',
        'CreatedTimestamp' => <DateTime>,
        'DeletionTimestamp' => <DateTime>,
        'E164PhoneNumber' => '<string>',
        'PhoneNumberId' => '<string>',
        'ProductType' => 'BusinessCalling|VoiceConnector|SipMediaApplicationDialIn',
        'Status' => 'AcquireInProgress|AcquireFailed|Unassigned|Assigned|ReleaseInProgress|DeleteInProgress|ReleaseFailed|DeleteFailed',
        'Type' => 'Local|TollFree',
        'UpdatedTimestamp' => <DateTime>,
    ],
]

Result Details

Errors

UnauthorizedClientException:

The client is not currently authorized to make the request.

NotFoundException:

One or more of the resources in the request does not exist in the system.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ThrottledClientException:

The client exceeded its request rate limit.

ResourceLimitExceededException:

The request exceeds the resource limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

SearchAvailablePhoneNumbers

$result = $client->searchAvailablePhoneNumbers([/* ... */]);
$promise = $client->searchAvailablePhoneNumbersAsync([/* ... */]);

Searches for phone numbers that can be ordered. For US numbers, provide at least one of the following search filters: AreaCode, City, State, or TollFreePrefix. If you provide City, you must also provide State. Numbers outside the US only support the PhoneNumberType filter, which you must use.

Parameter Syntax

$result = $client->searchAvailablePhoneNumbers([
    'AreaCode' => '<string>',
    'City' => '<string>',
    'Country' => '<string>',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'PhoneNumberType' => 'Local|TollFree',
    'State' => '<string>',
    'TollFreePrefix' => '<string>',
]);

Parameter Details

Result Syntax

[
    'E164PhoneNumbers' => ['<string>', ...],
    'NextToken' => '<string>',
]

Result Details

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

AccessDeniedException:

You don't have permissions to perform the requested operation.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

UpdateAccount

$result = $client->updateAccount([/* ... */]);
$promise = $client->updateAccountAsync([/* ... */]);

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

Parameter Syntax

$result = $client->updateAccount([
    'AccountId' => '<string>', // REQUIRED
    'DefaultLicense' => 'Basic|Plus|Pro|ProTrial',
    'Name' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Account' => [
        'AccountId' => '<string>',
        'AccountStatus' => 'Suspended|Active',
        'AccountType' => 'Team|EnterpriseDirectory|EnterpriseLWA|EnterpriseOIDC',
        'AwsAccountId' => '<string>',
        'CreatedTimestamp' => <DateTime>,
        'DefaultLicense' => 'Basic|Plus|Pro|ProTrial',
        'Name' => '<string>',
        'SigninDelegateGroups' => [
            [
                'GroupName' => '<string>',
            ],
            // ...
        ],
        'SupportedLicenses' => ['<string>', ...],
    ],
]

Result Details

Errors

UnauthorizedClientException:

The client is not currently authorized to make the request.

NotFoundException:

One or more of the resources in the request does not exist in the system.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

UpdateAccountSettings

$result = $client->updateAccountSettings([/* ... */]);
$promise = $client->updateAccountSettingsAsync([/* ... */]);

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 in the Amazon Chime Administration Guide.

Parameter Syntax

$result = $client->updateAccountSettings([
    'AccountId' => '<string>', // REQUIRED
    'AccountSettings' => [ // REQUIRED
        'DisableRemoteControl' => true || false,
        'EnableDialOut' => true || false,
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

UnauthorizedClientException:

The client is not currently authorized to make the request.

NotFoundException:

One or more of the resources in the request does not exist in the system.

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

ConflictException:

The request could not be processed because of conflict in the current state of the resource.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

UpdateBot

$result = $client->updateBot([/* ... */]);
$promise = $client->updateBotAsync([/* ... */]);

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

Parameter Syntax

$result = $client->updateBot([
    'AccountId' => '<string>', // REQUIRED
    'BotId' => '<string>', // REQUIRED
    'Disabled' => true || false,
]);

Parameter Details

Result Syntax

[
    'Bot' => [
        'BotEmail' => '<string>',
        'BotId' => '<string>',
        'BotType' => 'ChatBot',
        'CreatedTimestamp' => <DateTime>,
        'Disabled' => true || false,
        'DisplayName' => '<string>',
        'SecurityToken' => '<string>',
        'UpdatedTimestamp' => <DateTime>,
        'UserId' => '<string>',
    ],
]

Result Details

Errors

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

UnauthorizedClientException:

The client is not currently authorized to make the request.

NotFoundException:

One or more of the resources in the request does not exist in the system.

ThrottledClientException:

The client exceeded its request rate limit.

UpdateGlobalSettings

$result = $client->updateGlobalSettings([/* ... */]);
$promise = $client->updateGlobalSettingsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->updateGlobalSettings([
    'BusinessCalling' => [
        'CdrBucket' => '<string>',
    ],
    'VoiceConnector' => [
        'CdrBucket' => '<string>',
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

UnauthorizedClientException:

The client is not currently authorized to make the request.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

UpdatePhoneNumber

$result = $client->updatePhoneNumber([/* ... */]);
$promise = $client->updatePhoneNumberAsync([/* ... */]);

Updates phone number details, such as product type or calling name, for the specified phone number ID. You can update one phone number detail at a time. For example, you can update either the product type or the calling name in one action.

For toll-free numbers, you cannot use the Amazon Chime Business Calling product type. For numbers outside the U.S., you must use the Amazon Chime SIP Media Application Dial-In product type.

Updates to outbound calling names can take 72 hours to complete. Pending updates to outbound calling names must be complete before you can request another update.

Parameter Syntax

$result = $client->updatePhoneNumber([
    'CallingName' => '<string>',
    'PhoneNumberId' => '<string>', // REQUIRED
    'ProductType' => 'BusinessCalling|VoiceConnector|SipMediaApplicationDialIn',
]);

Parameter Details

Result Syntax

[
    'PhoneNumber' => [
        'Associations' => [
            [
                'AssociatedTimestamp' => <DateTime>,
                'Name' => 'AccountId|UserId|VoiceConnectorId|VoiceConnectorGroupId|SipRuleId',
                'Value' => '<string>',
            ],
            // ...
        ],
        'CallingName' => '<string>',
        'CallingNameStatus' => 'Unassigned|UpdateInProgress|UpdateSucceeded|UpdateFailed',
        'Capabilities' => [
            'InboundCall' => true || false,
            'InboundMMS' => true || false,
            'InboundSMS' => true || false,
            'OutboundCall' => true || false,
            'OutboundMMS' => true || false,
            'OutboundSMS' => true || false,
        ],
        'Country' => '<string>',
        'CreatedTimestamp' => <DateTime>,
        'DeletionTimestamp' => <DateTime>,
        'E164PhoneNumber' => '<string>',
        'PhoneNumberId' => '<string>',
        'ProductType' => 'BusinessCalling|VoiceConnector|SipMediaApplicationDialIn',
        'Status' => 'AcquireInProgress|AcquireFailed|Unassigned|Assigned|ReleaseInProgress|DeleteInProgress|ReleaseFailed|DeleteFailed',
        'Type' => 'Local|TollFree',
        'UpdatedTimestamp' => <DateTime>,
    ],
]

Result Details

Errors

UnauthorizedClientException:

The client is not currently authorized to make the request.

NotFoundException:

One or more of the resources in the request does not exist in the system.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ThrottledClientException:

The client exceeded its request rate limit.

ConflictException:

The request could not be processed because of conflict in the current state of the resource.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

UpdatePhoneNumberSettings

$result = $client->updatePhoneNumberSettings([/* ... */]);
$promise = $client->updatePhoneNumberSettingsAsync([/* ... */]);

Updates the phone number settings for the administrator's AWS account, such as the default outbound calling name. You can update the default outbound calling name once every seven days. Outbound calling names can take up to 72 hours to update.

Parameter Syntax

$result = $client->updatePhoneNumberSettings([
    'CallingName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

UnauthorizedClientException:

The client is not currently authorized to make the request.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

UpdateRoom

$result = $client->updateRoom([/* ... */]);
$promise = $client->updateRoomAsync([/* ... */]);

Updates room details, such as the room name, for a room in an Amazon Chime Enterprise account.

Parameter Syntax

$result = $client->updateRoom([
    'AccountId' => '<string>', // REQUIRED
    'Name' => '<string>',
    'RoomId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Room' => [
        'AccountId' => '<string>',
        'CreatedBy' => '<string>',
        'CreatedTimestamp' => <DateTime>,
        'Name' => '<string>',
        'RoomId' => '<string>',
        'UpdatedTimestamp' => <DateTime>,
    ],
]

Result Details

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

NotFoundException:

One or more of the resources in the request does not exist in the system.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

UpdateRoomMembership

$result = $client->updateRoomMembership([/* ... */]);
$promise = $client->updateRoomMembershipAsync([/* ... */]);

Updates room membership details, such as the member role, for a room in an Amazon Chime Enterprise account. The member role designates whether the member is a chat room administrator or a general chat room member. The member role can be updated only for user IDs.

Parameter Syntax

$result = $client->updateRoomMembership([
    'AccountId' => '<string>', // REQUIRED
    'MemberId' => '<string>', // REQUIRED
    'Role' => 'Administrator|Member',
    'RoomId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'RoomMembership' => [
        'InvitedBy' => '<string>',
        'Member' => [
            'AccountId' => '<string>',
            'Email' => '<string>',
            'FullName' => '<string>',
            'MemberId' => '<string>',
            'MemberType' => 'User|Bot|Webhook',
        ],
        'Role' => 'Administrator|Member',
        'RoomId' => '<string>',
        'UpdatedTimestamp' => <DateTime>,
    ],
]

Result Details

Errors

UnauthorizedClientException:

The client is not currently authorized to make the request.

NotFoundException:

One or more of the resources in the request does not exist in the system.

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

UpdateUser

$result = $client->updateUser([/* ... */]);
$promise = $client->updateUserAsync([/* ... */]);

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

Parameter Syntax

$result = $client->updateUser([
    'AccountId' => '<string>', // REQUIRED
    'AlexaForBusinessMetadata' => [
        'AlexaForBusinessRoomArn' => '<string>',
        'IsAlexaForBusinessEnabled' => true || false,
    ],
    'LicenseType' => 'Basic|Plus|Pro|ProTrial',
    'UserId' => '<string>', // REQUIRED
    'UserType' => 'PrivateUser|SharedDevice',
]);

Parameter Details

Result Syntax

[
    'User' => [
        'AccountId' => '<string>',
        'AlexaForBusinessMetadata' => [
            'AlexaForBusinessRoomArn' => '<string>',
            'IsAlexaForBusinessEnabled' => true || false,
        ],
        'DisplayName' => '<string>',
        'InvitedOn' => <DateTime>,
        'LicenseType' => 'Basic|Plus|Pro|ProTrial',
        'PersonalPIN' => '<string>',
        'PrimaryEmail' => '<string>',
        'PrimaryProvisionedNumber' => '<string>',
        'RegisteredOn' => <DateTime>,
        'UserId' => '<string>',
        'UserInvitationStatus' => 'Pending|Accepted|Failed',
        'UserRegistrationStatus' => 'Unregistered|Registered|Suspended',
        'UserType' => 'PrivateUser|SharedDevice',
    ],
]

Result Details

Errors

UnauthorizedClientException:

The client is not currently authorized to make the request.

NotFoundException:

One or more of the resources in the request does not exist in the system.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

UpdateUserSettings

$result = $client->updateUserSettings([/* ... */]);
$promise = $client->updateUserSettingsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->updateUserSettings([
    'AccountId' => '<string>', // REQUIRED
    'UserId' => '<string>', // REQUIRED
    'UserSettings' => [ // REQUIRED
        'Telephony' => [ // REQUIRED
            'InboundCalling' => true || false, // REQUIRED
            'OutboundCalling' => true || false, // REQUIRED
            'SMS' => true || false, // REQUIRED
        ],
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

UnauthorizedClientException:

The client is not currently authorized to make the request.

NotFoundException:

One or more of the resources in the request does not exist in the system.

ForbiddenException:

The client is permanently forbidden from making the request.

BadRequestException:

The input parameters don't match the service's restrictions.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.