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.

AssociatePhoneNumbersWithVoiceConnector

$result = $client->associatePhoneNumbersWithVoiceConnector([/* ... */]);
$promise = $client->associatePhoneNumbersWithVoiceConnectorAsync([/* ... */]);

Associates phone numbers with the specified Amazon Chime Voice Connector.

Parameter Syntax

$result = $client->associatePhoneNumbersWithVoiceConnector([
    'E164PhoneNumbers' => ['<string>', ...], // REQUIRED
    'ForceAssociate' => true || false,
    'VoiceConnectorId' => '<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.

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.

AssociatePhoneNumbersWithVoiceConnectorGroup

$result = $client->associatePhoneNumbersWithVoiceConnectorGroup([/* ... */]);
$promise = $client->associatePhoneNumbersWithVoiceConnectorGroupAsync([/* ... */]);

Associates phone numbers with the specified Amazon Chime Voice Connector group.

Parameter Syntax

$result = $client->associatePhoneNumbersWithVoiceConnectorGroup([
    'E164PhoneNumbers' => ['<string>', ...], // REQUIRED
    'ForceAssociate' => true || false,
    'VoiceConnectorGroupId' => '<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.

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.

BatchCreateAttendee

$result = $client->batchCreateAttendee([/* ... */]);
$promise = $client->batchCreateAttendeeAsync([/* ... */]);

Creates up to 100 new attendees for an active Amazon Chime SDK meeting.

For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide.

Parameter Syntax

$result = $client->batchCreateAttendee([
    'Attendees' => [ // REQUIRED
        [
            'ExternalUserId' => '<string>', // REQUIRED
            'Tags' => [
                [
                    'Key' => '<string>', // REQUIRED
                    'Value' => '<string>', // REQUIRED
                ],
                // ...
            ],
        ],
        // ...
    ],
    'MeetingId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Attendees' => [
        [
            'AttendeeId' => '<string>',
            'ExternalUserId' => '<string>',
            'JoinToken' => '<string>',
        ],
        // ...
    ],
    'Errors' => [
        [
            'ErrorCode' => '<string>',
            'ErrorMessage' => '<string>',
            'ExternalUserId' => '<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.

NotFoundException:

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

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.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

BatchCreateChannelMembership

$result = $client->batchCreateChannelMembership([/* ... */]);
$promise = $client->batchCreateChannelMembershipAsync([/* ... */]);

Adds a specified number of users to a channel.

Parameter Syntax

$result = $client->batchCreateChannelMembership([
    'ChannelArn' => '<string>', // REQUIRED
    'ChimeBearer' => '<string>',
    'MemberArns' => ['<string>', ...], // REQUIRED
    'Type' => 'DEFAULT|HIDDEN',
]);

Parameter Details

Result Syntax

[
    'BatchChannelMemberships' => [
        'ChannelArn' => '<string>',
        'InvitedBy' => [
            'Arn' => '<string>',
            'Name' => '<string>',
        ],
        'Members' => [
            [
                'Arn' => '<string>',
                'Name' => '<string>',
            ],
            // ...
        ],
        'Type' => 'DEFAULT|HIDDEN',
    ],
    'Errors' => [
        [
            'ErrorCode' => 'BadRequest|Conflict|Forbidden|NotFound|PreconditionFailed|ResourceLimitExceeded|ServiceFailure|AccessDenied|ServiceUnavailable|Throttled|Throttling|Unauthorized|Unprocessable|VoiceConnectorGroupAssociationsExist|PhoneNumberAssociationsExist',
            'ErrorMessage' => '<string>',
            'MemberArn' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ServiceFailureException:

The service encountered an unexpected error.

ServiceUnavailableException:

The service is currently unavailable.

UnauthorizedClientException:

The client is not currently authorized to make the request.

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.

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.

CreateAppInstance

$result = $client->createAppInstance([/* ... */]);
$promise = $client->createAppInstanceAsync([/* ... */]);

Creates an Amazon Chime SDK messaging AppInstance under an AWS account. Only SDK messaging customers use this API. CreateAppInstance supports idempotency behavior as described in the AWS API Standard.

Parameter Syntax

$result = $client->createAppInstance([
    'ClientRequestToken' => '<string>', // REQUIRED
    'Metadata' => '<string>',
    'Name' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

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

Result Details

Errors

BadRequestException:

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

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.

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.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

CreateAppInstanceAdmin

$result = $client->createAppInstanceAdmin([/* ... */]);
$promise = $client->createAppInstanceAdminAsync([/* ... */]);

Promotes an AppInstanceUser to an AppInstanceAdmin. The promoted user can perform the following actions.

• ChannelModerator actions across all channels in the AppInstance.

• DeleteChannelMessage actions.

Only an AppInstanceUser can be promoted to an AppInstanceAdmin role.

Parameter Syntax

$result = $client->createAppInstanceAdmin([
    'AppInstanceAdminArn' => '<string>', // REQUIRED
    'AppInstanceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'AppInstanceAdmin' => [
        'Arn' => '<string>',
        'Name' => '<string>',
    ],
    'AppInstanceArn' => '<string>',
]

Result Details

Errors

BadRequestException:

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

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.

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.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

CreateAppInstanceUser

$result = $client->createAppInstanceUser([/* ... */]);
$promise = $client->createAppInstanceUserAsync([/* ... */]);

Creates a user under an Amazon Chime AppInstance. The request consists of a unique appInstanceUserId and Name for that user.

Parameter Syntax

$result = $client->createAppInstanceUser([
    'AppInstanceArn' => '<string>', // REQUIRED
    'AppInstanceUserId' => '<string>', // REQUIRED
    'ClientRequestToken' => '<string>', // REQUIRED
    'Metadata' => '<string>',
    'Name' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

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

Result Details

Errors

BadRequestException:

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

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.

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.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

CreateAttendee

$result = $client->createAttendee([/* ... */]);
$promise = $client->createAttendeeAsync([/* ... */]);

Creates a new attendee for an active Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide.

Parameter Syntax

$result = $client->createAttendee([
    'ExternalUserId' => '<string>', // REQUIRED
    'MeetingId' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'Attendee' => [
        'AttendeeId' => '<string>',
        'ExternalUserId' => '<string>',
        'JoinToken' => '<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.

NotFoundException:

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

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.

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.

CreateChannel

$result = $client->createChannel([/* ... */]);
$promise = $client->createChannelAsync([/* ... */]);

Creates a channel to which you can add users and send messages.

Restriction: You can't change a channel's privacy.

Parameter Syntax

$result = $client->createChannel([
    'AppInstanceArn' => '<string>', // REQUIRED
    'ChimeBearer' => '<string>',
    'ClientRequestToken' => '<string>', // REQUIRED
    'Metadata' => '<string>',
    'Mode' => 'UNRESTRICTED|RESTRICTED',
    'Name' => '<string>', // REQUIRED
    'Privacy' => 'PUBLIC|PRIVATE',
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'ChannelArn' => '<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.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ConflictException:

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

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.

CreateChannelBan

$result = $client->createChannelBan([/* ... */]);
$promise = $client->createChannelBanAsync([/* ... */]);

Permanently bans a member from a channel. Moderators can't add banned members to a channel. To undo a ban, you first have to DeleteChannelBan, and then CreateChannelMembership. Bans are cleaned up when you delete users or channels.

If you ban a user who is already part of a channel, that user is automatically kicked from the channel.

Parameter Syntax

$result = $client->createChannelBan([
    'ChannelArn' => '<string>', // REQUIRED
    'ChimeBearer' => '<string>',
    'MemberArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ChannelArn' => '<string>',
    'Member' => [
        'Arn' => '<string>',
        'Name' => '<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.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ConflictException:

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

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.

CreateChannelMembership

$result = $client->createChannelMembership([/* ... */]);
$promise = $client->createChannelMembershipAsync([/* ... */]);

Adds a user to a channel. The InvitedBy response field is derived from the request header. A channel member can:

• List messages

• Send messages

• Receive messages

• Edit their own messages

• Leave the channel

Privacy settings impact this action as follows:

• Public Channels: You do not need to be a member to list messages, but you must be a member to send messages.

• Private Channels: You must be a member to list or send messages.

Parameter Syntax

$result = $client->createChannelMembership([
    'ChannelArn' => '<string>', // REQUIRED
    'ChimeBearer' => '<string>',
    'MemberArn' => '<string>', // REQUIRED
    'Type' => 'DEFAULT|HIDDEN', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ChannelArn' => '<string>',
    'Member' => [
        'Arn' => '<string>',
        'Name' => '<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.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ConflictException:

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

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.

CreateChannelModerator

$result = $client->createChannelModerator([/* ... */]);
$promise = $client->createChannelModeratorAsync([/* ... */]);

Creates a new ChannelModerator. A channel moderator can:

• Add and remove other members of the channel.

• Add and remove other moderators of the channel.

• Add and remove user bans for the channel.

• Redact messages in the channel.

• List messages in the channel.

Parameter Syntax

$result = $client->createChannelModerator([
    'ChannelArn' => '<string>', // REQUIRED
    'ChannelModeratorArn' => '<string>', // REQUIRED
    'ChimeBearer' => '<string>',
]);

Parameter Details

Result Syntax

[
    'ChannelArn' => '<string>',
    'ChannelModerator' => [
        'Arn' => '<string>',
        'Name' => '<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.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ConflictException:

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

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.

CreateMediaCapturePipeline

$result = $client->createMediaCapturePipeline([/* ... */]);
$promise = $client->createMediaCapturePipelineAsync([/* ... */]);

Creates a media capture pipeline.

Parameter Syntax

$result = $client->createMediaCapturePipeline([
    'ChimeSdkMeetingConfiguration' => [
        'ArtifactsConfiguration' => [
            'Audio' => [ // REQUIRED
                'MuxType' => 'AudioOnly|AudioWithActiveSpeakerVideo', // REQUIRED
            ],
            'Content' => [ // REQUIRED
                'MuxType' => 'ContentOnly',
                'State' => 'Enabled|Disabled', // REQUIRED
            ],
            'Video' => [ // REQUIRED
                'MuxType' => 'VideoOnly',
                'State' => 'Enabled|Disabled', // REQUIRED
            ],
        ],
        'SourceConfiguration' => [
            'SelectedVideoStreams' => [
                'AttendeeIds' => ['<string>', ...],
                'ExternalUserIds' => ['<string>', ...],
            ],
        ],
    ],
    'ClientRequestToken' => '<string>',
    'SinkArn' => '<string>', // REQUIRED
    'SinkType' => 'S3Bucket', // REQUIRED
    'SourceArn' => '<string>', // REQUIRED
    'SourceType' => 'ChimeSdkMeeting', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'MediaCapturePipeline' => [
        'ChimeSdkMeetingConfiguration' => [
            'ArtifactsConfiguration' => [
                'Audio' => [
                    'MuxType' => 'AudioOnly|AudioWithActiveSpeakerVideo',
                ],
                'Content' => [
                    'MuxType' => 'ContentOnly',
                    'State' => 'Enabled|Disabled',
                ],
                'Video' => [
                    'MuxType' => 'VideoOnly',
                    'State' => 'Enabled|Disabled',
                ],
            ],
            'SourceConfiguration' => [
                'SelectedVideoStreams' => [
                    'AttendeeIds' => ['<string>', ...],
                    'ExternalUserIds' => ['<string>', ...],
                ],
            ],
        ],
        'CreatedTimestamp' => <DateTime>,
        'MediaPipelineId' => '<string>',
        'SinkArn' => '<string>',
        'SinkType' => 'S3Bucket',
        'SourceArn' => '<string>',
        'SourceType' => 'ChimeSdkMeeting',
        'Status' => 'Initializing|InProgress|Failed|Stopping|Stopped',
        'UpdatedTimestamp' => <DateTime>,
    ],
]

Result Details

Errors

ResourceLimitExceededException:

The request exceeds the resource limit.

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.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

CreateMeeting

$result = $client->createMeeting([/* ... */]);
$promise = $client->createMeetingAsync([/* ... */]);

Creates a new Amazon Chime SDK meeting in the specified media Region with no initial attendees. For more information about specifying media Regions, see Amazon Chime SDK Media Regions in the Amazon Chime SDK Developer Guide . For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide.

Parameter Syntax

$result = $client->createMeeting([
    'ClientRequestToken' => '<string>', // REQUIRED
    'ExternalMeetingId' => '<string>',
    'MediaRegion' => '<string>',
    'MeetingHostId' => '<string>',
    'NotificationsConfiguration' => [
        'SnsTopicArn' => '<string>',
        'SqsQueueArn' => '<string>',
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'Meeting' => [
        'ExternalMeetingId' => '<string>',
        'MediaPlacement' => [
            'AudioFallbackUrl' => '<string>',
            'AudioHostUrl' => '<string>',
            'EventIngestionUrl' => '<string>',
            'ScreenDataUrl' => '<string>',
            'ScreenSharingUrl' => '<string>',
            'ScreenViewingUrl' => '<string>',
            'SignalingUrl' => '<string>',
            'TurnControlUrl' => '<string>',
        ],
        'MediaRegion' => '<string>',
        'MeetingId' => '<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.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

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.

CreateMeetingWithAttendees

$result = $client->createMeetingWithAttendees([/* ... */]);
$promise = $client->createMeetingWithAttendeesAsync([/* ... */]);

Creates a new Amazon Chime SDK meeting in the specified media Region, with attendees. For more information about specifying media Regions, see Amazon Chime SDK Media Regions in the Amazon Chime SDK Developer Guide . For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide .

Parameter Syntax

$result = $client->createMeetingWithAttendees([
    'Attendees' => [
        [
            'ExternalUserId' => '<string>', // REQUIRED
            'Tags' => [
                [
                    'Key' => '<string>', // REQUIRED
                    'Value' => '<string>', // REQUIRED
                ],
                // ...
            ],
        ],
        // ...
    ],
    'ClientRequestToken' => '<string>', // REQUIRED
    'ExternalMeetingId' => '<string>',
    'MediaRegion' => '<string>',
    'MeetingHostId' => '<string>',
    'NotificationsConfiguration' => [
        'SnsTopicArn' => '<string>',
        'SqsQueueArn' => '<string>',
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'Attendees' => [
        [
            'AttendeeId' => '<string>',
            'ExternalUserId' => '<string>',
            'JoinToken' => '<string>',
        ],
        // ...
    ],
    'Errors' => [
        [
            'ErrorCode' => '<string>',
            'ErrorMessage' => '<string>',
            'ExternalUserId' => '<string>',
        ],
        // ...
    ],
    'Meeting' => [
        'ExternalMeetingId' => '<string>',
        'MediaPlacement' => [
            'AudioFallbackUrl' => '<string>',
            'AudioHostUrl' => '<string>',
            'EventIngestionUrl' => '<string>',
            'ScreenDataUrl' => '<string>',
            'ScreenSharingUrl' => '<string>',
            'ScreenViewingUrl' => '<string>',
            'SignalingUrl' => '<string>',
            'TurnControlUrl' => '<string>',
        ],
        'MediaRegion' => '<string>',
        'MeetingId' => '<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.

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.

CreateProxySession

$result = $client->createProxySession([/* ... */]);
$promise = $client->createProxySessionAsync([/* ... */]);

Creates a proxy session on the specified Amazon Chime Voice Connector for the specified participant phone numbers.

Parameter Syntax

$result = $client->createProxySession([
    'Capabilities' => ['<string>', ...], // REQUIRED
    'ExpiryMinutes' => <integer>,
    'GeoMatchLevel' => 'Country|AreaCode',
    'GeoMatchParams' => [
        'AreaCode' => '<string>', // REQUIRED
        'Country' => '<string>', // REQUIRED
    ],
    'Name' => '<string>',
    'NumberSelectionBehavior' => 'PreferSticky|AvoidSticky',
    'ParticipantPhoneNumbers' => ['<string>', ...], // REQUIRED
    'VoiceConnectorId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ProxySession' => [
        'Capabilities' => ['<string>', ...],
        'CreatedTimestamp' => <DateTime>,
        'EndedTimestamp' => <DateTime>,
        'ExpiryMinutes' => <integer>,
        'GeoMatchLevel' => 'Country|AreaCode',
        'GeoMatchParams' => [
            'AreaCode' => '<string>',
            'Country' => '<string>',
        ],
        'Name' => '<string>',
        'NumberSelectionBehavior' => 'PreferSticky|AvoidSticky',
        'Participants' => [
            [
                'PhoneNumber' => '<string>',
                'ProxyPhoneNumber' => '<string>',
            ],
            // ...
        ],
        'ProxySessionId' => '<string>',
        'Status' => 'Open|InProgress|Closed',
        'UpdatedTimestamp' => <DateTime>,
        'VoiceConnectorId' => '<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.

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.

CreateSipMediaApplication

$result = $client->createSipMediaApplication([/* ... */]);
$promise = $client->createSipMediaApplicationAsync([/* ... */]);

Creates a SIP media application.

Parameter Syntax

$result = $client->createSipMediaApplication([
    'AwsRegion' => '<string>', // REQUIRED
    'Endpoints' => [ // REQUIRED
        [
            'LambdaArn' => '<string>',
        ],
        // ...
    ],
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'SipMediaApplication' => [
        'AwsRegion' => '<string>',
        'CreatedTimestamp' => <DateTime>,
        'Endpoints' => [
            [
                'LambdaArn' => '<string>',
            ],
            // ...
        ],
        'Name' => '<string>',
        'SipMediaApplicationId' => '<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.

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.

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.

CreateSipMediaApplicationCall

$result = $client->createSipMediaApplicationCall([/* ... */]);
$promise = $client->createSipMediaApplicationCallAsync([/* ... */]);

Creates an outbound call to a phone number from the phone number specified in the request, and it invokes the endpoint of the specified sipMediaApplicationId.

Parameter Syntax

$result = $client->createSipMediaApplicationCall([
    'FromPhoneNumber' => '<string>', // REQUIRED
    'SipHeaders' => ['<string>', ...],
    'SipMediaApplicationId' => '<string>', // REQUIRED
    'ToPhoneNumber' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'SipMediaApplicationCall' => [
        '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.

CreateSipRule

$result = $client->createSipRule([/* ... */]);
$promise = $client->createSipRuleAsync([/* ... */]);

Creates a SIP rule which can be used to run a SIP media application as a target for a specific trigger type.

Parameter Syntax

$result = $client->createSipRule([
    'Disabled' => true || false,
    'Name' => '<string>', // REQUIRED
    'TargetApplications' => [ // REQUIRED
        [
            'AwsRegion' => '<string>',
            'Priority' => <integer>,
            'SipMediaApplicationId' => '<string>',
        ],
        // ...
    ],
    'TriggerType' => 'ToPhoneNumber|RequestUriHostname', // REQUIRED
    'TriggerValue' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'SipRule' => [
        'CreatedTimestamp' => <DateTime>,
        'Disabled' => true || false,
        'Name' => '<string>',
        'SipRuleId' => '<string>',
        'TargetApplications' => [
            [
                'AwsRegion' => '<string>',
                'Priority' => <integer>,
                'SipMediaApplicationId' => '<string>',
            ],
            // ...
        ],
        'TriggerType' => 'ToPhoneNumber|RequestUriHostname',
        'TriggerValue' => '<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.

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.

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.

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.

CreateVoiceConnector

$result = $client->createVoiceConnector([/* ... */]);
$promise = $client->createVoiceConnectorAsync([/* ... */]);

Creates an Amazon Chime Voice Connector under the administrator's AWS account. You can choose to create an Amazon Chime Voice Connector in a specific AWS Region.

Enabling CreateVoiceConnectorRequest$RequireEncryption configures your Amazon Chime Voice Connector to use TLS transport for SIP signaling and Secure RTP (SRTP) for media. Inbound calls use TLS transport, and unencrypted outbound calls are blocked.

Parameter Syntax

$result = $client->createVoiceConnector([
    'AwsRegion' => 'us-east-1|us-west-2',
    'Name' => '<string>', // REQUIRED
    'RequireEncryption' => true || false, // REQUIRED
]);

Parameter Details

Result Syntax

[
    'VoiceConnector' => [
        'AwsRegion' => 'us-east-1|us-west-2',
        'CreatedTimestamp' => <DateTime>,
        'Name' => '<string>',
        'OutboundHostName' => '<string>',
        'RequireEncryption' => true || false,
        'UpdatedTimestamp' => <DateTime>,
        'VoiceConnectorArn' => '<string>',
        'VoiceConnectorId' => '<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.

ResourceLimitExceededException:

The request exceeds the resource limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

CreateVoiceConnectorGroup

$result = $client->createVoiceConnectorGroup([/* ... */]);
$promise = $client->createVoiceConnectorGroupAsync([/* ... */]);

Creates an Amazon Chime Voice Connector group under the administrator's AWS account. You can associate Amazon Chime Voice Connectors with the Amazon Chime Voice Connector group by including VoiceConnectorItems in the request.

You can include Amazon Chime Voice Connectors from different AWS Regions in your group. This creates a fault tolerant mechanism for fallback in case of availability events.

Parameter Syntax

$result = $client->createVoiceConnectorGroup([
    'Name' => '<string>', // REQUIRED
    'VoiceConnectorItems' => [
        [
            'Priority' => <integer>, // REQUIRED
            'VoiceConnectorId' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'VoiceConnectorGroup' => [
        'CreatedTimestamp' => <DateTime>,
        'Name' => '<string>',
        'UpdatedTimestamp' => <DateTime>,
        'VoiceConnectorGroupArn' => '<string>',
        'VoiceConnectorGroupId' => '<string>',
        'VoiceConnectorItems' => [
            [
                'Priority' => <integer>,
                'VoiceConnectorId' => '<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.

ResourceLimitExceededException:

The request exceeds the resource 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.

DeleteAppInstance

$result = $client->deleteAppInstance([/* ... */]);
$promise = $client->deleteAppInstanceAsync([/* ... */]);

Deletes an AppInstance and all associated data asynchronously.

Parameter Syntax

$result = $client->deleteAppInstance([
    'AppInstanceArn' => '<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.

ThrottledClientException:

The client exceeded its request rate limit.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

DeleteAppInstanceAdmin

$result = $client->deleteAppInstanceAdmin([/* ... */]);
$promise = $client->deleteAppInstanceAdminAsync([/* ... */]);

Demotes an AppInstanceAdmin to an AppInstanceUser. This action does not delete the user.

Parameter Syntax

$result = $client->deleteAppInstanceAdmin([
    'AppInstanceAdminArn' => '<string>', // REQUIRED
    'AppInstanceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

BadRequestException:

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

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.

ThrottledClientException:

The client exceeded its request rate limit.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

DeleteAppInstanceStreamingConfigurations

$result = $client->deleteAppInstanceStreamingConfigurations([/* ... */]);
$promise = $client->deleteAppInstanceStreamingConfigurationsAsync([/* ... */]);

Deletes the streaming configurations of an AppInstance.

Parameter Syntax

$result = $client->deleteAppInstanceStreamingConfigurations([
    'AppInstanceArn' => '<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.

DeleteAppInstanceUser

$result = $client->deleteAppInstanceUser([/* ... */]);
$promise = $client->deleteAppInstanceUserAsync([/* ... */]);

Deletes an AppInstanceUser.

Parameter Syntax

$result = $client->deleteAppInstanceUser([
    'AppInstanceUserArn' => '<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.

ThrottledClientException:

The client exceeded its request rate limit.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

DeleteAttendee

$result = $client->deleteAttendee([/* ... */]);
$promise = $client->deleteAttendeeAsync([/* ... */]);

Deletes an attendee from the specified Amazon Chime SDK meeting and deletes their JoinToken. Attendees are automatically deleted when a Amazon Chime SDK meeting is deleted. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide.

Parameter Syntax

$result = $client->deleteAttendee([
    'AttendeeId' => '<string>', // REQUIRED
    'MeetingId' => '<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.

ThrottledClientException:

The client exceeded its request rate limit.

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.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

DeleteChannel

$result = $client->deleteChannel([/* ... */]);
$promise = $client->deleteChannelAsync([/* ... */]);

Immediately makes a channel and its memberships inaccessible and marks them for deletion. This is an irreversible process.

Parameter Syntax

$result = $client->deleteChannel([
    'ChannelArn' => '<string>', // REQUIRED
    'ChimeBearer' => '<string>',
]);

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.

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.

DeleteChannelBan

$result = $client->deleteChannelBan([/* ... */]);
$promise = $client->deleteChannelBanAsync([/* ... */]);

Removes a user from a channel's ban list.

Parameter Syntax

$result = $client->deleteChannelBan([
    'ChannelArn' => '<string>', // REQUIRED
    'ChimeBearer' => '<string>',
    'MemberArn' => '<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.

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.

DeleteChannelMembership

$result = $client->deleteChannelMembership([/* ... */]);
$promise = $client->deleteChannelMembershipAsync([/* ... */]);

Removes a member from a channel.

Parameter Syntax

$result = $client->deleteChannelMembership([
    'ChannelArn' => '<string>', // REQUIRED
    'ChimeBearer' => '<string>',
    'MemberArn' => '<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.

UnauthorizedClientException:

The client is not currently authorized to make 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.

DeleteChannelMessage

$result = $client->deleteChannelMessage([/* ... */]);
$promise = $client->deleteChannelMessageAsync([/* ... */]);

Deletes a channel message. Only admins can perform this action. Deletion makes messages inaccessible immediately. A background process deletes any revisions created by UpdateChannelMessage.

Parameter Syntax

$result = $client->deleteChannelMessage([
    'ChannelArn' => '<string>', // REQUIRED
    'ChimeBearer' => '<string>',
    'MessageId' => '<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.

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.

DeleteChannelModerator

$result = $client->deleteChannelModerator([/* ... */]);
$promise = $client->deleteChannelModeratorAsync([/* ... */]);

Deletes a channel moderator.

Parameter Syntax

$result = $client->deleteChannelModerator([
    'ChannelArn' => '<string>', // REQUIRED
    'ChannelModeratorArn' => '<string>', // REQUIRED
    'ChimeBearer' => '<string>',
]);

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.

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.

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.

DeleteMediaCapturePipeline

$result = $client->deleteMediaCapturePipeline([/* ... */]);
$promise = $client->deleteMediaCapturePipelineAsync([/* ... */]);

Deletes the media capture pipeline.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

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.

BadRequestException:

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

ThrottledClientException:

The client exceeded its request rate limit.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

DeleteMeeting

$result = $client->deleteMeeting([/* ... */]);
$promise = $client->deleteMeetingAsync([/* ... */]);

Deletes the specified Amazon Chime SDK meeting. The operation deletes all attendees, disconnects all clients, and prevents new clients from joining the meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide.

Parameter Syntax

$result = $client->deleteMeeting([
    'MeetingId' => '<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.

ThrottledClientException:

The client exceeded its request rate limit.

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.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

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.

DeleteProxySession

$result = $client->deleteProxySession([/* ... */]);
$promise = $client->deleteProxySessionAsync([/* ... */]);

Deletes the specified proxy session from the specified Amazon Chime Voice Connector.

Parameter Syntax

$result = $client->deleteProxySession([
    'ProxySessionId' => '<string>', // REQUIRED
    'VoiceConnectorId' => '<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.

DeleteSipMediaApplication

$result = $client->deleteSipMediaApplication([/* ... */]);
$promise = $client->deleteSipMediaApplicationAsync([/* ... */]);

Deletes a SIP media application.

Parameter Syntax

$result = $client->deleteSipMediaApplication([
    'SipMediaApplicationId' => '<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.

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.

DeleteSipRule

$result = $client->deleteSipRule([/* ... */]);
$promise = $client->deleteSipRuleAsync([/* ... */]);

Deletes a SIP rule. You must disable a SIP rule before you can delete it.

Parameter Syntax

$result = $client->deleteSipRule([
    'SipRuleId' => '<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.

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.

DeleteVoiceConnector

$result = $client->deleteVoiceConnector([/* ... */]);
$promise = $client->deleteVoiceConnectorAsync([/* ... */]);

Deletes the specified Amazon Chime Voice Connector. Any phone numbers associated with the Amazon Chime Voice Connector must be disassociated from it before it can be deleted.

Parameter Syntax

$result = $client->deleteVoiceConnector([
    'VoiceConnectorId' => '<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.

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.

DeleteVoiceConnectorEmergencyCallingConfiguration

$result = $client->deleteVoiceConnectorEmergencyCallingConfiguration([/* ... */]);
$promise = $client->deleteVoiceConnectorEmergencyCallingConfigurationAsync([/* ... */]);

Deletes the emergency calling configuration details from the specified Amazon Chime Voice Connector.

Parameter Syntax

$result = $client->deleteVoiceConnectorEmergencyCallingConfiguration([
    'VoiceConnectorId' => '<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.

DeleteVoiceConnectorGroup

$result = $client->deleteVoiceConnectorGroup([/* ... */]);
$promise = $client->deleteVoiceConnectorGroupAsync([/* ... */]);

Deletes the specified Amazon Chime Voice Connector group. Any VoiceConnectorItems and phone numbers associated with the group must be removed before it can be deleted.

Parameter Syntax

$result = $client->deleteVoiceConnectorGroup([
    'VoiceConnectorGroupId' => '<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.

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.

DeleteVoiceConnectorOrigination

$result = $client->deleteVoiceConnectorOrigination([/* ... */]);
$promise = $client->deleteVoiceConnectorOriginationAsync([/* ... */]);

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

Parameter Syntax

$result = $client->deleteVoiceConnectorOrigination([
    'VoiceConnectorId' => '<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.