Chime

Table of Contents

Client

class Chime.Client

A low-level client representing Amazon Chime

The Amazon Chime API (application programming interface) is designed for developers to perform key tasks, such as creating and managing Amazon Chime accounts, users, and Voice Connectors. This guide provides detailed information about the Amazon Chime API, including operations, types, inputs and outputs, and error codes. It also includes some server-side API actions to use with the Amazon Chime SDK. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide .

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

Using an AWS SDK

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

Using the AWS CLI

Use your access keys with the AWS CLI to make API calls. For information about setting up the AWS CLI, see Installing the AWS Command Line Interface in the AWS Command Line Interface User Guide . For a list of available Amazon Chime commands, see the Amazon Chime commands in the AWS CLI Command Reference .

Using REST

If you use REST to make API calls, you must authenticate your request by providing a signature. Amazon Chime supports Signature Version 4. For more information, see Signature Version 4 Signing Process in the Amazon Web Services General Reference .

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

Administrative permissions are controlled using AWS Identity and Access Management (IAM). For more information, see Identity and Access Management for Amazon Chime in the Amazon Chime Administration Guide .

import boto3

client = boto3.client('chime')

These are the available methods:

associate_phone_number_with_user(**kwargs)

Associates a phone number with the specified Amazon Chime user.

See also: AWS API Documentation

Request Syntax

response = client.associate_phone_number_with_user(
    AccountId='string',
    UserId='string',
    E164PhoneNumber='string'
)
Parameters
  • AccountId (string) --

    [REQUIRED]

    The Amazon Chime account ID.

  • UserId (string) --

    [REQUIRED]

    The user ID.

  • E164PhoneNumber (string) --

    [REQUIRED]

    The phone number, in E.164 format.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.AccessDeniedException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
associate_phone_numbers_with_voice_connector(**kwargs)

Associates phone numbers with the specified Amazon Chime Voice Connector.

See also: AWS API Documentation

Request Syntax

response = client.associate_phone_numbers_with_voice_connector(
    VoiceConnectorId='string',
    E164PhoneNumbers=[
        'string',
    ],
    ForceAssociate=True|False
)
Parameters
  • VoiceConnectorId (string) --

    [REQUIRED]

    The Amazon Chime Voice Connector ID.

  • E164PhoneNumbers (list) --

    [REQUIRED]

    List of phone numbers, in E.164 format.

    • (string) --
  • ForceAssociate (boolean) -- If true, associates the provided phone numbers with the provided Amazon Chime Voice Connector and removes any previously existing associations. If false, does not associate any phone numbers that have previously existing associations.
Return type

dict

Returns

Response Syntax

{
    'PhoneNumberErrors': [
        {
            'PhoneNumberId': 'string',
            'ErrorCode': 'BadRequest'|'Conflict'|'Forbidden'|'NotFound'|'PreconditionFailed'|'ResourceLimitExceeded'|'ServiceFailure'|'AccessDenied'|'ServiceUnavailable'|'Throttled'|'Throttling'|'Unauthorized'|'Unprocessable'|'VoiceConnectorGroupAssociationsExist'|'PhoneNumberAssociationsExist',
            'ErrorMessage': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • PhoneNumberErrors (list) --

      If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.

      • (dict) --

        If the phone number action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.

        • PhoneNumberId (string) --

          The phone number ID for which the action failed.

        • ErrorCode (string) --

          The error code.

        • ErrorMessage (string) --

          The error message.

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.AccessDeniedException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
associate_phone_numbers_with_voice_connector_group(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.associate_phone_numbers_with_voice_connector_group(
    VoiceConnectorGroupId='string',
    E164PhoneNumbers=[
        'string',
    ],
    ForceAssociate=True|False
)
Parameters
  • VoiceConnectorGroupId (string) --

    [REQUIRED]

    The Amazon Chime Voice Connector group ID.

  • E164PhoneNumbers (list) --

    [REQUIRED]

    List of phone numbers, in E.164 format.

    • (string) --
  • ForceAssociate (boolean) -- If true, associates the provided phone numbers with the provided Amazon Chime Voice Connector Group and removes any previously existing associations. If false, does not associate any phone numbers that have previously existing associations.
Return type

dict

Returns

Response Syntax

{
    'PhoneNumberErrors': [
        {
            'PhoneNumberId': 'string',
            'ErrorCode': 'BadRequest'|'Conflict'|'Forbidden'|'NotFound'|'PreconditionFailed'|'ResourceLimitExceeded'|'ServiceFailure'|'AccessDenied'|'ServiceUnavailable'|'Throttled'|'Throttling'|'Unauthorized'|'Unprocessable'|'VoiceConnectorGroupAssociationsExist'|'PhoneNumberAssociationsExist',
            'ErrorMessage': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • PhoneNumberErrors (list) --

      If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.

      • (dict) --

        If the phone number action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.

        • PhoneNumberId (string) --

          The phone number ID for which the action failed.

        • ErrorCode (string) --

          The error code.

        • ErrorMessage (string) --

          The error message.

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.AccessDeniedException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
associate_signin_delegate_groups_with_account(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.associate_signin_delegate_groups_with_account(
    AccountId='string',
    SigninDelegateGroups=[
        {
            'GroupName': 'string'
        },
    ]
)
Parameters
  • AccountId (string) --

    [REQUIRED]

    The Amazon Chime account ID.

  • SigninDelegateGroups (list) --

    [REQUIRED]

    The sign-in delegate groups.

    • (dict) --

      An Active Directory (AD) group whose members are granted permission to act as delegates.

      • GroupName (string) --

        The group name.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
batch_create_attendee(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.batch_create_attendee(
    MeetingId='string',
    Attendees=[
        {
            'ExternalUserId': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ]
)
Parameters
  • MeetingId (string) --

    [REQUIRED]

    The Amazon Chime SDK meeting ID.

  • Attendees (list) --

    [REQUIRED]

    The request containing the attendees to create.

    • (dict) --

      The Amazon Chime SDK attendee fields to create, used with the BatchCreateAttendee action.

      • ExternalUserId (string) -- [REQUIRED]

        The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application. If you create an attendee with the same external user id, the service returns the existing record.

        The Amazon Chime SDK external user ID. Links the attendee to an identity managed by a builder application.

      • Tags (list) --

        The tag key-value pairs.

        • (dict) --

          Describes a tag applied to a resource.

          • Key (string) -- [REQUIRED]

            The key of the tag.

          • Value (string) -- [REQUIRED]

            The value of the tag.

Return type

dict

Returns

Response Syntax

{
    'Attendees': [
        {
            'ExternalUserId': 'string',
            'AttendeeId': 'string',
            'JoinToken': 'string'
        },
    ],
    'Errors': [
        {
            'ExternalUserId': 'string',
            'ErrorCode': 'string',
            'ErrorMessage': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • Attendees (list) --

      The attendee information, including attendees IDs and join tokens.

      • (dict) --

        An Amazon Chime SDK meeting attendee. Includes a unique AttendeeId and JoinToken . The JoinToken allows a client to authenticate and join as the specified attendee. The JoinToken expires when the meeting ends or when DeleteAttendee is called. After that, the attendee is unable to join the meeting.

        We recommend securely transferring each JoinToken from your server application to the client so that no other client has access to the token except for the one authorized to represent the attendee.

        • ExternalUserId (string) --

          The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application. If you create an attendee with the same external user id, the service returns the existing record.

        • AttendeeId (string) --

          The Amazon Chime SDK attendee ID.

        • JoinToken (string) --

          The join token used by the Amazon Chime SDK attendee.

    • Errors (list) --

      If the action fails for one or more of the attendees in the request, a list of the attendees is returned, along with error codes and error messages.

      • (dict) --

        The list of errors returned when errors are encountered during the BatchCreateAttendee and CreateAttendee actions. This includes external user IDs, error codes, and error messages.

        • ExternalUserId (string) --

          The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application. If you create an attendee with the same external user id, the service returns the existing record.

        • ErrorCode (string) --

          The error code.

        • ErrorMessage (string) --

          The error message.

Exceptions

  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.ResourceLimitExceededException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
batch_create_room_membership(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.batch_create_room_membership(
    AccountId='string',
    RoomId='string',
    MembershipItemList=[
        {
            'MemberId': 'string',
            'Role': 'Administrator'|'Member'
        },
    ]
)
Parameters
  • AccountId (string) --

    [REQUIRED]

    The Amazon Chime account ID.

  • RoomId (string) --

    [REQUIRED]

    The room ID.

  • MembershipItemList (list) --

    [REQUIRED]

    The list of membership items.

    • (dict) --

      Membership details, such as member ID and member role.

      • MemberId (string) --

        The member ID.

      • Role (string) --

        The member role.

Return type

dict

Returns

Response Syntax

{
    'Errors': [
        {
            'MemberId': 'string',
            'ErrorCode': 'BadRequest'|'Conflict'|'Forbidden'|'NotFound'|'PreconditionFailed'|'ResourceLimitExceeded'|'ServiceFailure'|'AccessDenied'|'ServiceUnavailable'|'Throttled'|'Throttling'|'Unauthorized'|'Unprocessable'|'VoiceConnectorGroupAssociationsExist'|'PhoneNumberAssociationsExist',
            'ErrorMessage': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • Errors (list) --

      If the action fails for one or more of the member IDs in the request, a list of the member IDs is returned, along with error codes and error messages.

      • (dict) --

        The list of errors returned when a member action results in an error.

        • MemberId (string) --

          The member ID.

        • ErrorCode (string) --

          The error code.

        • ErrorMessage (string) --

          The error message.

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
batch_delete_phone_number(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.batch_delete_phone_number(
    PhoneNumberIds=[
        'string',
    ]
)
Parameters
PhoneNumberIds (list) --

[REQUIRED]

List of phone number IDs.

  • (string) --
Return type
dict
Returns
Response Syntax
{
    'PhoneNumberErrors': [
        {
            'PhoneNumberId': 'string',
            'ErrorCode': 'BadRequest'|'Conflict'|'Forbidden'|'NotFound'|'PreconditionFailed'|'ResourceLimitExceeded'|'ServiceFailure'|'AccessDenied'|'ServiceUnavailable'|'Throttled'|'Throttling'|'Unauthorized'|'Unprocessable'|'VoiceConnectorGroupAssociationsExist'|'PhoneNumberAssociationsExist',
            'ErrorMessage': 'string'
        },
    ]
}

Response Structure

  • (dict) --
    • PhoneNumberErrors (list) --

      If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.

      • (dict) --

        If the phone number action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.

        • PhoneNumberId (string) --

          The phone number ID for which the action failed.

        • ErrorCode (string) --

          The error code.

        • ErrorMessage (string) --

          The error message.

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
batch_suspend_user(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.batch_suspend_user(
    AccountId='string',
    UserIdList=[
        'string',
    ]
)
Parameters
  • AccountId (string) --

    [REQUIRED]

    The Amazon Chime account ID.

  • UserIdList (list) --

    [REQUIRED]

    The request containing the user IDs to suspend.

    • (string) --
Return type

dict

Returns

Response Syntax

{
    'UserErrors': [
        {
            'UserId': 'string',
            'ErrorCode': 'BadRequest'|'Conflict'|'Forbidden'|'NotFound'|'PreconditionFailed'|'ResourceLimitExceeded'|'ServiceFailure'|'AccessDenied'|'ServiceUnavailable'|'Throttled'|'Throttling'|'Unauthorized'|'Unprocessable'|'VoiceConnectorGroupAssociationsExist'|'PhoneNumberAssociationsExist',
            'ErrorMessage': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • UserErrors (list) --

      If the BatchSuspendUser action fails for one or more of the user IDs in the request, a list of the user IDs is returned, along with error codes and error messages.

      • (dict) --

        The list of errors returned when errors are encountered during the BatchSuspendUser , BatchUnsuspendUser , or BatchUpdateUser actions. This includes user IDs, error codes, and error messages.

        • UserId (string) --

          The user ID for which the action failed.

        • ErrorCode (string) --

          The error code.

        • ErrorMessage (string) --

          The error message.

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
batch_unsuspend_user(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.batch_unsuspend_user(
    AccountId='string',
    UserIdList=[
        'string',
    ]
)
Parameters
  • AccountId (string) --

    [REQUIRED]

    The Amazon Chime account ID.

  • UserIdList (list) --

    [REQUIRED]

    The request containing the user IDs to unsuspend.

    • (string) --
Return type

dict

Returns

Response Syntax

{
    'UserErrors': [
        {
            'UserId': 'string',
            'ErrorCode': 'BadRequest'|'Conflict'|'Forbidden'|'NotFound'|'PreconditionFailed'|'ResourceLimitExceeded'|'ServiceFailure'|'AccessDenied'|'ServiceUnavailable'|'Throttled'|'Throttling'|'Unauthorized'|'Unprocessable'|'VoiceConnectorGroupAssociationsExist'|'PhoneNumberAssociationsExist',
            'ErrorMessage': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • UserErrors (list) --

      If the BatchUnsuspendUser action fails for one or more of the user IDs in the request, a list of the user IDs is returned, along with error codes and error messages.

      • (dict) --

        The list of errors returned when errors are encountered during the BatchSuspendUser , BatchUnsuspendUser , or BatchUpdateUser actions. This includes user IDs, error codes, and error messages.

        • UserId (string) --

          The user ID for which the action failed.

        • ErrorCode (string) --

          The error code.

        • ErrorMessage (string) --

          The error message.

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
batch_update_phone_number(**kwargs)

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

For product types, choose from Amazon Chime Business Calling and Amazon Chime Voice Connector. For toll-free numbers, you must use the Amazon Chime Voice Connector 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.

See also: AWS API Documentation

Request Syntax

response = client.batch_update_phone_number(
    UpdatePhoneNumberRequestItems=[
        {
            'PhoneNumberId': 'string',
            'ProductType': 'BusinessCalling'|'VoiceConnector',
            'CallingName': 'string'
        },
    ]
)
Parameters
UpdatePhoneNumberRequestItems (list) --

[REQUIRED]

The request containing the phone number IDs and product types or calling names to update.

  • (dict) --

    The phone number ID, product type, or calling name fields to update, used with the BatchUpdatePhoneNumber and UpdatePhoneNumber actions.

    • PhoneNumberId (string) -- [REQUIRED]

      The phone number ID to update.

    • ProductType (string) --

      The product type to update.

    • CallingName (string) --

      The outbound calling name to update.

Return type
dict
Returns
Response Syntax
{
    'PhoneNumberErrors': [
        {
            'PhoneNumberId': 'string',
            'ErrorCode': 'BadRequest'|'Conflict'|'Forbidden'|'NotFound'|'PreconditionFailed'|'ResourceLimitExceeded'|'ServiceFailure'|'AccessDenied'|'ServiceUnavailable'|'Throttled'|'Throttling'|'Unauthorized'|'Unprocessable'|'VoiceConnectorGroupAssociationsExist'|'PhoneNumberAssociationsExist',
            'ErrorMessage': 'string'
        },
    ]
}

Response Structure

  • (dict) --
    • PhoneNumberErrors (list) --

      If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.

      • (dict) --

        If the phone number action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.

        • PhoneNumberId (string) --

          The phone number ID for which the action failed.

        • ErrorCode (string) --

          The error code.

        • ErrorMessage (string) --

          The error message.

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
batch_update_user(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.batch_update_user(
    AccountId='string',
    UpdateUserRequestItems=[
        {
            'UserId': 'string',
            'LicenseType': 'Basic'|'Plus'|'Pro'|'ProTrial',
            'UserType': 'PrivateUser'|'SharedDevice',
            'AlexaForBusinessMetadata': {
                'IsAlexaForBusinessEnabled': True|False,
                'AlexaForBusinessRoomArn': 'string'
            }
        },
    ]
)
Parameters
  • AccountId (string) --

    [REQUIRED]

    The Amazon Chime account ID.

  • UpdateUserRequestItems (list) --

    [REQUIRED]

    The request containing the user IDs and details to update.

    • (dict) --

      The user ID and user fields to update, used with the BatchUpdateUser action.

      • UserId (string) -- [REQUIRED]

        The user ID.

      • LicenseType (string) --

        The user license type.

      • UserType (string) --

        The user type.

      • AlexaForBusinessMetadata (dict) --

        The Alexa for Business metadata.

        • IsAlexaForBusinessEnabled (boolean) --

          Starts or stops Alexa for Business.

        • AlexaForBusinessRoomArn (string) --

          The ARN of the room resource.

Return type

dict

Returns

Response Syntax

{
    'UserErrors': [
        {
            'UserId': 'string',
            'ErrorCode': 'BadRequest'|'Conflict'|'Forbidden'|'NotFound'|'PreconditionFailed'|'ResourceLimitExceeded'|'ServiceFailure'|'AccessDenied'|'ServiceUnavailable'|'Throttled'|'Throttling'|'Unauthorized'|'Unprocessable'|'VoiceConnectorGroupAssociationsExist'|'PhoneNumberAssociationsExist',
            'ErrorMessage': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • UserErrors (list) --

      If the BatchUpdateUser action fails for one or more of the user IDs in the request, a list of the user IDs is returned, along with error codes and error messages.

      • (dict) --

        The list of errors returned when errors are encountered during the BatchSuspendUser , BatchUnsuspendUser , or BatchUpdateUser actions. This includes user IDs, error codes, and error messages.

        • UserId (string) --

          The user ID for which the action failed.

        • ErrorCode (string) --

          The error code.

        • ErrorMessage (string) --

          The error message.

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns
True if the operation can be paginated, False otherwise.
create_account(**kwargs)

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 .

See also: AWS API Documentation

Request Syntax

response = client.create_account(
    Name='string'
)
Parameters
Name (string) --

[REQUIRED]

The name of the Amazon Chime account.

Return type
dict
Returns
Response Syntax
{
    'Account': {
        'AwsAccountId': 'string',
        'AccountId': 'string',
        'Name': 'string',
        'AccountType': 'Team'|'EnterpriseDirectory'|'EnterpriseLWA'|'EnterpriseOIDC',
        'CreatedTimestamp': datetime(2015, 1, 1),
        'DefaultLicense': 'Basic'|'Plus'|'Pro'|'ProTrial',
        'SupportedLicenses': [
            'Basic'|'Plus'|'Pro'|'ProTrial',
        ],
        'SigninDelegateGroups': [
            {
                'GroupName': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) --
    • Account (dict) --

      The Amazon Chime account details. An AWS account can have multiple Amazon Chime accounts.

      • AwsAccountId (string) --

        The AWS account ID.

      • AccountId (string) --

        The Amazon Chime account ID.

      • Name (string) --

        The Amazon Chime account name.

      • AccountType (string) --

        The Amazon Chime account type. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide .

      • CreatedTimestamp (datetime) --

        The Amazon Chime account creation timestamp, in ISO 8601 format.

      • DefaultLicense (string) --

        The default license for the Amazon Chime account.

      • SupportedLicenses (list) --

        Supported licenses for the Amazon Chime account.

        • (string) --
      • SigninDelegateGroups (list) --

        The sign-in delegate groups associated with the account.

        • (dict) --

          An Active Directory (AD) group whose members are granted permission to act as delegates.

          • GroupName (string) --

            The group name.

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
create_app_instance(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.create_app_instance(
    Name='string',
    Metadata='string',
    ClientRequestToken='string'
)
Parameters
  • Name (string) --

    [REQUIRED]

    The name of the app instance.

  • Metadata (string) -- The metadata of the app instance. Limited to a 1KB string in UTF-8.
  • ClientRequestToken (string) --

    [REQUIRED]

    The ClientRequestToken of the app instance.

    This field is autopopulated if not provided.

Return type

dict

Returns

Response Syntax

{
    'AppInstanceArn': 'string'
}

Response Structure

  • (dict) --

    • AppInstanceArn (string) --

      The Amazon Resource Number (ARN) of the app instance.

Exceptions

  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ConflictException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.ResourceLimitExceededException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
create_app_instance_admin(**kwargs)

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

  • ChannelModerator actions across all channels in the app instance.
  • DeleteChannelMessage actions.

Only an AppInstanceUser can be promoted to an AppInstanceAdmin role.

See also: AWS API Documentation

Request Syntax

response = client.create_app_instance_admin(
    AppInstanceAdminArn='string',
    AppInstanceArn='string'
)
Parameters
  • AppInstanceAdminArn (string) --

    [REQUIRED]

    The ARN of the administrator of the current app instance.

  • AppInstanceArn (string) --

    [REQUIRED]

    The ARN of the app instance.

Return type

dict

Returns

Response Syntax

{
    'AppInstanceAdmin': {
        'Arn': 'string',
        'Name': 'string'
    },
    'AppInstanceArn': 'string'
}

Response Structure

  • (dict) --

    • AppInstanceAdmin (dict) --

      The name and ARN of the admin for the app instance.

      • Arn (string) --

        The ARN in an Identity.

      • Name (string) --

        The name in an Identity.

    • AppInstanceArn (string) --

      The ARN of the of the admin for the app instance.

Exceptions

  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ConflictException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.ResourceLimitExceededException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
create_app_instance_user(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.create_app_instance_user(
    AppInstanceArn='string',
    AppInstanceUserId='string',
    Name='string',
    Metadata='string',
    ClientRequestToken='string'
)
Parameters
  • AppInstanceArn (string) --

    [REQUIRED]

    The ARN of the app instance request.

  • AppInstanceUserId (string) --

    [REQUIRED]

    The user ID of the app instance.

  • Name (string) --

    [REQUIRED]

    The user's name.

  • Metadata (string) -- The request's metadata. Limited to a 1KB string in UTF-8.
  • ClientRequestToken (string) --

    [REQUIRED]

    The token assigned to the user requesting an app instance.

    This field is autopopulated if not provided.

Return type

dict

Returns

Response Syntax

{
    'AppInstanceUserArn': 'string'
}

Response Structure

  • (dict) --

    • AppInstanceUserArn (string) --

      The user's ARN.

Exceptions

  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ConflictException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.ResourceLimitExceededException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
create_attendee(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.create_attendee(
    MeetingId='string',
    ExternalUserId='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters
  • MeetingId (string) --

    [REQUIRED]

    The Amazon Chime SDK meeting ID.

  • ExternalUserId (string) --

    [REQUIRED]

    The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application. If you create an attendee with the same external user id, the service returns the existing record.

  • Tags (list) --

    The tag key-value pairs.

    • (dict) --

      Describes a tag applied to a resource.

      • Key (string) -- [REQUIRED]

        The key of the tag.

      • Value (string) -- [REQUIRED]

        The value of the tag.

Return type

dict

Returns

Response Syntax

{
    'Attendee': {
        'ExternalUserId': 'string',
        'AttendeeId': 'string',
        'JoinToken': 'string'
    }
}

Response Structure

  • (dict) --

    • Attendee (dict) --

      The attendee information, including attendee ID and join token.

      • ExternalUserId (string) --

        The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application. If you create an attendee with the same external user id, the service returns the existing record.

      • AttendeeId (string) --

        The Amazon Chime SDK attendee ID.

      • JoinToken (string) --

        The join token used by the Amazon Chime SDK attendee.

Exceptions

  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.ResourceLimitExceededException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
create_bot(**kwargs)

Creates a bot for an Amazon Chime Enterprise account.

See also: AWS API Documentation

Request Syntax

response = client.create_bot(
    AccountId='string',
    DisplayName='string',
    Domain='string'
)
Parameters
  • AccountId (string) --

    [REQUIRED]

    The Amazon Chime account ID.

  • DisplayName (string) --

    [REQUIRED]

    The bot display name.

  • Domain (string) -- The domain of the Amazon Chime Enterprise account.
Return type

dict

Returns

Response Syntax

{
    'Bot': {
        'BotId': 'string',
        'UserId': 'string',
        'DisplayName': 'string',
        'BotType': 'ChatBot',
        'Disabled': True|False,
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1),
        'BotEmail': 'string',
        'SecurityToken': 'string'
    }
}

Response Structure

  • (dict) --

    • Bot (dict) --

      The bot details.

      • BotId (string) --

        The bot ID.

      • UserId (string) --

        The unique ID for the bot user.

      • DisplayName (string) --

        The bot display name.

      • BotType (string) --

        The bot type.

      • Disabled (boolean) --

        When true, the bot is stopped from running in your account.

      • CreatedTimestamp (datetime) --

        The bot creation timestamp, in ISO 8601 format.

      • UpdatedTimestamp (datetime) --

        The updated bot timestamp, in ISO 8601 format.

      • BotEmail (string) --

        The bot email address.

      • SecurityToken (string) --

        The security token used to authenticate Amazon Chime with the outgoing event endpoint.

Exceptions

  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ResourceLimitExceededException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.ThrottledClientException
create_channel(**kwargs)

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

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

See also: AWS API Documentation

Request Syntax

response = client.create_channel(
    AppInstanceArn='string',
    Name='string',
    Mode='UNRESTRICTED'|'RESTRICTED',
    Privacy='PUBLIC'|'PRIVATE',
    Metadata='string',
    ClientRequestToken='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters
  • AppInstanceArn (string) --

    [REQUIRED]

    The ARN of the channel request.

  • Name (string) --

    [REQUIRED]

    The name of the channel.

  • Mode (string) -- The channel mode: UNRESTRICTED or RESTRICTED . Administrators, moderators, and channel members can add themselves and other members to unrestricted channels. Only administrators and moderators can add members to restricted channels.
  • Privacy (string) -- The channel's privacy level: PUBLIC or PRIVATE . Private channels aren't discoverable by users outside the channel. Public channels are discoverable by anyone in the app instance.
  • Metadata (string) -- The metadata of the creation request. Limited to 1KB and UTF-8.
  • ClientRequestToken (string) --

    [REQUIRED]

    The client token for the request. An Idempotency token.

    This field is autopopulated if not provided.

  • Tags (list) --
    • (dict) --

      Describes a tag applied to a resource.

      • Key (string) -- [REQUIRED]

        The key of the tag.

      • Value (string) -- [REQUIRED]

        The value of the tag.

Return type

dict

Returns

Response Syntax

{
    'ChannelArn': 'string'
}

Response Structure

  • (dict) --

    • ChannelArn (string) --

      The ARN of the channel.

Exceptions

  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ConflictException
  • Chime.Client.exceptions.ResourceLimitExceededException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
create_channel_ban(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.create_channel_ban(
    ChannelArn='string',
    MemberArn='string'
)
Parameters
  • ChannelArn (string) --

    [REQUIRED]

    The ARN of the ban request.

  • MemberArn (string) --

    [REQUIRED]

    The ARN of the member being banned.

Return type

dict

Returns

Response Syntax

{
    'ChannelArn': 'string',
    'Member': {
        'Arn': 'string',
        'Name': 'string'
    }
}

Response Structure

  • (dict) --

    • ChannelArn (string) --

      The ARN of the response to the ban request.

    • Member (dict) --

      The ChannelArn and BannedIdentity of the member in the ban response.

      • Arn (string) --

        The ARN in an Identity.

      • Name (string) --

        The name in an Identity.

Exceptions

  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ConflictException
  • Chime.Client.exceptions.ResourceLimitExceededException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
create_channel_membership(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.create_channel_membership(
    ChannelArn='string',
    MemberArn='string',
    Type='DEFAULT'|'HIDDEN'
)
Parameters
  • ChannelArn (string) --

    [REQUIRED]

    The ARN of the channel to which you're adding users.

  • MemberArn (string) --

    [REQUIRED]

    The ARN of the member you want to add to the channel.

  • Type (string) --

    [REQUIRED]

    The membership type of a user, DEFAULT or HIDDEN . Default members are always returned as part of ListChannelMemberships . Hidden members are only returned if the type filter in ListChannelMemberships equals HIDDEN . Otherwise hidden members are not returned. This is only supported by moderators.

Return type

dict

Returns

Response Syntax

{
    'ChannelArn': 'string',
    'Member': {
        'Arn': 'string',
        'Name': 'string'
    }
}

Response Structure

  • (dict) --

    • ChannelArn (string) --

      The ARN of the channel.

    • Member (dict) --

      The ARN and metadata of the member being added.

      • Arn (string) --

        The ARN in an Identity.

      • Name (string) --

        The name in an Identity.

Exceptions

  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ConflictException
  • Chime.Client.exceptions.ResourceLimitExceededException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
create_channel_moderator(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.create_channel_moderator(
    ChannelArn='string',
    ChannelModeratorArn='string'
)
Parameters
  • ChannelArn (string) --

    [REQUIRED]

    The ARN of the channel.

  • ChannelModeratorArn (string) --

    [REQUIRED]

    The ARN of the moderator.

Return type

dict

Returns

Response Syntax

{
    'ChannelArn': 'string',
    'ChannelModerator': {
        'Arn': 'string',
        'Name': 'string'
    }
}

Response Structure

  • (dict) --

    • ChannelArn (string) --

      The ARN of the channel.

    • ChannelModerator (dict) --

      The ARNs of the channel and the moderator.

      • Arn (string) --

        The ARN in an Identity.

      • Name (string) --

        The name in an Identity.

Exceptions

  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ConflictException
  • Chime.Client.exceptions.ResourceLimitExceededException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
create_meeting(**kwargs)

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 Developer Guide . For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide .

See also: AWS API Documentation

Request Syntax

response = client.create_meeting(
    ClientRequestToken='string',
    ExternalMeetingId='string',
    MeetingHostId='string',
    MediaRegion='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    NotificationsConfiguration={
        'SnsTopicArn': 'string',
        'SqsQueueArn': 'string'
    }
)
Parameters
  • ClientRequestToken (string) --

    [REQUIRED]

    The unique identifier for the client request. Use a different token for different meetings.

    This field is autopopulated if not provided.

  • ExternalMeetingId (string) -- The external meeting ID.
  • MeetingHostId (string) -- Reserved.
  • MediaRegion (string) --

    The Region in which to create the meeting. Default: us-east-1 .

    Available values: af-south-1 , ap-northeast-1 , ap-northeast-2 , ap-south-1 , ap-southeast-1 , ap-southeast-2 , ca-central-1 , eu-central-1 , eu-north-1 , eu-south-1 , eu-west-1 , eu-west-2 , eu-west-3 , sa-east-1 , us-east-1 , us-east-2 , us-west-1 , us-west-2 .

  • Tags (list) --

    The tag key-value pairs.

    • (dict) --

      Describes a tag applied to a resource.

      • Key (string) -- [REQUIRED]

        The key of the tag.

      • Value (string) -- [REQUIRED]

        The value of the tag.

  • NotificationsConfiguration (dict) --

    The configuration for resource targets to receive notifications when meeting and attendee events occur.

    • SnsTopicArn (string) --

      The SNS topic ARN.

    • SqsQueueArn (string) --

      The SQS queue ARN.

Return type

dict

Returns

Response Syntax

{
    'Meeting': {
        'MeetingId': 'string',
        'ExternalMeetingId': 'string',
        'MediaPlacement': {
            'AudioHostUrl': 'string',
            'AudioFallbackUrl': 'string',
            'ScreenDataUrl': 'string',
            'ScreenSharingUrl': 'string',
            'ScreenViewingUrl': 'string',
            'SignalingUrl': 'string',
            'TurnControlUrl': 'string'
        },
        'MediaRegion': 'string'
    }
}

Response Structure

  • (dict) --

    • Meeting (dict) --

      The meeting information, including the meeting ID and MediaPlacement .

      • MeetingId (string) --

        The Amazon Chime SDK meeting ID.

      • ExternalMeetingId (string) --

        The external meeting ID.

      • MediaPlacement (dict) --

        The media placement for the meeting.

        • AudioHostUrl (string) --

          The audio host URL.

        • AudioFallbackUrl (string) --

          The audio fallback URL.

        • ScreenDataUrl (string) --

          The screen data URL.

        • ScreenSharingUrl (string) --

          The screen sharing URL.

        • ScreenViewingUrl (string) --

          The screen viewing URL.

        • SignalingUrl (string) --

          The signaling URL.

        • TurnControlUrl (string) --

          The turn control URL.

      • MediaRegion (string) --

        The Region in which to create the meeting. Available values: af-south-1 , ap-northeast-1 , ap-northeast-2 , ap-south-1 , ap-southeast-1 , ap-southeast-2 , ca-central-1 , eu-central-1 , eu-north-1 , eu-south-1 , eu-west-1 , eu-west-2 , eu-west-3 , sa-east-1 , us-east-1 , us-east-2 , us-west-1 , us-west-2 .

Exceptions

  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.ResourceLimitExceededException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
create_meeting_dial_out(**kwargs)

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 joins them into 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 API with the corresponding SIP media application ID.

See also: AWS API Documentation

Request Syntax

response = client.create_meeting_dial_out(
    MeetingId='string',
    FromPhoneNumber='string',
    ToPhoneNumber='string',
    JoinToken='string'
)
Parameters
  • MeetingId (string) --

    [REQUIRED]

    The Amazon Chime SDK meeting ID.

    Type: String

    Pattern: [a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}

    Required: No

  • FromPhoneNumber (string) --

    [REQUIRED]

    Phone number used as the caller ID when the remote party receives a call.

  • ToPhoneNumber (string) --

    [REQUIRED]

    Phone number called when inviting someone to a meeting.

  • JoinToken (string) --

    [REQUIRED]

    Token used by the Amazon Chime SDK attendee. Call the CreateAttendee API to get a join token.

Return type

dict

Returns

Response Syntax

{
    'TransactionId': 'string'
}

Response Structure

  • (dict) --

    • TransactionId (string) --

      Unique ID that tracks API calls.

Exceptions

  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.ResourceLimitExceededException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
create_meeting_with_attendees(**kwargs)

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 Developer Guide . For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide .

See also: AWS API Documentation

Request Syntax

response = client.create_meeting_with_attendees(
    ClientRequestToken='string',
    ExternalMeetingId='string',
    MeetingHostId='string',
    MediaRegion='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    NotificationsConfiguration={
        'SnsTopicArn': 'string',
        'SqsQueueArn': 'string'
    },
    Attendees=[
        {
            'ExternalUserId': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ]
)
Parameters
  • ClientRequestToken (string) --

    [REQUIRED]

    The unique identifier for the client request. Use a different token for different meetings.

    This field is autopopulated if not provided.

  • ExternalMeetingId (string) -- The external meeting ID.
  • MeetingHostId (string) -- Reserved.
  • MediaRegion (string) --

    The Region in which to create the meeting. Default: us-east-1 .

    Available values: af-south-1 , ap-northeast-1 , ap-northeast-2 , ap-south-1 , ap-southeast-1 , ap-southeast-2 , ca-central-1 , eu-central-1 , eu-north-1 , eu-south-1 , eu-west-1 , eu-west-2 , eu-west-3 , sa-east-1 , us-east-1 , us-east-2 , us-west-1 , us-west-2 .

  • Tags (list) --

    The tag key-value pairs.

    • (dict) --

      Describes a tag applied to a resource.

      • Key (string) -- [REQUIRED]

        The key of the tag.

      • Value (string) -- [REQUIRED]

        The value of the tag.

  • NotificationsConfiguration (dict) --

    The configuration for resource targets to receive notifications when Amazon Chime SDK meeting and attendee events occur. The Amazon Chime SDK supports resource targets located in the US East (N. Virginia) AWS Region (us-east-1 ).

    • SnsTopicArn (string) --

      The SNS topic ARN.

    • SqsQueueArn (string) --

      The SQS queue ARN.

  • Attendees (list) --

    The request containing the attendees to create.

    • (dict) --

      The Amazon Chime SDK attendee fields to create, used with the BatchCreateAttendee action.

      • ExternalUserId (string) -- [REQUIRED]

        The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application. If you create an attendee with the same external user id, the service returns the existing record.

        The Amazon Chime SDK external user ID. Links the attendee to an identity managed by a builder application.

      • Tags (list) --

        The tag key-value pairs.

        • (dict) --

          Describes a tag applied to a resource.

          • Key (string) -- [REQUIRED]

            The key of the tag.

          • Value (string) -- [REQUIRED]

            The value of the tag.

Return type

dict

Returns

Response Syntax

{
    'Meeting': {
        'MeetingId': 'string',
        'ExternalMeetingId': 'string',
        'MediaPlacement': {
            'AudioHostUrl': 'string',
            'AudioFallbackUrl': 'string',
            'ScreenDataUrl': 'string',
            'ScreenSharingUrl': 'string',
            'ScreenViewingUrl': 'string',
            'SignalingUrl': 'string',
            'TurnControlUrl': 'string'
        },
        'MediaRegion': 'string'
    },
    'Attendees': [
        {
            'ExternalUserId': 'string',
            'AttendeeId': 'string',
            'JoinToken': 'string'
        },
    ],
    'Errors': [
        {
            'ExternalUserId': 'string',
            'ErrorCode': 'string',
            'ErrorMessage': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • Meeting (dict) --

      A meeting created using the Amazon Chime SDK.

      • MeetingId (string) --

        The Amazon Chime SDK meeting ID.

      • ExternalMeetingId (string) --

        The external meeting ID.

      • MediaPlacement (dict) --

        The media placement for the meeting.

        • AudioHostUrl (string) --

          The audio host URL.

        • AudioFallbackUrl (string) --

          The audio fallback URL.

        • ScreenDataUrl (string) --

          The screen data URL.

        • ScreenSharingUrl (string) --

          The screen sharing URL.

        • ScreenViewingUrl (string) --

          The screen viewing URL.

        • SignalingUrl (string) --

          The signaling URL.

        • TurnControlUrl (string) --

          The turn control URL.

      • MediaRegion (string) --

        The Region in which to create the meeting. Available values: af-south-1 , ap-northeast-1 , ap-northeast-2 , ap-south-1 , ap-southeast-1 , ap-southeast-2 , ca-central-1 , eu-central-1 , eu-north-1 , eu-south-1 , eu-west-1 , eu-west-2 , eu-west-3 , sa-east-1 , us-east-1 , us-east-2 , us-west-1 , us-west-2 .

    • Attendees (list) --

      The attendee information, including attendees IDs and join tokens.

      • (dict) --

        An Amazon Chime SDK meeting attendee. Includes a unique AttendeeId and JoinToken . The JoinToken allows a client to authenticate and join as the specified attendee. The JoinToken expires when the meeting ends or when DeleteAttendee is called. After that, the attendee is unable to join the meeting.

        We recommend securely transferring each JoinToken from your server application to the client so that no other client has access to the token except for the one authorized to represent the attendee.

        • ExternalUserId (string) --

          The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application. If you create an attendee with the same external user id, the service returns the existing record.

        • AttendeeId (string) --

          The Amazon Chime SDK attendee ID.

        • JoinToken (string) --

          The join token used by the Amazon Chime SDK attendee.

    • Errors (list) --

      If the action fails for one or more of the attendees in the request, a list of the attendees is returned, along with error codes and error messages.

      • (dict) --

        The list of errors returned when errors are encountered during the BatchCreateAttendee and CreateAttendee actions. This includes external user IDs, error codes, and error messages.

        • ExternalUserId (string) --

          The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application. If you create an attendee with the same external user id, the service returns the existing record.

        • ErrorCode (string) --

          The error code.

        • ErrorMessage (string) --

          The error message.

Exceptions

  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.ResourceLimitExceededException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
create_phone_number_order(**kwargs)

Creates an order for phone numbers to be provisioned. Choose from Amazon Chime Business Calling and Amazon Chime Voice Connector product types. For toll-free numbers, you must use the Amazon Chime Voice Connector product type.

See also: AWS API Documentation

Request Syntax

response = client.create_phone_number_order(
    ProductType='BusinessCalling'|'VoiceConnector',
    E164PhoneNumbers=[
        'string',
    ]
)
Parameters
  • ProductType (string) --

    [REQUIRED]

    The phone number product type.

  • E164PhoneNumbers (list) --

    [REQUIRED]

    List of phone numbers, in E.164 format.

    • (string) --
Return type

dict

Returns

Response Syntax

{
    'PhoneNumberOrder': {
        'PhoneNumberOrderId': 'string',
        'ProductType': 'BusinessCalling'|'VoiceConnector',
        'Status': 'Processing'|'Successful'|'Failed'|'Partial',
        'OrderedPhoneNumbers': [
            {
                'E164PhoneNumber': 'string',
                'Status': 'Processing'|'Acquired'|'Failed'
            },
        ],
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) --

    • PhoneNumberOrder (dict) --

      The phone number order details.

      • PhoneNumberOrderId (string) --

        The phone number order ID.

      • ProductType (string) --

        The phone number order product type.

      • Status (string) --

        The status of the phone number order.

      • OrderedPhoneNumbers (list) --

        The ordered phone number details, such as the phone number in E.164 format and the phone number status.

        • (dict) --

          A phone number for which an order has been placed.

          • E164PhoneNumber (string) --

            The phone number, in E.164 format.

          • Status (string) --

            The phone number status.

      • CreatedTimestamp (datetime) --

        The phone number order creation timestamp, in ISO 8601 format.

      • UpdatedTimestamp (datetime) --

        The updated phone number order timestamp, in ISO 8601 format.

Exceptions

  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.AccessDeniedException
  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ResourceLimitExceededException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
create_proxy_session(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.create_proxy_session(
    VoiceConnectorId='string',
    ParticipantPhoneNumbers=[
        'string',
    ],
    Name='string',
    ExpiryMinutes=123,
    Capabilities=[
        'Voice'|'SMS',
    ],
    NumberSelectionBehavior='PreferSticky'|'AvoidSticky',
    GeoMatchLevel='Country'|'AreaCode',
    GeoMatchParams={
        'Country': 'string',
        'AreaCode': 'string'
    }
)
Parameters
  • VoiceConnectorId (string) --

    [REQUIRED]

    The Amazon Chime voice connector ID.

  • ParticipantPhoneNumbers (list) --

    [REQUIRED]

    The participant phone numbers.

    • (string) --
  • Name (string) -- The name of the proxy session.
  • ExpiryMinutes (integer) -- The number of minutes allowed for the proxy session.
  • Capabilities (list) --

    [REQUIRED]

    The proxy session capabilities.

    • (string) --
  • NumberSelectionBehavior (string) -- The preference for proxy phone number reuse, or stickiness, between the same participants across sessions.
  • GeoMatchLevel (string) -- The preference for matching the country or area code of the proxy phone number with that of the first participant.
  • GeoMatchParams (dict) --

    The country and area code for the proxy phone number.

    • Country (string) -- [REQUIRED]

      The country.

    • AreaCode (string) -- [REQUIRED]

      The area code.

Return type

dict

Returns

Response Syntax

{
    'ProxySession': {
        'VoiceConnectorId': 'string',
        'ProxySessionId': 'string',
        'Name': 'string',
        'Status': 'Open'|'InProgress'|'Closed',
        'ExpiryMinutes': 123,
        'Capabilities': [
            'Voice'|'SMS',
        ],
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1),
        'EndedTimestamp': datetime(2015, 1, 1),
        'Participants': [
            {
                'PhoneNumber': 'string',
                'ProxyPhoneNumber': 'string'
            },
        ],
        'NumberSelectionBehavior': 'PreferSticky'|'AvoidSticky',
        'GeoMatchLevel': 'Country'|'AreaCode',
        'GeoMatchParams': {
            'Country': 'string',
            'AreaCode': 'string'
        }
    }
}

Response Structure

  • (dict) --

    • ProxySession (dict) --

      The proxy session details.

      • VoiceConnectorId (string) --

        The Amazon Chime voice connector ID.

      • ProxySessionId (string) --

        The proxy session ID.

      • Name (string) --

        The name of the proxy session.

      • Status (string) --

        The status of the proxy session.

      • ExpiryMinutes (integer) --

        The number of minutes allowed for the proxy session.

      • Capabilities (list) --

        The proxy session capabilities.

        • (string) --
      • CreatedTimestamp (datetime) --

        The created timestamp, in ISO 8601 format.

      • UpdatedTimestamp (datetime) --

        The updated timestamp, in ISO 8601 format.

      • EndedTimestamp (datetime) --

        The ended timestamp, in ISO 8601 format.

      • Participants (list) --

        The proxy session participants.

        • (dict) --

          The phone number and proxy phone number for a participant in an Amazon Chime Voice Connector proxy session.

          • PhoneNumber (string) --

            The participant's phone number.

          • ProxyPhoneNumber (string) --

            The participant's proxy phone number.

      • NumberSelectionBehavior (string) --

        The preference for proxy phone number reuse, or stickiness, between the same participants across sessions.

      • GeoMatchLevel (string) --

        The preference for matching the country or area code of the proxy phone number with that of the first participant.

      • GeoMatchParams (dict) --

        The country and area code for the proxy phone number.

        • Country (string) --

          The country.

        • AreaCode (string) --

          The area code.

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
create_room(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.create_room(
    AccountId='string',
    Name='string',
    ClientRequestToken='string'
)
Parameters
  • AccountId (string) --

    [REQUIRED]

    The Amazon Chime account ID.

  • Name (string) --

    [REQUIRED]

    The room name.

  • ClientRequestToken (string) --

    The idempotency token for the request.

    This field is autopopulated if not provided.

Return type

dict

Returns

Response Syntax

{
    'Room': {
        'RoomId': 'string',
        'Name': 'string',
        'AccountId': 'string',
        'CreatedBy': 'string',
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) --

    • Room (dict) --

      The room details.

      • RoomId (string) --

        The room ID.

      • Name (string) --

        The room name.

      • AccountId (string) --

        The Amazon Chime account ID.

      • CreatedBy (string) --

        The identifier of the room creator.

      • CreatedTimestamp (datetime) --

        The room creation timestamp, in ISO 8601 format.

      • UpdatedTimestamp (datetime) --

        The room update timestamp, in ISO 8601 format.

Exceptions

  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ResourceLimitExceededException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
create_room_membership(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.create_room_membership(
    AccountId='string',
    RoomId='string',
    MemberId='string',
    Role='Administrator'|'Member'
)
Parameters
  • AccountId (string) --

    [REQUIRED]

    The Amazon Chime account ID.

  • RoomId (string) --

    [REQUIRED]

    The room ID.

  • MemberId (string) --

    [REQUIRED]

    The Amazon Chime member ID (user ID or bot ID).

  • Role (string) -- The role of the member.
Return type

dict

Returns

Response Syntax

{
    'RoomMembership': {
        'RoomId': 'string',
        'Member': {
            'MemberId': 'string',
            'MemberType': 'User'|'Bot'|'Webhook',
            'Email': 'string',
            'FullName': 'string',
            'AccountId': 'string'
        },
        'Role': 'Administrator'|'Member',
        'InvitedBy': 'string',
        'UpdatedTimestamp': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) --

    • RoomMembership (dict) --

      The room membership details.

      • RoomId (string) --

        The room ID.

      • Member (dict) --

        The member details, such as email address, name, member ID, and member type.

        • MemberId (string) --

          The member ID (user ID or bot ID).

        • MemberType (string) --

          The member type.

        • Email (string) --

          The member email address.

        • FullName (string) --

          The member name.

        • AccountId (string) --

          The Amazon Chime account ID.

      • Role (string) --

        The membership role.

      • InvitedBy (string) --

        The identifier of the user that invited the room member.

      • UpdatedTimestamp (datetime) --

        The room membership update timestamp, in ISO 8601 format.

Exceptions

  • Chime.Client.exceptions.ConflictException
  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.ResourceLimitExceededException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
create_sip_media_application(**kwargs)

Creates a SIP media application.

See also: AWS API Documentation

Request Syntax

response = client.create_sip_media_application(
    AwsRegion='string',
    Name='string',
    Endpoints=[
        {
            'LambdaArn': 'string'
        },
    ]
)
Parameters
  • AwsRegion (string) --

    [REQUIRED]

    AWS Region assigned to the SIP media application.

  • Name (string) -- The SIP media application name.
  • Endpoints (list) --

    [REQUIRED]

    List of endpoints (Lambda Amazon Resource Names) specified for the SIP media application. Currently, only one endpoint is supported.

    • (dict) --

      Endpoints to specify as part of a SIP media application.

      • LambdaArn (string) --

        Valid Amazon Resource Name (ARN) of the Lambda function of the same AWS Region where the SIP media application is created.

Return type

dict

Returns

Response Syntax

{
    'SipMediaApplication': {
        'SipMediaApplicationId': 'string',
        'AwsRegion': 'string',
        'Name': 'string',
        'Endpoints': [
            {
                'LambdaArn': 'string'
            },
        ],
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) --

    • SipMediaApplication (dict) --

      The Sip media application details.

      • SipMediaApplicationId (string) --

        The SIP media application ID.

      • AwsRegion (string) --

        The AWS Region in which the SIP media application is created.

      • Name (string) --

        The name of the SIP media application.

      • Endpoints (list) --

        List of endpoints for SIP media application. Currently, only one endpoint per SIP media application is permitted.

        • (dict) --

          Endpoints to specify as part of a SIP media application.

          • LambdaArn (string) --

            Valid Amazon Resource Name (ARN) of the Lambda function of the same AWS Region where the SIP media application is created.

      • CreatedTimestamp (datetime) --

        The SIP media application creation timestamp, in ISO 8601 format.

      • UpdatedTimestamp (datetime) --

        The SIP media application updated timestamp, in ISO 8601 format.

Exceptions

  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.AccessDeniedException
  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ResourceLimitExceededException
  • Chime.Client.exceptions.ConflictException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
create_sip_media_application_call(**kwargs)

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 .

See also: AWS API Documentation

Request Syntax

response = client.create_sip_media_application_call(
    FromPhoneNumber='string',
    ToPhoneNumber='string',
    SipMediaApplicationId='string'
)
Parameters
  • FromPhoneNumber (string) -- The phone number that a user calls from.
  • ToPhoneNumber (string) -- The phone number that the user dials in order to connect to a meeting
  • SipMediaApplicationId (string) --

    [REQUIRED]

    The ID of the SIP media application.

Return type

dict

Returns

Response Syntax

{
    'SipMediaApplicationCall': {
        'TransactionId': 'string'
    }
}

Response Structure

  • (dict) --

    • SipMediaApplicationCall (dict) --

      The actual call.

      • TransactionId (string) --

        The transaction ID of a call.

Exceptions

  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.ResourceLimitExceededException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
create_sip_rule(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.create_sip_rule(
    Name='string',
    TriggerType='ToPhoneNumber'|'RequestUriHostname',
    TriggerValue='string',
    Disabled=True|False,
    TargetApplications=[
        {
            'SipMediaApplicationId': 'string',
            'Priority': 123,
            'AwsRegion': 'string'
        },
    ]
)
Parameters
  • Name (string) --

    [REQUIRED]

    The name of the SIP rule.

  • TriggerType (string) --

    [REQUIRED]

    The type of trigger whose value is assigned to the SIP rule in TriggerValue . Allowed trigger values are RequestUriHostname and ToPhoneNumber .

  • TriggerValue (string) --

    [REQUIRED]

    If TriggerType is RequestUriHostname then the value can be the outbound host name of an Amazon Chime Voice Connector. If TriggerType is ToPhoneNumber then the value can be a customer-owned phone number in E164 format. SipRule is triggered if the SIP application requests a host name, or a If TriggerType is RequestUriHostname , then the value can be the outbound hostname of an Amazon Chime Voice Connector. If TriggerType is ToPhoneNumber , then the value can be a customer-owned phone number in E164 format. SipRule is triggered if the SIP application requests a host name, or a ToPhoneNumber value matches the incoming SIP request.

  • Disabled (boolean) -- Enables or disables a rule. You must disable rules before you can delete them.
  • TargetApplications (list) --

    [REQUIRED]

    List of SIP media applications with priority and AWS Region. Only one SIP application per AWS Region can be used.

    • (dict) --

      Target SIP media application along with other details like priority and AWS Region to be specified in the SIP rule. Only one SIP rule per AWS Region can be provided.

      • SipMediaApplicationId (string) --

        The SIP media application ID.

      • Priority (integer) --

        Priority of the SIP media application in the target list.

      • AwsRegion (string) --

        AWS Region of target application.

Return type

dict

Returns

Response Syntax

{
    'SipRule': {
        'SipRuleId': 'string',
        'Name': 'string',
        'Disabled': True|False,
        'TriggerType': 'ToPhoneNumber'|'RequestUriHostname',
        'TriggerValue': 'string',
        'TargetApplications': [
            {
                'SipMediaApplicationId': 'string',
                'Priority': 123,
                'AwsRegion': 'string'
            },
        ],
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) --

    • SipRule (dict) --

      Returns the SIP rule information, including the rule ID, triggers, and target applications.

      • SipRuleId (string) --

        The SIP rule ID.

      • Name (string) --

        The name of the SIP rule.

      • Disabled (boolean) --

        Indicates if the SIP rule is enabled or disabled. You must disable a rule before you can delete it.

      • TriggerType (string) --

        The type of trigger whose value is assigned to the SIP rule in TriggerValue .

      • TriggerValue (string) --

        If TriggerType is RequestUriHostname , then the value can be the outbound host name of the Amazon Chime Voice Connector. If TriggerType is ToPhoneNumber , then the value can be a customer-owned phone number in E164 format. SipRule is triggered when a SIP rule requests host name or ToPhoneNumber matches in the incoming SIP request.

      • TargetApplications (list) --

        List of SIP media applications with priority and AWS Region. You can only use one SIP application per AWS Region and priority combination.

        • (dict) --

          Target SIP media application along with other details like priority and AWS Region to be specified in the SIP rule. Only one SIP rule per AWS Region can be provided.

          • SipMediaApplicationId (string) --

            The SIP media application ID.

          • Priority (integer) --

            Priority of the SIP media application in the target list.

          • AwsRegion (string) --

            AWS Region of target application.

      • CreatedTimestamp (datetime) --

        The SIP rule created timestamp, in ISO 8601 format.

      • UpdatedTimestamp (datetime) --

        The SIP rule updated timestamp, in ISO 8601 format.

Exceptions

  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.AccessDeniedException
  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ResourceLimitExceededException
  • Chime.Client.exceptions.ConflictException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
create_user(**kwargs)

Creates a user under the specified Amazon Chime account.

See also: AWS API Documentation

Request Syntax

response = client.create_user(
    AccountId='string',
    Username='string',
    Email='string',
    UserType='PrivateUser'|'SharedDevice'
)
Parameters
  • AccountId (string) --

    [REQUIRED]

    The Amazon Chime account ID.

  • Username (string) -- The user name.
  • Email (string) -- The user's email address.
  • UserType (string) -- The user type.
Return type

dict

Returns

Response Syntax

{
    'User': {
        'UserId': 'string',
        'AccountId': 'string',
        'PrimaryEmail': 'string',
        'PrimaryProvisionedNumber': 'string',
        'DisplayName': 'string',
        'LicenseType': 'Basic'|'Plus'|'Pro'|'ProTrial',
        'UserType': 'PrivateUser'|'SharedDevice',
        'UserRegistrationStatus': 'Unregistered'|'Registered'|'Suspended',
        'UserInvitationStatus': 'Pending'|'Accepted'|'Failed',
        'RegisteredOn': datetime(2015, 1, 1),
        'InvitedOn': datetime(2015, 1, 1),
        'AlexaForBusinessMetadata': {
            'IsAlexaForBusinessEnabled': True|False,
            'AlexaForBusinessRoomArn': 'string'
        },
        'PersonalPIN': 'string'
    }
}

Response Structure

  • (dict) --

    • User (dict) --

      The user on the Amazon Chime account.

      • UserId (string) --

        The user ID.

      • AccountId (string) --

        The Amazon Chime account ID.

      • PrimaryEmail (string) --

        The primary email address of the user.

      • PrimaryProvisionedNumber (string) --

        The primary phone number associated with the user.

      • DisplayName (string) --

        The display name of the user.

      • LicenseType (string) --

        The license type for the user.

      • UserType (string) --

        The user type.

      • UserRegistrationStatus (string) --

        The user registration status.

      • UserInvitationStatus (string) --

        The user invite status.

      • RegisteredOn (datetime) --

        Date and time when the user is registered, in ISO 8601 format.

      • InvitedOn (datetime) --

        Date and time when the user is invited to the Amazon Chime account, in ISO 8601 format.

      • AlexaForBusinessMetadata (dict) --

        The Alexa for Business metadata.

        • IsAlexaForBusinessEnabled (boolean) --

          Starts or stops Alexa for Business.

        • AlexaForBusinessRoomArn (string) --

          The ARN of the room resource.

      • PersonalPIN (string) --

        The user's personal meeting PIN.

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.ConflictException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
create_voice_connector(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.create_voice_connector(
    Name='string',
    AwsRegion='us-east-1'|'us-west-2',
    RequireEncryption=True|False
)
Parameters
  • Name (string) --

    [REQUIRED]

    The name of the Amazon Chime Voice Connector.

  • AwsRegion (string) -- The AWS Region in which the Amazon Chime Voice Connector is created. Default value: us-east-1 .
  • RequireEncryption (boolean) --

    [REQUIRED]

    When enabled, requires encryption for the Amazon Chime Voice Connector.

Return type

dict

Returns

Response Syntax

{
    'VoiceConnector': {
        'VoiceConnectorId': 'string',
        'AwsRegion': 'us-east-1'|'us-west-2',
        'Name': 'string',
        'OutboundHostName': 'string',
        'RequireEncryption': True|False,
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) --

    • VoiceConnector (dict) --

      The Amazon Chime Voice Connector details.

      • VoiceConnectorId (string) --

        The Amazon Chime Voice Connector ID.

      • AwsRegion (string) --

        The AWS Region in which the Amazon Chime Voice Connector is created. Default: us-east-1 .

      • Name (string) --

        The name of the Amazon Chime Voice Connector.

      • OutboundHostName (string) --

        The outbound host name for the Amazon Chime Voice Connector.

      • RequireEncryption (boolean) --

        Designates whether encryption is required for the Amazon Chime Voice Connector.

      • CreatedTimestamp (datetime) --

        The Amazon Chime Voice Connector creation timestamp, in ISO 8601 format.

      • UpdatedTimestamp (datetime) --

        The updated Amazon Chime Voice Connector timestamp, in ISO 8601 format.

Exceptions

  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.AccessDeniedException
  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ResourceLimitExceededException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
create_voice_connector_group(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.create_voice_connector_group(
    Name='string',
    VoiceConnectorItems=[
        {
            'VoiceConnectorId': 'string',
            'Priority': 123
        },
    ]
)
Parameters
  • Name (string) --

    [REQUIRED]

    The name of the Amazon Chime Voice Connector group.

  • VoiceConnectorItems (list) --

    The Amazon Chime Voice Connectors to route inbound calls to.

    • (dict) --

      For Amazon Chime Voice Connector groups, the Amazon Chime Voice Connectors to which to route inbound calls. Includes priority configuration settings. Limit: 3 VoiceConnectorItems per Amazon Chime Voice Connector group.

      • VoiceConnectorId (string) -- [REQUIRED]

        The Amazon Chime Voice Connector ID.

      • Priority (integer) -- [REQUIRED]

        The priority associated with the Amazon Chime Voice Connector, with 1 being the highest priority. Higher priority Amazon Chime Voice Connectors are attempted first.

Return type

dict

Returns

Response Syntax

{
    'VoiceConnectorGroup': {
        'VoiceConnectorGroupId': 'string',
        'Name': 'string',
        'VoiceConnectorItems': [
            {
                'VoiceConnectorId': 'string',
                'Priority': 123
            },
        ],
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) --

    • VoiceConnectorGroup (dict) --

      The Amazon Chime Voice Connector group details.

      • VoiceConnectorGroupId (string) --

        The Amazon Chime Voice Connector group ID.

      • Name (string) --

        The name of the Amazon Chime Voice Connector group.

      • VoiceConnectorItems (list) --

        The Amazon Chime Voice Connectors to which to route inbound calls.

        • (dict) --

          For Amazon Chime Voice Connector groups, the Amazon Chime Voice Connectors to which to route inbound calls. Includes priority configuration settings. Limit: 3 VoiceConnectorItems per Amazon Chime Voice Connector group.

          • VoiceConnectorId (string) --

            The Amazon Chime Voice Connector ID.

          • Priority (integer) --

            The priority associated with the Amazon Chime Voice Connector, with 1 being the highest priority. Higher priority Amazon Chime Voice Connectors are attempted first.

      • CreatedTimestamp (datetime) --

        The Amazon Chime Voice Connector group creation timestamp, in ISO 8601 format.

      • UpdatedTimestamp (datetime) --

        The updated Amazon Chime Voice Connector group timestamp, in ISO 8601 format.

Exceptions

  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.AccessDeniedException
  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ResourceLimitExceededException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
delete_account(**kwargs)

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

For EnterpriseLWA and EnterpriseAD accounts, you must release the claimed domains for your Amazon Chime account before deletion. As soon as you release the domain, all users under that account are suspended.

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

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

See also: AWS API Documentation

Request Syntax

response = client.delete_account(
    AccountId='string'
)
Parameters
AccountId (string) --

[REQUIRED]

The Amazon Chime account ID.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.UnprocessableEntityException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
delete_app_instance(**kwargs)

Deletes an AppInstance and all associated data asynchronously.

See also: AWS API Documentation

Request Syntax

response = client.delete_app_instance(
    AppInstanceArn='string'
)
Parameters
AppInstanceArn (string) --

[REQUIRED]

The ARN of the app instance.

Returns
None

Exceptions

  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
delete_app_instance_admin(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.delete_app_instance_admin(
    AppInstanceAdminArn='string',
    AppInstanceArn='string'
)
Parameters
  • AppInstanceAdminArn (string) --

    [REQUIRED]

    The ARN of the app instance's administrator.

  • AppInstanceArn (string) --

    [REQUIRED]

    The ARN of the app instance.

Returns

None

Exceptions

  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ConflictException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.ResourceLimitExceededException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
delete_app_instance_streaming_configurations(**kwargs)

Deletes the streaming configurations of an app instance.

See also: AWS API Documentation

Request Syntax

response = client.delete_app_instance_streaming_configurations(
    AppInstanceArn='string'
)
Parameters
AppInstanceArn (string) --

[REQUIRED]

The ARN of the streaming configurations being deleted.

Returns
None

Exceptions

  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
delete_app_instance_user(**kwargs)

Deletes an AppInstanceUser .

See also: AWS API Documentation

Request Syntax

response = client.delete_app_instance_user(
    AppInstanceUserArn='string'
)
Parameters
AppInstanceUserArn (string) --

[REQUIRED]

The ARN of the user request being deleted.

Returns
None

Exceptions

  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
delete_attendee(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.delete_attendee(
    MeetingId='string',
    AttendeeId='string'
)
Parameters
  • MeetingId (string) --

    [REQUIRED]

    The Amazon Chime SDK meeting ID.

  • AttendeeId (string) --

    [REQUIRED]

    The Amazon Chime SDK attendee ID.

Returns

None

Exceptions

  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
delete_channel(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.delete_channel(
    ChannelArn='string'
)
Parameters
ChannelArn (string) --

[REQUIRED]

The ARN of the channel being deleted.

Returns
None

Exceptions

  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
delete_channel_ban(**kwargs)

Removes a user from a channel's ban list.

See also: AWS API Documentation

Request Syntax

response = client.delete_channel_ban(
    ChannelArn='string',
    MemberArn='string'
)
Parameters
  • ChannelArn (string) --

    [REQUIRED]

    The ARN of the channel from which the app instance user was banned.

  • MemberArn (string) --

    [REQUIRED]

    The ARN of the app instance user that you want to reinstate.

Returns

None

Exceptions

  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
delete_channel_membership(**kwargs)

Removes a member from a channel.

See also: AWS API Documentation

Request Syntax

response = client.delete_channel_membership(
    ChannelArn='string',
    MemberArn='string'
)
Parameters
  • ChannelArn (string) --

    [REQUIRED]

    The ARN of the channel from which you want to remove the user.

  • MemberArn (string) --

    [REQUIRED]

    The ARN of the member that you're removing from the channel.

Returns

None

Exceptions

  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
delete_channel_message(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.delete_channel_message(
    ChannelArn='string',
    MessageId='string'
)
Parameters
  • ChannelArn (string) --

    [REQUIRED]

    The ARN of the channel.

  • MessageId (string) --

    [REQUIRED]

    The ID of the message being deleted.

Returns

None

Exceptions

  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
delete_channel_moderator(**kwargs)

Deletes a channel moderator.

See also: AWS API Documentation

Request Syntax

response = client.delete_channel_moderator(
    ChannelArn='string',
    ChannelModeratorArn='string'
)
Parameters
  • ChannelArn (string) --

    [REQUIRED]

    The ARN of the channel.

  • ChannelModeratorArn (string) --

    [REQUIRED]

    The ARN of the moderator being deleted.

Returns

None

Exceptions

  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
delete_events_configuration(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.delete_events_configuration(
    AccountId='string',
    BotId='string'
)
Parameters
  • AccountId (string) --

    [REQUIRED]

    The Amazon Chime account ID.

  • BotId (string) --

    [REQUIRED]

    The bot ID.

Returns

None

Exceptions

  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ResourceLimitExceededException
delete_meeting(**kwargs)

Deletes the specified Amazon Chime SDK meeting. When a meeting is deleted, its attendees are also deleted and clients can no longer join it. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide .

See also: AWS API Documentation

Request Syntax

response = client.delete_meeting(
    MeetingId='string'
)
Parameters
MeetingId (string) --

[REQUIRED]

The Amazon Chime SDK meeting ID.

Returns
None

Exceptions

  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
delete_phone_number(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.delete_phone_number(
    PhoneNumberId='string'
)
Parameters
PhoneNumberId (string) --

[REQUIRED]

The phone number ID.

Returns
None

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
delete_proxy_session(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.delete_proxy_session(
    VoiceConnectorId='string',
    ProxySessionId='string'
)
Parameters
  • VoiceConnectorId (string) --

    [REQUIRED]

    The Amazon Chime voice connector ID.

  • ProxySessionId (string) --

    [REQUIRED]

    The proxy session ID.

Returns

None

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
delete_room(**kwargs)

Deletes a chat room in an Amazon Chime Enterprise account.

See also: AWS API Documentation

Request Syntax

response = client.delete_room(
    AccountId='string',
    RoomId='string'
)
Parameters
  • AccountId (string) --

    [REQUIRED]

    The Amazon Chime account ID.

  • RoomId (string) --

    [REQUIRED]

    The chat room ID.

Returns

None

Exceptions

  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
delete_room_membership(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.delete_room_membership(
    AccountId='string',
    RoomId='string',
    MemberId='string'
)
Parameters
  • AccountId (string) --

    [REQUIRED]

    The Amazon Chime account ID.

  • RoomId (string) --

    [REQUIRED]

    The room ID.

  • MemberId (string) --

    [REQUIRED]

    The member ID (user ID or bot ID).

Returns

None

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
delete_sip_media_application(**kwargs)

Deletes a SIP media application.

See also: AWS API Documentation

Request Syntax

response = client.delete_sip_media_application(
    SipMediaApplicationId='string'
)
Parameters
SipMediaApplicationId (string) --

[REQUIRED]

The SIP media application ID.

Returns
None

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ConflictException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
delete_sip_rule(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.delete_sip_rule(
    SipRuleId='string'
)
Parameters
SipRuleId (string) --

[REQUIRED]

The SIP rule ID.

Returns
None

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ConflictException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
delete_voice_connector(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.delete_voice_connector(
    VoiceConnectorId='string'
)
Parameters
VoiceConnectorId (string) --

[REQUIRED]

The Amazon Chime Voice Connector ID.

Returns
None

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ConflictException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
delete_voice_connector_emergency_calling_configuration(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.delete_voice_connector_emergency_calling_configuration(
    VoiceConnectorId='string'
)
Parameters
VoiceConnectorId (string) --

[REQUIRED]

The Amazon Chime Voice Connector ID.

Returns
None

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
delete_voice_connector_group(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.delete_voice_connector_group(
    VoiceConnectorGroupId='string'
)
Parameters
VoiceConnectorGroupId (string) --

[REQUIRED]

The Amazon Chime Voice Connector group ID.

Returns
None

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ConflictException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
delete_voice_connector_origination(**kwargs)

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

Note

If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to deleting the origination settings.

See also: AWS API Documentation

Request Syntax

response = client.delete_voice_connector_origination(
    VoiceConnectorId='string'
)
Parameters
VoiceConnectorId (string) --

[REQUIRED]

The Amazon Chime Voice Connector ID.

Returns
None

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
delete_voice_connector_proxy(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.delete_voice_connector_proxy(
    VoiceConnectorId='string'
)
Parameters
VoiceConnectorId (string) --

[REQUIRED]

The Amazon Chime Voice Connector ID.

Returns
None

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
delete_voice_connector_streaming_configuration(**kwargs)

Deletes the streaming configuration for the specified Amazon Chime Voice Connector.

See also: AWS API Documentation

Request Syntax

response = client.delete_voice_connector_streaming_configuration(
    VoiceConnectorId='string'
)
Parameters
VoiceConnectorId (string) --

[REQUIRED]

The Amazon Chime Voice Connector ID.

Returns
None

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
delete_voice_connector_termination(**kwargs)

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

Note

If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to deleting the termination settings.

See also: AWS API Documentation

Request Syntax

response = client.delete_voice_connector_termination(
    VoiceConnectorId='string'
)
Parameters
VoiceConnectorId (string) --

[REQUIRED]

The Amazon Chime Voice Connector ID.

Returns
None

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
delete_voice_connector_termination_credentials(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.delete_voice_connector_termination_credentials(
    VoiceConnectorId='string',
    Usernames=[
        'string',
    ]
)
Parameters
  • VoiceConnectorId (string) --

    [REQUIRED]

    The Amazon Chime Voice Connector ID.

  • Usernames (list) --

    [REQUIRED]

    The RFC2617 compliant username associated with the SIP credentials, in US-ASCII format.

    • (string) --
Returns

None

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
describe_app_instance(**kwargs)

Returns the full details of an AppInstance .

See also: AWS API Documentation

Request Syntax

response = client.describe_app_instance(
    AppInstanceArn='string'
)
Parameters
AppInstanceArn (string) --

[REQUIRED]

The ARN of the app instance.

Return type
dict
Returns
Response Syntax
{
    'AppInstance': {
        'AppInstanceArn': 'string',
        'Name': 'string',
        'Metadata': 'string',
        'CreatedTimestamp': datetime(2015, 1, 1),
        'LastUpdatedTimestamp': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) --
    • AppInstance (dict) --

      The ARN, metadata, created and last-updated timestamps, and the name of the app instance. All timestamps use epoch milliseconds.

      • AppInstanceArn (string) --

        The ARN of the messaging instance.

      • Name (string) --

        The name of an app instance.

      • Metadata (string) --

        The metadata of an app instance.

      • CreatedTimestamp (datetime) --

        The time at which an app instance was created. In epoch milliseconds.

      • LastUpdatedTimestamp (datetime) --

        The time an app instance was last updated. In epoch milliseconds.

Exceptions

  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
describe_app_instance_admin(**kwargs)

Returns the full details of an AppInstanceAdmin .

See also: AWS API Documentation

Request Syntax

response = client.describe_app_instance_admin(
    AppInstanceAdminArn='string',
    AppInstanceArn='string'
)
Parameters
  • AppInstanceAdminArn (string) --

    [REQUIRED]

    The ARN of the app instance administrator.

  • AppInstanceArn (string) --

    [REQUIRED]

    The ARN of the app instance.

Return type

dict

Returns

Response Syntax

{
    'AppInstanceAdmin': {
        'Admin': {
            'Arn': 'string',
            'Name': 'string'
        },
        'AppInstanceArn': 'string',
        'CreatedTimestamp': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) --

    • AppInstanceAdmin (dict) --

      The ARN and name of the app instance user, the ARN of the app instance, and the created and last-updated timestamps. All timestamps use epoch milliseconds.

      • Admin (dict) --

        The name and metadata of the app instance administrator.

        • Arn (string) --

          The ARN in an Identity.

        • Name (string) --

          The name in an Identity.

      • AppInstanceArn (string) --

        The ARN of the app instance administrator.

      • CreatedTimestamp (datetime) --

        The time at which an administrator was created.

Exceptions

  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
describe_app_instance_user(**kwargs)

Returns the full details of an AppInstanceUser .

See also: AWS API Documentation

Request Syntax

response = client.describe_app_instance_user(
    AppInstanceUserArn='string'
)
Parameters
AppInstanceUserArn (string) --

[REQUIRED]

The ARN of the app instance user.

Return type
dict
Returns
Response Syntax
{
    'AppInstanceUser': {
        'AppInstanceUserArn': 'string',
        'Name': 'string',
        'CreatedTimestamp': datetime(2015, 1, 1),
        'Metadata': 'string',
        'LastUpdatedTimestamp': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) --
    • AppInstanceUser (dict) --

      The name of the app instance user.

      • AppInstanceUserArn (string) --

        The ARN of the app instance user.

      • Name (string) --

        The name of the app instance user.

      • CreatedTimestamp (datetime) --

        The time at which the app instance user was created.

      • Metadata (string) --

        The metadata of the app instance user.

      • LastUpdatedTimestamp (datetime) --

        The time at which the app instance user was last updated.

Exceptions

  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
describe_channel(**kwargs)

Returns the full details of a channel in an Amazon Chime app instance.

See also: AWS API Documentation

Request Syntax

response = client.describe_channel(
    ChannelArn='string'
)
Parameters
ChannelArn (string) --

[REQUIRED]

The ARN of the channel.

Return type
dict
Returns
Response Syntax
{
    'Channel': {
        'Name': 'string',
        'ChannelArn': 'string',
        'Mode': 'UNRESTRICTED'|'RESTRICTED',
        'Privacy': 'PUBLIC'|'PRIVATE',
        'Metadata': 'string',
        'CreatedBy': {
            'Arn': 'string',
            'Name': 'string'
        },
        'CreatedTimestamp': datetime(2015, 1, 1),
        'LastMessageTimestamp': datetime(2015, 1, 1),
        'LastUpdatedTimestamp': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) --
    • Channel (dict) --

      The channel details.

      • Name (string) --

        The name of the channel.

      • ChannelArn (string) --

        The ARN of the channel.

      • Mode (string) --

        The mode of the channel.

      • Privacy (string) --

        The channel's privacy setting, PUBLIC or HIDDEN .

      • Metadata (string) --

        The metadata of the channel.

      • CreatedBy (dict) --

        The administrator who created the channel.

        • Arn (string) --

          The ARN in an Identity.

        • Name (string) --

          The name in an Identity.

      • CreatedTimestamp (datetime) --

        The time at which the administrator created the channel.

      • LastMessageTimestamp (datetime) --

        The time at which a member sent the last message in a session.

      • LastUpdatedTimestamp (datetime) --

        The time at which a channel was last updated.

Exceptions

  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
describe_channel_ban(**kwargs)

Returns the full details of a channel ban.

See also: AWS API Documentation

Request Syntax

response = client.describe_channel_ban(
    ChannelArn='string',
    MemberArn='string'
)
Parameters
  • ChannelArn (string) --

    [REQUIRED]

    The ARN of the channel from which the user is banned.

  • MemberArn (string) --

    [REQUIRED]

    The ARN of the member being banned.

Return type

dict

Returns

Response Syntax

{
    'ChannelBan': {
        'Member': {
            'Arn': 'string',
            'Name': 'string'
        },
        'ChannelArn': 'string',
        'CreatedTimestamp': datetime(2015, 1, 1),
        'CreatedBy': {
            'Arn': 'string',
            'Name': 'string'
        }
    }
}

Response Structure

  • (dict) --

    • ChannelBan (dict) --

      The the details of the ban.

      • Member (dict) --

        The member being banned from the channel.

        • Arn (string) --

          The ARN in an Identity.

        • Name (string) --

          The name in an Identity.

      • ChannelArn (string) --

        The ARN of the channel from which a member is being banned.

      • CreatedTimestamp (datetime) --

        The time at which the ban was created.

      • CreatedBy (dict) --

        The parameter of the action.

        • Arn (string) --

          The ARN in an Identity.

        • Name (string) --

          The name in an Identity.

Exceptions

  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
describe_channel_membership(**kwargs)

Returns the full details of a user's channel membership.

See also: AWS API Documentation

Request Syntax

response = client.describe_channel_membership(
    ChannelArn='string',
    MemberArn='string'
)
Parameters
  • ChannelArn (string) --

    [REQUIRED]

    The ARN of the channel.

  • MemberArn (string) --

    [REQUIRED]

    The ARN of the member.

Return type

dict

Returns

Response Syntax

{
    'ChannelMembership': {
        'InvitedBy': {
            'Arn': 'string',
            'Name': 'string'
        },
        'Type': 'DEFAULT'|'HIDDEN',
        'Member': {
            'Arn': 'string',
            'Name': 'string'
        },
        'ChannelArn': 'string',
        'CreatedTimestamp': datetime(2015, 1, 1),
        'LastUpdatedTimestamp': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) --

    • ChannelMembership (dict) --

      The details of the membership.

      • InvitedBy (dict) --

        The identifier of the member who invited another member. Taken from the message header.

        • Arn (string) --

          The ARN in an Identity.

        • Name (string) --

          The name in an Identity.

      • Type (string) --

        The membership type set for the channel member.

      • Member (dict) --

        The data of the channel member.

        • Arn (string) --

          The ARN in an Identity.

        • Name (string) --

          The name in an Identity.

      • ChannelArn (string) --

        The ARN of the member's channel.

      • CreatedTimestamp (datetime) --

        The time at which the channel membership was created.

      • LastUpdatedTimestamp (datetime) --

        The time at which a channel membership was last updated.

Exceptions

  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
describe_channel_membership_for_app_instance_user(**kwargs)

Returns the details of a channel based on the membership of the AppInstanceUser specified.

See also: AWS API Documentation

Request Syntax

response = client.describe_channel_membership_for_app_instance_user(
    ChannelArn='string',
    AppInstanceUserArn='string'
)
Parameters
  • ChannelArn (string) --

    [REQUIRED]

    The ARN of the channel to which the user belongs.

  • AppInstanceUserArn (string) --

    [REQUIRED]

    The ARN of the user in a channel.

Return type

dict

Returns

Response Syntax

{
    'ChannelMembership': {
        'ChannelSummary': {
            'Name': 'string',
            'ChannelArn': 'string',
            'Mode': 'UNRESTRICTED'|'RESTRICTED',
            'Privacy': 'PUBLIC'|'PRIVATE',
            'Metadata': 'string',
            'LastMessageTimestamp': datetime(2015, 1, 1)
        },
        'AppInstanceUserMembershipSummary': {
            'Type': 'DEFAULT'|'HIDDEN',
            'ReadMarkerTimestamp': datetime(2015, 1, 1)
        }
    }
}

Response Structure

  • (dict) --

    • ChannelMembership (dict) --

      The channel to which a user belongs.

      • ChannelSummary (dict) --

        The summary data for a channel.

        • Name (string) --

          The parameter of the action.

        • ChannelArn (string) --

          The ARN of the channel summary.

        • Mode (string) --

          The summary mode of the channel.

        • Privacy (string) --

          The privacy setting of the channel being summarized, PUBLIC or HIDDEN .

        • Metadata (string) --

          The metadata of the channel summary.

        • LastMessageTimestamp (datetime) --

          The time at which the last message in a channel was sent.

      • AppInstanceUserMembershipSummary (dict) --

        Returns the channel membership data for an app instance.

        • Type (string) --

          The type of channel summary,

        • ReadMarkerTimestamp (datetime) --

          The time at which a summary was last read.

Exceptions

  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
describe_channel_moderated_by_app_instance_user(**kwargs)

Returns the full details of a channel moderated by the specified AppInstanceUser .

See also: AWS API Documentation

Request Syntax

response = client.describe_channel_moderated_by_app_instance_user(
    ChannelArn='string',
    AppInstanceUserArn='string'
)
Parameters
  • ChannelArn (string) --

    [REQUIRED]

    The ARN of the moderated channel.

  • AppInstanceUserArn (string) --

    [REQUIRED]

    The ARN of the app instance user in the moderated channel.

Return type

dict

Returns

Response Syntax

{
    'Channel': {
        'ChannelSummary': {
            'Name': 'string',
            'ChannelArn': 'string',
            'Mode': 'UNRESTRICTED'|'RESTRICTED',
            'Privacy': 'PUBLIC'|'PRIVATE',
            'Metadata': 'string',
            'LastMessageTimestamp': datetime(2015, 1, 1)
        }
    }
}

Response Structure

  • (dict) --

    • Channel (dict) --

      The moderated channel.

      • ChannelSummary (dict) --

        The summary data for a channel.

        • Name (string) --

          The parameter of the action.

        • ChannelArn (string) --

          The ARN of the channel summary.

        • Mode (string) --

          The summary mode of the channel.

        • Privacy (string) --

          The privacy setting of the channel being summarized, PUBLIC or HIDDEN .

        • Metadata (string) --

          The metadata of the channel summary.

        • LastMessageTimestamp (datetime) --

          The time at which the last message in a channel was sent.

Exceptions

  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
describe_channel_moderator(**kwargs)

Returns the full details of a single ChannelModerator.

See also: AWS API Documentation

Request Syntax

response = client.describe_channel_moderator(
    ChannelArn='string',
    ChannelModeratorArn='string'
)
Parameters
  • ChannelArn (string) --

    [REQUIRED]

    The ARN of the channel.

  • ChannelModeratorArn (string) --

    [REQUIRED]

    The ARN of the channel moderator.

Return type

dict

Returns

Response Syntax

{
    'ChannelModerator': {
        'Moderator': {
            'Arn': 'string',
            'Name': 'string'
        },
        'ChannelArn': 'string',
        'CreatedTimestamp': datetime(2015, 1, 1),
        'CreatedBy': {
            'Arn': 'string',
            'Name': 'string'
        }
    }
}

Response Structure

  • (dict) --

    • ChannelModerator (dict) --

      The details of the channel moderator.

      • Moderator (dict) --

        The moderator's data.

        • Arn (string) --

          The ARN in an Identity.

        • Name (string) --

          The name in an Identity.

      • ChannelArn (string) --

        The ARN of the moderator's channel.

      • CreatedTimestamp (datetime) --

        The time at which the moderator was created.

      • CreatedBy (dict) --

        The member who created the moderator.

        • Arn (string) --

          The ARN in an Identity.

        • Name (string) --

          The name in an Identity.

Exceptions

  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
disassociate_phone_number_from_user(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.disassociate_phone_number_from_user(
    AccountId='string',
    UserId='string'
)
Parameters
  • AccountId (string) --

    [REQUIRED]

    The Amazon Chime account ID.

  • UserId (string) --

    [REQUIRED]

    The user ID.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
disassociate_phone_numbers_from_voice_connector(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.disassociate_phone_numbers_from_voice_connector(
    VoiceConnectorId='string',
    E164PhoneNumbers=[
        'string',
    ]
)
Parameters
  • VoiceConnectorId (string) --

    [REQUIRED]

    The Amazon Chime Voice Connector ID.

  • E164PhoneNumbers (list) --

    [REQUIRED]

    List of phone numbers, in E.164 format.

    • (string) --
Return type

dict

Returns

Response Syntax

{
    'PhoneNumberErrors': [
        {
            'PhoneNumberId': 'string',
            'ErrorCode': 'BadRequest'|'Conflict'|'Forbidden'|'NotFound'|'PreconditionFailed'|'ResourceLimitExceeded'|'ServiceFailure'|'AccessDenied'|'ServiceUnavailable'|'Throttled'|'Throttling'|'Unauthorized'|'Unprocessable'|'VoiceConnectorGroupAssociationsExist'|'PhoneNumberAssociationsExist',
            'ErrorMessage': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • PhoneNumberErrors (list) --

      If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.

      • (dict) --

        If the phone number action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.

        • PhoneNumberId (string) --

          The phone number ID for which the action failed.

        • ErrorCode (string) --

          The error code.

        • ErrorMessage (string) --

          The error message.

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
disassociate_phone_numbers_from_voice_connector_group(**kwargs)

Disassociates the specified phone numbers from the specified Amazon Chime Voice Connector group.

See also: AWS API Documentation

Request Syntax

response = client.disassociate_phone_numbers_from_voice_connector_group(
    VoiceConnectorGroupId='string',
    E164PhoneNumbers=[
        'string',
    ]
)
Parameters
  • VoiceConnectorGroupId (string) --

    [REQUIRED]

    The Amazon Chime Voice Connector group ID.

  • E164PhoneNumbers (list) --

    [REQUIRED]

    List of phone numbers, in E.164 format.

    • (string) --
Return type

dict

Returns

Response Syntax

{
    'PhoneNumberErrors': [
        {
            'PhoneNumberId': 'string',
            'ErrorCode': 'BadRequest'|'Conflict'|'Forbidden'|'NotFound'|'PreconditionFailed'|'ResourceLimitExceeded'|'ServiceFailure'|'AccessDenied'|'ServiceUnavailable'|'Throttled'|'Throttling'|'Unauthorized'|'Unprocessable'|'VoiceConnectorGroupAssociationsExist'|'PhoneNumberAssociationsExist',
            'ErrorMessage': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • PhoneNumberErrors (list) --

      If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.

      • (dict) --

        If the phone number action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.

        • PhoneNumberId (string) --

          The phone number ID for which the action failed.

        • ErrorCode (string) --

          The error code.

        • ErrorMessage (string) --

          The error message.

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
disassociate_signin_delegate_groups_from_account(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.disassociate_signin_delegate_groups_from_account(
    AccountId='string',
    GroupNames=[
        'string',
    ]
)
Parameters
  • AccountId (string) --

    [REQUIRED]

    The Amazon Chime account ID.

  • GroupNames (list) --

    [REQUIRED]

    The sign-in delegate group names.

    • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)

Generate a presigned url given a client, its method, and arguments

Parameters
  • ClientMethod (string) -- The client method to presign for
  • Params (dict) -- The parameters normally passed to ClientMethod.
  • ExpiresIn (int) -- The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
  • HttpMethod (string) -- The http method to use on the generated url. By default, the http method is whatever is used in the method's model.
Returns

The presigned url

get_account(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.get_account(
    AccountId='string'
)
Parameters
AccountId (string) --

[REQUIRED]

The Amazon Chime account ID.

Return type
dict
Returns
Response Syntax
{
    'Account': {
        'AwsAccountId': 'string',
        'AccountId': 'string',
        'Name': 'string',
        'AccountType': 'Team'|'EnterpriseDirectory'|'EnterpriseLWA'|'EnterpriseOIDC',
        'CreatedTimestamp': datetime(2015, 1, 1),
        'DefaultLicense': 'Basic'|'Plus'|'Pro'|'ProTrial',
        'SupportedLicenses': [
            'Basic'|'Plus'|'Pro'|'ProTrial',
        ],
        'SigninDelegateGroups': [
            {
                'GroupName': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) --
    • Account (dict) --

      The Amazon Chime account details. An AWS account can have multiple Amazon Chime accounts.

      • AwsAccountId (string) --

        The AWS account ID.

      • AccountId (string) --

        The Amazon Chime account ID.

      • Name (string) --

        The Amazon Chime account name.

      • AccountType (string) --

        The Amazon Chime account type. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide .

      • CreatedTimestamp (datetime) --

        The Amazon Chime account creation timestamp, in ISO 8601 format.

      • DefaultLicense (string) --

        The default license for the Amazon Chime account.

      • SupportedLicenses (list) --

        Supported licenses for the Amazon Chime account.

        • (string) --
      • SigninDelegateGroups (list) --

        The sign-in delegate groups associated with the account.

        • (dict) --

          An Active Directory (AD) group whose members are granted permission to act as delegates.

          • GroupName (string) --

            The group name.

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
get_account_settings(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.get_account_settings(
    AccountId='string'
)
Parameters
AccountId (string) --

[REQUIRED]

The Amazon Chime account ID.

Return type
dict
Returns
Response Syntax
{
    'AccountSettings': {
        'DisableRemoteControl': True|False,
        'EnableDialOut': True|False
    }
}

Response Structure

  • (dict) --
    • AccountSettings (dict) --

      The Amazon Chime account settings.

      • DisableRemoteControl (boolean) --

        Setting that stops or starts remote control of shared screens during meetings.

      • EnableDialOut (boolean) --

        Setting that allows meeting participants to choose the Call me at a phone number option. For more information, see Join a Meeting without the Amazon Chime App .

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
get_app_instance_retention_settings(**kwargs)

Gets the retention settings for an app instance.

See also: AWS API Documentation

Request Syntax

response = client.get_app_instance_retention_settings(
    AppInstanceArn='string'
)
Parameters
AppInstanceArn (string) --

[REQUIRED]

The ARN of the app instance.

Return type
dict
Returns
Response Syntax
{
    'AppInstanceRetentionSettings': {
        'ChannelRetentionSettings': {
            'RetentionDays': 123
        }
    },
    'InitiateDeletionTimestamp': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --
    • AppInstanceRetentionSettings (dict) --

      The retention settings for the app instance.

      • ChannelRetentionSettings (dict) --

        The length of time in days to retain a channel.

        • RetentionDays (integer) --

          The time in days to retain a channel.

    • InitiateDeletionTimestamp (datetime) --

      The timestamp representing the time at which the specified items are retained, in Epoch Seconds.

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
get_app_instance_streaming_configurations(**kwargs)

Gets the streaming settings for an app instance.

See also: AWS API Documentation

Request Syntax

response = client.get_app_instance_streaming_configurations(
    AppInstanceArn='string'
)
Parameters
AppInstanceArn (string) --

[REQUIRED]

The ARN of the app instance.

Return type
dict
Returns
Response Syntax
{
    'AppInstanceStreamingConfigurations': [
        {
            'AppInstanceDataType': 'Channel'|'ChannelMessage',
            'ResourceArn': 'string'
        },
    ]
}

Response Structure

  • (dict) --
    • AppInstanceStreamingConfigurations (list) --

      The streaming settings.

      • (dict) --

        The streaming configuration of an app instance.

        • AppInstanceDataType (string) --

          The data type of the app instance.

        • ResourceArn (string) --

          The resource ARN.

Exceptions

  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
get_attendee(**kwargs)

Gets the Amazon Chime SDK attendee details for a specified meeting ID and attendee ID. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide .

See also: AWS API Documentation

Request Syntax

response = client.get_attendee(
    MeetingId='string',
    AttendeeId='string'
)
Parameters
  • MeetingId (string) --

    [REQUIRED]

    The Amazon Chime SDK meeting ID.

  • AttendeeId (string) --

    [REQUIRED]

    The Amazon Chime SDK attendee ID.

Return type

dict

Returns

Response Syntax

{
    'Attendee': {
        'ExternalUserId': 'string',
        'AttendeeId': 'string',
        'JoinToken': 'string'
    }
}

Response Structure

  • (dict) --

    • Attendee (dict) --

      The Amazon Chime SDK attendee information.

      • ExternalUserId (string) --

        The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application. If you create an attendee with the same external user id, the service returns the existing record.

      • AttendeeId (string) --

        The Amazon Chime SDK attendee ID.

      • JoinToken (string) --

        The join token used by the Amazon Chime SDK attendee.

Exceptions

  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
get_bot(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.get_bot(
    AccountId='string',
    BotId='string'
)
Parameters
  • AccountId (string) --

    [REQUIRED]

    The Amazon Chime account ID.

  • BotId (string) --

    [REQUIRED]

    The bot ID.

Return type

dict

Returns

Response Syntax

{
    'Bot': {
        'BotId': 'string',
        'UserId': 'string',
        'DisplayName': 'string',
        'BotType': 'ChatBot',
        'Disabled': True|False,
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1),
        'BotEmail': 'string',
        'SecurityToken': 'string'
    }
}

Response Structure

  • (dict) --

    • Bot (dict) --

      The chat bot details.

      • BotId (string) --

        The bot ID.

      • UserId (string) --

        The unique ID for the bot user.

      • DisplayName (string) --

        The bot display name.

      • BotType (string) --

        The bot type.

      • Disabled (boolean) --

        When true, the bot is stopped from running in your account.

      • CreatedTimestamp (datetime) --

        The bot creation timestamp, in ISO 8601 format.

      • UpdatedTimestamp (datetime) --

        The updated bot timestamp, in ISO 8601 format.

      • BotEmail (string) --

        The bot email address.

      • SecurityToken (string) --

        The security token used to authenticate Amazon Chime with the outgoing event endpoint.

Exceptions

  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ThrottledClientException
get_channel_message(**kwargs)

Gets the full details of a channel message.

See also: AWS API Documentation

Request Syntax

response = client.get_channel_message(
    ChannelArn='string',
    MessageId='string'
)
Parameters
  • ChannelArn (string) --

    [REQUIRED]

    The ARN of the channel.

  • MessageId (string) --

    [REQUIRED]

    The ID of the message.

Return type

dict

Returns

Response Syntax

{
    'ChannelMessage': {
        'ChannelArn': 'string',
        'MessageId': 'string',
        'Content': 'string',
        'Metadata': 'string',
        'Type': 'STANDARD'|'CONTROL',
        'CreatedTimestamp': datetime(2015, 1, 1),
        'LastEditedTimestamp': datetime(2015, 1, 1),
        'LastUpdatedTimestamp': datetime(2015, 1, 1),
        'Sender': {
            'Arn': 'string',
            'Name': 'string'
        },
        'Redacted': True|False,
        'Persistence': 'PERSISTENT'|'NON_PERSISTENT'
    }
}

Response Structure

  • (dict) --

    • ChannelMessage (dict) --

      The details of and content in the message.

      • ChannelArn (string) --

        The ARN of the channel.

      • MessageId (string) --

        The ID of a message.

      • Content (string) --

        The message content.

      • Metadata (string) --

        The message metadata.

      • Type (string) --

        The message type.

      • CreatedTimestamp (datetime) --

        The time at which the message was created.

      • LastEditedTimestamp (datetime) --

        The time at which a message was edited.

      • LastUpdatedTimestamp (datetime) --

        The time at which a message was updated.

      • Sender (dict) --

        The message sender.

        • Arn (string) --

          The ARN in an Identity.

        • Name (string) --

          The name in an Identity.

      • Redacted (boolean) --

        Hides the content of a message. The message still exists on the back end, but this action only returns metadata.

      • Persistence (string) --

Exceptions

  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
get_events_configuration(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.get_events_configuration(
    AccountId='string',
    BotId='string'
)
Parameters
  • AccountId (string) --

    [REQUIRED]

    The Amazon Chime account ID.

  • BotId (string) --

    [REQUIRED]

    The bot ID.

Return type

dict

Returns

Response Syntax

{
    'EventsConfiguration': {
        'BotId': 'string',
        'OutboundEventsHTTPSEndpoint': 'string',
        'LambdaFunctionArn': 'string'
    }
}

Response Structure

  • (dict) --

    • EventsConfiguration (dict) --

      The events configuration details.

      • BotId (string) --

        The bot ID.

      • OutboundEventsHTTPSEndpoint (string) --

        HTTPS endpoint that allows a bot to receive outgoing events.

      • LambdaFunctionArn (string) --

        Lambda function ARN that allows a bot to receive outgoing events.

Exceptions

  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ResourceLimitExceededException
  • Chime.Client.exceptions.NotFoundException
get_global_settings()

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

See also: AWS API Documentation

Request Syntax

response = client.get_global_settings()
Return type
dict
Returns
Response Syntax
{
    'BusinessCalling': {
        'CdrBucket': 'string'
    },
    'VoiceConnector': {
        'CdrBucket': 'string'
    }
}

Response Structure

  • (dict) --
    • BusinessCalling (dict) --

      The Amazon Chime Business Calling settings.

      • CdrBucket (string) --

        The Amazon S3 bucket designated for call detail record storage.

    • VoiceConnector (dict) --

      The Amazon Chime Voice Connector settings.

      • CdrBucket (string) --

        The Amazon S3 bucket designated for call detail record storage.

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
get_meeting(**kwargs)

Gets the Amazon Chime SDK meeting details for the specified meeting ID. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide .

See also: AWS API Documentation

Request Syntax

response = client.get_meeting(
    MeetingId='string'
)
Parameters
MeetingId (string) --

[REQUIRED]

The Amazon Chime SDK meeting ID.

Return type
dict
Returns
Response Syntax
{
    'Meeting': {
        'MeetingId': 'string',
        'ExternalMeetingId': 'string',
        'MediaPlacement': {
            'AudioHostUrl': 'string',
            'AudioFallbackUrl': 'string',
            'ScreenDataUrl': 'string',
            'ScreenSharingUrl': 'string',
            'ScreenViewingUrl': 'string',
            'SignalingUrl': 'string',
            'TurnControlUrl': 'string'
        },
        'MediaRegion': 'string'
    }
}

Response Structure

  • (dict) --
    • Meeting (dict) --

      The Amazon Chime SDK meeting information.

      • MeetingId (string) --

        The Amazon Chime SDK meeting ID.

      • ExternalMeetingId (string) --

        The external meeting ID.

      • MediaPlacement (dict) --

        The media placement for the meeting.

        • AudioHostUrl (string) --

          The audio host URL.

        • AudioFallbackUrl (string) --

          The audio fallback URL.

        • ScreenDataUrl (string) --

          The screen data URL.

        • ScreenSharingUrl (string) --

          The screen sharing URL.

        • ScreenViewingUrl (string) --

          The screen viewing URL.

        • SignalingUrl (string) --

          The signaling URL.

        • TurnControlUrl (string) --

          The turn control URL.

      • MediaRegion (string) --

        The Region in which to create the meeting. Available values: af-south-1 , ap-northeast-1 , ap-northeast-2 , ap-south-1 , ap-southeast-1 , ap-southeast-2 , ca-central-1 , eu-central-1 , eu-north-1 , eu-south-1 , eu-west-1 , eu-west-2 , eu-west-3 , sa-east-1 , us-east-1 , us-east-2 , us-west-1 , us-west-2 .

Exceptions

  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
get_messaging_session_endpoint()

The endpoint for the messaging session.

See also: AWS API Documentation

Request Syntax

response = client.get_messaging_session_endpoint()
Return type
dict
Returns
Response Syntax
{
    'Endpoint': {
        'Url': 'string'
    }
}

Response Structure

  • (dict) --
    • Endpoint (dict) --

      The endpoint returned in the response.

      • Url (string) --

        The URL of a meeting session endpoint.

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_phone_number(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.get_phone_number(
    PhoneNumberId='string'
)
Parameters
PhoneNumberId (string) --

[REQUIRED]

The phone number ID.

Return type
dict
Returns
Response Syntax
{
    'PhoneNumber': {
        'PhoneNumberId': 'string',
        'E164PhoneNumber': 'string',
        'Type': 'Local'|'TollFree',
        'ProductType': 'BusinessCalling'|'VoiceConnector',
        'Status': 'AcquireInProgress'|'AcquireFailed'|'Unassigned'|'Assigned'|'ReleaseInProgress'|'DeleteInProgress'|'ReleaseFailed'|'DeleteFailed',
        'Capabilities': {
            'InboundCall': True|False,
            'OutboundCall': True|False,
            'InboundSMS': True|False,
            'OutboundSMS': True|False,
            'InboundMMS': True|False,
            'OutboundMMS': True|False
        },
        'Associations': [
            {
                'Value': 'string',
                'Name': 'AccountId'|'UserId'|'VoiceConnectorId'|'VoiceConnectorGroupId'|'SipRuleId',
                'AssociatedTimestamp': datetime(2015, 1, 1)
            },
        ],
        'CallingName': 'string',
        'CallingNameStatus': 'Unassigned'|'UpdateInProgress'|'UpdateSucceeded'|'UpdateFailed',
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1),
        'DeletionTimestamp': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) --
    • PhoneNumber (dict) --

      The phone number details.

      • PhoneNumberId (string) --

        The phone number ID.

      • E164PhoneNumber (string) --

        The phone number, in E.164 format.

      • Type (string) --

        The phone number type.

      • ProductType (string) --

        The phone number product type.

      • Status (string) --

        The phone number status.

      • Capabilities (dict) --

        The phone number capabilities.

        • InboundCall (boolean) --

          Allows or denies inbound calling for the specified phone number.

        • OutboundCall (boolean) --

          Allows or denies outbound calling for the specified phone number.

        • InboundSMS (boolean) --

          Allows or denies inbound SMS messaging for the specified phone number.

        • OutboundSMS (boolean) --

          Allows or denies outbound SMS messaging for the specified phone number.

        • InboundMMS (boolean) --

          Allows or denies inbound MMS messaging for the specified phone number.

        • OutboundMMS (boolean) --

          Allows or denies outbound MMS messaging for the specified phone number.

      • Associations (list) --

        The phone number associations.

        • (dict) --

          The phone number associations, such as Amazon Chime account ID, Amazon Chime user ID, Amazon Chime Voice Connector ID, or Amazon Chime Voice Connector group ID.

          • Value (string) --

            Contains the ID for the entity specified in Name.

          • Name (string) --

            Defines the association with an Amazon Chime account ID, user ID, Amazon Chime Voice Connector ID, or Amazon Chime Voice Connector group ID.

          • AssociatedTimestamp (datetime) --

            The timestamp of the phone number association, in ISO 8601 format.

      • CallingName (string) --

        The outbound calling name associated with the phone number.

      • CallingNameStatus (string) --

        The outbound calling name status.

      • CreatedTimestamp (datetime) --

        The phone number creation timestamp, in ISO 8601 format.

      • UpdatedTimestamp (datetime) --

        The updated phone number timestamp, in ISO 8601 format.

      • DeletionTimestamp (datetime) --

        The deleted phone number timestamp, in ISO 8601 format.

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
get_phone_number_order(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.get_phone_number_order(
    PhoneNumberOrderId='string'
)
Parameters
PhoneNumberOrderId (string) --

[REQUIRED]

The ID for the phone number order.

Return type
dict
Returns
Response Syntax
{
    'PhoneNumberOrder': {
        'PhoneNumberOrderId': 'string',
        'ProductType': 'BusinessCalling'|'VoiceConnector',
        'Status': 'Processing'|'Successful'|'Failed'|'Partial',
        'OrderedPhoneNumbers': [
            {
                'E164PhoneNumber': 'string',
                'Status': 'Processing'|'Acquired'|'Failed'
            },
        ],
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) --
    • PhoneNumberOrder (dict) --

      The phone number order details.

      • PhoneNumberOrderId (string) --

        The phone number order ID.

      • ProductType (string) --

        The phone number order product type.

      • Status (string) --

        The status of the phone number order.

      • OrderedPhoneNumbers (list) --

        The ordered phone number details, such as the phone number in E.164 format and the phone number status.

        • (dict) --

          A phone number for which an order has been placed.

          • E164PhoneNumber (string) --

            The phone number, in E.164 format.

          • Status (string) --

            The phone number status.

      • CreatedTimestamp (datetime) --

        The phone number order creation timestamp, in ISO 8601 format.

      • UpdatedTimestamp (datetime) --

        The updated phone number order timestamp, in ISO 8601 format.

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
get_phone_number_settings()

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

See also: AWS API Documentation

Request Syntax

response = client.get_phone_number_settings()
Return type
dict
Returns
Response Syntax
{
    'CallingName': 'string',
    'CallingNameUpdatedTimestamp': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --
    • CallingName (string) --

      The default outbound calling name for the account.

    • CallingNameUpdatedTimestamp (datetime) --

      The updated outbound calling name timestamp, in ISO 8601 format.

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
get_proxy_session(**kwargs)

Gets the specified proxy session details for the specified Amazon Chime Voice Connector.

See also: AWS API Documentation

Request Syntax

response = client.get_proxy_session(
    VoiceConnectorId='string',
    ProxySessionId='string'
)
Parameters
  • VoiceConnectorId (string) --

    [REQUIRED]

    The Amazon Chime voice connector ID.

  • ProxySessionId (string) --

    [REQUIRED]

    The proxy session ID.

Return type

dict

Returns

Response Syntax

{
    'ProxySession': {
        'VoiceConnectorId': 'string',
        'ProxySessionId': 'string',
        'Name': 'string',
        'Status': 'Open'|'InProgress'|'Closed',
        'ExpiryMinutes': 123,
        'Capabilities': [
            'Voice'|'SMS',
        ],
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1),
        'EndedTimestamp': datetime(2015, 1, 1),
        'Participants': [
            {
                'PhoneNumber': 'string',
                'ProxyPhoneNumber': 'string'
            },
        ],
        'NumberSelectionBehavior': 'PreferSticky'|'AvoidSticky',
        'GeoMatchLevel': 'Country'|'AreaCode',
        'GeoMatchParams': {
            'Country': 'string',
            'AreaCode': 'string'
        }
    }
}

Response Structure

  • (dict) --

    • ProxySession (dict) --

      The proxy session details.

      • VoiceConnectorId (string) --

        The Amazon Chime voice connector ID.

      • ProxySessionId (string) --

        The proxy session ID.

      • Name (string) --

        The name of the proxy session.

      • Status (string) --

        The status of the proxy session.

      • ExpiryMinutes (integer) --

        The number of minutes allowed for the proxy session.

      • Capabilities (list) --

        The proxy session capabilities.

        • (string) --
      • CreatedTimestamp (datetime) --

        The created timestamp, in ISO 8601 format.

      • UpdatedTimestamp (datetime) --

        The updated timestamp, in ISO 8601 format.

      • EndedTimestamp (datetime) --

        The ended timestamp, in ISO 8601 format.

      • Participants (list) --

        The proxy session participants.

        • (dict) --

          The phone number and proxy phone number for a participant in an Amazon Chime Voice Connector proxy session.

          • PhoneNumber (string) --

            The participant's phone number.

          • ProxyPhoneNumber (string) --

            The participant's proxy phone number.

      • NumberSelectionBehavior (string) --

        The preference for proxy phone number reuse, or stickiness, between the same participants across sessions.

      • GeoMatchLevel (string) --

        The preference for matching the country or area code of the proxy phone number with that of the first participant.

      • GeoMatchParams (dict) --

        The country and area code for the proxy phone number.

        • Country (string) --

          The country.

        • AreaCode (string) --

          The area code.

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
get_retention_settings(**kwargs)

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 .

See also: AWS API Documentation

Request Syntax

response = client.get_retention_settings(
    AccountId='string'
)
Parameters
AccountId (string) --

[REQUIRED]

The Amazon Chime account ID.

Return type
dict
Returns
Response Syntax
{
    'RetentionSettings': {
        'RoomRetentionSettings': {
            'RetentionDays': 123
        },
        'ConversationRetentionSettings': {
            'RetentionDays': 123
        }
    },
    'InitiateDeletionTimestamp': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --
    • RetentionSettings (dict) --

      The retention settings.

      • RoomRetentionSettings (dict) --

        The chat room retention settings.

        • RetentionDays (integer) --

          The number of days for which to retain chat room messages.

      • ConversationRetentionSettings (dict) --

        The chat conversation retention settings.

        • RetentionDays (integer) --

          The number of days for which to retain chat conversation messages.

    • InitiateDeletionTimestamp (datetime) --

      The timestamp representing the time at which the specified items are permanently deleted, in ISO 8601 format.

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
get_room(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.get_room(
    AccountId='string',
    RoomId='string'
)
Parameters
  • AccountId (string) --

    [REQUIRED]

    The Amazon Chime account ID.

  • RoomId (string) --

    [REQUIRED]

    The room ID.

Return type

dict

Returns

Response Syntax

{
    'Room': {
        'RoomId': 'string',
        'Name': 'string',
        'AccountId': 'string',
        'CreatedBy': 'string',
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) --

    • Room (dict) --

      The room details.

      • RoomId (string) --

        The room ID.

      • Name (string) --

        The room name.

      • AccountId (string) --

        The Amazon Chime account ID.

      • CreatedBy (string) --

        The identifier of the room creator.

      • CreatedTimestamp (datetime) --

        The room creation timestamp, in ISO 8601 format.

      • UpdatedTimestamp (datetime) --

        The room update timestamp, in ISO 8601 format.

Exceptions

  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
get_sip_media_application(**kwargs)

Retrieves the information for a SIP media application, including name, AWS Region, and endpoints.

See also: AWS API Documentation

Request Syntax

response = client.get_sip_media_application(
    SipMediaApplicationId='string'
)
Parameters
SipMediaApplicationId (string) --

[REQUIRED]

The SIP media application ID.

Return type
dict
Returns
Response Syntax
{
    'SipMediaApplication': {
        'SipMediaApplicationId': 'string',
        'AwsRegion': 'string',
        'Name': 'string',
        'Endpoints': [
            {
                'LambdaArn': 'string'
            },
        ],
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) --
    • SipMediaApplication (dict) --

      The SIP media application details.

      • SipMediaApplicationId (string) --

        The SIP media application ID.

      • AwsRegion (string) --

        The AWS Region in which the SIP media application is created.

      • Name (string) --

        The name of the SIP media application.

      • Endpoints (list) --

        List of endpoints for SIP media application. Currently, only one endpoint per SIP media application is permitted.

        • (dict) --

          Endpoints to specify as part of a SIP media application.

          • LambdaArn (string) --

            Valid Amazon Resource Name (ARN) of the Lambda function of the same AWS Region where the SIP media application is created.

      • CreatedTimestamp (datetime) --

        The SIP media application creation timestamp, in ISO 8601 format.

      • UpdatedTimestamp (datetime) --

        The SIP media application updated timestamp, in ISO 8601 format.

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
get_sip_media_application_logging_configuration(**kwargs)

Returns the logging configuration for the specified SIP media application.

See also: AWS API Documentation

Request Syntax

response = client.get_sip_media_application_logging_configuration(
    SipMediaApplicationId='string'
)
Parameters
SipMediaApplicationId (string) --

[REQUIRED]

The ID of the SIP media application.

Return type
dict
Returns
Response Syntax
{
    'SipMediaApplicationLoggingConfiguration': {
        'EnableSipMediaApplicationMessageLogs': True|False
    }
}

Response Structure

  • (dict) --
    • SipMediaApplicationLoggingConfiguration (dict) --

      The actual logging configuration.

      • EnableSipMediaApplicationMessageLogs (boolean) --

        Enables application message logs for the SIP media application.

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
get_sip_rule(**kwargs)

Retrieves the details of a SIP rule, such as the rule ID, name, triggers, and target endpoints.

See also: AWS API Documentation

Request Syntax

response = client.get_sip_rule(
    SipRuleId='string'
)
Parameters
SipRuleId (string) --

[REQUIRED]

The SIP rule ID.

Return type
dict
Returns
Response Syntax
{
    'SipRule': {
        'SipRuleId': 'string',
        'Name': 'string',
        'Disabled': True|False,
        'TriggerType': 'ToPhoneNumber'|'RequestUriHostname',
        'TriggerValue': 'string',
        'TargetApplications': [
            {
                'SipMediaApplicationId': 'string',
                'Priority': 123,
                'AwsRegion': 'string'
            },
        ],
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) --
    • SipRule (dict) --

      The SIP rule details.

      • SipRuleId (string) --

        The SIP rule ID.

      • Name (string) --

        The name of the SIP rule.

      • Disabled (boolean) --

        Indicates if the SIP rule is enabled or disabled. You must disable a rule before you can delete it.

      • TriggerType (string) --

        The type of trigger whose value is assigned to the SIP rule in TriggerValue .

      • TriggerValue (string) --

        If TriggerType is RequestUriHostname , then the value can be the outbound host name of the Amazon Chime Voice Connector. If TriggerType is ToPhoneNumber , then the value can be a customer-owned phone number in E164 format. SipRule is triggered when a SIP rule requests host name or ToPhoneNumber matches in the incoming SIP request.

      • TargetApplications (list) --

        List of SIP media applications with priority and AWS Region. You can only use one SIP application per AWS Region and priority combination.

        • (dict) --

          Target SIP media application along with other details like priority and AWS Region to be specified in the SIP rule. Only one SIP rule per AWS Region can be provided.

          • SipMediaApplicationId (string) --

            The SIP media application ID.

          • Priority (integer) --

            Priority of the SIP media application in the target list.

          • AwsRegion (string) --

            AWS Region of target application.

      • CreatedTimestamp (datetime) --

        The SIP rule created timestamp, in ISO 8601 format.

      • UpdatedTimestamp (datetime) --

        The SIP rule updated timestamp, in ISO 8601 format.

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
get_user(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.get_user(
    AccountId='string',
    UserId='string'
)
Parameters
  • AccountId (string) --

    [REQUIRED]

    The Amazon Chime account ID.

  • UserId (string) --

    [REQUIRED]

    The user ID.

Return type

dict

Returns

Response Syntax

{
    'User': {
        'UserId': 'string',
        'AccountId': 'string',
        'PrimaryEmail': 'string',
        'PrimaryProvisionedNumber': 'string',
        'DisplayName': 'string',
        'LicenseType': 'Basic'|'Plus'|'Pro'|'ProTrial',
        'UserType': 'PrivateUser'|'SharedDevice',
        'UserRegistrationStatus': 'Unregistered'|'Registered'|'Suspended',
        'UserInvitationStatus': 'Pending'|'Accepted'|'Failed',
        'RegisteredOn': datetime(2015, 1, 1),
        'InvitedOn': datetime(2015, 1, 1),
        'AlexaForBusinessMetadata': {
            'IsAlexaForBusinessEnabled': True|False,
            'AlexaForBusinessRoomArn': 'string'
        },
        'PersonalPIN': 'string'
    }
}

Response Structure

  • (dict) --

    • User (dict) --

      The user details.

      • UserId (string) --

        The user ID.

      • AccountId (string) --

        The Amazon Chime account ID.

      • PrimaryEmail (string) --

        The primary email address of the user.

      • PrimaryProvisionedNumber (string) --

        The primary phone number associated with the user.

      • DisplayName (string) --

        The display name of the user.

      • LicenseType (string) --

        The license type for the user.

      • UserType (string) --

        The user type.

      • UserRegistrationStatus (string) --

        The user registration status.

      • UserInvitationStatus (string) --

        The user invite status.

      • RegisteredOn (datetime) --

        Date and time when the user is registered, in ISO 8601 format.

      • InvitedOn (datetime) --

        Date and time when the user is invited to the Amazon Chime account, in ISO 8601 format.

      • AlexaForBusinessMetadata (dict) --

        The Alexa for Business metadata.

        • IsAlexaForBusinessEnabled (boolean) --

          Starts or stops Alexa for Business.

        • AlexaForBusinessRoomArn (string) --

          The ARN of the room resource.

      • PersonalPIN (string) --

        The user's personal meeting PIN.

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
get_user_settings(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.get_user_settings(
    AccountId='string',
    UserId='string'
)
Parameters
  • AccountId (string) --

    [REQUIRED]

    The Amazon Chime account ID.

  • UserId (string) --

    [REQUIRED]

    The user ID.

Return type

dict

Returns

Response Syntax

{
    'UserSettings': {
        'Telephony': {
            'InboundCalling': True|False,
            'OutboundCalling': True|False,
            'SMS': True|False
        }
    }
}

Response Structure

  • (dict) --

    • UserSettings (dict) --

      The user settings.

      • Telephony (dict) --

        The telephony settings associated with the user.

        • InboundCalling (boolean) --

          Allows or denies inbound calling.

        • OutboundCalling (boolean) --

          Allows or denies outbound calling.

        • SMS (boolean) --

          Allows or denies SMS messaging.

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
get_voice_connector(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.get_voice_connector(
    VoiceConnectorId='string'
)
Parameters
VoiceConnectorId (string) --

[REQUIRED]

The Amazon Chime Voice Connector ID.

Return type
dict
Returns
Response Syntax
{
    'VoiceConnector': {
        'VoiceConnectorId': 'string',
        'AwsRegion': 'us-east-1'|'us-west-2',
        'Name': 'string',
        'OutboundHostName': 'string',
        'RequireEncryption': True|False,
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) --
    • VoiceConnector (dict) --

      The Amazon Chime Voice Connector details.

      • VoiceConnectorId (string) --

        The Amazon Chime Voice Connector ID.

      • AwsRegion (string) --

        The AWS Region in which the Amazon Chime Voice Connector is created. Default: us-east-1 .

      • Name (string) --

        The name of the Amazon Chime Voice Connector.

      • OutboundHostName (string) --

        The outbound host name for the Amazon Chime Voice Connector.

      • RequireEncryption (boolean) --

        Designates whether encryption is required for the Amazon Chime Voice Connector.

      • CreatedTimestamp (datetime) --

        The Amazon Chime Voice Connector creation timestamp, in ISO 8601 format.

      • UpdatedTimestamp (datetime) --

        The updated Amazon Chime Voice Connector timestamp, in ISO 8601 format.

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
get_voice_connector_emergency_calling_configuration(**kwargs)

Gets the emergency calling configuration details for the specified Amazon Chime Voice Connector.

See also: AWS API Documentation

Request Syntax

response = client.get_voice_connector_emergency_calling_configuration(
    VoiceConnectorId='string'
)
Parameters
VoiceConnectorId (string) --

[REQUIRED]

The Amazon Chime Voice Connector ID.

Return type
dict
Returns
Response Syntax
{
    'EmergencyCallingConfiguration': {
        'DNIS': [
            {
                'EmergencyPhoneNumber': 'string',
                'TestPhoneNumber': 'string',
                'CallingCountry': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) --
    • EmergencyCallingConfiguration (dict) --

      The emergency calling configuration details.

      • DNIS (list) --

        The Dialed Number Identification Service (DNIS) emergency calling configuration details.

        • (dict) --

          The Dialed Number Identification Service (DNIS) emergency calling configuration details associated with an Amazon Chime Voice Connector's emergency calling configuration.

          • EmergencyPhoneNumber (string) --

            The DNIS phone number to route emergency calls to, in E.164 format.

          • TestPhoneNumber (string) --

            The DNIS phone number to route test emergency calls to, in E.164 format.

          • CallingCountry (string) --

            The country from which emergency calls are allowed, in ISO 3166-1 alpha-2 format.

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
get_voice_connector_group(**kwargs)

Retrieves details for the specified Amazon Chime Voice Connector group, such as timestamps, name, and associated VoiceConnectorItems .

See also: AWS API Documentation

Request Syntax

response = client.get_voice_connector_group(
    VoiceConnectorGroupId='string'
)
Parameters
VoiceConnectorGroupId (string) --

[REQUIRED]

The Amazon Chime Voice Connector group ID.

Return type
dict
Returns
Response Syntax
{
    'VoiceConnectorGroup': {
        'VoiceConnectorGroupId': 'string',
        'Name': 'string',
        'VoiceConnectorItems': [
            {
                'VoiceConnectorId': 'string',
                'Priority': 123
            },
        ],
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) --
    • VoiceConnectorGroup (dict) --

      The Amazon Chime Voice Connector group details.

      • VoiceConnectorGroupId (string) --

        The Amazon Chime Voice Connector group ID.

      • Name (string) --

        The name of the Amazon Chime Voice Connector group.

      • VoiceConnectorItems (list) --

        The Amazon Chime Voice Connectors to which to route inbound calls.

        • (dict) --

          For Amazon Chime Voice Connector groups, the Amazon Chime Voice Connectors to which to route inbound calls. Includes priority configuration settings. Limit: 3 VoiceConnectorItems per Amazon Chime Voice Connector group.

          • VoiceConnectorId (string) --

            The Amazon Chime Voice Connector ID.

          • Priority (integer) --

            The priority associated with the Amazon Chime Voice Connector, with 1 being the highest priority. Higher priority Amazon Chime Voice Connectors are attempted first.

      • CreatedTimestamp (datetime) --

        The Amazon Chime Voice Connector group creation timestamp, in ISO 8601 format.

      • UpdatedTimestamp (datetime) --

        The updated Amazon Chime Voice Connector group timestamp, in ISO 8601 format.

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
get_voice_connector_logging_configuration(**kwargs)

Retrieves the logging configuration details for the specified Amazon Chime Voice Connector. Shows whether SIP message logs are enabled for sending to Amazon CloudWatch.

See also: AWS API Documentation

Request Syntax

response = client.get_voice_connector_logging_configuration(
    VoiceConnectorId='string'
)
Parameters
VoiceConnectorId (string) --

[REQUIRED]

The Amazon Chime Voice Connector ID.

Return type
dict
Returns
Response Syntax
{
    'LoggingConfiguration': {
        'EnableSIPLogs': True|False
    }
}

Response Structure

  • (dict) --
    • LoggingConfiguration (dict) --

      The logging configuration details.

      • EnableSIPLogs (boolean) --

        When true, enables SIP message logs for sending to Amazon CloudWatch Logs.

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
get_voice_connector_origination(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.get_voice_connector_origination(
    VoiceConnectorId='string'
)
Parameters
VoiceConnectorId (string) --

[REQUIRED]

The Amazon Chime Voice Connector ID.

Return type
dict
Returns
Response Syntax
{
    'Origination': {
        'Routes': [
            {
                'Host': 'string',
                'Port': 123,
                'Protocol': 'TCP'|'UDP',
                'Priority': 123,
                'Weight': 123
            },
        ],
        'Disabled': True|False
    }
}

Response Structure

  • (dict) --
    • Origination (dict) --

      The origination setting details.

      • Routes (list) --

        The call distribution properties defined for your SIP hosts. Valid range: Minimum value of 1. Maximum value of 20.

        • (dict) --

          Origination routes define call distribution properties for your SIP hosts to receive inbound calls using your Amazon Chime Voice Connector. Limit: Ten origination routes for each Amazon Chime Voice Connector.

          • Host (string) --

            The FQDN or IP address to contact for origination traffic.

          • Port (integer) --

            The designated origination route port. Defaults to 5060.

          • Protocol (string) --

            The protocol to use for the origination route. Encryption-enabled Amazon Chime Voice Connectors use TCP protocol by default.

          • Priority (integer) --

            The priority associated with the host, with 1 being the highest priority. Higher priority hosts are attempted first.

          • Weight (integer) --

            The weight associated with the host. If hosts are equal in priority, calls are distributed among them based on their relative weight.

      • Disabled (boolean) --

        When origination settings are disabled, inbound calls are not enabled for your Amazon Chime Voice Connector.

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
get_voice_connector_proxy(**kwargs)

Gets the proxy configuration details for the specified Amazon Chime Voice Connector.

See also: AWS API Documentation

Request Syntax

response = client.get_voice_connector_proxy(
    VoiceConnectorId='string'
)
Parameters
VoiceConnectorId (string) --

[REQUIRED]

The Amazon Chime voice connector ID.

Return type
dict
Returns
Response Syntax
{
    'Proxy': {
        'DefaultSessionExpiryMinutes': 123,
        'Disabled': True|False,
        'FallBackPhoneNumber': 'string',
        'PhoneNumberCountries': [
            'string',
        ]
    }
}

Response Structure

  • (dict) --
    • Proxy (dict) --

      The proxy configuration details.

      • DefaultSessionExpiryMinutes (integer) --

        The default number of minutes allowed for proxy sessions.

      • Disabled (boolean) --

        When true, stops proxy sessions from being created on the specified Amazon Chime Voice Connector.

      • FallBackPhoneNumber (string) --

        The phone number to route calls to after a proxy session expires.

      • PhoneNumberCountries (list) --

        The countries for proxy phone numbers to be selected from.

        • (string) --

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
get_voice_connector_streaming_configuration(**kwargs)

Retrieves the streaming configuration details for the specified Amazon Chime Voice Connector. Shows whether media streaming is enabled for sending to Amazon Kinesis. It also shows the retention period, in hours, for the Amazon Kinesis data.

See also: AWS API Documentation

Request Syntax

response = client.get_voice_connector_streaming_configuration(
    VoiceConnectorId='string'
)
Parameters
VoiceConnectorId (string) --

[REQUIRED]

The Amazon Chime Voice Connector ID.

Return type
dict
Returns
Response Syntax
{
    'StreamingConfiguration': {
        'DataRetentionInHours': 123,
        'Disabled': True|False,
        'StreamingNotificationTargets': [
            {
                'NotificationTarget': 'EventBridge'|'SNS'|'SQS'
            },
        ]
    }
}

Response Structure

  • (dict) --
    • StreamingConfiguration (dict) --

      The streaming configuration details.

      • DataRetentionInHours (integer) --

        The retention period, in hours, for the Amazon Kinesis data.

      • Disabled (boolean) --

        When true, media streaming to Amazon Kinesis is turned off.

      • StreamingNotificationTargets (list) --

        The streaming notification targets.

        • (dict) --

          The targeted recipient for a streaming configuration notification.

          • NotificationTarget (string) --

            The streaming notification target.

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
get_voice_connector_termination(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.get_voice_connector_termination(
    VoiceConnectorId='string'
)
Parameters
VoiceConnectorId (string) --

[REQUIRED]

The Amazon Chime Voice Connector ID.

Return type
dict
Returns
Response Syntax
{
    'Termination': {
        'CpsLimit': 123,
        'DefaultPhoneNumber': 'string',
        'CallingRegions': [
            'string',
        ],
        'CidrAllowedList': [
            'string',
        ],
        'Disabled': True|False
    }
}

Response Structure

  • (dict) --
    • Termination (dict) --

      The termination setting details.

      • CpsLimit (integer) --

        The limit on calls per second. Max value based on account service quota. Default value of 1.

      • DefaultPhoneNumber (string) --

        The default caller ID phone number.

      • CallingRegions (list) --

        The countries to which calls are allowed, in ISO 3166-1 alpha-2 format. Required.

        • (string) --
      • CidrAllowedList (list) --

        The IP addresses allowed to make calls, in CIDR format. Required.

        • (string) --
      • Disabled (boolean) --

        When termination settings are disabled, outbound calls can not be made.

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
get_voice_connector_termination_health(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.get_voice_connector_termination_health(
    VoiceConnectorId='string'
)
Parameters
VoiceConnectorId (string) --

[REQUIRED]

The Amazon Chime Voice Connector ID.

Return type
dict
Returns
Response Syntax
{
    'TerminationHealth': {
        'Timestamp': datetime(2015, 1, 1),
        'Source': 'string'
    }
}

Response Structure

  • (dict) --
    • TerminationHealth (dict) --

      The termination health details.

      • Timestamp (datetime) --

        The timestamp, in ISO 8601 format.

      • Source (string) --

        The source IP address.

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters
waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns
The specified waiter object.
Return type
botocore.waiter.Waiter
invite_users(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.invite_users(
    AccountId='string',
    UserEmailList=[
        'string',
    ],
    UserType='PrivateUser'|'SharedDevice'
)
Parameters
  • AccountId (string) --

    [REQUIRED]

    The Amazon Chime account ID.

  • UserEmailList (list) --

    [REQUIRED]

    The user email addresses to which to send the email invitation.

    • (string) --
  • UserType (string) -- The user type.
Return type

dict

Returns

Response Syntax

{
    'Invites': [
        {
            'InviteId': 'string',
            'Status': 'Pending'|'Accepted'|'Failed',
            'EmailAddress': 'string',
            'EmailStatus': 'NotSent'|'Sent'|'Failed'
        },
    ]
}

Response Structure

  • (dict) --

    • Invites (list) --

      The email invitation details.

      • (dict) --

        Invitation object returned after emailing users to invite them to join the Amazon Chime Team account.

        • InviteId (string) --

          The invite ID.

        • Status (string) --

          The status of the invite.

        • EmailAddress (string) --

          The email address to which the invite is sent.

        • EmailStatus (string) --

          The status of the invite email.

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
list_accounts(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.list_accounts(
    Name='string',
    UserEmail='string',
    NextToken='string',
    MaxResults=123
)
Parameters
  • Name (string) -- Amazon Chime account name prefix with which to filter results.
  • UserEmail (string) -- User email address with which to filter results.
  • NextToken (string) -- The token to use to retrieve the next page of results.
  • MaxResults (integer) -- The maximum number of results to return in a single call. Defaults to 100.
Return type

dict

Returns

Response Syntax

{
    'Accounts': [
        {
            'AwsAccountId': 'string',
            'AccountId': 'string',
            'Name': 'string',
            'AccountType': 'Team'|'EnterpriseDirectory'|'EnterpriseLWA'|'EnterpriseOIDC',
            'CreatedTimestamp': datetime(2015, 1, 1),
            'DefaultLicense': 'Basic'|'Plus'|'Pro'|'ProTrial',
            'SupportedLicenses': [
                'Basic'|'Plus'|'Pro'|'ProTrial',
            ],
            'SigninDelegateGroups': [
                {
                    'GroupName': 'string'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Accounts (list) --

      The list of accounts.

      • (dict) --

        The Amazon Chime account details. An AWS account can have multiple Amazon Chime accounts.

        • AwsAccountId (string) --

          The AWS account ID.

        • AccountId (string) --

          The Amazon Chime account ID.

        • Name (string) --

          The Amazon Chime account name.

        • AccountType (string) --

          The Amazon Chime account type. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide .

        • CreatedTimestamp (datetime) --

          The Amazon Chime account creation timestamp, in ISO 8601 format.

        • DefaultLicense (string) --

          The default license for the Amazon Chime account.

        • SupportedLicenses (list) --

          Supported licenses for the Amazon Chime account.

          • (string) --
        • SigninDelegateGroups (list) --

          The sign-in delegate groups associated with the account.

          • (dict) --

            An Active Directory (AD) group whose members are granted permission to act as delegates.

            • GroupName (string) --

              The group name.

    • NextToken (string) --

      The account's user token.

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
list_app_instance_admins(**kwargs)

Returns a list of the administrators in the app instance.

See also: AWS API Documentation

Request Syntax

response = client.list_app_instance_admins(
    AppInstanceArn='string',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • AppInstanceArn (string) --

    [REQUIRED]

    The ARN of the app instance.

  • MaxResults (integer) -- The maximum number of administrators that you want to return.
  • NextToken (string) -- The token returned from previous API requests until the number of administrators is reached.
Return type

dict

Returns

Response Syntax

{
    'AppInstanceArn': 'string',
    'AppInstanceAdmins': [
        {
            'Admin': {
                'Arn': 'string',
                'Name': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • AppInstanceArn (string) --

      The ARN of the app instance.

    • AppInstanceAdmins (list) --

      The information for each administrator.

      • (dict) --

        The identity and metadata of an administrator.

        • Admin (dict) --

          The name and metadata of the app instance administrator.

          • Arn (string) --

            The ARN in an Identity.

          • Name (string) --

            The name in an Identity.

    • NextToken (string) --

      The token returned from previous API requests until the number of administrators is reached.

Exceptions

  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.ResourceLimitExceededException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
list_app_instance_users(**kwargs)

List all AppInstanceUsers created under a single app instance.

See also: AWS API Documentation

Request Syntax

response = client.list_app_instance_users(
    AppInstanceArn='string',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • AppInstanceArn (string) --

    [REQUIRED]

    The ARN of the app instance.

  • MaxResults (integer) -- The maximum number of requests that you want returned.
  • NextToken (string) -- The token passed by previous API calls until all requested users are returned.
Return type

dict

Returns

Response Syntax

{
    'AppInstanceArn': 'string',
    'AppInstanceUsers': [
        {
            'AppInstanceUserArn': 'string',
            'Name': 'string',
            'Metadata': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • AppInstanceArn (string) --

      The ARN of the app instance.

    • AppInstanceUsers (list) --

      The information for each of the requested app instance users.

      • (dict) --

        The app instance user summary data .

        • AppInstanceUserArn (string) --

          The ARN of the app instance user.

        • Name (string) --

          The name in an app instance user summary.

        • Metadata (string) --

          The metadata in an app instance user summary.

    • NextToken (string) --

      The token passed by previous API calls until all requested users are returned.

Exceptions

  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
list_app_instances(**kwargs)

Lists all Amazon Chime app instances created under a single AWS account.

See also: AWS API Documentation

Request Syntax

response = client.list_app_instances(
    MaxResults=123,
    NextToken='string'
)
Parameters
  • MaxResults (integer) -- The maximum number of app instances that you want to return.
  • NextToken (string) -- The token passed by previous API requests until you reach the maximum number of app instances.
Return type

dict

Returns

Response Syntax

{
    'AppInstances': [
        {
            'AppInstanceArn': 'string',
            'Name': 'string',
            'Metadata': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • AppInstances (list) --

      The information for each app instance.

      • (dict) --

        The summary data for an app instance.

        • AppInstanceArn (string) --

          The app instance ARN.

        • Name (string) --

          The name of the app instance summary.

        • Metadata (string) --

          The metadata of the app instance summary.

    • NextToken (string) --

      The token passed by previous API requests until the maximum number of app instances is reached.

Exceptions

  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
list_attendee_tags(**kwargs)

Lists the tags applied to an Amazon Chime SDK attendee resource.

See also: AWS API Documentation

Request Syntax

response = client.list_attendee_tags(
    MeetingId='string',
    AttendeeId='string'
)
Parameters
  • MeetingId (string) --

    [REQUIRED]

    The Amazon Chime SDK meeting ID.

  • AttendeeId (string) --

    [REQUIRED]

    The Amazon Chime SDK attendee ID.

Return type

dict

Returns

Response Syntax

{
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • Tags (list) --

      A list of tag key-value pairs.

      • (dict) --

        Describes a tag applied to a resource.

        • Key (string) --

          The key of the tag.

        • Value (string) --

          The value of the tag.

Exceptions

  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
list_attendees(**kwargs)

Lists the attendees for the specified Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide .

See also: AWS API Documentation

Request Syntax

response = client.list_attendees(
    MeetingId='string',
    NextToken='string',
    MaxResults=123
)
Parameters
  • MeetingId (string) --

    [REQUIRED]

    The Amazon Chime SDK meeting ID.

  • NextToken (string) -- The token to use to retrieve the next page of results.
  • MaxResults (integer) -- The maximum number of results to return in a single call.
Return type

dict

Returns

Response Syntax

{
    'Attendees': [
        {
            'ExternalUserId': 'string',
            'AttendeeId': 'string',
            'JoinToken': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Attendees (list) --

      The Amazon Chime SDK attendee information.

      • (dict) --

        An Amazon Chime SDK meeting attendee. Includes a unique AttendeeId and JoinToken . The JoinToken allows a client to authenticate and join as the specified attendee. The JoinToken expires when the meeting ends or when DeleteAttendee is called. After that, the attendee is unable to join the meeting.

        We recommend securely transferring each JoinToken from your server application to the client so that no other client has access to the token except for the one authorized to represent the attendee.

        • ExternalUserId (string) --

          The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application. If you create an attendee with the same external user id, the service returns the existing record.

        • AttendeeId (string) --

          The Amazon Chime SDK attendee ID.

        • JoinToken (string) --

          The join token used by the Amazon Chime SDK attendee.

    • NextToken (string) --

      The token to use to retrieve the next page of results.

Exceptions

  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
list_bots(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.list_bots(
    AccountId='string',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • AccountId (string) --

    [REQUIRED]

    The Amazon Chime account ID.

  • MaxResults (integer) -- The maximum number of results to return in a single call. The default is 10.
  • NextToken (string) -- The token to use to retrieve the next page of results.
Return type

dict

Returns

Response Syntax

{
    'Bots': [
        {
            'BotId': 'string',
            'UserId': 'string',
            'DisplayName': 'string',
            'BotType': 'ChatBot',
            'Disabled': True|False,
            'CreatedTimestamp': datetime(2015, 1, 1),
            'UpdatedTimestamp': datetime(2015, 1, 1),
            'BotEmail': 'string',
            'SecurityToken': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Bots (list) --

      List of bots and bot details.

      • (dict) --

        A resource that allows Enterprise account administrators to configure an interface to receive events from Amazon Chime.

        • BotId (string) --

          The bot ID.

        • UserId (string) --

          The unique ID for the bot user.

        • DisplayName (string) --

          The bot display name.

        • BotType (string) --

          The bot type.

        • Disabled (boolean) --

          When true, the bot is stopped from running in your account.

        • CreatedTimestamp (datetime) --

          The bot creation timestamp, in ISO 8601 format.

        • UpdatedTimestamp (datetime) --

          The updated bot timestamp, in ISO 8601 format.

        • BotEmail (string) --

          The bot email address.

        • SecurityToken (string) --

          The security token used to authenticate Amazon Chime with the outgoing event endpoint.

    • NextToken (string) --

      The token to use to retrieve the next page of results.

Exceptions

  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.ThrottledClientException
list_channel_bans(**kwargs)

Lists all the users banned from a particular channel.

See also: AWS API Documentation

Request Syntax

response = client.list_channel_bans(
    ChannelArn='string',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • ChannelArn (string) --

    [REQUIRED]

    The ARN of the channel.

  • MaxResults (integer) -- The maximum number of bans that you want returned.
  • NextToken (string) -- The token passed by previous API calls until all requested bans are returned.
Return type

dict

Returns

Response Syntax

{
    'ChannelArn': 'string',
    'NextToken': 'string',
    'ChannelBans': [
        {
            'Member': {
                'Arn': 'string',
                'Name': 'string'
            }
        },
    ]
}

Response Structure

  • (dict) --

    • ChannelArn (string) --

      The ARN of the channel.

    • NextToken (string) --

      The token passed by previous API calls until all requested bans are returned.

    • ChannelBans (list) --

      The information for each requested ban.

      • (dict) --

        The summary data for the channel ban.

        • Member (dict) --

          The member being banned from a channel.

          • Arn (string) --

            The ARN in an Identity.

          • Name (string) --

            The name in an Identity.

Exceptions

  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
list_channel_memberships(**kwargs)

Lists all channel memberships in a channel.

See also: AWS API Documentation

Request Syntax

response = client.list_channel_memberships(
    ChannelArn='string',
    Type='DEFAULT'|'HIDDEN',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • ChannelArn (string) --

    [REQUIRED]

    The maximum number of channel memberships that you want returned.

  • Type (string) -- The membership type of a user, DEFAULT or HIDDEN . Default members are always returned as part of ListChannelMemberships . Hidden members are only returned if the type filter in ListChannelMemberships equals HIDDEN . Otherwise hidden members are not returned.
  • MaxResults (integer) -- The maximum number of channel memberships that you want returned.
  • NextToken (string) -- The token passed by previous API calls until all requested channel memberships are returned..
Return type

dict

Returns

Response Syntax

{
    'ChannelArn': 'string',
    'ChannelMemberships': [
        {
            'Member': {
                'Arn': 'string',
                'Name': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • ChannelArn (string) --

      The ARN of the channel.

    • ChannelMemberships (list) --

      The information for the requested channel memberships.

      • (dict) --

        The summary data of a channel membership.

        • Member (dict) --

          A member's summary data.

          • Arn (string) --

            The ARN in an Identity.

          • Name (string) --

            The name in an Identity.

    • NextToken (string) --

      The token passed by previous API calls until all requested channel memberships are returned.

Exceptions

  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
list_channel_memberships_for_app_instance_user(**kwargs)

Lists all channels that a particular AppInstanceUser is a part of. Only an AppInstanceAdmin can call the API with a user ARN that is not their own.

See also: AWS API Documentation

Request Syntax

response = client.list_channel_memberships_for_app_instance_user(
    AppInstanceUserArn='string',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • AppInstanceUserArn (string) -- The ARN of the app instance users
  • MaxResults (integer) -- The maximum number of users that you want returned.
  • NextToken (string) -- The token returned from previous API requests until the number of channel memberships is reached.
Return type

dict

Returns

Response Syntax

{
    'ChannelMemberships': [
        {
            'ChannelSummary': {
                'Name': 'string',
                'ChannelArn': 'string',
                'Mode': 'UNRESTRICTED'|'RESTRICTED',
                'Privacy': 'PUBLIC'|'PRIVATE',
                'Metadata': 'string',
                'LastMessageTimestamp': datetime(2015, 1, 1)
            },
            'AppInstanceUserMembershipSummary': {
                'Type': 'DEFAULT'|'HIDDEN',
                'ReadMarkerTimestamp': datetime(2015, 1, 1)
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • ChannelMemberships (list) --

      The token passed by previous API calls until all requested users are returned.

      • (dict) --

        Returns the channel membership summary data for an app instance.

        • ChannelSummary (dict) --

          The summary data for a channel.

          • Name (string) --

            The parameter of the action.

          • ChannelArn (string) --

            The ARN of the channel summary.

          • Mode (string) --

            The summary mode of the channel.

          • Privacy (string) --

            The privacy setting of the channel being summarized, PUBLIC or HIDDEN .

          • Metadata (string) --

            The metadata of the channel summary.

          • LastMessageTimestamp (datetime) --

            The time at which the last message in a channel was sent.

        • AppInstanceUserMembershipSummary (dict) --

          Returns the channel membership data for an app instance.

          • Type (string) --

            The type of channel summary,

          • ReadMarkerTimestamp (datetime) --

            The time at which a summary was last read.

    • NextToken (string) --

      The token passed by previous API calls until all requested users are returned.

Exceptions

  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
list_channel_messages(**kwargs)

List all the messages in a channel. Returns a paginated list of ChannelMessages . Sorted in descending order by default, based on the creation timestamp.

Note

Redacted messages appear in the results as empty, since they are only redacted, not deleted. Deleted messages do not appear in the results. This action always returns the latest version of an edited message.

See also: AWS API Documentation

Request Syntax

response = client.list_channel_messages(
    ChannelArn='string',
    SortOrder='ASCENDING'|'DESCENDING',
    NotBefore=datetime(2015, 1, 1),
    NotAfter=datetime(2015, 1, 1),
    MaxResults=123,
    NextToken='string'
)
Parameters
  • ChannelArn (string) --

    [REQUIRED]

    The ARN of the channel.

  • SortOrder (string) -- The order in which you want messages sorted. Default is Descending, based on time created.
  • NotBefore (datetime) -- The initial or starting time stamp for your requested messages.
  • NotAfter (datetime) -- The final or ending time stamp for your requested messages.
  • MaxResults (integer) -- The maximum number of messages that you want returned.
  • NextToken (string) -- The token passed by previous API calls until all requested messages are returned.
Return type

dict

Returns

Response Syntax

{
    'ChannelArn': 'string',
    'NextToken': 'string',
    'ChannelMessages': [
        {
            'MessageId': 'string',
            'Content': 'string',
            'Metadata': 'string',
            'Type': 'STANDARD'|'CONTROL',
            'CreatedTimestamp': datetime(2015, 1, 1),
            'LastUpdatedTimestamp': datetime(2015, 1, 1),
            'LastEditedTimestamp': datetime(2015, 1, 1),
            'Sender': {
                'Arn': 'string',
                'Name': 'string'
            },
            'Redacted': True|False
        },
    ]
}

Response Structure

  • (dict) --

    • ChannelArn (string) --

      The ARN of the channel containing the requested messages.

    • NextToken (string) --

      The token passed by previous API calls until all requested messages are returned.

    • ChannelMessages (list) --

      The information about and content of each requested message.

      • (dict) --

        A summary of the messages in a channel.

        • MessageId (string) --

          The ID of the message summary.

        • Content (string) --

          The content of the message summary.

        • Metadata (string) --

          The metadata of the message summary.

        • Type (string) --

          The type of message summary.

        • CreatedTimestamp (datetime) --

          The time at which the message summary was created.

        • LastUpdatedTimestamp (datetime) --

        • LastEditedTimestamp (datetime) --

        • Sender (dict) --

          The sender of the message summary.

          • Arn (string) --

            The ARN in an Identity.

          • Name (string) --

            The name in an Identity.

        • Redacted (boolean) --

          Redacts the content of a message summary.

Exceptions

  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
list_channel_moderators(**kwargs)

Lists all the moderators for a channel.

See also: AWS API Documentation

Request Syntax

response = client.list_channel_moderators(
    ChannelArn='string',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • ChannelArn (string) --

    [REQUIRED]

    The ARN of the channel.

  • MaxResults (integer) -- The maximum number of moderators that you want returned.
  • NextToken (string) -- The token passed by previous API calls until all requested moderators are returned.
Return type

dict

Returns

Response Syntax

{
    'ChannelArn': 'string',
    'NextToken': 'string',
    'ChannelModerators': [
        {
            'Moderator': {
                'Arn': 'string',
                'Name': 'string'
            }
        },
    ]
}

Response Structure

  • (dict) --

    • ChannelArn (string) --

      The ARN of the channel.

    • NextToken (string) --

      The token passed by previous API calls until all requested moderators are returned.

    • ChannelModerators (list) --

      The information about and names of each moderator.

      • (dict) --

        Summary data of the moderators in a channel.

        • Moderator (dict) --

          The data for a moderator.

          • Arn (string) --

            The ARN in an Identity.

          • Name (string) --

            The name in an Identity.

Exceptions

  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
list_channels(**kwargs)

Lists all Channels created under a single Chime App as a paginated list. You can specify filters to narrow results.

Functionality & restrictions
  • Use privacy = PUBLIC to retrieve all public channels in the account
  • Only an AppInstanceAdmin can set privacy = PRIVATE to list the private channels in an account.

See also: AWS API Documentation

Request Syntax

response = client.list_channels(
    AppInstanceArn='string',
    Privacy='PUBLIC'|'PRIVATE',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • AppInstanceArn (string) --

    [REQUIRED]

    The ARN of the app instance.

  • Privacy (string) -- The privacy setting. PUBLIC retrieves all the public channels. PRIVATE retrieves private channels. Only an app instance administrator can retrieve private channels.
  • MaxResults (integer) -- The maximum number of channels that you want to return.
  • NextToken (string) -- The token passed by previous API calls until all requested channels are returned.
Return type

dict

Returns

Response Syntax

{
    'Channels': [
        {
            'Name': 'string',
            'ChannelArn': 'string',
            'Mode': 'UNRESTRICTED'|'RESTRICTED',
            'Privacy': 'PUBLIC'|'PRIVATE',
            'Metadata': 'string',
            'LastMessageTimestamp': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Channels (list) --

      The information about each channel.

      • (dict) --

        The summary data for a channel.

        • Name (string) --

          The parameter of the action.

        • ChannelArn (string) --

          The ARN of the channel summary.

        • Mode (string) --

          The summary mode of the channel.

        • Privacy (string) --

          The privacy setting of the channel being summarized, PUBLIC or HIDDEN .

        • Metadata (string) --

          The metadata of the channel summary.

        • LastMessageTimestamp (datetime) --

          The time at which the last message in a channel was sent.

    • NextToken (string) --

      The token returned from previous API requests until the number of channels is reached.

Exceptions

  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
list_channels_moderated_by_app_instance_user(**kwargs)

A list of the channels moderated by an app instance user.

See also: AWS API Documentation

Request Syntax

response = client.list_channels_moderated_by_app_instance_user(
    AppInstanceUserArn='string',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • AppInstanceUserArn (string) -- The ARN of the user in the moderated channel.
  • MaxResults (integer) -- The maximum number of channels in the request.
  • NextToken (string) -- The token returned from previous API requests until the number of channels moderated by the user is reached.
Return type

dict

Returns

Response Syntax

{
    'Channels': [
        {
            'ChannelSummary': {
                'Name': 'string',
                'ChannelArn': 'string',
                'Mode': 'UNRESTRICTED'|'RESTRICTED',
                'Privacy': 'PUBLIC'|'PRIVATE',
                'Metadata': 'string',
                'LastMessageTimestamp': datetime(2015, 1, 1)
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Channels (list) --

      The moderated channels in the request.

      • (dict) --

        Returns the summary data for a moderated channel.

        • ChannelSummary (dict) --

          The summary data for a channel.

          • Name (string) --

            The parameter of the action.

          • ChannelArn (string) --

            The ARN of the channel summary.

          • Mode (string) --

            The summary mode of the channel.

          • Privacy (string) --

            The privacy setting of the channel being summarized, PUBLIC or HIDDEN .

          • Metadata (string) --

            The metadata of the channel summary.

          • LastMessageTimestamp (datetime) --

            The time at which the last message in a channel was sent.

    • NextToken (string) --

      The token returned from previous API requests until the number of channels moderated by the user is reached.

Exceptions

  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
list_meeting_tags(**kwargs)

Lists the tags applied to an Amazon Chime SDK meeting resource.

See also: AWS API Documentation

Request Syntax

response = client.list_meeting_tags(
    MeetingId='string'
)
Parameters
MeetingId (string) --

[REQUIRED]

The Amazon Chime SDK meeting ID.

Return type
dict
Returns
Response Syntax
{
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
}

Response Structure

  • (dict) --
    • Tags (list) --

      A list of tag key-value pairs.

      • (dict) --

        Describes a tag applied to a resource.

        • Key (string) --

          The key of the tag.

        • Value (string) --

          The value of the tag.

Exceptions

  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
list_meetings(**kwargs)

Lists up to 100 active Amazon Chime SDK meetings. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide .

See also: AWS API Documentation

Request Syntax

response = client.list_meetings(
    NextToken='string',
    MaxResults=123
)
Parameters
  • NextToken (string) -- The token to use to retrieve the next page of results.
  • MaxResults (integer) -- The maximum number of results to return in a single call.
Return type

dict

Returns

Response Syntax

{
    'Meetings': [
        {
            'MeetingId': 'string',
            'ExternalMeetingId': 'string',
            'MediaPlacement': {
                'AudioHostUrl': 'string',
                'AudioFallbackUrl': 'string',
                'ScreenDataUrl': 'string',
                'ScreenSharingUrl': 'string',
                'ScreenViewingUrl': 'string',
                'SignalingUrl': 'string',
                'TurnControlUrl': 'string'
            },
            'MediaRegion': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Meetings (list) --

      The Amazon Chime SDK meeting information.

      • (dict) --

        A meeting created using the Amazon Chime SDK.

        • MeetingId (string) --

          The Amazon Chime SDK meeting ID.

        • ExternalMeetingId (string) --

          The external meeting ID.

        • MediaPlacement (dict) --

          The media placement for the meeting.

          • AudioHostUrl (string) --

            The audio host URL.

          • AudioFallbackUrl (string) --

            The audio fallback URL.

          • ScreenDataUrl (string) --

            The screen data URL.

          • ScreenSharingUrl (string) --

            The screen sharing URL.

          • ScreenViewingUrl (string) --

            The screen viewing URL.

          • SignalingUrl (string) --

            The signaling URL.

          • TurnControlUrl (string) --

            The turn control URL.

        • MediaRegion (string) --

          The Region in which to create the meeting. Available values: af-south-1 , ap-northeast-1 , ap-northeast-2 , ap-south-1 , ap-southeast-1 , ap-southeast-2 , ca-central-1 , eu-central-1 , eu-north-1 , eu-south-1 , eu-west-1 , eu-west-2 , eu-west-3 , sa-east-1 , us-east-1 , us-east-2 , us-west-1 , us-west-2 .

    • NextToken (string) --

      The token to use to retrieve the next page of results.

Exceptions

  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
list_phone_number_orders(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.list_phone_number_orders(
    NextToken='string',
    MaxResults=123
)
Parameters
  • NextToken (string) -- The token to use to retrieve the next page of results.
  • MaxResults (integer) -- The maximum number of results to return in a single call.
Return type

dict

Returns

Response Syntax

{
    'PhoneNumberOrders': [
        {
            'PhoneNumberOrderId': 'string',
            'ProductType': 'BusinessCalling'|'VoiceConnector',
            'Status': 'Processing'|'Successful'|'Failed'|'Partial',
            'OrderedPhoneNumbers': [
                {
                    'E164PhoneNumber': 'string',
                    'Status': 'Processing'|'Acquired'|'Failed'
                },
            ],
            'CreatedTimestamp': datetime(2015, 1, 1),
            'UpdatedTimestamp': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • PhoneNumberOrders (list) --

      The phone number order details.

      • (dict) --

        The details of a phone number order created for Amazon Chime.

        • PhoneNumberOrderId (string) --

          The phone number order ID.

        • ProductType (string) --

          The phone number order product type.

        • Status (string) --

          The status of the phone number order.

        • OrderedPhoneNumbers (list) --

          The ordered phone number details, such as the phone number in E.164 format and the phone number status.

          • (dict) --

            A phone number for which an order has been placed.

            • E164PhoneNumber (string) --

              The phone number, in E.164 format.

            • Status (string) --

              The phone number status.

        • CreatedTimestamp (datetime) --

          The phone number order creation timestamp, in ISO 8601 format.

        • UpdatedTimestamp (datetime) --

          The updated phone number order timestamp, in ISO 8601 format.

    • NextToken (string) --

      The token to use to retrieve the next page of results.

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
list_phone_numbers(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.list_phone_numbers(
    Status='AcquireInProgress'|'AcquireFailed'|'Unassigned'|'Assigned'|'ReleaseInProgress'|'DeleteInProgress'|'ReleaseFailed'|'DeleteFailed',
    ProductType='BusinessCalling'|'VoiceConnector',
    FilterName='AccountId'|'UserId'|'VoiceConnectorId'|'VoiceConnectorGroupId'|'SipRuleId',
    FilterValue='string',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • Status (string) -- The phone number status.
  • ProductType (string) -- The phone number product type.
  • FilterName (string) -- The filter to use to limit the number of results.
  • FilterValue (string) -- The value to use for the filter.
  • MaxResults (integer) -- The maximum number of results to return in a single call.
  • NextToken (string) -- The token to use to retrieve the next page of results.
Return type

dict

Returns

Response Syntax

{
    'PhoneNumbers': [
        {
            'PhoneNumberId': 'string',
            'E164PhoneNumber': 'string',
            'Type': 'Local'|'TollFree',
            'ProductType': 'BusinessCalling'|'VoiceConnector',
            'Status': 'AcquireInProgress'|'AcquireFailed'|'Unassigned'|'Assigned'|'ReleaseInProgress'|'DeleteInProgress'|'ReleaseFailed'|'DeleteFailed',
            'Capabilities': {
                'InboundCall': True|False,
                'OutboundCall': True|False,
                'InboundSMS': True|False,
                'OutboundSMS': True|False,
                'InboundMMS': True|False,
                'OutboundMMS': True|False
            },
            'Associations': [
                {
                    'Value': 'string',
                    'Name': 'AccountId'|'UserId'|'VoiceConnectorId'|'VoiceConnectorGroupId'|'SipRuleId',
                    'AssociatedTimestamp': datetime(2015, 1, 1)
                },
            ],
            'CallingName': 'string',
            'CallingNameStatus': 'Unassigned'|'UpdateInProgress'|'UpdateSucceeded'|'UpdateFailed',
            'CreatedTimestamp': datetime(2015, 1, 1),
            'UpdatedTimestamp': datetime(2015, 1, 1),
            'DeletionTimestamp': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • PhoneNumbers (list) --

      The phone number details.

      • (dict) --

        A phone number used for Amazon Chime Business Calling or an Amazon Chime Voice Connector.

        • PhoneNumberId (string) --

          The phone number ID.

        • E164PhoneNumber (string) --

          The phone number, in E.164 format.

        • Type (string) --

          The phone number type.

        • ProductType (string) --

          The phone number product type.

        • Status (string) --

          The phone number status.

        • Capabilities (dict) --

          The phone number capabilities.

          • InboundCall (boolean) --

            Allows or denies inbound calling for the specified phone number.

          • OutboundCall (boolean) --

            Allows or denies outbound calling for the specified phone number.

          • InboundSMS (boolean) --

            Allows or denies inbound SMS messaging for the specified phone number.

          • OutboundSMS (boolean) --

            Allows or denies outbound SMS messaging for the specified phone number.

          • InboundMMS (boolean) --

            Allows or denies inbound MMS messaging for the specified phone number.

          • OutboundMMS (boolean) --

            Allows or denies outbound MMS messaging for the specified phone number.

        • Associations (list) --

          The phone number associations.

          • (dict) --

            The phone number associations, such as Amazon Chime account ID, Amazon Chime user ID, Amazon Chime Voice Connector ID, or Amazon Chime Voice Connector group ID.

            • Value (string) --

              Contains the ID for the entity specified in Name.

            • Name (string) --

              Defines the association with an Amazon Chime account ID, user ID, Amazon Chime Voice Connector ID, or Amazon Chime Voice Connector group ID.

            • AssociatedTimestamp (datetime) --

              The timestamp of the phone number association, in ISO 8601 format.

        • CallingName (string) --

          The outbound calling name associated with the phone number.

        • CallingNameStatus (string) --

          The outbound calling name status.

        • CreatedTimestamp (datetime) --

          The phone number creation timestamp, in ISO 8601 format.

        • UpdatedTimestamp (datetime) --

          The updated phone number timestamp, in ISO 8601 format.

        • DeletionTimestamp (datetime) --

          The deleted phone number timestamp, in ISO 8601 format.

    • NextToken (string) --

      The token to use to retrieve the next page of results.

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
list_proxy_sessions(**kwargs)

Lists the proxy sessions for the specified Amazon Chime Voice Connector.

See also: AWS API Documentation

Request Syntax

response = client.list_proxy_sessions(
    VoiceConnectorId='string',
    Status='Open'|'InProgress'|'Closed',
    NextToken='string',
    MaxResults=123
)
Parameters
  • VoiceConnectorId (string) --

    [REQUIRED]

    The Amazon Chime voice connector ID.

  • Status (string) -- The proxy session status.
  • NextToken (string) -- The token to use to retrieve the next page of results.
  • MaxResults (integer) -- The maximum number of results to return in a single call.
Return type

dict

Returns

Response Syntax

{
    'ProxySessions': [
        {
            'VoiceConnectorId': 'string',
            'ProxySessionId': 'string',
            'Name': 'string',
            'Status': 'Open'|'InProgress'|'Closed',
            'ExpiryMinutes': 123,
            'Capabilities': [
                'Voice'|'SMS',
            ],
            'CreatedTimestamp': datetime(2015, 1, 1),
            'UpdatedTimestamp': datetime(2015, 1, 1),
            'EndedTimestamp': datetime(2015, 1, 1),
            'Participants': [
                {
                    'PhoneNumber': 'string',
                    'ProxyPhoneNumber': 'string'
                },
            ],
            'NumberSelectionBehavior': 'PreferSticky'|'AvoidSticky',
            'GeoMatchLevel': 'Country'|'AreaCode',
            'GeoMatchParams': {
                'Country': 'string',
                'AreaCode': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • ProxySessions (list) --

      The proxy session details.

      • (dict) --

        The proxy session for an Amazon Chime Voice Connector.

        • VoiceConnectorId (string) --

          The Amazon Chime voice connector ID.

        • ProxySessionId (string) --

          The proxy session ID.

        • Name (string) --

          The name of the proxy session.

        • Status (string) --

          The status of the proxy session.

        • ExpiryMinutes (integer) --

          The number of minutes allowed for the proxy session.

        • Capabilities (list) --

          The proxy session capabilities.

          • (string) --
        • CreatedTimestamp (datetime) --

          The created timestamp, in ISO 8601 format.

        • UpdatedTimestamp (datetime) --

          The updated timestamp, in ISO 8601 format.

        • EndedTimestamp (datetime) --

          The ended timestamp, in ISO 8601 format.

        • Participants (list) --

          The proxy session participants.

          • (dict) --

            The phone number and proxy phone number for a participant in an Amazon Chime Voice Connector proxy session.

            • PhoneNumber (string) --

              The participant's phone number.

            • ProxyPhoneNumber (string) --

              The participant's proxy phone number.

        • NumberSelectionBehavior (string) --

          The preference for proxy phone number reuse, or stickiness, between the same participants across sessions.

        • GeoMatchLevel (string) --

          The preference for matching the country or area code of the proxy phone number with that of the first participant.

        • GeoMatchParams (dict) --

          The country and area code for the proxy phone number.

          • Country (string) --

            The country.

          • AreaCode (string) --

            The area code.

    • NextToken (string) --

      The token to use to retrieve the next page of results.

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
list_room_memberships(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.list_room_memberships(
    AccountId='string',
    RoomId='string',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • AccountId (string) --

    [REQUIRED]

    The Amazon Chime account ID.

  • RoomId (string) --

    [REQUIRED]

    The room ID.

  • MaxResults (integer) -- The maximum number of results to return in a single call.
  • NextToken (string) -- The token to use to retrieve the next page of results.
Return type

dict

Returns

Response Syntax

{
    'RoomMemberships': [
        {
            'RoomId': 'string',
            'Member': {
                'MemberId': 'string',
                'MemberType': 'User'|'Bot'|'Webhook',
                'Email': 'string',
                'FullName': 'string',
                'AccountId': 'string'
            },
            'Role': 'Administrator'|'Member',
            'InvitedBy': 'string',
            'UpdatedTimestamp': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • RoomMemberships (list) --

      The room membership details.

      • (dict) --

        The room membership details.

        • RoomId (string) --

          The room ID.

        • Member (dict) --

          The member details, such as email address, name, member ID, and member type.

          • MemberId (string) --

            The member ID (user ID or bot ID).

          • MemberType (string) --

            The member type.

          • Email (string) --

            The member email address.

          • FullName (string) --

            The member name.

          • AccountId (string) --

            The Amazon Chime account ID.

        • Role (string) --

          The membership role.

        • InvitedBy (string) --

          The identifier of the user that invited the room member.

        • UpdatedTimestamp (datetime) --

          The room membership update timestamp, in ISO 8601 format.

    • NextToken (string) --

      The token to use to retrieve the next page of results.

Exceptions

  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
list_rooms(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.list_rooms(
    AccountId='string',
    MemberId='string',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • AccountId (string) --

    [REQUIRED]

    The Amazon Chime account ID.

  • MemberId (string) -- The member ID (user ID or bot ID).
  • MaxResults (integer) -- The maximum number of results to return in a single call.
  • NextToken (string) -- The token to use to retrieve the next page of results.
Return type

dict

Returns

Response Syntax

{
    'Rooms': [
        {
            'RoomId': 'string',
            'Name': 'string',
            'AccountId': 'string',
            'CreatedBy': 'string',
            'CreatedTimestamp': datetime(2015, 1, 1),
            'UpdatedTimestamp': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Rooms (list) --

      The room details.

      • (dict) --

        The Amazon Chime chat room details.

        • RoomId (string) --

          The room ID.

        • Name (string) --

          The room name.

        • AccountId (string) --

          The Amazon Chime account ID.

        • CreatedBy (string) --

          The identifier of the room creator.

        • CreatedTimestamp (datetime) --

          The room creation timestamp, in ISO 8601 format.

        • UpdatedTimestamp (datetime) --

          The room update timestamp, in ISO 8601 format.

    • NextToken (string) --

      The token to use to retrieve the next page of results.

Exceptions

  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
list_sip_media_applications(**kwargs)

Lists the SIP media applications under the administrator's AWS account.

See also: AWS API Documentation

Request Syntax

response = client.list_sip_media_applications(
    MaxResults=123,
    NextToken='string'
)
Parameters
  • MaxResults (integer) -- The maximum number of results to return in a single call. Defaults to 100.
  • NextToken (string) -- The token to use to retrieve the next page of results.
Return type

dict

Returns

Response Syntax

{
    'SipMediaApplications': [
        {
            'SipMediaApplicationId': 'string',
            'AwsRegion': 'string',
            'Name': 'string',
            'Endpoints': [
                {
                    'LambdaArn': 'string'
                },
            ],
            'CreatedTimestamp': datetime(2015, 1, 1),
            'UpdatedTimestamp': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • SipMediaApplications (list) --

      List of SIP media applications and application details.

      • (dict) --

        The SIP media application details, including name and endpoints. An AWS account can have multiple SIP media applications.

        • SipMediaApplicationId (string) --

          The SIP media application ID.

        • AwsRegion (string) --

          The AWS Region in which the SIP media application is created.

        • Name (string) --

          The name of the SIP media application.

        • Endpoints (list) --

          List of endpoints for SIP media application. Currently, only one endpoint per SIP media application is permitted.

          • (dict) --

            Endpoints to specify as part of a SIP media application.

            • LambdaArn (string) --

              Valid Amazon Resource Name (ARN) of the Lambda function of the same AWS Region where the SIP media application is created.

        • CreatedTimestamp (datetime) --

          The SIP media application creation timestamp, in ISO 8601 format.

        • UpdatedTimestamp (datetime) --

          The SIP media application updated timestamp, in ISO 8601 format.

    • NextToken (string) --

      The token to use to retrieve the next page of results.

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
list_sip_rules(**kwargs)

Lists the SIP rules under the administrator's AWS account.

See also: AWS API Documentation

Request Syntax

response = client.list_sip_rules(
    SipMediaApplicationId='string',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • SipMediaApplicationId (string) -- The SIP media application ID.
  • MaxResults (integer) -- The maximum number of results to return in a single call. Defaults to 100.
  • NextToken (string) -- The token to use to retrieve the next page of results.
Return type

dict

Returns

Response Syntax

{
    'SipRules': [
        {
            'SipRuleId': 'string',
            'Name': 'string',
            'Disabled': True|False,
            'TriggerType': 'ToPhoneNumber'|'RequestUriHostname',
            'TriggerValue': 'string',
            'TargetApplications': [
                {
                    'SipMediaApplicationId': 'string',
                    'Priority': 123,
                    'AwsRegion': 'string'
                },
            ],
            'CreatedTimestamp': datetime(2015, 1, 1),
            'UpdatedTimestamp': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • SipRules (list) --

      List of SIP rules and rule details.

      • (dict) --

        The SIP rule details, including name, triggers, and target applications. An AWS account can have multiple SIP rules.

        • SipRuleId (string) --

          The SIP rule ID.

        • Name (string) --

          The name of the SIP rule.

        • Disabled (boolean) --

          Indicates if the SIP rule is enabled or disabled. You must disable a rule before you can delete it.

        • TriggerType (string) --

          The type of trigger whose value is assigned to the SIP rule in TriggerValue .

        • TriggerValue (string) --

          If TriggerType is RequestUriHostname , then the value can be the outbound host name of the Amazon Chime Voice Connector. If TriggerType is ToPhoneNumber , then the value can be a customer-owned phone number in E164 format. SipRule is triggered when a SIP rule requests host name or ToPhoneNumber matches in the incoming SIP request.

        • TargetApplications (list) --

          List of SIP media applications with priority and AWS Region. You can only use one SIP application per AWS Region and priority combination.

          • (dict) --

            Target SIP media application along with other details like priority and AWS Region to be specified in the SIP rule. Only one SIP rule per AWS Region can be provided.

            • SipMediaApplicationId (string) --

              The SIP media application ID.

            • Priority (integer) --

              Priority of the SIP media application in the target list.

            • AwsRegion (string) --

              AWS Region of target application.

        • CreatedTimestamp (datetime) --

          The SIP rule created timestamp, in ISO 8601 format.

        • UpdatedTimestamp (datetime) --

          The SIP rule updated timestamp, in ISO 8601 format.

    • NextToken (string) --

      The token to use to retrieve the next page of results.

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
list_tags_for_resource(**kwargs)

Lists the tags applied to an Amazon Chime SDK meeting resource.

See also: AWS API Documentation

Request Syntax

response = client.list_tags_for_resource(
    ResourceARN='string'
)
Parameters
ResourceARN (string) --

[REQUIRED]

The resource ARN.

Return type
dict
Returns
Response Syntax
{
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
}

Response Structure

  • (dict) --
    • Tags (list) --

      A list of tag-key value pairs.

      • (dict) --

        Describes a tag applied to a resource.

        • Key (string) --

          The key of the tag.

        • Value (string) --

          The value of the tag.

Exceptions

  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
list_users(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.list_users(
    AccountId='string',
    UserEmail='string',
    UserType='PrivateUser'|'SharedDevice',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • AccountId (string) --

    [REQUIRED]

    The Amazon Chime account ID.

  • UserEmail (string) -- Optional. The user email address used to filter results. Maximum 1.
  • UserType (string) -- The user type.
  • MaxResults (integer) -- The maximum number of results to return in a single call. Defaults to 100.
  • NextToken (string) -- The token to use to retrieve the next page of results.
Return type

dict

Returns

Response Syntax

{
    'Users': [
        {
            'UserId': 'string',
            'AccountId': 'string',
            'PrimaryEmail': 'string',
            'PrimaryProvisionedNumber': 'string',
            'DisplayName': 'string',
            'LicenseType': 'Basic'|'Plus'|'Pro'|'ProTrial',
            'UserType': 'PrivateUser'|'SharedDevice',
            'UserRegistrationStatus': 'Unregistered'|'Registered'|'Suspended',
            'UserInvitationStatus': 'Pending'|'Accepted'|'Failed',
            'RegisteredOn': datetime(2015, 1, 1),
            'InvitedOn': datetime(2015, 1, 1),
            'AlexaForBusinessMetadata': {
                'IsAlexaForBusinessEnabled': True|False,
                'AlexaForBusinessRoomArn': 'string'
            },
            'PersonalPIN': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Users (list) --

      List of users and user details.

      • (dict) --

        The user on the Amazon Chime account.

        • UserId (string) --

          The user ID.

        • AccountId (string) --

          The Amazon Chime account ID.

        • PrimaryEmail (string) --

          The primary email address of the user.

        • PrimaryProvisionedNumber (string) --

          The primary phone number associated with the user.

        • DisplayName (string) --

          The display name of the user.

        • LicenseType (string) --

          The license type for the user.

        • UserType (string) --

          The user type.

        • UserRegistrationStatus (string) --

          The user registration status.

        • UserInvitationStatus (string) --

          The user invite status.

        • RegisteredOn (datetime) --

          Date and time when the user is registered, in ISO 8601 format.

        • InvitedOn (datetime) --

          Date and time when the user is invited to the Amazon Chime account, in ISO 8601 format.

        • AlexaForBusinessMetadata (dict) --

          The Alexa for Business metadata.

          • IsAlexaForBusinessEnabled (boolean) --

            Starts or stops Alexa for Business.

          • AlexaForBusinessRoomArn (string) --

            The ARN of the room resource.

        • PersonalPIN (string) --

          The user's personal meeting PIN.

    • NextToken (string) --

      The token to use to retrieve the next page of results.

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
list_voice_connector_groups(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.list_voice_connector_groups(
    NextToken='string',
    MaxResults=123
)
Parameters
  • NextToken (string) -- The token to use to retrieve the next page of results.
  • MaxResults (integer) -- The maximum number of results to return in a single call.
Return type

dict

Returns

Response Syntax

{
    'VoiceConnectorGroups': [
        {
            'VoiceConnectorGroupId': 'string',
            'Name': 'string',
            'VoiceConnectorItems': [
                {
                    'VoiceConnectorId': 'string',
                    'Priority': 123
                },
            ],
            'CreatedTimestamp': datetime(2015, 1, 1),
            'UpdatedTimestamp': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • VoiceConnectorGroups (list) --

      The details of the Amazon Chime Voice Connector groups.

      • (dict) --

        The Amazon Chime Voice Connector group configuration, including associated Amazon Chime Voice Connectors. 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.

        • VoiceConnectorGroupId (string) --

          The Amazon Chime Voice Connector group ID.

        • Name (string) --

          The name of the Amazon Chime Voice Connector group.

        • VoiceConnectorItems (list) --

          The Amazon Chime Voice Connectors to which to route inbound calls.

          • (dict) --

            For Amazon Chime Voice Connector groups, the Amazon Chime Voice Connectors to which to route inbound calls. Includes priority configuration settings. Limit: 3 VoiceConnectorItems per Amazon Chime Voice Connector group.

            • VoiceConnectorId (string) --

              The Amazon Chime Voice Connector ID.

            • Priority (integer) --

              The priority associated with the Amazon Chime Voice Connector, with 1 being the highest priority. Higher priority Amazon Chime Voice Connectors are attempted first.

        • CreatedTimestamp (datetime) --

          The Amazon Chime Voice Connector group creation timestamp, in ISO 8601 format.

        • UpdatedTimestamp (datetime) --

          The updated Amazon Chime Voice Connector group timestamp, in ISO 8601 format.

    • NextToken (string) --

      The token to use to retrieve the next page of results.

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
list_voice_connector_termination_credentials(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.list_voice_connector_termination_credentials(
    VoiceConnectorId='string'
)
Parameters
VoiceConnectorId (string) --

[REQUIRED]

The Amazon Chime Voice Connector ID.

Return type
dict
Returns
Response Syntax
{
    'Usernames': [
        'string',
    ]
}

Response Structure

  • (dict) --
    • Usernames (list) --

      A list of user names.

      • (string) --

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
list_voice_connectors(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.list_voice_connectors(
    NextToken='string',
    MaxResults=123
)
Parameters
  • NextToken (string) -- The token to use to retrieve the next page of results.
  • MaxResults (integer) -- The maximum number of results to return in a single call.
Return type

dict

Returns

Response Syntax

{
    'VoiceConnectors': [
        {
            'VoiceConnectorId': 'string',
            'AwsRegion': 'us-east-1'|'us-west-2',
            'Name': 'string',
            'OutboundHostName': 'string',
            'RequireEncryption': True|False,
            'CreatedTimestamp': datetime(2015, 1, 1),
            'UpdatedTimestamp': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • VoiceConnectors (list) --

      The details of the Amazon Chime Voice Connectors.

      • (dict) --

        The Amazon Chime Voice Connector configuration, including outbound host name and encryption settings.

        • VoiceConnectorId (string) --

          The Amazon Chime Voice Connector ID.

        • AwsRegion (string) --

          The AWS Region in which the Amazon Chime Voice Connector is created. Default: us-east-1 .

        • Name (string) --

          The name of the Amazon Chime Voice Connector.

        • OutboundHostName (string) --

          The outbound host name for the Amazon Chime Voice Connector.

        • RequireEncryption (boolean) --

          Designates whether encryption is required for the Amazon Chime Voice Connector.

        • CreatedTimestamp (datetime) --

          The Amazon Chime Voice Connector creation timestamp, in ISO 8601 format.

        • UpdatedTimestamp (datetime) --

          The updated Amazon Chime Voice Connector timestamp, in ISO 8601 format.

    • NextToken (string) --

      The token to use to retrieve the next page of results.

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
logout_user(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.logout_user(
    AccountId='string',
    UserId='string'
)
Parameters
  • AccountId (string) --

    [REQUIRED]

    The Amazon Chime account ID.

  • UserId (string) --

    [REQUIRED]

    The user ID.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
put_app_instance_retention_settings(**kwargs)

Sets the amount of time in days that a given app instance retains data.

See also: AWS API Documentation

Request Syntax

response = client.put_app_instance_retention_settings(
    AppInstanceArn='string',
    AppInstanceRetentionSettings={
        'ChannelRetentionSettings': {
            'RetentionDays': 123
        }
    }
)
Parameters
  • AppInstanceArn (string) --

    [REQUIRED]

    The ARN of the app instance.

  • AppInstanceRetentionSettings (dict) --

    [REQUIRED]

    The time in days to retain data. Data type: number.

    • ChannelRetentionSettings (dict) --

      The length of time in days to retain a channel.

      • RetentionDays (integer) --

        The time in days to retain a channel.

Return type

dict

Returns

Response Syntax

{
    'AppInstanceRetentionSettings': {
        'ChannelRetentionSettings': {
            'RetentionDays': 123
        }
    },
    'InitiateDeletionTimestamp': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    • AppInstanceRetentionSettings (dict) --

      The time in days to retain data. Data type: number.

      • ChannelRetentionSettings (dict) --

        The length of time in days to retain a channel.

        • RetentionDays (integer) --

          The time in days to retain a channel.

    • InitiateDeletionTimestamp (datetime) --

      The time at which the API deletes data.

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.ConflictException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
put_app_instance_streaming_configurations(**kwargs)

The data streaming configurations of an app instance.

See also: AWS API Documentation

Request Syntax

response = client.put_app_instance_streaming_configurations(
    AppInstanceArn='string',
    AppInstanceStreamingConfigurations=[
        {
            'AppInstanceDataType': 'Channel'|'ChannelMessage',
            'ResourceArn': 'string'
        },
    ]
)
Parameters
  • AppInstanceArn (string) --

    [REQUIRED]

    The ARN of the app instance.

  • AppInstanceStreamingConfigurations (list) --

    [REQUIRED]

    The streaming configurations set for an app instance.

    • (dict) --

      The streaming configuration of an app instance.

      • AppInstanceDataType (string) -- [REQUIRED]

        The data type of the app instance.

      • ResourceArn (string) -- [REQUIRED]

        The resource ARN.

Return type

dict

Returns

Response Syntax

{
    'AppInstanceStreamingConfigurations': [
        {
            'AppInstanceDataType': 'Channel'|'ChannelMessage',
            'ResourceArn': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • AppInstanceStreamingConfigurations (list) --

      The streaming configurations of an app instance.

      • (dict) --

        The streaming configuration of an app instance.

        • AppInstanceDataType (string) --

          The data type of the app instance.

        • ResourceArn (string) --

          The resource ARN.

Exceptions

  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
put_events_configuration(**kwargs)

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 .

See also: AWS API Documentation

Request Syntax

response = client.put_events_configuration(
    AccountId='string',
    BotId='string',
    OutboundEventsHTTPSEndpoint='string',
    LambdaFunctionArn='string'
)
Parameters
  • AccountId (string) --

    [REQUIRED]

    The Amazon Chime account ID.

  • BotId (string) --

    [REQUIRED]

    The bot ID.

  • OutboundEventsHTTPSEndpoint (string) -- HTTPS endpoint that allows the bot to receive outgoing events.
  • LambdaFunctionArn (string) -- Lambda function ARN that allows the bot to receive outgoing events.
Return type

dict

Returns

Response Syntax

{
    'EventsConfiguration': {
        'BotId': 'string',
        'OutboundEventsHTTPSEndpoint': 'string',
        'LambdaFunctionArn': 'string'
    }
}

Response Structure

  • (dict) --

    • EventsConfiguration (dict) --

      The configuration that allows a bot to receive outgoing events. Can be either an HTTPS endpoint or a Lambda function ARN.

      • BotId (string) --

        The bot ID.

      • OutboundEventsHTTPSEndpoint (string) --

        HTTPS endpoint that allows a bot to receive outgoing events.

      • LambdaFunctionArn (string) --

        Lambda function ARN that allows a bot to receive outgoing events.

Exceptions

  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ResourceLimitExceededException
  • Chime.Client.exceptions.NotFoundException
put_retention_settings(**kwargs)

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 .

See also: AWS API Documentation

Request Syntax

response = client.put_retention_settings(
    AccountId='string',
    RetentionSettings={
        'RoomRetentionSettings': {
            'RetentionDays': 123
        },
        'ConversationRetentionSettings': {
            'RetentionDays': 123
        }
    }
)
Parameters
  • AccountId (string) --

    [REQUIRED]

    The Amazon Chime account ID.

  • RetentionSettings (dict) --

    [REQUIRED]

    The retention settings.

    • RoomRetentionSettings (dict) --

      The chat room retention settings.

      • RetentionDays (integer) --

        The number of days for which to retain chat room messages.

    • ConversationRetentionSettings (dict) --

      The chat conversation retention settings.

      • RetentionDays (integer) --

        The number of days for which to retain chat conversation messages.

Return type

dict

Returns

Response Syntax

{
    'RetentionSettings': {
        'RoomRetentionSettings': {
            'RetentionDays': 123
        },
        'ConversationRetentionSettings': {
            'RetentionDays': 123
        }
    },
    'InitiateDeletionTimestamp': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    • RetentionSettings (dict) --

      The retention settings.

      • RoomRetentionSettings (dict) --

        The chat room retention settings.

        • RetentionDays (integer) --

          The number of days for which to retain chat room messages.

      • ConversationRetentionSettings (dict) --

        The chat conversation retention settings.

        • RetentionDays (integer) --

          The number of days for which to retain chat conversation messages.

    • InitiateDeletionTimestamp (datetime) --

      The timestamp representing the time at which the specified items are permanently deleted, in ISO 8601 format.

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.ConflictException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
put_sip_media_application_logging_configuration(**kwargs)

Updates the logging configuration for the specified SIP media application.

See also: AWS API Documentation

Request Syntax

response = client.put_sip_media_application_logging_configuration(
    SipMediaApplicationId='string',
    SipMediaApplicationLoggingConfiguration={
        'EnableSipMediaApplicationMessageLogs': True|False
    }
)
Parameters
  • SipMediaApplicationId (string) --

    [REQUIRED]

    The ID of the specified SIP media application

  • SipMediaApplicationLoggingConfiguration (dict) --

    The actual logging configuration.

    • EnableSipMediaApplicationMessageLogs (boolean) --

      Enables application message logs for the SIP media application.

Return type

dict

Returns

Response Syntax

{
    'SipMediaApplicationLoggingConfiguration': {
        'EnableSipMediaApplicationMessageLogs': True|False
    }
}

Response Structure

  • (dict) --

    • SipMediaApplicationLoggingConfiguration (dict) --

      The actual logging configuration.

      • EnableSipMediaApplicationMessageLogs (boolean) --

        Enables application message logs for the SIP media application.

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
put_voice_connector_emergency_calling_configuration(**kwargs)

Puts emergency calling configuration details to the specified Amazon Chime Voice Connector, such as emergency phone numbers and calling countries. Origination and termination settings must be enabled for the Amazon Chime Voice Connector before emergency calling can be configured.

See also: AWS API Documentation

Request Syntax

response = client.put_voice_connector_emergency_calling_configuration(
    VoiceConnectorId='string',
    EmergencyCallingConfiguration={
        'DNIS': [
            {
                'EmergencyPhoneNumber': 'string',
                'TestPhoneNumber': 'string',
                'CallingCountry': 'string'
            },
        ]
    }
)
Parameters
  • VoiceConnectorId (string) --

    [REQUIRED]

    The Amazon Chime Voice Connector ID.

  • EmergencyCallingConfiguration (dict) --

    [REQUIRED]

    The emergency calling configuration details.

    • DNIS (list) --

      The Dialed Number Identification Service (DNIS) emergency calling configuration details.

      • (dict) --

        The Dialed Number Identification Service (DNIS) emergency calling configuration details associated with an Amazon Chime Voice Connector's emergency calling configuration.

        • EmergencyPhoneNumber (string) -- [REQUIRED]

          The DNIS phone number to route emergency calls to, in E.164 format.

        • TestPhoneNumber (string) --

          The DNIS phone number to route test emergency calls to, in E.164 format.

        • CallingCountry (string) -- [REQUIRED]

          The country from which emergency calls are allowed, in ISO 3166-1 alpha-2 format.

Return type

dict

Returns

Response Syntax

{
    'EmergencyCallingConfiguration': {
        'DNIS': [
            {
                'EmergencyPhoneNumber': 'string',
                'TestPhoneNumber': 'string',
                'CallingCountry': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) --

    • EmergencyCallingConfiguration (dict) --

      The emergency calling configuration details.

      • DNIS (list) --

        The Dialed Number Identification Service (DNIS) emergency calling configuration details.

        • (dict) --

          The Dialed Number Identification Service (DNIS) emergency calling configuration details associated with an Amazon Chime Voice Connector's emergency calling configuration.

          • EmergencyPhoneNumber (string) --

            The DNIS phone number to route emergency calls to, in E.164 format.

          • TestPhoneNumber (string) --

            The DNIS phone number to route test emergency calls to, in E.164 format.

          • CallingCountry (string) --

            The country from which emergency calls are allowed, in ISO 3166-1 alpha-2 format.

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
put_voice_connector_logging_configuration(**kwargs)

Adds a logging configuration for the specified Amazon Chime Voice Connector. The logging configuration specifies whether SIP message logs are enabled for sending to Amazon CloudWatch Logs.

See also: AWS API Documentation

Request Syntax

response = client.put_voice_connector_logging_configuration(
    VoiceConnectorId='string',
    LoggingConfiguration={
        'EnableSIPLogs': True|False
    }
)
Parameters
  • VoiceConnectorId (string) --

    [REQUIRED]

    The Amazon Chime Voice Connector ID.

  • LoggingConfiguration (dict) --

    [REQUIRED]

    The logging configuration details to add.

    • EnableSIPLogs (boolean) --

      When true, enables SIP message logs for sending to Amazon CloudWatch Logs.

Return type

dict

Returns

Response Syntax

{
    'LoggingConfiguration': {
        'EnableSIPLogs': True|False
    }
}

Response Structure

  • (dict) --

    • LoggingConfiguration (dict) --

      The updated logging configuration details.

      • EnableSIPLogs (boolean) --

        When true, enables SIP message logs for sending to Amazon CloudWatch Logs.

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
put_voice_connector_origination(**kwargs)

Adds origination settings for the specified Amazon Chime Voice Connector.

Note

If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to turning off origination settings.

See also: AWS API Documentation

Request Syntax

response = client.put_voice_connector_origination(
    VoiceConnectorId='string',
    Origination={
        'Routes': [
            {
                'Host': 'string',
                'Port': 123,
                'Protocol': 'TCP'|'UDP',
                'Priority': 123,
                'Weight': 123
            },
        ],
        'Disabled': True|False
    }
)
Parameters
  • VoiceConnectorId (string) --

    [REQUIRED]

    The Amazon Chime Voice Connector ID.

  • Origination (dict) --

    [REQUIRED]

    The origination setting details to add.

    • Routes (list) --

      The call distribution properties defined for your SIP hosts. Valid range: Minimum value of 1. Maximum value of 20.

      • (dict) --

        Origination routes define call distribution properties for your SIP hosts to receive inbound calls using your Amazon Chime Voice Connector. Limit: Ten origination routes for each Amazon Chime Voice Connector.

        • Host (string) --

          The FQDN or IP address to contact for origination traffic.

        • Port (integer) --

          The designated origination route port. Defaults to 5060.

        • Protocol (string) --

          The protocol to use for the origination route. Encryption-enabled Amazon Chime Voice Connectors use TCP protocol by default.

        • Priority (integer) --

          The priority associated with the host, with 1 being the highest priority. Higher priority hosts are attempted first.

        • Weight (integer) --

          The weight associated with the host. If hosts are equal in priority, calls are distributed among them based on their relative weight.

    • Disabled (boolean) --

      When origination settings are disabled, inbound calls are not enabled for your Amazon Chime Voice Connector.

Return type

dict

Returns

Response Syntax

{
    'Origination': {
        'Routes': [
            {
                'Host': 'string',
                'Port': 123,
                'Protocol': 'TCP'|'UDP',
                'Priority': 123,
                'Weight': 123
            },
        ],
        'Disabled': True|False
    }
}

Response Structure

  • (dict) --

    • Origination (dict) --

      The updated origination setting details.

      • Routes (list) --

        The call distribution properties defined for your SIP hosts. Valid range: Minimum value of 1. Maximum value of 20.

        • (dict) --

          Origination routes define call distribution properties for your SIP hosts to receive inbound calls using your Amazon Chime Voice Connector. Limit: Ten origination routes for each Amazon Chime Voice Connector.

          • Host (string) --

            The FQDN or IP address to contact for origination traffic.

          • Port (integer) --

            The designated origination route port. Defaults to 5060.

          • Protocol (string) --

            The protocol to use for the origination route. Encryption-enabled Amazon Chime Voice Connectors use TCP protocol by default.

          • Priority (integer) --

            The priority associated with the host, with 1 being the highest priority. Higher priority hosts are attempted first.

          • Weight (integer) --

            The weight associated with the host. If hosts are equal in priority, calls are distributed among them based on their relative weight.

      • Disabled (boolean) --

        When origination settings are disabled, inbound calls are not enabled for your Amazon Chime Voice Connector.

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
put_voice_connector_proxy(**kwargs)

Puts the specified proxy configuration to the specified Amazon Chime Voice Connector.

See also: AWS API Documentation

Request Syntax

response = client.put_voice_connector_proxy(
    VoiceConnectorId='string',
    DefaultSessionExpiryMinutes=123,
    PhoneNumberPoolCountries=[
        'string',
    ],
    FallBackPhoneNumber='string',
    Disabled=True|False
)
Parameters
  • VoiceConnectorId (string) --

    [REQUIRED]

    The Amazon Chime voice connector ID.

  • DefaultSessionExpiryMinutes (integer) --

    [REQUIRED]

    The default number of minutes allowed for proxy sessions.

  • PhoneNumberPoolCountries (list) --

    [REQUIRED]

    The countries for proxy phone numbers to be selected from.

    • (string) --
  • FallBackPhoneNumber (string) -- The phone number to route calls to after a proxy session expires.
  • Disabled (boolean) -- When true, stops proxy sessions from being created on the specified Amazon Chime Voice Connector.
Return type

dict

Returns

Response Syntax

{
    'Proxy': {
        'DefaultSessionExpiryMinutes': 123,
        'Disabled': True|False,
        'FallBackPhoneNumber': 'string',
        'PhoneNumberCountries': [
            'string',
        ]
    }
}

Response Structure

  • (dict) --

    • Proxy (dict) --

      The proxy configuration details.

      • DefaultSessionExpiryMinutes (integer) --

        The default number of minutes allowed for proxy sessions.

      • Disabled (boolean) --

        When true, stops proxy sessions from being created on the specified Amazon Chime Voice Connector.

      • FallBackPhoneNumber (string) --

        The phone number to route calls to after a proxy session expires.

      • PhoneNumberCountries (list) --

        The countries for proxy phone numbers to be selected from.

        • (string) --

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.AccessDeniedException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
put_voice_connector_streaming_configuration(**kwargs)

Adds a streaming configuration for the specified Amazon Chime Voice Connector. The streaming configuration specifies whether media streaming is enabled for sending to Amazon Kinesis. It also sets the retention period, in hours, for the Amazon Kinesis data.

See also: AWS API Documentation

Request Syntax

response = client.put_voice_connector_streaming_configuration(
    VoiceConnectorId='string',
    StreamingConfiguration={
        'DataRetentionInHours': 123,
        'Disabled': True|False,
        'StreamingNotificationTargets': [
            {
                'NotificationTarget': 'EventBridge'|'SNS'|'SQS'
            },
        ]
    }
)
Parameters
  • VoiceConnectorId (string) --

    [REQUIRED]

    The Amazon Chime Voice Connector ID.

  • StreamingConfiguration (dict) --

    [REQUIRED]

    The streaming configuration details to add.

    • DataRetentionInHours (integer) -- [REQUIRED]

      The retention period, in hours, for the Amazon Kinesis data.

    • Disabled (boolean) --

      When true, media streaming to Amazon Kinesis is turned off.

    • StreamingNotificationTargets (list) --

      The streaming notification targets.

      • (dict) --

        The targeted recipient for a streaming configuration notification.

        • NotificationTarget (string) -- [REQUIRED]

          The streaming notification target.

Return type

dict

Returns

Response Syntax

{
    'StreamingConfiguration': {
        'DataRetentionInHours': 123,
        'Disabled': True|False,
        'StreamingNotificationTargets': [
            {
                'NotificationTarget': 'EventBridge'|'SNS'|'SQS'
            },
        ]
    }
}

Response Structure

  • (dict) --

    • StreamingConfiguration (dict) --

      The updated streaming configuration details.

      • DataRetentionInHours (integer) --

        The retention period, in hours, for the Amazon Kinesis data.

      • Disabled (boolean) --

        When true, media streaming to Amazon Kinesis is turned off.

      • StreamingNotificationTargets (list) --

        The streaming notification targets.

        • (dict) --

          The targeted recipient for a streaming configuration notification.

          • NotificationTarget (string) --

            The streaming notification target.

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
put_voice_connector_termination(**kwargs)

Adds termination settings for the specified Amazon Chime Voice Connector.

Note

If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to turning off termination settings.

See also: AWS API Documentation

Request Syntax

response = client.put_voice_connector_termination(
    VoiceConnectorId='string',
    Termination={
        'CpsLimit': 123,
        'DefaultPhoneNumber': 'string',
        'CallingRegions': [
            'string',
        ],
        'CidrAllowedList': [
            'string',
        ],
        'Disabled': True|False
    }
)
Parameters
  • VoiceConnectorId (string) --

    [REQUIRED]

    The Amazon Chime Voice Connector ID.

  • Termination (dict) --

    [REQUIRED]

    The termination setting details to add.

    • CpsLimit (integer) --

      The limit on calls per second. Max value based on account service quota. Default value of 1.

    • DefaultPhoneNumber (string) --

      The default caller ID phone number.

    • CallingRegions (list) --

      The countries to which calls are allowed, in ISO 3166-1 alpha-2 format. Required.

      • (string) --
    • CidrAllowedList (list) --

      The IP addresses allowed to make calls, in CIDR format. Required.

      • (string) --
    • Disabled (boolean) --

      When termination settings are disabled, outbound calls can not be made.

Return type

dict

Returns

Response Syntax

{
    'Termination': {
        'CpsLimit': 123,
        'DefaultPhoneNumber': 'string',
        'CallingRegions': [
            'string',
        ],
        'CidrAllowedList': [
            'string',
        ],
        'Disabled': True|False
    }
}

Response Structure

  • (dict) --

    • Termination (dict) --

      The updated termination setting details.

      • CpsLimit (integer) --

        The limit on calls per second. Max value based on account service quota. Default value of 1.

      • DefaultPhoneNumber (string) --

        The default caller ID phone number.

      • CallingRegions (list) --

        The countries to which calls are allowed, in ISO 3166-1 alpha-2 format. Required.

        • (string) --
      • CidrAllowedList (list) --

        The IP addresses allowed to make calls, in CIDR format. Required.

        • (string) --
      • Disabled (boolean) --

        When termination settings are disabled, outbound calls can not be made.

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.AccessDeniedException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
put_voice_connector_termination_credentials(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.put_voice_connector_termination_credentials(
    VoiceConnectorId='string',
    Credentials=[
        {
            'Username': 'string',
            'Password': 'string'
        },
    ]
)
Parameters
  • VoiceConnectorId (string) --

    [REQUIRED]

    The Amazon Chime Voice Connector ID.

  • Credentials (list) --

    The termination SIP credentials.

    • (dict) --

      The SIP credentials used to authenticate requests to your Amazon Chime Voice Connector.

      • Username (string) --

        The RFC2617 compliant user name associated with the SIP credentials, in US-ASCII format.

      • Password (string) --

        The RFC2617 compliant password associated with the SIP credentials, in US-ASCII format.

Returns

None

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
redact_channel_message(**kwargs)

Redacts message content, but not metadata. The message exists in the back end, but the action returns null content, and the state shows as redacted.

See also: AWS API Documentation

Request Syntax

response = client.redact_channel_message(
    ChannelArn='string',
    MessageId='string'
)
Parameters
  • ChannelArn (string) --

    [REQUIRED]

    The ARN of the channel containing the messages that you want to redact.

  • MessageId (string) --

    [REQUIRED]

    The ID of the message being redacted.

Return type

dict

Returns

Response Syntax

{
    'ChannelArn': 'string',
    'MessageId': 'string'
}

Response Structure

  • (dict) --

    • ChannelArn (string) --

      The ARN of the channel containing the messages that you want to redact.

    • MessageId (string) --

      The ID of the message being redacted.

Exceptions

  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
redact_conversation_message(**kwargs)

Redacts the specified message from the specified Amazon Chime conversation.

See also: AWS API Documentation

Request Syntax

response = client.redact_conversation_message(
    AccountId='string',
    ConversationId='string',
    MessageId='string'
)
Parameters
  • AccountId (string) --

    [REQUIRED]

    The Amazon Chime account ID.

  • ConversationId (string) --

    [REQUIRED]

    The conversation ID.

  • MessageId (string) --

    [REQUIRED]

    The message ID.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
redact_room_message(**kwargs)

Redacts the specified message from the specified Amazon Chime channel.

See also: AWS API Documentation

Request Syntax

response = client.redact_room_message(
    AccountId='string',
    RoomId='string',
    MessageId='string'
)
Parameters
  • AccountId (string) --

    [REQUIRED]

    The Amazon Chime account ID.

  • RoomId (string) --

    [REQUIRED]

    The room ID.

  • MessageId (string) --

    [REQUIRED]

    The message ID.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
regenerate_security_token(**kwargs)

Regenerates the security token for a bot.

See also: AWS API Documentation

Request Syntax

response = client.regenerate_security_token(
    AccountId='string',
    BotId='string'
)
Parameters
  • AccountId (string) --

    [REQUIRED]

    The Amazon Chime account ID.

  • BotId (string) --

    [REQUIRED]

    The bot ID.

Return type

dict

Returns

Response Syntax

{
    'Bot': {
        'BotId': 'string',
        'UserId': 'string',
        'DisplayName': 'string',
        'BotType': 'ChatBot',
        'Disabled': True|False,
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1),
        'BotEmail': 'string',
        'SecurityToken': 'string'
    }
}

Response Structure

  • (dict) --

    • Bot (dict) --

      A resource that allows Enterprise account administrators to configure an interface to receive events from Amazon Chime.

      • BotId (string) --

        The bot ID.

      • UserId (string) --

        The unique ID for the bot user.

      • DisplayName (string) --

        The bot display name.

      • BotType (string) --

        The bot type.

      • Disabled (boolean) --

        When true, the bot is stopped from running in your account.

      • CreatedTimestamp (datetime) --

        The bot creation timestamp, in ISO 8601 format.

      • UpdatedTimestamp (datetime) --

        The updated bot timestamp, in ISO 8601 format.

      • BotEmail (string) --

        The bot email address.

      • SecurityToken (string) --

        The security token used to authenticate Amazon Chime with the outgoing event endpoint.

Exceptions

  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.ThrottledClientException
reset_personal_pin(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.reset_personal_pin(
    AccountId='string',
    UserId='string'
)
Parameters
  • AccountId (string) --

    [REQUIRED]

    The Amazon Chime account ID.

  • UserId (string) --

    [REQUIRED]

    The user ID.

Return type

dict

Returns

Response Syntax

{
    'User': {
        'UserId': 'string',
        'AccountId': 'string',
        'PrimaryEmail': 'string',
        'PrimaryProvisionedNumber': 'string',
        'DisplayName': 'string',
        'LicenseType': 'Basic'|'Plus'|'Pro'|'ProTrial',
        'UserType': 'PrivateUser'|'SharedDevice',
        'UserRegistrationStatus': 'Unregistered'|'Registered'|'Suspended',
        'UserInvitationStatus': 'Pending'|'Accepted'|'Failed',
        'RegisteredOn': datetime(2015, 1, 1),
        'InvitedOn': datetime(2015, 1, 1),
        'AlexaForBusinessMetadata': {
            'IsAlexaForBusinessEnabled': True|False,
            'AlexaForBusinessRoomArn': 'string'
        },
        'PersonalPIN': 'string'
    }
}

Response Structure

  • (dict) --

    • User (dict) --

      The user details and new personal meeting PIN.

      • UserId (string) --

        The user ID.

      • AccountId (string) --

        The Amazon Chime account ID.

      • PrimaryEmail (string) --

        The primary email address of the user.

      • PrimaryProvisionedNumber (string) --

        The primary phone number associated with the user.

      • DisplayName (string) --

        The display name of the user.

      • LicenseType (string) --

        The license type for the user.

      • UserType (string) --

        The user type.

      • UserRegistrationStatus (string) --

        The user registration status.

      • UserInvitationStatus (string) --

        The user invite status.

      • RegisteredOn (datetime) --

        Date and time when the user is registered, in ISO 8601 format.

      • InvitedOn (datetime) --

        Date and time when the user is invited to the Amazon Chime account, in ISO 8601 format.

      • AlexaForBusinessMetadata (dict) --

        The Alexa for Business metadata.

        • IsAlexaForBusinessEnabled (boolean) --

          Starts or stops Alexa for Business.

        • AlexaForBusinessRoomArn (string) --

          The ARN of the room resource.

      • PersonalPIN (string) --

        The user's personal meeting PIN.

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
restore_phone_number(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.restore_phone_number(
    PhoneNumberId='string'
)
Parameters
PhoneNumberId (string) --

[REQUIRED]

The phone number.

Return type
dict
Returns
Response Syntax
{
    'PhoneNumber': {
        'PhoneNumberId': 'string',
        'E164PhoneNumber': 'string',
        'Type': 'Local'|'TollFree',
        'ProductType': 'BusinessCalling'|'VoiceConnector',
        'Status': 'AcquireInProgress'|'AcquireFailed'|'Unassigned'|'Assigned'|'ReleaseInProgress'|'DeleteInProgress'|'ReleaseFailed'|'DeleteFailed',
        'Capabilities': {
            'InboundCall': True|False,
            'OutboundCall': True|False,
            'InboundSMS': True|False,
            'OutboundSMS': True|False,
            'InboundMMS': True|False,
            'OutboundMMS': True|False
        },
        'Associations': [
            {
                'Value': 'string',
                'Name': 'AccountId'|'UserId'|'VoiceConnectorId'|'VoiceConnectorGroupId'|'SipRuleId',
                'AssociatedTimestamp': datetime(2015, 1, 1)
            },
        ],
        'CallingName': 'string',
        'CallingNameStatus': 'Unassigned'|'UpdateInProgress'|'UpdateSucceeded'|'UpdateFailed',
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1),
        'DeletionTimestamp': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) --
    • PhoneNumber (dict) --

      The phone number details.

      • PhoneNumberId (string) --

        The phone number ID.

      • E164PhoneNumber (string) --

        The phone number, in E.164 format.

      • Type (string) --

        The phone number type.

      • ProductType (string) --

        The phone number product type.

      • Status (string) --

        The phone number status.

      • Capabilities (dict) --

        The phone number capabilities.

        • InboundCall (boolean) --

          Allows or denies inbound calling for the specified phone number.

        • OutboundCall (boolean) --

          Allows or denies outbound calling for the specified phone number.

        • InboundSMS (boolean) --

          Allows or denies inbound SMS messaging for the specified phone number.

        • OutboundSMS (boolean) --

          Allows or denies outbound SMS messaging for the specified phone number.

        • InboundMMS (boolean) --

          Allows or denies inbound MMS messaging for the specified phone number.

        • OutboundMMS (boolean) --

          Allows or denies outbound MMS messaging for the specified phone number.

      • Associations (list) --

        The phone number associations.

        • (dict) --

          The phone number associations, such as Amazon Chime account ID, Amazon Chime user ID, Amazon Chime Voice Connector ID, or Amazon Chime Voice Connector group ID.

          • Value (string) --

            Contains the ID for the entity specified in Name.

          • Name (string) --

            Defines the association with an Amazon Chime account ID, user ID, Amazon Chime Voice Connector ID, or Amazon Chime Voice Connector group ID.

          • AssociatedTimestamp (datetime) --

            The timestamp of the phone number association, in ISO 8601 format.

      • CallingName (string) --

        The outbound calling name associated with the phone number.

      • CallingNameStatus (string) --

        The outbound calling name status.

      • CreatedTimestamp (datetime) --

        The phone number creation timestamp, in ISO 8601 format.

      • UpdatedTimestamp (datetime) --

        The updated phone number timestamp, in ISO 8601 format.

      • DeletionTimestamp (datetime) --

        The deleted phone number timestamp, in ISO 8601 format.

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ResourceLimitExceededException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
search_available_phone_numbers(**kwargs)

Searches phone numbers that can be ordered.

See also: AWS API Documentation

Request Syntax

response = client.search_available_phone_numbers(
    AreaCode='string',
    City='string',
    Country='string',
    State='string',
    TollFreePrefix='string',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • AreaCode (string) -- The area code used to filter results.
  • City (string) -- The city used to filter results.
  • Country (string) -- The country used to filter results.
  • State (string) -- The state used to filter results.
  • TollFreePrefix (string) -- The toll-free prefix that you use to filter results.
  • MaxResults (integer) -- The maximum number of results to return in a single call.
  • NextToken (string) -- The token to use to retrieve the next page of results.
Return type

dict

Returns

Response Syntax

{
    'E164PhoneNumbers': [
        'string',
    ]
}

Response Structure

  • (dict) --

    • E164PhoneNumbers (list) --

      List of phone numbers, in E.164 format.

      • (string) --

Exceptions

  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.AccessDeniedException
  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
send_channel_message(**kwargs)

Sends a message to a particular channel that the member is a part of.

Note

STANDARD messages can contain 4KB of data and the 1KB of metadata. CONTROL messages can contain 30 bytes of data and no metadata.

See also: AWS API Documentation

Request Syntax

response = client.send_channel_message(
    ChannelArn='string',
    Content='string',
    Type='STANDARD'|'CONTROL',
    Persistence='PERSISTENT'|'NON_PERSISTENT',
    Metadata='string',
    ClientRequestToken='string'
)
Parameters
  • ChannelArn (string) --

    [REQUIRED]

    The ARN of the channel.

  • Content (string) --

    [REQUIRED]

    The content of the message.

  • Type (string) --

    [REQUIRED]

    The type of message, STANDARD or CONTROL .

  • Persistence (string) --

    [REQUIRED]

    Boolean that controls whether the message is persisted on the back end. Required.

  • Metadata (string) -- The optional metadata for each message.
  • ClientRequestToken (string) --

    [REQUIRED]

    The Idempotency token for each client request.

    This field is autopopulated if not provided.

Return type

dict

Returns

Response Syntax

{
    'ChannelArn': 'string',
    'MessageId': 'string'
}

Response Structure

  • (dict) --

    • ChannelArn (string) --

      The ARN of the channel.

    • MessageId (string) --

      The ID string assigned to each message.

Exceptions

  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ConflictException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
tag_attendee(**kwargs)

Applies the specified tags to the specified Amazon Chime SDK attendee.

See also: AWS API Documentation

Request Syntax

response = client.tag_attendee(
    MeetingId='string',
    AttendeeId='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters
  • MeetingId (string) --

    [REQUIRED]

    The Amazon Chime SDK meeting ID.

  • AttendeeId (string) --

    [REQUIRED]

    The Amazon Chime SDK attendee ID.

  • Tags (list) --

    [REQUIRED]

    The tag key-value pairs.

    • (dict) --

      Describes a tag applied to a resource.

      • Key (string) -- [REQUIRED]

        The key of the tag.

      • Value (string) -- [REQUIRED]

        The value of the tag.

Returns

None

Exceptions

  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.ResourceLimitExceededException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
tag_meeting(**kwargs)

Applies the specified tags to the specified Amazon Chime SDK meeting.

See also: AWS API Documentation

Request Syntax

response = client.tag_meeting(
    MeetingId='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters
  • MeetingId (string) --

    [REQUIRED]

    The Amazon Chime SDK meeting ID.

  • Tags (list) --

    [REQUIRED]

    The tag key-value pairs.

    • (dict) --

      Describes a tag applied to a resource.

      • Key (string) -- [REQUIRED]

        The key of the tag.

      • Value (string) -- [REQUIRED]

        The value of the tag.

Returns

None

Exceptions

  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.ResourceLimitExceededException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
tag_resource(**kwargs)

Applies the specified tags to the specified Amazon Chime SDK meeting resource.

See also: AWS API Documentation

Request Syntax

response = client.tag_resource(
    ResourceARN='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters
  • ResourceARN (string) --

    [REQUIRED]

    The resource ARN.

  • Tags (list) --

    [REQUIRED]

    The tag key-value pairs.

    • (dict) --

      Describes a tag applied to a resource.

      • Key (string) -- [REQUIRED]

        The key of the tag.

      • Value (string) -- [REQUIRED]

        The value of the tag.

Returns

None

Exceptions

  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
untag_attendee(**kwargs)

Untags the specified tags from the specified Amazon Chime SDK attendee.

See also: AWS API Documentation

Request Syntax

response = client.untag_attendee(
    MeetingId='string',
    AttendeeId='string',
    TagKeys=[
        'string',
    ]
)
Parameters
  • MeetingId (string) --

    [REQUIRED]

    The Amazon Chime SDK meeting ID.

  • AttendeeId (string) --

    [REQUIRED]

    The Amazon Chime SDK attendee ID.

  • TagKeys (list) --

    [REQUIRED]

    The tag keys.

    • (string) --
Returns

None

Exceptions

  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
untag_meeting(**kwargs)

Untags the specified tags from the specified Amazon Chime SDK meeting.

See also: AWS API Documentation

Request Syntax

response = client.untag_meeting(
    MeetingId='string',
    TagKeys=[
        'string',
    ]
)
Parameters
  • MeetingId (string) --

    [REQUIRED]

    The Amazon Chime SDK meeting ID.

  • TagKeys (list) --

    [REQUIRED]

    The tag keys.

    • (string) --
Returns

None

Exceptions

  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
untag_resource(**kwargs)

Untags the specified tags from the specified Amazon Chime SDK meeting resource.

See also: AWS API Documentation

Request Syntax

response = client.untag_resource(
    ResourceARN='string',
    TagKeys=[
        'string',
    ]
)
Parameters
  • ResourceARN (string) --

    [REQUIRED]

    The resource ARN.

  • TagKeys (list) --

    [REQUIRED]

    The tag keys.

    • (string) --
Returns

None

Exceptions

  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
update_account(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.update_account(
    AccountId='string',
    Name='string'
)
Parameters
  • AccountId (string) --

    [REQUIRED]

    The Amazon Chime account ID.

  • Name (string) -- The new name for the specified Amazon Chime account.
Return type

dict

Returns

Response Syntax

{
    'Account': {
        'AwsAccountId': 'string',
        'AccountId': 'string',
        'Name': 'string',
        'AccountType': 'Team'|'EnterpriseDirectory'|'EnterpriseLWA'|'EnterpriseOIDC',
        'CreatedTimestamp': datetime(2015, 1, 1),
        'DefaultLicense': 'Basic'|'Plus'|'Pro'|'ProTrial',
        'SupportedLicenses': [
            'Basic'|'Plus'|'Pro'|'ProTrial',
        ],
        'SigninDelegateGroups': [
            {
                'GroupName': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) --

    • Account (dict) --

      The Amazon Chime account details. An AWS account can have multiple Amazon Chime accounts.

      • AwsAccountId (string) --

        The AWS account ID.

      • AccountId (string) --

        The Amazon Chime account ID.

      • Name (string) --

        The Amazon Chime account name.

      • AccountType (string) --

        The Amazon Chime account type. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide .

      • CreatedTimestamp (datetime) --

        The Amazon Chime account creation timestamp, in ISO 8601 format.

      • DefaultLicense (string) --

        The default license for the Amazon Chime account.

      • SupportedLicenses (list) --

        Supported licenses for the Amazon Chime account.

        • (string) --
      • SigninDelegateGroups (list) --

        The sign-in delegate groups associated with the account.

        • (dict) --

          An Active Directory (AD) group whose members are granted permission to act as delegates.

          • GroupName (string) --

            The group name.

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
update_account_settings(**kwargs)

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 .

See also: AWS API Documentation

Request Syntax

response = client.update_account_settings(
    AccountId='string',
    AccountSettings={
        'DisableRemoteControl': True|False,
        'EnableDialOut': True|False
    }
)
Parameters
  • AccountId (string) --

    [REQUIRED]

    The Amazon Chime account ID.

  • AccountSettings (dict) --

    [REQUIRED]

    The Amazon Chime account settings to update.

    • DisableRemoteControl (boolean) --

      Setting that stops or starts remote control of shared screens during meetings.

    • EnableDialOut (boolean) --

      Setting that allows meeting participants to choose the Call me at a phone number option. For more information, see Join a Meeting without the Amazon Chime App .

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.ConflictException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
update_app_instance(**kwargs)

Updates AppInstance metadata.

See also: AWS API Documentation

Request Syntax

response = client.update_app_instance(
    AppInstanceArn='string',
    Name='string',
    Metadata='string'
)
Parameters
  • AppInstanceArn (string) --

    [REQUIRED]

    The ARN of the app instance.

  • Name (string) --

    [REQUIRED]

    The name that you want to change.

  • Metadata (string) -- The metadata that you want to change.
Return type

dict

Returns

Response Syntax

{
    'AppInstanceArn': 'string'
}

Response Structure

  • (dict) --

    • AppInstanceArn (string) --

      The ARN of the app instance.

Exceptions

  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ConflictException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
update_app_instance_user(**kwargs)

Updates the details for an AppInstanceUser . You can update names and metadata.

See also: AWS API Documentation

Request Syntax

response = client.update_app_instance_user(
    AppInstanceUserArn='string',
    Name='string',
    Metadata='string'
)
Parameters
  • AppInstanceUserArn (string) --

    [REQUIRED]

    The ARN of the app instance user.

  • Name (string) --

    [REQUIRED]

    The name of the app instance user.

  • Metadata (string) -- The metadata of the app instance user.
Return type

dict

Returns

Response Syntax

{
    'AppInstanceUserArn': 'string'
}

Response Structure

  • (dict) --

    • AppInstanceUserArn (string) --

      The ARN of the app instance user.

Exceptions

  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ConflictException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
update_bot(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.update_bot(
    AccountId='string',
    BotId='string',
    Disabled=True|False
)
Parameters
  • AccountId (string) --

    [REQUIRED]

    The Amazon Chime account ID.

  • BotId (string) --

    [REQUIRED]

    The bot ID.

  • Disabled (boolean) -- When true, stops the specified bot from running in your account.
Return type

dict

Returns

Response Syntax

{
    'Bot': {
        'BotId': 'string',
        'UserId': 'string',
        'DisplayName': 'string',
        'BotType': 'ChatBot',
        'Disabled': True|False,
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1),
        'BotEmail': 'string',
        'SecurityToken': 'string'
    }
}

Response Structure

  • (dict) --

    • Bot (dict) --

      The updated bot details.

      • BotId (string) --

        The bot ID.

      • UserId (string) --

        The unique ID for the bot user.

      • DisplayName (string) --

        The bot display name.

      • BotType (string) --

        The bot type.

      • Disabled (boolean) --

        When true, the bot is stopped from running in your account.

      • CreatedTimestamp (datetime) --

        The bot creation timestamp, in ISO 8601 format.

      • UpdatedTimestamp (datetime) --

        The updated bot timestamp, in ISO 8601 format.

      • BotEmail (string) --

        The bot email address.

      • SecurityToken (string) --

        The security token used to authenticate Amazon Chime with the outgoing event endpoint.

Exceptions

  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.ThrottledClientException
update_channel(**kwargs)

Update a channel's attributes.

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

See also: AWS API Documentation

Request Syntax

response = client.update_channel(
    ChannelArn='string',
    Name='string',
    Mode='UNRESTRICTED'|'RESTRICTED',
    Metadata='string'
)
Parameters
  • ChannelArn (string) --

    [REQUIRED]

    The ARN of the channel.

  • Name (string) --

    [REQUIRED]

    The name of the channel.

  • Mode (string) --

    [REQUIRED]

    The mode of the update request.

  • Metadata (string) -- The metadata of the channel.
Return type

dict

Returns

Response Syntax

{
    'ChannelArn': 'string'
}

Response Structure

  • (dict) --

    • ChannelArn (string) --

      The ARN of the channel.

Exceptions

  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.ConflictException
  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
update_channel_message(**kwargs)

Updates the content of a message.

See also: AWS API Documentation

Request Syntax

response = client.update_channel_message(
    ChannelArn='string',
    MessageId='string',
    Content='string',
    Metadata='string'
)
Parameters
  • ChannelArn (string) --

    [REQUIRED]

    The ARN of the channel.

  • MessageId (string) --

    [REQUIRED]

    The ID string of the message being updated.

  • Content (string) -- The content of the message being updated.
  • Metadata (string) -- The metadata of the message being updated.
Return type

dict

Returns

Response Syntax

{
    'ChannelArn': 'string',
    'MessageId': 'string'
}

Response Structure

  • (dict) --

    • ChannelArn (string) --

      The ARN of the channel.

    • MessageId (string) --

      The ID string of the message being updated.

Exceptions

  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ConflictException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
update_channel_read_marker(**kwargs)

Sets the timestamp to the point when a user last read messages in a channel.

See also: AWS API Documentation

Request Syntax

response = client.update_channel_read_marker(
    ChannelArn='string'
)
Parameters
ChannelArn (string) --

[REQUIRED]

The ARN of the channel.

Return type
dict
Returns
Response Syntax
{
    'ChannelArn': 'string'
}

Response Structure

  • (dict) --
    • ChannelArn (string) --

      The ARN of the channel.

Exceptions

  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.ConflictException
  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
update_global_settings(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.update_global_settings(
    BusinessCalling={
        'CdrBucket': 'string'
    },
    VoiceConnector={
        'CdrBucket': 'string'
    }
)
Parameters
  • BusinessCalling (dict) --

    [REQUIRED]

    The Amazon Chime Business Calling settings.

    • CdrBucket (string) --

      The Amazon S3 bucket designated for call detail record storage.

  • VoiceConnector (dict) --

    [REQUIRED]

    The Amazon Chime Voice Connector settings.

    • CdrBucket (string) --

      The Amazon S3 bucket designated for call detail record storage.

Returns

None

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
update_phone_number(**kwargs)

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 must use the Amazon Chime Voice Connector 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.

See also: AWS API Documentation

Request Syntax

response = client.update_phone_number(
    PhoneNumberId='string',
    ProductType='BusinessCalling'|'VoiceConnector',
    CallingName='string'
)
Parameters
  • PhoneNumberId (string) --

    [REQUIRED]

    The phone number ID.

  • ProductType (string) -- The product type.
  • CallingName (string) -- The outbound calling name associated with the phone number.
Return type

dict

Returns

Response Syntax

{
    'PhoneNumber': {
        'PhoneNumberId': 'string',
        'E164PhoneNumber': 'string',
        'Type': 'Local'|'TollFree',
        'ProductType': 'BusinessCalling'|'VoiceConnector',
        'Status': 'AcquireInProgress'|'AcquireFailed'|'Unassigned'|'Assigned'|'ReleaseInProgress'|'DeleteInProgress'|'ReleaseFailed'|'DeleteFailed',
        'Capabilities': {
            'InboundCall': True|False,
            'OutboundCall': True|False,
            'InboundSMS': True|False,
            'OutboundSMS': True|False,
            'InboundMMS': True|False,
            'OutboundMMS': True|False
        },
        'Associations': [
            {
                'Value': 'string',
                'Name': 'AccountId'|'UserId'|'VoiceConnectorId'|'VoiceConnectorGroupId'|'SipRuleId',
                'AssociatedTimestamp': datetime(2015, 1, 1)
            },
        ],
        'CallingName': 'string',
        'CallingNameStatus': 'Unassigned'|'UpdateInProgress'|'UpdateSucceeded'|'UpdateFailed',
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1),
        'DeletionTimestamp': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) --

    • PhoneNumber (dict) --

      The updated phone number details.

      • PhoneNumberId (string) --

        The phone number ID.

      • E164PhoneNumber (string) --

        The phone number, in E.164 format.

      • Type (string) --

        The phone number type.

      • ProductType (string) --

        The phone number product type.

      • Status (string) --

        The phone number status.

      • Capabilities (dict) --

        The phone number capabilities.

        • InboundCall (boolean) --

          Allows or denies inbound calling for the specified phone number.

        • OutboundCall (boolean) --

          Allows or denies outbound calling for the specified phone number.

        • InboundSMS (boolean) --

          Allows or denies inbound SMS messaging for the specified phone number.

        • OutboundSMS (boolean) --

          Allows or denies outbound SMS messaging for the specified phone number.

        • InboundMMS (boolean) --

          Allows or denies inbound MMS messaging for the specified phone number.

        • OutboundMMS (boolean) --

          Allows or denies outbound MMS messaging for the specified phone number.

      • Associations (list) --

        The phone number associations.

        • (dict) --

          The phone number associations, such as Amazon Chime account ID, Amazon Chime user ID, Amazon Chime Voice Connector ID, or Amazon Chime Voice Connector group ID.

          • Value (string) --

            Contains the ID for the entity specified in Name.

          • Name (string) --

            Defines the association with an Amazon Chime account ID, user ID, Amazon Chime Voice Connector ID, or Amazon Chime Voice Connector group ID.

          • AssociatedTimestamp (datetime) --

            The timestamp of the phone number association, in ISO 8601 format.

      • CallingName (string) --

        The outbound calling name associated with the phone number.

      • CallingNameStatus (string) --

        The outbound calling name status.

      • CreatedTimestamp (datetime) --

        The phone number creation timestamp, in ISO 8601 format.

      • UpdatedTimestamp (datetime) --

        The updated phone number timestamp, in ISO 8601 format.

      • DeletionTimestamp (datetime) --

        The deleted phone number timestamp, in ISO 8601 format.

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
update_phone_number_settings(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.update_phone_number_settings(
    CallingName='string'
)
Parameters
CallingName (string) --

[REQUIRED]

The default outbound calling name for the account.

Returns
None

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
update_proxy_session(**kwargs)

Updates the specified proxy session details, such as voice or SMS capabilities.

See also: AWS API Documentation

Request Syntax

response = client.update_proxy_session(
    VoiceConnectorId='string',
    ProxySessionId='string',
    Capabilities=[
        'Voice'|'SMS',
    ],
    ExpiryMinutes=123
)
Parameters
  • VoiceConnectorId (string) --

    [REQUIRED]

    The Amazon Chime voice connector ID.

  • ProxySessionId (string) --

    [REQUIRED]

    The proxy session ID.

  • Capabilities (list) --

    [REQUIRED]

    The proxy session capabilities.

    • (string) --
  • ExpiryMinutes (integer) -- The number of minutes allowed for the proxy session.
Return type

dict

Returns

Response Syntax

{
    'ProxySession': {
        'VoiceConnectorId': 'string',
        'ProxySessionId': 'string',
        'Name': 'string',
        'Status': 'Open'|'InProgress'|'Closed',
        'ExpiryMinutes': 123,
        'Capabilities': [
            'Voice'|'SMS',
        ],
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1),
        'EndedTimestamp': datetime(2015, 1, 1),
        'Participants': [
            {
                'PhoneNumber': 'string',
                'ProxyPhoneNumber': 'string'
            },
        ],
        'NumberSelectionBehavior': 'PreferSticky'|'AvoidSticky',
        'GeoMatchLevel': 'Country'|'AreaCode',
        'GeoMatchParams': {
            'Country': 'string',
            'AreaCode': 'string'
        }
    }
}

Response Structure

  • (dict) --

    • ProxySession (dict) --

      The proxy session details.

      • VoiceConnectorId (string) --

        The Amazon Chime voice connector ID.

      • ProxySessionId (string) --

        The proxy session ID.

      • Name (string) --

        The name of the proxy session.

      • Status (string) --

        The status of the proxy session.

      • ExpiryMinutes (integer) --

        The number of minutes allowed for the proxy session.

      • Capabilities (list) --

        The proxy session capabilities.

        • (string) --
      • CreatedTimestamp (datetime) --

        The created timestamp, in ISO 8601 format.

      • UpdatedTimestamp (datetime) --

        The updated timestamp, in ISO 8601 format.

      • EndedTimestamp (datetime) --

        The ended timestamp, in ISO 8601 format.

      • Participants (list) --

        The proxy session participants.

        • (dict) --

          The phone number and proxy phone number for a participant in an Amazon Chime Voice Connector proxy session.

          • PhoneNumber (string) --

            The participant's phone number.

          • ProxyPhoneNumber (string) --

            The participant's proxy phone number.

      • NumberSelectionBehavior (string) --

        The preference for proxy phone number reuse, or stickiness, between the same participants across sessions.

      • GeoMatchLevel (string) --

        The preference for matching the country or area code of the proxy phone number with that of the first participant.

      • GeoMatchParams (dict) --

        The country and area code for the proxy phone number.

        • Country (string) --

          The country.

        • AreaCode (string) --

          The area code.

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
update_room(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.update_room(
    AccountId='string',
    RoomId='string',
    Name='string'
)
Parameters
  • AccountId (string) --

    [REQUIRED]

    The Amazon Chime account ID.

  • RoomId (string) --

    [REQUIRED]

    The room ID.

  • Name (string) -- The room name.
Return type

dict

Returns

Response Syntax

{
    'Room': {
        'RoomId': 'string',
        'Name': 'string',
        'AccountId': 'string',
        'CreatedBy': 'string',
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) --

    • Room (dict) --

      The room details.

      • RoomId (string) --

        The room ID.

      • Name (string) --

        The room name.

      • AccountId (string) --

        The Amazon Chime account ID.

      • CreatedBy (string) --

        The identifier of the room creator.

      • CreatedTimestamp (datetime) --

        The room creation timestamp, in ISO 8601 format.

      • UpdatedTimestamp (datetime) --

        The room update timestamp, in ISO 8601 format.

Exceptions

  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
update_room_membership(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.update_room_membership(
    AccountId='string',
    RoomId='string',
    MemberId='string',
    Role='Administrator'|'Member'
)
Parameters
  • AccountId (string) --

    [REQUIRED]

    The Amazon Chime account ID.

  • RoomId (string) --

    [REQUIRED]

    The room ID.

  • MemberId (string) --

    [REQUIRED]

    The member ID.

  • Role (string) -- The role of the member.
Return type

dict

Returns

Response Syntax

{
    'RoomMembership': {
        'RoomId': 'string',
        'Member': {
            'MemberId': 'string',
            'MemberType': 'User'|'Bot'|'Webhook',
            'Email': 'string',
            'FullName': 'string',
            'AccountId': 'string'
        },
        'Role': 'Administrator'|'Member',
        'InvitedBy': 'string',
        'UpdatedTimestamp': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) --

    • RoomMembership (dict) --

      The room membership details.

      • RoomId (string) --

        The room ID.

      • Member (dict) --

        The member details, such as email address, name, member ID, and member type.

        • MemberId (string) --

          The member ID (user ID or bot ID).

        • MemberType (string) --

          The member type.

        • Email (string) --

          The member email address.

        • FullName (string) --

          The member name.

        • AccountId (string) --

          The Amazon Chime account ID.

      • Role (string) --

        The membership role.

      • InvitedBy (string) --

        The identifier of the user that invited the room member.

      • UpdatedTimestamp (datetime) --

        The room membership update timestamp, in ISO 8601 format.

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
update_sip_media_application(**kwargs)

Updates the details for the specified SIP media application.

See also: AWS API Documentation

Request Syntax

response = client.update_sip_media_application(
    SipMediaApplicationId='string',
    Name='string',
    Endpoints=[
        {
            'LambdaArn': 'string'
        },
    ]
)
Parameters
  • SipMediaApplicationId (string) --

    [REQUIRED]

    The SIP media application ID.

  • Name (string) -- The new name for the specified SIP media application.
  • Endpoints (list) --

    The new set of endpoints for the specified SIP media application.

    • (dict) --

      Endpoints to specify as part of a SIP media application.

      • LambdaArn (string) --

        Valid Amazon Resource Name (ARN) of the Lambda function of the same AWS Region where the SIP media application is created.

Return type

dict

Returns

Response Syntax

{
    'SipMediaApplication': {
        'SipMediaApplicationId': 'string',
        'AwsRegion': 'string',
        'Name': 'string',
        'Endpoints': [
            {
                'LambdaArn': 'string'
            },
        ],
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) --

    • SipMediaApplication (dict) --

      The updated SIP media application details.

      • SipMediaApplicationId (string) --

        The SIP media application ID.

      • AwsRegion (string) --

        The AWS Region in which the SIP media application is created.

      • Name (string) --

        The name of the SIP media application.

      • Endpoints (list) --

        List of endpoints for SIP media application. Currently, only one endpoint per SIP media application is permitted.

        • (dict) --

          Endpoints to specify as part of a SIP media application.

          • LambdaArn (string) --

            Valid Amazon Resource Name (ARN) of the Lambda function of the same AWS Region where the SIP media application is created.

      • CreatedTimestamp (datetime) --

        The SIP media application creation timestamp, in ISO 8601 format.

      • UpdatedTimestamp (datetime) --

        The SIP media application updated timestamp, in ISO 8601 format.

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ConflictException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
update_sip_rule(**kwargs)

Updates the details for the specified SIP rule.

See also: AWS API Documentation

Request Syntax

response = client.update_sip_rule(
    SipRuleId='string',
    Name='string',
    Disabled=True|False,
    TargetApplications=[
        {
            'SipMediaApplicationId': 'string',
            'Priority': 123,
            'AwsRegion': 'string'
        },
    ]
)
Parameters
  • SipRuleId (string) --

    [REQUIRED]

    The SIP rule ID.

  • Name (string) --

    [REQUIRED]

    The new name for the specified SIP rule.

  • Disabled (boolean) -- The new value specified to indicate whether the rule is disabled.
  • TargetApplications (list) --

    The new value of the list of target applications.

    • (dict) --

      Target SIP media application along with other details like priority and AWS Region to be specified in the SIP rule. Only one SIP rule per AWS Region can be provided.

      • SipMediaApplicationId (string) --

        The SIP media application ID.

      • Priority (integer) --

        Priority of the SIP media application in the target list.

      • AwsRegion (string) --

        AWS Region of target application.

Return type

dict

Returns

Response Syntax

{
    'SipRule': {
        'SipRuleId': 'string',
        'Name': 'string',
        'Disabled': True|False,
        'TriggerType': 'ToPhoneNumber'|'RequestUriHostname',
        'TriggerValue': 'string',
        'TargetApplications': [
            {
                'SipMediaApplicationId': 'string',
                'Priority': 123,
                'AwsRegion': 'string'
            },
        ],
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) --

    • SipRule (dict) --

      Updated SIP rule details.

      • SipRuleId (string) --

        The SIP rule ID.

      • Name (string) --

        The name of the SIP rule.

      • Disabled (boolean) --

        Indicates if the SIP rule is enabled or disabled. You must disable a rule before you can delete it.

      • TriggerType (string) --

        The type of trigger whose value is assigned to the SIP rule in TriggerValue .

      • TriggerValue (string) --

        If TriggerType is RequestUriHostname , then the value can be the outbound host name of the Amazon Chime Voice Connector. If TriggerType is ToPhoneNumber , then the value can be a customer-owned phone number in E164 format. SipRule is triggered when a SIP rule requests host name or ToPhoneNumber matches in the incoming SIP request.

      • TargetApplications (list) --

        List of SIP media applications with priority and AWS Region. You can only use one SIP application per AWS Region and priority combination.

        • (dict) --

          Target SIP media application along with other details like priority and AWS Region to be specified in the SIP rule. Only one SIP rule per AWS Region can be provided.

          • SipMediaApplicationId (string) --

            The SIP media application ID.

          • Priority (integer) --

            Priority of the SIP media application in the target list.

          • AwsRegion (string) --

            AWS Region of target application.

      • CreatedTimestamp (datetime) --

        The SIP rule created timestamp, in ISO 8601 format.

      • UpdatedTimestamp (datetime) --

        The SIP rule updated timestamp, in ISO 8601 format.

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ConflictException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ResourceLimitExceededException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
update_user(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.update_user(
    AccountId='string',
    UserId='string',
    LicenseType='Basic'|'Plus'|'Pro'|'ProTrial',
    UserType='PrivateUser'|'SharedDevice',
    AlexaForBusinessMetadata={
        'IsAlexaForBusinessEnabled': True|False,
        'AlexaForBusinessRoomArn': 'string'
    }
)
Parameters
  • AccountId (string) --

    [REQUIRED]

    The Amazon Chime account ID.

  • UserId (string) --

    [REQUIRED]

    The user ID.

  • LicenseType (string) -- The user license type to update. This must be a supported license type for the Amazon Chime account that the user belongs to.
  • UserType (string) -- The user type.
  • AlexaForBusinessMetadata (dict) --

    The Alexa for Business metadata.

    • IsAlexaForBusinessEnabled (boolean) --

      Starts or stops Alexa for Business.

    • AlexaForBusinessRoomArn (string) --

      The ARN of the room resource.

Return type

dict

Returns

Response Syntax

{
    'User': {
        'UserId': 'string',
        'AccountId': 'string',
        'PrimaryEmail': 'string',
        'PrimaryProvisionedNumber': 'string',
        'DisplayName': 'string',
        'LicenseType': 'Basic'|'Plus'|'Pro'|'ProTrial',
        'UserType': 'PrivateUser'|'SharedDevice',
        'UserRegistrationStatus': 'Unregistered'|'Registered'|'Suspended',
        'UserInvitationStatus': 'Pending'|'Accepted'|'Failed',
        'RegisteredOn': datetime(2015, 1, 1),
        'InvitedOn': datetime(2015, 1, 1),
        'AlexaForBusinessMetadata': {
            'IsAlexaForBusinessEnabled': True|False,
            'AlexaForBusinessRoomArn': 'string'
        },
        'PersonalPIN': 'string'
    }
}

Response Structure

  • (dict) --

    • User (dict) --

      The updated user details.

      • UserId (string) --

        The user ID.

      • AccountId (string) --

        The Amazon Chime account ID.

      • PrimaryEmail (string) --

        The primary email address of the user.

      • PrimaryProvisionedNumber (string) --

        The primary phone number associated with the user.

      • DisplayName (string) --

        The display name of the user.

      • LicenseType (string) --

        The license type for the user.

      • UserType (string) --

        The user type.

      • UserRegistrationStatus (string) --

        The user registration status.

      • UserInvitationStatus (string) --

        The user invite status.

      • RegisteredOn (datetime) --

        Date and time when the user is registered, in ISO 8601 format.

      • InvitedOn (datetime) --

        Date and time when the user is invited to the Amazon Chime account, in ISO 8601 format.

      • AlexaForBusinessMetadata (dict) --

        The Alexa for Business metadata.

        • IsAlexaForBusinessEnabled (boolean) --

          Starts or stops Alexa for Business.

        • AlexaForBusinessRoomArn (string) --

          The ARN of the room resource.

      • PersonalPIN (string) --

        The user's personal meeting PIN.

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
update_user_settings(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.update_user_settings(
    AccountId='string',
    UserId='string',
    UserSettings={
        'Telephony': {
            'InboundCalling': True|False,
            'OutboundCalling': True|False,
            'SMS': True|False
        }
    }
)
Parameters
  • AccountId (string) --

    [REQUIRED]

    The Amazon Chime account ID.

  • UserId (string) --

    [REQUIRED]

    The user ID.

  • UserSettings (dict) --

    [REQUIRED]

    The user settings to update.

    • Telephony (dict) -- [REQUIRED]

      The telephony settings associated with the user.

      • InboundCalling (boolean) -- [REQUIRED]

        Allows or denies inbound calling.

      • OutboundCalling (boolean) -- [REQUIRED]

        Allows or denies outbound calling.

      • SMS (boolean) -- [REQUIRED]

        Allows or denies SMS messaging.

Returns

None

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
update_voice_connector(**kwargs)

Updates details for the specified Amazon Chime Voice Connector.

See also: AWS API Documentation

Request Syntax

response = client.update_voice_connector(
    VoiceConnectorId='string',
    Name='string',
    RequireEncryption=True|False
)
Parameters
  • VoiceConnectorId (string) --

    [REQUIRED]

    The Amazon Chime Voice Connector ID.

  • Name (string) --

    [REQUIRED]

    The name of the Amazon Chime Voice Connector.

  • RequireEncryption (boolean) --

    [REQUIRED]

    When enabled, requires encryption for the Amazon Chime Voice Connector.

Return type

dict

Returns

Response Syntax

{
    'VoiceConnector': {
        'VoiceConnectorId': 'string',
        'AwsRegion': 'us-east-1'|'us-west-2',
        'Name': 'string',
        'OutboundHostName': 'string',
        'RequireEncryption': True|False,
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) --

    • VoiceConnector (dict) --

      The updated Amazon Chime Voice Connector details.

      • VoiceConnectorId (string) --

        The Amazon Chime Voice Connector ID.

      • AwsRegion (string) --

        The AWS Region in which the Amazon Chime Voice Connector is created. Default: us-east-1 .

      • Name (string) --

        The name of the Amazon Chime Voice Connector.

      • OutboundHostName (string) --

        The outbound host name for the Amazon Chime Voice Connector.

      • RequireEncryption (boolean) --

        Designates whether encryption is required for the Amazon Chime Voice Connector.

      • CreatedTimestamp (datetime) --

        The Amazon Chime Voice Connector creation timestamp, in ISO 8601 format.

      • UpdatedTimestamp (datetime) --

        The updated Amazon Chime Voice Connector timestamp, in ISO 8601 format.

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException
  • Chime.Client.exceptions.NotFoundException
  • Chime.Client.exceptions.ForbiddenException
  • Chime.Client.exceptions.BadRequestException
  • Chime.Client.exceptions.ThrottledClientException
  • Chime.Client.exceptions.ServiceUnavailableException
  • Chime.Client.exceptions.ServiceFailureException
update_voice_connector_group(**kwargs)

Updates details for the specified Amazon Chime Voice Connector group, such as the name and Amazon Chime Voice Connector priority ranking.

See also: AWS API Documentation

Request Syntax

response = client.update_voice_connector_group(
    VoiceConnectorGroupId='string',
    Name='string',
    VoiceConnectorItems=[
        {
            'VoiceConnectorId': 'string',
            'Priority': 123
        },
    ]
)
Parameters
  • VoiceConnectorGroupId (string) --

    [REQUIRED]

    The Amazon Chime Voice Connector group ID.

  • Name (string) --

    [REQUIRED]

    The name of the Amazon Chime Voice Connector group.

  • VoiceConnectorItems (list) --

    [REQUIRED]

    The VoiceConnectorItems to associate with the group.

    • (dict) --

      For Amazon Chime Voice Connector groups, the Amazon Chime Voice Connectors to which to route inbound calls. Includes priority configuration settings. Limit: 3 VoiceConnectorItems per Amazon Chime Voice Connector group.

      • VoiceConnectorId (string) -- [REQUIRED]

        The Amazon Chime Voice Connector ID.

      • Priority (integer) -- [REQUIRED]

        The priority associated with the Amazon Chime Voice Connector, with 1 being the highest priority. Higher priority Amazon Chime Voice Connectors are attempted first.

Return type

dict

Returns

Response Syntax

{
    'VoiceConnectorGroup': {
        'VoiceConnectorGroupId': 'string',
        'Name': 'string',
        'VoiceConnectorItems': [
            {
                'VoiceConnectorId': 'string',
                'Priority': 123
            },
        ],
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) --

    • VoiceConnectorGroup (dict) --

      The updated Amazon Chime Voice Connector group details.

      • VoiceConnectorGroupId (string) --

        The Amazon Chime Voice Connector group ID.

      • Name (string) --

        The name of the Amazon Chime Voice Connector group.

      • VoiceConnectorItems (list) --

        The Amazon Chime Voice Connectors to which to route inbound calls.

        • (dict) --

          For Amazon Chime Voice Connector groups, the Amazon Chime Voice Connectors to which to route inbound calls. Includes priority configuration settings. Limit: 3 VoiceConnectorItems per Amazon Chime Voice Connector group.

          • VoiceConnectorId (string) --

            The Amazon Chime Voice Connector ID.

          • Priority (integer) --

            The priority associated wit