ExAws.Chime.Voice (ex_aws_chime v2.0.1)

API calls for Amazon Chime SDK Voice See https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_Operations_Amazon_Chime_SDK_Voice.html

Summary

Types

filters()

Functions

associate_phone_numbers_with_voice_connector(voice_connector_id, phone_numbers, force \\ false)
associate_phone_numbers_with_voice_connector_group(voice_connector_group_id, phone_numbers, force \\ false)
batch_delete_phone_number(phone_number_ids)
batch_update_phone_number(phone_number_updates)
create_phone_number_order(phone_numbers, product_type)
create_proxy_session(voice_connector_id, capabilities, expiry_minutes \\ nil, geo_match_level \\ nil, geo_match_params \\ nil, name \\ nil, number_selection_behavior \\ nil, participant_phone_numbers)
create_voice_connector(aws_region \\ nil, name, require_encryption)
create_voice_connector_group(name, voice_connector_items \\ nil)
delete_phone_number(phone_number_id)
delete_proxy_session(voice_connector_id, proxy_session_id)
delete_voice_connector(voice_connector_id)
delete_voice_connector_emergency_calling_configuration(voice_connector_id)
delete_voice_connector_group(voice_connector_group_id)
delete_voice_connector_origination(voice_connector_id)
delete_voice_connector_proxy(voice_connector_id)
delete_voice_connector_streaming_configuration(voice_connector_id)
delete_voice_connector_termination(voice_connector_id)
delete_voice_connector_termination_credentials(voice_connector_id, usernames)
disassociate_phone_numbers_from_voice_connector(voice_connector_id, phone_numbers)
disassociate_phone_numbers_from_voice_connector_group(voice_connector_group_id, phone_numbers)
get_global_settings()
get_phone_number(phone_number_id)
get_phone_number_order(phone_number_order_id)
get_phone_number_settings()
get_proxy_session(voice_connector_id, proxy_session_id)
get_voice_connector(voice_connector_id)
get_voice_connector_emergency_calling_configuration(voice_connector_id)
get_voice_connector_group(voice_connector_group_id)
get_voice_connector_logging_configuration(voice_connector_id)
get_voice_connector_origination(voice_connector_id)
get_voice_connector_proxy(voice_connector_id)
get_voice_connector_streaming_configuration(voice_connector_id)
get_voice_connector_termination(voice_connector_id)
get_voice_connector_termination_health(voice_connector_id)
list_phone_number_orders(max_results \\ nil, next_token \\ nil)
list_phone_numbers(filters \\ %{}, max_results \\ nil, next_token \\ nil)
list_proxy_sessions(voice_connector_id, filters \\ %{}, max_results \\ nil, next_token \\ nil)
list_voice_connector_groups(max_results \\ nil, next_token \\ nil)
list_voice_connector_termination_credentials(voice_connector_id)
list_voice_connectors(max_results \\ nil, next_token \\ nil)
put_voice_connector_emergency_calling_configuration(voice_connector_id, emergency_calling_configuration)
put_voice_connector_logging_configuration(voice_connector_id, logging_configuration)
put_voice_connector_origination(voice_connector_id, origination)
put_voice_connector_proxy(voice_connector_id, default_session_expiry_minutes, disabled \\ nil, fall_back_phone_number \\ nil, phone_number_pool_countries)
put_voice_connector_streaming_configuration(voice_connector_id, streaming_configuration)
put_voice_connector_termination(voice_connector_id, termination)
put_voice_connector_termination_credentials(voice_connector_id, credentials)
restore_phone_number(phone_number_id)
search_available_phone_numbers(filters \\ %{}, max_results \\ nil, next_token \\ nil)
tag_resource(resource_arn, tags)
untag_resource(resource_arn, tag_keys)
update_global_settings(business_calling, voice_connector)
update_phone_number(phone_number_id, calling_name \\ nil, product_type \\ nil)
update_phone_number_settings(calling_name)
update_proxy_session(proxy_session_id, voice_connector_id, capabilities, expiry_minutes)
update_voice_connector(voice_connector_id, name, require_encryption)
update_voice_connector_group(voice_connector_group_id, name, voice_connector_items)

Types

Link to this type

filters()

@type filters() :: %{required(String.t()) => String.t()}

Functions

Link to this function

associate_phone_numbers_with_voice_connector(voice_connector_id, phone_numbers, force \\ false)

@spec associate_phone_numbers_with_voice_connector(
  String.t(),
  [String.t()],
  boolean()
) ::
  ExAws.Operation.JSON.t()
Link to this function

associate_phone_numbers_with_voice_connector_group(voice_connector_group_id, phone_numbers, force \\ false)

@spec associate_phone_numbers_with_voice_connector_group(
  String.t(),
  [String.t()],
  boolean()
) ::
  ExAws.Operation.JSON.t()
Link to this function

batch_delete_phone_number(phone_number_ids)

@spec batch_delete_phone_number([String.t()]) :: ExAws.Operation.JSON.t()
Link to this function

batch_update_phone_number(phone_number_updates)

@spec batch_update_phone_number(ExAws.Chime.Voice.UpdatePhoneNumberRequestItem.t()) ::
  ExAws.Operation.JSON.t()
Link to this function

create_phone_number_order(phone_numbers, product_type)

@spec create_phone_number_order([String.t()], String.t()) :: ExAws.Operation.JSON.t()
Link to this function

create_proxy_session(voice_connector_id, capabilities, expiry_minutes \\ nil, geo_match_level \\ nil, geo_match_params \\ nil, name \\ nil, number_selection_behavior \\ nil, participant_phone_numbers)

Link to this function

create_voice_connector(aws_region \\ nil, name, require_encryption)

@spec create_voice_connector(String.t() | nil, String.t(), boolean()) ::
  ExAws.Operation.JSON.t()
Link to this function

create_voice_connector_group(name, voice_connector_items \\ nil)

@spec create_voice_connector_group(
  String.t(),
  [ExAws.Chime.Voice.VoiceConnectorItem.t()] | nil
) ::
  ExAws.Operation.JSON.t()
Link to this function

delete_phone_number(phone_number_id)

@spec delete_phone_number(String.t()) :: ExAws.Operation.RestQuery.t()
Link to this function

delete_proxy_session(voice_connector_id, proxy_session_id)

@spec delete_proxy_session(String.t(), String.t()) :: ExAws.Operation.RestQuery.t()
Link to this function

delete_voice_connector(voice_connector_id)

@spec delete_voice_connector(String.t()) :: ExAws.Operation.RestQuery.t()
Link to this function

delete_voice_connector_emergency_calling_configuration(voice_connector_id)

@spec delete_voice_connector_emergency_calling_configuration(String.t()) ::
  ExAws.Operation.RestQuery.t()
Link to this function

delete_voice_connector_group(voice_connector_group_id)

@spec delete_voice_connector_group(String.t()) :: ExAws.Operation.RestQuery.t()
Link to this function

delete_voice_connector_origination(voice_connector_id)

@spec delete_voice_connector_origination(String.t()) :: ExAws.Operation.RestQuery.t()
Link to this function

delete_voice_connector_proxy(voice_connector_id)

@spec delete_voice_connector_proxy(String.t()) :: ExAws.Operation.RestQuery.t()
Link to this function

delete_voice_connector_streaming_configuration(voice_connector_id)

@spec delete_voice_connector_streaming_configuration(String.t()) ::
  ExAws.Operation.RestQuery.t()
Link to this function

delete_voice_connector_termination(voice_connector_id)

@spec delete_voice_connector_termination(String.t()) :: ExAws.Operation.RestQuery.t()
Link to this function

delete_voice_connector_termination_credentials(voice_connector_id, usernames)

@spec delete_voice_connector_termination_credentials(String.t(), [String.t()]) ::
  ExAws.Operation.JSON.t()
Link to this function

disassociate_phone_numbers_from_voice_connector(voice_connector_id, phone_numbers)

@spec disassociate_phone_numbers_from_voice_connector(String.t(), [String.t()]) ::
  ExAws.Operation.JSON.t()
Link to this function

disassociate_phone_numbers_from_voice_connector_group(voice_connector_group_id, phone_numbers)

@spec disassociate_phone_numbers_from_voice_connector_group(String.t(), [String.t()]) ::
  ExAws.Operation.JSON.t()
Link to this function

get_global_settings()

@spec get_global_settings() :: ExAws.Operation.RestQuery.t()
Link to this function

get_phone_number(phone_number_id)

@spec get_phone_number(String.t()) :: ExAws.Operation.RestQuery.t()
Link to this function

get_phone_number_order(phone_number_order_id)

@spec get_phone_number_order(String.t()) :: ExAws.Operation.RestQuery.t()
Link to this function

get_phone_number_settings()

@spec get_phone_number_settings() :: ExAws.Operation.RestQuery.t()
Link to this function

get_proxy_session(voice_connector_id, proxy_session_id)

@spec get_proxy_session(String.t(), String.t()) :: ExAws.Operation.RestQuery.t()
Link to this function

get_voice_connector(voice_connector_id)

@spec get_voice_connector(String.t()) :: ExAws.Operation.RestQuery.t()
Link to this function

get_voice_connector_emergency_calling_configuration(voice_connector_id)

@spec get_voice_connector_emergency_calling_configuration(String.t()) ::
  ExAws.Operation.RestQuery.t()
Link to this function

get_voice_connector_group(voice_connector_group_id)

@spec get_voice_connector_group(String.t()) :: ExAws.Operation.RestQuery.t()
Link to this function

get_voice_connector_logging_configuration(voice_connector_id)

@spec get_voice_connector_logging_configuration(String.t()) ::
  ExAws.Operation.RestQuery.t()
Link to this function

get_voice_connector_origination(voice_connector_id)

@spec get_voice_connector_origination(String.t()) :: ExAws.Operation.RestQuery.t()
Link to this function

get_voice_connector_proxy(voice_connector_id)

@spec get_voice_connector_proxy(String.t()) :: ExAws.Operation.RestQuery.t()
Link to this function

get_voice_connector_streaming_configuration(voice_connector_id)

@spec get_voice_connector_streaming_configuration(String.t()) ::
  ExAws.Operation.RestQuery.t()
Link to this function

get_voice_connector_termination(voice_connector_id)

@spec get_voice_connector_termination(String.t()) :: ExAws.Operation.RestQuery.t()
Link to this function

get_voice_connector_termination_health(voice_connector_id)

@spec get_voice_connector_termination_health(String.t()) ::
  ExAws.Operation.RestQuery.t()
Link to this function

list_phone_number_orders(max_results \\ nil, next_token \\ nil)

@spec list_phone_number_orders(
  ExAws.Chime.Utils.max_results(),
  ExAws.Chime.Utils.paging_token()
) ::
  ExAws.Operation.RestQuery.t()
Link to this function

list_phone_numbers(filters \\ %{}, max_results \\ nil, next_token \\ nil)

@spec list_phone_numbers(
  filters(),
  ExAws.Chime.Utils.max_results(),
  ExAws.Chime.Utils.paging_token()
) ::
  ExAws.Operation.RestQuery.t()
Link to this function

list_proxy_sessions(voice_connector_id, filters \\ %{}, max_results \\ nil, next_token \\ nil)

@spec list_proxy_sessions(
  String.t(),
  filters(),
  ExAws.Chime.Utils.max_results(),
  ExAws.Chime.Utils.paging_token()
) :: ExAws.Operation.RestQuery.t()
Link to this function

list_voice_connector_groups(max_results \\ nil, next_token \\ nil)

@spec list_voice_connector_groups(
  ExAws.Chime.Utils.max_results(),
  ExAws.Chime.Utils.paging_token()
) ::
  ExAws.Operation.RestQuery.t()
Link to this function

list_voice_connector_termination_credentials(voice_connector_id)

@spec list_voice_connector_termination_credentials(String.t()) ::
  ExAws.Operation.RestQuery.t()
Link to this function

list_voice_connectors(max_results \\ nil, next_token \\ nil)

@spec list_voice_connectors(
  ExAws.Chime.Utils.max_results(),
  ExAws.Chime.Utils.paging_token()
) ::
  ExAws.Operation.RestQuery.t()
Link to this function

put_voice_connector_emergency_calling_configuration(voice_connector_id, emergency_calling_configuration)

@spec put_voice_connector_emergency_calling_configuration(
  String.t(),
  ExAws.Chime.Voice.EmergencyCallingConfiguration.t()
) :: ExAws.Operation.JSON.t()
Link to this function

put_voice_connector_logging_configuration(voice_connector_id, logging_configuration)

@spec put_voice_connector_logging_configuration(
  String.t(),
  ExAws.Chime.Voice.LoggingConfiguration.t()
) ::
  ExAws.Operation.JSON.t()
Link to this function

put_voice_connector_origination(voice_connector_id, origination)

@spec put_voice_connector_origination(String.t(), ExAws.Chime.Voice.Origination.t()) ::
  ExAws.Operation.JSON.t()
Link to this function

put_voice_connector_proxy(voice_connector_id, default_session_expiry_minutes, disabled \\ nil, fall_back_phone_number \\ nil, phone_number_pool_countries)

@spec put_voice_connector_proxy(
  String.t(),
  integer(),
  boolean() | nil,
  String.t() | nil,
  [String.t()]
) ::
  ExAws.Operation.JSON.t()
Link to this function

put_voice_connector_streaming_configuration(voice_connector_id, streaming_configuration)

@spec put_voice_connector_streaming_configuration(
  String.t(),
  ExAws.Chime.Voice.StreamingConfiguration.t()
) :: ExAws.Operation.JSON.t()
Link to this function

put_voice_connector_termination(voice_connector_id, termination)

@spec put_voice_connector_termination(String.t(), ExAws.Chime.Voice.Termination.t()) ::
  ExAws.Operation.JSON.t()
Link to this function

put_voice_connector_termination_credentials(voice_connector_id, credentials)

@spec put_voice_connector_termination_credentials(
  String.t(),
  [ExAws.Chime.Voice.Credentials.t()] | nil
) ::
  ExAws.Operation.JSON.t()
Link to this function

restore_phone_number(phone_number_id)

@spec restore_phone_number(String.t()) :: ExAws.Operation.RestQuery.t()
Link to this function

search_available_phone_numbers(filters \\ %{}, max_results \\ nil, next_token \\ nil)

@spec search_available_phone_numbers(
  filters(),
  ExAws.Chime.Utils.max_results() | nil,
  ExAws.Chime.Utils.paging_token()
) :: ExAws.Operation.RestQuery.t()
Link to this function

tag_resource(resource_arn, tags)

@spec tag_resource(String.t(), [ExAws.Chime.Tag.t()]) :: ExAws.Operation.JSON.t()
Link to this function

untag_resource(resource_arn, tag_keys)

@spec untag_resource(String.t(), [String.t()]) :: ExAws.Operation.JSON.t()
Link to this function

update_global_settings(business_calling, voice_connector)

@spec update_global_settings(
  ExAws.Chime.Voice.BusinessCallingSettings.t(),
  ExAws.Chime.Voice.VoiceConnectorSettings.t()
) :: ExAws.Operation.JSON.t()
Link to this function

update_phone_number(phone_number_id, calling_name \\ nil, product_type \\ nil)

@spec update_phone_number(String.t(), String.t() | nil, String.t() | nil) ::
  ExAws.Operation.JSON.t()
Link to this function

update_phone_number_settings(calling_name)

@spec update_phone_number_settings(String.t()) :: ExAws.Operation.JSON.t()
Link to this function

update_proxy_session(proxy_session_id, voice_connector_id, capabilities, expiry_minutes)

@spec update_proxy_session(String.t(), String.t(), [String.t()], pos_integer() | nil) ::
  ExAws.Operation.JSON.t()
Link to this function

update_voice_connector(voice_connector_id, name, require_encryption)

@spec update_voice_connector(String.t(), String.t(), boolean()) ::
  ExAws.Operation.JSON.t()
Link to this function

update_voice_connector_group(voice_connector_group_id, name, voice_connector_items)

@spec update_voice_connector_group(
  String.t(),
  String.t(),
  ExAws.Chime.Voice.VoiceConnectorItem.t()
) ::
  ExAws.Operation.JSON.t()