ExAws.Chime (ex_aws_chime v1.0.1)

See https://docs.aws.amazon.com/chime/latest/APIReference

Summary

Functions

Types

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

max_results()

@type max_results() :: pos_integer() | nil
Link to this type

paging_token()

@type paging_token() :: String.t() | nil

Functions

Link to this function

associate_phone_number_with_user(account_id, user_id, phone_number)

@spec associate_phone_number_with_user(String.t(), String.t(), String.t()) ::
  ExAws.Operation.JSON.t()
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

associate_signin_delegate_groups_with_account(account_id, group_names)

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

batch_create_attendee(meeting_id, attendee_requests)

Link to this function

batch_create_room_membership(account_id, room_id, memberships)

@spec batch_create_room_membership(
  String.t(),
  String.t(),
  ExAws.Chime.MembershipItem.t()
) ::
  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_suspend_user(account_id, user_ids)

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

batch_unsuspend_user(account_id, user_ids)

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

batch_update_phone_number(phone_number_updates)

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

batch_update_user(account_id, user_updates)

Link to this function

create_account(name)

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

create_attendee(meeting_id, create_attendee)

Link to this function

create_bot(account_id, display_name, domain \\ nil)

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

create_meeting(external_meeting_id \\ nil, media_region \\ nil, meeting_host_id \\ nil, notifications_configuration \\ nil, tags \\ nil)

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

create_meeting_with_attendees(attendees \\ nil, external_meeting_id, media_region \\ nil, meeting_host_id \\ nil, notifications_configuration \\ nil, tags \\ nil)

@spec create_meeting_with_attendees(
  [ExAws.Chime.CreateAttendeeRequestItem.t()] | nil,
  String.t(),
  String.t() | nil,
  String.t() | nil,
  ExAws.Chime.MeetingNotificationConfiguration.t() | nil,
  [ExAws.Chime.Tag.t()] | nil
) :: 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_room(account_id, name)

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

create_room_membership(account_id, room_id, member_id, role \\ nil)

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

create_user(account_id, email \\ nil, username \\ nil, user_type \\ nil)

@spec create_user(String.t(), String.t() | nil, String.t() | nil, String.t() | nil) ::
  ExAws.Operation.JSON.t()
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.VoiceConnectorItem.t()] | nil
) ::
  ExAws.Operation.JSON.t()
Link to this function

delete_account(account_id)

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

delete_attendee(meeting_id, attendee_id)

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

delete_events_configuration(account_id, bot_id)

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

delete_meeting(meeting_id)

@spec delete_meeting(String.t()) :: ExAws.Operation.RestQuery.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_room(account_id, room_id)

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

delete_room_membership(account_id, room_id, member_id)

@spec delete_room_membership(String.t(), 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_number_from_user(account_id, user_id)

@spec disassociate_phone_number_from_user(String.t(), String.t()) ::
  ExAws.Operation.RestQuery.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

disassociate_signin_delegate_groups_from_account(account_id, group_names)

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

get_account(account_id)

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

get_account_settings(account_id)

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

get_attendee(meeting_id, attendee_id)

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

get_bot(account_id, bot_id)

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

get_events_configuration(account_id, bot_id)

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

get_global_settings()

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

get_meeting(meeting_id)

@spec get_meeting(String.t()) :: 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_retention_settings(account_id)

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

get_room(account_id, room_id)

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

get_user(account_id, user_id)

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

get_user_settings(account_id, user_id)

@spec get_user_settings(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

invite_users(account_id, user_emails, user_type \\ nil)

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

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

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

list_attendee_tags(meeting_id, attendee_id)

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

list_attendees(meeting_id, max_results \\ nil, next_token \\ nil)

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

list_bots(account_id, max_results \\ nil, next_token \\ nil)

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

list_meeting_tags(meeting_id)

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

list_meetings(max_results \\ nil, next_token \\ nil)

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

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

@spec list_phone_number_orders(max_results(), 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(), max_results(), 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(), max_results(), paging_token()) ::
  ExAws.Operation.RestQuery.t()
Link to this function

list_room_memberships(account_id, room_id, max_results \\ nil, next_token \\ nil)

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

list_rooms(account_id, max_results \\ nil, next_token \\ nil)

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

list_tags_for_resource(resource_arn)

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

list_users(account_id, filters \\ %{}, max_results \\ nil, next_token \\ nil)

@spec list_users(String.t(), filters(), max_results(), 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(max_results(), 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(max_results(), paging_token()) ::
  ExAws.Operation.RestQuery.t()
Link to this function

logout_user(account_id, user_id)

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

normalise_data(struct)

Link to this function

put_events_configuration(account_id, bot_id, lambda_function_arn \\ nil, outbound_events_https_endpoint \\ nil)

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

put_retention_settings(account_id, retention_settings)

@spec put_retention_settings(String.t(), ExAws.Chime.RetentionSettings.t()) ::
  ExAws.Operation.JSON.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.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.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.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.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.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.Credentials.t()] | nil
) ::
  ExAws.Operation.JSON.t()
Link to this function

redact_conversation_message(account_id, conversation_id, message_id)

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

redact_room_message(account_id, room_id, message_id)

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

regenerate_security_token(account_id, bot_id)

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

reset_personal_pin(account_id, user_id)

@spec reset_personal_pin(String.t(), String.t()) :: ExAws.Operation.RestQuery.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)

Link to this function

start_transcription(meeting_id, engine_transcribe_settings)

Link to this function

stop_transcription(meeting_id)

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

tag_attendee(meeting_id, attendee_id, tags)

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

tag_meeting(meeting_id, tags)

@spec tag_meeting(String.t(), [ExAws.Chime.Tag.t()]) :: ExAws.Operation.JSON.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_attendee(meeting_id, attendee_id, tag_keys)

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

untag_meeting(meeting_id, tag_keys)

@spec untag_meeting(String.t(), [String.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_account(account_id, name)

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

update_account_settings(account_id, account_settings)

@spec update_account_settings(String.t(), ExAws.Chime.AccountSettings.t()) ::
  ExAws.Operation.JSON.t()
Link to this function

update_bot(account_id, bot_id, disabled \\ nil)

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

update_global_settings(business_calling, voice_connector)

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_room(account_id, room_id, name \\ nil)

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

update_room_membership(account_id, room_id, member_id, role \\ nil)

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

update_user(account_id, user_id, alexa_for_business_metadata \\ nil, license_type \\ nil, user_type \\ nil)

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

update_user_settings(account_id, user_id, user_settings)

@spec update_user_settings(String.t(), String.t(), ExAws.Chime.UserSettings.t()) ::
  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.VoiceConnectorItem.t()
) ::
  ExAws.Operation.JSON.t()