AWS API Changes

2019/10/24 - Amazon Chime - 14 new 15 updated api methods

Changes * This release introduces Voice Connector PDX region and defaults previously created Voice Connectors to IAD. You can create Voice Connector Groups and add region specific Voice Connectors to direct telephony traffic across AWS regions in case of regional failures. With this release you can add phone numbers to Voice Connector Groups and can bulk move phone numbers between Voice Connectors, between Voice Connector and Voice Connector Groups and between Voice Connector Groups. Voice Connector now supports additional settings to enable SIP Log capture. This is in addition to the launch of Voice Connector Cloud Watch metrics in this release. This release also supports assigning outbound calling name (CNAM) to AWS account and individual phone numbers assigned to Voice Connectors. * Voice Connector now supports a setting to enable real time audio streaming delivered via Kinesis Audio streams. Please note that recording Amazon Chime Voice Connector calls with this feature maybe be subject to laws or regulations regarding the recording of telephone calls and other electronic communications. AWS Customer and their end users' have the responsibility to comply with all applicable laws regarding the recording, including properly notifying all participants in a recorded session or to a recorded communication that the session or communication is being recorded and obtain their consent.

UpdatePhoneNumberSettings (new)

Link ¶

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

See also: AWS API Documentation

Request Syntax

client.update_phone_number_settings(
    CallingName='string'
)

type CallingName

string

param CallingName

[REQUIRED]

The default outbound calling name for the account.

returns

None

PutVoiceConnectorLoggingConfiguration (new)

Link ¶

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

client.put_voice_connector_logging_configuration(
    VoiceConnectorId='string',
    LoggingConfiguration={
        'EnableSIPLogs': True|False
    }
)

type VoiceConnectorId

string

param VoiceConnectorId

[REQUIRED]

The Amazon Chime Voice Connector ID.

type LoggingConfiguration

dict

param LoggingConfiguration

[REQUIRED]

The logging configuration details to add.

EnableSIPLogs (boolean) --

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

rtype

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.

GetVoiceConnectorLoggingConfiguration (new)

Link ¶

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

See also: AWS API Documentation

Request Syntax

client.get_voice_connector_logging_configuration(
    VoiceConnectorId='string'
)

type VoiceConnectorId

string

param VoiceConnectorId

[REQUIRED]

The Amazon Chime Voice Connector ID.

rtype

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.

GetPhoneNumberSettings (new)

Link ¶

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

client.get_phone_number_settings()

rtype

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.

GetVoiceConnectorGroup (new)

Link ¶

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

See also: AWS API Documentation

Request Syntax

client.get_voice_connector_group(
    VoiceConnectorGroupId='string'
)

type VoiceConnectorGroupId

string

param VoiceConnectorGroupId

[REQUIRED]

The Amazon Chime Voice Connector group ID.

rtype

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.

PutVoiceConnectorStreamingConfiguration (new)

Link ¶

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, and sets the retention period for the Amazon Kinesis data, in hours.

See also: AWS API Documentation

Request Syntax

client.put_voice_connector_streaming_configuration(
    VoiceConnectorId='string',
    StreamingConfiguration={
        'DataRetentionInHours': 123,
        'Disabled': True|False
    }
)

type VoiceConnectorId

string

param VoiceConnectorId

[REQUIRED]

The Amazon Chime Voice Connector ID.

type StreamingConfiguration

dict

param StreamingConfiguration

[REQUIRED]

The streaming configuration details to add.

DataRetentionInHours (integer) -- [REQUIRED]

The retention period for the Amazon Kinesis data, in hours.
Disabled (boolean) --

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

rtype

dict

returns

Response Syntax

{
    'StreamingConfiguration': {
        'DataRetentionInHours': 123,
        'Disabled': True|False
    }
}

Response Structure

(dict) --
- StreamingConfiguration (dict) --
  
  The updated streaming configuration details.
  - DataRetentionInHours (integer) --
    
    The retention period for the Amazon Kinesis data, in hours.
  - Disabled (boolean) --
    
    When true, media streaming to Amazon Kinesis is turned off.

AssociatePhoneNumbersWithVoiceConnectorGroup (new)

Link ¶

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

See also: AWS API Documentation

Request Syntax

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

type VoiceConnectorGroupId

string

param VoiceConnectorGroupId

[REQUIRED]

The Amazon Chime Voice Connector group ID.

type E164PhoneNumbers

list

param E164PhoneNumbers

List of phone numbers, in E.164 format.

(string) --

type ForceAssociate

boolean

param ForceAssociate

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.

rtype

dict

returns

Response Syntax

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

GetVoiceConnectorStreamingConfiguration (new)

Link ¶

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

See also: AWS API Documentation

Request Syntax

client.get_voice_connector_streaming_configuration(
    VoiceConnectorId='string'
)

type VoiceConnectorId

string

param VoiceConnectorId

[REQUIRED]

The Amazon Chime Voice Connector ID.

rtype

dict

returns

Response Syntax

{
    'StreamingConfiguration': {
        'DataRetentionInHours': 123,
        'Disabled': True|False
    }
}

Response Structure

(dict) --
- StreamingConfiguration (dict) --
  
  The streaming configuration details.
  - DataRetentionInHours (integer) --
    
    The retention period for the Amazon Kinesis data, in hours.
  - Disabled (boolean) --
    
    When true, media streaming to Amazon Kinesis is turned off.

CreateVoiceConnectorGroup (new)

Link ¶

Creates an Amazon Chime Voice Connector group under the administrator's AWS account. You can associate up to three existing 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

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

type Name

string

param Name

[REQUIRED]

The name of the Amazon Chime Voice Connector group.

type VoiceConnectorItems

list

param VoiceConnectorItems

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.

rtype

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.

DeleteVoiceConnectorGroup (new)

Link ¶

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

client.delete_voice_connector_group(
    VoiceConnectorGroupId='string'
)

type VoiceConnectorGroupId

string

param VoiceConnectorGroupId

[REQUIRED]

The Amazon Chime Voice Connector group ID.

returns

None

UpdateVoiceConnectorGroup (new)

Link ¶

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

client.update_voice_connector_group(
    VoiceConnectorGroupId='string',
    Name='string',
    VoiceConnectorItems=[
        {
            'VoiceConnectorId': 'string',
            'Priority': 123
        },
    ]
)

type VoiceConnectorGroupId

string

param VoiceConnectorGroupId

[REQUIRED]

The Amazon Chime Voice Connector group ID.

type Name

string

param Name

[REQUIRED]

The name of the Amazon Chime Voice Connector group.

type VoiceConnectorItems

list

param VoiceConnectorItems

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

rtype

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

ListVoiceConnectorGroups (new)

Link ¶

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

See also: AWS API Documentation

Request Syntax

client.list_voice_connector_groups(
    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

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

DeleteVoiceConnectorStreamingConfiguration (new)

Link ¶

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

See also: AWS API Documentation

Request Syntax

client.delete_voice_connector_streaming_configuration(
    VoiceConnectorId='string'
)

type VoiceConnectorId

string

param VoiceConnectorId

[REQUIRED]

The Amazon Chime Voice Connector ID.

returns

None

DisassociatePhoneNumbersFromVoiceConnectorGroup (new)

Link ¶

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

See also: AWS API Documentation

Request Syntax

client.disassociate_phone_numbers_from_voice_connector_group(
    VoiceConnectorGroupId='string',
    E164PhoneNumbers=[
        'string',
    ]
)

type VoiceConnectorGroupId

string

param VoiceConnectorGroupId

[REQUIRED]

The Amazon Chime Voice Connector group ID.

type E164PhoneNumbers

list

param E164PhoneNumbers

List of phone numbers, in E.164 format.

(string) --

rtype

dict

returns

Response Syntax

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

AssociatePhoneNumbersWithVoiceConnector (updated)

Link ¶
Changes (request, response)
Request

{'ForceAssociate': 'boolean'}

Response

{'PhoneNumberErrors': {'ErrorCode': ['ResourceLimitExceeded',
                                     'VoiceConnectorGroupAssociationsExist',
                                     'PhoneNumberAssociationsExist',
                                     'AccessDenied']}}

Associates phone numbers 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',
    ],
    ForceAssociate=True|False
)

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

type ForceAssociate

boolean

param ForceAssociate

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.

rtype

dict

returns

Response Syntax

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

BatchDeletePhoneNumber (updated)

Link ¶
Changes (response)

{'PhoneNumberErrors': {'ErrorCode': ['ResourceLimitExceeded',
                                     'VoiceConnectorGroupAssociationsExist',
                                     'PhoneNumberAssociationsExist',
                                     'AccessDenied']}}

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': 'BadRequest'|'Conflict'|'Forbidden'|'NotFound'|'PreconditionFailed'|'ResourceLimitExceeded'|'ServiceFailure'|'AccessDenied'|'ServiceUnavailable'|'Throttled'|'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.

BatchSuspendUser (updated)

Link ¶
Changes (response)

{'UserErrors': {'ErrorCode': ['ResourceLimitExceeded',
                              'VoiceConnectorGroupAssociationsExist',
                              'PhoneNumberAssociationsExist',
                              'AccessDenied']}}

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

client.batch_suspend_user(
    AccountId='string',
    UserIdList=[
        'string',
    ]
)

type AccountId

string

param AccountId

[REQUIRED]

The Amazon Chime account ID.

type UserIdList

list

param UserIdList

[REQUIRED]

The request containing the user IDs to suspend.

(string) --

rtype

dict

returns

Response Syntax

{
    'UserErrors': [
        {
            'UserId': 'string',
            'ErrorCode': 'BadRequest'|'Conflict'|'Forbidden'|'NotFound'|'PreconditionFailed'|'ResourceLimitExceeded'|'ServiceFailure'|'AccessDenied'|'ServiceUnavailable'|'Throttled'|'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.

BatchUnsuspendUser (updated)

Link ¶
Changes (response)

{'UserErrors': {'ErrorCode': ['ResourceLimitExceeded',
                              'VoiceConnectorGroupAssociationsExist',
                              'PhoneNumberAssociationsExist',
                              'AccessDenied']}}

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

client.batch_unsuspend_user(
    AccountId='string',
    UserIdList=[
        'string',
    ]
)

type AccountId

string

param AccountId

[REQUIRED]

The Amazon Chime account ID.

type UserIdList

list

param UserIdList

[REQUIRED]

The request containing the user IDs to unsuspend.

(string) --

rtype

dict

returns

Response Syntax

{
    'UserErrors': [
        {
            'UserId': 'string',
            'ErrorCode': 'BadRequest'|'Conflict'|'Forbidden'|'NotFound'|'PreconditionFailed'|'ResourceLimitExceeded'|'ServiceFailure'|'AccessDenied'|'ServiceUnavailable'|'Throttled'|'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.

BatchUpdatePhoneNumber (updated)

Link ¶
Changes (request, response)
Request

{'UpdatePhoneNumberRequestItems': {'CallingName': 'string'}}

Response

{'PhoneNumberErrors': {'ErrorCode': ['ResourceLimitExceeded',
                                     'VoiceConnectorGroupAssociationsExist',
                                     'PhoneNumberAssociationsExist',
                                     'AccessDenied']}}

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

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

type UpdatePhoneNumberRequestItems

list

param UpdatePhoneNumberRequestItems

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

rtype

dict

returns

Response Syntax

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

BatchUpdateUser (updated)

Link ¶
Changes (response)

{'UserErrors': {'ErrorCode': ['ResourceLimitExceeded',
                              'VoiceConnectorGroupAssociationsExist',
                              'PhoneNumberAssociationsExist',
                              'AccessDenied']}}

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

client.batch_update_user(
    AccountId='string',
    UpdateUserRequestItems=[
        {
            'UserId': 'string',
            'LicenseType': 'Basic'|'Plus'|'Pro'|'ProTrial'
        },
    ]
)

type AccountId

string

param AccountId

[REQUIRED]

The Amazon Chime account ID.

type UpdateUserRequestItems

list

param UpdateUserRequestItems

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

rtype

dict

returns

Response Syntax

{
    'UserErrors': [
        {
            'UserId': 'string',
            'ErrorCode': 'BadRequest'|'Conflict'|'Forbidden'|'NotFound'|'PreconditionFailed'|'ResourceLimitExceeded'|'ServiceFailure'|'AccessDenied'|'ServiceUnavailable'|'Throttled'|'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.

CreateVoiceConnector (updated)

Link ¶
Changes (request, response)
Request

{'AwsRegion': 'us-east-1 | us-west-2'}

Response

{'VoiceConnector': {'AwsRegion': 'us-east-1 | us-west-2'}}

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

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

type Name

string

param Name

[REQUIRED]

The name of the Amazon Chime Voice Connector.

type AwsRegion

string

param AwsRegion

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

type RequireEncryption

boolean

param RequireEncryption

[REQUIRED]

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

rtype

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.

DisassociatePhoneNumbersFromVoiceConnector (updated)

Link ¶
Changes (response)

{'PhoneNumberErrors': {'ErrorCode': ['ResourceLimitExceeded',
                                     'VoiceConnectorGroupAssociationsExist',
                                     'PhoneNumberAssociationsExist',
                                     'AccessDenied']}}

Disassociates the specified phone numbers 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': 'BadRequest'|'Conflict'|'Forbidden'|'NotFound'|'PreconditionFailed'|'ResourceLimitExceeded'|'ServiceFailure'|'AccessDenied'|'ServiceUnavailable'|'Throttled'|'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.

GetPhoneNumber (updated)

Link ¶
Changes (response)

{'PhoneNumber': {'Associations': {'Name': ['VoiceConnectorGroupId']},
                 'CallingName': 'string',
                 'CallingNameStatus': 'Unassigned | UpdateInProgress | '
                                      'UpdateSucceeded | UpdateFailed'}}

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

GetVoiceConnector (updated)

Link ¶
Changes (response)

{'VoiceConnector': {'AwsRegion': 'us-east-1 | us-west-2'}}

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

ListPhoneNumbers (updated)

Link ¶
Changes (request, response)
Request

{'FilterName': ['VoiceConnectorGroupId']}

Response

{'PhoneNumbers': {'Associations': {'Name': ['VoiceConnectorGroupId']},
                  'CallingName': 'string',
                  'CallingNameStatus': 'Unassigned | UpdateInProgress | '
                                       'UpdateSucceeded | UpdateFailed'}}

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

client.list_phone_numbers(
    Status='AcquireInProgress'|'AcquireFailed'|'Unassigned'|'Assigned'|'ReleaseInProgress'|'DeleteInProgress'|'ReleaseFailed'|'DeleteFailed',
    ProductType='BusinessCalling'|'VoiceConnector',
    FilterName='AccountId'|'UserId'|'VoiceConnectorId'|'VoiceConnectorGroupId',
    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',
            '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',
                    '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.

ListVoiceConnectors (updated)

Link ¶
Changes (response)

{'VoiceConnectors': {'AwsRegion': 'us-east-1 | us-west-2'}}

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

RestorePhoneNumber (updated)

Link ¶
Changes (response)

{'PhoneNumber': {'Associations': {'Name': ['VoiceConnectorGroupId']},
                 'CallingName': 'string',
                 'CallingNameStatus': 'Unassigned | UpdateInProgress | '
                                      'UpdateSucceeded | UpdateFailed'}}

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

UpdatePhoneNumber (updated)

Link ¶
Changes (request, response)
Request

{'CallingName': 'string'}

Response

{'PhoneNumber': {'Associations': {'Name': ['VoiceConnectorGroupId']},
                 'CallingName': 'string',
                 'CallingNameStatus': 'Unassigned | UpdateInProgress | '
                                      'UpdateSucceeded | UpdateFailed'}}

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

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

type PhoneNumberId

string

param PhoneNumberId

[REQUIRED]

The phone number ID.

type ProductType

string

param ProductType

The product type.

type CallingName

string

param CallingName

The outbound calling name associated with the phone number.

rtype

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

UpdateVoiceConnector (updated)

Link ¶
Changes (response)

{'VoiceConnector': {'AwsRegion': 'us-east-1 | us-west-2'}}

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