# WARNING: DO NOT EDIT, AUTO-GENERATED CODE!
# See https://github.com/aws-beam/aws-codegen for more details.
defmodule AWS.PinpointSMSVoiceV2 do
@moduledoc """
Welcome to the *AWS End User Messaging SMS and Voice, version 2 API Reference*.
This guide provides information about AWS End User Messaging SMS and Voice,
version 2 API
resources, including supported HTTP methods, parameters, and schemas.
Amazon Pinpoint is an Amazon Web Services service that you can use to engage
with
your recipients across multiple messaging channels. The AWS End User Messaging
SMS and Voice, version 2 API provides programmatic access to options that are
unique to the SMS
and voice channels. AWS End User Messaging SMS and Voice, version 2 resources
such as phone numbers, sender IDs, and opt-out lists can be used by the Amazon
Pinpoint API.
If you're new to AWS End User Messaging SMS and Voice, it's also helpful to
review the [
AWS End User Messaging SMS User
Guide](https://docs.aws.amazon.com/sms-voice/latest/userguide/what-is-service.html).
The *AWS End User Messaging SMS User Guide
* provides tutorials, code samples, and procedures that
demonstrate how to use AWS End User Messaging SMS and Voice features
programmatically and how to integrate
functionality into mobile apps and other types of applications.
The guide also provides key information, such as AWS End User Messaging SMS and
Voice integration with
other Amazon Web Services services, and the quotas that apply to use of the
service.
## Regional availability
The *AWS End User Messaging SMS and Voice version 2 API Reference* is
available in several Amazon Web Services Regions and it provides an endpoint for
each of
these Regions. For a list of all the Regions and endpoints where the API is
currently
available, see [Amazon Web Services Service Endpoints](https://docs.aws.amazon.com/general/latest/gr/rande.html#pinpoint_region)
and [Amazon Pinpoint endpoints and
quotas](https://docs.aws.amazon.com/general/latest/gr/pinpoint.html) in the
Amazon Web Services General Reference. To
learn more about Amazon Web Services Regions, see [Managing Amazon Web Services
Regions](https://docs.aws.amazon.com/general/latest/gr/rande-manage.html) in the
Amazon Web Services General
Reference.
In each Region, Amazon Web Services maintains multiple Availability Zones. These
Availability Zones are physically isolated from each other, but are united by
private,
low-latency, high-throughput, and highly redundant network connections. These
Availability Zones enable us to provide very high levels of availability and
redundancy,
while also minimizing latency. To learn more about the number of Availability
Zones that
are available in each Region, see [Amazon Web Services Global Infrastructure.](https://aws.amazon.com/about-aws/global-infrastructure/)
"""
alias AWS.Client
alias AWS.Request
@typedoc """
## Example:
describe_spend_limits_result() :: %{
"NextToken" => String.t(),
"SpendLimits" => list(spend_limit()())
}
"""
@type describe_spend_limits_result() :: %{String.t() => any()}
@typedoc """
## Example:
update_phone_number_result() :: %{
"CreatedTimestamp" => [non_neg_integer()],
"DeletionProtectionEnabled" => [boolean()],
"IsoCountryCode" => String.t(),
"MessageType" => String.t(),
"MonthlyLeasingPrice" => [String.t()],
"NumberCapabilities" => list(String.t()()),
"NumberType" => String.t(),
"OptOutListName" => String.t(),
"PhoneNumber" => String.t(),
"PhoneNumberArn" => [String.t()],
"PhoneNumberId" => [String.t()],
"RegistrationId" => [String.t()],
"SelfManagedOptOutsEnabled" => [boolean()],
"Status" => String.t(),
"TwoWayChannelArn" => String.t(),
"TwoWayChannelRole" => String.t(),
"TwoWayEnabled" => [boolean()]
}
"""
@type update_phone_number_result() :: %{String.t() => any()}
@typedoc """
## Example:
spend_limit() :: %{
"EnforcedLimit" => [float()],
"MaxLimit" => [float()],
"Name" => String.t(),
"Overridden" => [boolean()]
}
"""
@type spend_limit() :: %{String.t() => any()}
@typedoc """
## Example:
describe_registration_field_definitions_result() :: %{
"NextToken" => String.t(),
"RegistrationFieldDefinitions" => list(registration_field_definition()()),
"RegistrationType" => String.t()
}
"""
@type describe_registration_field_definitions_result() :: %{String.t() => any()}
@typedoc """
## Example:
registration_attachment_filter() :: %{
"Name" => String.t(),
"Values" => list(String.t()())
}
"""
@type registration_attachment_filter() :: %{String.t() => any()}
@typedoc """
## Example:
create_registration_attachment_request() :: %{
optional("AttachmentBody") => binary(),
optional("AttachmentUrl") => String.t(),
optional("ClientToken") => String.t(),
optional("Tags") => list(tag()())
}
"""
@type create_registration_attachment_request() :: %{String.t() => any()}
@typedoc """
## Example:
phone_number_information() :: %{
"CreatedTimestamp" => [non_neg_integer()],
"DeletionProtectionEnabled" => [boolean()],
"IsoCountryCode" => String.t(),
"MessageType" => String.t(),
"MonthlyLeasingPrice" => [String.t()],
"NumberCapabilities" => list(String.t()()),
"NumberType" => String.t(),
"OptOutListName" => String.t(),
"PhoneNumber" => String.t(),
"PhoneNumberArn" => [String.t()],
"PhoneNumberId" => [String.t()],
"PoolId" => [String.t()],
"RegistrationId" => [String.t()],
"SelfManagedOptOutsEnabled" => [boolean()],
"Status" => String.t(),
"TwoWayChannelArn" => String.t(),
"TwoWayChannelRole" => String.t(),
"TwoWayEnabled" => [boolean()]
}
"""
@type phone_number_information() :: %{String.t() => any()}
@typedoc """
## Example:
create_registration_attachment_result() :: %{
"AttachmentStatus" => String.t(),
"CreatedTimestamp" => [non_neg_integer()],
"RegistrationAttachmentArn" => [String.t()],
"RegistrationAttachmentId" => [String.t()],
"Tags" => list(tag()())
}
"""
@type create_registration_attachment_result() :: %{String.t() => any()}
@typedoc """
## Example:
request_sender_id_request() :: %{
optional("ClientToken") => String.t(),
optional("DeletionProtectionEnabled") => [boolean()],
optional("MessageTypes") => list(String.t()()),
optional("Tags") => list(tag()()),
required("IsoCountryCode") => String.t(),
required("SenderId") => String.t()
}
"""
@type request_sender_id_request() :: %{String.t() => any()}
@typedoc """
## Example:
tag_resource_request() :: %{
required("ResourceArn") => String.t(),
required("Tags") => list(tag()())
}
"""
@type tag_resource_request() :: %{String.t() => any()}
@typedoc """
## Example:
send_destination_number_verification_code_request() :: %{
optional("ConfigurationSetName") => String.t(),
optional("Context") => map(),
optional("DestinationCountryParameters") => map(),
optional("LanguageCode") => String.t(),
optional("OriginationIdentity") => String.t(),
required("VerificationChannel") => String.t(),
required("VerifiedDestinationNumberId") => String.t()
}
"""
@type send_destination_number_verification_code_request() :: %{String.t() => any()}
@typedoc """
## Example:
describe_account_limits_request() :: %{
optional("MaxResults") => integer(),
optional("NextToken") => String.t()
}
"""
@type describe_account_limits_request() :: %{String.t() => any()}
@typedoc """
## Example:
delete_pool_result() :: %{
"CreatedTimestamp" => [non_neg_integer()],
"MessageType" => String.t(),
"OptOutListName" => String.t(),
"PoolArn" => [String.t()],
"PoolId" => [String.t()],
"SelfManagedOptOutsEnabled" => [boolean()],
"SharedRoutesEnabled" => [boolean()],
"Status" => String.t(),
"TwoWayChannelArn" => String.t(),
"TwoWayChannelRole" => String.t(),
"TwoWayEnabled" => [boolean()]
}
"""
@type delete_pool_result() :: %{String.t() => any()}
@typedoc """
## Example:
describe_registration_versions_result() :: %{
"NextToken" => String.t(),
"RegistrationArn" => [String.t()],
"RegistrationId" => [String.t()],
"RegistrationVersions" => list(registration_version_information()())
}
"""
@type describe_registration_versions_result() :: %{String.t() => any()}
@typedoc """
## Example:
update_pool_result() :: %{
"CreatedTimestamp" => [non_neg_integer()],
"DeletionProtectionEnabled" => [boolean()],
"MessageType" => String.t(),
"OptOutListName" => String.t(),
"PoolArn" => [String.t()],
"PoolId" => [String.t()],
"SelfManagedOptOutsEnabled" => [boolean()],
"SharedRoutesEnabled" => [boolean()],
"Status" => String.t(),
"TwoWayChannelArn" => String.t(),
"TwoWayChannelRole" => String.t(),
"TwoWayEnabled" => [boolean()]
}
"""
@type update_pool_result() :: %{String.t() => any()}
@typedoc """
## Example:
verified_destination_number_information() :: %{
"CreatedTimestamp" => [non_neg_integer()],
"DestinationPhoneNumber" => String.t(),
"Status" => String.t(),
"VerifiedDestinationNumberArn" => [String.t()],
"VerifiedDestinationNumberId" => [String.t()]
}
"""
@type verified_destination_number_information() :: %{String.t() => any()}
@typedoc """
## Example:
request_phone_number_result() :: %{
"CreatedTimestamp" => [non_neg_integer()],
"DeletionProtectionEnabled" => [boolean()],
"IsoCountryCode" => String.t(),
"MessageType" => String.t(),
"MonthlyLeasingPrice" => [String.t()],
"NumberCapabilities" => list(String.t()()),
"NumberType" => String.t(),
"OptOutListName" => String.t(),
"PhoneNumber" => String.t(),
"PhoneNumberArn" => [String.t()],
"PhoneNumberId" => [String.t()],
"PoolId" => [String.t()],
"RegistrationId" => [String.t()],
"SelfManagedOptOutsEnabled" => [boolean()],
"Status" => String.t(),
"Tags" => list(tag()()),
"TwoWayChannelArn" => String.t(),
"TwoWayChannelRole" => String.t(),
"TwoWayEnabled" => [boolean()]
}
"""
@type request_phone_number_result() :: %{String.t() => any()}
@typedoc """
## Example:
delete_voice_message_spend_limit_override_request() :: %{}
"""
@type delete_voice_message_spend_limit_override_request() :: %{}
@typedoc """
## Example:
describe_pools_result() :: %{
"NextToken" => String.t(),
"Pools" => list(pool_information()())
}
"""
@type describe_pools_result() :: %{String.t() => any()}
@typedoc """
## Example:
list_registration_associations_request() :: %{
optional("Filters") => list(registration_association_filter()()),
optional("MaxResults") => integer(),
optional("NextToken") => String.t(),
required("RegistrationId") => String.t()
}
"""
@type list_registration_associations_request() :: %{String.t() => any()}
@typedoc """
## Example:
registration_section_display_hints() :: %{
"DocumentationLink" => [String.t()],
"DocumentationTitle" => [String.t()],
"LongDescription" => [String.t()],
"ShortDescription" => [String.t()],
"Title" => [String.t()]
}
"""
@type registration_section_display_hints() :: %{String.t() => any()}
@typedoc """
## Example:
describe_pools_request() :: %{
optional("Filters") => list(pool_filter()()),
optional("MaxResults") => integer(),
optional("NextToken") => String.t(),
optional("Owner") => String.t(),
optional("PoolIds") => list(String.t()())
}
"""
@type describe_pools_request() :: %{String.t() => any()}
@typedoc """
## Example:
create_opt_out_list_result() :: %{
"CreatedTimestamp" => [non_neg_integer()],
"OptOutListArn" => [String.t()],
"OptOutListName" => String.t(),
"Tags" => list(tag()())
}
"""
@type create_opt_out_list_result() :: %{String.t() => any()}
@typedoc """
## Example:
untag_resource_result() :: %{}
"""
@type untag_resource_result() :: %{}
@typedoc """
## Example:
verified_destination_number_filter() :: %{
"Name" => String.t(),
"Values" => list(String.t()())
}
"""
@type verified_destination_number_filter() :: %{String.t() => any()}
@typedoc """
## Example:
create_registration_association_request() :: %{
required("RegistrationId") => String.t(),
required("ResourceId") => String.t()
}
"""
@type create_registration_association_request() :: %{String.t() => any()}
@typedoc """
## Example:
set_default_message_type_request() :: %{
required("ConfigurationSetName") => String.t(),
required("MessageType") => String.t()
}
"""
@type set_default_message_type_request() :: %{String.t() => any()}
@typedoc """
## Example:
pool_information() :: %{
"CreatedTimestamp" => [non_neg_integer()],
"DeletionProtectionEnabled" => [boolean()],
"MessageType" => String.t(),
"OptOutListName" => String.t(),
"PoolArn" => [String.t()],
"PoolId" => [String.t()],
"SelfManagedOptOutsEnabled" => [boolean()],
"SharedRoutesEnabled" => [boolean()],
"Status" => String.t(),
"TwoWayChannelArn" => String.t(),
"TwoWayChannelRole" => String.t(),
"TwoWayEnabled" => [boolean()]
}
"""
@type pool_information() :: %{String.t() => any()}
@typedoc """
## Example:
registration_type_display_hints() :: %{
"DocumentationLink" => [String.t()],
"DocumentationTitle" => [String.t()],
"LongDescription" => [String.t()],
"ShortDescription" => [String.t()],
"Title" => [String.t()]
}
"""
@type registration_type_display_hints() :: %{String.t() => any()}
@typedoc """
## Example:
put_resource_policy_result() :: %{
"CreatedTimestamp" => [non_neg_integer()],
"Policy" => String.t(),
"ResourceArn" => String.t()
}
"""
@type put_resource_policy_result() :: %{String.t() => any()}
@typedoc """
## Example:
update_protect_configuration_request() :: %{
optional("DeletionProtectionEnabled") => [boolean()],
required("ProtectConfigurationId") => String.t()
}
"""
@type update_protect_configuration_request() :: %{String.t() => any()}
@typedoc """
## Example:
registration_association_filter() :: %{
"Name" => String.t(),
"Values" => list(String.t()())
}
"""
@type registration_association_filter() :: %{String.t() => any()}
@typedoc """
## Example:
kinesis_firehose_destination() :: %{
"DeliveryStreamArn" => String.t(),
"IamRoleArn" => String.t()
}
"""
@type kinesis_firehose_destination() :: %{String.t() => any()}
@typedoc """
## Example:
disassociate_protect_configuration_result() :: %{
"ConfigurationSetArn" => [String.t()],
"ConfigurationSetName" => String.t(),
"ProtectConfigurationArn" => String.t(),
"ProtectConfigurationId" => String.t()
}
"""
@type disassociate_protect_configuration_result() :: %{String.t() => any()}
@typedoc """
## Example:
registration_denied_reason_information() :: %{
"DocumentationLink" => [String.t()],
"DocumentationTitle" => [String.t()],
"LongDescription" => [String.t()],
"Reason" => [String.t()],
"ShortDescription" => [String.t()]
}
"""
@type registration_denied_reason_information() :: %{String.t() => any()}
@typedoc """
## Example:
put_protect_configuration_rule_set_number_override_result() :: %{
"Action" => String.t(),
"CreatedTimestamp" => [non_neg_integer()],
"DestinationPhoneNumber" => String.t(),
"ExpirationTimestamp" => [non_neg_integer()],
"IsoCountryCode" => String.t(),
"ProtectConfigurationArn" => String.t(),
"ProtectConfigurationId" => String.t()
}
"""
@type put_protect_configuration_rule_set_number_override_result() :: %{String.t() => any()}
@typedoc """
## Example:
protect_configuration_country_rule_set_information() :: %{
"ProtectStatus" => String.t()
}
"""
@type protect_configuration_country_rule_set_information() :: %{String.t() => any()}
@typedoc """
## Example:
registration_association_metadata() :: %{
"IsoCountryCode" => String.t(),
"PhoneNumber" => String.t(),
"ResourceArn" => [String.t()],
"ResourceId" => [String.t()],
"ResourceType" => [String.t()]
}
"""
@type registration_association_metadata() :: %{String.t() => any()}
@typedoc """
## Example:
describe_registration_type_definitions_request() :: %{
optional("Filters") => list(registration_type_filter()()),
optional("MaxResults") => integer(),
optional("NextToken") => String.t(),
optional("RegistrationTypes") => list(String.t()())
}
"""
@type describe_registration_type_definitions_request() :: %{String.t() => any()}
@typedoc """
## Example:
submit_registration_version_request() :: %{
required("RegistrationId") => String.t()
}
"""
@type submit_registration_version_request() :: %{String.t() => any()}
@typedoc """
## Example:
cloud_watch_logs_destination() :: %{
"IamRoleArn" => String.t(),
"LogGroupArn" => String.t()
}
"""
@type cloud_watch_logs_destination() :: %{String.t() => any()}
@typedoc """
## Example:
create_registration_association_result() :: %{
"IsoCountryCode" => String.t(),
"PhoneNumber" => String.t(),
"RegistrationArn" => [String.t()],
"RegistrationId" => [String.t()],
"RegistrationType" => String.t(),
"ResourceArn" => [String.t()],
"ResourceId" => [String.t()],
"ResourceType" => [String.t()]
}
"""
@type create_registration_association_result() :: %{String.t() => any()}
@typedoc """
## Example:
create_pool_result() :: %{
"CreatedTimestamp" => [non_neg_integer()],
"DeletionProtectionEnabled" => [boolean()],
"MessageType" => String.t(),
"OptOutListName" => String.t(),
"PoolArn" => [String.t()],
"PoolId" => [String.t()],
"SelfManagedOptOutsEnabled" => [boolean()],
"SharedRoutesEnabled" => [boolean()],
"Status" => String.t(),
"Tags" => list(tag()()),
"TwoWayChannelArn" => String.t(),
"TwoWayChannelRole" => String.t(),
"TwoWayEnabled" => [boolean()]
}
"""
@type create_pool_result() :: %{String.t() => any()}
@typedoc """
## Example:
delete_default_message_type_request() :: %{
required("ConfigurationSetName") => String.t()
}
"""
@type delete_default_message_type_request() :: %{String.t() => any()}
@typedoc """
## Example:
release_phone_number_result() :: %{
"CreatedTimestamp" => [non_neg_integer()],
"IsoCountryCode" => String.t(),
"MessageType" => String.t(),
"MonthlyLeasingPrice" => [String.t()],
"NumberCapabilities" => list(String.t()()),
"NumberType" => String.t(),
"OptOutListName" => String.t(),
"PhoneNumber" => String.t(),
"PhoneNumberArn" => [String.t()],
"PhoneNumberId" => [String.t()],
"RegistrationId" => [String.t()],
"SelfManagedOptOutsEnabled" => [boolean()],
"Status" => String.t(),
"TwoWayChannelArn" => String.t(),
"TwoWayChannelRole" => String.t(),
"TwoWayEnabled" => [boolean()]
}
"""
@type release_phone_number_result() :: %{String.t() => any()}
@typedoc """
## Example:
delete_protect_configuration_request() :: %{
required("ProtectConfigurationId") => String.t()
}
"""
@type delete_protect_configuration_request() :: %{String.t() => any()}
@typedoc """
## Example:
delete_event_destination_request() :: %{
required("ConfigurationSetName") => String.t(),
required("EventDestinationName") => String.t()
}
"""
@type delete_event_destination_request() :: %{String.t() => any()}
@typedoc """
## Example:
associate_protect_configuration_result() :: %{
"ConfigurationSetArn" => [String.t()],
"ConfigurationSetName" => String.t(),
"ProtectConfigurationArn" => String.t(),
"ProtectConfigurationId" => String.t()
}
"""
@type associate_protect_configuration_result() :: %{String.t() => any()}
@typedoc """
## Example:
configuration_set_information() :: %{
"ConfigurationSetArn" => [String.t()],
"ConfigurationSetName" => String.t(),
"CreatedTimestamp" => [non_neg_integer()],
"DefaultMessageFeedbackEnabled" => [boolean()],
"DefaultMessageType" => String.t(),
"DefaultSenderId" => String.t(),
"EventDestinations" => list(event_destination()()),
"ProtectConfigurationId" => String.t()
}
"""
@type configuration_set_information() :: %{String.t() => any()}
@typedoc """
## Example:
text_validation() :: %{
"MaxLength" => [integer()],
"MinLength" => [integer()],
"Pattern" => [String.t()]
}
"""
@type text_validation() :: %{String.t() => any()}
@typedoc """
## Example:
release_phone_number_request() :: %{
required("PhoneNumberId") => String.t()
}
"""
@type release_phone_number_request() :: %{String.t() => any()}
@typedoc """
## Example:
release_sender_id_result() :: %{
"IsoCountryCode" => String.t(),
"MessageTypes" => list(String.t()()),
"MonthlyLeasingPrice" => [String.t()],
"Registered" => [boolean()],
"RegistrationId" => [String.t()],
"SenderId" => String.t(),
"SenderIdArn" => [String.t()]
}
"""
@type release_sender_id_result() :: %{String.t() => any()}
@typedoc """
## Example:
update_sender_id_request() :: %{
optional("DeletionProtectionEnabled") => [boolean()],
required("IsoCountryCode") => String.t(),
required("SenderId") => String.t()
}
"""
@type update_sender_id_request() :: %{String.t() => any()}
@typedoc """
## Example:
discard_registration_version_request() :: %{
required("RegistrationId") => String.t()
}
"""
@type discard_registration_version_request() :: %{String.t() => any()}
@typedoc """
## Example:
update_pool_request() :: %{
optional("DeletionProtectionEnabled") => [boolean()],
optional("OptOutListName") => String.t(),
optional("SelfManagedOptOutsEnabled") => [boolean()],
optional("SharedRoutesEnabled") => [boolean()],
optional("TwoWayChannelArn") => String.t(),
optional("TwoWayChannelRole") => String.t(),
optional("TwoWayEnabled") => [boolean()],
required("PoolId") => String.t()
}
"""
@type update_pool_request() :: %{String.t() => any()}
@typedoc """
## Example:
set_text_message_spend_limit_override_result() :: %{
"MonthlyLimit" => float()
}
"""
@type set_text_message_spend_limit_override_result() :: %{String.t() => any()}
@typedoc """
## Example:
create_pool_request() :: %{
optional("ClientToken") => String.t(),
optional("DeletionProtectionEnabled") => [boolean()],
optional("Tags") => list(tag()()),
required("IsoCountryCode") => String.t(),
required("MessageType") => String.t(),
required("OriginationIdentity") => String.t()
}
"""
@type create_pool_request() :: %{String.t() => any()}
@typedoc """
## Example:
untag_resource_request() :: %{
required("ResourceArn") => String.t(),
required("TagKeys") => list(String.t()())
}
"""
@type untag_resource_request() :: %{String.t() => any()}
@typedoc """
## Example:
registration_filter() :: %{
"Name" => String.t(),
"Values" => list(String.t()())
}
"""
@type registration_filter() :: %{String.t() => any()}
@typedoc """
## Example:
set_voice_message_spend_limit_override_request() :: %{
required("MonthlyLimit") => float()
}
"""
@type set_voice_message_spend_limit_override_request() :: %{String.t() => any()}
@typedoc """
## Example:
request_sender_id_result() :: %{
"DeletionProtectionEnabled" => [boolean()],
"IsoCountryCode" => String.t(),
"MessageTypes" => list(String.t()()),
"MonthlyLeasingPrice" => [String.t()],
"Registered" => [boolean()],
"SenderId" => String.t(),
"SenderIdArn" => [String.t()],
"Tags" => list(tag()())
}
"""
@type request_sender_id_result() :: %{String.t() => any()}
@typedoc """
## Example:
delete_registration_field_value_request() :: %{
required("FieldPath") => String.t(),
required("RegistrationId") => String.t()
}
"""
@type delete_registration_field_value_request() :: %{String.t() => any()}
@typedoc """
## Example:
verify_destination_number_result() :: %{
"CreatedTimestamp" => [non_neg_integer()],
"DestinationPhoneNumber" => String.t(),
"Status" => String.t(),
"VerifiedDestinationNumberArn" => [String.t()],
"VerifiedDestinationNumberId" => [String.t()]
}
"""
@type verify_destination_number_result() :: %{String.t() => any()}
@typedoc """
## Example:
delete_media_message_spend_limit_override_request() :: %{}
"""
@type delete_media_message_spend_limit_override_request() :: %{}
@typedoc """
## Example:
delete_configuration_set_request() :: %{
required("ConfigurationSetName") => String.t()
}
"""
@type delete_configuration_set_request() :: %{String.t() => any()}
@typedoc """
## Example:
describe_registration_section_definitions_result() :: %{
"NextToken" => String.t(),
"RegistrationSectionDefinitions" => list(registration_section_definition()()),
"RegistrationType" => String.t()
}
"""
@type describe_registration_section_definitions_result() :: %{String.t() => any()}
@typedoc """
## Example:
create_registration_version_result() :: %{
"RegistrationArn" => [String.t()],
"RegistrationId" => [String.t()],
"RegistrationVersionStatus" => String.t(),
"RegistrationVersionStatusHistory" => registration_version_status_history(),
"VersionNumber" => float()
}
"""
@type create_registration_version_result() :: %{String.t() => any()}
@typedoc """
## Example:
delete_text_message_spend_limit_override_request() :: %{}
"""
@type delete_text_message_spend_limit_override_request() :: %{}
@typedoc """
## Example:
describe_keywords_result() :: %{
"Keywords" => list(keyword_information()()),
"NextToken" => String.t(),
"OriginationIdentity" => [String.t()],
"OriginationIdentityArn" => [String.t()]
}
"""
@type describe_keywords_result() :: %{String.t() => any()}
@typedoc """
## Example:
registration_attachments_information() :: %{
"AttachmentStatus" => String.t(),
"AttachmentUploadErrorReason" => String.t(),
"CreatedTimestamp" => [non_neg_integer()],
"RegistrationAttachmentArn" => [String.t()],
"RegistrationAttachmentId" => [String.t()]
}
"""
@type registration_attachments_information() :: %{String.t() => any()}
@typedoc """
## Example:
select_validation() :: %{
"MaxChoices" => [integer()],
"MinChoices" => [integer()],
"Options" => list([String.t()]())
}
"""
@type select_validation() :: %{String.t() => any()}
@typedoc """
## Example:
disassociate_origination_identity_result() :: %{
"IsoCountryCode" => String.t(),
"OriginationIdentity" => [String.t()],
"OriginationIdentityArn" => [String.t()],
"PoolArn" => [String.t()],
"PoolId" => [String.t()]
}
"""
@type disassociate_origination_identity_result() :: %{String.t() => any()}
@typedoc """
## Example:
create_event_destination_request() :: %{
optional("ClientToken") => String.t(),
optional("CloudWatchLogsDestination") => cloud_watch_logs_destination(),
optional("KinesisFirehoseDestination") => kinesis_firehose_destination(),
optional("SnsDestination") => sns_destination(),
required("ConfigurationSetName") => String.t(),
required("EventDestinationName") => String.t(),
required("MatchingEventTypes") => list(String.t()())
}
"""
@type create_event_destination_request() :: %{String.t() => any()}
@typedoc """
## Example:
describe_registrations_request() :: %{
optional("Filters") => list(registration_filter()()),
optional("MaxResults") => integer(),
optional("NextToken") => String.t(),
optional("RegistrationIds") => list(String.t()())
}
"""
@type describe_registrations_request() :: %{String.t() => any()}
@typedoc """
## Example:
describe_protect_configurations_request() :: %{
optional("Filters") => list(protect_configuration_filter()()),
optional("MaxResults") => integer(),
optional("NextToken") => String.t(),
optional("ProtectConfigurationIds") => list(String.t()())
}
"""
@type describe_protect_configurations_request() :: %{String.t() => any()}
@typedoc """
## Example:
put_protect_configuration_rule_set_number_override_request() :: %{
optional("ClientToken") => String.t(),
optional("ExpirationTimestamp") => [non_neg_integer()],
required("Action") => String.t(),
required("DestinationPhoneNumber") => String.t(),
required("ProtectConfigurationId") => String.t()
}
"""
@type put_protect_configuration_rule_set_number_override_request() :: %{String.t() => any()}
@typedoc """
## Example:
update_event_destination_request() :: %{
optional("CloudWatchLogsDestination") => cloud_watch_logs_destination(),
optional("Enabled") => [boolean()],
optional("KinesisFirehoseDestination") => kinesis_firehose_destination(),
optional("MatchingEventTypes") => list(String.t()()),
optional("SnsDestination") => sns_destination(),
required("ConfigurationSetName") => String.t(),
required("EventDestinationName") => String.t()
}
"""
@type update_event_destination_request() :: %{String.t() => any()}
@typedoc """
## Example:
update_protect_configuration_country_rule_set_result() :: %{
"CountryRuleSet" => map(),
"NumberCapability" => String.t(),
"ProtectConfigurationArn" => String.t(),
"ProtectConfigurationId" => String.t()
}
"""
@type update_protect_configuration_country_rule_set_result() :: %{String.t() => any()}
@typedoc """
## Example:
describe_verified_destination_numbers_result() :: %{
"NextToken" => String.t(),
"VerifiedDestinationNumbers" => list(verified_destination_number_information()())
}
"""
@type describe_verified_destination_numbers_result() :: %{String.t() => any()}
@typedoc """
## Example:
delete_opted_out_number_result() :: %{
"EndUserOptedOut" => [boolean()],
"OptOutListArn" => [String.t()],
"OptOutListName" => String.t(),
"OptedOutNumber" => String.t(),
"OptedOutTimestamp" => [non_neg_integer()]
}
"""
@type delete_opted_out_number_result() :: %{String.t() => any()}
@typedoc """
## Example:
set_voice_message_spend_limit_override_result() :: %{
"MonthlyLimit" => float()
}
"""
@type set_voice_message_spend_limit_override_result() :: %{String.t() => any()}
@typedoc """
## Example:
create_protect_configuration_request() :: %{
optional("ClientToken") => String.t(),
optional("DeletionProtectionEnabled") => [boolean()],
optional("Tags") => list(tag()())
}
"""
@type create_protect_configuration_request() :: %{String.t() => any()}
@typedoc """
## Example:
conflict_exception() :: %{
"Message" => [String.t()],
"Reason" => String.t(),
"ResourceId" => [String.t()],
"ResourceType" => String.t()
}
"""
@type conflict_exception() :: %{String.t() => any()}
@typedoc """
## Example:
resource_not_found_exception() :: %{
"Message" => [String.t()],
"ResourceId" => [String.t()],
"ResourceType" => String.t()
}
"""
@type resource_not_found_exception() :: %{String.t() => any()}
@typedoc """
## Example:
registration_field_definition() :: %{
"DisplayHints" => registration_field_display_hints(),
"FieldPath" => String.t(),
"FieldRequirement" => String.t(),
"FieldType" => String.t(),
"SectionPath" => String.t(),
"SelectValidation" => select_validation(),
"TextValidation" => text_validation()
}
"""
@type registration_field_definition() :: %{String.t() => any()}
@typedoc """
## Example:
delete_account_default_protect_configuration_result() :: %{
"DefaultProtectConfigurationArn" => String.t(),
"DefaultProtectConfigurationId" => String.t()
}
"""
@type delete_account_default_protect_configuration_result() :: %{String.t() => any()}
@typedoc """
## Example:
put_message_feedback_result() :: %{
"MessageFeedbackStatus" => String.t(),
"MessageId" => String.t()
}
"""
@type put_message_feedback_result() :: %{String.t() => any()}
@typedoc """
## Example:
registration_type_definition() :: %{
"DisplayHints" => registration_type_display_hints(),
"RegistrationType" => String.t(),
"SupportedAssociations" => list(supported_association()())
}
"""
@type registration_type_definition() :: %{String.t() => any()}
@typedoc """
## Example:
opted_out_number_information() :: %{
"EndUserOptedOut" => [boolean()],
"OptedOutNumber" => String.t(),
"OptedOutTimestamp" => [non_neg_integer()]
}
"""
@type opted_out_number_information() :: %{String.t() => any()}
@typedoc """
## Example:
list_protect_configuration_rule_set_number_overrides_result() :: %{
"NextToken" => String.t(),
"ProtectConfigurationArn" => String.t(),
"ProtectConfigurationId" => String.t(),
"RuleSetNumberOverrides" => list(protect_configuration_rule_set_number_override()())
}
"""
@type list_protect_configuration_rule_set_number_overrides_result() :: %{String.t() => any()}
@typedoc """
## Example:
tag() :: %{
"Key" => String.t(),
"Value" => String.t()
}
"""
@type tag() :: %{String.t() => any()}
@typedoc """
## Example:
event_destination() :: %{
"CloudWatchLogsDestination" => cloud_watch_logs_destination(),
"Enabled" => [boolean()],
"EventDestinationName" => String.t(),
"KinesisFirehoseDestination" => kinesis_firehose_destination(),
"MatchingEventTypes" => list(String.t()()),
"SnsDestination" => sns_destination()
}
"""
@type event_destination() :: %{String.t() => any()}
@typedoc """
## Example:
delete_opted_out_number_request() :: %{
required("OptOutListName") => String.t(),
required("OptedOutNumber") => String.t()
}
"""
@type delete_opted_out_number_request() :: %{String.t() => any()}
@typedoc """
## Example:
registration_section_definition() :: %{
"DisplayHints" => registration_section_display_hints(),
"SectionPath" => String.t()
}
"""
@type registration_section_definition() :: %{String.t() => any()}
@typedoc """
## Example:
delete_opt_out_list_result() :: %{
"CreatedTimestamp" => [non_neg_integer()],
"OptOutListArn" => [String.t()],
"OptOutListName" => String.t()
}
"""
@type delete_opt_out_list_result() :: %{String.t() => any()}
@typedoc """
## Example:
update_protect_configuration_country_rule_set_request() :: %{
required("CountryRuleSetUpdates") => map(),
required("NumberCapability") => String.t(),
required("ProtectConfigurationId") => String.t()
}
"""
@type update_protect_configuration_country_rule_set_request() :: %{String.t() => any()}
@typedoc """
## Example:
delete_registration_result() :: %{
"AdditionalAttributes" => map(),
"ApprovedVersionNumber" => float(),
"CreatedTimestamp" => [non_neg_integer()],
"CurrentVersionNumber" => float(),
"LatestDeniedVersionNumber" => float(),
"RegistrationArn" => [String.t()],
"RegistrationId" => [String.t()],
"RegistrationStatus" => String.t(),
"RegistrationType" => String.t()
}
"""
@type delete_registration_result() :: %{String.t() => any()}
@typedoc """
## Example:
sender_id_filter() :: %{
"Name" => String.t(),
"Values" => list(String.t()())
}
"""
@type sender_id_filter() :: %{String.t() => any()}
@typedoc """
## Example:
delete_event_destination_result() :: %{
"ConfigurationSetArn" => [String.t()],
"ConfigurationSetName" => String.t(),
"EventDestination" => event_destination()
}
"""
@type delete_event_destination_result() :: %{String.t() => any()}
@typedoc """
## Example:
protect_configuration_filter() :: %{
"Name" => String.t(),
"Values" => list(String.t()())
}
"""
@type protect_configuration_filter() :: %{String.t() => any()}
@typedoc """
## Example:
service_quota_exceeded_exception() :: %{
"Message" => [String.t()],
"Reason" => String.t()
}
"""
@type service_quota_exceeded_exception() :: %{String.t() => any()}
@typedoc """
## Example:
delete_default_sender_id_request() :: %{
required("ConfigurationSetName") => String.t()
}
"""
@type delete_default_sender_id_request() :: %{String.t() => any()}
@typedoc """
## Example:
set_default_message_feedback_enabled_result() :: %{
"ConfigurationSetArn" => [String.t()],
"ConfigurationSetName" => String.t(),
"MessageFeedbackEnabled" => [boolean()]
}
"""
@type set_default_message_feedback_enabled_result() :: %{String.t() => any()}
@typedoc """
## Example:
delete_voice_message_spend_limit_override_result() :: %{
"MonthlyLimit" => float()
}
"""
@type delete_voice_message_spend_limit_override_result() :: %{String.t() => any()}
@typedoc """
## Example:
associate_origination_identity_result() :: %{
"IsoCountryCode" => String.t(),
"OriginationIdentity" => [String.t()],
"OriginationIdentityArn" => [String.t()],
"PoolArn" => [String.t()],
"PoolId" => [String.t()]
}
"""
@type associate_origination_identity_result() :: %{String.t() => any()}
@typedoc """
## Example:
set_default_message_feedback_enabled_request() :: %{
required("ConfigurationSetName") => String.t(),
required("MessageFeedbackEnabled") => [boolean()]
}
"""
@type set_default_message_feedback_enabled_request() :: %{String.t() => any()}
@typedoc """
## Example:
describe_opted_out_numbers_result() :: %{
"NextToken" => String.t(),
"OptOutListArn" => [String.t()],
"OptOutListName" => String.t(),
"OptedOutNumbers" => list(opted_out_number_information()())
}
"""
@type describe_opted_out_numbers_result() :: %{String.t() => any()}
@typedoc """
## Example:
registration_version_status_history() :: %{
"ApprovedTimestamp" => [non_neg_integer()],
"ArchivedTimestamp" => [non_neg_integer()],
"DeniedTimestamp" => [non_neg_integer()],
"DiscardedTimestamp" => [non_neg_integer()],
"DraftTimestamp" => [non_neg_integer()],
"RequiresAuthenticationTimestamp" => [non_neg_integer()],
"ReviewingTimestamp" => [non_neg_integer()],
"RevokedTimestamp" => [non_neg_integer()],
"SubmittedTimestamp" => [non_neg_integer()]
}
"""
@type registration_version_status_history() :: %{String.t() => any()}
@typedoc """
## Example:
phone_number_filter() :: %{
"Name" => String.t(),
"Values" => list(String.t()())
}
"""
@type phone_number_filter() :: %{String.t() => any()}
@typedoc """
## Example:
list_pool_origination_identities_request() :: %{
optional("Filters") => list(pool_origination_identities_filter()()),
optional("MaxResults") => integer(),
optional("NextToken") => String.t(),
required("PoolId") => String.t()
}
"""
@type list_pool_origination_identities_request() :: %{String.t() => any()}
@typedoc """
## Example:
registration_information() :: %{
"AdditionalAttributes" => map(),
"ApprovedVersionNumber" => float(),
"CreatedTimestamp" => [non_neg_integer()],
"CurrentVersionNumber" => float(),
"LatestDeniedVersionNumber" => float(),
"RegistrationArn" => [String.t()],
"RegistrationId" => [String.t()],
"RegistrationStatus" => String.t(),
"RegistrationType" => String.t()
}
"""
@type registration_information() :: %{String.t() => any()}
@typedoc """
## Example:
send_media_message_result() :: %{
"MessageId" => [String.t()]
}
"""
@type send_media_message_result() :: %{String.t() => any()}
@typedoc """
## Example:
select_option_description() :: %{
"Description" => [String.t()],
"Option" => [String.t()],
"Title" => [String.t()]
}
"""
@type select_option_description() :: %{String.t() => any()}
@typedoc """
## Example:
get_resource_policy_result() :: %{
"CreatedTimestamp" => [non_neg_integer()],
"Policy" => String.t(),
"ResourceArn" => String.t()
}
"""
@type get_resource_policy_result() :: %{String.t() => any()}
@typedoc """
## Example:
keyword_filter() :: %{
"Name" => String.t(),
"Values" => list(String.t()())
}
"""
@type keyword_filter() :: %{String.t() => any()}
@typedoc """
## Example:
create_registration_version_request() :: %{
required("RegistrationId") => String.t()
}
"""
@type create_registration_version_request() :: %{String.t() => any()}
@typedoc """
## Example:
describe_keywords_request() :: %{
optional("Filters") => list(keyword_filter()()),
optional("Keywords") => list(String.t()()),
optional("MaxResults") => integer(),
optional("NextToken") => String.t(),
required("OriginationIdentity") => String.t()
}
"""
@type describe_keywords_request() :: %{String.t() => any()}
@typedoc """
## Example:
delete_verified_destination_number_request() :: %{
required("VerifiedDestinationNumberId") => String.t()
}
"""
@type delete_verified_destination_number_request() :: %{String.t() => any()}
@typedoc """
## Example:
account_limit() :: %{
"Max" => [float()],
"Name" => String.t(),
"Used" => [float()]
}
"""
@type account_limit() :: %{String.t() => any()}
@typedoc """
## Example:
request_phone_number_request() :: %{
optional("ClientToken") => String.t(),
optional("DeletionProtectionEnabled") => [boolean()],
optional("OptOutListName") => String.t(),
optional("PoolId") => String.t(),
optional("RegistrationId") => String.t(),
optional("Tags") => list(tag()()),
required("IsoCountryCode") => String.t(),
required("MessageType") => String.t(),
required("NumberCapabilities") => list(String.t()()),
required("NumberType") => String.t()
}
"""
@type request_phone_number_request() :: %{String.t() => any()}
@typedoc """
## Example:
create_protect_configuration_result() :: %{
"AccountDefault" => [boolean()],
"CreatedTimestamp" => [non_neg_integer()],
"DeletionProtectionEnabled" => [boolean()],
"ProtectConfigurationArn" => String.t(),
"ProtectConfigurationId" => String.t(),
"Tags" => list(tag()())
}
"""
@type create_protect_configuration_result() :: %{String.t() => any()}
@typedoc """
## Example:
describe_registration_field_values_result() :: %{
"NextToken" => String.t(),
"RegistrationArn" => [String.t()],
"RegistrationFieldValues" => list(registration_field_value_information()()),
"RegistrationId" => [String.t()],
"VersionNumber" => float()
}
"""
@type describe_registration_field_values_result() :: %{String.t() => any()}
@typedoc """
## Example:
validation_exception_field() :: %{
"Message" => [String.t()],
"Name" => [String.t()]
}
"""
@type validation_exception_field() :: %{String.t() => any()}
@typedoc """
## Example:
delete_keyword_request() :: %{
required("Keyword") => String.t(),
required("OriginationIdentity") => String.t()
}
"""
@type delete_keyword_request() :: %{String.t() => any()}
@typedoc """
## Example:
describe_registration_field_values_request() :: %{
optional("FieldPaths") => list(String.t()()),
optional("MaxResults") => integer(),
optional("NextToken") => String.t(),
optional("SectionPath") => String.t(),
optional("VersionNumber") => float(),
required("RegistrationId") => String.t()
}
"""
@type describe_registration_field_values_request() :: %{String.t() => any()}
@typedoc """
## Example:
describe_opt_out_lists_request() :: %{
optional("MaxResults") => integer(),
optional("NextToken") => String.t(),
optional("OptOutListNames") => list(String.t()()),
optional("Owner") => String.t()
}
"""
@type describe_opt_out_lists_request() :: %{String.t() => any()}
@typedoc """
## Example:
get_resource_policy_request() :: %{
required("ResourceArn") => String.t()
}
"""
@type get_resource_policy_request() :: %{String.t() => any()}
@typedoc """
## Example:
create_registration_result() :: %{
"AdditionalAttributes" => map(),
"CreatedTimestamp" => [non_neg_integer()],
"CurrentVersionNumber" => float(),
"RegistrationArn" => [String.t()],
"RegistrationId" => [String.t()],
"RegistrationStatus" => String.t(),
"RegistrationType" => String.t(),
"Tags" => list(tag()())
}
"""
@type create_registration_result() :: %{String.t() => any()}
@typedoc """
## Example:
put_opted_out_number_result() :: %{
"EndUserOptedOut" => [boolean()],
"OptOutListArn" => [String.t()],
"OptOutListName" => String.t(),
"OptedOutNumber" => String.t(),
"OptedOutTimestamp" => [non_neg_integer()]
}
"""
@type put_opted_out_number_result() :: %{String.t() => any()}
@typedoc """
## Example:
update_event_destination_result() :: %{
"ConfigurationSetArn" => [String.t()],
"ConfigurationSetName" => String.t(),
"EventDestination" => event_destination()
}
"""
@type update_event_destination_result() :: %{String.t() => any()}
@typedoc """
## Example:
delete_opt_out_list_request() :: %{
required("OptOutListName") => String.t()
}
"""
@type delete_opt_out_list_request() :: %{String.t() => any()}
@typedoc """
## Example:
pool_filter() :: %{
"Name" => String.t(),
"Values" => list(String.t()())
}
"""
@type pool_filter() :: %{String.t() => any()}
@typedoc """
## Example:
describe_spend_limits_request() :: %{
optional("MaxResults") => integer(),
optional("NextToken") => String.t()
}
"""
@type describe_spend_limits_request() :: %{String.t() => any()}
@typedoc """
## Example:
describe_sender_ids_request() :: %{
optional("Filters") => list(sender_id_filter()()),
optional("MaxResults") => integer(),
optional("NextToken") => String.t(),
optional("Owner") => String.t(),
optional("SenderIds") => list(sender_id_and_country()())
}
"""
@type describe_sender_ids_request() :: %{String.t() => any()}
@typedoc """
## Example:
delete_protect_configuration_rule_set_number_override_request() :: %{
required("DestinationPhoneNumber") => String.t(),
required("ProtectConfigurationId") => String.t()
}
"""
@type delete_protect_configuration_rule_set_number_override_request() :: %{String.t() => any()}
@typedoc """
## Example:
describe_registration_attachments_result() :: %{
"NextToken" => String.t(),
"RegistrationAttachments" => list(registration_attachments_information()())
}
"""
@type describe_registration_attachments_result() :: %{String.t() => any()}
@typedoc """
## Example:
list_pool_origination_identities_result() :: %{
"NextToken" => String.t(),
"OriginationIdentities" => list(origination_identity_metadata()()),
"PoolArn" => [String.t()],
"PoolId" => [String.t()]
}
"""
@type list_pool_origination_identities_result() :: %{String.t() => any()}
@typedoc """
## Example:
put_registration_field_value_result() :: %{
"FieldPath" => String.t(),
"RegistrationArn" => [String.t()],
"RegistrationAttachmentId" => [String.t()],
"RegistrationId" => [String.t()],
"SelectChoices" => list(String.t()()),
"TextValue" => String.t(),
"VersionNumber" => float()
}
"""
@type put_registration_field_value_result() :: %{String.t() => any()}
@typedoc """
## Example:
opted_out_filter() :: %{
"Name" => String.t(),
"Values" => list(String.t()())
}
"""
@type opted_out_filter() :: %{String.t() => any()}
@typedoc """
## Example:
send_destination_number_verification_code_result() :: %{
"MessageId" => [String.t()]
}
"""
@type send_destination_number_verification_code_result() :: %{String.t() => any()}
@typedoc """
## Example:
describe_verified_destination_numbers_request() :: %{
optional("DestinationPhoneNumbers") => list(String.t()()),
optional("Filters") => list(verified_destination_number_filter()()),
optional("MaxResults") => integer(),
optional("NextToken") => String.t(),
optional("VerifiedDestinationNumberIds") => list(String.t()())
}
"""
@type describe_verified_destination_numbers_request() :: %{String.t() => any()}
@typedoc """
## Example:
registration_field_display_hints() :: %{
"DocumentationLink" => [String.t()],
"DocumentationTitle" => [String.t()],
"ExampleTextValue" => [String.t()],
"LongDescription" => [String.t()],
"SelectOptionDescriptions" => list(select_option_description()()),
"ShortDescription" => [String.t()],
"TextValidationDescription" => [String.t()],
"Title" => [String.t()]
}
"""
@type registration_field_display_hints() :: %{String.t() => any()}
@typedoc """
## Example:
send_voice_message_request() :: %{
optional("ConfigurationSetName") => String.t(),
optional("Context") => map(),
optional("DryRun") => [boolean()],
optional("MaxPricePerMinute") => String.t(),
optional("MessageBody") => String.t(),
optional("MessageBodyTextType") => String.t(),
optional("MessageFeedbackEnabled") => [boolean()],
optional("ProtectConfigurationId") => String.t(),
optional("TimeToLive") => integer(),
optional("VoiceId") => String.t(),
required("DestinationPhoneNumber") => String.t(),
required("OriginationIdentity") => String.t()
}
"""
@type send_voice_message_request() :: %{String.t() => any()}
@typedoc """
## Example:
put_message_feedback_request() :: %{
required("MessageFeedbackStatus") => String.t(),
required("MessageId") => String.t()
}
"""
@type put_message_feedback_request() :: %{String.t() => any()}
@typedoc """
## Example:
set_account_default_protect_configuration_result() :: %{
"DefaultProtectConfigurationArn" => String.t(),
"DefaultProtectConfigurationId" => String.t()
}
"""
@type set_account_default_protect_configuration_result() :: %{String.t() => any()}
@typedoc """
## Example:
internal_server_exception() :: %{
"Message" => [String.t()],
"RequestId" => [String.t()]
}
"""
@type internal_server_exception() :: %{String.t() => any()}
@typedoc """
## Example:
discard_registration_version_result() :: %{
"RegistrationArn" => [String.t()],
"RegistrationId" => [String.t()],
"RegistrationVersionStatus" => String.t(),
"RegistrationVersionStatusHistory" => registration_version_status_history(),
"VersionNumber" => float()
}
"""
@type discard_registration_version_result() :: %{String.t() => any()}
@typedoc """
## Example:
list_registration_associations_result() :: %{
"NextToken" => String.t(),
"RegistrationArn" => [String.t()],
"RegistrationAssociations" => list(registration_association_metadata()()),
"RegistrationId" => [String.t()],
"RegistrationType" => String.t()
}
"""
@type list_registration_associations_result() :: %{String.t() => any()}
@typedoc """
## Example:
protect_configuration_rule_set_number_override() :: %{
"Action" => String.t(),
"CreatedTimestamp" => [non_neg_integer()],
"DestinationPhoneNumber" => String.t(),
"ExpirationTimestamp" => [non_neg_integer()],
"IsoCountryCode" => String.t()
}
"""
@type protect_configuration_rule_set_number_override() :: %{String.t() => any()}
@typedoc """
## Example:
list_tags_for_resource_result() :: %{
"ResourceArn" => String.t(),
"Tags" => list(tag()())
}
"""
@type list_tags_for_resource_result() :: %{String.t() => any()}
@typedoc """
## Example:
release_sender_id_request() :: %{
required("IsoCountryCode") => String.t(),
required("SenderId") => String.t()
}
"""
@type release_sender_id_request() :: %{String.t() => any()}
@typedoc """
## Example:
supported_association() :: %{
"AssociationBehavior" => String.t(),
"DisassociationBehavior" => String.t(),
"IsoCountryCode" => String.t(),
"ResourceType" => [String.t()]
}
"""
@type supported_association() :: %{String.t() => any()}
@typedoc """
## Example:
disassociate_protect_configuration_request() :: %{
required("ConfigurationSetName") => String.t(),
required("ProtectConfigurationId") => String.t()
}
"""
@type disassociate_protect_configuration_request() :: %{String.t() => any()}
@typedoc """
## Example:
send_text_message_result() :: %{
"MessageId" => [String.t()]
}
"""
@type send_text_message_result() :: %{String.t() => any()}
@typedoc """
## Example:
delete_registration_attachment_request() :: %{
required("RegistrationAttachmentId") => String.t()
}
"""
@type delete_registration_attachment_request() :: %{String.t() => any()}
@typedoc """
## Example:
sender_id_information() :: %{
"DeletionProtectionEnabled" => [boolean()],
"IsoCountryCode" => String.t(),
"MessageTypes" => list(String.t()()),
"MonthlyLeasingPrice" => [String.t()],
"Registered" => [boolean()],
"RegistrationId" => [String.t()],
"SenderId" => String.t(),
"SenderIdArn" => [String.t()]
}
"""
@type sender_id_information() :: %{String.t() => any()}
@typedoc """
## Example:
delete_pool_request() :: %{
required("PoolId") => String.t()
}
"""
@type delete_pool_request() :: %{String.t() => any()}
@typedoc """
## Example:
describe_registration_section_definitions_request() :: %{
optional("MaxResults") => integer(),
optional("NextToken") => String.t(),
optional("SectionPaths") => list(String.t()()),
required("RegistrationType") => String.t()
}
"""
@type describe_registration_section_definitions_request() :: %{String.t() => any()}
@typedoc """
## Example:
associate_protect_configuration_request() :: %{
required("ConfigurationSetName") => String.t(),
required("ProtectConfigurationId") => String.t()
}
"""
@type associate_protect_configuration_request() :: %{String.t() => any()}
@typedoc """
## Example:
put_resource_policy_request() :: %{
required("Policy") => String.t(),
required("ResourceArn") => String.t()
}
"""
@type put_resource_policy_request() :: %{String.t() => any()}
@typedoc """
## Example:
sender_id_and_country() :: %{
"IsoCountryCode" => String.t(),
"SenderId" => String.t()
}
"""
@type sender_id_and_country() :: %{String.t() => any()}
@typedoc """
## Example:
send_voice_message_result() :: %{
"MessageId" => [String.t()]
}
"""
@type send_voice_message_result() :: %{String.t() => any()}
@typedoc """
## Example:
access_denied_exception() :: %{
"Message" => [String.t()],
"Reason" => String.t()
}
"""
@type access_denied_exception() :: %{String.t() => any()}
@typedoc """
## Example:
delete_default_sender_id_result() :: %{
"ConfigurationSetArn" => [String.t()],
"ConfigurationSetName" => String.t(),
"SenderId" => String.t()
}
"""
@type delete_default_sender_id_result() :: %{String.t() => any()}
@typedoc """
## Example:
send_text_message_request() :: %{
optional("ConfigurationSetName") => String.t(),
optional("Context") => map(),
optional("DestinationCountryParameters") => map(),
optional("DryRun") => [boolean()],
optional("Keyword") => String.t(),
optional("MaxPrice") => String.t(),
optional("MessageBody") => String.t(),
optional("MessageFeedbackEnabled") => [boolean()],
optional("MessageType") => String.t(),
optional("OriginationIdentity") => String.t(),
optional("ProtectConfigurationId") => String.t(),
optional("TimeToLive") => integer(),
required("DestinationPhoneNumber") => String.t()
}
"""
@type send_text_message_request() :: %{String.t() => any()}
@typedoc """
## Example:
describe_sender_ids_result() :: %{
"NextToken" => String.t(),
"SenderIds" => list(sender_id_information()())
}
"""
@type describe_sender_ids_result() :: %{String.t() => any()}
@typedoc """
## Example:
get_protect_configuration_country_rule_set_result() :: %{
"CountryRuleSet" => map(),
"NumberCapability" => String.t(),
"ProtectConfigurationArn" => String.t(),
"ProtectConfigurationId" => String.t()
}
"""
@type get_protect_configuration_country_rule_set_result() :: %{String.t() => any()}
@typedoc """
## Example:
describe_account_attributes_result() :: %{
"AccountAttributes" => list(account_attribute()()),
"NextToken" => String.t()
}
"""
@type describe_account_attributes_result() :: %{String.t() => any()}
@typedoc """
## Example:
put_registration_field_value_request() :: %{
optional("RegistrationAttachmentId") => String.t(),
optional("SelectChoices") => list(String.t()()),
optional("TextValue") => String.t(),
required("FieldPath") => String.t(),
required("RegistrationId") => String.t()
}
"""
@type put_registration_field_value_request() :: %{String.t() => any()}
@typedoc """
## Example:
describe_registration_field_definitions_request() :: %{
optional("FieldPaths") => list(String.t()()),
optional("MaxResults") => integer(),
optional("NextToken") => String.t(),
optional("SectionPath") => String.t(),
required("RegistrationType") => String.t()
}
"""
@type describe_registration_field_definitions_request() :: %{String.t() => any()}
@typedoc """
## Example:
describe_registrations_result() :: %{
"NextToken" => String.t(),
"Registrations" => list(registration_information()())
}
"""
@type describe_registrations_result() :: %{String.t() => any()}
@typedoc """
## Example:
describe_opt_out_lists_result() :: %{
"NextToken" => String.t(),
"OptOutLists" => list(opt_out_list_information()())
}
"""
@type describe_opt_out_lists_result() :: %{String.t() => any()}
@typedoc """
## Example:
delete_verified_destination_number_result() :: %{
"CreatedTimestamp" => [non_neg_integer()],
"DestinationPhoneNumber" => String.t(),
"VerifiedDestinationNumberArn" => [String.t()],
"VerifiedDestinationNumberId" => [String.t()]
}
"""
@type delete_verified_destination_number_result() :: %{String.t() => any()}
@typedoc """
## Example:
describe_registration_attachments_request() :: %{
optional("Filters") => list(registration_attachment_filter()()),
optional("MaxResults") => integer(),
optional("NextToken") => String.t(),
optional("RegistrationAttachmentIds") => list(String.t()())
}
"""
@type describe_registration_attachments_request() :: %{String.t() => any()}
@typedoc """
## Example:
update_sender_id_result() :: %{
"DeletionProtectionEnabled" => [boolean()],
"IsoCountryCode" => String.t(),
"MessageTypes" => list(String.t()()),
"MonthlyLeasingPrice" => [String.t()],
"Registered" => [boolean()],
"RegistrationId" => [String.t()],
"SenderId" => String.t(),
"SenderIdArn" => [String.t()]
}
"""
@type update_sender_id_result() :: %{String.t() => any()}
@typedoc """
## Example:
pool_origination_identities_filter() :: %{
"Name" => String.t(),
"Values" => list(String.t()())
}
"""
@type pool_origination_identities_filter() :: %{String.t() => any()}
@typedoc """
## Example:
describe_account_limits_result() :: %{
"AccountLimits" => list(account_limit()()),
"NextToken" => String.t()
}
"""
@type describe_account_limits_result() :: %{String.t() => any()}
@typedoc """
## Example:
validation_exception() :: %{
"Fields" => list(validation_exception_field()()),
"Message" => [String.t()],
"Reason" => String.t()
}
"""
@type validation_exception() :: %{String.t() => any()}
@typedoc """
## Example:
list_tags_for_resource_request() :: %{
required("ResourceArn") => String.t()
}
"""
@type list_tags_for_resource_request() :: %{String.t() => any()}
@typedoc """
## Example:
put_keyword_result() :: %{
"Keyword" => String.t(),
"KeywordAction" => String.t(),
"KeywordMessage" => String.t(),
"OriginationIdentity" => [String.t()],
"OriginationIdentityArn" => [String.t()]
}
"""
@type put_keyword_result() :: %{String.t() => any()}
@typedoc """
## Example:
associate_origination_identity_request() :: %{
optional("ClientToken") => String.t(),
required("IsoCountryCode") => String.t(),
required("OriginationIdentity") => String.t(),
required("PoolId") => String.t()
}
"""
@type associate_origination_identity_request() :: %{String.t() => any()}
@typedoc """
## Example:
update_protect_configuration_result() :: %{
"AccountDefault" => [boolean()],
"CreatedTimestamp" => [non_neg_integer()],
"DeletionProtectionEnabled" => [boolean()],
"ProtectConfigurationArn" => String.t(),
"ProtectConfigurationId" => String.t()
}
"""
@type update_protect_configuration_result() :: %{String.t() => any()}
@typedoc """
## Example:
throttling_exception() :: %{
"Message" => [String.t()]
}
"""
@type throttling_exception() :: %{String.t() => any()}
@typedoc """
## Example:
protect_configuration_rule_set_number_override_filter_item() :: %{
"Name" => String.t(),
"Values" => list(String.t()())
}
"""
@type protect_configuration_rule_set_number_override_filter_item() :: %{String.t() => any()}
@typedoc """
## Example:
disassociate_origination_identity_request() :: %{
optional("ClientToken") => String.t(),
required("IsoCountryCode") => String.t(),
required("OriginationIdentity") => String.t(),
required("PoolId") => String.t()
}
"""
@type disassociate_origination_identity_request() :: %{String.t() => any()}
@typedoc """
## Example:
registration_type_filter() :: %{
"Name" => String.t(),
"Values" => list(String.t()())
}
"""
@type registration_type_filter() :: %{String.t() => any()}
@typedoc """
## Example:
account_attribute() :: %{
"Name" => String.t(),
"Value" => [String.t()]
}
"""
@type account_attribute() :: %{String.t() => any()}
@typedoc """
## Example:
create_verified_destination_number_request() :: %{
optional("ClientToken") => String.t(),
optional("Tags") => list(tag()()),
required("DestinationPhoneNumber") => String.t()
}
"""
@type create_verified_destination_number_request() :: %{String.t() => any()}
@typedoc """
## Example:
describe_phone_numbers_request() :: %{
optional("Filters") => list(phone_number_filter()()),
optional("MaxResults") => integer(),
optional("NextToken") => String.t(),
optional("Owner") => String.t(),
optional("PhoneNumberIds") => list(String.t()())
}
"""
@type describe_phone_numbers_request() :: %{String.t() => any()}
@typedoc """
## Example:
describe_opted_out_numbers_request() :: %{
optional("Filters") => list(opted_out_filter()()),
optional("MaxResults") => integer(),
optional("NextToken") => String.t(),
optional("OptedOutNumbers") => list(String.t()()),
required("OptOutListName") => String.t()
}
"""
@type describe_opted_out_numbers_request() :: %{String.t() => any()}
@typedoc """
## Example:
describe_protect_configurations_result() :: %{
"NextToken" => String.t(),
"ProtectConfigurations" => list(protect_configuration_information()())
}
"""
@type describe_protect_configurations_result() :: %{String.t() => any()}
@typedoc """
## Example:
set_account_default_protect_configuration_request() :: %{
required("ProtectConfigurationId") => String.t()
}
"""
@type set_account_default_protect_configuration_request() :: %{String.t() => any()}
@typedoc """
## Example:
delete_registration_request() :: %{
required("RegistrationId") => String.t()
}
"""
@type delete_registration_request() :: %{String.t() => any()}
@typedoc """
## Example:
describe_registration_type_definitions_result() :: %{
"NextToken" => String.t(),
"RegistrationTypeDefinitions" => list(registration_type_definition()())
}
"""
@type describe_registration_type_definitions_result() :: %{String.t() => any()}
@typedoc """
## Example:
describe_phone_numbers_result() :: %{
"NextToken" => String.t(),
"PhoneNumbers" => list(phone_number_information()())
}
"""
@type describe_phone_numbers_result() :: %{String.t() => any()}
@typedoc """
## Example:
tag_resource_result() :: %{}
"""
@type tag_resource_result() :: %{}
@typedoc """
## Example:
configuration_set_filter() :: %{
"Name" => String.t(),
"Values" => list(String.t()())
}
"""
@type configuration_set_filter() :: %{String.t() => any()}
@typedoc """
## Example:
create_opt_out_list_request() :: %{
optional("ClientToken") => String.t(),
optional("Tags") => list(tag()()),
required("OptOutListName") => String.t()
}
"""
@type create_opt_out_list_request() :: %{String.t() => any()}
@typedoc """
## Example:
create_configuration_set_result() :: %{
"ConfigurationSetArn" => [String.t()],
"ConfigurationSetName" => String.t(),
"CreatedTimestamp" => [non_neg_integer()],
"Tags" => list(tag()())
}
"""
@type create_configuration_set_result() :: %{String.t() => any()}
@typedoc """
## Example:
delete_account_default_protect_configuration_request() :: %{}
"""
@type delete_account_default_protect_configuration_request() :: %{}
@typedoc """
## Example:
delete_resource_policy_request() :: %{
required("ResourceArn") => String.t()
}
"""
@type delete_resource_policy_request() :: %{String.t() => any()}
@typedoc """
## Example:
describe_configuration_sets_result() :: %{
"ConfigurationSets" => list(configuration_set_information()()),
"NextToken" => String.t()
}
"""
@type describe_configuration_sets_result() :: %{String.t() => any()}
@typedoc """
## Example:
keyword_information() :: %{
"Keyword" => String.t(),
"KeywordAction" => String.t(),
"KeywordMessage" => String.t()
}
"""
@type keyword_information() :: %{String.t() => any()}
@typedoc """
## Example:
list_protect_configuration_rule_set_number_overrides_request() :: %{
optional("Filters") => list(protect_configuration_rule_set_number_override_filter_item()()),
optional("MaxResults") => integer(),
optional("NextToken") => String.t(),
required("ProtectConfigurationId") => String.t()
}
"""
@type list_protect_configuration_rule_set_number_overrides_request() :: %{String.t() => any()}
@typedoc """
## Example:
delete_registration_attachment_result() :: %{
"AttachmentStatus" => String.t(),
"AttachmentUploadErrorReason" => String.t(),
"CreatedTimestamp" => [non_neg_integer()],
"RegistrationAttachmentArn" => [String.t()],
"RegistrationAttachmentId" => [String.t()]
}
"""
@type delete_registration_attachment_result() :: %{String.t() => any()}
@typedoc """
## Example:
set_media_message_spend_limit_override_result() :: %{
"MonthlyLimit" => float()
}
"""
@type set_media_message_spend_limit_override_result() :: %{String.t() => any()}
@typedoc """
## Example:
put_keyword_request() :: %{
optional("KeywordAction") => String.t(),
required("Keyword") => String.t(),
required("KeywordMessage") => String.t(),
required("OriginationIdentity") => String.t()
}
"""
@type put_keyword_request() :: %{String.t() => any()}
@typedoc """
## Example:
set_default_sender_id_request() :: %{
required("ConfigurationSetName") => String.t(),
required("SenderId") => String.t()
}
"""
@type set_default_sender_id_request() :: %{String.t() => any()}
@typedoc """
## Example:
set_text_message_spend_limit_override_request() :: %{
required("MonthlyLimit") => float()
}
"""
@type set_text_message_spend_limit_override_request() :: %{String.t() => any()}
@typedoc """
## Example:
submit_registration_version_result() :: %{
"RegistrationArn" => [String.t()],
"RegistrationId" => [String.t()],
"RegistrationVersionStatus" => String.t(),
"RegistrationVersionStatusHistory" => registration_version_status_history(),
"VersionNumber" => float()
}
"""
@type submit_registration_version_result() :: %{String.t() => any()}
@typedoc """
## Example:
describe_registration_versions_request() :: %{
optional("Filters") => list(registration_version_filter()()),
optional("MaxResults") => integer(),
optional("NextToken") => String.t(),
optional("VersionNumbers") => list(float()()),
required("RegistrationId") => String.t()
}
"""
@type describe_registration_versions_request() :: %{String.t() => any()}
@typedoc """
## Example:
registration_field_value_information() :: %{
"DeniedReason" => [String.t()],
"FieldPath" => String.t(),
"RegistrationAttachmentId" => String.t(),
"SelectChoices" => list(String.t()()),
"TextValue" => String.t()
}
"""
@type registration_field_value_information() :: %{String.t() => any()}
@typedoc """
## Example:
protect_configuration_information() :: %{
"AccountDefault" => [boolean()],
"CreatedTimestamp" => [non_neg_integer()],
"DeletionProtectionEnabled" => [boolean()],
"ProtectConfigurationArn" => String.t(),
"ProtectConfigurationId" => String.t()
}
"""
@type protect_configuration_information() :: %{String.t() => any()}
@typedoc """
## Example:
set_default_sender_id_result() :: %{
"ConfigurationSetArn" => [String.t()],
"ConfigurationSetName" => String.t(),
"SenderId" => String.t()
}
"""
@type set_default_sender_id_result() :: %{String.t() => any()}
@typedoc """
## Example:
get_protect_configuration_country_rule_set_request() :: %{
required("NumberCapability") => String.t(),
required("ProtectConfigurationId") => String.t()
}
"""
@type get_protect_configuration_country_rule_set_request() :: %{String.t() => any()}
@typedoc """
## Example:
delete_resource_policy_result() :: %{
"CreatedTimestamp" => [non_neg_integer()],
"Policy" => String.t(),
"ResourceArn" => String.t()
}
"""
@type delete_resource_policy_result() :: %{String.t() => any()}
@typedoc """
## Example:
registration_version_information() :: %{
"DeniedReasons" => list(registration_denied_reason_information()()),
"RegistrationVersionStatus" => String.t(),
"RegistrationVersionStatusHistory" => registration_version_status_history(),
"VersionNumber" => float()
}
"""
@type registration_version_information() :: %{String.t() => any()}
@typedoc """
## Example:
delete_media_message_spend_limit_override_result() :: %{
"MonthlyLimit" => float()
}
"""
@type delete_media_message_spend_limit_override_result() :: %{String.t() => any()}
@typedoc """
## Example:
registration_version_filter() :: %{
"Name" => String.t(),
"Values" => list(String.t()())
}
"""
@type registration_version_filter() :: %{String.t() => any()}
@typedoc """
## Example:
update_phone_number_request() :: %{
optional("DeletionProtectionEnabled") => [boolean()],
optional("OptOutListName") => String.t(),
optional("SelfManagedOptOutsEnabled") => [boolean()],
optional("TwoWayChannelArn") => String.t(),
optional("TwoWayChannelRole") => String.t(),
optional("TwoWayEnabled") => [boolean()],
required("PhoneNumberId") => String.t()
}
"""
@type update_phone_number_request() :: %{String.t() => any()}
@typedoc """
## Example:
origination_identity_metadata() :: %{
"IsoCountryCode" => String.t(),
"NumberCapabilities" => list(String.t()()),
"OriginationIdentity" => [String.t()],
"OriginationIdentityArn" => [String.t()],
"PhoneNumber" => String.t()
}
"""
@type origination_identity_metadata() :: %{String.t() => any()}
@typedoc """
## Example:
set_default_message_type_result() :: %{
"ConfigurationSetArn" => [String.t()],
"ConfigurationSetName" => String.t(),
"MessageType" => String.t()
}
"""
@type set_default_message_type_result() :: %{String.t() => any()}
@typedoc """
## Example:
describe_configuration_sets_request() :: %{
optional("ConfigurationSetNames") => list(String.t()()),
optional("Filters") => list(configuration_set_filter()()),
optional("MaxResults") => integer(),
optional("NextToken") => String.t()
}
"""
@type describe_configuration_sets_request() :: %{String.t() => any()}
@typedoc """
## Example:
create_registration_request() :: %{
optional("ClientToken") => String.t(),
optional("Tags") => list(tag()()),
required("RegistrationType") => String.t()
}
"""
@type create_registration_request() :: %{String.t() => any()}
@typedoc """
## Example:
describe_account_attributes_request() :: %{
optional("MaxResults") => integer(),
optional("NextToken") => String.t()
}
"""
@type describe_account_attributes_request() :: %{String.t() => any()}
@typedoc """
## Example:
delete_text_message_spend_limit_override_result() :: %{
"MonthlyLimit" => float()
}
"""
@type delete_text_message_spend_limit_override_result() :: %{String.t() => any()}
@typedoc """
## Example:
set_media_message_spend_limit_override_request() :: %{
required("MonthlyLimit") => float()
}
"""
@type set_media_message_spend_limit_override_request() :: %{String.t() => any()}
@typedoc """
## Example:
put_opted_out_number_request() :: %{
required("OptOutListName") => String.t(),
required("OptedOutNumber") => String.t()
}
"""
@type put_opted_out_number_request() :: %{String.t() => any()}
@typedoc """
## Example:
create_event_destination_result() :: %{
"ConfigurationSetArn" => [String.t()],
"ConfigurationSetName" => String.t(),
"EventDestination" => event_destination()
}
"""
@type create_event_destination_result() :: %{String.t() => any()}
@typedoc """
## Example:
create_configuration_set_request() :: %{
optional("ClientToken") => String.t(),
optional("Tags") => list(tag()()),
required("ConfigurationSetName") => String.t()
}
"""
@type create_configuration_set_request() :: %{String.t() => any()}
@typedoc """
## Example:
create_verified_destination_number_result() :: %{
"CreatedTimestamp" => [non_neg_integer()],
"DestinationPhoneNumber" => String.t(),
"Status" => String.t(),
"Tags" => list(tag()()),
"VerifiedDestinationNumberArn" => [String.t()],
"VerifiedDestinationNumberId" => [String.t()]
}
"""
@type create_verified_destination_number_result() :: %{String.t() => any()}
@typedoc """
## Example:
delete_configuration_set_result() :: %{
"ConfigurationSetArn" => [String.t()],
"ConfigurationSetName" => String.t(),
"CreatedTimestamp" => [non_neg_integer()],
"DefaultMessageFeedbackEnabled" => [boolean()],
"DefaultMessageType" => String.t(),
"DefaultSenderId" => String.t(),
"EventDestinations" => list(event_destination()())
}
"""
@type delete_configuration_set_result() :: %{String.t() => any()}
@typedoc """
## Example:
delete_registration_field_value_result() :: %{
"FieldPath" => String.t(),
"RegistrationArn" => [String.t()],
"RegistrationAttachmentId" => [String.t()],
"RegistrationId" => [String.t()],
"SelectChoices" => list(String.t()()),
"TextValue" => String.t(),
"VersionNumber" => float()
}
"""
@type delete_registration_field_value_result() :: %{String.t() => any()}
@typedoc """
## Example:
sns_destination() :: %{
"TopicArn" => String.t()
}
"""
@type sns_destination() :: %{String.t() => any()}
@typedoc """
## Example:
verify_destination_number_request() :: %{
required("VerificationCode") => String.t(),
required("VerifiedDestinationNumberId") => String.t()
}
"""
@type verify_destination_number_request() :: %{String.t() => any()}
@typedoc """
## Example:
delete_default_message_type_result() :: %{
"ConfigurationSetArn" => [String.t()],
"ConfigurationSetName" => String.t(),
"MessageType" => String.t()
}
"""
@type delete_default_message_type_result() :: %{String.t() => any()}
@typedoc """
## Example:
delete_protect_configuration_rule_set_number_override_result() :: %{
"Action" => String.t(),
"CreatedTimestamp" => [non_neg_integer()],
"DestinationPhoneNumber" => String.t(),
"ExpirationTimestamp" => [non_neg_integer()],
"IsoCountryCode" => String.t(),
"ProtectConfigurationArn" => String.t(),
"ProtectConfigurationId" => String.t()
}
"""
@type delete_protect_configuration_rule_set_number_override_result() :: %{String.t() => any()}
@typedoc """
## Example:
opt_out_list_information() :: %{
"CreatedTimestamp" => [non_neg_integer()],
"OptOutListArn" => [String.t()],
"OptOutListName" => String.t()
}
"""
@type opt_out_list_information() :: %{String.t() => any()}
@typedoc """
## Example:
send_media_message_request() :: %{
optional("ConfigurationSetName") => String.t(),
optional("Context") => map(),
optional("DryRun") => [boolean()],
optional("MaxPrice") => String.t(),
optional("MediaUrls") => list(String.t()()),
optional("MessageBody") => String.t(),
optional("MessageFeedbackEnabled") => [boolean()],
optional("ProtectConfigurationId") => String.t(),
optional("TimeToLive") => integer(),
required("DestinationPhoneNumber") => String.t(),
required("OriginationIdentity") => String.t()
}
"""
@type send_media_message_request() :: %{String.t() => any()}
@typedoc """
## Example:
delete_protect_configuration_result() :: %{
"AccountDefault" => [boolean()],
"CreatedTimestamp" => [non_neg_integer()],
"DeletionProtectionEnabled" => [boolean()],
"ProtectConfigurationArn" => String.t(),
"ProtectConfigurationId" => String.t()
}
"""
@type delete_protect_configuration_result() :: %{String.t() => any()}
@typedoc """
## Example:
delete_keyword_result() :: %{
"Keyword" => String.t(),
"KeywordAction" => String.t(),
"KeywordMessage" => String.t(),
"OriginationIdentity" => [String.t()],
"OriginationIdentityArn" => [String.t()]
}
"""
@type delete_keyword_result() :: %{String.t() => any()}
@type associate_origination_identity_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| service_quota_exceeded_exception()
| resource_not_found_exception()
| conflict_exception()
@type associate_protect_configuration_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
| conflict_exception()
@type create_configuration_set_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| service_quota_exceeded_exception()
| conflict_exception()
@type create_event_destination_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| service_quota_exceeded_exception()
| resource_not_found_exception()
| conflict_exception()
@type create_opt_out_list_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| service_quota_exceeded_exception()
| conflict_exception()
@type create_pool_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| service_quota_exceeded_exception()
| resource_not_found_exception()
| conflict_exception()
@type create_protect_configuration_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| service_quota_exceeded_exception()
@type create_registration_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| service_quota_exceeded_exception()
| conflict_exception()
@type create_registration_association_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| service_quota_exceeded_exception()
| resource_not_found_exception()
| conflict_exception()
@type create_registration_attachment_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| service_quota_exceeded_exception()
| conflict_exception()
@type create_registration_version_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| service_quota_exceeded_exception()
| resource_not_found_exception()
| conflict_exception()
@type create_verified_destination_number_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| service_quota_exceeded_exception()
| conflict_exception()
@type delete_account_default_protect_configuration_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type delete_configuration_set_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type delete_default_message_type_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type delete_default_sender_id_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type delete_event_destination_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type delete_keyword_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
| conflict_exception()
@type delete_media_message_spend_limit_override_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
@type delete_opt_out_list_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
| conflict_exception()
@type delete_opted_out_number_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
| conflict_exception()
@type delete_pool_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
| conflict_exception()
@type delete_protect_configuration_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
| conflict_exception()
@type delete_protect_configuration_rule_set_number_override_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type delete_registration_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
| conflict_exception()
@type delete_registration_attachment_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
| conflict_exception()
@type delete_registration_field_value_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
| conflict_exception()
@type delete_resource_policy_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type delete_text_message_spend_limit_override_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
@type delete_verified_destination_number_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
| conflict_exception()
@type delete_voice_message_spend_limit_override_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
@type describe_account_attributes_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
@type describe_account_limits_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
@type describe_configuration_sets_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type describe_keywords_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type describe_opt_out_lists_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type describe_opted_out_numbers_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type describe_phone_numbers_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type describe_pools_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type describe_protect_configurations_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type describe_registration_attachments_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type describe_registration_field_definitions_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
@type describe_registration_field_values_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type describe_registration_section_definitions_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
@type describe_registration_type_definitions_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
@type describe_registration_versions_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type describe_registrations_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type describe_sender_ids_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type describe_spend_limits_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
@type describe_verified_destination_numbers_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type disassociate_origination_identity_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
| conflict_exception()
@type disassociate_protect_configuration_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
| conflict_exception()
@type discard_registration_version_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
| conflict_exception()
@type get_protect_configuration_country_rule_set_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type get_resource_policy_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type list_pool_origination_identities_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type list_protect_configuration_rule_set_number_overrides_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type list_registration_associations_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type list_tags_for_resource_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type put_keyword_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| service_quota_exceeded_exception()
| resource_not_found_exception()
| conflict_exception()
@type put_message_feedback_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type put_opted_out_number_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type put_protect_configuration_rule_set_number_override_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| service_quota_exceeded_exception()
| conflict_exception()
@type put_registration_field_value_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
| conflict_exception()
@type put_resource_policy_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type release_phone_number_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
| conflict_exception()
@type release_sender_id_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
| conflict_exception()
@type request_phone_number_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| service_quota_exceeded_exception()
| resource_not_found_exception()
| conflict_exception()
@type request_sender_id_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| service_quota_exceeded_exception()
| conflict_exception()
@type send_destination_number_verification_code_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| service_quota_exceeded_exception()
| resource_not_found_exception()
| conflict_exception()
@type send_media_message_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| service_quota_exceeded_exception()
| resource_not_found_exception()
| conflict_exception()
@type send_text_message_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| service_quota_exceeded_exception()
| resource_not_found_exception()
| conflict_exception()
@type send_voice_message_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| service_quota_exceeded_exception()
| resource_not_found_exception()
| conflict_exception()
@type set_account_default_protect_configuration_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type set_default_message_feedback_enabled_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type set_default_message_type_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type set_default_sender_id_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type set_media_message_spend_limit_override_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
@type set_text_message_spend_limit_override_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
@type set_voice_message_spend_limit_override_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
@type submit_registration_version_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
| conflict_exception()
@type tag_resource_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| service_quota_exceeded_exception()
| resource_not_found_exception()
@type untag_resource_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type update_event_destination_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
| conflict_exception()
@type update_phone_number_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
| conflict_exception()
@type update_pool_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
| conflict_exception()
@type update_protect_configuration_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type update_protect_configuration_country_rule_set_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type update_sender_id_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type verify_destination_number_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
| conflict_exception()
def metadata do
%{
api_version: "2022-03-31",
content_type: "application/x-amz-json-1.0",
credential_scope: nil,
endpoint_prefix: "sms-voice",
global?: false,
hostname: nil,
protocol: "json",
service_id: "Pinpoint SMS Voice V2",
signature_version: "v4",
signing_name: "sms-voice",
target_prefix: "PinpointSMSVoiceV2"
}
end
@doc """
Associates the specified origination identity with a pool.
If the origination identity is a phone number and is already associated with
another
pool, an error is returned. A sender ID can be associated with multiple pools.
If the origination identity configuration doesn't match the pool's
configuration, an
error is returned.
"""
@spec associate_origination_identity(map(), associate_origination_identity_request(), list()) ::
{:ok, associate_origination_identity_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, associate_origination_identity_errors()}
def associate_origination_identity(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "AssociateOriginationIdentity", input, options)
end
@doc """
Associate a protect configuration with a configuration set.
This replaces the
configuration sets current protect configuration. A configuration set can
only be associated with one protect configuration at a time. A protect
configuration can
be associated with multiple configuration sets.
"""
@spec associate_protect_configuration(map(), associate_protect_configuration_request(), list()) ::
{:ok, associate_protect_configuration_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, associate_protect_configuration_errors()}
def associate_protect_configuration(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "AssociateProtectConfiguration", input, options)
end
@doc """
Creates a new configuration set.
After you create the configuration set, you can add
one or more event destinations to it.
A configuration set is a set of rules that you apply to the SMS and voice
messages
that you send.
When you send a message, you can optionally specify a single configuration set.
"""
@spec create_configuration_set(map(), create_configuration_set_request(), list()) ::
{:ok, create_configuration_set_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, create_configuration_set_errors()}
def create_configuration_set(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "CreateConfigurationSet", input, options)
end
@doc """
Creates a new event destination in a configuration set.
An event destination is a location where you send message events. The event
options
are Amazon CloudWatch, Amazon Data Firehose, or Amazon SNS. For example,
when a message is delivered successfully, you can send information about that
event to
an event destination, or send notifications to endpoints that are subscribed to
an
Amazon SNS topic.
Each configuration set can contain between 0 and 5 event destinations. Each
event
destination can contain a reference to a single destination, such as a
CloudWatch
or Firehose destination.
"""
@spec create_event_destination(map(), create_event_destination_request(), list()) ::
{:ok, create_event_destination_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, create_event_destination_errors()}
def create_event_destination(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "CreateEventDestination", input, options)
end
@doc """
Creates a new opt-out list.
If the opt-out list name already exists, an error is returned.
An opt-out list is a list of phone numbers that are opted out, meaning you can't
send
SMS or voice messages to them. If end user replies with the keyword "STOP," an
entry for
the phone number is added to the opt-out list. In addition to STOP, your
recipients can
use any supported opt-out keyword, such as CANCEL or OPTOUT. For a list of
supported
opt-out keywords, see [
SMS opt out
](https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms-manage.html#channels-sms-manage-optout)
in the *AWS End User Messaging SMS User Guide*.
"""
@spec create_opt_out_list(map(), create_opt_out_list_request(), list()) ::
{:ok, create_opt_out_list_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, create_opt_out_list_errors()}
def create_opt_out_list(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "CreateOptOutList", input, options)
end
@doc """
Creates a new pool and associates the specified origination identity to the
pool.
A
pool can include one or more phone numbers and SenderIds that are associated
with your
Amazon Web Services account.
The new pool inherits its configuration from the specified origination identity.
This
includes keywords, message type, opt-out list, two-way configuration, and
self-managed
opt-out configuration. Deletion protection isn't inherited from the origination
identity
and defaults to false.
If the origination identity is a phone number and is already associated with
another
pool, an error is returned. A sender ID can be associated with multiple pools.
"""
@spec create_pool(map(), create_pool_request(), list()) ::
{:ok, create_pool_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, create_pool_errors()}
def create_pool(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "CreatePool", input, options)
end
@doc """
Create a new protect configuration.
By default all country rule sets for each capability are set to `ALLOW`. Update
the country rule sets using `UpdateProtectConfigurationCountryRuleSet`. A
protect configurations name is stored as a Tag with the key set to `Name` and
value as the name of the protect configuration.
"""
@spec create_protect_configuration(map(), create_protect_configuration_request(), list()) ::
{:ok, create_protect_configuration_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, create_protect_configuration_errors()}
def create_protect_configuration(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "CreateProtectConfiguration", input, options)
end
@doc """
Creates a new registration based on the **RegistrationType** field.
"""
@spec create_registration(map(), create_registration_request(), list()) ::
{:ok, create_registration_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, create_registration_errors()}
def create_registration(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "CreateRegistration", input, options)
end
@doc """
Associate the registration with an origination identity such as a phone number
or sender ID.
"""
@spec create_registration_association(map(), create_registration_association_request(), list()) ::
{:ok, create_registration_association_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, create_registration_association_errors()}
def create_registration_association(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "CreateRegistrationAssociation", input, options)
end
@doc """
Create a new registration attachment to use for uploading a file or a URL to a
file.
The maximum file size is 500KB and valid file extensions are PDF, JPEG and PNG.
For
example, many sender ID registrations require a signed “letter of authorization”
(LOA)
to be submitted.
Use either `AttachmentUrl` or `AttachmentBody` to upload your attachment. If
both are specified then an exception is returned.
"""
@spec create_registration_attachment(map(), create_registration_attachment_request(), list()) ::
{:ok, create_registration_attachment_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, create_registration_attachment_errors()}
def create_registration_attachment(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "CreateRegistrationAttachment", input, options)
end
@doc """
Create a new version of the registration and increase the **VersionNumber**.
The previous version of the registration becomes read-only.
"""
@spec create_registration_version(map(), create_registration_version_request(), list()) ::
{:ok, create_registration_version_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, create_registration_version_errors()}
def create_registration_version(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "CreateRegistrationVersion", input, options)
end
@doc """
You can only send messages to verified destination numbers when your account is
in the sandbox.
You can add up to 10 verified destination
numbers.
"""
@spec create_verified_destination_number(
map(),
create_verified_destination_number_request(),
list()
) ::
{:ok, create_verified_destination_number_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, create_verified_destination_number_errors()}
def create_verified_destination_number(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "CreateVerifiedDestinationNumber", input, options)
end
@doc """
Removes the current account default protect configuration.
"""
@spec delete_account_default_protect_configuration(
map(),
delete_account_default_protect_configuration_request(),
list()
) ::
{:ok, delete_account_default_protect_configuration_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, delete_account_default_protect_configuration_errors()}
def delete_account_default_protect_configuration(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DeleteAccountDefaultProtectConfiguration", input, options)
end
@doc """
Deletes an existing configuration set.
A configuration set is a set of rules that you apply to voice and SMS messages
that
you send. In a configuration set, you can specify a destination for specific
types of
events related to voice and SMS messages.
"""
@spec delete_configuration_set(map(), delete_configuration_set_request(), list()) ::
{:ok, delete_configuration_set_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, delete_configuration_set_errors()}
def delete_configuration_set(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DeleteConfigurationSet", input, options)
end
@doc """
Deletes an existing default message type on a configuration set.
A message type is a type of messages that you plan to send. If you send
account-related messages or time-sensitive messages such as one-time passcodes,
choose
**Transactional**. If you plan to send messages that
contain marketing material or other promotional content, choose **Promotional**.
This setting applies to your entire Amazon Web Services
account.
"""
@spec delete_default_message_type(map(), delete_default_message_type_request(), list()) ::
{:ok, delete_default_message_type_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, delete_default_message_type_errors()}
def delete_default_message_type(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DeleteDefaultMessageType", input, options)
end
@doc """
Deletes an existing default sender ID on a configuration set.
A default sender ID is the identity that appears on recipients' devices when
they
receive SMS messages. Support for sender ID capabilities varies by country or
region.
"""
@spec delete_default_sender_id(map(), delete_default_sender_id_request(), list()) ::
{:ok, delete_default_sender_id_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, delete_default_sender_id_errors()}
def delete_default_sender_id(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DeleteDefaultSenderId", input, options)
end
@doc """
Deletes an existing event destination.
An event destination is a location where you send response information about the
messages that you send. For example, when a message is delivered successfully,
you can
send information about that event to an Amazon CloudWatch destination, or send
notifications to endpoints that are subscribed to an Amazon SNS topic.
"""
@spec delete_event_destination(map(), delete_event_destination_request(), list()) ::
{:ok, delete_event_destination_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, delete_event_destination_errors()}
def delete_event_destination(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DeleteEventDestination", input, options)
end
@doc """
Deletes an existing keyword from an origination phone number or pool.
A keyword is a word that you can search for on a particular phone number or
pool. It
is also a specific word or phrase that an end user can send to your number to
elicit a
response, such as an informational message or a special offer. When your number
receives
a message that begins with a keyword, AWS End User Messaging SMS and Voice
responds with a customizable
message.
Keywords "HELP" and "STOP" can't be deleted or modified.
"""
@spec delete_keyword(map(), delete_keyword_request(), list()) ::
{:ok, delete_keyword_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, delete_keyword_errors()}
def delete_keyword(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DeleteKeyword", input, options)
end
@doc """
Deletes an account-level monthly spending limit override for sending multimedia
messages (MMS).
Deleting a spend limit override will set the `EnforcedLimit` to equal the
`MaxLimit`, which is controlled by Amazon Web Services. For more
information on spend limits (quotas) see [Quotas for Server Migration Service](https://docs.aws.amazon.com/sms-voice/latest/userguide/quotas.html)
in the *Server Migration Service User Guide*.
"""
@spec delete_media_message_spend_limit_override(
map(),
delete_media_message_spend_limit_override_request(),
list()
) ::
{:ok, delete_media_message_spend_limit_override_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, delete_media_message_spend_limit_override_errors()}
def delete_media_message_spend_limit_override(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DeleteMediaMessageSpendLimitOverride", input, options)
end
@doc """
Deletes an existing opt-out list.
All opted out phone numbers in the opt-out list are
deleted.
If the specified opt-out list name doesn't exist or is in-use by an origination
phone
number or pool, an error is returned.
"""
@spec delete_opt_out_list(map(), delete_opt_out_list_request(), list()) ::
{:ok, delete_opt_out_list_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, delete_opt_out_list_errors()}
def delete_opt_out_list(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DeleteOptOutList", input, options)
end
@doc """
Deletes an existing opted out destination phone number from the specified
opt-out
list.
Each destination phone number can only be deleted once every 30 days.
If the specified destination phone number doesn't exist or if the opt-out list
doesn't
exist, an error is returned.
"""
@spec delete_opted_out_number(map(), delete_opted_out_number_request(), list()) ::
{:ok, delete_opted_out_number_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, delete_opted_out_number_errors()}
def delete_opted_out_number(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DeleteOptedOutNumber", input, options)
end
@doc """
Deletes an existing pool.
Deleting a pool disassociates all origination identities
from that pool.
If the pool status isn't active or if deletion protection is enabled, an error
is
returned.
A pool is a collection of phone numbers and SenderIds. A pool can include one or
more
phone numbers and SenderIds that are associated with your Amazon Web Services
account.
"""
@spec delete_pool(map(), delete_pool_request(), list()) ::
{:ok, delete_pool_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, delete_pool_errors()}
def delete_pool(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DeletePool", input, options)
end
@doc """
Permanently delete the protect configuration.
The protect configuration must have deletion protection disabled and must not be
associated as the account default protect configuration or associated with a
configuration set.
"""
@spec delete_protect_configuration(map(), delete_protect_configuration_request(), list()) ::
{:ok, delete_protect_configuration_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, delete_protect_configuration_errors()}
def delete_protect_configuration(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DeleteProtectConfiguration", input, options)
end
@doc """
Permanently delete the protect configuration rule set number override.
"""
@spec delete_protect_configuration_rule_set_number_override(
map(),
delete_protect_configuration_rule_set_number_override_request(),
list()
) ::
{:ok, delete_protect_configuration_rule_set_number_override_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, delete_protect_configuration_rule_set_number_override_errors()}
def delete_protect_configuration_rule_set_number_override(
%Client{} = client,
input,
options \\ []
) do
meta = metadata()
Request.request_post(
client,
meta,
"DeleteProtectConfigurationRuleSetNumberOverride",
input,
options
)
end
@doc """
Permanently delete an existing registration from your account.
"""
@spec delete_registration(map(), delete_registration_request(), list()) ::
{:ok, delete_registration_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, delete_registration_errors()}
def delete_registration(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DeleteRegistration", input, options)
end
@doc """
Permanently delete the specified registration attachment.
"""
@spec delete_registration_attachment(map(), delete_registration_attachment_request(), list()) ::
{:ok, delete_registration_attachment_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, delete_registration_attachment_errors()}
def delete_registration_attachment(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DeleteRegistrationAttachment", input, options)
end
@doc """
Delete the value in a registration form field.
"""
@spec delete_registration_field_value(map(), delete_registration_field_value_request(), list()) ::
{:ok, delete_registration_field_value_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, delete_registration_field_value_errors()}
def delete_registration_field_value(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DeleteRegistrationFieldValue", input, options)
end
@doc """
Deletes the resource-based policy document attached to the AWS End User
Messaging SMS and Voice resource.
A shared resource can be a Pool, Opt-out list, Sender Id, or Phone number.
"""
@spec delete_resource_policy(map(), delete_resource_policy_request(), list()) ::
{:ok, delete_resource_policy_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, delete_resource_policy_errors()}
def delete_resource_policy(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DeleteResourcePolicy", input, options)
end
@doc """
Deletes an account-level monthly spending limit override for sending text
messages.
Deleting a spend limit override will set the `EnforcedLimit` to equal the
`MaxLimit`, which is controlled by Amazon Web Services. For more
information on spend limits (quotas) see [Quotas
](https://docs.aws.amazon.com/sms-voice/latest/userguide/quotas.html)
in the *AWS End User Messaging SMS User Guide*.
"""
@spec delete_text_message_spend_limit_override(
map(),
delete_text_message_spend_limit_override_request(),
list()
) ::
{:ok, delete_text_message_spend_limit_override_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, delete_text_message_spend_limit_override_errors()}
def delete_text_message_spend_limit_override(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DeleteTextMessageSpendLimitOverride", input, options)
end
@doc """
Delete a verified destination phone number.
"""
@spec delete_verified_destination_number(
map(),
delete_verified_destination_number_request(),
list()
) ::
{:ok, delete_verified_destination_number_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, delete_verified_destination_number_errors()}
def delete_verified_destination_number(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DeleteVerifiedDestinationNumber", input, options)
end
@doc """
Deletes an account level monthly spend limit override for sending voice
messages.
Deleting a spend limit override sets the `EnforcedLimit` equal to the
`MaxLimit`, which is controlled by Amazon Web Services. For more
information on spending limits (quotas) see [Quotas
](https://docs.aws.amazon.com/sms-voice/latest/userguide/quotas.html)
in the *AWS End User Messaging SMS User Guide*.
"""
@spec delete_voice_message_spend_limit_override(
map(),
delete_voice_message_spend_limit_override_request(),
list()
) ::
{:ok, delete_voice_message_spend_limit_override_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, delete_voice_message_spend_limit_override_errors()}
def delete_voice_message_spend_limit_override(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DeleteVoiceMessageSpendLimitOverride", input, options)
end
@doc """
Describes attributes of your Amazon Web Services account.
The supported account
attributes include account tier, which indicates whether your account is in the
sandbox
or production environment. When you're ready to move your account out of the
sandbox,
create an Amazon Web Services Support case for a service limit increase request.
New accounts are placed into an SMS or voice sandbox. The sandbox
protects both Amazon Web Services end recipients and SMS or voice recipients
from fraud
and abuse.
"""
@spec describe_account_attributes(map(), describe_account_attributes_request(), list()) ::
{:ok, describe_account_attributes_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, describe_account_attributes_errors()}
def describe_account_attributes(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DescribeAccountAttributes", input, options)
end
@doc """
Describes the current AWS End User Messaging SMS and Voice SMS Voice V2 resource
quotas for your
account.
The description for a quota includes the quota name, current usage toward that
quota, and the quota's maximum value.
When you establish an Amazon Web Services account, the account has initial
quotas on
the maximum number of configuration sets, opt-out lists, phone numbers, and
pools that
you can create in a given Region. For more information see [Quotas
](https://docs.aws.amazon.com/sms-voice/latest/userguide/quotas.html)
in the *AWS End User Messaging SMS User Guide*.
"""
@spec describe_account_limits(map(), describe_account_limits_request(), list()) ::
{:ok, describe_account_limits_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, describe_account_limits_errors()}
def describe_account_limits(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DescribeAccountLimits", input, options)
end
@doc """
Describes the specified configuration sets or all in your account.
If you specify configuration set names, the output includes information for only
the
specified configuration sets. If you specify filters, the output includes
information
for only those configuration sets that meet the filter criteria. If you don't
specify
configuration set names or filters, the output includes information for all
configuration sets.
If you specify a configuration set name that isn't valid, an error is returned.
"""
@spec describe_configuration_sets(map(), describe_configuration_sets_request(), list()) ::
{:ok, describe_configuration_sets_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, describe_configuration_sets_errors()}
def describe_configuration_sets(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DescribeConfigurationSets", input, options)
end
@doc """
Describes the specified keywords or all keywords on your origination phone
number or
pool.
A keyword is a word that you can search for on a particular phone number or
pool. It
is also a specific word or phrase that an end user can send to your number to
elicit a
response, such as an informational message or a special offer. When your number
receives
a message that begins with a keyword, AWS End User Messaging SMS and Voice
responds with a customizable
message.
If you specify a keyword that isn't valid, an error is returned.
"""
@spec describe_keywords(map(), describe_keywords_request(), list()) ::
{:ok, describe_keywords_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, describe_keywords_errors()}
def describe_keywords(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DescribeKeywords", input, options)
end
@doc """
Describes the specified opt-out list or all opt-out lists in your account.
If you specify opt-out list names, the output includes information for only the
specified opt-out lists. Opt-out lists include only those that meet the filter
criteria.
If you don't specify opt-out list names or filters, the output includes
information for
all opt-out lists.
If you specify an opt-out list name that isn't valid, an error is returned.
"""
@spec describe_opt_out_lists(map(), describe_opt_out_lists_request(), list()) ::
{:ok, describe_opt_out_lists_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, describe_opt_out_lists_errors()}
def describe_opt_out_lists(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DescribeOptOutLists", input, options)
end
@doc """
Describes the specified opted out destination numbers or all opted out
destination
numbers in an opt-out list.
If you specify opted out numbers, the output includes information for only the
specified opted out numbers. If you specify filters, the output includes
information for
only those opted out numbers that meet the filter criteria. If you don't specify
opted
out numbers or filters, the output includes information for all opted out
destination
numbers in your opt-out list.
If you specify an opted out number that isn't valid, an exception is returned.
"""
@spec describe_opted_out_numbers(map(), describe_opted_out_numbers_request(), list()) ::
{:ok, describe_opted_out_numbers_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, describe_opted_out_numbers_errors()}
def describe_opted_out_numbers(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DescribeOptedOutNumbers", input, options)
end
@doc """
Describes the specified origination phone number, or all the phone numbers in
your
account.
If you specify phone number IDs, the output includes information for only the
specified phone numbers. If you specify filters, the output includes information
for
only those phone numbers that meet the filter criteria. If you don't specify
phone
number IDs or filters, the output includes information for all phone numbers.
If you specify a phone number ID that isn't valid, an error is returned.
"""
@spec describe_phone_numbers(map(), describe_phone_numbers_request(), list()) ::
{:ok, describe_phone_numbers_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, describe_phone_numbers_errors()}
def describe_phone_numbers(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DescribePhoneNumbers", input, options)
end
@doc """
Retrieves the specified pools or all pools associated with your Amazon Web
Services
account.
If you specify pool IDs, the output includes information for only the specified
pools.
If you specify filters, the output includes information for only those pools
that meet
the filter criteria. If you don't specify pool IDs or filters, the output
includes
information for all pools.
If you specify a pool ID that isn't valid, an error is returned.
A pool is a collection of phone numbers and SenderIds. A pool can include one or
more
phone numbers and SenderIds that are associated with your Amazon Web Services
account.
"""
@spec describe_pools(map(), describe_pools_request(), list()) ::
{:ok, describe_pools_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, describe_pools_errors()}
def describe_pools(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DescribePools", input, options)
end
@doc """
Retrieves the protect configurations that match any of filters.
If a filter isn’t provided then all protect configurations are returned.
"""
@spec describe_protect_configurations(map(), describe_protect_configurations_request(), list()) ::
{:ok, describe_protect_configurations_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, describe_protect_configurations_errors()}
def describe_protect_configurations(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DescribeProtectConfigurations", input, options)
end
@doc """
Retrieves the specified registration attachments or all registration attachments
associated with your Amazon Web Services account.
"""
@spec describe_registration_attachments(
map(),
describe_registration_attachments_request(),
list()
) ::
{:ok, describe_registration_attachments_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, describe_registration_attachments_errors()}
def describe_registration_attachments(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DescribeRegistrationAttachments", input, options)
end
@doc """
Retrieves the specified registration type field definitions.
You can use DescribeRegistrationFieldDefinitions to view the requirements for
creating, filling out, and submitting each registration type.
"""
@spec describe_registration_field_definitions(
map(),
describe_registration_field_definitions_request(),
list()
) ::
{:ok, describe_registration_field_definitions_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, describe_registration_field_definitions_errors()}
def describe_registration_field_definitions(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DescribeRegistrationFieldDefinitions", input, options)
end
@doc """
Retrieves the specified registration field values.
"""
@spec describe_registration_field_values(
map(),
describe_registration_field_values_request(),
list()
) ::
{:ok, describe_registration_field_values_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, describe_registration_field_values_errors()}
def describe_registration_field_values(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DescribeRegistrationFieldValues", input, options)
end
@doc """
Retrieves the specified registration section definitions.
You can use DescribeRegistrationSectionDefinitions to view the requirements for
creating, filling out, and submitting each registration type.
"""
@spec describe_registration_section_definitions(
map(),
describe_registration_section_definitions_request(),
list()
) ::
{:ok, describe_registration_section_definitions_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, describe_registration_section_definitions_errors()}
def describe_registration_section_definitions(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DescribeRegistrationSectionDefinitions", input, options)
end
@doc """
Retrieves the specified registration type definitions.
You can use DescribeRegistrationTypeDefinitions to view the requirements for
creating, filling out, and submitting each registration type.
"""
@spec describe_registration_type_definitions(
map(),
describe_registration_type_definitions_request(),
list()
) ::
{:ok, describe_registration_type_definitions_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, describe_registration_type_definitions_errors()}
def describe_registration_type_definitions(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DescribeRegistrationTypeDefinitions", input, options)
end
@doc """
Retrieves the specified registration version.
"""
@spec describe_registration_versions(map(), describe_registration_versions_request(), list()) ::
{:ok, describe_registration_versions_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, describe_registration_versions_errors()}
def describe_registration_versions(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DescribeRegistrationVersions", input, options)
end
@doc """
Retrieves the specified registrations.
"""
@spec describe_registrations(map(), describe_registrations_request(), list()) ::
{:ok, describe_registrations_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, describe_registrations_errors()}
def describe_registrations(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DescribeRegistrations", input, options)
end
@doc """
Describes the specified SenderIds or all SenderIds associated with your Amazon
Web Services account.
If you specify SenderIds, the output includes information for only the specified
SenderIds. If you specify filters, the output includes information for only
those
SenderIds that meet the filter criteria. If you don't specify SenderIds or
filters, the
output includes information for all SenderIds.
f you specify a sender ID that isn't valid, an error is returned.
"""
@spec describe_sender_ids(map(), describe_sender_ids_request(), list()) ::
{:ok, describe_sender_ids_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, describe_sender_ids_errors()}
def describe_sender_ids(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DescribeSenderIds", input, options)
end
@doc """
Describes the current monthly spend limits for sending voice and
text messages.
When you establish an Amazon Web Services account, the account has initial
monthly
spend limit in a given Region. For more information on increasing your monthly
spend
limit, see [
Requesting increases to your monthly SMS, MMS, or Voice spending quota
](https://docs.aws.amazon.com/sms-voice/latest/userguide/awssupport-spend-threshold.html)
in the *AWS End User Messaging SMS User Guide*.
"""
@spec describe_spend_limits(map(), describe_spend_limits_request(), list()) ::
{:ok, describe_spend_limits_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, describe_spend_limits_errors()}
def describe_spend_limits(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DescribeSpendLimits", input, options)
end
@doc """
Retrieves the specified verified destination numbers.
"""
@spec describe_verified_destination_numbers(
map(),
describe_verified_destination_numbers_request(),
list()
) ::
{:ok, describe_verified_destination_numbers_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, describe_verified_destination_numbers_errors()}
def describe_verified_destination_numbers(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DescribeVerifiedDestinationNumbers", input, options)
end
@doc """
Removes the specified origination identity from an existing pool.
If the origination identity isn't associated with the specified pool, an error
is
returned.
"""
@spec disassociate_origination_identity(
map(),
disassociate_origination_identity_request(),
list()
) ::
{:ok, disassociate_origination_identity_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, disassociate_origination_identity_errors()}
def disassociate_origination_identity(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DisassociateOriginationIdentity", input, options)
end
@doc """
Disassociate a protect configuration from a configuration set.
"""
@spec disassociate_protect_configuration(
map(),
disassociate_protect_configuration_request(),
list()
) ::
{:ok, disassociate_protect_configuration_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, disassociate_protect_configuration_errors()}
def disassociate_protect_configuration(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DisassociateProtectConfiguration", input, options)
end
@doc """
Discard the current version of the registration.
"""
@spec discard_registration_version(map(), discard_registration_version_request(), list()) ::
{:ok, discard_registration_version_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, discard_registration_version_errors()}
def discard_registration_version(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DiscardRegistrationVersion", input, options)
end
@doc """
Retrieve the CountryRuleSet for the specified NumberCapability from a protect
configuration.
"""
@spec get_protect_configuration_country_rule_set(
map(),
get_protect_configuration_country_rule_set_request(),
list()
) ::
{:ok, get_protect_configuration_country_rule_set_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, get_protect_configuration_country_rule_set_errors()}
def get_protect_configuration_country_rule_set(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "GetProtectConfigurationCountryRuleSet", input, options)
end
@doc """
Retrieves the JSON text of the resource-based policy document attached to the
AWS End User Messaging SMS and Voice resource.
A shared resource can be a Pool, Opt-out list, Sender Id, or Phone number.
"""
@spec get_resource_policy(map(), get_resource_policy_request(), list()) ::
{:ok, get_resource_policy_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, get_resource_policy_errors()}
def get_resource_policy(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "GetResourcePolicy", input, options)
end
@doc """
Lists all associated origination identities in your pool.
If you specify filters, the output includes information for only those
origination
identities that meet the filter criteria.
"""
@spec list_pool_origination_identities(
map(),
list_pool_origination_identities_request(),
list()
) ::
{:ok, list_pool_origination_identities_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, list_pool_origination_identities_errors()}
def list_pool_origination_identities(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "ListPoolOriginationIdentities", input, options)
end
@doc """
Retrieve all of the protect configuration rule set number overrides that match
the filters.
"""
@spec list_protect_configuration_rule_set_number_overrides(
map(),
list_protect_configuration_rule_set_number_overrides_request(),
list()
) ::
{:ok, list_protect_configuration_rule_set_number_overrides_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, list_protect_configuration_rule_set_number_overrides_errors()}
def list_protect_configuration_rule_set_number_overrides(
%Client{} = client,
input,
options \\ []
) do
meta = metadata()
Request.request_post(
client,
meta,
"ListProtectConfigurationRuleSetNumberOverrides",
input,
options
)
end
@doc """
Retrieve all of the origination identities that are associated with a
registration.
"""
@spec list_registration_associations(map(), list_registration_associations_request(), list()) ::
{:ok, list_registration_associations_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, list_registration_associations_errors()}
def list_registration_associations(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "ListRegistrationAssociations", input, options)
end
@doc """
List all tags associated with a resource.
"""
@spec list_tags_for_resource(map(), list_tags_for_resource_request(), list()) ::
{:ok, list_tags_for_resource_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, list_tags_for_resource_errors()}
def list_tags_for_resource(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "ListTagsForResource", input, options)
end
@doc """
Creates or updates a keyword configuration on an origination phone number or
pool.
A keyword is a word that you can search for on a particular phone number or
pool. It
is also a specific word or phrase that an end user can send to your number to
elicit a
response, such as an informational message or a special offer. When your number
receives
a message that begins with a keyword, AWS End User Messaging SMS and Voice
responds with a customizable
message.
If you specify a keyword that isn't valid, an error is returned.
"""
@spec put_keyword(map(), put_keyword_request(), list()) ::
{:ok, put_keyword_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, put_keyword_errors()}
def put_keyword(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "PutKeyword", input, options)
end
@doc """
Set the MessageFeedbackStatus as `RECEIVED` or `FAILED` for the
passed in MessageId.
If you use message feedback then you must update message feedback record. When
you receive a signal that a user has received the message you must use
`PutMessageFeedback` to set the message feedback record as
`RECEIVED`; Otherwise, an hour after the message feedback record is set
to `FAILED`.
"""
@spec put_message_feedback(map(), put_message_feedback_request(), list()) ::
{:ok, put_message_feedback_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, put_message_feedback_errors()}
def put_message_feedback(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "PutMessageFeedback", input, options)
end
@doc """
Creates an opted out destination phone number in the opt-out list.
If the destination phone number isn't valid or if the specified opt-out list
doesn't
exist, an error is returned.
"""
@spec put_opted_out_number(map(), put_opted_out_number_request(), list()) ::
{:ok, put_opted_out_number_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, put_opted_out_number_errors()}
def put_opted_out_number(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "PutOptedOutNumber", input, options)
end
@doc """
Create or update a RuleSetNumberOverride and associate it with a protect
configuration.
"""
@spec put_protect_configuration_rule_set_number_override(
map(),
put_protect_configuration_rule_set_number_override_request(),
list()
) ::
{:ok, put_protect_configuration_rule_set_number_override_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, put_protect_configuration_rule_set_number_override_errors()}
def put_protect_configuration_rule_set_number_override(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(
client,
meta,
"PutProtectConfigurationRuleSetNumberOverride",
input,
options
)
end
@doc """
Creates or updates a field value for a registration.
"""
@spec put_registration_field_value(map(), put_registration_field_value_request(), list()) ::
{:ok, put_registration_field_value_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, put_registration_field_value_errors()}
def put_registration_field_value(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "PutRegistrationFieldValue", input, options)
end
@doc """
Attaches a resource-based policy to a AWS End User Messaging SMS and Voice
resource(phone number, sender Id, phone poll, or opt-out list) that is used for
sharing the resource.
A shared resource can be a Pool, Opt-out list, Sender Id, or Phone number. For
more information about
resource-based policies, see [Working with shared resources](https://docs.aws.amazon.com/sms-voice/latest/userguide/shared-resources.html)
in the *AWS End User Messaging SMS User Guide*.
"""
@spec put_resource_policy(map(), put_resource_policy_request(), list()) ::
{:ok, put_resource_policy_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, put_resource_policy_errors()}
def put_resource_policy(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "PutResourcePolicy", input, options)
end
@doc """
Releases an existing origination phone number in your account.
Once released, a phone
number is no longer available for sending messages.
If the origination phone number has deletion protection enabled or is associated
with
a pool, an error is returned.
"""
@spec release_phone_number(map(), release_phone_number_request(), list()) ::
{:ok, release_phone_number_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, release_phone_number_errors()}
def release_phone_number(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "ReleasePhoneNumber", input, options)
end
@doc """
Releases an existing sender ID in your account.
"""
@spec release_sender_id(map(), release_sender_id_request(), list()) ::
{:ok, release_sender_id_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, release_sender_id_errors()}
def release_sender_id(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "ReleaseSenderId", input, options)
end
@doc """
Request an origination phone number for use in your account.
For more information on
phone number request see [Request a phone number](https://docs.aws.amazon.com/sms-voice/latest/userguide/phone-numbers-request.html)
in the *AWS End User Messaging SMS User Guide*.
"""
@spec request_phone_number(map(), request_phone_number_request(), list()) ::
{:ok, request_phone_number_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, request_phone_number_errors()}
def request_phone_number(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "RequestPhoneNumber", input, options)
end
@doc """
Request a new sender ID that doesn't require registration.
"""
@spec request_sender_id(map(), request_sender_id_request(), list()) ::
{:ok, request_sender_id_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, request_sender_id_errors()}
def request_sender_id(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "RequestSenderId", input, options)
end
@doc """
Before you can send test messages to a verified destination phone number you
need to
opt-in the verified destination phone number.
Creates a new text message with a
verification code and send it to a verified destination phone number. Once you
have the verification code use `VerifyDestinationNumber` to opt-in the verified
destination phone number to receive messages.
"""
@spec send_destination_number_verification_code(
map(),
send_destination_number_verification_code_request(),
list()
) ::
{:ok, send_destination_number_verification_code_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, send_destination_number_verification_code_errors()}
def send_destination_number_verification_code(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "SendDestinationNumberVerificationCode", input, options)
end
@doc """
Creates a new multimedia message (MMS) and sends it to a recipient's phone
number.
"""
@spec send_media_message(map(), send_media_message_request(), list()) ::
{:ok, send_media_message_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, send_media_message_errors()}
def send_media_message(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "SendMediaMessage", input, options)
end
@doc """
Creates a new text message and sends it to a recipient's phone number.
SendTextMessage only sends an SMS message to one recipient each time it is
invoked.
SMS throughput limits are measured in Message Parts per Second (MPS). Your MPS
limit
depends on the destination country of your messages, as well as the type of
phone number
(origination number) that you use to send the message. For more information
about MPS, see [Message Parts per Second (MPS)
limits](https://docs.aws.amazon.com/sms-voice/latest/userguide/sms-limitations-mps.html)
in the *AWS End User Messaging SMS User Guide*.
"""
@spec send_text_message(map(), send_text_message_request(), list()) ::
{:ok, send_text_message_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, send_text_message_errors()}
def send_text_message(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "SendTextMessage", input, options)
end
@doc """
Allows you to send a request that sends a voice message.
This operation uses [Amazon Polly](http://aws.amazon.com/polly/) to
convert a text script into a voice message.
"""
@spec send_voice_message(map(), send_voice_message_request(), list()) ::
{:ok, send_voice_message_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, send_voice_message_errors()}
def send_voice_message(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "SendVoiceMessage", input, options)
end
@doc """
Set a protect configuration as your account default.
You can only have one account
default protect configuration at a time. The current account default protect
configuration is replaced with the provided protect configuration.
"""
@spec set_account_default_protect_configuration(
map(),
set_account_default_protect_configuration_request(),
list()
) ::
{:ok, set_account_default_protect_configuration_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, set_account_default_protect_configuration_errors()}
def set_account_default_protect_configuration(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "SetAccountDefaultProtectConfiguration", input, options)
end
@doc """
Sets a configuration set's default for message feedback.
"""
@spec set_default_message_feedback_enabled(
map(),
set_default_message_feedback_enabled_request(),
list()
) ::
{:ok, set_default_message_feedback_enabled_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, set_default_message_feedback_enabled_errors()}
def set_default_message_feedback_enabled(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "SetDefaultMessageFeedbackEnabled", input, options)
end
@doc """
Sets the default message type on a configuration set.
Choose the category of SMS messages that you plan to send from this account. If
you
send account-related messages or time-sensitive messages such as one-time
passcodes,
choose **Transactional**. If you plan to send messages that
contain marketing material or other promotional content, choose **Promotional**.
This setting applies to your entire Amazon Web Services
account.
"""
@spec set_default_message_type(map(), set_default_message_type_request(), list()) ::
{:ok, set_default_message_type_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, set_default_message_type_errors()}
def set_default_message_type(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "SetDefaultMessageType", input, options)
end
@doc """
Sets default sender ID on a configuration set.
When sending a text message to a destination country that supports sender IDs,
the
default sender ID on the configuration set specified will be used if no
dedicated
origination phone numbers or registered sender IDs are available in your
account.
"""
@spec set_default_sender_id(map(), set_default_sender_id_request(), list()) ::
{:ok, set_default_sender_id_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, set_default_sender_id_errors()}
def set_default_sender_id(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "SetDefaultSenderId", input, options)
end
@doc """
Sets an account level monthly spend limit override for sending MMS messages.
The
requested spend limit must be less than or equal to the `MaxLimit`, which is
set by Amazon Web Services.
"""
@spec set_media_message_spend_limit_override(
map(),
set_media_message_spend_limit_override_request(),
list()
) ::
{:ok, set_media_message_spend_limit_override_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, set_media_message_spend_limit_override_errors()}
def set_media_message_spend_limit_override(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "SetMediaMessageSpendLimitOverride", input, options)
end
@doc """
Sets an account level monthly spend limit override for sending text messages.
The
requested spend limit must be less than or equal to the `MaxLimit`, which is
set by Amazon Web Services.
"""
@spec set_text_message_spend_limit_override(
map(),
set_text_message_spend_limit_override_request(),
list()
) ::
{:ok, set_text_message_spend_limit_override_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, set_text_message_spend_limit_override_errors()}
def set_text_message_spend_limit_override(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "SetTextMessageSpendLimitOverride", input, options)
end
@doc """
Sets an account level monthly spend limit override for sending voice messages.
The
requested spend limit must be less than or equal to the `MaxLimit`, which is
set by Amazon Web Services.
"""
@spec set_voice_message_spend_limit_override(
map(),
set_voice_message_spend_limit_override_request(),
list()
) ::
{:ok, set_voice_message_spend_limit_override_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, set_voice_message_spend_limit_override_errors()}
def set_voice_message_spend_limit_override(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "SetVoiceMessageSpendLimitOverride", input, options)
end
@doc """
Submit the specified registration for review and approval.
"""
@spec submit_registration_version(map(), submit_registration_version_request(), list()) ::
{:ok, submit_registration_version_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, submit_registration_version_errors()}
def submit_registration_version(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "SubmitRegistrationVersion", input, options)
end
@doc """
Adds or overwrites only the specified tags for the specified resource.
When you specify an existing tag key, the value is
overwritten with the new value. Each resource can have a maximum of 50 tags.
Each tag
consists of a key and an optional value. Tag keys must be unique per resource.
For more
information about tags, see [Tags
](https://docs.aws.amazon.com/sms-voice/latest/userguide/phone-numbers-tags.html)
in the *AWS End User Messaging SMS User Guide*.
"""
@spec tag_resource(map(), tag_resource_request(), list()) ::
{:ok, tag_resource_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, tag_resource_errors()}
def tag_resource(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "TagResource", input, options)
end
@doc """
Removes the association of the specified tags from a
resource.
For more information on tags see [Tags
](https://docs.aws.amazon.com/sms-voice/latest/userguide/phone-numbers-tags.html)
in the *AWS End User Messaging SMS User Guide*.
"""
@spec untag_resource(map(), untag_resource_request(), list()) ::
{:ok, untag_resource_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, untag_resource_errors()}
def untag_resource(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "UntagResource", input, options)
end
@doc """
Updates an existing event destination in a configuration set.
You can update the
IAM role ARN for CloudWatch Logs and Firehose. You can
also enable or disable the event destination.
You may want to update an event destination to change its matching event types
or
updating the destination resource ARN. You can't change an event destination's
type
between CloudWatch Logs, Firehose, and Amazon SNS.
"""
@spec update_event_destination(map(), update_event_destination_request(), list()) ::
{:ok, update_event_destination_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, update_event_destination_errors()}
def update_event_destination(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "UpdateEventDestination", input, options)
end
@doc """
Updates the configuration of an existing origination phone number.
You can update the
opt-out list, enable or disable two-way messaging, change the TwoWayChannelArn,
enable
or disable self-managed opt-outs, and enable or disable deletion protection.
If the origination phone number is associated with a pool, an error is
returned.
"""
@spec update_phone_number(map(), update_phone_number_request(), list()) ::
{:ok, update_phone_number_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, update_phone_number_errors()}
def update_phone_number(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "UpdatePhoneNumber", input, options)
end
@doc """
Updates the configuration of an existing pool.
You can update the opt-out list, enable
or disable two-way messaging, change the `TwoWayChannelArn`, enable or
disable self-managed opt-outs, enable or disable deletion protection, and enable
or
disable shared routes.
"""
@spec update_pool(map(), update_pool_request(), list()) ::
{:ok, update_pool_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, update_pool_errors()}
def update_pool(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "UpdatePool", input, options)
end
@doc """
Update the setting for an existing protect configuration.
"""
@spec update_protect_configuration(map(), update_protect_configuration_request(), list()) ::
{:ok, update_protect_configuration_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, update_protect_configuration_errors()}
def update_protect_configuration(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "UpdateProtectConfiguration", input, options)
end
@doc """
Update a country rule set to `ALLOW` or `BLOCK` messages to be sent to the
specified destination counties.
You can update one or multiple countries at a time. The updates are only applied
to the specified NumberCapability type.
"""
@spec update_protect_configuration_country_rule_set(
map(),
update_protect_configuration_country_rule_set_request(),
list()
) ::
{:ok, update_protect_configuration_country_rule_set_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, update_protect_configuration_country_rule_set_errors()}
def update_protect_configuration_country_rule_set(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "UpdateProtectConfigurationCountryRuleSet", input, options)
end
@doc """
Updates the configuration of an existing sender ID.
"""
@spec update_sender_id(map(), update_sender_id_request(), list()) ::
{:ok, update_sender_id_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, update_sender_id_errors()}
def update_sender_id(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "UpdateSenderId", input, options)
end
@doc """
Use the verification code that was received by the verified destination phone
number to opt-in the verified destination phone number to receive more messages.
"""
@spec verify_destination_number(map(), verify_destination_number_request(), list()) ::
{:ok, verify_destination_number_result(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, verify_destination_number_errors()}
def verify_destination_number(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "VerifyDestinationNumber", input, options)
end
end
