Amazon Chime

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

client.update_global_settings(
    BusinessCalling={
        'CdrBucket': 'string'
    },
    VoiceConnector={
        'CdrBucket': 'string'
    }
)

type BusinessCalling:

dict

param BusinessCalling:

[REQUIRED]

The Amazon Chime Business Calling settings.

• CdrBucket (string) --

  The Amazon S3 bucket designated for call detail record storage.

type VoiceConnector:

dict

param VoiceConnector:

[REQUIRED]

The Amazon Chime Voice Connector settings.

• CdrBucket (string) --

  The Amazon S3 bucket designated for call detail record storage.

returns:

None

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

See also: AWS API Documentation

Request Syntax

client.delete_voice_connector_termination(
    VoiceConnectorId='string'
)

type VoiceConnectorId:

string

param VoiceConnectorId:

[REQUIRED]

The Amazon Chime Voice Connector ID.

returns:

None

Adds origination settings for the specified Amazon Chime Voice Connector.

See also: AWS API Documentation

Request Syntax

client.put_voice_connector_origination(
    VoiceConnectorId='string',
    Origination={
        'Routes': [
            {
                'Host': 'string',
                'Port': 123,
                'Protocol': 'TCP'|'UDP',
                'Priority': 123,
                'Weight': 123
            },
        ],
        'Disabled': True|False
    }
)

type VoiceConnectorId:

string

param VoiceConnectorId:

[REQUIRED]

The Amazon Chime Voice Connector ID.

type Origination:

dict

param Origination:

[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: 10 origination routes per Amazon Chime Voice Connector.

    • Host (string) --

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

rtype:

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: 10 origination routes per Amazon Chime Voice Connector.

        • Host (string) --

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

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

client.get_voice_connector_termination_health(
    VoiceConnectorId='string'
)

type VoiceConnectorId:

string

param VoiceConnectorId:

[REQUIRED]

The Amazon Chime Voice Connector ID.

rtype:

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.

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

See also: AWS API Documentation

Request Syntax

client.list_phone_number_orders(
    NextToken='string',
    MaxResults=123
)

type NextToken:

string

param NextToken:

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

type MaxResults:

integer

param MaxResults:

The maximum number of results to return in a single call.

rtype:

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.

Creates an Amazon Chime Voice Connector under the administrator's AWS account. Enabling CreateVoiceConnectorRequest$RequireEncryption configures your Amazon Chime Voice Connector to use TLS transport for SIP signaling and Secure RTP (SRTP) for media. Inbound calls use TLS transport, and unencrypted outbound calls are blocked.

See also: AWS API Documentation

Request Syntax

client.create_voice_connector(
    Name='string',
    RequireEncryption=True|False
)

type Name:

string

param Name:

[REQUIRED]

The name of the Amazon Chime Voice Connector.

type RequireEncryption:

boolean

param RequireEncryption:

[REQUIRED]

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

rtype:

dict

returns:

Response Syntax

{
    'VoiceConnector': {
        'VoiceConnectorId': 'string',
        '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.

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

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

See also: AWS API Documentation

Request Syntax

client.put_voice_connector_termination_credentials(
    VoiceConnectorId='string',
    Credentials=[
        {
            'Username': 'string',
            'Password': 'string'
        },
    ]
)

type VoiceConnectorId:

string

param VoiceConnectorId:

[REQUIRED]

The Amazon Chime Voice Connector ID.

type Credentials:

list

param Credentials:

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

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

See also: AWS API Documentation

Request Syntax

client.disassociate_phone_numbers_from_voice_connector(
    VoiceConnectorId='string',
    E164PhoneNumbers=[
        'string',
    ]
)

type VoiceConnectorId:

string

param VoiceConnectorId:

[REQUIRED]

The Amazon Chime Voice Connector ID.

type E164PhoneNumbers:

list

param E164PhoneNumbers:

List of phone numbers, in E.164 format.

• (string) --

rtype:

dict

returns:

Response Syntax

{
    'PhoneNumberErrors': [
        {
            'PhoneNumberId': 'string',
            'ErrorCode': 'Unauthorized'|'Forbidden'|'NotFound'|'BadRequest'|'Conflict'|'ServiceFailure'|'ServiceUnavailable'|'Unprocessable'|'Throttled'|'PreconditionFailed',
            '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.

Updates phone number product types. Choose from Amazon Chime Business Calling and Amazon Chime Voice Connector product types.

See also: AWS API Documentation

Request Syntax

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

type UpdatePhoneNumberRequestItems:

list

param UpdatePhoneNumberRequestItems:

[REQUIRED]

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

• (dict) --

  The phone number ID and product type 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.

rtype:

dict

returns:

Response Syntax

{
    'PhoneNumberErrors': [
        {
            'PhoneNumberId': 'string',
            'ErrorCode': 'Unauthorized'|'Forbidden'|'NotFound'|'BadRequest'|'Conflict'|'ServiceFailure'|'ServiceUnavailable'|'Unprocessable'|'Throttled'|'PreconditionFailed',
            '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.

Creates an order for phone numbers to be provisioned. Choose from Amazon Chime Business Calling and Amazon Chime Voice Connector product types.

See also: AWS API Documentation

Request Syntax

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

type ProductType:

string

param ProductType:

[REQUIRED]

The phone number product type.

type E164PhoneNumbers:

list

param E164PhoneNumbers:

[REQUIRED]

List of phone numbers, in E.164 format.

• (string) --

rtype:

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.

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

See also: AWS API Documentation

Request Syntax

client.list_voice_connectors(
    NextToken='string',
    MaxResults=123
)

type NextToken:

string

param NextToken:

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

type MaxResults:

integer

param MaxResults:

The maximum number of results to return in a single call.

rtype:

dict

returns:

Response Syntax

{
    'VoiceConnectors': [
        {
            'VoiceConnectorId': 'string',
            '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.

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

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

See also: AWS API Documentation

Request Syntax

client.get_voice_connector_termination(
    VoiceConnectorId='string'
)

type VoiceConnectorId:

string

param VoiceConnectorId:

[REQUIRED]

The Amazon Chime Voice Connector ID.

rtype:

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 limit. Default value of 1.

    • DefaultPhoneNumber (string) --

      The default caller ID phone number.

    • CallingRegions (list) --

      The countries to which calls are allowed.

      • (string) --

    • CidrAllowedList (list) --

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

      • (string) --

    • Disabled (boolean) --

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

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

See also: AWS API Documentation

Request Syntax

client.get_voice_connector_origination(
    VoiceConnectorId='string'
)

type VoiceConnectorId:

string

param VoiceConnectorId:

[REQUIRED]

The Amazon Chime Voice Connector ID.

rtype:

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: 10 origination routes per Amazon Chime Voice Connector.

        • Host (string) --

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

Adds termination settings for the specified Amazon Chime Voice Connector.

See also: AWS API Documentation

Request Syntax

client.put_voice_connector_termination(
    VoiceConnectorId='string',
    Termination={
        'CpsLimit': 123,
        'DefaultPhoneNumber': 'string',
        'CallingRegions': [
            'string',
        ],
        'CidrAllowedList': [
            'string',
        ],
        'Disabled': True|False
    }
)

type VoiceConnectorId:

string

param VoiceConnectorId:

[REQUIRED]

The Amazon Chime Voice Connector ID.

type Termination:

dict

param Termination:

[REQUIRED]

The termination setting details to add.

• CpsLimit (integer) --

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

• DefaultPhoneNumber (string) --

  The default caller ID phone number.

• CallingRegions (list) --

  The countries to which calls are allowed.

  • (string) --

• CidrAllowedList (list) --

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

  • (string) --

• Disabled (boolean) --

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

rtype:

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 limit. Default value of 1.

    • DefaultPhoneNumber (string) --

      The default caller ID phone number.

    • CallingRegions (list) --

      The countries to which calls are allowed.

      • (string) --

    • CidrAllowedList (list) --

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

      • (string) --

    • Disabled (boolean) --

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

Updates details for the specified Amazon Chime Voice Connector.

See also: AWS API Documentation

Request Syntax

client.update_voice_connector(
    VoiceConnectorId='string',
    Name='string',
    RequireEncryption=True|False
)

type VoiceConnectorId:

string

param VoiceConnectorId:

[REQUIRED]

The Amazon Chime Voice Connector ID.

type Name:

string

param Name:

[REQUIRED]

The name of the Amazon Chime Voice Connector.

type RequireEncryption:

boolean

param RequireEncryption:

[REQUIRED]

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

rtype:

dict

returns:

Response Syntax

{
    'VoiceConnector': {
        'VoiceConnectorId': 'string',
        '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.

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

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

See also: AWS API Documentation

Request Syntax

client.update_user_settings(
    AccountId='string',
    UserId='string',
    UserSettings={
        'Telephony': {
            'InboundCalling': True|False,
            'OutboundCalling': True|False,
            'SMS': True|False
        }
    }
)

type AccountId:

string

param AccountId:

[REQUIRED]

The Amazon Chime account ID.

type UserId:

string

param UserId:

[REQUIRED]

The user ID.

type UserSettings:

dict

param UserSettings:

[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

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

client.delete_phone_number(
    PhoneNumberId='string'
)

type PhoneNumberId:

string

param PhoneNumberId:

[REQUIRED]

The phone number ID.

returns:

None

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

See also: AWS API Documentation

Request Syntax

client.get_user_settings(
    AccountId='string',
    UserId='string'
)

type AccountId:

string

param AccountId:

[REQUIRED]

The Amazon Chime account ID.

type UserId:

string

param UserId:

[REQUIRED]

The user ID.

rtype:

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.

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

See also: AWS API Documentation

Request Syntax

client.list_phone_numbers(
    Status='AcquireInProgress'|'AcquireFailed'|'Unassigned'|'Assigned'|'ReleaseInProgress'|'DeleteInProgress'|'ReleaseFailed'|'DeleteFailed',
    ProductType='BusinessCalling'|'VoiceConnector',
    FilterName='AccountId'|'UserId'|'VoiceConnectorId',
    FilterValue='string',
    MaxResults=123,
    NextToken='string'
)

type Status:

string

param Status:

The phone number status.

type ProductType:

string

param ProductType:

The phone number product type.

type FilterName:

string

param FilterName:

The filter to use to limit the number of results.

type FilterValue:

string

param FilterValue:

The value to use for the filter.

type MaxResults:

integer

param MaxResults:

The maximum number of results to return in a single call.

type NextToken:

string

param NextToken:

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

rtype:

dict

returns:

Response Syntax

{
    'PhoneNumbers': [
        {
            'PhoneNumberId': 'string',
            'E164PhoneNumber': 'string',
            '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',
                    'AssociatedTimestamp': datetime(2015, 1, 1)
                },
            ],
            '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.

      • 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, or Amazon Chime Voice Connector 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, or Amazon Chime Voice Connector ID.

          • AssociatedTimestamp (datetime) --

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

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

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

See also: AWS API Documentation

Request Syntax

client.restore_phone_number(
    PhoneNumberId='string'
)

type PhoneNumberId:

string

param PhoneNumberId:

[REQUIRED]

The phone number.

rtype:

dict

returns:

Response Syntax

{
    'PhoneNumber': {
        'PhoneNumberId': 'string',
        'E164PhoneNumber': 'string',
        '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',
                'AssociatedTimestamp': datetime(2015, 1, 1)
            },
        ],
        '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.

    • 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, or Amazon Chime Voice Connector 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, or Amazon Chime Voice Connector ID.

        • AssociatedTimestamp (datetime) --

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

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

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

client.get_global_settings()

rtype:

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.

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

See also: AWS API Documentation

Request Syntax

client.associate_phone_numbers_with_voice_connector(
    VoiceConnectorId='string',
    E164PhoneNumbers=[
        'string',
    ]
)

type VoiceConnectorId:

string

param VoiceConnectorId:

[REQUIRED]

The Amazon Chime Voice Connector ID.

type E164PhoneNumbers:

list

param E164PhoneNumbers:

List of phone numbers, in E.164 format.

• (string) --

rtype:

dict

returns:

Response Syntax

{
    'PhoneNumberErrors': [
        {
            'PhoneNumberId': 'string',
            'ErrorCode': 'Unauthorized'|'Forbidden'|'NotFound'|'BadRequest'|'Conflict'|'ServiceFailure'|'ServiceUnavailable'|'Unprocessable'|'Throttled'|'PreconditionFailed',
            '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.

Searches phone numbers that can be ordered.

See also: AWS API Documentation

Request Syntax

client.search_available_phone_numbers(
    AreaCode='string',
    City='string',
    Country='string',
    State='string',
    MaxResults=123,
    NextToken='string'
)

type AreaCode:

string

param AreaCode:

The area code used to filter results.

type City:

string

param City:

The city used to filter results.

type Country:

string

param Country:

The country used to filter results.

type State:

string

param State:

The state used to filter results.

type MaxResults:

integer

param MaxResults:

The maximum number of results to return in a single call.

type NextToken:

string

param NextToken:

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

rtype:

dict

returns:

Response Syntax

{
    'E164PhoneNumbers': [
        'string',
    ]
}

Response Structure

• (dict) --

  • E164PhoneNumbers (list) --

    List of phone numbers, in E.164 format.

    • (string) --

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

See also: AWS API Documentation

Request Syntax

client.disassociate_phone_number_from_user(
    AccountId='string',
    UserId='string'
)

type AccountId:

string

param AccountId:

[REQUIRED]

The Amazon Chime account ID.

type UserId:

string

param UserId:

[REQUIRED]

The user ID.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

• (dict) --

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

client.batch_delete_phone_number(
    PhoneNumberIds=[
        'string',
    ]
)

type PhoneNumberIds:

list

param PhoneNumberIds:

[REQUIRED]

List of phone number IDs.

• (string) --

rtype:

dict

returns:

Response Syntax

{
    'PhoneNumberErrors': [
        {
            'PhoneNumberId': 'string',
            'ErrorCode': 'Unauthorized'|'Forbidden'|'NotFound'|'BadRequest'|'Conflict'|'ServiceFailure'|'ServiceUnavailable'|'Unprocessable'|'Throttled'|'PreconditionFailed',
            '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.

Deletes the specified Amazon Chime Voice Connector. Any phone numbers assigned to the Amazon Chime Voice Connector must be unassigned from it before it can be deleted.

See also: AWS API Documentation

Request Syntax

client.delete_voice_connector(
    VoiceConnectorId='string'
)

type VoiceConnectorId:

string

param VoiceConnectorId:

[REQUIRED]

The Amazon Chime Voice Connector ID.

returns:

None

Updates phone number details, such as product type, for the specified phone number ID.

See also: AWS API Documentation

Request Syntax

client.update_phone_number(
    PhoneNumberId='string',
    ProductType='BusinessCalling'|'VoiceConnector'
)

type PhoneNumberId:

string

param PhoneNumberId:

[REQUIRED]

The phone number ID.

type ProductType:

string

param ProductType:

The product type.

rtype:

dict

returns:

Response Syntax

{
    'PhoneNumber': {
        'PhoneNumberId': 'string',
        'E164PhoneNumber': 'string',
        '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',
                'AssociatedTimestamp': datetime(2015, 1, 1)
            },
        ],
        '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.

    • 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, or Amazon Chime Voice Connector 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, or Amazon Chime Voice Connector ID.

        • AssociatedTimestamp (datetime) --

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

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

Associates a phone number with the specified Amazon Chime user.

See also: AWS API Documentation

Request Syntax

client.associate_phone_number_with_user(
    AccountId='string',
    UserId='string',
    E164PhoneNumber='string'
)

type AccountId:

string

param AccountId:

[REQUIRED]

The Amazon Chime account ID.

type UserId:

string

param UserId:

[REQUIRED]

The user ID.

type E164PhoneNumber:

string

param E164PhoneNumber:

[REQUIRED]

The phone number, in E.164 format.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

• (dict) --

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

client.get_voice_connector(
    VoiceConnectorId='string'
)

type VoiceConnectorId:

string

param VoiceConnectorId:

[REQUIRED]

The Amazon Chime Voice Connector ID.

rtype:

dict

returns:

Response Syntax

{
    'VoiceConnector': {
        'VoiceConnectorId': 'string',
        '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.

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

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

client.get_phone_number_order(
    PhoneNumberOrderId='string'
)

type PhoneNumberOrderId:

string

param PhoneNumberOrderId:

[REQUIRED]

The ID for the phone number order.

rtype:

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.

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

See also: AWS API Documentation

Request Syntax

client.delete_voice_connector_origination(
    VoiceConnectorId='string'
)

type VoiceConnectorId:

string

param VoiceConnectorId:

[REQUIRED]

The Amazon Chime Voice Connector ID.

returns:

None

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

See also: AWS API Documentation

Request Syntax

client.list_voice_connector_termination_credentials(
    VoiceConnectorId='string'
)

type VoiceConnectorId:

string

param VoiceConnectorId:

[REQUIRED]

The Amazon Chime Voice Connector ID.

rtype:

dict

returns:

Response Syntax

{
    'Usernames': [
        'string',
    ]
}

Response Structure

• (dict) --

  • Usernames (list) --

    A list of user names.

    • (string) --

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

See also: AWS API Documentation

Request Syntax

client.delete_voice_connector_termination_credentials(
    VoiceConnectorId='string',
    Usernames=[
        'string',
    ]
)

type VoiceConnectorId:

string

param VoiceConnectorId:

[REQUIRED]

The Amazon Chime Voice Connector ID.

type Usernames:

list

param Usernames:

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

• (string) --

returns:

None

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

See also: AWS API Documentation

Request Syntax

client.get_phone_number(
    PhoneNumberId='string'
)

type PhoneNumberId:

string

param PhoneNumberId:

[REQUIRED]

The phone number ID.

rtype:

dict

returns:

Response Syntax

{
    'PhoneNumber': {
        'PhoneNumberId': 'string',
        'E164PhoneNumber': 'string',
        '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',
                'AssociatedTimestamp': datetime(2015, 1, 1)
            },
        ],
        '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.

    • 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, or Amazon Chime Voice Connector 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, or Amazon Chime Voice Connector ID.

        • AssociatedTimestamp (datetime) --

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

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

{'User': {'PrimaryProvisionedNumber': 'string'}}

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

client.get_user(
    AccountId='string',
    UserId='string'
)

type AccountId:

string

param AccountId:

[REQUIRED]

The Amazon Chime account ID.

type UserId:

string

param UserId:

[REQUIRED]

The user ID.

rtype:

dict

returns:

Response Syntax

{
    'User': {
        'UserId': 'string',
        'AccountId': 'string',
        'PrimaryEmail': 'string',
        'PrimaryProvisionedNumber': 'string',
        'DisplayName': 'string',
        'LicenseType': 'Basic'|'Plus'|'Pro'|'ProTrial',
        'UserRegistrationStatus': 'Unregistered'|'Registered'|'Suspended',
        'UserInvitationStatus': 'Pending'|'Accepted'|'Failed',
        'RegisteredOn': datetime(2015, 1, 1),
        'InvitedOn': datetime(2015, 1, 1),
        '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.

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

    • PersonalPIN (string) --

      The user's personal meeting PIN.

{'Users': {'PrimaryProvisionedNumber': 'string'}}

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

client.list_users(
    AccountId='string',
    UserEmail='string',
    MaxResults=123,
    NextToken='string'
)

type AccountId:

string

param AccountId:

[REQUIRED]

The Amazon Chime account ID.

type UserEmail:

string

param UserEmail:

Optional. The user email address used to filter results. Maximum 1.

type MaxResults:

integer

param MaxResults:

The maximum number of results to return in a single call. Defaults to 100.

type NextToken:

string

param NextToken:

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

rtype:

dict

returns:

Response Syntax

{
    'Users': [
        {
            'UserId': 'string',
            'AccountId': 'string',
            'PrimaryEmail': 'string',
            'PrimaryProvisionedNumber': 'string',
            'DisplayName': 'string',
            'LicenseType': 'Basic'|'Plus'|'Pro'|'ProTrial',
            'UserRegistrationStatus': 'Unregistered'|'Registered'|'Suspended',
            'UserInvitationStatus': 'Pending'|'Accepted'|'Failed',
            'RegisteredOn': datetime(2015, 1, 1),
            'InvitedOn': datetime(2015, 1, 1),
            '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.

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

      • PersonalPIN (string) --

        The user's personal meeting PIN.

  • NextToken (string) --

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

{'User': {'PrimaryProvisionedNumber': 'string'}}

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

client.reset_personal_pin(
    AccountId='string',
    UserId='string'
)

type AccountId:

string

param AccountId:

[REQUIRED]

The Amazon Chime account ID.

type UserId:

string

param UserId:

[REQUIRED]

The user ID.

rtype:

dict

returns:

Response Syntax

{
    'User': {
        'UserId': 'string',
        'AccountId': 'string',
        'PrimaryEmail': 'string',
        'PrimaryProvisionedNumber': 'string',
        'DisplayName': 'string',
        'LicenseType': 'Basic'|'Plus'|'Pro'|'ProTrial',
        'UserRegistrationStatus': 'Unregistered'|'Registered'|'Suspended',
        'UserInvitationStatus': 'Pending'|'Accepted'|'Failed',
        'RegisteredOn': datetime(2015, 1, 1),
        'InvitedOn': datetime(2015, 1, 1),
        '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.

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

    • PersonalPIN (string) --

      The user's personal meeting PIN.

{'User': {'PrimaryProvisionedNumber': 'string'}}

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

See also: AWS API Documentation

Request Syntax

client.update_user(
    AccountId='string',
    UserId='string',
    LicenseType='Basic'|'Plus'|'Pro'|'ProTrial'
)

type AccountId:

string

param AccountId:

[REQUIRED]

The Amazon Chime account ID.

type UserId:

string

param UserId:

[REQUIRED]

The user ID.

type LicenseType:

string

param LicenseType:

The user license type to update. This must be a supported license type for the Amazon Chime account that the user belongs to.

rtype:

dict

returns:

Response Syntax

{
    'User': {
        'UserId': 'string',
        'AccountId': 'string',
        'PrimaryEmail': 'string',
        'PrimaryProvisionedNumber': 'string',
        'DisplayName': 'string',
        'LicenseType': 'Basic'|'Plus'|'Pro'|'ProTrial',
        'UserRegistrationStatus': 'Unregistered'|'Registered'|'Suspended',
        'UserInvitationStatus': 'Pending'|'Accepted'|'Failed',
        'RegisteredOn': datetime(2015, 1, 1),
        'InvitedOn': datetime(2015, 1, 1),
        '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.

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

    • PersonalPIN (string) --

      The user's personal meeting PIN.