Table of Contents
ChimeSDKVoice.Client¶A low-level client representing Amazon Chime SDK Voice
import boto3
client = boto3.client('chime-sdk-voice')
These are the available methods:
associate_phone_numbers_with_voice_connector()associate_phone_numbers_with_voice_connector_group()batch_delete_phone_number()batch_update_phone_number()can_paginate()close()create_phone_number_order()create_proxy_session()create_sip_media_application()create_sip_media_application_call()create_sip_rule()create_voice_connector()create_voice_connector_group()delete_phone_number()delete_proxy_session()delete_sip_media_application()delete_sip_rule()delete_voice_connector()delete_voice_connector_emergency_calling_configuration()delete_voice_connector_group()delete_voice_connector_origination()delete_voice_connector_proxy()delete_voice_connector_streaming_configuration()delete_voice_connector_termination()delete_voice_connector_termination_credentials()disassociate_phone_numbers_from_voice_connector()disassociate_phone_numbers_from_voice_connector_group()get_global_settings()get_paginator()get_phone_number()get_phone_number_order()get_phone_number_settings()get_proxy_session()get_sip_media_application()get_sip_media_application_alexa_skill_configuration()get_sip_media_application_logging_configuration()get_sip_rule()get_voice_connector()get_voice_connector_emergency_calling_configuration()get_voice_connector_group()get_voice_connector_logging_configuration()get_voice_connector_origination()get_voice_connector_proxy()get_voice_connector_streaming_configuration()get_voice_connector_termination()get_voice_connector_termination_health()get_waiter()list_available_voice_connector_regions()list_phone_number_orders()list_phone_numbers()list_proxy_sessions()list_sip_media_applications()list_sip_rules()list_supported_phone_number_countries()list_voice_connector_groups()list_voice_connector_termination_credentials()list_voice_connectors()put_sip_media_application_alexa_skill_configuration()put_sip_media_application_logging_configuration()put_voice_connector_emergency_calling_configuration()put_voice_connector_logging_configuration()put_voice_connector_origination()put_voice_connector_proxy()put_voice_connector_streaming_configuration()put_voice_connector_termination()put_voice_connector_termination_credentials()restore_phone_number()search_available_phone_numbers()update_global_settings()update_phone_number()update_phone_number_settings()update_proxy_session()update_sip_media_application()update_sip_media_application_call()update_sip_rule()update_voice_connector()update_voice_connector_group()validate_e911_address()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
)
[REQUIRED]
dict
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
Exceptions
ChimeSDKVoice.Client.exceptions.UnauthorizedClientExceptionChimeSDKVoice.Client.exceptions.NotFoundExceptionChimeSDKVoice.Client.exceptions.ForbiddenExceptionChimeSDKVoice.Client.exceptions.BadRequestExceptionChimeSDKVoice.Client.exceptions.AccessDeniedExceptionChimeSDKVoice.Client.exceptions.ThrottledClientExceptionChimeSDKVoice.Client.exceptions.ServiceUnavailableExceptionChimeSDKVoice.Client.exceptions.ServiceFailureExceptionassociate_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
)
[REQUIRED]
dict
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
Exceptions
ChimeSDKVoice.Client.exceptions.UnauthorizedClientExceptionChimeSDKVoice.Client.exceptions.NotFoundExceptionChimeSDKVoice.Client.exceptions.ForbiddenExceptionChimeSDKVoice.Client.exceptions.BadRequestExceptionChimeSDKVoice.Client.exceptions.AccessDeniedExceptionChimeSDKVoice.Client.exceptions.ThrottledClientExceptionChimeSDKVoice.Client.exceptions.ServiceUnavailableExceptionChimeSDKVoice.Client.exceptions.ServiceFailureExceptionbatch_delete_phone_number(**kwargs)¶See also: AWS API Documentation
Request Syntax
response = client.batch_delete_phone_number(
PhoneNumberIds=[
'string',
]
)
[REQUIRED]
{
'PhoneNumberErrors': [
{
'PhoneNumberId': 'string',
'ErrorCode': 'BadRequest'|'Conflict'|'Forbidden'|'NotFound'|'PreconditionFailed'|'ResourceLimitExceeded'|'ServiceFailure'|'AccessDenied'|'ServiceUnavailable'|'Throttled'|'Throttling'|'Unauthorized'|'Unprocessable'|'VoiceConnectorGroupAssociationsExist'|'PhoneNumberAssociationsExist'|'Gone',
'ErrorMessage': 'string'
},
]
}
Response Structure
Exceptions
ChimeSDKVoice.Client.exceptions.UnauthorizedClientExceptionChimeSDKVoice.Client.exceptions.NotFoundExceptionChimeSDKVoice.Client.exceptions.ForbiddenExceptionChimeSDKVoice.Client.exceptions.BadRequestExceptionChimeSDKVoice.Client.exceptions.ThrottledClientExceptionChimeSDKVoice.Client.exceptions.ServiceUnavailableExceptionChimeSDKVoice.Client.exceptions.ServiceFailureExceptionbatch_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'
},
]
)
[REQUIRED]
{
'PhoneNumberErrors': [
{
'PhoneNumberId': 'string',
'ErrorCode': 'BadRequest'|'Conflict'|'Forbidden'|'NotFound'|'PreconditionFailed'|'ResourceLimitExceeded'|'ServiceFailure'|'AccessDenied'|'ServiceUnavailable'|'Throttled'|'Throttling'|'Unauthorized'|'Unprocessable'|'VoiceConnectorGroupAssociationsExist'|'PhoneNumberAssociationsExist'|'Gone',
'ErrorMessage': 'string'
},
]
}
Response Structure
Exceptions
ChimeSDKVoice.Client.exceptions.UnauthorizedClientExceptionChimeSDKVoice.Client.exceptions.NotFoundExceptionChimeSDKVoice.Client.exceptions.ForbiddenExceptionChimeSDKVoice.Client.exceptions.BadRequestExceptionChimeSDKVoice.Client.exceptions.ThrottledClientExceptionChimeSDKVoice.Client.exceptions.ServiceUnavailableExceptionChimeSDKVoice.Client.exceptions.ServiceFailureExceptioncan_paginate(operation_name)¶Check if an operation can be paginated.
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").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',
]
)
[REQUIRED]
dict
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
Exceptions
ChimeSDKVoice.Client.exceptions.BadRequestExceptionChimeSDKVoice.Client.exceptions.ForbiddenExceptionChimeSDKVoice.Client.exceptions.AccessDeniedExceptionChimeSDKVoice.Client.exceptions.UnauthorizedClientExceptionChimeSDKVoice.Client.exceptions.ThrottledClientExceptionChimeSDKVoice.Client.exceptions.ResourceLimitExceededExceptionChimeSDKVoice.Client.exceptions.ServiceUnavailableExceptionChimeSDKVoice.Client.exceptions.ServiceFailureExceptioncreate_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'
}
)
[REQUIRED]
[REQUIRED]
dict
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
Exceptions
ChimeSDKVoice.Client.exceptions.UnauthorizedClientExceptionChimeSDKVoice.Client.exceptions.NotFoundExceptionChimeSDKVoice.Client.exceptions.ForbiddenExceptionChimeSDKVoice.Client.exceptions.BadRequestExceptionChimeSDKVoice.Client.exceptions.ThrottledClientExceptionChimeSDKVoice.Client.exceptions.ServiceUnavailableExceptionChimeSDKVoice.Client.exceptions.ServiceFailureExceptioncreate_sip_media_application(**kwargs)¶See also: AWS API Documentation
Request Syntax
response = client.create_sip_media_application(
AwsRegion='string',
Name='string',
Endpoints=[
{
'LambdaArn': 'string'
},
]
)
[REQUIRED]
dict
Response Syntax
{
'SipMediaApplication': {
'SipMediaApplicationId': 'string',
'AwsRegion': 'string',
'Name': 'string',
'Endpoints': [
{
'LambdaArn': 'string'
},
],
'CreatedTimestamp': datetime(2015, 1, 1),
'UpdatedTimestamp': datetime(2015, 1, 1)
}
}
Response Structure
Exceptions
ChimeSDKVoice.Client.exceptions.BadRequestExceptionChimeSDKVoice.Client.exceptions.ForbiddenExceptionChimeSDKVoice.Client.exceptions.AccessDeniedExceptionChimeSDKVoice.Client.exceptions.UnauthorizedClientExceptionChimeSDKVoice.Client.exceptions.ThrottledClientExceptionChimeSDKVoice.Client.exceptions.ResourceLimitExceededExceptionChimeSDKVoice.Client.exceptions.ConflictExceptionChimeSDKVoice.Client.exceptions.ServiceUnavailableExceptionChimeSDKVoice.Client.exceptions.ServiceFailureExceptioncreate_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'
}
)
dict
Response Syntax
{
'SipMediaApplicationCall': {
'TransactionId': 'string'
}
}
Response Structure
Exceptions
ChimeSDKVoice.Client.exceptions.BadRequestExceptionChimeSDKVoice.Client.exceptions.ForbiddenExceptionChimeSDKVoice.Client.exceptions.ResourceLimitExceededExceptionChimeSDKVoice.Client.exceptions.ThrottledClientExceptionChimeSDKVoice.Client.exceptions.UnauthorizedClientExceptionChimeSDKVoice.Client.exceptions.AccessDeniedExceptionChimeSDKVoice.Client.exceptions.ServiceUnavailableExceptionChimeSDKVoice.Client.exceptions.ServiceFailureExceptioncreate_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'
},
]
)
dict
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
Exceptions
ChimeSDKVoice.Client.exceptions.BadRequestExceptionChimeSDKVoice.Client.exceptions.ForbiddenExceptionChimeSDKVoice.Client.exceptions.AccessDeniedExceptionChimeSDKVoice.Client.exceptions.UnauthorizedClientExceptionChimeSDKVoice.Client.exceptions.ThrottledClientExceptionChimeSDKVoice.Client.exceptions.ResourceLimitExceededExceptionChimeSDKVoice.Client.exceptions.ConflictExceptionChimeSDKVoice.Client.exceptions.ServiceUnavailableExceptionChimeSDKVoice.Client.exceptions.ServiceFailureExceptioncreate_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
)
dict
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
Exceptions
ChimeSDKVoice.Client.exceptions.BadRequestExceptionChimeSDKVoice.Client.exceptions.ForbiddenExceptionChimeSDKVoice.Client.exceptions.AccessDeniedExceptionChimeSDKVoice.Client.exceptions.UnauthorizedClientExceptionChimeSDKVoice.Client.exceptions.ThrottledClientExceptionChimeSDKVoice.Client.exceptions.ResourceLimitExceededExceptionChimeSDKVoice.Client.exceptions.ServiceUnavailableExceptionChimeSDKVoice.Client.exceptions.ServiceFailureExceptioncreate_voice_connector_group(**kwargs)¶See also: AWS API Documentation
Request Syntax
response = client.create_voice_connector_group(
Name='string',
VoiceConnectorItems=[
{
'VoiceConnectorId': 'string',
'Priority': 123
},
]
)
dict
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
Exceptions
ChimeSDKVoice.Client.exceptions.BadRequestExceptionChimeSDKVoice.Client.exceptions.ForbiddenExceptionChimeSDKVoice.Client.exceptions.AccessDeniedExceptionChimeSDKVoice.Client.exceptions.UnauthorizedClientExceptionChimeSDKVoice.Client.exceptions.ThrottledClientExceptionChimeSDKVoice.Client.exceptions.ResourceLimitExceededExceptionChimeSDKVoice.Client.exceptions.ServiceUnavailableExceptionChimeSDKVoice.Client.exceptions.ServiceFailureExceptiondelete_phone_number(**kwargs)¶See also: AWS API Documentation
Request Syntax
response = client.delete_phone_number(
PhoneNumberId='string'
)
Exceptions
ChimeSDKVoice.Client.exceptions.UnauthorizedClientExceptionChimeSDKVoice.Client.exceptions.NotFoundExceptionChimeSDKVoice.Client.exceptions.ForbiddenExceptionChimeSDKVoice.Client.exceptions.BadRequestExceptionChimeSDKVoice.Client.exceptions.ThrottledClientExceptionChimeSDKVoice.Client.exceptions.ServiceUnavailableExceptionChimeSDKVoice.Client.exceptions.ServiceFailureExceptiondelete_proxy_session(**kwargs)¶See also: AWS API Documentation
Request Syntax
response = client.delete_proxy_session(
VoiceConnectorId='string',
ProxySessionId='string'
)
None
Exceptions
ChimeSDKVoice.Client.exceptions.UnauthorizedClientExceptionChimeSDKVoice.Client.exceptions.NotFoundExceptionChimeSDKVoice.Client.exceptions.ForbiddenExceptionChimeSDKVoice.Client.exceptions.BadRequestExceptionChimeSDKVoice.Client.exceptions.ThrottledClientExceptionChimeSDKVoice.Client.exceptions.ServiceUnavailableExceptionChimeSDKVoice.Client.exceptions.ServiceFailureExceptiondelete_sip_media_application(**kwargs)¶See also: AWS API Documentation
Request Syntax
response = client.delete_sip_media_application(
SipMediaApplicationId='string'
)
Exceptions
ChimeSDKVoice.Client.exceptions.UnauthorizedClientExceptionChimeSDKVoice.Client.exceptions.NotFoundExceptionChimeSDKVoice.Client.exceptions.ForbiddenExceptionChimeSDKVoice.Client.exceptions.BadRequestExceptionChimeSDKVoice.Client.exceptions.ConflictExceptionChimeSDKVoice.Client.exceptions.ThrottledClientExceptionChimeSDKVoice.Client.exceptions.ServiceUnavailableExceptionChimeSDKVoice.Client.exceptions.ServiceFailureExceptiondelete_sip_rule(**kwargs)¶See also: AWS API Documentation
Request Syntax
response = client.delete_sip_rule(
SipRuleId='string'
)
Exceptions
ChimeSDKVoice.Client.exceptions.UnauthorizedClientExceptionChimeSDKVoice.Client.exceptions.NotFoundExceptionChimeSDKVoice.Client.exceptions.ForbiddenExceptionChimeSDKVoice.Client.exceptions.BadRequestExceptionChimeSDKVoice.Client.exceptions.ConflictExceptionChimeSDKVoice.Client.exceptions.ThrottledClientExceptionChimeSDKVoice.Client.exceptions.ServiceUnavailableExceptionChimeSDKVoice.Client.exceptions.ServiceFailureExceptiondelete_voice_connector(**kwargs)¶See also: AWS API Documentation
Request Syntax
response = client.delete_voice_connector(
VoiceConnectorId='string'
)
Exceptions
ChimeSDKVoice.Client.exceptions.UnauthorizedClientExceptionChimeSDKVoice.Client.exceptions.NotFoundExceptionChimeSDKVoice.Client.exceptions.ForbiddenExceptionChimeSDKVoice.Client.exceptions.BadRequestExceptionChimeSDKVoice.Client.exceptions.ConflictExceptionChimeSDKVoice.Client.exceptions.ThrottledClientExceptionChimeSDKVoice.Client.exceptions.ServiceUnavailableExceptionChimeSDKVoice.Client.exceptions.ServiceFailureExceptiondelete_voice_connector_emergency_calling_configuration(**kwargs)¶See also: AWS API Documentation
Request Syntax
response = client.delete_voice_connector_emergency_calling_configuration(
VoiceConnectorId='string'
)
Exceptions
ChimeSDKVoice.Client.exceptions.UnauthorizedClientExceptionChimeSDKVoice.Client.exceptions.NotFoundExceptionChimeSDKVoice.Client.exceptions.ForbiddenExceptionChimeSDKVoice.Client.exceptions.BadRequestExceptionChimeSDKVoice.Client.exceptions.ThrottledClientExceptionChimeSDKVoice.Client.exceptions.ServiceUnavailableExceptionChimeSDKVoice.Client.exceptions.ServiceFailureExceptiondelete_voice_connector_group(**kwargs)¶See also: AWS API Documentation
Request Syntax
response = client.delete_voice_connector_group(
VoiceConnectorGroupId='string'
)
Exceptions
ChimeSDKVoice.Client.exceptions.UnauthorizedClientExceptionChimeSDKVoice.Client.exceptions.NotFoundExceptionChimeSDKVoice.Client.exceptions.ForbiddenExceptionChimeSDKVoice.Client.exceptions.BadRequestExceptionChimeSDKVoice.Client.exceptions.ConflictExceptionChimeSDKVoice.Client.exceptions.ThrottledClientExceptionChimeSDKVoice.Client.exceptions.ServiceUnavailableExceptionChimeSDKVoice.Client.exceptions.ServiceFailureExceptiondelete_voice_connector_origination(**kwargs)¶See also: AWS API Documentation
Request Syntax
response = client.delete_voice_connector_origination(
VoiceConnectorId='string'
)
Exceptions
ChimeSDKVoice.Client.exceptions.UnauthorizedClientExceptionChimeSDKVoice.Client.exceptions.NotFoundExceptionChimeSDKVoice.Client.exceptions.ForbiddenExceptionChimeSDKVoice.Client.exceptions.BadRequestExceptionChimeSDKVoice.Client.exceptions.ThrottledClientExceptionChimeSDKVoice.Client.exceptions.ServiceUnavailableExceptionChimeSDKVoice.Client.exceptions.ServiceFailureExceptiondelete_voice_connector_proxy(**kwargs)¶See also: AWS API Documentation
Request Syntax
response = client.delete_voice_connector_proxy(
VoiceConnectorId='string'
)
Exceptions
ChimeSDKVoice.Client.exceptions.UnauthorizedClientExceptionChimeSDKVoice.Client.exceptions.NotFoundExceptionChimeSDKVoice.Client.exceptions.ForbiddenExceptionChimeSDKVoice.Client.exceptions.BadRequestExceptionChimeSDKVoice.Client.exceptions.ThrottledClientExceptionChimeSDKVoice.Client.exceptions.ServiceUnavailableExceptionChimeSDKVoice.Client.exceptions.ServiceFailureExceptiondelete_voice_connector_streaming_configuration(**kwargs)¶See also: AWS API Documentation
Request Syntax
response = client.delete_voice_connector_streaming_configuration(
VoiceConnectorId='string'
)
Exceptions
ChimeSDKVoice.Client.exceptions.UnauthorizedClientExceptionChimeSDKVoice.Client.exceptions.NotFoundExceptionChimeSDKVoice.Client.exceptions.ForbiddenExceptionChimeSDKVoice.Client.exceptions.BadRequestExceptionChimeSDKVoice.Client.exceptions.ThrottledClientExceptionChimeSDKVoice.Client.exceptions.ServiceUnavailableExceptionChimeSDKVoice.Client.exceptions.ServiceFailureExceptiondelete_voice_connector_termination(**kwargs)¶See also: AWS API Documentation
Request Syntax
response = client.delete_voice_connector_termination(
VoiceConnectorId='string'
)
Exceptions
ChimeSDKVoice.Client.exceptions.UnauthorizedClientExceptionChimeSDKVoice.Client.exceptions.NotFoundExceptionChimeSDKVoice.Client.exceptions.ForbiddenExceptionChimeSDKVoice.Client.exceptions.BadRequestExceptionChimeSDKVoice.Client.exceptions.ThrottledClientExceptionChimeSDKVoice.Client.exceptions.ServiceUnavailableExceptionChimeSDKVoice.Client.exceptions.ServiceFailureExceptiondelete_voice_connector_termination_credentials(**kwargs)¶See also: AWS API Documentation
Request Syntax
response = client.delete_voice_connector_termination_credentials(
VoiceConnectorId='string',
Usernames=[
'string',
]
)
[REQUIRED]
None
Exceptions
ChimeSDKVoice.Client.exceptions.UnauthorizedClientExceptionChimeSDKVoice.Client.exceptions.NotFoundExceptionChimeSDKVoice.Client.exceptions.ForbiddenExceptionChimeSDKVoice.Client.exceptions.BadRequestExceptionChimeSDKVoice.Client.exceptions.ThrottledClientExceptionChimeSDKVoice.Client.exceptions.ServiceUnavailableExceptionChimeSDKVoice.Client.exceptions.ServiceFailureExceptiondisassociate_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',
]
)
[REQUIRED]
dict
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
Exceptions
ChimeSDKVoice.Client.exceptions.UnauthorizedClientExceptionChimeSDKVoice.Client.exceptions.NotFoundExceptionChimeSDKVoice.Client.exceptions.ForbiddenExceptionChimeSDKVoice.Client.exceptions.BadRequestExceptionChimeSDKVoice.Client.exceptions.ThrottledClientExceptionChimeSDKVoice.Client.exceptions.ServiceUnavailableExceptionChimeSDKVoice.Client.exceptions.ServiceFailureExceptiondisassociate_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',
]
)
[REQUIRED]
dict
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
Exceptions
ChimeSDKVoice.Client.exceptions.UnauthorizedClientExceptionChimeSDKVoice.Client.exceptions.NotFoundExceptionChimeSDKVoice.Client.exceptions.ForbiddenExceptionChimeSDKVoice.Client.exceptions.BadRequestExceptionChimeSDKVoice.Client.exceptions.ThrottledClientExceptionChimeSDKVoice.Client.exceptions.ServiceUnavailableExceptionChimeSDKVoice.Client.exceptions.ServiceFailureExceptionget_global_settings()¶See also: AWS API Documentation
Request Syntax
response = client.get_global_settings()
{
'VoiceConnector': {
'CdrBucket': 'string'
}
}
Response Structure
Exceptions
ChimeSDKVoice.Client.exceptions.UnauthorizedClientExceptionChimeSDKVoice.Client.exceptions.ForbiddenExceptionChimeSDKVoice.Client.exceptions.BadRequestExceptionChimeSDKVoice.Client.exceptions.ThrottledClientExceptionChimeSDKVoice.Client.exceptions.ServiceUnavailableExceptionChimeSDKVoice.Client.exceptions.ServiceFailureExceptionget_paginator(operation_name)¶Create a paginator for an operation.
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").client.can_paginate method to
check if an operation is pageable.get_phone_number(**kwargs)¶See also: AWS API Documentation
Request Syntax
response = client.get_phone_number(
PhoneNumberId='string'
)
{
'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
Exceptions
ChimeSDKVoice.Client.exceptions.UnauthorizedClientExceptionChimeSDKVoice.Client.exceptions.NotFoundExceptionChimeSDKVoice.Client.exceptions.ForbiddenExceptionChimeSDKVoice.Client.exceptions.BadRequestExceptionChimeSDKVoice.Client.exceptions.ThrottledClientExceptionChimeSDKVoice.Client.exceptions.ServiceUnavailableExceptionChimeSDKVoice.Client.exceptions.ServiceFailureExceptionget_phone_number_order(**kwargs)¶See also: AWS API Documentation
Request Syntax
response = client.get_phone_number_order(
PhoneNumberOrderId='string'
)
{
'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
Exceptions
ChimeSDKVoice.Client.exceptions.UnauthorizedClientExceptionChimeSDKVoice.Client.exceptions.NotFoundExceptionChimeSDKVoice.Client.exceptions.ForbiddenExceptionChimeSDKVoice.Client.exceptions.BadRequestExceptionChimeSDKVoice.Client.exceptions.ThrottledClientExceptionChimeSDKVoice.Client.exceptions.ServiceUnavailableExceptionChimeSDKVoice.Client.exceptions.ServiceFailureExceptionget_phone_number_settings()¶See also: AWS API Documentation
Request Syntax
response = client.get_phone_number_settings()
{
'CallingName': 'string',
'CallingNameUpdatedTimestamp': datetime(2015, 1, 1)
}
Response Structure
Exceptions
ChimeSDKVoice.Client.exceptions.UnauthorizedClientExceptionChimeSDKVoice.Client.exceptions.ForbiddenExceptionChimeSDKVoice.Client.exceptions.BadRequestExceptionChimeSDKVoice.Client.exceptions.ThrottledClientExceptionChimeSDKVoice.Client.exceptions.ServiceUnavailableExceptionChimeSDKVoice.Client.exceptions.ServiceFailureExceptionget_proxy_session(**kwargs)¶See also: AWS API Documentation
Request Syntax
response = client.get_proxy_session(
VoiceConnectorId='string',
ProxySessionId='string'
)
dict
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
Exceptions
ChimeSDKVoice.Client.exceptions.UnauthorizedClientExceptionChimeSDKVoice.Client.exceptions.NotFoundExceptionChimeSDKVoice.Client.exceptions.ForbiddenExceptionChimeSDKVoice.Client.exceptions.BadRequestExceptionChimeSDKVoice.Client.exceptions.ThrottledClientExceptionChimeSDKVoice.Client.exceptions.ServiceUnavailableExceptionChimeSDKVoice.Client.exceptions.ServiceFailureExceptionget_sip_media_application(**kwargs)¶See also: AWS API Documentation
Request Syntax
response = client.get_sip_media_application(
SipMediaApplicationId='string'
)
{
'SipMediaApplication': {
'SipMediaApplicationId': 'string',
'AwsRegion': 'string',
'Name': 'string',
'Endpoints': [
{
'LambdaArn': 'string'
},
],
'CreatedTimestamp': datetime(2015, 1, 1),
'UpdatedTimestamp': datetime(2015, 1, 1)
}
}
Response Structure
Exceptions
ChimeSDKVoice.Client.exceptions.UnauthorizedClientExceptionChimeSDKVoice.Client.exceptions.NotFoundExceptionChimeSDKVoice.Client.exceptions.ForbiddenExceptionChimeSDKVoice.Client.exceptions.BadRequestExceptionChimeSDKVoice.Client.exceptions.ThrottledClientExceptionChimeSDKVoice.Client.exceptions.ServiceUnavailableExceptionChimeSDKVoice.Client.exceptions.ServiceFailureExceptionget_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'
)
{
'SipMediaApplicationAlexaSkillConfiguration': {
'AlexaSkillStatus': 'ACTIVE'|'INACTIVE',
'AlexaSkillIds': [
'string',
]
}
}
Response Structure
Exceptions
ChimeSDKVoice.Client.exceptions.UnauthorizedClientExceptionChimeSDKVoice.Client.exceptions.NotFoundExceptionChimeSDKVoice.Client.exceptions.ForbiddenExceptionChimeSDKVoice.Client.exceptions.BadRequestExceptionChimeSDKVoice.Client.exceptions.ThrottledClientExceptionChimeSDKVoice.Client.exceptions.ServiceUnavailableExceptionChimeSDKVoice.Client.exceptions.ServiceFailureExceptionget_sip_media_application_logging_configuration(**kwargs)¶See also: AWS API Documentation
Request Syntax
response = client.get_sip_media_application_logging_configuration(
SipMediaApplicationId='string'
)
{
'SipMediaApplicationLoggingConfiguration': {
'EnableSipMediaApplicationMessageLogs': True|False
}
}
Response Structure
Exceptions
ChimeSDKVoice.Client.exceptions.UnauthorizedClientExceptionChimeSDKVoice.Client.exceptions.NotFoundExceptionChimeSDKVoice.Client.exceptions.ForbiddenExceptionChimeSDKVoice.Client.exceptions.BadRequestExceptionChimeSDKVoice.Client.exceptions.ThrottledClientExceptionChimeSDKVoice.Client.exceptions.ServiceUnavailableExceptionChimeSDKVoice.Client.exceptions.ServiceFailureExceptionget_sip_rule(**kwargs)¶See also: AWS API Documentation
Request Syntax
response = client.get_sip_rule(
SipRuleId='string'
)
{
'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
Exceptions
ChimeSDKVoice.Client.exceptions.UnauthorizedClientExceptionChimeSDKVoice.Client.exceptions.NotFoundExceptionChimeSDKVoice.Client.exceptions.ForbiddenExceptionChimeSDKVoice.Client.exceptions.BadRequestExceptionChimeSDKVoice.Client.exceptions.ThrottledClientExceptionChimeSDKVoice.Client.exceptions.ServiceUnavailableExceptionChimeSDKVoice.Client.exceptions.ServiceFailureExceptionget_voice_connector(**kwargs)¶See also: AWS API Documentation
Request Syntax
response = client.get_voice_connector(
VoiceConnectorId='string'
)
{
'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
Exceptions
ChimeSDKVoice.Client.exceptions.UnauthorizedClientExceptionChimeSDKVoice.Client.exceptions.NotFoundExceptionChimeSDKVoice.Client.exceptions.ForbiddenExceptionChimeSDKVoice.Client.exceptions.BadRequestExceptionChimeSDKVoice.Client.exceptions.ThrottledClientExceptionChimeSDKVoice.Client.exceptions.ServiceUnavailableExceptionChimeSDKVoice.Client.exceptions.ServiceFailureExceptionget_voice_connector_emergency_calling_configuration(**kwargs)¶See also: AWS API Documentation
Request Syntax
response = client.get_voice_connector_emergency_calling_configuration(
VoiceConnectorId='string'
)
{
'EmergencyCallingConfiguration': {
'DNIS': [
{
'EmergencyPhoneNumber': 'string',
'TestPhoneNumber': 'string',
'CallingCountry': 'string'
},
]
}
}
Response Structure
Exceptions
ChimeSDKVoice.Client.exceptions.UnauthorizedClientExceptionChimeSDKVoice.Client.exceptions.NotFoundExceptionChimeSDKVoice.Client.exceptions.ForbiddenExceptionChimeSDKVoice.Client.exceptions.BadRequestExceptionChimeSDKVoice.Client.exceptions.ThrottledClientExceptionChimeSDKVoice.Client.exceptions.ServiceUnavailableExceptionChimeSDKVoice.Client.exceptions.ServiceFailureExceptionget_voice_connector_group(**kwargs)¶See also: AWS API Documentation
Request Syntax
response = client.get_voice_connector_group(
VoiceConnectorGroupId='string'
)
{
'VoiceConnectorGroup': {
'VoiceConnectorGroupId': 'string',
'Name': 'string',
'VoiceConnectorItems': [
{
'VoiceConnectorId': 'string',
'Priority': 123
},
],
'CreatedTimestamp': datetime(2015, 1, 1),
'UpdatedTimestamp': datetime(2015, 1, 1),
'VoiceConnectorGroupArn': 'string'
}
}
Response Structure
Exceptions
ChimeSDKVoice.Client.exceptions.UnauthorizedClientExceptionChimeSDKVoice.Client.exceptions.NotFoundExceptionChimeSDKVoice.Client.exceptions.ForbiddenExceptionChimeSDKVoice.Client.exceptions.BadRequestExceptionChimeSDKVoice.Client.exceptions.ThrottledClientExceptionChimeSDKVoice.Client.exceptions.ServiceUnavailableExceptionChimeSDKVoice.Client.exceptions.ServiceFailureExceptionget_voice_connector_logging_configuration(**kwargs)¶See also: AWS API Documentation
Request Syntax
response = client.get_voice_connector_logging_configuration(
VoiceConnectorId='string'
)
{
'LoggingConfiguration': {
'EnableSIPLogs': True|False
}
}
Response Structure
Exceptions
ChimeSDKVoice.Client.exceptions.UnauthorizedClientExceptionChimeSDKVoice.Client.exceptions.NotFoundExceptionChimeSDKVoice.Client.exceptions.ForbiddenExceptionChimeSDKVoice.Client.exceptions.BadRequestExceptionChimeSDKVoice.Client.exceptions.ThrottledClientExceptionChimeSDKVoice.Client.exceptions.ServiceUnavailableExceptionChimeSDKVoice.Client.exceptions.ServiceFailureExceptionget_voice_connector_origination(**kwargs)¶See also: AWS API Documentation
Request Syntax
response = client.get_voice_connector_origination(
VoiceConnectorId='string'
)
{
'Origination': {
'Routes': [
{
'Host': 'string',
'Port': 123,
'Protocol': 'TCP'|'UDP',
'Priority': 123,
'Weight': 123
},
],
'Disabled': True|False
}
}
Response Structure
Exceptions
ChimeSDKVoice.Client.exceptions.UnauthorizedClientExceptionChimeSDKVoice.Client.exceptions.NotFoundExceptionChimeSDKVoice.Client.exceptions.ForbiddenExceptionChimeSDKVoice.Client.exceptions.BadRequestExceptionChimeSDKVoice.Client.exceptions.ThrottledClientExceptionChimeSDKVoice.Client.exceptions.ServiceUnavailableExceptionChimeSDKVoice.Client.exceptions.ServiceFailureExceptionget_voice_connector_proxy(**kwargs)¶See also: AWS API Documentation
Request Syntax
response = client.get_voice_connector_proxy(
VoiceConnectorId='string'
)
{
'Proxy': {
'DefaultSessionExpiryMinutes': 123,
'Disabled': True|False,
'FallBackPhoneNumber': 'string',
'PhoneNumberCountries': [
'string',
]
}
}
Response Structure
Exceptions
ChimeSDKVoice.Client.exceptions.UnauthorizedClientExceptionChimeSDKVoice.Client.exceptions.NotFoundExceptionChimeSDKVoice.Client.exceptions.ForbiddenExceptionChimeSDKVoice.Client.exceptions.BadRequestExceptionChimeSDKVoice.Client.exceptions.ThrottledClientExceptionChimeSDKVoice.Client.exceptions.ServiceUnavailableExceptionChimeSDKVoice.Client.exceptions.ServiceFailureExceptionget_voice_connector_streaming_configuration(**kwargs)¶See also: AWS API Documentation
Request Syntax
response = client.get_voice_connector_streaming_configuration(
VoiceConnectorId='string'
)
{
'StreamingConfiguration': {
'DataRetentionInHours': 123,
'Disabled': True|False,
'StreamingNotificationTargets': [
{
'NotificationTarget': 'EventBridge'|'SNS'|'SQS'
},
]
}
}
Response Structure
Exceptions
ChimeSDKVoice.Client.exceptions.UnauthorizedClientExceptionChimeSDKVoice.Client.exceptions.NotFoundExceptionChimeSDKVoice.Client.exceptions.ForbiddenExceptionChimeSDKVoice.Client.exceptions.BadRequestExceptionChimeSDKVoice.Client.exceptions.ThrottledClientExceptionChimeSDKVoice.Client.exceptions.ServiceUnavailableExceptionChimeSDKVoice.Client.exceptions.ServiceFailureExceptionget_voice_connector_termination(**kwargs)¶See also: AWS API Documentation
Request Syntax
response = client.get_voice_connector_termination(
VoiceConnectorId='string'
)
{
'Termination': {
'CpsLimit': 123,
'DefaultPhoneNumber': 'string',
'CallingRegions': [
'string',
],
'CidrAllowedList': [
'string',
],
'Disabled': True|False
}
}
Response Structure
Exceptions
ChimeSDKVoice.Client.exceptions.UnauthorizedClientExceptionChimeSDKVoice.Client.exceptions.NotFoundExceptionChimeSDKVoice.Client.exceptions.ForbiddenExceptionChimeSDKVoice.Client.exceptions.BadRequestExceptionChimeSDKVoice.Client.exceptions.ThrottledClientExceptionChimeSDKVoice.Client.exceptions.ServiceUnavailableExceptionChimeSDKVoice.Client.exceptions.ServiceFailureExceptionget_voice_connector_termination_health(**kwargs)¶See also: AWS API Documentation
Request Syntax
response = client.get_voice_connector_termination_health(
VoiceConnectorId='string'
)
{
'TerminationHealth': {
'Timestamp': datetime(2015, 1, 1),
'Source': 'string'
}
}
Response Structure
Exceptions
ChimeSDKVoice.Client.exceptions.UnauthorizedClientExceptionChimeSDKVoice.Client.exceptions.NotFoundExceptionChimeSDKVoice.Client.exceptions.ForbiddenExceptionChimeSDKVoice.Client.exceptions.BadRequestExceptionChimeSDKVoice.Client.exceptions.ThrottledClientExceptionChimeSDKVoice.Client.exceptions.ServiceUnavailableExceptionChimeSDKVoice.Client.exceptions.ServiceFailureExceptionget_waiter(waiter_name)¶Returns an object that can wait for some condition.
list_available_voice_connector_regions()¶See also: AWS API Documentation
Request Syntax
response = client.list_available_voice_connector_regions()
{
'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
Exceptions
ChimeSDKVoice.Client.exceptions.UnauthorizedClientExceptionChimeSDKVoice.Client.exceptions.ForbiddenExceptionChimeSDKVoice.Client.exceptions.BadRequestExceptionChimeSDKVoice.Client.exceptions.ThrottledClientExceptionChimeSDKVoice.Client.exceptions.ServiceUnavailableExceptionChimeSDKVoice.Client.exceptions.ServiceFailureExceptionlist_phone_number_orders(**kwargs)¶See also: AWS API Documentation
Request Syntax
response = client.list_phone_number_orders(
NextToken='string',
MaxResults=123
)
dict
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
Exceptions
ChimeSDKVoice.Client.exceptions.UnauthorizedClientExceptionChimeSDKVoice.Client.exceptions.ForbiddenExceptionChimeSDKVoice.Client.exceptions.BadRequestExceptionChimeSDKVoice.Client.exceptions.ThrottledClientExceptionChimeSDKVoice.Client.exceptions.ServiceUnavailableExceptionChimeSDKVoice.Client.exceptions.ServiceFailureExceptionlist_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'
)
dict
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
Exceptions
ChimeSDKVoice.Client.exceptions.UnauthorizedClientExceptionChimeSDKVoice.Client.exceptions.ForbiddenExceptionChimeSDKVoice.Client.exceptions.BadRequestExceptionChimeSDKVoice.Client.exceptions.NotFoundExceptionChimeSDKVoice.Client.exceptions.ThrottledClientExceptionChimeSDKVoice.Client.exceptions.ServiceUnavailableExceptionChimeSDKVoice.Client.exceptions.ServiceFailureExceptionlist_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
)
dict
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
Exceptions
ChimeSDKVoice.Client.exceptions.UnauthorizedClientExceptionChimeSDKVoice.Client.exceptions.NotFoundExceptionChimeSDKVoice.Client.exceptions.ForbiddenExceptionChimeSDKVoice.Client.exceptions.BadRequestExceptionChimeSDKVoice.Client.exceptions.ThrottledClientExceptionChimeSDKVoice.Client.exceptions.ServiceUnavailableExceptionChimeSDKVoice.Client.exceptions.ServiceFailureExceptionlist_sip_media_applications(**kwargs)¶See also: AWS API Documentation
Request Syntax
response = client.list_sip_media_applications(
MaxResults=123,
NextToken='string'
)
dict
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
Exceptions
ChimeSDKVoice.Client.exceptions.UnauthorizedClientExceptionChimeSDKVoice.Client.exceptions.ForbiddenExceptionChimeSDKVoice.Client.exceptions.BadRequestExceptionChimeSDKVoice.Client.exceptions.ThrottledClientExceptionChimeSDKVoice.Client.exceptions.ServiceUnavailableExceptionChimeSDKVoice.Client.exceptions.ServiceFailureExceptionlist_sip_rules(**kwargs)¶See also: AWS API Documentation
Request Syntax
response = client.list_sip_rules(
SipMediaApplicationId='string',
MaxResults=123,
NextToken='string'
)
dict
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
Exceptions
ChimeSDKVoice.Client.exceptions.UnauthorizedClientExceptionChimeSDKVoice.Client.exceptions.ForbiddenExceptionChimeSDKVoice.Client.exceptions.BadRequestExceptionChimeSDKVoice.Client.exceptions.ThrottledClientExceptionChimeSDKVoice.Client.exceptions.ServiceUnavailableExceptionChimeSDKVoice.Client.exceptions.ServiceFailureExceptionlist_supported_phone_number_countries(**kwargs)¶See also: AWS API Documentation
Request Syntax
response = client.list_supported_phone_number_countries(
ProductType='VoiceConnector'|'SipMediaApplicationDialIn'
)
{
'PhoneNumberCountries': [
{
'CountryCode': 'string',
'SupportedPhoneNumberTypes': [
'Local'|'TollFree',
]
},
]
}
Response Structure
Exceptions
ChimeSDKVoice.Client.exceptions.BadRequestExceptionChimeSDKVoice.Client.exceptions.ForbiddenExceptionChimeSDKVoice.Client.exceptions.AccessDeniedExceptionChimeSDKVoice.Client.exceptions.UnauthorizedClientExceptionChimeSDKVoice.Client.exceptions.ThrottledClientExceptionChimeSDKVoice.Client.exceptions.ServiceUnavailableExceptionChimeSDKVoice.Client.exceptions.ServiceFailureExceptionlist_voice_connector_groups(**kwargs)¶See also: AWS API Documentation
Request Syntax
response = client.list_voice_connector_groups(
NextToken='string',
MaxResults=123
)
dict
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
Exceptions
ChimeSDKVoice.Client.exceptions.UnauthorizedClientExceptionChimeSDKVoice.Client.exceptions.ForbiddenExceptionChimeSDKVoice.Client.exceptions.BadRequestExceptionChimeSDKVoice.Client.exceptions.ThrottledClientExceptionChimeSDKVoice.Client.exceptions.ServiceUnavailableExceptionChimeSDKVoice.Client.exceptions.ServiceFailureExceptionlist_voice_connector_termination_credentials(**kwargs)¶See also: AWS API Documentation
Request Syntax
response = client.list_voice_connector_termination_credentials(
VoiceConnectorId='string'
)
{
'Usernames': [
'string',
]
}
Response Structure
Exceptions
ChimeSDKVoice.Client.exceptions.UnauthorizedClientExceptionChimeSDKVoice.Client.exceptions.NotFoundExceptionChimeSDKVoice.Client.exceptions.ForbiddenExceptionChimeSDKVoice.Client.exceptions.BadRequestExceptionChimeSDKVoice.Client.exceptions.ThrottledClientExceptionChimeSDKVoice.Client.exceptions.ServiceUnavailableExceptionChimeSDKVoice.Client.exceptions.ServiceFailureExceptionlist_voice_connectors(**kwargs)¶See also: AWS API Documentation
Request Syntax
response = client.list_voice_connectors(
NextToken='string',
MaxResults=123
)
dict
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
Exceptions
ChimeSDKVoice.Client.exceptions.UnauthorizedClientExceptionChimeSDKVoice.Client.exceptions.ForbiddenExceptionChimeSDKVoice.Client.exceptions.BadRequestExceptionChimeSDKVoice.Client.exceptions.ThrottledClientExceptionChimeSDKVoice.Client.exceptions.ServiceUnavailableExceptionChimeSDKVoice.Client.exceptions.ServiceFailureExceptionput_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',
]
}
)
dict
Response Syntax
{
'SipMediaApplicationAlexaSkillConfiguration': {
'AlexaSkillStatus': 'ACTIVE'|'INACTIVE',
'AlexaSkillIds': [
'string',
]
}
}
Response Structure
Exceptions
ChimeSDKVoice.Client.exceptions.UnauthorizedClientExceptionChimeSDKVoice.Client.exceptions.NotFoundExceptionChimeSDKVoice.Client.exceptions.ForbiddenExceptionChimeSDKVoice.Client.exceptions.BadRequestExceptionChimeSDKVoice.Client.exceptions.ThrottledClientExceptionChimeSDKVoice.Client.exceptions.ServiceUnavailableExceptionChimeSDKVoice.Client.exceptions.ServiceFailureExceptionput_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
}
)
dict
Response Syntax
{
'SipMediaApplicationLoggingConfiguration': {
'EnableSipMediaApplicationMessageLogs': True|False
}
}
Response Structure
Exceptions
ChimeSDKVoice.Client.exceptions.UnauthorizedClientExceptionChimeSDKVoice.Client.exceptions.NotFoundExceptionChimeSDKVoice.Client.exceptions.ForbiddenExceptionChimeSDKVoice.Client.exceptions.BadRequestExceptionChimeSDKVoice.Client.exceptions.ThrottledClientExceptionChimeSDKVoice.Client.exceptions.ServiceUnavailableExceptionChimeSDKVoice.Client.exceptions.ServiceFailureExceptionput_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'
},
]
}
)
[REQUIRED]
dict
Response Syntax
{
'EmergencyCallingConfiguration': {
'DNIS': [
{
'EmergencyPhoneNumber': 'string',
'TestPhoneNumber': 'string',
'CallingCountry': 'string'
},
]
}
}
Response Structure
Exceptions
ChimeSDKVoice.Client.exceptions.UnauthorizedClientExceptionChimeSDKVoice.Client.exceptions.NotFoundExceptionChimeSDKVoice.Client.exceptions.ForbiddenExceptionChimeSDKVoice.Client.exceptions.BadRequestExceptionChimeSDKVoice.Client.exceptions.ThrottledClientExceptionChimeSDKVoice.Client.exceptions.ServiceUnavailableExceptionChimeSDKVoice.Client.exceptions.ServiceFailureExceptionput_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
}
)
[REQUIRED]
dict
Response Syntax
{
'LoggingConfiguration': {
'EnableSIPLogs': True|False
}
}
Response Structure
Exceptions
ChimeSDKVoice.Client.exceptions.UnauthorizedClientExceptionChimeSDKVoice.Client.exceptions.NotFoundExceptionChimeSDKVoice.Client.exceptions.ForbiddenExceptionChimeSDKVoice.Client.exceptions.BadRequestExceptionChimeSDKVoice.Client.exceptions.ThrottledClientExceptionChimeSDKVoice.Client.exceptions.ServiceUnavailableExceptionChimeSDKVoice.Client.exceptions.ServiceFailureExceptionput_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
}
)
[REQUIRED]
dict
Response Syntax
{
'Origination': {
'Routes': [
{
'Host': 'string',
'Port': 123,
'Protocol': 'TCP'|'UDP',
'Priority': 123,
'Weight': 123
},
],
'Disabled': True|False
}
}
Response Structure
Exceptions
ChimeSDKVoice.Client.exceptions.UnauthorizedClientExceptionChimeSDKVoice.Client.exceptions.NotFoundExceptionChimeSDKVoice.Client.exceptions.ForbiddenExceptionChimeSDKVoice.Client.exceptions.BadRequestExceptionChimeSDKVoice.Client.exceptions.ThrottledClientExceptionChimeSDKVoice.Client.exceptions.ServiceUnavailableExceptionChimeSDKVoice.Client.exceptions.ServiceFailureExceptionput_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
)
[REQUIRED]
dict
Response Syntax
{
'Proxy': {
'DefaultSessionExpiryMinutes': 123,
'Disabled': True|False,
'FallBackPhoneNumber': 'string',
'PhoneNumberCountries': [
'string',
]
}
}
Response Structure
Exceptions
ChimeSDKVoice.Client.exceptions.UnauthorizedClientExceptionChimeSDKVoice.Client.exceptions.AccessDeniedExceptionChimeSDKVoice.Client.exceptions.NotFoundExceptionChimeSDKVoice.Client.exceptions.ForbiddenExceptionChimeSDKVoice.Client.exceptions.BadRequestExceptionChimeSDKVoice.Client.exceptions.ThrottledClientExceptionChimeSDKVoice.Client.exceptions.ServiceUnavailableExceptionChimeSDKVoice.Client.exceptions.ServiceFailureExceptionput_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'
},
]
}
)
[REQUIRED]
dict
Response Syntax
{
'StreamingConfiguration': {
'DataRetentionInHours': 123,
'Disabled': True|False,
'StreamingNotificationTargets': [
{
'NotificationTarget': 'EventBridge'|'SNS'|'SQS'
},
]
}
}
Response Structure
Exceptions
ChimeSDKVoice.Client.exceptions.UnauthorizedClientExceptionChimeSDKVoice.Client.exceptions.NotFoundExceptionChimeSDKVoice.Client.exceptions.ForbiddenExceptionChimeSDKVoice.Client.exceptions.BadRequestExceptionChimeSDKVoice.Client.exceptions.ThrottledClientExceptionChimeSDKVoice.Client.exceptions.ServiceUnavailableExceptionChimeSDKVoice.Client.exceptions.ServiceFailureExceptionput_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
}
)
[REQUIRED]
dict
Response Syntax
{
'Termination': {
'CpsLimit': 123,
'DefaultPhoneNumber': 'string',
'CallingRegions': [
'string',
],
'CidrAllowedList': [
'string',
],
'Disabled': True|False
}
}
Response Structure
Exceptions
ChimeSDKVoice.Client.exceptions.UnauthorizedClientExceptionChimeSDKVoice.Client.exceptions.NotFoundExceptionChimeSDKVoice.Client.exceptions.ForbiddenExceptionChimeSDKVoice.Client.exceptions.BadRequestExceptionChimeSDKVoice.Client.exceptions.AccessDeniedExceptionChimeSDKVoice.Client.exceptions.ThrottledClientExceptionChimeSDKVoice.Client.exceptions.ServiceUnavailableExceptionChimeSDKVoice.Client.exceptions.ServiceFailureExceptionput_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'
},
]
)
None
Exceptions
ChimeSDKVoice.Client.exceptions.UnauthorizedClientExceptionChimeSDKVoice.Client.exceptions.NotFoundExceptionChimeSDKVoice.Client.exceptions.ForbiddenExceptionChimeSDKVoice.Client.exceptions.BadRequestExceptionChimeSDKVoice.Client.exceptions.ThrottledClientExceptionChimeSDKVoice.Client.exceptions.ServiceUnavailableExceptionChimeSDKVoice.Client.exceptions.ServiceFailureExceptionrestore_phone_number(**kwargs)¶See also: AWS API Documentation
Request Syntax
response = client.restore_phone_number(
PhoneNumberId='string'
)
{
'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
Exceptions
ChimeSDKVoice.Client.exceptions.UnauthorizedClientExceptionChimeSDKVoice.Client.exceptions.NotFoundExceptionChimeSDKVoice.Client.exceptions.ForbiddenExceptionChimeSDKVoice.Client.exceptions.BadRequestExceptionChimeSDKVoice.Client.exceptions.ThrottledClientExceptionChimeSDKVoice.Client.exceptions.ResourceLimitExceededExceptionChimeSDKVoice.Client.exceptions.ServiceUnavailableExceptionChimeSDKVoice.Client.exceptions.ServiceFailureExceptionsearch_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'
)
dict
Response Syntax
{
'E164PhoneNumbers': [
'string',
],
'NextToken': 'string'
}
Response Structure
Exceptions
ChimeSDKVoice.Client.exceptions.BadRequestExceptionChimeSDKVoice.Client.exceptions.ForbiddenExceptionChimeSDKVoice.Client.exceptions.AccessDeniedExceptionChimeSDKVoice.Client.exceptions.UnauthorizedClientExceptionChimeSDKVoice.Client.exceptions.ThrottledClientExceptionChimeSDKVoice.Client.exceptions.ServiceUnavailableExceptionChimeSDKVoice.Client.exceptions.ServiceFailureExceptionupdate_global_settings(**kwargs)¶See also: AWS API Documentation
Request Syntax
response = client.update_global_settings(
VoiceConnector={
'CdrBucket': 'string'
}
)
Exceptions
ChimeSDKVoice.Client.exceptions.UnauthorizedClientExceptionChimeSDKVoice.Client.exceptions.ForbiddenExceptionChimeSDKVoice.Client.exceptions.BadRequestExceptionChimeSDKVoice.Client.exceptions.ThrottledClientExceptionChimeSDKVoice.Client.exceptions.ServiceUnavailableExceptionChimeSDKVoice.Client.exceptions.ServiceFailureExceptionupdate_phone_number(**kwargs)¶See also: AWS API Documentation
Request Syntax
response = client.update_phone_number(
PhoneNumberId='string',
ProductType='VoiceConnector'|'SipMediaApplicationDialIn',
CallingName='string'
)
dict
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
Exceptions
ChimeSDKVoice.Client.exceptions.UnauthorizedClientExceptionChimeSDKVoice.Client.exceptions.NotFoundExceptionChimeSDKVoice.Client.exceptions.ForbiddenExceptionChimeSDKVoice.Client.exceptions.BadRequestExceptionChimeSDKVoice.Client.exceptions.ThrottledClientExceptionChimeSDKVoice.Client.exceptions.ConflictExceptionChimeSDKVoice.Client.exceptions.ServiceUnavailableExceptionChimeSDKVoice.Client.exceptions.ServiceFailureExceptionupdate_phone_number_settings(**kwargs)¶See also: AWS API Documentation
Request Syntax
response = client.update_phone_number_settings(
CallingName='string'
)
Exceptions
ChimeSDKVoice.Client.exceptions.UnauthorizedClientExceptionChimeSDKVoice.Client.exceptions.ForbiddenExceptionChimeSDKVoice.Client.exceptions.BadRequestExceptionChimeSDKVoice.Client.exceptions.ThrottledClientExceptionChimeSDKVoice.Client.exceptions.ServiceUnavailableExceptionChimeSDKVoice.Client.exceptions.ServiceFailureExceptionupdate_proxy_session(**kwargs)¶See also: AWS API Documentation
Request Syntax
response = client.update_proxy_session(
VoiceConnectorId='string',
ProxySessionId='string',
Capabilities=[
'Voice'|'SMS',
],
ExpiryMinutes=123
)
[REQUIRED]
dict
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
Exceptions
ChimeSDKVoice.Client.exceptions.UnauthorizedClientExceptionChimeSDKVoice.Client.exceptions.NotFoundExceptionChimeSDKVoice.Client.exceptions.ForbiddenExceptionChimeSDKVoice.Client.exceptions.BadRequestExceptionChimeSDKVoice.Client.exceptions.ThrottledClientExceptionChimeSDKVoice.Client.exceptions.ServiceUnavailableExceptionChimeSDKVoice.Client.exceptions.ServiceFailureExceptionupdate_sip_media_application(**kwargs)¶See also: AWS API Documentation
Request Syntax
response = client.update_sip_media_application(
SipMediaApplicationId='string',
Name='string',
Endpoints=[
{
'LambdaArn': 'string'
},
]
)
dict
Response Syntax
{
'SipMediaApplication': {
'SipMediaApplicationId': 'string',
'AwsRegion': 'string',
'Name': 'string',
'Endpoints': [
{
'LambdaArn': 'string'
},
],
'CreatedTimestamp': datetime(2015, 1, 1),
'UpdatedTimestamp': datetime(2015, 1, 1)
}
}
Response Structure
Exceptions
ChimeSDKVoice.Client.exceptions.UnauthorizedClientExceptionChimeSDKVoice.Client.exceptions.NotFoundExceptionChimeSDKVoice.Client.exceptions.ForbiddenExceptionChimeSDKVoice.Client.exceptions.BadRequestExceptionChimeSDKVoice.Client.exceptions.ConflictExceptionChimeSDKVoice.Client.exceptions.ThrottledClientExceptionChimeSDKVoice.Client.exceptions.ServiceUnavailableExceptionChimeSDKVoice.Client.exceptions.ServiceFailureExceptionupdate_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'
}
)
[REQUIRED]
dict
Response Syntax
{
'SipMediaApplicationCall': {
'TransactionId': 'string'
}
}
Response Structure
Exceptions
ChimeSDKVoice.Client.exceptions.BadRequestExceptionChimeSDKVoice.Client.exceptions.NotFoundExceptionChimeSDKVoice.Client.exceptions.ForbiddenExceptionChimeSDKVoice.Client.exceptions.ResourceLimitExceededExceptionChimeSDKVoice.Client.exceptions.ThrottledClientExceptionChimeSDKVoice.Client.exceptions.UnauthorizedClientExceptionChimeSDKVoice.Client.exceptions.ServiceUnavailableExceptionChimeSDKVoice.Client.exceptions.ServiceFailureExceptionupdate_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'
},
]
)
dict
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
Exceptions
ChimeSDKVoice.Client.exceptions.UnauthorizedClientExceptionChimeSDKVoice.Client.exceptions.NotFoundExceptionChimeSDKVoice.Client.exceptions.ForbiddenExceptionChimeSDKVoice.Client.exceptions.BadRequestExceptionChimeSDKVoice.Client.exceptions.ConflictExceptionChimeSDKVoice.Client.exceptions.ThrottledClientExceptionChimeSDKVoice.Client.exceptions.ResourceLimitExceededExceptionChimeSDKVoice.Client.exceptions.ServiceUnavailableExceptionChimeSDKVoice.Client.exceptions.ServiceFailureExceptionupdate_voice_connector(**kwargs)¶See also: AWS API Documentation
Request Syntax
response = client.update_voice_connector(
VoiceConnectorId='string',
Name='string',
RequireEncryption=True|False
)
dict
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
Exceptions
ChimeSDKVoice.Client.exceptions.UnauthorizedClientExceptionChimeSDKVoice.Client.exceptions.NotFoundExceptionChimeSDKVoice.Client.exceptions.ForbiddenExceptionChimeSDKVoice.Client.exceptions.BadRequestExceptionChimeSDKVoice.Client.exceptions.ThrottledClientExceptionChimeSDKVoice.Client.exceptions.ServiceUnavailableExceptionChimeSDKVoice.Client.exceptions.ServiceFailureExceptionupdate_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
},
]
)
[REQUIRED]
dict
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
Exceptions
ChimeSDKVoice.Client.exceptions.UnauthorizedClientExceptionChimeSDKVoice.Client.exceptions.NotFoundExceptionChimeSDKVoice.Client.exceptions.ForbiddenExceptionChimeSDKVoice.Client.exceptions.BadRequestExceptionChimeSDKVoice.Client.exceptions.ConflictExceptionChimeSDKVoice.Client.exceptions.ThrottledClientExceptionChimeSDKVoice.Client.exceptions.ServiceUnavailableExceptionChimeSDKVoice.Client.exceptions.ServiceFailureExceptionvalidate_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'
)
dict
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
Exceptions
ChimeSDKVoice.Client.exceptions.UnauthorizedClientExceptionChimeSDKVoice.Client.exceptions.NotFoundExceptionChimeSDKVoice.Client.exceptions.ForbiddenExceptionChimeSDKVoice.Client.exceptions.BadRequestExceptionChimeSDKVoice.Client.exceptions.ThrottledClientExceptionChimeSDKVoice.Client.exceptions.ServiceUnavailableExceptionChimeSDKVoice.Client.exceptions.ServiceFailureExceptionThe available paginators are:
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'
}
)
A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'SipMediaApplications': [
{
'SipMediaApplicationId': 'string',
'AwsRegion': 'string',
'Name': 'string',
'Endpoints': [
{
'LambdaArn': 'string'
},
],
'CreatedTimestamp': datetime(2015, 1, 1),
'UpdatedTimestamp': datetime(2015, 1, 1)
},
],
}
Response Structure
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'
}
)
A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
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