# WARNING: DO NOT EDIT, AUTO-GENERATED CODE!
# See https://github.com/aws-beam/aws-codegen for more details.
defmodule AWS.PinpointSMSVoice do
@moduledoc """
Pinpoint SMS and Voice Messaging public facing APIs
"""
alias AWS.Client
alias AWS.Request
@typedoc """
## Example:
already_exists_exception() :: %{
"Message" => String.t() | atom()
}
"""
@type already_exists_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
bad_request_exception() :: %{
"Message" => String.t() | atom()
}
"""
@type bad_request_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
call_instructions_message_type() :: %{
"Text" => String.t() | atom()
}
"""
@type call_instructions_message_type() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
cloud_watch_logs_destination() :: %{
"IamRoleArn" => String.t() | atom(),
"LogGroupArn" => String.t() | atom()
}
"""
@type cloud_watch_logs_destination() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_configuration_set_event_destination_request() :: %{
optional("EventDestination") => event_destination_definition(),
optional("EventDestinationName") => String.t() | atom()
}
"""
@type create_configuration_set_event_destination_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_configuration_set_event_destination_response() :: %{}
"""
@type create_configuration_set_event_destination_response() :: %{}
@typedoc """
## Example:
create_configuration_set_request() :: %{
optional("ConfigurationSetName") => String.t() | atom()
}
"""
@type create_configuration_set_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_configuration_set_response() :: %{}
"""
@type create_configuration_set_response() :: %{}
@typedoc """
## Example:
delete_configuration_set_event_destination_request() :: %{}
"""
@type delete_configuration_set_event_destination_request() :: %{}
@typedoc """
## Example:
delete_configuration_set_event_destination_response() :: %{}
"""
@type delete_configuration_set_event_destination_response() :: %{}
@typedoc """
## Example:
delete_configuration_set_request() :: %{}
"""
@type delete_configuration_set_request() :: %{}
@typedoc """
## Example:
delete_configuration_set_response() :: %{}
"""
@type delete_configuration_set_response() :: %{}
@typedoc """
## Example:
event_destination() :: %{
"CloudWatchLogsDestination" => cloud_watch_logs_destination(),
"Enabled" => boolean(),
"KinesisFirehoseDestination" => kinesis_firehose_destination(),
"MatchingEventTypes" => list(list(any())()),
"Name" => String.t() | atom(),
"SnsDestination" => sns_destination()
}
"""
@type event_destination() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
event_destination_definition() :: %{
"CloudWatchLogsDestination" => cloud_watch_logs_destination(),
"Enabled" => boolean(),
"KinesisFirehoseDestination" => kinesis_firehose_destination(),
"MatchingEventTypes" => list(list(any())()),
"SnsDestination" => sns_destination()
}
"""
@type event_destination_definition() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_configuration_set_event_destinations_request() :: %{}
"""
@type get_configuration_set_event_destinations_request() :: %{}
@typedoc """
## Example:
get_configuration_set_event_destinations_response() :: %{
"EventDestinations" => list(event_destination())
}
"""
@type get_configuration_set_event_destinations_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
internal_service_error_exception() :: %{
"Message" => String.t() | atom()
}
"""
@type internal_service_error_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
kinesis_firehose_destination() :: %{
"DeliveryStreamArn" => String.t() | atom(),
"IamRoleArn" => String.t() | atom()
}
"""
@type kinesis_firehose_destination() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
limit_exceeded_exception() :: %{
"Message" => String.t() | atom()
}
"""
@type limit_exceeded_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_configuration_sets_request() :: %{
optional("NextToken") => String.t() | atom(),
optional("PageSize") => String.t() | atom()
}
"""
@type list_configuration_sets_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_configuration_sets_response() :: %{
"ConfigurationSets" => list(String.t() | atom()),
"NextToken" => String.t() | atom()
}
"""
@type list_configuration_sets_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
not_found_exception() :: %{
"Message" => String.t() | atom()
}
"""
@type not_found_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
plain_text_message_type() :: %{
"LanguageCode" => String.t() | atom(),
"Text" => String.t() | atom(),
"VoiceId" => String.t() | atom()
}
"""
@type plain_text_message_type() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
s_s_ml_message_type() :: %{
"LanguageCode" => String.t() | atom(),
"Text" => String.t() | atom(),
"VoiceId" => String.t() | atom()
}
"""
@type s_s_ml_message_type() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
send_voice_message_request() :: %{
optional("CallerId") => String.t() | atom(),
optional("ConfigurationSetName") => String.t() | atom(),
optional("Content") => voice_message_content(),
optional("DestinationPhoneNumber") => String.t() | atom(),
optional("OriginationPhoneNumber") => String.t() | atom()
}
"""
@type send_voice_message_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
send_voice_message_response() :: %{
"MessageId" => String.t() | atom()
}
"""
@type send_voice_message_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
sns_destination() :: %{
"TopicArn" => String.t() | atom()
}
"""
@type sns_destination() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
too_many_requests_exception() :: %{
"Message" => String.t() | atom()
}
"""
@type too_many_requests_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_configuration_set_event_destination_request() :: %{
optional("EventDestination") => event_destination_definition()
}
"""
@type update_configuration_set_event_destination_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_configuration_set_event_destination_response() :: %{}
"""
@type update_configuration_set_event_destination_response() :: %{}
@typedoc """
## Example:
voice_message_content() :: %{
"CallInstructionsMessage" => call_instructions_message_type(),
"PlainTextMessage" => plain_text_message_type(),
"SSMLMessage" => s_s_ml_message_type()
}
"""
@type voice_message_content() :: %{(String.t() | atom()) => any()}
@type create_configuration_set_errors() ::
too_many_requests_exception()
| limit_exceeded_exception()
| internal_service_error_exception()
| bad_request_exception()
| already_exists_exception()
@type create_configuration_set_event_destination_errors() ::
too_many_requests_exception()
| not_found_exception()
| limit_exceeded_exception()
| internal_service_error_exception()
| bad_request_exception()
| already_exists_exception()
@type delete_configuration_set_errors() ::
too_many_requests_exception()
| not_found_exception()
| internal_service_error_exception()
| bad_request_exception()
@type delete_configuration_set_event_destination_errors() ::
too_many_requests_exception()
| not_found_exception()
| internal_service_error_exception()
| bad_request_exception()
@type get_configuration_set_event_destinations_errors() ::
too_many_requests_exception()
| not_found_exception()
| internal_service_error_exception()
| bad_request_exception()
@type list_configuration_sets_errors() ::
too_many_requests_exception()
| internal_service_error_exception()
| bad_request_exception()
@type send_voice_message_errors() ::
too_many_requests_exception()
| internal_service_error_exception()
| bad_request_exception()
@type update_configuration_set_event_destination_errors() ::
too_many_requests_exception()
| not_found_exception()
| internal_service_error_exception()
| bad_request_exception()
def metadata do
%{
api_version: "2018-09-05",
content_type: "application/x-amz-json-1.1",
credential_scope: nil,
endpoint_prefix: "sms-voice.pinpoint",
global?: false,
hostname: nil,
protocol: "rest-json",
service_id: "Pinpoint SMS Voice",
signature_version: "v4",
signing_name: "sms-voice",
target_prefix: nil
}
end
@doc """
Create a new configuration set.
After you create the configuration set, you can add one or more event
destinations to it.
"""
@spec create_configuration_set(map(), create_configuration_set_request(), list()) ::
{:ok, create_configuration_set_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_configuration_set_errors()}
def create_configuration_set(%Client{} = client, input, options \\ []) do
url_path = "/v1/sms-voice/configuration-sets"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Create a new event destination in a configuration set.
"""
@spec create_configuration_set_event_destination(
map(),
String.t() | atom(),
create_configuration_set_event_destination_request(),
list()
) ::
{:ok, create_configuration_set_event_destination_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_configuration_set_event_destination_errors()}
def create_configuration_set_event_destination(
%Client{} = client,
configuration_set_name,
input,
options \\ []
) do
url_path =
"/v1/sms-voice/configuration-sets/#{AWS.Util.encode_uri(configuration_set_name)}/event-destinations"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Deletes an existing configuration set.
"""
@spec delete_configuration_set(
map(),
String.t() | atom(),
delete_configuration_set_request(),
list()
) ::
{:ok, delete_configuration_set_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_configuration_set_errors()}
def delete_configuration_set(%Client{} = client, configuration_set_name, input, options \\ []) do
url_path = "/v1/sms-voice/configuration-sets/#{AWS.Util.encode_uri(configuration_set_name)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Deletes an event destination in a configuration set.
"""
@spec delete_configuration_set_event_destination(
map(),
String.t() | atom(),
String.t() | atom(),
delete_configuration_set_event_destination_request(),
list()
) ::
{:ok, delete_configuration_set_event_destination_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_configuration_set_event_destination_errors()}
def delete_configuration_set_event_destination(
%Client{} = client,
configuration_set_name,
event_destination_name,
input,
options \\ []
) do
url_path =
"/v1/sms-voice/configuration-sets/#{AWS.Util.encode_uri(configuration_set_name)}/event-destinations/#{AWS.Util.encode_uri(event_destination_name)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Obtain information about an event destination, including the types of events it
reports, the Amazon Resource Name (ARN) of the destination, and the name of the
event destination.
"""
@spec get_configuration_set_event_destinations(map(), String.t() | atom(), list()) ::
{:ok, get_configuration_set_event_destinations_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_configuration_set_event_destinations_errors()}
def get_configuration_set_event_destinations(
%Client{} = client,
configuration_set_name,
options \\ []
) do
url_path =
"/v1/sms-voice/configuration-sets/#{AWS.Util.encode_uri(configuration_set_name)}/event-destinations"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
List all of the configuration sets associated with your Amazon Pinpoint account
in the current region.
"""
@spec list_configuration_sets(
map(),
String.t() | atom() | nil,
String.t() | atom() | nil,
list()
) ::
{:ok, list_configuration_sets_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_configuration_sets_errors()}
def list_configuration_sets(
%Client{} = client,
next_token \\ nil,
page_size \\ nil,
options \\ []
) do
url_path = "/v1/sms-voice/configuration-sets"
headers = []
query_params = []
query_params =
if !is_nil(page_size) do
[{"PageSize", page_size} | query_params]
else
query_params
end
query_params =
if !is_nil(next_token) do
[{"NextToken", next_token} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Create a new voice message and send it to a recipient's phone number.
"""
@spec send_voice_message(map(), send_voice_message_request(), list()) ::
{:ok, send_voice_message_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, send_voice_message_errors()}
def send_voice_message(%Client{} = client, input, options \\ []) do
url_path = "/v1/sms-voice/voice/message"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Update an event destination in a configuration set.
An event destination is a location that you publish information about your voice
calls to. For example, you can log an event to an Amazon CloudWatch destination
when a call fails.
"""
@spec update_configuration_set_event_destination(
map(),
String.t() | atom(),
String.t() | atom(),
update_configuration_set_event_destination_request(),
list()
) ::
{:ok, update_configuration_set_event_destination_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_configuration_set_event_destination_errors()}
def update_configuration_set_event_destination(
%Client{} = client,
configuration_set_name,
event_destination_name,
input,
options \\ []
) do
url_path =
"/v1/sms-voice/configuration-sets/#{AWS.Util.encode_uri(configuration_set_name)}/event-destinations/#{AWS.Util.encode_uri(event_destination_name)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
end
