ChimeSDKVoice

Client

class ChimeSDKVoice.Client

A low-level client representing Amazon Chime SDK Voice

client = session.create_client('chime-sdk-voice')

These are the available methods:

associate_phone_numbers_with_voice_connector(**kwargs)

See also: AWS API Documentation

Request Syntax

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

    [REQUIRED]

    • (string) --
  • ForceAssociate (boolean) --
Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) --
    • PhoneNumberErrors (list) --
      • (dict) --
        • PhoneNumberId (string) --
        • ErrorCode (string) --
        • ErrorMessage (string) --

Exceptions

associate_phone_numbers_with_voice_connector_group(**kwargs)

See also: AWS API Documentation

Request Syntax

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

    [REQUIRED]

    • (string) --
  • ForceAssociate (boolean) --
Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) --
    • PhoneNumberErrors (list) --
      • (dict) --
        • PhoneNumberId (string) --
        • ErrorCode (string) --
        • ErrorMessage (string) --

Exceptions

batch_delete_phone_number(**kwargs)

See also: AWS API Documentation

Request Syntax

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

[REQUIRED]

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

Response Structure

  • (dict) --
    • PhoneNumberErrors (list) --
      • (dict) --
        • PhoneNumberId (string) --
        • ErrorCode (string) --
        • ErrorMessage (string) --

Exceptions

batch_update_phone_number(**kwargs)

See also: AWS API Documentation

Request Syntax

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

[REQUIRED]

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

Response Structure

  • (dict) --
    • PhoneNumberErrors (list) --
      • (dict) --
        • PhoneNumberId (string) --
        • ErrorCode (string) --
        • ErrorMessage (string) --

Exceptions

can_paginate(operation_name)

Check if an operation can be paginated.

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

Closes underlying endpoint connections.

create_phone_number_order(**kwargs)

See also: AWS API Documentation

Request Syntax

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

    [REQUIRED]

    • (string) --
Return type

dict

Returns

Response Syntax

{
    'PhoneNumberOrder': {
        'PhoneNumberOrderId': 'string',
        'ProductType': 'VoiceConnector'|'SipMediaApplicationDialIn',
        'Status': 'Processing'|'Successful'|'Failed'|'Partial'|'PendingDocuments'|'Submitted'|'FOC'|'ChangeRequested'|'Exception'|'CancelRequested'|'Cancelled',
        'OrderType': 'New'|'Porting',
        'OrderedPhoneNumbers': [
            {
                'E164PhoneNumber': 'string',
                'Status': 'Processing'|'Acquired'|'Failed'
            },
        ],
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) --
    • PhoneNumberOrder (dict) --
      • PhoneNumberOrderId (string) --
      • ProductType (string) --
      • Status (string) --
      • OrderType (string) --
      • OrderedPhoneNumbers (list) --
        • (dict) --
          • E164PhoneNumber (string) --
          • Status (string) --
      • CreatedTimestamp (datetime) --
      • UpdatedTimestamp (datetime) --

Exceptions

create_proxy_session(**kwargs)

See also: AWS API Documentation

Request Syntax

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

    [REQUIRED]

    • (string) --
  • Name (string) --
  • ExpiryMinutes (integer) --
  • Capabilities (list) --

    [REQUIRED]

    • (string) --
  • NumberSelectionBehavior (string) --
  • GeoMatchLevel (string) --
  • GeoMatchParams (dict) --
    • Country (string) -- [REQUIRED]
    • AreaCode (string) -- [REQUIRED]
Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) --
    • ProxySession (dict) --
      • VoiceConnectorId (string) --
      • ProxySessionId (string) --
      • Name (string) --
      • Status (string) --
      • ExpiryMinutes (integer) --
      • Capabilities (list) --
        • (string) --
      • CreatedTimestamp (datetime) --
      • UpdatedTimestamp (datetime) --
      • EndedTimestamp (datetime) --
      • Participants (list) --
        • (dict) --
          • PhoneNumber (string) --
          • ProxyPhoneNumber (string) --
      • NumberSelectionBehavior (string) --
      • GeoMatchLevel (string) --
      • GeoMatchParams (dict) --
        • Country (string) --
        • AreaCode (string) --

Exceptions

create_sip_media_application(**kwargs)

See also: AWS API Documentation

Request Syntax

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

    [REQUIRED]

    • (dict) --
      • LambdaArn (string) --
Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) --
    • SipMediaApplication (dict) --
      • SipMediaApplicationId (string) --
      • AwsRegion (string) --
      • Name (string) --
      • Endpoints (list) --
        • (dict) --
          • LambdaArn (string) --
      • CreatedTimestamp (datetime) --
      • UpdatedTimestamp (datetime) --

Exceptions

create_sip_media_application_call(**kwargs)

See also: AWS API Documentation

Request Syntax

response = client.create_sip_media_application_call(
    FromPhoneNumber='string',
    ToPhoneNumber='string',
    SipMediaApplicationId='string',
    SipHeaders={
        'string': 'string'
    },
    ArgumentsMap={
        'string': 'string'
    }
)
Parameters
  • FromPhoneNumber (string) -- [REQUIRED]
  • ToPhoneNumber (string) -- [REQUIRED]
  • SipMediaApplicationId (string) -- [REQUIRED]
  • SipHeaders (dict) --
    • (string) --
      • (string) --
  • ArgumentsMap (dict) --
    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) --
    • SipMediaApplicationCall (dict) --
      • TransactionId (string) --

Exceptions

create_sip_rule(**kwargs)

See also: AWS API Documentation

Request Syntax

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

dict

Returns

Response Syntax

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

Response Structure

  • (dict) --
    • SipRule (dict) --
      • SipRuleId (string) --
      • Name (string) --
      • Disabled (boolean) --
      • TriggerType (string) --
      • TriggerValue (string) --
      • TargetApplications (list) --
        • (dict) --
          • SipMediaApplicationId (string) --
          • Priority (integer) --
          • AwsRegion (string) --
      • CreatedTimestamp (datetime) --
      • UpdatedTimestamp (datetime) --

Exceptions

create_voice_connector(**kwargs)

See also: AWS API Documentation

Request Syntax

response = client.create_voice_connector(
    Name='string',
    AwsRegion='us-east-1'|'us-west-2'|'ca-central-1'|'eu-central-1'|'eu-west-1'|'eu-west-2'|'ap-northeast-2'|'ap-northeast-1'|'ap-southeast-1'|'ap-southeast-2',
    RequireEncryption=True|False
)
Parameters
  • Name (string) -- [REQUIRED]
  • AwsRegion (string) --
  • RequireEncryption (boolean) -- [REQUIRED]
Return type

dict

Returns

Response Syntax

{
    'VoiceConnector': {
        'VoiceConnectorId': 'string',
        'AwsRegion': 'us-east-1'|'us-west-2'|'ca-central-1'|'eu-central-1'|'eu-west-1'|'eu-west-2'|'ap-northeast-2'|'ap-northeast-1'|'ap-southeast-1'|'ap-southeast-2',
        'Name': 'string',
        'OutboundHostName': 'string',
        'RequireEncryption': True|False,
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1),
        'VoiceConnectorArn': 'string'
    }
}

Response Structure

  • (dict) --
    • VoiceConnector (dict) --
      • VoiceConnectorId (string) --
      • AwsRegion (string) --
      • Name (string) --
      • OutboundHostName (string) --
      • RequireEncryption (boolean) --
      • CreatedTimestamp (datetime) --
      • UpdatedTimestamp (datetime) --
      • VoiceConnectorArn (string) --

Exceptions

create_voice_connector_group(**kwargs)

See also: AWS API Documentation

Request Syntax

response = client.create_voice_connector_group(
    Name='string',
    VoiceConnectorItems=[
        {
            'VoiceConnectorId': 'string',
            'Priority': 123
        },
    ]
)
Parameters
  • Name (string) -- [REQUIRED]
  • VoiceConnectorItems (list) --
    • (dict) --
      • VoiceConnectorId (string) -- [REQUIRED]
      • Priority (integer) -- [REQUIRED]
Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) --
    • VoiceConnectorGroup (dict) --
      • VoiceConnectorGroupId (string) --
      • Name (string) --
      • VoiceConnectorItems (list) --
        • (dict) --
          • VoiceConnectorId (string) --
          • Priority (integer) --
      • CreatedTimestamp (datetime) --
      • UpdatedTimestamp (datetime) --
      • VoiceConnectorGroupArn (string) --

Exceptions

delete_phone_number(**kwargs)

See also: AWS API Documentation

Request Syntax

response = client.delete_phone_number(
    PhoneNumberId='string'
)
Parameters
PhoneNumberId (string) -- [REQUIRED]
Returns
None

Exceptions

delete_proxy_session(**kwargs)

See also: AWS API Documentation

Request Syntax

response = client.delete_proxy_session(
    VoiceConnectorId='string',
    ProxySessionId='string'
)
Parameters
  • VoiceConnectorId (string) -- [REQUIRED]
  • ProxySessionId (string) -- [REQUIRED]
Returns

None

Exceptions

delete_sip_media_application(**kwargs)

See also: AWS API Documentation

Request Syntax

response = client.delete_sip_media_application(
    SipMediaApplicationId='string'
)
Parameters
SipMediaApplicationId (string) -- [REQUIRED]
Returns
None

Exceptions

delete_sip_rule(**kwargs)

See also: AWS API Documentation

Request Syntax

response = client.delete_sip_rule(
    SipRuleId='string'
)
Parameters
SipRuleId (string) -- [REQUIRED]
Returns
None

Exceptions

delete_voice_connector(**kwargs)

See also: AWS API Documentation

Request Syntax

response = client.delete_voice_connector(
    VoiceConnectorId='string'
)
Parameters
VoiceConnectorId (string) -- [REQUIRED]
Returns
None

Exceptions

delete_voice_connector_emergency_calling_configuration(**kwargs)

See also: AWS API Documentation

Request Syntax

response = client.delete_voice_connector_emergency_calling_configuration(
    VoiceConnectorId='string'
)
Parameters
VoiceConnectorId (string) -- [REQUIRED]
Returns
None

Exceptions

delete_voice_connector_group(**kwargs)

See also: AWS API Documentation

Request Syntax

response = client.delete_voice_connector_group(
    VoiceConnectorGroupId='string'
)
Parameters
VoiceConnectorGroupId (string) -- [REQUIRED]
Returns
None

Exceptions

delete_voice_connector_origination(**kwargs)

See also: AWS API Documentation

Request Syntax

response = client.delete_voice_connector_origination(
    VoiceConnectorId='string'
)
Parameters
VoiceConnectorId (string) -- [REQUIRED]
Returns
None

Exceptions

delete_voice_connector_proxy(**kwargs)

See also: AWS API Documentation

Request Syntax

response = client.delete_voice_connector_proxy(
    VoiceConnectorId='string'
)
Parameters
VoiceConnectorId (string) -- [REQUIRED]
Returns
None

Exceptions

delete_voice_connector_streaming_configuration(**kwargs)

See also: AWS API Documentation

Request Syntax

response = client.delete_voice_connector_streaming_configuration(
    VoiceConnectorId='string'
)
Parameters
VoiceConnectorId (string) -- [REQUIRED]
Returns
None

Exceptions

delete_voice_connector_termination(**kwargs)

See also: AWS API Documentation

Request Syntax

response = client.delete_voice_connector_termination(
    VoiceConnectorId='string'
)
Parameters
VoiceConnectorId (string) -- [REQUIRED]
Returns
None

Exceptions

delete_voice_connector_termination_credentials(**kwargs)

See also: AWS API Documentation

Request Syntax

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

    [REQUIRED]

    • (string) --
Returns

None

Exceptions

disassociate_phone_numbers_from_voice_connector(**kwargs)

See also: AWS API Documentation

Request Syntax

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

    [REQUIRED]

    • (string) --
Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) --
    • PhoneNumberErrors (list) --
      • (dict) --
        • PhoneNumberId (string) --
        • ErrorCode (string) --
        • ErrorMessage (string) --

Exceptions

disassociate_phone_numbers_from_voice_connector_group(**kwargs)

See also: AWS API Documentation

Request Syntax

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

    [REQUIRED]

    • (string) --
Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) --
    • PhoneNumberErrors (list) --
      • (dict) --
        • PhoneNumberId (string) --
        • ErrorCode (string) --
        • ErrorMessage (string) --

Exceptions

get_global_settings()

See also: AWS API Documentation

Request Syntax

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

Response Structure

  • (dict) --
    • VoiceConnector (dict) --
      • CdrBucket (string) --

Exceptions

get_paginator(operation_name)

Create a paginator for an operation.

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

See also: AWS API Documentation

Request Syntax

response = client.get_phone_number(
    PhoneNumberId='string'
)
Parameters
PhoneNumberId (string) -- [REQUIRED]
Return type
dict
Returns
Response Syntax
{
    'PhoneNumber': {
        'PhoneNumberId': 'string',
        'E164PhoneNumber': 'string',
        'Country': 'string',
        'Type': 'Local'|'TollFree',
        'ProductType': 'VoiceConnector'|'SipMediaApplicationDialIn',
        'Status': 'Cancelled'|'PortinCancelRequested'|'PortinInProgress'|'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': 'VoiceConnectorId'|'VoiceConnectorGroupId'|'SipRuleId',
                'AssociatedTimestamp': datetime(2015, 1, 1)
            },
        ],
        'CallingName': 'string',
        'CallingNameStatus': 'Unassigned'|'UpdateInProgress'|'UpdateSucceeded'|'UpdateFailed',
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1),
        'DeletionTimestamp': datetime(2015, 1, 1),
        'OrderId': 'string'
    }
}

Response Structure

  • (dict) --
    • PhoneNumber (dict) --
      • PhoneNumberId (string) --
      • E164PhoneNumber (string) --
      • Country (string) --
      • Type (string) --
      • ProductType (string) --
      • Status (string) --
      • Capabilities (dict) --
        • InboundCall (boolean) --
        • OutboundCall (boolean) --
        • InboundSMS (boolean) --
        • OutboundSMS (boolean) --
        • InboundMMS (boolean) --
        • OutboundMMS (boolean) --
      • Associations (list) --
        • (dict) --
          • Value (string) --
          • Name (string) --
          • AssociatedTimestamp (datetime) --
      • CallingName (string) --
      • CallingNameStatus (string) --
      • CreatedTimestamp (datetime) --
      • UpdatedTimestamp (datetime) --
      • DeletionTimestamp (datetime) --
      • OrderId (string) --

Exceptions

get_phone_number_order(**kwargs)

See also: AWS API Documentation

Request Syntax

response = client.get_phone_number_order(
    PhoneNumberOrderId='string'
)
Parameters
PhoneNumberOrderId (string) -- [REQUIRED]
Return type
dict
Returns
Response Syntax
{
    'PhoneNumberOrder': {
        'PhoneNumberOrderId': 'string',
        'ProductType': 'VoiceConnector'|'SipMediaApplicationDialIn',
        'Status': 'Processing'|'Successful'|'Failed'|'Partial'|'PendingDocuments'|'Submitted'|'FOC'|'ChangeRequested'|'Exception'|'CancelRequested'|'Cancelled',
        'OrderType': 'New'|'Porting',
        'OrderedPhoneNumbers': [
            {
                'E164PhoneNumber': 'string',
                'Status': 'Processing'|'Acquired'|'Failed'
            },
        ],
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) --
    • PhoneNumberOrder (dict) --
      • PhoneNumberOrderId (string) --
      • ProductType (string) --
      • Status (string) --
      • OrderType (string) --
      • OrderedPhoneNumbers (list) --
        • (dict) --
          • E164PhoneNumber (string) --
          • Status (string) --
      • CreatedTimestamp (datetime) --
      • UpdatedTimestamp (datetime) --

Exceptions

get_phone_number_settings()

See also: AWS API Documentation

Request Syntax

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

Response Structure

  • (dict) --
    • CallingName (string) --
    • CallingNameUpdatedTimestamp (datetime) --

Exceptions

get_proxy_session(**kwargs)

See also: AWS API Documentation

Request Syntax

response = client.get_proxy_session(
    VoiceConnectorId='string',
    ProxySessionId='string'
)
Parameters
  • VoiceConnectorId (string) -- [REQUIRED]
  • ProxySessionId (string) -- [REQUIRED]
Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) --
    • ProxySession (dict) --
      • VoiceConnectorId (string) --
      • ProxySessionId (string) --
      • Name (string) --
      • Status (string) --
      • ExpiryMinutes (integer) --
      • Capabilities (list) --
        • (string) --
      • CreatedTimestamp (datetime) --
      • UpdatedTimestamp (datetime) --
      • EndedTimestamp (datetime) --
      • Participants (list) --
        • (dict) --
          • PhoneNumber (string) --
          • ProxyPhoneNumber (string) --
      • NumberSelectionBehavior (string) --
      • GeoMatchLevel (string) --
      • GeoMatchParams (dict) --
        • Country (string) --
        • AreaCode (string) --

Exceptions

get_sip_media_application(**kwargs)

See also: AWS API Documentation

Request Syntax

response = client.get_sip_media_application(
    SipMediaApplicationId='string'
)
Parameters
SipMediaApplicationId (string) -- [REQUIRED]
Return type
dict
Returns
Response Syntax
{
    'SipMediaApplication': {
        'SipMediaApplicationId': 'string',
        'AwsRegion': 'string',
        'Name': 'string',
        'Endpoints': [
            {
                'LambdaArn': 'string'
            },
        ],
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) --
    • SipMediaApplication (dict) --
      • SipMediaApplicationId (string) --
      • AwsRegion (string) --
      • Name (string) --
      • Endpoints (list) --
        • (dict) --
          • LambdaArn (string) --
      • CreatedTimestamp (datetime) --
      • UpdatedTimestamp (datetime) --

Exceptions

get_sip_media_application_alexa_skill_configuration(**kwargs)

See also: AWS API Documentation

Request Syntax

response = client.get_sip_media_application_alexa_skill_configuration(
    SipMediaApplicationId='string'
)
Parameters
SipMediaApplicationId (string) -- [REQUIRED]
Return type
dict
Returns
Response Syntax
{
    'SipMediaApplicationAlexaSkillConfiguration': {
        'AlexaSkillStatus': 'ACTIVE'|'INACTIVE',
        'AlexaSkillIds': [
            'string',
        ]
    }
}

Response Structure

  • (dict) --
    • SipMediaApplicationAlexaSkillConfiguration (dict) --
      • AlexaSkillStatus (string) --
      • AlexaSkillIds (list) --
        • (string) --

Exceptions

get_sip_media_application_logging_configuration(**kwargs)

See also: AWS API Documentation

Request Syntax

response = client.get_sip_media_application_logging_configuration(
    SipMediaApplicationId='string'
)
Parameters
SipMediaApplicationId (string) -- [REQUIRED]
Return type
dict
Returns
Response Syntax
{
    'SipMediaApplicationLoggingConfiguration': {
        'EnableSipMediaApplicationMessageLogs': True|False
    }
}

Response Structure

  • (dict) --
    • SipMediaApplicationLoggingConfiguration (dict) --
      • EnableSipMediaApplicationMessageLogs (boolean) --

Exceptions

get_sip_rule(**kwargs)

See also: AWS API Documentation

Request Syntax

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

Response Structure

  • (dict) --
    • SipRule (dict) --
      • SipRuleId (string) --
      • Name (string) --
      • Disabled (boolean) --
      • TriggerType (string) --
      • TriggerValue (string) --
      • TargetApplications (list) --
        • (dict) --
          • SipMediaApplicationId (string) --
          • Priority (integer) --
          • AwsRegion (string) --
      • CreatedTimestamp (datetime) --
      • UpdatedTimestamp (datetime) --

Exceptions

get_voice_connector(**kwargs)

See also: AWS API Documentation

Request Syntax

response = client.get_voice_connector(
    VoiceConnectorId='string'
)
Parameters
VoiceConnectorId (string) -- [REQUIRED]
Return type
dict
Returns
Response Syntax
{
    'VoiceConnector': {
        'VoiceConnectorId': 'string',
        'AwsRegion': 'us-east-1'|'us-west-2'|'ca-central-1'|'eu-central-1'|'eu-west-1'|'eu-west-2'|'ap-northeast-2'|'ap-northeast-1'|'ap-southeast-1'|'ap-southeast-2',
        'Name': 'string',
        'OutboundHostName': 'string',
        'RequireEncryption': True|False,
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1),
        'VoiceConnectorArn': 'string'
    }
}

Response Structure

  • (dict) --
    • VoiceConnector (dict) --
      • VoiceConnectorId (string) --
      • AwsRegion (string) --
      • Name (string) --
      • OutboundHostName (string) --
      • RequireEncryption (boolean) --
      • CreatedTimestamp (datetime) --
      • UpdatedTimestamp (datetime) --
      • VoiceConnectorArn (string) --

Exceptions

get_voice_connector_emergency_calling_configuration(**kwargs)

See also: AWS API Documentation

Request Syntax

response = client.get_voice_connector_emergency_calling_configuration(
    VoiceConnectorId='string'
)
Parameters
VoiceConnectorId (string) -- [REQUIRED]
Return type
dict
Returns
Response Syntax
{
    'EmergencyCallingConfiguration': {
        'DNIS': [
            {
                'EmergencyPhoneNumber': 'string',
                'TestPhoneNumber': 'string',
                'CallingCountry': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) --
    • EmergencyCallingConfiguration (dict) --
      • DNIS (list) --
        • (dict) --
          • EmergencyPhoneNumber (string) --
          • TestPhoneNumber (string) --
          • CallingCountry (string) --

Exceptions

get_voice_connector_group(**kwargs)

See also: AWS API Documentation

Request Syntax

response = client.get_voice_connector_group(
    VoiceConnectorGroupId='string'
)
Parameters
VoiceConnectorGroupId (string) -- [REQUIRED]
Return type
dict
Returns
Response Syntax
{
    'VoiceConnectorGroup': {
        'VoiceConnectorGroupId': 'string',
        'Name': 'string',
        'VoiceConnectorItems': [
            {
                'VoiceConnectorId': 'string',
                'Priority': 123
            },
        ],
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1),
        'VoiceConnectorGroupArn': 'string'
    }
}

Response Structure

  • (dict) --
    • VoiceConnectorGroup (dict) --
      • VoiceConnectorGroupId (string) --
      • Name (string) --
      • VoiceConnectorItems (list) --
        • (dict) --
          • VoiceConnectorId (string) --
          • Priority (integer) --
      • CreatedTimestamp (datetime) --
      • UpdatedTimestamp (datetime) --
      • VoiceConnectorGroupArn (string) --

Exceptions

get_voice_connector_logging_configuration(**kwargs)

See also: AWS API Documentation

Request Syntax

response = client.get_voice_connector_logging_configuration(
    VoiceConnectorId='string'
)
Parameters
VoiceConnectorId (string) -- [REQUIRED]
Return type
dict
Returns
Response Syntax
{
    'LoggingConfiguration': {
        'EnableSIPLogs': True|False
    }
}

Response Structure

  • (dict) --
    • LoggingConfiguration (dict) --
      • EnableSIPLogs (boolean) --

Exceptions

get_voice_connector_origination(**kwargs)

See also: AWS API Documentation

Request Syntax

response = client.get_voice_connector_origination(
    VoiceConnectorId='string'
)
Parameters
VoiceConnectorId (string) -- [REQUIRED]
Return type
dict
Returns
Response Syntax
{
    'Origination': {
        'Routes': [
            {
                'Host': 'string',
                'Port': 123,
                'Protocol': 'TCP'|'UDP',
                'Priority': 123,
                'Weight': 123
            },
        ],
        'Disabled': True|False
    }
}

Response Structure

  • (dict) --
    • Origination (dict) --
      • Routes (list) --
        • (dict) --
          • Host (string) --
          • Port (integer) --
          • Protocol (string) --
          • Priority (integer) --
          • Weight (integer) --
      • Disabled (boolean) --

Exceptions

get_voice_connector_proxy(**kwargs)

See also: AWS API Documentation

Request Syntax

response = client.get_voice_connector_proxy(
    VoiceConnectorId='string'
)
Parameters
VoiceConnectorId (string) -- [REQUIRED]
Return type
dict
Returns
Response Syntax
{
    'Proxy': {
        'DefaultSessionExpiryMinutes': 123,
        'Disabled': True|False,
        'FallBackPhoneNumber': 'string',
        'PhoneNumberCountries': [
            'string',
        ]
    }
}

Response Structure

  • (dict) --
    • Proxy (dict) --
      • DefaultSessionExpiryMinutes (integer) --
      • Disabled (boolean) --
      • FallBackPhoneNumber (string) --
      • PhoneNumberCountries (list) --
        • (string) --

Exceptions

get_voice_connector_streaming_configuration(**kwargs)

See also: AWS API Documentation

Request Syntax

response = client.get_voice_connector_streaming_configuration(
    VoiceConnectorId='string'
)
Parameters
VoiceConnectorId (string) -- [REQUIRED]
Return type
dict
Returns
Response Syntax
{
    'StreamingConfiguration': {
        'DataRetentionInHours': 123,
        'Disabled': True|False,
        'StreamingNotificationTargets': [
            {
                'NotificationTarget': 'EventBridge'|'SNS'|'SQS'
            },
        ]
    }
}

Response Structure

  • (dict) --
    • StreamingConfiguration (dict) --
      • DataRetentionInHours (integer) --
      • Disabled (boolean) --
      • StreamingNotificationTargets (list) --
        • (dict) --
          • NotificationTarget (string) --

Exceptions

get_voice_connector_termination(**kwargs)

See also: AWS API Documentation

Request Syntax

response = client.get_voice_connector_termination(
    VoiceConnectorId='string'
)
Parameters
VoiceConnectorId (string) -- [REQUIRED]
Return type
dict
Returns
Response Syntax
{
    'Termination': {
        'CpsLimit': 123,
        'DefaultPhoneNumber': 'string',
        'CallingRegions': [
            'string',
        ],
        'CidrAllowedList': [
            'string',
        ],
        'Disabled': True|False
    }
}

Response Structure

  • (dict) --
    • Termination (dict) --
      • CpsLimit (integer) --
      • DefaultPhoneNumber (string) --
      • CallingRegions (list) --
        • (string) --
      • CidrAllowedList (list) --
        • (string) --
      • Disabled (boolean) --

Exceptions

get_voice_connector_termination_health(**kwargs)

See also: AWS API Documentation

Request Syntax

response = client.get_voice_connector_termination_health(
    VoiceConnectorId='string'
)
Parameters
VoiceConnectorId (string) -- [REQUIRED]
Return type
dict
Returns
Response Syntax
{
    'TerminationHealth': {
        'Timestamp': datetime(2015, 1, 1),
        'Source': 'string'
    }
}

Response Structure

  • (dict) --
    • TerminationHealth (dict) --
      • Timestamp (datetime) --
      • Source (string) --

Exceptions

get_waiter(waiter_name)

Returns an object that can wait for some condition.

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

See also: AWS API Documentation

Request Syntax

response = client.list_available_voice_connector_regions()
Return type
dict
Returns
Response Syntax
{
    'VoiceConnectorRegions': [
        'us-east-1'|'us-west-2'|'ca-central-1'|'eu-central-1'|'eu-west-1'|'eu-west-2'|'ap-northeast-2'|'ap-northeast-1'|'ap-southeast-1'|'ap-southeast-2',
    ]
}

Response Structure

  • (dict) --
    • VoiceConnectorRegions (list) --
      • (string) --

Exceptions

list_phone_number_orders(**kwargs)

See also: AWS API Documentation

Request Syntax

response = client.list_phone_number_orders(
    NextToken='string',
    MaxResults=123
)
Parameters
  • NextToken (string) --
  • MaxResults (integer) --
Return type

dict

Returns

Response Syntax

{
    'PhoneNumberOrders': [
        {
            'PhoneNumberOrderId': 'string',
            'ProductType': 'VoiceConnector'|'SipMediaApplicationDialIn',
            'Status': 'Processing'|'Successful'|'Failed'|'Partial'|'PendingDocuments'|'Submitted'|'FOC'|'ChangeRequested'|'Exception'|'CancelRequested'|'Cancelled',
            'OrderType': 'New'|'Porting',
            'OrderedPhoneNumbers': [
                {
                    'E164PhoneNumber': 'string',
                    'Status': 'Processing'|'Acquired'|'Failed'
                },
            ],
            'CreatedTimestamp': datetime(2015, 1, 1),
            'UpdatedTimestamp': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --
    • PhoneNumberOrders (list) --
      • (dict) --
        • PhoneNumberOrderId (string) --
        • ProductType (string) --
        • Status (string) --
        • OrderType (string) --
        • OrderedPhoneNumbers (list) --
          • (dict) --
            • E164PhoneNumber (string) --
            • Status (string) --
        • CreatedTimestamp (datetime) --
        • UpdatedTimestamp (datetime) --
    • NextToken (string) --

Exceptions

list_phone_numbers(**kwargs)

See also: AWS API Documentation

Request Syntax

response = client.list_phone_numbers(
    Status='string',
    ProductType='VoiceConnector'|'SipMediaApplicationDialIn',
    FilterName='VoiceConnectorId'|'VoiceConnectorGroupId'|'SipRuleId',
    FilterValue='string',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • Status (string) --
  • ProductType (string) --
  • FilterName (string) --
  • FilterValue (string) --
  • MaxResults (integer) --
  • NextToken (string) --
Return type

dict

Returns

Response Syntax

{
    'PhoneNumbers': [
        {
            'PhoneNumberId': 'string',
            'E164PhoneNumber': 'string',
            'Country': 'string',
            'Type': 'Local'|'TollFree',
            'ProductType': 'VoiceConnector'|'SipMediaApplicationDialIn',
            'Status': 'Cancelled'|'PortinCancelRequested'|'PortinInProgress'|'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': 'VoiceConnectorId'|'VoiceConnectorGroupId'|'SipRuleId',
                    'AssociatedTimestamp': datetime(2015, 1, 1)
                },
            ],
            'CallingName': 'string',
            'CallingNameStatus': 'Unassigned'|'UpdateInProgress'|'UpdateSucceeded'|'UpdateFailed',
            'CreatedTimestamp': datetime(2015, 1, 1),
            'UpdatedTimestamp': datetime(2015, 1, 1),
            'DeletionTimestamp': datetime(2015, 1, 1),
            'OrderId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --
    • PhoneNumbers (list) --
      • (dict) --
        • PhoneNumberId (string) --
        • E164PhoneNumber (string) --
        • Country (string) --
        • Type (string) --
        • ProductType (string) --
        • Status (string) --
        • Capabilities (dict) --
          • InboundCall (boolean) --
          • OutboundCall (boolean) --
          • InboundSMS (boolean) --
          • OutboundSMS (boolean) --
          • InboundMMS (boolean) --
          • OutboundMMS (boolean) --
        • Associations (list) --
          • (dict) --
            • Value (string) --
            • Name (string) --
            • AssociatedTimestamp (datetime) --
        • CallingName (string) --
        • CallingNameStatus (string) --
        • CreatedTimestamp (datetime) --
        • UpdatedTimestamp (datetime) --
        • DeletionTimestamp (datetime) --
        • OrderId (string) --
    • NextToken (string) --

Exceptions

list_proxy_sessions(**kwargs)

See also: AWS API Documentation

Request Syntax

response = client.list_proxy_sessions(
    VoiceConnectorId='string',
    Status='Open'|'InProgress'|'Closed',
    NextToken='string',
    MaxResults=123
)
Parameters
  • VoiceConnectorId (string) -- [REQUIRED]
  • Status (string) --
  • NextToken (string) --
  • MaxResults (integer) --
Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) --
    • ProxySessions (list) --
      • (dict) --
        • VoiceConnectorId (string) --
        • ProxySessionId (string) --
        • Name (string) --
        • Status (string) --
        • ExpiryMinutes (integer) --
        • Capabilities (list) --
          • (string) --
        • CreatedTimestamp (datetime) --
        • UpdatedTimestamp (datetime) --
        • EndedTimestamp (datetime) --
        • Participants (list) --
          • (dict) --
            • PhoneNumber (string) --
            • ProxyPhoneNumber (string) --
        • NumberSelectionBehavior (string) --
        • GeoMatchLevel (string) --
        • GeoMatchParams (dict) --
          • Country (string) --
          • AreaCode (string) --
    • NextToken (string) --

Exceptions

list_sip_media_applications(**kwargs)

See also: AWS API Documentation

Request Syntax

response = client.list_sip_media_applications(
    MaxResults=123,
    NextToken='string'
)
Parameters
  • MaxResults (integer) --
  • NextToken (string) --
Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) --
    • SipMediaApplications (list) --
      • (dict) --
        • SipMediaApplicationId (string) --
        • AwsRegion (string) --
        • Name (string) --
        • Endpoints (list) --
          • (dict) --
            • LambdaArn (string) --
        • CreatedTimestamp (datetime) --
        • UpdatedTimestamp (datetime) --
    • NextToken (string) --

Exceptions

list_sip_rules(**kwargs)

See also: AWS API Documentation

Request Syntax

response = client.list_sip_rules(
    SipMediaApplicationId='string',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • SipMediaApplicationId (string) --
  • MaxResults (integer) --
  • NextToken (string) --
Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) --
    • SipRules (list) --
      • (dict) --
        • SipRuleId (string) --
        • Name (string) --
        • Disabled (boolean) --
        • TriggerType (string) --
        • TriggerValue (string) --
        • TargetApplications (list) --
          • (dict) --
            • SipMediaApplicationId (string) --
            • Priority (integer) --
            • AwsRegion (string) --
        • CreatedTimestamp (datetime) --
        • UpdatedTimestamp (datetime) --
    • NextToken (string) --

Exceptions

list_supported_phone_number_countries(**kwargs)

See also: AWS API Documentation

Request Syntax

response = client.list_supported_phone_number_countries(
    ProductType='VoiceConnector'|'SipMediaApplicationDialIn'
)
Parameters
ProductType (string) -- [REQUIRED]
Return type
dict
Returns
Response Syntax
{
    'PhoneNumberCountries': [
        {
            'CountryCode': 'string',
            'SupportedPhoneNumberTypes': [
                'Local'|'TollFree',
            ]
        },
    ]
}

Response Structure

  • (dict) --
    • PhoneNumberCountries (list) --
      • (dict) --
        • CountryCode (string) --
        • SupportedPhoneNumberTypes (list) --
          • (string) --

Exceptions

list_voice_connector_groups(**kwargs)

See also: AWS API Documentation

Request Syntax

response = client.list_voice_connector_groups(
    NextToken='string',
    MaxResults=123
)
Parameters
  • NextToken (string) --
  • MaxResults (integer) --
Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) --
    • VoiceConnectorGroups (list) --
      • (dict) --
        • VoiceConnectorGroupId (string) --
        • Name (string) --
        • VoiceConnectorItems (list) --
          • (dict) --
            • VoiceConnectorId (string) --
            • Priority (integer) --
        • CreatedTimestamp (datetime) --
        • UpdatedTimestamp (datetime) --
        • VoiceConnectorGroupArn (string) --
    • NextToken (string) --

Exceptions

list_voice_connector_termination_credentials(**kwargs)

See also: AWS API Documentation

Request Syntax

response = client.list_voice_connector_termination_credentials(
    VoiceConnectorId='string'
)
Parameters
VoiceConnectorId (string) -- [REQUIRED]
Return type
dict
Returns
Response Syntax
{
    'Usernames': [
        'string',
    ]
}

Response Structure

  • (dict) --
    • Usernames (list) --
      • (string) --

Exceptions

list_voice_connectors(**kwargs)

See also: AWS API Documentation

Request Syntax

response = client.list_voice_connectors(
    NextToken='string',
    MaxResults=123
)
Parameters
  • NextToken (string) --
  • MaxResults (integer) --
Return type

dict

Returns

Response Syntax

{
    'VoiceConnectors': [
        {
            'VoiceConnectorId': 'string',
            'AwsRegion': 'us-east-1'|'us-west-2'|'ca-central-1'|'eu-central-1'|'eu-west-1'|'eu-west-2'|'ap-northeast-2'|'ap-northeast-1'|'ap-southeast-1'|'ap-southeast-2',
            'Name': 'string',
            'OutboundHostName': 'string',
            'RequireEncryption': True|False,
            'CreatedTimestamp': datetime(2015, 1, 1),
            'UpdatedTimestamp': datetime(2015, 1, 1),
            'VoiceConnectorArn': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --
    • VoiceConnectors (list) --
      • (dict) --
        • VoiceConnectorId (string) --
        • AwsRegion (string) --
        • Name (string) --
        • OutboundHostName (string) --
        • RequireEncryption (boolean) --
        • CreatedTimestamp (datetime) --
        • UpdatedTimestamp (datetime) --
        • VoiceConnectorArn (string) --
    • NextToken (string) --

Exceptions

put_sip_media_application_alexa_skill_configuration(**kwargs)

See also: AWS API Documentation

Request Syntax

response = client.put_sip_media_application_alexa_skill_configuration(
    SipMediaApplicationId='string',
    SipMediaApplicationAlexaSkillConfiguration={
        'AlexaSkillStatus': 'ACTIVE'|'INACTIVE',
        'AlexaSkillIds': [
            'string',
        ]
    }
)
Parameters
  • SipMediaApplicationId (string) -- [REQUIRED]
  • SipMediaApplicationAlexaSkillConfiguration (dict) --
    • AlexaSkillStatus (string) -- [REQUIRED]
    • AlexaSkillIds (list) -- [REQUIRED]
      • (string) --
Return type

dict

Returns

Response Syntax

{
    'SipMediaApplicationAlexaSkillConfiguration': {
        'AlexaSkillStatus': 'ACTIVE'|'INACTIVE',
        'AlexaSkillIds': [
            'string',
        ]
    }
}

Response Structure

  • (dict) --
    • SipMediaApplicationAlexaSkillConfiguration (dict) --
      • AlexaSkillStatus (string) --
      • AlexaSkillIds (list) --
        • (string) --

Exceptions

put_sip_media_application_logging_configuration(**kwargs)

See also: AWS API Documentation

Request Syntax

response = client.put_sip_media_application_logging_configuration(
    SipMediaApplicationId='string',
    SipMediaApplicationLoggingConfiguration={
        'EnableSipMediaApplicationMessageLogs': True|False
    }
)
Parameters
  • SipMediaApplicationId (string) -- [REQUIRED]
  • SipMediaApplicationLoggingConfiguration (dict) --
    • EnableSipMediaApplicationMessageLogs (boolean) --
Return type

dict

Returns

Response Syntax

{
    'SipMediaApplicationLoggingConfiguration': {
        'EnableSipMediaApplicationMessageLogs': True|False
    }
}

Response Structure

  • (dict) --
    • SipMediaApplicationLoggingConfiguration (dict) --
      • EnableSipMediaApplicationMessageLogs (boolean) --

Exceptions

put_voice_connector_emergency_calling_configuration(**kwargs)

See also: AWS API Documentation

Request Syntax

response = client.put_voice_connector_emergency_calling_configuration(
    VoiceConnectorId='string',
    EmergencyCallingConfiguration={
        'DNIS': [
            {
                'EmergencyPhoneNumber': 'string',
                'TestPhoneNumber': 'string',
                'CallingCountry': 'string'
            },
        ]
    }
)
Parameters
  • VoiceConnectorId (string) -- [REQUIRED]
  • EmergencyCallingConfiguration (dict) --

    [REQUIRED]

    • DNIS (list) --
      • (dict) --
        • EmergencyPhoneNumber (string) -- [REQUIRED]
        • TestPhoneNumber (string) --
        • CallingCountry (string) -- [REQUIRED]
Return type

dict

Returns

Response Syntax

{
    'EmergencyCallingConfiguration': {
        'DNIS': [
            {
                'EmergencyPhoneNumber': 'string',
                'TestPhoneNumber': 'string',
                'CallingCountry': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) --
    • EmergencyCallingConfiguration (dict) --
      • DNIS (list) --
        • (dict) --
          • EmergencyPhoneNumber (string) --
          • TestPhoneNumber (string) --
          • CallingCountry (string) --

Exceptions

put_voice_connector_logging_configuration(**kwargs)

See also: AWS API Documentation

Request Syntax

response = client.put_voice_connector_logging_configuration(
    VoiceConnectorId='string',
    LoggingConfiguration={
        'EnableSIPLogs': True|False
    }
)
Parameters
  • VoiceConnectorId (string) -- [REQUIRED]
  • LoggingConfiguration (dict) --

    [REQUIRED]

    • EnableSIPLogs (boolean) --
Return type

dict

Returns

Response Syntax

{
    'LoggingConfiguration': {
        'EnableSIPLogs': True|False
    }
}

Response Structure

  • (dict) --
    • LoggingConfiguration (dict) --
      • EnableSIPLogs (boolean) --

Exceptions

put_voice_connector_origination(**kwargs)

See also: AWS API Documentation

Request Syntax

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

    [REQUIRED]

    • Routes (list) --
      • (dict) --
        • Host (string) --
        • Port (integer) --
        • Protocol (string) --
        • Priority (integer) --
        • Weight (integer) --
    • Disabled (boolean) --
Return type

dict

Returns

Response Syntax

{
    'Origination': {
        'Routes': [
            {
                'Host': 'string',
                'Port': 123,
                'Protocol': 'TCP'|'UDP',
                'Priority': 123,
                'Weight': 123
            },
        ],
        'Disabled': True|False
    }
}

Response Structure

  • (dict) --
    • Origination (dict) --
      • Routes (list) --
        • (dict) --
          • Host (string) --
          • Port (integer) --
          • Protocol (string) --
          • Priority (integer) --
          • Weight (integer) --
      • Disabled (boolean) --

Exceptions

put_voice_connector_proxy(**kwargs)

See also: AWS API Documentation

Request Syntax

response = client.put_voice_connector_proxy(
    VoiceConnectorId='string',
    DefaultSessionExpiryMinutes=123,
    PhoneNumberPoolCountries=[
        'string',
    ],
    FallBackPhoneNumber='string',
    Disabled=True|False
)
Parameters
  • VoiceConnectorId (string) -- [REQUIRED]
  • DefaultSessionExpiryMinutes (integer) -- [REQUIRED]
  • PhoneNumberPoolCountries (list) --

    [REQUIRED]

    • (string) --
  • FallBackPhoneNumber (string) --
  • Disabled (boolean) --
Return type

dict

Returns

Response Syntax

{
    'Proxy': {
        'DefaultSessionExpiryMinutes': 123,
        'Disabled': True|False,
        'FallBackPhoneNumber': 'string',
        'PhoneNumberCountries': [
            'string',
        ]
    }
}

Response Structure

  • (dict) --
    • Proxy (dict) --
      • DefaultSessionExpiryMinutes (integer) --
      • Disabled (boolean) --
      • FallBackPhoneNumber (string) --
      • PhoneNumberCountries (list) --
        • (string) --

Exceptions

put_voice_connector_streaming_configuration(**kwargs)

See also: AWS API Documentation

Request Syntax

response = client.put_voice_connector_streaming_configuration(
    VoiceConnectorId='string',
    StreamingConfiguration={
        'DataRetentionInHours': 123,
        'Disabled': True|False,
        'StreamingNotificationTargets': [
            {
                'NotificationTarget': 'EventBridge'|'SNS'|'SQS'
            },
        ]
    }
)
Parameters
  • VoiceConnectorId (string) -- [REQUIRED]
  • StreamingConfiguration (dict) --

    [REQUIRED]

    • DataRetentionInHours (integer) -- [REQUIRED]
    • Disabled (boolean) -- [REQUIRED]
    • StreamingNotificationTargets (list) --
      • (dict) --
        • NotificationTarget (string) --
Return type

dict

Returns

Response Syntax

{
    'StreamingConfiguration': {
        'DataRetentionInHours': 123,
        'Disabled': True|False,
        'StreamingNotificationTargets': [
            {
                'NotificationTarget': 'EventBridge'|'SNS'|'SQS'
            },
        ]
    }
}

Response Structure

  • (dict) --
    • StreamingConfiguration (dict) --
      • DataRetentionInHours (integer) --
      • Disabled (boolean) --
      • StreamingNotificationTargets (list) --
        • (dict) --
          • NotificationTarget (string) --

Exceptions

put_voice_connector_termination(**kwargs)

See also: AWS API Documentation

Request Syntax

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

    [REQUIRED]

    • CpsLimit (integer) --
    • DefaultPhoneNumber (string) --
    • CallingRegions (list) --
      • (string) --
    • CidrAllowedList (list) --
      • (string) --
    • Disabled (boolean) --
Return type

dict

Returns

Response Syntax

{
    'Termination': {
        'CpsLimit': 123,
        'DefaultPhoneNumber': 'string',
        'CallingRegions': [
            'string',
        ],
        'CidrAllowedList': [
            'string',
        ],
        'Disabled': True|False
    }
}

Response Structure

  • (dict) --
    • Termination (dict) --
      • CpsLimit (integer) --
      • DefaultPhoneNumber (string) --
      • CallingRegions (list) --
        • (string) --
      • CidrAllowedList (list) --
        • (string) --
      • Disabled (boolean) --

Exceptions

put_voice_connector_termination_credentials(**kwargs)

See also: AWS API Documentation

Request Syntax

response = client.put_voice_connector_termination_credentials(
    VoiceConnectorId='string',
    Credentials=[
        {
            'Username': 'string',
            'Password': 'string'
        },
    ]
)
Parameters
  • VoiceConnectorId (string) -- [REQUIRED]
  • Credentials (list) --
    • (dict) --
      • Username (string) --
      • Password (string) --
Returns

None

Exceptions

restore_phone_number(**kwargs)

See also: AWS API Documentation

Request Syntax

response = client.restore_phone_number(
    PhoneNumberId='string'
)
Parameters
PhoneNumberId (string) -- [REQUIRED]
Return type
dict
Returns
Response Syntax
{
    'PhoneNumber': {
        'PhoneNumberId': 'string',
        'E164PhoneNumber': 'string',
        'Country': 'string',
        'Type': 'Local'|'TollFree',
        'ProductType': 'VoiceConnector'|'SipMediaApplicationDialIn',
        'Status': 'Cancelled'|'PortinCancelRequested'|'PortinInProgress'|'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': 'VoiceConnectorId'|'VoiceConnectorGroupId'|'SipRuleId',
                'AssociatedTimestamp': datetime(2015, 1, 1)
            },
        ],
        'CallingName': 'string',
        'CallingNameStatus': 'Unassigned'|'UpdateInProgress'|'UpdateSucceeded'|'UpdateFailed',
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1),
        'DeletionTimestamp': datetime(2015, 1, 1),
        'OrderId': 'string'
    }
}

Response Structure

  • (dict) --
    • PhoneNumber (dict) --
      • PhoneNumberId (string) --
      • E164PhoneNumber (string) --
      • Country (string) --
      • Type (string) --
      • ProductType (string) --
      • Status (string) --
      • Capabilities (dict) --
        • InboundCall (boolean) --
        • OutboundCall (boolean) --
        • InboundSMS (boolean) --
        • OutboundSMS (boolean) --
        • InboundMMS (boolean) --
        • OutboundMMS (boolean) --
      • Associations (list) --
        • (dict) --
          • Value (string) --
          • Name (string) --
          • AssociatedTimestamp (datetime) --
      • CallingName (string) --
      • CallingNameStatus (string) --
      • CreatedTimestamp (datetime) --
      • UpdatedTimestamp (datetime) --
      • DeletionTimestamp (datetime) --
      • OrderId (string) --

Exceptions

search_available_phone_numbers(**kwargs)

See also: AWS API Documentation

Request Syntax

response = client.search_available_phone_numbers(
    AreaCode='string',
    City='string',
    Country='string',
    State='string',
    TollFreePrefix='string',
    PhoneNumberType='Local'|'TollFree',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • AreaCode (string) --
  • City (string) --
  • Country (string) --
  • State (string) --
  • TollFreePrefix (string) --
  • PhoneNumberType (string) --
  • MaxResults (integer) --
  • NextToken (string) --
Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) --
    • E164PhoneNumbers (list) --
      • (string) --
    • NextToken (string) --

Exceptions

update_global_settings(**kwargs)

See also: AWS API Documentation

Request Syntax

response = client.update_global_settings(
    VoiceConnector={
        'CdrBucket': 'string'
    }
)
Parameters
VoiceConnector (dict) --
  • CdrBucket (string) --
Returns
None

Exceptions

update_phone_number(**kwargs)

See also: AWS API Documentation

Request Syntax

response = client.update_phone_number(
    PhoneNumberId='string',
    ProductType='VoiceConnector'|'SipMediaApplicationDialIn',
    CallingName='string'
)
Parameters
  • PhoneNumberId (string) -- [REQUIRED]
  • ProductType (string) --
  • CallingName (string) --
Return type

dict

Returns

Response Syntax

{
    'PhoneNumber': {
        'PhoneNumberId': 'string',
        'E164PhoneNumber': 'string',
        'Country': 'string',
        'Type': 'Local'|'TollFree',
        'ProductType': 'VoiceConnector'|'SipMediaApplicationDialIn',
        'Status': 'Cancelled'|'PortinCancelRequested'|'PortinInProgress'|'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': 'VoiceConnectorId'|'VoiceConnectorGroupId'|'SipRuleId',
                'AssociatedTimestamp': datetime(2015, 1, 1)
            },
        ],
        'CallingName': 'string',
        'CallingNameStatus': 'Unassigned'|'UpdateInProgress'|'UpdateSucceeded'|'UpdateFailed',
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1),
        'DeletionTimestamp': datetime(2015, 1, 1),
        'OrderId': 'string'
    }
}

Response Structure

  • (dict) --
    • PhoneNumber (dict) --
      • PhoneNumberId (string) --
      • E164PhoneNumber (string) --
      • Country (string) --
      • Type (string) --
      • ProductType (string) --
      • Status (string) --
      • Capabilities (dict) --
        • InboundCall (boolean) --
        • OutboundCall (boolean) --
        • InboundSMS (boolean) --
        • OutboundSMS (boolean) --
        • InboundMMS (boolean) --
        • OutboundMMS (boolean) --
      • Associations (list) --
        • (dict) --
          • Value (string) --
          • Name (string) --
          • AssociatedTimestamp (datetime) --
      • CallingName (string) --
      • CallingNameStatus (string) --
      • CreatedTimestamp (datetime) --
      • UpdatedTimestamp (datetime) --
      • DeletionTimestamp (datetime) --
      • OrderId (string) --

Exceptions

update_phone_number_settings(**kwargs)

See also: AWS API Documentation

Request Syntax

response = client.update_phone_number_settings(
    CallingName='string'
)
Parameters
CallingName (string) -- [REQUIRED]
Returns
None

Exceptions

update_proxy_session(**kwargs)

See also: AWS API Documentation

Request Syntax

response = client.update_proxy_session(
    VoiceConnectorId='string',
    ProxySessionId='string',
    Capabilities=[
        'Voice'|'SMS',
    ],
    ExpiryMinutes=123
)
Parameters
  • VoiceConnectorId (string) -- [REQUIRED]
  • ProxySessionId (string) -- [REQUIRED]
  • Capabilities (list) --

    [REQUIRED]

    • (string) --
  • ExpiryMinutes (integer) --
Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) --
    • ProxySession (dict) --
      • VoiceConnectorId (string) --
      • ProxySessionId (string) --
      • Name (string) --
      • Status (string) --
      • ExpiryMinutes (integer) --
      • Capabilities (list) --
        • (string) --
      • CreatedTimestamp (datetime) --
      • UpdatedTimestamp (datetime) --
      • EndedTimestamp (datetime) --
      • Participants (list) --
        • (dict) --
          • PhoneNumber (string) --
          • ProxyPhoneNumber (string) --
      • NumberSelectionBehavior (string) --
      • GeoMatchLevel (string) --
      • GeoMatchParams (dict) --
        • Country (string) --
        • AreaCode (string) --

Exceptions

update_sip_media_application(**kwargs)

See also: AWS API Documentation

Request Syntax

response = client.update_sip_media_application(
    SipMediaApplicationId='string',
    Name='string',
    Endpoints=[
        {
            'LambdaArn': 'string'
        },
    ]
)
Parameters
  • SipMediaApplicationId (string) -- [REQUIRED]
  • Name (string) --
  • Endpoints (list) --
    • (dict) --
      • LambdaArn (string) --
Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) --
    • SipMediaApplication (dict) --
      • SipMediaApplicationId (string) --
      • AwsRegion (string) --
      • Name (string) --
      • Endpoints (list) --
        • (dict) --
          • LambdaArn (string) --
      • CreatedTimestamp (datetime) --
      • UpdatedTimestamp (datetime) --

Exceptions

update_sip_media_application_call(**kwargs)

See also: AWS API Documentation

Request Syntax

response = client.update_sip_media_application_call(
    SipMediaApplicationId='string',
    TransactionId='string',
    Arguments={
        'string': 'string'
    }
)
Parameters
  • SipMediaApplicationId (string) -- [REQUIRED]
  • TransactionId (string) -- [REQUIRED]
  • Arguments (dict) --

    [REQUIRED]

    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) --
    • SipMediaApplicationCall (dict) --
      • TransactionId (string) --

Exceptions

update_sip_rule(**kwargs)

See also: AWS API Documentation

Request Syntax

response = client.update_sip_rule(
    SipRuleId='string',
    Name='string',
    Disabled=True|False,
    TargetApplications=[
        {
            'SipMediaApplicationId': 'string',
            'Priority': 123,
            'AwsRegion': 'string'
        },
    ]
)
Parameters
  • SipRuleId (string) -- [REQUIRED]
  • Name (string) -- [REQUIRED]
  • Disabled (boolean) --
  • TargetApplications (list) --
    • (dict) --
      • SipMediaApplicationId (string) --
      • Priority (integer) --
      • AwsRegion (string) --
Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) --
    • SipRule (dict) --
      • SipRuleId (string) --
      • Name (string) --
      • Disabled (boolean) --
      • TriggerType (string) --
      • TriggerValue (string) --
      • TargetApplications (list) --
        • (dict) --
          • SipMediaApplicationId (string) --
          • Priority (integer) --
          • AwsRegion (string) --
      • CreatedTimestamp (datetime) --
      • UpdatedTimestamp (datetime) --

Exceptions

update_voice_connector(**kwargs)

See also: AWS API Documentation

Request Syntax

response = client.update_voice_connector(
    VoiceConnectorId='string',
    Name='string',
    RequireEncryption=True|False
)
Parameters
  • VoiceConnectorId (string) -- [REQUIRED]
  • Name (string) -- [REQUIRED]
  • RequireEncryption (boolean) -- [REQUIRED]
Return type

dict

Returns

Response Syntax

{
    'VoiceConnector': {
        'VoiceConnectorId': 'string',
        'AwsRegion': 'us-east-1'|'us-west-2'|'ca-central-1'|'eu-central-1'|'eu-west-1'|'eu-west-2'|'ap-northeast-2'|'ap-northeast-1'|'ap-southeast-1'|'ap-southeast-2',
        'Name': 'string',
        'OutboundHostName': 'string',
        'RequireEncryption': True|False,
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1),
        'VoiceConnectorArn': 'string'
    }
}

Response Structure

  • (dict) --
    • VoiceConnector (dict) --
      • VoiceConnectorId (string) --
      • AwsRegion (string) --
      • Name (string) --
      • OutboundHostName (string) --
      • RequireEncryption (boolean) --
      • CreatedTimestamp (datetime) --
      • UpdatedTimestamp (datetime) --
      • VoiceConnectorArn (string) --

Exceptions

update_voice_connector_group(**kwargs)

See also: AWS API Documentation

Request Syntax

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

    [REQUIRED]

    • (dict) --
      • VoiceConnectorId (string) -- [REQUIRED]
      • Priority (integer) -- [REQUIRED]
Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) --
    • VoiceConnectorGroup (dict) --
      • VoiceConnectorGroupId (string) --
      • Name (string) --
      • VoiceConnectorItems (list) --
        • (dict) --
          • VoiceConnectorId (string) --
          • Priority (integer) --
      • CreatedTimestamp (datetime) --
      • UpdatedTimestamp (datetime) --
      • VoiceConnectorGroupArn (string) --

Exceptions

validate_e911_address(**kwargs)

See also: AWS API Documentation

Request Syntax

response = client.validate_e911_address(
    AwsAccountId='string',
    StreetNumber='string',
    StreetInfo='string',
    City='string',
    State='string',
    Country='string',
    PostalCode='string'
)
Parameters
  • AwsAccountId (string) -- [REQUIRED]
  • StreetNumber (string) -- [REQUIRED]
  • StreetInfo (string) -- [REQUIRED]
  • City (string) -- [REQUIRED]
  • State (string) -- [REQUIRED]
  • Country (string) -- [REQUIRED]
  • PostalCode (string) -- [REQUIRED]
Return type

dict

Returns

Response Syntax

{
    'ValidationResult': 123,
    'AddressExternalId': 'string',
    'Address': {
        'streetName': 'string',
        'streetSuffix': 'string',
        'postDirectional': 'string',
        'preDirectional': 'string',
        'streetNumber': 'string',
        'city': 'string',
        'state': 'string',
        'postalCode': 'string',
        'postalCodePlus4': 'string',
        'country': 'string'
    },
    'CandidateAddressList': [
        {
            'streetInfo': 'string',
            'streetNumber': 'string',
            'city': 'string',
            'state': 'string',
            'postalCode': 'string',
            'postalCodePlus4': 'string',
            'country': 'string'
        },
    ]
}

Response Structure

  • (dict) --
    • ValidationResult (integer) --
    • AddressExternalId (string) --
    • Address (dict) --
      • streetName (string) --
      • streetSuffix (string) --
      • postDirectional (string) --
      • preDirectional (string) --
      • streetNumber (string) --
      • city (string) --
      • state (string) --
      • postalCode (string) --
      • postalCodePlus4 (string) --
      • country (string) --
    • CandidateAddressList (list) --
      • (dict) --
        • streetInfo (string) --
        • streetNumber (string) --
        • city (string) --
        • state (string) --
        • postalCode (string) --
        • postalCodePlus4 (string) --
        • country (string) --

Exceptions

Client Exceptions

Client exceptions are available on a client instance via the exceptions property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.

The available client exceptions are:

class ChimeSDKVoice.Client.exceptions.AccessDeniedException

Example

try:
  ...
except client.exceptions.AccessDeniedException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class ChimeSDKVoice.Client.exceptions.BadRequestException

Example

try:
  ...
except client.exceptions.BadRequestException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class ChimeSDKVoice.Client.exceptions.ConflictException

Example

try:
  ...
except client.exceptions.ConflictException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class ChimeSDKVoice.Client.exceptions.ForbiddenException

Example

try:
  ...
except client.exceptions.ForbiddenException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class ChimeSDKVoice.Client.exceptions.NotFoundException

Example

try:
  ...
except client.exceptions.NotFoundException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class ChimeSDKVoice.Client.exceptions.ResourceLimitExceededException

Example

try:
  ...
except client.exceptions.ResourceLimitExceededException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class ChimeSDKVoice.Client.exceptions.ServiceFailureException

Example

try:
  ...
except client.exceptions.ServiceFailureException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class ChimeSDKVoice.Client.exceptions.ServiceUnavailableException

Example

try:
  ...
except client.exceptions.ServiceUnavailableException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class ChimeSDKVoice.Client.exceptions.ThrottledClientException

Example

try:
  ...
except client.exceptions.ThrottledClientException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class ChimeSDKVoice.Client.exceptions.UnauthorizedClientException

Example

try:
  ...
except client.exceptions.UnauthorizedClientException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.

Paginators

The available paginators are:

class ChimeSDKVoice.Paginator.ListSipMediaApplications
paginator = client.get_paginator('list_sip_media_applications')
paginate(**kwargs)

Creates an iterator that will paginate through responses from ChimeSDKVoice.Client.list_sip_media_applications().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
PaginationConfig (dict) --

A dictionary that provides parameters to control pagination.

  • MaxItems (integer) --

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) --

    The size of each page.

  • StartingToken (string) --

    A token to specify where to start paginating. This is the NextToken from a previous response.

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

}

Response Structure

  • (dict) --
    • SipMediaApplications (list) --
      • (dict) --
        • SipMediaApplicationId (string) --
        • AwsRegion (string) --
        • Name (string) --
        • Endpoints (list) --
          • (dict) --
            • LambdaArn (string) --
        • CreatedTimestamp (datetime) --
        • UpdatedTimestamp (datetime) --
class ChimeSDKVoice.Paginator.ListSipRules
paginator = client.get_paginator('list_sip_rules')
paginate(**kwargs)

Creates an iterator that will paginate through responses from ChimeSDKVoice.Client.list_sip_rules().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    SipMediaApplicationId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • SipMediaApplicationId (string) --
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

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

}

Response Structure

  • (dict) --
    • SipRules (list) --
      • (dict) --
        • SipRuleId (string) --
        • Name (string) --
        • Disabled (boolean) --
        • TriggerType (string) --
        • TriggerValue (string) --
        • TargetApplications (list) --
          • (dict) --
            • SipMediaApplicationId (string) --
            • Priority (integer) --
            • AwsRegion (string) --
        • CreatedTimestamp (datetime) --
        • UpdatedTimestamp (datetime) --