Smaws_Client_PinpointSMSVoiceV2.Typestype nonrec voice_id = | AMY| ASTRID| BIANCA| BRIAN| CAMILA| CARLA| CARMEN| CELINE| CHANTAL| CONCHITA| CRISTIANO| DORA| EMMA| ENRIQUE| EWA| FILIZ| GERAINT| GIORGIO| GWYNETH| HANS| INES| IVY| JACEK| JAN| JOANNA| JOEY| JUSTIN| KARL| KENDRA| KIMBERLY| LEA| LIV| LOTTE| LUCIA| LUPE| MADS| MAJA| MARLENE| MATHIEU| MATTHEW| MAXIM| MIA| MIGUEL| MIZUKI| NAJA| NICOLE| PENELOPE| RAVEENA| RICARDO| RUBEN| RUSSELL| SALLI| SEOYEON| TAKUMI| TATYANA| VICKI| VITORIA| ZEINA| ZHIYUtype nonrec voice_id_list = voice_id listtype nonrec verify_destination_number_result = {created_timestamp : Smaws_Lib.Smithy_api.Types.timestamp;status : verification_status;The status for being able to send messages to the phone number.
*)destination_phone_number : phone_number;The phone number in E.164 format.
*)verified_destination_number_id : Smaws_Lib.Smithy_api.Types.string_;The unique identifier for the verified destination phone number.
*)verified_destination_number_arn : Smaws_Lib.Smithy_api.Types.string_;The Amazon Resource Name (ARN) for the verified destination phone number.
*)}type nonrec verify_destination_number_request = {verification_code : verification_code;The verification code that was received by the verified destination phone number.
*)verified_destination_number_id : verified_destination_number_id_or_arn;The unique identifier for the verififed destination phone number.
*)}type nonrec validation_exception_reason = | CANNOT_ADD_OPTED_OUT_NUMBER| CANNOT_PARSE| CHANNEL_NOT_ENABLED| COUNTRY_CODE_MISMATCH| COUNTRY_NOT_ENABLED| DESTINATION_COUNTRY_BLOCKED| FIELD_VALIDATION_FAILED| ATTACHMENT_TYPE_NOT_SUPPORTED| INTERNATIONAL_SENDING_NOT_SUPPORTED| INVALID_ARN| INVALID_FILTER_VALUES| INVALID_IDENTITY_FOR_DESTINATION_COUNTRY| INVALID_NEXT_TOKEN| INVALID_PARAMETER| INVALID_REQUEST| INVALID_REGISTRATION_ASSOCIATION| MAXIMUM_SIZE_EXCEEDED| MEDIA_TYPE_NOT_SUPPORTED| MISSING_PARAMETER| PARAMETERS_CANNOT_BE_USED_TOGETHER| PHONE_NUMBER_CANNOT_BE_OPTED_IN| PHONE_NUMBER_CANNOT_BE_RELEASED| PRICE_OVER_THRESHOLD| RESOURCE_NOT_ACCESSIBLE| REQUESTED_SPEND_LIMIT_HIGHER_THAN_SERVICE_LIMIT| SENDER_ID_NOT_REGISTERED| SENDER_ID_NOT_SUPPORTED| SENDER_ID_REQUIRES_REGISTRATION| TWO_WAY_TOPIC_NOT_PRESENT| TWO_WAY_NOT_ENABLED| TWO_WAY_NOT_SUPPORTED_IN_COUNTRY| TWO_WAY_NOT_SUPPORTED_IN_REGION| TWO_WAY_CHANNEL_NOT_PRESENT| UNKNOWN_REGISTRATION_FIELD| UNKNOWN_REGISTRATION_SECTION| UNKNOWN_REGISTRATION_TYPE| UNKNOWN_REGISTRATION_VERSION| UNKNOWN_OPERATION| REGISTRATION_FIELD_CANNOT_BE_DELETED| VERIFICATION_CODE_MISMATCH| VOICE_CAPABILITY_NOT_AVAILABLE| UNSPECIFIED_PARAMETER_NOT_SUPPORTED| OTHERtype nonrec validation_exception_field = {message : Smaws_Lib.Smithy_api.Types.string_;The message associated with the validation exception with information to help determine its cause.
*)name : Smaws_Lib.Smithy_api.Types.string_;The name of the field.
*)}The field associated with the validation exception.
type nonrec validation_exception_field_list = validation_exception_field listtype nonrec validation_exception = {fields : validation_exception_field_list option;The field that failed validation.
*)reason : validation_exception_reason option;The reason for the exception.
*)message : Smaws_Lib.Smithy_api.Types.string_ option;}A validation exception for a field.
An error that occurred because too many requests were sent during a certain amount of time.
type nonrec resource_not_found_exception = {resource_id : Smaws_Lib.Smithy_api.Types.string_ option;The unique identifier of the resource.
*)resource_type : resource_type option;The type of resource that caused the exception.
*)message : Smaws_Lib.Smithy_api.Types.string_ option;}A requested resource couldn't be found.
type nonrec internal_server_exception = {request_id : Smaws_Lib.Smithy_api.Types.string_ option;The unique identifier of the request.
*)message : Smaws_Lib.Smithy_api.Types.string_ option;}The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.
type nonrec conflict_exception_reason = | CREATE_REGISTRATION_VERSION_NOT_ALLOWED| DELETION_PROTECTION_ENABLED| DESTINATION_PHONE_NUMBER_NOT_VERIFIED| DESTINATION_PHONE_NUMBER_OPTED_OUT| DISASSOCIATE_REGISTRATION_NOT_ALLOWED| DISCARD_REGISTRATION_VERSION_NOT_ALLOWED| EDIT_REGISTRATION_FIELD_VALUES_NOT_ALLOWED| EVENT_DESTINATION_MISMATCH| KEYWORD_MISMATCH| LAST_PHONE_NUMBER| NUMBER_CAPABILITIES_MISMATCH| MESSAGE_TYPE_MISMATCH| NO_ORIGINATION_IDENTITIES_FOUND| OPT_OUT_LIST_MISMATCH| PHONE_NUMBER_ASSOCIATED_TO_POOL| PHONE_NUMBER_ASSOCIATED_TO_REGISTRATION| PHONE_NUMBER_NOT_ASSOCIATED_TO_POOL| PHONE_NUMBER_NOT_IN_REGISTRATION_REGION| REGISTRATION_ALREADY_SUBMITTED| REGISTRATION_NOT_COMPLETE| RESOURCE_ALREADY_ASSOCIATED| SENDER_ID_ASSOCIATED_TO_POOL| RCS_AGENT_ASSOCIATED_TO_POOL| POOL_ASSOCIATED_TO_NOTIFY_CONFIGURATION| RESOURCE_ALREADY_EXISTS| RESOURCE_DELETION_NOT_ALLOWED| RESOURCE_MODIFICATION_NOT_ALLOWED| RESOURCE_NOT_ACTIVE| RESOURCE_NOT_EMPTY| SELF_MANAGED_OPT_OUTS_MISMATCH| SUBMIT_REGISTRATION_VERSION_NOT_ALLOWED| TWO_WAY_CONFIG_MISMATCH| VERIFICATION_CODE_EXPIRED| VERIFICATION_ALREADY_COMPLETE| PROTECT_CONFIGURATION_IS_ACCOUNT_DEFAULT| PROTECT_CONFIGURATION_ASSOCIATED_WITH_CONFIGURATION_SET| PROTECT_CONFIGURATION_NOT_ASSOCIATED_WITH_CONFIGURATION_SET| DESTINATION_COUNTRY_BLOCKED_BY_PROTECT_CONFIGURATION| DESTINATION_PHONE_NUMBER_BLOCKED_BY_PROTECT_NUMBER_OVERRIDE| RCS_AGENT_ALREADY_ASSOCIATED_TO_REGISTRATION_TYPE| NOTIFY_CONFIGURATION_NOT_ACTIVEtype nonrec conflict_exception = {resource_id : Smaws_Lib.Smithy_api.Types.string_ option;The unique identifier of the request.
*)resource_type : resource_type option;The type of resource that caused the exception.
*)reason : conflict_exception_reason option;The reason for the exception.
*)message : Smaws_Lib.Smithy_api.Types.string_ option;}Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.
type nonrec access_denied_exception = {reason : access_denied_exception_reason option;The reason for the exception.
*)message : Smaws_Lib.Smithy_api.Types.string_ option;}The request was denied because you don't have sufficient permissions to access the resource.
type nonrec verified_destination_number_information = {created_timestamp : Smaws_Lib.Smithy_api.Types.timestamp;rcs_agent_id : Smaws_Lib.Smithy_api.Types.string_ option;The unique identifier of the RCS agent associated with the verified destination number.
*)status : verification_status;The status of the verified destination phone number.
PENDING: The phone number hasn't been verified yet.VERIFIED: The phone number is verified and can receive messages.destination_phone_number : phone_number;The verified destination phone number, in E.164 format.
*)verified_destination_number_id : Smaws_Lib.Smithy_api.Types.string_;The unique identifier for the verified destination phone number.
*)verified_destination_number_arn : Smaws_Lib.Smithy_api.Types.string_;The Amazon Resource Name (ARN) for the verified destination phone number.
*)}Provides information about the requested verified destintion phone number.
type nonrec verified_destination_number_information_list =
verified_destination_number_information listtype nonrec verified_destination_number_id_list =
verified_destination_number_id_or_arn listtype nonrec filter_value_list = filter_value listtype nonrec verified_destination_number_filter = {values : filter_value_list;An array of values to filter on.
*)name : verified_destination_number_filter_name;The name of the attribute to filter on.
*)}The filter definition for filtering verified destination phone numbers that meets a specified criteria.
type nonrec verified_destination_number_filter_list =
verified_destination_number_filter listtype nonrec message_type_list = message_type listtype nonrec update_sender_id_result = {registration_id : Smaws_Lib.Smithy_api.Types.string_ option;The unique identifier for the registration.
*)registered : Smaws_Lib.Smithy_api.Types.primitive_boolean;True if the sender ID is registered..
*)deletion_protection_enabled : Smaws_Lib.Smithy_api.Types.primitive_boolean;By default this is set to false. When set to true the sender ID can't be deleted.
*)monthly_leasing_price : Smaws_Lib.Smithy_api.Types.string_;The monthly price, in US dollars, to lease the sender ID.
*)message_types : message_type_list;The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
*)iso_country_code : iso_country_code;The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
*)sender_id : sender_id;The sender ID that was updated.
*)sender_id_arn : Smaws_Lib.Smithy_api.Types.string_;The Amazon Resource Name (ARN) associated with the SenderId.
*)}type nonrec update_sender_id_request = {deletion_protection_enabled : Smaws_Lib.Smithy_api.Types.boolean_ option;By default this is set to false. When set to true the sender ID can't be deleted.
*)iso_country_code : iso_country_code;The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
*)sender_id : sender_id_or_arn;The sender ID to update.
*)}type nonrec rcs_event_type_list = rcs_event_type listtype nonrec update_rcs_agent_result = {two_way_rcs_events_enabled : rcs_event_type_list option;The list of RCS event types enabled for two-way messaging on the agent.
*)two_way_media_s3_role : iam_role_arn option;The ARN of the IAM role used to write inbound RCS media files to the S3 bucket.
*)two_way_media_s3_key_prefix : two_way_media_s3_key_prefix option;The key prefix used for inbound RCS media objects in the S3 bucket.
*)two_way_media_s3_bucket_name : two_way_media_s3_bucket_name option;The name of the S3 bucket where inbound RCS media files are stored.
*)two_way_enabled : Smaws_Lib.Smithy_api.Types.primitive_boolean;By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
*)two_way_channel_role : iam_role_arn option;An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
*)two_way_channel_arn : two_way_channel_arn option;The Amazon Resource Name (ARN) of the two way channel.
*)self_managed_opt_outs_enabled : Smaws_Lib.Smithy_api.Types.primitive_boolean;By default this is set to false. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
*)opt_out_list_name : opt_out_list_name option;The name of the OptOutList associated with the RCS agent.
*)deletion_protection_enabled : Smaws_Lib.Smithy_api.Types.primitive_boolean;When set to true deletion protection is enabled. By default this is set to false.
*)created_timestamp : Smaws_Lib.Smithy_api.Types.timestamp;status : rcs_agent_status;The current status of the RCS agent.
*)rcs_agent_id : Smaws_Lib.Smithy_api.Types.string_;The unique identifier for the RCS agent.
*)rcs_agent_arn : Smaws_Lib.Smithy_api.Types.string_;The Amazon Resource Name (ARN) of the updated RCS agent.
*)}type nonrec update_rcs_agent_request = {two_way_rcs_events_enabled : rcs_event_type_list option;The list of RCS event types to enable for two-way messaging. Pass an empty list to disable all event types. The special value ALL enables all current and future event types and must be the sole element if used.
two_way_media_s3_role : iam_role_arn_or_unset option;The ARN of the IAM role used to write inbound RCS media files to the S3 bucket. The role must have s3:PutObject permission on the bucket and a trust policy allowing sms-voice.amazonaws.com to assume it. To remove the media configuration, pass the sentinel value UNSET_RCS_MEDIA_CONFIGURATION for both this field and TwoWayMediaS3BucketName.
two_way_media_s3_key_prefix : two_way_media_s3_key_prefix option;The key prefix used for inbound RCS media objects in the S3 bucket.
*)two_way_media_s3_bucket_name : two_way_media_s3_bucket_name_or_unset option;The name of the S3 bucket where inbound RCS media files are stored. Two-way messaging must be enabled on the agent. To remove the media configuration, pass the sentinel value UNSET_RCS_MEDIA_CONFIGURATION for both this field and TwoWayMediaS3Role.
two_way_enabled : Smaws_Lib.Smithy_api.Types.boolean_ option;By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
*)two_way_channel_role : iam_role_arn option;An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
*)two_way_channel_arn : two_way_channel_arn option;The Amazon Resource Name (ARN) of the two way channel.
*)self_managed_opt_outs_enabled : Smaws_Lib.Smithy_api.Types.boolean_ option;By default this is set to false. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
*)opt_out_list_name : opt_out_list_name_or_arn option;The OptOutList to associate with the RCS agent. Valid values are either OptOutListName or OptOutListArn.
*)deletion_protection_enabled : Smaws_Lib.Smithy_api.Types.boolean_ option;By default this is set to false. When set to true the RCS agent can't be deleted.
*)rcs_agent_id : rcs_agent_id_or_arn;The unique identifier of the RCS agent to update. You can use either the RcsAgentId or RcsAgentArn.
*)}type nonrec update_protect_configuration_result = {deletion_protection_enabled : Smaws_Lib.Smithy_api.Types.primitive_boolean;The status of deletion protection for the protect configuration. When set to true deletion protection is enabled. By default this is set to false.
*)account_default : Smaws_Lib.Smithy_api.Types.primitive_boolean;This is true if the protect configuration is set as your account default protect configuration.
*)created_timestamp : Smaws_Lib.Smithy_api.Types.timestamp;protect_configuration_id : protect_configuration_id;The unique identifier for the protect configuration.
*)protect_configuration_arn : protect_configuration_arn;The Amazon Resource Name (ARN) of the protect configuration.
*)}type nonrec update_protect_configuration_request = {deletion_protection_enabled : Smaws_Lib.Smithy_api.Types.boolean_ option;When set to true deletion protection is enabled. By default this is set to false.
*)protect_configuration_id : protect_configuration_id_or_arn;The unique identifier for the protect configuration.
*)}type nonrec protect_configuration_country_rule_set_information = {protect_status : protect_status;The types of protection that can be used.
*)}The types of statuses that can be used.
type nonrec protect_configuration_country_rule_set =
(iso_country_code * protect_configuration_country_rule_set_information) listtype nonrec update_protect_configuration_country_rule_set_result = {country_rule_set : protect_configuration_country_rule_set;An array of ProtectConfigurationCountryRuleSetInformation containing the rules for the NumberCapability.
*)number_capability : number_capability;The number capability that was updated
*)protect_configuration_id : protect_configuration_id;The unique identifier for the protect configuration.
*)protect_configuration_arn : protect_configuration_arn;The Amazon Resource Name (ARN) of the protect configuration.
*)}type nonrec update_protect_configuration_country_rule_set_request = {country_rule_set_updates : protect_configuration_country_rule_set;A map of ProtectConfigurationCountryRuleSetInformation objects that contain the details for the requested NumberCapability. The Key is the two-letter ISO country code. For a list of supported ISO country codes, see Supported countries and regions (SMS channel) in the End User Messaging SMS User Guide.
For example, to set the United States as allowed and Canada as blocked, the CountryRuleSetUpdates would be formatted as: "CountryRuleSetUpdates": { "US" : { "ProtectStatus": "ALLOW" } "CA" : { "ProtectStatus": "BLOCK" } }
number_capability : number_capability;The number capability to apply the CountryRuleSetUpdates updates to.
*)protect_configuration_id : protect_configuration_id_or_arn;The unique identifier for the protect configuration.
*)}type nonrec update_pool_result = {created_timestamp : Smaws_Lib.Smithy_api.Types.timestamp option;deletion_protection_enabled : Smaws_Lib.Smithy_api.Types.primitive_boolean
option;When set to true the pool can't be deleted.
*)opt_out_list_name : opt_out_list_name option;The name of the OptOutList associated with the pool.
*)self_managed_opt_outs_enabled : Smaws_Lib.Smithy_api.Types.primitive_boolean
option;When set to false and an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, End User Messaging SMS automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
*)two_way_channel_role : iam_role_arn option;An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
*)two_way_channel_arn : two_way_channel_arn option;The Amazon Resource Name (ARN) of the two way channel.
*)two_way_enabled : Smaws_Lib.Smithy_api.Types.primitive_boolean option;By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
*)message_type : message_type option;The type of message for the pool to use.
*)status : pool_status option;The current status of the pool update request.
*)pool_id : Smaws_Lib.Smithy_api.Types.string_ option;The unique identifier of the pool.
*)pool_arn : Smaws_Lib.Smithy_api.Types.string_ option;The ARN of the pool.
*)}type nonrec update_pool_request = {deletion_protection_enabled : Smaws_Lib.Smithy_api.Types.boolean_ option;When set to true the pool can't be deleted.
*)opt_out_list_name : opt_out_list_name_or_arn option;The OptOutList to associate with the pool. Valid values are either OptOutListName or OptOutListArn.
If you are using a shared End User Messaging SMS resource then you must use the full Amazon Resource Name(ARN).
*)self_managed_opt_outs_enabled : Smaws_Lib.Smithy_api.Types.boolean_ option;By default this is set to false. When set to false and an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, End User Messaging SMS automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
*)two_way_channel_role : iam_role_arn option;An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
*)two_way_channel_arn : two_way_channel_arn option;The Amazon Resource Name (ARN) of the two way channel.
*)two_way_enabled : Smaws_Lib.Smithy_api.Types.boolean_ option;By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
*)pool_id : pool_id_or_arn;The unique identifier of the pool to update. Valid values are either the PoolId or PoolArn.
If you are using a shared End User Messaging SMS resource then you must use the full Amazon Resource Name(ARN).
*)}type nonrec number_capability_list = number_capability listtype nonrec update_phone_number_result = {created_timestamp : Smaws_Lib.Smithy_api.Types.timestamp option;registration_id : Smaws_Lib.Smithy_api.Types.string_ option;The unique identifier for the registration.
*)deletion_protection_enabled : Smaws_Lib.Smithy_api.Types.primitive_boolean
option;When set to true the phone number can't be deleted.
*)international_sending_enabled : Smaws_Lib.Smithy_api.Types.primitive_boolean
option;When set to true the international sending of phone number is Enabled.
*)opt_out_list_name : opt_out_list_name option;The name of the OptOutList associated with the phone number.
*)self_managed_opt_outs_enabled : Smaws_Lib.Smithy_api.Types.primitive_boolean
option;This is true if self managed opt-out are enabled.
*)two_way_channel_role : iam_role_arn option;An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
*)two_way_channel_arn : two_way_channel_arn option;The Amazon Resource Name (ARN) of the two way channel.
*)two_way_enabled : Smaws_Lib.Smithy_api.Types.primitive_boolean option;By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
*)monthly_leasing_price : Smaws_Lib.Smithy_api.Types.string_ option;The monthly leasing price of the phone number, in US dollars.
*)number_type : number_type option;The type of number that was requested.
*)number_capabilities : number_capability_list option;Specifies if the number could be used for text messages, voice or both.
*)message_type : message_type option;The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
*)iso_country_code : iso_country_code option;The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
*)status : number_status option;The current status of the request.
*)phone_number : phone_number option;The phone number that was updated.
*)phone_number_id : Smaws_Lib.Smithy_api.Types.string_ option;The unique identifier of the phone number.
*)phone_number_arn : Smaws_Lib.Smithy_api.Types.string_ option;The Amazon Resource Name (ARN) of the updated phone number.
*)}type nonrec update_phone_number_request = {deletion_protection_enabled : Smaws_Lib.Smithy_api.Types.boolean_ option;By default this is set to false. When set to true the phone number can't be deleted.
*)international_sending_enabled : Smaws_Lib.Smithy_api.Types.boolean_ option;By default this is set to false. When set to true the international sending of phone number is Enabled.
*)opt_out_list_name : opt_out_list_name_or_arn option;The OptOutList to add the phone number to. You can use either the opt out list name or the opt out list ARN.
*)self_managed_opt_outs_enabled : Smaws_Lib.Smithy_api.Types.boolean_ option;By default this is set to false. When set to false and an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, End User Messaging SMS automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
*)two_way_channel_role : iam_role_arn option;An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
*)two_way_channel_arn : two_way_channel_arn option;The Amazon Resource Name (ARN) of the two way channel.
*)two_way_enabled : Smaws_Lib.Smithy_api.Types.boolean_ option;By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
*)phone_number_id : phone_number_id_or_arn;The unique identifier of the phone number. Valid values for this field can be either the PhoneNumberId or PhoneNumberArn.
If you are using a shared End User Messaging SMS resource then you must use the full Amazon Resource Name(ARN).
*)}type nonrec iso_country_code_list = iso_country_code listtype nonrec notify_enabled_channels_list = number_capability listtype nonrec update_notify_configuration_result = {created_timestamp : Smaws_Lib.Smithy_api.Types.timestamp;deletion_protection_enabled : Smaws_Lib.Smithy_api.Types.primitive_boolean;When set to true deletion protection is enabled. By default this is set to false.
*)rejection_reason : Smaws_Lib.Smithy_api.Types.string_ option;The reason the notify configuration was rejected, if applicable.
*)status : notify_configuration_status;The current status of the notify configuration.
*)tier_upgrade_status : tier_upgrade_status;The tier upgrade status of the notify configuration.
*)tier : notify_configuration_tier;The tier of the notify configuration.
*)enabled_channels : notify_enabled_channels_list;An array of channels enabled for the notify configuration. Supported values include SMS and VOICE.
enabled_countries : iso_country_code_list option;An array of two-character ISO country codes, in ISO 3166-1 alpha-2 format, that are enabled for the notify configuration.
*)pool_id : Smaws_Lib.Smithy_api.Types.string_ option;The identifier of the pool associated with the notify configuration.
*)default_template_id : notify_template_id option;The default template identifier associated with the notify configuration.
*)use_case : notify_configuration_use_case;The use case for the notify configuration.
*)display_name : notify_configuration_display_name;The display name associated with the notify configuration.
*)notify_configuration_id : notify_configuration_id;The unique identifier for the notify configuration.
*)notify_configuration_arn : notify_configuration_arn;The Amazon Resource Name (ARN) for the notify configuration.
*)}type nonrec update_notify_configuration_request = {deletion_protection_enabled : Smaws_Lib.Smithy_api.Types.boolean_ option;When set to true the notify configuration can't be deleted.
*)enabled_channels : notify_enabled_channels_list option;An array of channels to enable for the notify configuration. Supported values include SMS and VOICE.
enabled_countries : iso_country_code_list option;An array of two-character ISO country codes, in ISO 3166-1 alpha-2 format, that are enabled for the notify configuration.
*)pool_id : notify_pool_id_or_unset option;The pool identifier or Amazon Resource Name (ARN) to associate with the notify configuration. Pass the special value UNSET_DEFAULT_POOL_FOR_NOTIFY to clear the current default pool from the notify configuration.
default_template_id : notify_template_id option;The default template identifier to associate with the notify configuration. If specified, this template is used when sending messages without an explicit template identifier. Pass the special value UNSET_DEFAULT_TEMPLATE to clear the current default template from the notify configuration.
notify_configuration_id : notify_configuration_id_or_arn;The identifier of the notify configuration to update. The NotifyConfigurationId can be found using the DescribeNotifyConfigurations operation.
}type nonrec event_type = | ALL| TEXT_ALL| TEXT_SENT| TEXT_PENDING| TEXT_QUEUED| TEXT_SUCCESSFUL| TEXT_DELIVERED| TEXT_INVALID| TEXT_INVALID_MESSAGE| TEXT_UNREACHABLE| TEXT_CARRIER_UNREACHABLE| TEXT_BLOCKED| TEXT_CARRIER_BLOCKED| TEXT_SPAM| TEXT_UNKNOWN| TEXT_TTL_EXPIRED| TEXT_PROTECT_BLOCKED| VOICE_ALL| VOICE_INITIATED| VOICE_RINGING| VOICE_ANSWERED| VOICE_COMPLETED| VOICE_BUSY| VOICE_NO_ANSWER| VOICE_FAILED| VOICE_TTL_EXPIRED| MEDIA_ALL| MEDIA_PENDING| MEDIA_QUEUED| MEDIA_SUCCESSFUL| MEDIA_DELIVERED| MEDIA_INVALID| MEDIA_INVALID_MESSAGE| MEDIA_UNREACHABLE| MEDIA_CARRIER_UNREACHABLE| MEDIA_BLOCKED| MEDIA_CARRIER_BLOCKED| MEDIA_SPAM| MEDIA_UNKNOWN| MEDIA_TTL_EXPIRED| MEDIA_FILE_INACCESSIBLE| MEDIA_FILE_TYPE_UNSUPPORTED| MEDIA_FILE_SIZE_EXCEEDED| RCS_ALL| RCS_QUEUED| RCS_SENT| RCS_DELIVERED| RCS_READ| RCS_FAILED| RCS_TTL_EXPIRED| RCS_PROTECT_BLOCKED| RCS_FALLEN_BACK_TO_SMStype nonrec event_type_list = event_type listtype nonrec cloud_watch_logs_destination = {log_group_arn : log_group_arn;The name of the Amazon CloudWatch log group that you want to record events in.
*)iam_role_arn : iam_role_arn;The Amazon Resource Name (ARN) of an Identity and Access Management role that is able to write event data to an Amazon CloudWatch destination.
*)}Contains the destination configuration to use when publishing message sending events.
type nonrec kinesis_firehose_destination = {delivery_stream_arn : delivery_stream_arn;The Amazon Resource Name (ARN) of the delivery stream.
*)iam_role_arn : iam_role_arn;The ARN of an Identity and Access Management role that is able to write event data to an Amazon Data Firehose destination.
*)}Contains the delivery stream Amazon Resource Name (ARN), and the ARN of the Identity and Access Management (IAM) role associated with a Firehose event destination.
Event destinations, such as Firehose, are associated with configuration sets, which enable you to publish message sending events.
type nonrec sns_destination = {topic_arn : sns_topic_arn;The Amazon Resource Name (ARN) of the Amazon SNS topic that you want to publish events to.
*)}An object that defines an Amazon SNS destination for events. You can use Amazon SNS to send notification when certain events occur.
type nonrec event_destination = {sns_destination : sns_destination option;An object that contains information about an event destination that sends logging events to Amazon SNS.
*)kinesis_firehose_destination : kinesis_firehose_destination option;An object that contains information about an event destination for logging to Amazon Data Firehose.
*)cloud_watch_logs_destination : cloud_watch_logs_destination option;An object that contains information about an event destination that sends logging events to Amazon CloudWatch logs.
*)matching_event_types : event_type_list;An array of event types that determine which events to log.
The TEXT_SENT event type is not supported.
enabled : Smaws_Lib.Smithy_api.Types.boolean_;When set to true events will be logged.
*)event_destination_name : event_destination_name;The name of the EventDestination.
*)}Contains information about an event destination.
Event destinations are associated with configuration sets, which enable you to publish message sending events to CloudWatch, Firehose, or Amazon SNS.
type nonrec update_event_destination_result = {event_destination : event_destination option;An EventDestination object containing the details of where events will be logged.
*)configuration_set_name : configuration_set_name option;The name of the configuration set.
*)configuration_set_arn : Smaws_Lib.Smithy_api.Types.string_ option;The Amazon Resource Name (ARN) for the ConfigurationSet that was updated.
*)}type nonrec update_event_destination_request = {sns_destination : sns_destination option;An object that contains information about an event destination that sends data to Amazon SNS.
*)kinesis_firehose_destination : kinesis_firehose_destination option;An object that contains information about an event destination for logging to Firehose.
*)cloud_watch_logs_destination : cloud_watch_logs_destination option;An object that contains information about an event destination that sends data to CloudWatch Logs.
*)matching_event_types : event_type_list option;An array of event types that determine which events to log.
The TEXT_SENT event type is not supported.
enabled : Smaws_Lib.Smithy_api.Types.boolean_ option;When set to true logging is enabled.
*)event_destination_name : event_destination_name;The name to use for the event destination.
*)configuration_set_name : configuration_set_name_or_arn;The configuration set to update with the new event destination. Valid values for this can be the ConfigurationSetName or ConfigurationSetArn.
*)}type nonrec tag_key_list = tag_key listtype nonrec untag_resource_request = {tag_keys : tag_key_list;An array of tag key values to unassociate with the resource.
*)resource_arn : amazon_resource_name;The Amazon Resource Name (ARN) of the resource.
*)}type nonrec text_validation = {pattern : Smaws_Lib.Smithy_api.Types.string_;The regular expression used to validate the text field.
*)max_length : Smaws_Lib.Smithy_api.Types.integer;The maximum number of characters for the text field.
*)min_length : Smaws_Lib.Smithy_api.Types.integer;The minimum number of characters for the text field.
*)}Validation rules for a text field.
type nonrec testing_agent_information = {registration_id : Smaws_Lib.Smithy_api.Types.string_;The unique identifier of the registration associated with the testing agent.
*)testing_agent_id : Smaws_Lib.Smithy_api.Types.string_ option;The unique identifier for the testing agent.
*)status : testing_agent_status;The current status of the testing agent.
*)}Contains details about the testing agent associated with an RCS agent.
type nonrec template_variable_metadata = {source : template_variable_source option;The source of the variable, either CUSTOMER or SYSTEM.
sample : Smaws_Lib.Smithy_api.Types.string_ option;A sample value for the variable.
*)pattern : Smaws_Lib.Smithy_api.Types.string_ option;The regex pattern the variable value must match.
*)default_value : Smaws_Lib.Smithy_api.Types.string_ option;The default value for the variable.
*)max_value : Smaws_Lib.Smithy_api.Types.integer option;The maximum value for numeric variables.
*)min_value : Smaws_Lib.Smithy_api.Types.integer option;The minimum value for numeric variables.
*)max_length : Smaws_Lib.Smithy_api.Types.integer option;The maximum length for string variables.
*)description : Smaws_Lib.Smithy_api.Types.string_ option;A description of the variable.
*)required : Smaws_Lib.Smithy_api.Types.primitive_boolean;Whether the variable is required.
*)type_ : template_variable_type;The type of the variable.
*)}Contains metadata about a template variable.
type nonrec template_variables_map =
(Smaws_Lib.Smithy_api.Types.string_ * template_variable_metadata) listtype nonrec template_variable_substitution_map =
(template_variable_name * template_variable_value) listtype nonrec tag = {value : tag_value;The string value associated with the key of the tag.
*)key : tag_key;The key identifier, or name, of the tag.
*)}The list of tags to be added to the specified topic.
type nonrec non_empty_tag_list = tag listtype nonrec tag_resource_request = {resource_arn : amazon_resource_name;The Amazon Resource Name (ARN) of the resource.
*)}type nonrec service_quota_exceeded_exception_reason = | ASSOCIATIONS_PER_REGISTRATION| CONFIGURATION_SETS_PER_ACCOUNT| DAILY_DESTINATION_CALL_LIMIT| DAILY_NOTIFY_TIER_MESSAGE_LIMIT| EVENT_DESTINATIONS_PER_CONFIGURATION_SET| KEYWORDS_PER_PHONE_NUMBER| KEYWORDS_PER_POOL| MONTHLY_SPEND_LIMIT_REACHED_FOR_MEDIA| MONTHLY_SPEND_LIMIT_REACHED_FOR_NOTIFY| MONTHLY_SPEND_LIMIT_REACHED_FOR_RCS| MONTHLY_SPEND_LIMIT_REACHED_FOR_TEXT| MONTHLY_SPEND_LIMIT_REACHED_FOR_VOICE| NOTIFY_CONFIGURATIONS_PER_ACCOUNT| OPT_OUT_LISTS_PER_ACCOUNT| ORIGINATION_IDENTITIES_PER_POOL| PHONE_NUMBERS_PER_ACCOUNT| PHONE_NUMBERS_PER_REGISTRATION| POOLS_PER_ACCOUNT| RCS_AGENTS_PER_ACCOUNT| REGISTRATION_ATTACHMENTS_CREATED_PER_DAY| REGISTRATION_ATTACHMENTS_PER_ACCOUNT| REGISTRATION_VERSIONS_CREATED_PER_DAY| REGISTRATIONS_PER_ACCOUNT| SENDER_IDS_PER_ACCOUNT| TAGS_PER_RESOURCE| VERIFIED_DESTINATION_NUMBERS_PER_ACCOUNT| VERIFICATION_ATTEMPTS_PER_DAY| PROTECT_CONFIGURATIONS_PER_ACCOUNTtype nonrec service_quota_exceeded_exception = {reason : service_quota_exceeded_exception_reason option;The reason for the exception.
*)message : Smaws_Lib.Smithy_api.Types.string_ option;}The request would cause a service quota to be exceeded.
type nonrec tag_list = tag listtype nonrec supported_association = {disassociation_behavior : registration_disassociation_behavior;The disassociation behavior.
DISASSOCIATE_ALL_CLOSES_REGISTRATION All origination identities must be disassociated from the registration before the registration can be closed.DISASSOCIATE_ALL_ALLOWS_DELETE_REGISTRATION All origination identities must be disassociated from the registration before the registration can be deleted.DELETE_REGISTRATION_DISASSOCIATES The registration can be deleted and all origination identities will be disasscoiated.association_behavior : registration_association_behavior;The association behavior.
ASSOCIATE_BEFORE_SUBMIT The origination identity has to be supplied when creating a registration.ASSOCIATE_ON_APPROVAL This applies to all sender ID registrations. The sender ID will be automatically provisioned once the registration is approved.ASSOCIATE_AFTER_COMPLETE This applies to phone number registrations when you must complete a registration first, then associate one or more phone numbers later. For example 10DLC campaigns and long codes.iso_country_code : iso_country_code option;The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
*)resource_type : Smaws_Lib.Smithy_api.Types.string_;Defines the behavior of when an origination identity and registration can be associated with each other.
*)}The processing rules for when a registration can be associated with an origination identity and disassociated from an origination identity.
type nonrec supported_association_list = supported_association listtype nonrec registration_version_number = Smaws_Lib.CoreTypes.Int64.ttype nonrec registration_version_status_history = {archived_timestamp : Smaws_Lib.Smithy_api.Types.timestamp option;revoked_timestamp : Smaws_Lib.Smithy_api.Types.timestamp option;denied_timestamp : Smaws_Lib.Smithy_api.Types.timestamp option;discarded_timestamp : Smaws_Lib.Smithy_api.Types.timestamp option;approved_timestamp : Smaws_Lib.Smithy_api.Types.timestamp option;requires_authentication_timestamp : Smaws_Lib.Smithy_api.Types.timestamp option;The time when the registration was in the requires authentication state, in UNIX epoch time format.
*)reviewing_timestamp : Smaws_Lib.Smithy_api.Types.timestamp option;aws_reviewing_timestamp : Smaws_Lib.Smithy_api.Types.timestamp option;submitted_timestamp : Smaws_Lib.Smithy_api.Types.timestamp option;draft_timestamp : Smaws_Lib.Smithy_api.Types.timestamp;}The RegistrationVersionStatusHistory object contains the time stamps for when the reservations status changes.
type nonrec submit_registration_version_result = {aws_review : Smaws_Lib.Smithy_api.Types.primitive_boolean;Indicates whether AWS review was requested for this registration submission.
*)registration_version_status_history : registration_version_status_history;The RegistrationVersionStatusHistory object contains the time stamps for when the reservations status changes.
*)registration_version_status : registration_version_status;The status of the registration version.
APPROVED: Your registration has been approved.ARCHIVED: Your previously approved registration version moves into this status when a more recently submitted version is approved.DENIED: You must fix your registration and resubmit it.DISCARDED: You've abandon this version of their registration to start over with a new version.DRAFT: The initial status of a registration version after it’s created.REQUIRES_AUTHENTICATION: You need to complete email authentication.REVIEWING: Your registration has been accepted and is being reviewed.REVOKED: Your previously approved registration has been revoked.SUBMITTED: Your registration has been submitted.version_number : registration_version_number;The version number of the registration.
*)registration_id : Smaws_Lib.Smithy_api.Types.string_;The unique identifier for the registration.
*)registration_arn : Smaws_Lib.Smithy_api.Types.string_;The Amazon Resource Name (ARN) for the registration.
*)}type nonrec submit_registration_version_request = {aws_review : Smaws_Lib.Smithy_api.Types.primitive_boolean option;Set to true to request AWS review of the registration. When enabled, AWS will perform additional validation and review of the registration submission before processing.
*)registration_id : registration_id_or_arn;The unique identifier for the registration.
*)}type nonrec string_map =
(Smaws_Lib.Smithy_api.Types.string_ * Smaws_Lib.Smithy_api.Types.string_)
listtype nonrec string_list = Smaws_Lib.Smithy_api.Types.string_ listtype nonrec spend_limit = {overridden : Smaws_Lib.Smithy_api.Types.primitive_boolean;When set to True, the value that has been specified in the EnforcedLimit is used to determine the maximum amount in US dollars that can be spent to send messages each month, in US dollars.
max_limit : Smaws_Lib.Smithy_api.Types.primitive_long;The maximum amount of money that you are able to spend to send messages each month, in US dollars.
*)enforced_limit : Smaws_Lib.Smithy_api.Types.primitive_long;The maximum amount of money, in US dollars, that you want to be able to spend sending messages each month. This value has to be less than or equal to the amount in MaxLimit. To use this custom limit, Overridden must be set to true.
name : spend_limit_name;The name for the SpendLimit.
*)}Describes the current monthly spend limits for sending voice and text messages. For more information on increasing your monthly spend limit, see Requesting a spending quota increase in the End User Messaging SMS User Guide.
type nonrec spend_limit_list = spend_limit listtype nonrec monthly_limit = Smaws_Lib.CoreTypes.Int64.ttype nonrec set_voice_message_spend_limit_override_result = {monthly_limit : monthly_limit option;The current monthly limit to enforce on sending voice messages.
*)}type nonrec set_voice_message_spend_limit_override_request = {monthly_limit : monthly_limit;The new monthly limit to enforce on voice messages.
*)}type nonrec set_text_message_spend_limit_override_result = {monthly_limit : monthly_limit option;The current monthly limit to enforce on sending text messages.
*)}type nonrec set_text_message_spend_limit_override_request = {monthly_limit : monthly_limit;The new monthly limit to enforce on text messages.
*)}type nonrec set_rcs_message_spend_limit_override_result = {monthly_limit : monthly_limit option;The current monthly limit to enforce on RCS message spending.
*)}type nonrec set_rcs_message_spend_limit_override_request = {monthly_limit : monthly_limit;The new monthly limit to enforce on RCS message spending.
*)}type nonrec set_notify_message_spend_limit_override_result = {monthly_limit : monthly_limit option;The current monthly limit, in US dollars.
*)}type nonrec set_notify_message_spend_limit_override_request = {monthly_limit : monthly_limit;The new monthly limit to enforce on notify messages.
*)}type nonrec set_media_message_spend_limit_override_result = {monthly_limit : monthly_limit option;The current monthly limit to enforce on sending text messages.
*)}type nonrec set_media_message_spend_limit_override_request = {monthly_limit : monthly_limit;The new monthly limit to enforce on text messages.
*)}type nonrec set_default_sender_id_result = {sender_id : sender_id option;The default sender ID to set for the ConfigurationSet.
*)configuration_set_name : configuration_set_name option;The name of the configuration set that was updated.
*)configuration_set_arn : Smaws_Lib.Smithy_api.Types.string_ option;The Amazon Resource Name (ARN) of the updated configuration set.
*)}type nonrec set_default_sender_id_request = {sender_id : sender_id;The current sender ID for the configuration set. When sending a text message to a destination country which supports SenderIds, the default sender ID on the configuration set specified on SendTextMessage will be used if no dedicated origination phone numbers or registered SenderIds are available in your account, instead of a generic sender ID, such as 'NOTICE'.
configuration_set_name : configuration_set_name_or_arn;The configuration set to updated with a new default SenderId. This field can be the ConsigurationSetName or ConfigurationSetArn.
*)}type nonrec set_default_message_type_result = {message_type : message_type option;The new default message type of the configuration set.
*)configuration_set_name : configuration_set_name option;The name of the configuration set that was updated.
*)configuration_set_arn : Smaws_Lib.Smithy_api.Types.string_ option;The Amazon Resource Name (ARN) of the updated configuration set.
*)}type nonrec set_default_message_type_request = {message_type : message_type;The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
*)configuration_set_name : configuration_set_name_or_arn;The configuration set to update with a new default message type. This field can be the ConsigurationSetName or ConfigurationSetArn.
*)}type nonrec set_default_message_feedback_enabled_result = {message_feedback_enabled : Smaws_Lib.Smithy_api.Types.boolean_ option;True if message feedback is enabled.
*)configuration_set_name : configuration_set_name option;The name of the configuration.
*)configuration_set_arn : Smaws_Lib.Smithy_api.Types.string_ option;The arn of the configuration set.
*)}type nonrec set_default_message_feedback_enabled_request = {message_feedback_enabled : Smaws_Lib.Smithy_api.Types.boolean_;Set to true to enable message feedback.
*)configuration_set_name : configuration_set_name_or_arn;The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.
*)}type nonrec set_account_default_protect_configuration_result = {default_protect_configuration_id : protect_configuration_id;The unique identifier of the account default protect configuration.
*)default_protect_configuration_arn : protect_configuration_arn;The Amazon Resource Name (ARN) of the account default protect configuration.
*)}type nonrec set_account_default_protect_configuration_request = {protect_configuration_id : protect_configuration_id_or_arn;The unique identifier for the protect configuration.
*)}type nonrec sender_id_and_country = {iso_country_code : iso_country_code;The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
*)sender_id : sender_id_or_arn;The unique identifier of the sender.
*)}The alphanumeric sender ID in a specific country that you want to describe. For more information on sender IDs see Requesting sender IDs in the End User Messaging SMS User Guide.
type nonrec sender_id_list = sender_id_and_country listtype nonrec sender_id_information = {registration_id : Smaws_Lib.Smithy_api.Types.string_ option;The unique identifier for the registration.
*)registered : Smaws_Lib.Smithy_api.Types.primitive_boolean;True if the sender ID is registered.
*)deletion_protection_enabled : Smaws_Lib.Smithy_api.Types.primitive_boolean;By default this is set to false. When set to true the sender ID can't be deleted.
*)monthly_leasing_price : Smaws_Lib.Smithy_api.Types.string_;The monthly leasing price, in US dollars.
*)message_types : message_type_list;The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
*)iso_country_code : iso_country_code;The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
*)sender_id : sender_id;The alphanumeric sender ID in a specific country that you'd like to describe.
*)sender_id_arn : Smaws_Lib.Smithy_api.Types.string_;The Amazon Resource Name (ARN) associated with the SenderId.
*)}The information for all SenderIds in an Amazon Web Services account.
type nonrec sender_id_information_list = sender_id_information listtype nonrec sender_id_filter = {values : filter_value_list;An array of values to filter for.
*)name : sender_id_filter_name;The name of the attribute to filter on.
*)}The information for a sender ID that meets a specified criteria.
type nonrec sender_id_filter_list = sender_id_filter listtype nonrec send_voice_message_result = {message_id : Smaws_Lib.Smithy_api.Types.string_ option;The unique identifier for the message.
*)}type nonrec context_map = (context_key * context_value) listtype nonrec send_voice_message_request = {message_feedback_enabled : Smaws_Lib.Smithy_api.Types.boolean_ option;Set to true to enable message feedback for the message. When a user receives the message you need to update the message status using PutMessageFeedback.
protect_configuration_id : protect_configuration_id_or_arn option;The unique identifier for the protect configuration.
*)dry_run : Smaws_Lib.Smithy_api.Types.primitive_boolean option;When set to true, the message is checked and validated, but isn't sent to the end recipient.
*)context : context_map option;You can specify custom data in this field. If you do, that data is logged to the event destination.
*)time_to_live : time_to_live option;How long the voice message is valid for. By default this is 72 hours.
*)max_price_per_minute : max_price option;The maximum amount to spend per voice message, in US dollars.
*)configuration_set_name : configuration_set_name_or_arn option;The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.
*)voice_id : voice_id option;message_body_text_type : voice_message_body_text_type option;Specifies if the MessageBody field contains text or speech synthesis markup language (SSML).
message_body : voice_message_body option;The text to convert to a voice message.
*)origination_identity : voice_message_origination_identity;The origination identity to use for the voice call. This can be the PhoneNumber, PhoneNumberId, PhoneNumberArn, PoolId, or PoolArn.
If you are using a shared End User Messaging SMS resource then you must use the full Amazon Resource Name(ARN).
*)destination_phone_number : phone_number;The destination phone number in E.164 format.
*)}type nonrec send_text_message_result = {message_id : Smaws_Lib.Smithy_api.Types.string_ option;The unique identifier for the message.
*)}type nonrec destination_country_parameters =
(destination_country_parameter_key * destination_country_parameter_value)
listtype nonrec send_text_message_request = {message_feedback_enabled : Smaws_Lib.Smithy_api.Types.boolean_ option;Set to true to enable message feedback for the message. When a user receives the message you need to update the message status using PutMessageFeedback.
protect_configuration_id : protect_configuration_id_or_arn option;The unique identifier for the protect configuration.
*)dry_run : Smaws_Lib.Smithy_api.Types.primitive_boolean option;When set to true, the message is checked and validated, but isn't sent to the end recipient. You are not charged for using DryRun.
The Message Parts per Second (MPS) limit when using DryRun is five. If your origination identity has a lower MPS limit then the lower MPS limit is used. For more information about MPS limits, see Message Parts per Second (MPS) limits in the End User Messaging SMS User Guide..
destination_country_parameters : destination_country_parameters option;This field is used for any country-specific registration requirements. Currently, this setting is only used when you send messages to recipients in India using a sender ID. For more information see Special requirements for sending SMS messages to recipients in India.
IN_ENTITY_ID The entity ID or Principal Entity (PE) ID that you received after completing the sender ID registration process.IN_TEMPLATE_ID The template ID that you received after completing the sender ID registration process.
Make sure that the Template ID that you specify matches your message template exactly. If your message doesn't match the template that you provided during the registration process, the mobile carriers might reject your message.
context : context_map option;You can specify custom data in this field. If you do, that data is logged to the event destination.
*)time_to_live : time_to_live option;How long the text message is valid for, in seconds. By default this is 72 hours. If the messages isn't handed off before the TTL expires we stop attempting to hand off the message and return TTL_EXPIRED event.
max_price : max_price option;The maximum amount that you want to spend, in US dollars, per each text message. If the calculated amount to send the text message is greater than MaxPrice, the message is not sent and an error is returned.
configuration_set_name : configuration_set_name_or_arn option;The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.
*)keyword : keyword option;When you register a short code in the US, you must specify a program name. If you don’t have a US short code, omit this attribute.
*)message_type : message_type option;The type of message. Valid values are for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
*)message_body : text_message_body option;The body of the text message.
*)origination_identity : text_message_origination_identity option;The origination identity of the message. This can be either the PhoneNumber, PhoneNumberId, PhoneNumberArn, RcsAgentId, RcsAgentArn, SenderId, SenderIdArn, PoolId, or PoolArn.
If you are using a shared End User Messaging SMS resource then you must use the full Amazon Resource Name(ARN).
*)destination_phone_number : phone_number;The destination phone number in E.164 format.
*)}type nonrec send_rcs_message_result = {message_id : Smaws_Lib.Smithy_api.Types.string_ option;The unique identifier for the message.
*)}type nonrec rcs_text_message = {body : rcs_text_body;The text body of the RCS message. Maximum 3072 characters.
*)}A plain text RCS message body.
type nonrec rcs_file_message = {thumbnail_url : rcs_media_url option;The S3 URI of an optional thumbnail image for the media file, in the format s3://bucket-name/key. Maximum 2000 characters.
file_url : rcs_media_url;The S3 URI of the media file to send, in the format s3://bucket-name/key. The service downloads the file from your S3 bucket, rehosts it, and generates a presigned URL for the aggregator. Maximum 2000 characters.
}A file message containing a media file (image, video, audio, or PDF) with an optional thumbnail.
type nonrec rcs_card_media = {height : Smaws_Lib.Smithy_api.Types.string_ option;The display height of the media in the card. Valid values are SHORT, MEDIUM, and TALL.
*)thumbnail_url : rcs_media_url option;The S3 URI of an optional thumbnail image for the card media. Maximum 2000 characters.
*)file_url : rcs_media_url;The S3 URI of the media file for the card, in the format s3://bucket-name/key. Maximum 2000 characters.
}The media content of a rich card, including the file URL, optional thumbnail, and display height.
type nonrec rcs_reply_action = {postback_data : rcs_postback_data;The postback data sent to your webhook when the user taps this reply. Maximum 2048 characters.
*)text : rcs_suggested_action_text;The display text of the suggested reply. Maximum 25 characters.
*)}A suggested reply action that sends predefined text and postback data when tapped by the recipient.
type nonrec rcs_open_url_action = {webview_view_mode : Smaws_Lib.Smithy_api.Types.string_ option;The display mode of the webview. Valid values are FULL, HALF, and TALL. Only applicable when Application is WEBVIEW.
*)application : Smaws_Lib.Smithy_api.Types.string_ option;How to open the URL. BROWSER opens in the device's default browser. WEBVIEW opens in an in-app webview.
*)url : rcs_open_url_value;The URL to open. Must start with https://. Maximum 2048 characters.
*)postback_data : rcs_postback_data;The postback data sent to your webhook when the user taps this action. Maximum 2048 characters.
*)text : rcs_suggested_action_text;The display text of the action. Maximum 25 characters.
*)}A suggested action that opens a URL in the recipient's browser or an in-app webview.
type nonrec rcs_dial_phone_action = {phone_number : phone_number;The phone number to dial in E.164 format.
*)postback_data : rcs_postback_data;The postback data sent to your webhook when the user taps this action. Maximum 2048 characters.
*)text : rcs_suggested_action_text;The display text of the action. Maximum 25 characters.
*)}A suggested action that initiates a phone call to a specified number when tapped by the recipient.
type nonrec rcs_show_location_action = {label : rcs_location_label option;An optional label for the location pin. Maximum 100 characters.
*)longitude : Smaws_Lib.Smithy_api.Types.double;The longitude of the location. Valid values are -180 to 180.
*)latitude : Smaws_Lib.Smithy_api.Types.double;The latitude of the location. Valid values are -90 to 90.
*)postback_data : rcs_postback_data;The postback data sent to your webhook when the user taps this action. Maximum 2048 characters.
*)text : rcs_suggested_action_text;The display text of the action. Maximum 25 characters.
*)}A suggested action that shows a location on a map when tapped by the recipient.
type nonrec rcs_request_location_action = {postback_data : rcs_postback_data;The postback data sent to your webhook when the user taps this action. Maximum 2048 characters.
*)text : rcs_suggested_action_text;The display text of the action. Maximum 25 characters.
*)}A suggested action that requests the recipient's current location.
type nonrec rcs_create_calendar_event_action = {description : rcs_calendar_event_description option;An optional description for the calendar event. Maximum 500 characters.
*)end_time : Smaws_Lib.Smithy_api.Types.timestamp;The end time of the calendar event in ISO 8601 format.
*)start_time : Smaws_Lib.Smithy_api.Types.timestamp;The start time of the calendar event in ISO 8601 format.
*)title : rcs_calendar_event_title;The title of the calendar event. Maximum 100 characters.
*)postback_data : rcs_postback_data;The postback data sent to your webhook when the user taps this action. Maximum 2048 characters.
*)text : rcs_suggested_action_text;The display text of the action. Maximum 25 characters.
*)}A suggested action that creates a calendar event on the recipient's device.
type nonrec rcs_suggested_action = | CreateCalendarEvent of rcs_create_calendar_event_actionA suggested action that creates a calendar event on the user's device.
*)| RequestLocation of rcs_request_location_actionA suggested action that requests the user's current location.
*)| ShowLocation of rcs_show_location_actionA suggested action that shows a location on a map.
*)| DialPhone of rcs_dial_phone_actionA suggested action that initiates a phone call to the specified number.
*)| OpenUrl of rcs_open_url_actionA suggested action that opens a URL in the user's browser or a webview.
*)| Reply of rcs_reply_actionA suggested reply that sends predefined text and postback data when tapped.
*)A suggested action displayed to the RCS message recipient. Can be a reply, open URL, dial phone, show location, request location, or create calendar event.
type nonrec rcs_card_suggested_action_list = rcs_suggested_action listtype nonrec rcs_card_content = {suggestions : rcs_card_suggested_action_list option;Card-level suggested actions. Maximum 4 suggestions per card.
*)media : rcs_card_media option;The media content of the card, including the file URL, optional thumbnail, and display height.
*)description : rcs_card_description option;The description text of the card. Maximum 2000 characters.
*)title : rcs_card_title option;The title of the card. Maximum 200 characters.
*)}The content of a rich card, including title, description, media, and card-level suggested actions.
type nonrec rcs_standalone_card = {card_content : rcs_card_content;The content of the rich card, including title, description, media, and card-level suggested actions.
*)thumbnail_image_alignment : Smaws_Lib.Smithy_api.Types.string_ option;The alignment of the thumbnail image in a horizontal card. Valid values are LEFT and RIGHT. Only applicable when CardOrientation is HORIZONTAL.
*)card_orientation : Smaws_Lib.Smithy_api.Types.string_;The orientation of the rich card. Valid values are HORIZONTAL and VERTICAL.
*)}A standalone rich card with media, title, description, and suggested actions.
type nonrec rcs_carousel_card_media = {height : Smaws_Lib.Smithy_api.Types.string_ option;The display height of the media in the carousel card. Valid values are SHORT and MEDIUM.
*)thumbnail_url : rcs_media_url option;The S3 URI of an optional thumbnail image for the carousel card media. Maximum 2000 characters.
*)file_url : rcs_media_url;The S3 URI of the media file for the carousel card. Maximum 2000 characters.
*)}The media content of a carousel card. Display height is restricted to SHORT or MEDIUM (TALL is not supported in carousels).
type nonrec rcs_carousel_card_content = {suggestions : rcs_card_suggested_action_list option;Card-level suggested actions for this carousel card. Maximum 4 suggestions per card.
*)media : rcs_carousel_card_media option;The media content of the carousel card. Media height is restricted to SHORT or MEDIUM (TALL is not supported in carousels).
*)description : rcs_card_description option;The description text of the carousel card. Maximum 2000 characters.
*)title : rcs_card_title option;The title of the carousel card. Maximum 200 characters.
*)}The content of a carousel card, including title, description, media, and card-level suggested actions. Media height is restricted to SHORT or MEDIUM.
type nonrec rcs_carousel_card_content_list = rcs_carousel_card_content listtype nonrec rcs_carousel = {card_contents : rcs_carousel_card_content_list;The list of cards in the carousel. Minimum 2, maximum 10 cards.
*)card_width : Smaws_Lib.Smithy_api.Types.string_;The width of cards in the carousel. Valid values are SMALL and MEDIUM.
*)}A carousel of 2 to 10 scrollable rich cards.
type nonrec rcs_content = | Carousel of rcs_carouselA carousel of 2 to 10 scrollable cards, each with media, title, description, and suggested actions.
*)| RichCard of rcs_standalone_cardA standalone rich card with media, title, description, and suggested actions.
*)| FileMessage of rcs_file_messageA file message containing a media file (image, video, audio, or PDF) with an optional thumbnail.
*)| TextMessage of rcs_text_messageA plain text RCS message.
*)The message body of an RCS message. Exactly one content type must be specified.
type nonrec rcs_suggested_action_list = rcs_suggested_action listtype nonrec rcs_message_content = {suggestions : rcs_suggested_action_list option;Message-level suggested actions displayed to the recipient. Maximum 11 suggestions per message.
*)content : rcs_content;The content of the RCS message. Exactly one content type must be specified: TextMessage, FileMessage, RichCard, or Carousel.
*)}The content of an RCS message, containing the message body (text, file, rich card, or carousel) and optional message-level suggested actions.
type nonrec media_url_list = media_url_value listtype nonrec rcs_fallback_configuration = {origination_identity : rcs_fallback_origination_identity option;The origination identity to use for the fallback message. This can be a PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, or SenderIdArn. Pool IDs and pool ARNs are not accepted. If not specified and the original message was sent via a pool, the service selects a suitable number from the pool.
*)media_urls : media_url_list option;An array of S3 URIs to media files for MMS fallback. Only valid when Channel is MMS.
*)message_body : rcs_fallback_message_body option;The text body of the fallback message. Required for SMS fallback. For MMS fallback, at least one of MessageBody or MediaUrls must be provided.
*)channel : rcs_fallback_channel;The fallback channel to use when RCS delivery fails. Valid values are SMS and MMS. SMS and MMS are mutually exclusive.
*)}Configuration for SMS or MMS fallback when RCS delivery fails or the TimeToLive expires without delivery confirmation.
type nonrec send_rcs_message_request = {message_feedback_enabled : Smaws_Lib.Smithy_api.Types.boolean_ option;Set to true to enable message feedback for the message. When a user receives the message you need to update the message status using PutMessageFeedback.
context : context_map option;You can specify custom data in this field. If you do, that data is logged to the event destination.
*)dry_run : Smaws_Lib.Smithy_api.Types.primitive_boolean option;When set to true, the message is checked and validated, but isn't sent to the end recipient.
*)max_price : max_price option;The maximum amount that you want to spend, in US dollars, per each RCS message.
*)configuration_set_name : configuration_set_name_or_arn option;The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.
*)protect_configuration_id : protect_configuration_id_or_arn option;The unique identifier of the protect configuration to use.
*)fallback_configuration : rcs_fallback_configuration option;Configuration for SMS or MMS fallback when RCS delivery fails. If provided, the service sends a fallback message via the specified channel when the RCS message fails or the TimeToLive expires.
*)message_traffic_type : rcs_message_traffic_type option;The traffic type of the RCS message. Valid values are AUTHENTICATION, TRANSACTION, PROMOTION, SERVICE_REQUEST, and ACKNOWLEDGEMENT. This field is reserved for future use.
*)time_to_live : rcs_time_to_live option;The duration in seconds that the RCS message is valid for delivery. If the message cannot be delivered within this duration, it is considered expired. Valid values are 1 to 172800 (48 hours). If a FallbackConfiguration is provided, the fallback is triggered when the duration expires without delivery confirmation.
*)rcs_message_content : rcs_message_content option;The content of the RCS message. Contains the message content (text, file, rich card, or carousel) and optional message-level suggested actions.
*)origination_identity : rcs_message_origination_identity;The origination identity of the message. This can be either the RcsAgentId, RcsAgentArn, PoolId, or PoolArn.
*)destination_phone_number : phone_number;The destination phone number in E.164 format.
*)}type nonrec send_notify_voice_message_result = {resolved_message_body : Smaws_Lib.Smithy_api.Types.string_ option;The message body after template variable substitution has been applied.
*)template_id : notify_template_id option;The unique identifier of the template used for the message.
*)message_id : Smaws_Lib.Smithy_api.Types.string_ option;The unique identifier for the message.
*)}type nonrec send_notify_voice_message_request = {message_feedback_enabled : Smaws_Lib.Smithy_api.Types.boolean_ option;Set to true to enable message feedback for the message. When a user receives the message you need to update the message status using PutMessageFeedback.
dry_run : Smaws_Lib.Smithy_api.Types.primitive_boolean option;When set to true, the message is checked and validated, but isn't sent to the end recipient.
*)configuration_set_name : configuration_set_name_or_arn option;The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.
*)context : context_map option;You can specify custom data in this field. If you do, that data is logged to the event destination.
*)time_to_live : time_to_live option;How long the voice message is valid for, in seconds. By default this is 72 hours.
*)voice_id : voice_id option;The voice ID to use for the voice message.
*)template_variables : template_variable_substitution_map;A map of template variable names and their values. All variable values are passed as strings regardless of the declared variable type. For example, pass INTEGER values as "42" and BOOLEAN values as "true" or "false".
template_id : notify_template_id option;The unique identifier of the template to use for the message.
*)destination_phone_number : phone_number;The destination phone number in E.164 format.
*)notify_configuration_id : notify_configuration_id_or_arn;The unique identifier of the notify configuration to use for sending the message. This can be either the NotifyConfigurationId or NotifyConfigurationArn.
*)}type nonrec send_notify_text_message_result = {resolved_message_body : Smaws_Lib.Smithy_api.Types.string_ option;The message body after template variable substitution has been applied.
*)template_id : notify_template_id option;The unique identifier of the template used for the message.
*)message_id : Smaws_Lib.Smithy_api.Types.string_ option;The unique identifier for the message.
*)}type nonrec send_notify_text_message_request = {message_feedback_enabled : Smaws_Lib.Smithy_api.Types.boolean_ option;Set to true to enable message feedback for the message. When a user receives the message you need to update the message status using PutMessageFeedback.
dry_run : Smaws_Lib.Smithy_api.Types.primitive_boolean option;When set to true, the message is checked and validated, but isn't sent to the end recipient.
*)configuration_set_name : configuration_set_name_or_arn option;The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.
*)context : context_map option;You can specify custom data in this field. If you do, that data is logged to the event destination.
*)time_to_live : time_to_live option;How long the text message is valid for, in seconds. By default this is 72 hours.
*)template_variables : template_variable_substitution_map;A map of template variable names and their values. All variable values are passed as strings regardless of the declared variable type. For example, pass INTEGER values as "42" and BOOLEAN values as "true" or "false".
template_id : notify_template_id option;The unique identifier of the template to use for the message.
*)destination_phone_number : phone_number;The destination phone number in E.164 format.
*)notify_configuration_id : notify_configuration_id_or_arn;The unique identifier of the notify configuration to use for sending the message. This can be either the NotifyConfigurationId or NotifyConfigurationArn.
*)}type nonrec send_media_message_result = {message_id : Smaws_Lib.Smithy_api.Types.string_ option;The unique identifier for the message.
*)}type nonrec send_media_message_request = {message_feedback_enabled : Smaws_Lib.Smithy_api.Types.boolean_ option;Set to true to enable message feedback for the message. When a user receives the message you need to update the message status using PutMessageFeedback.
protect_configuration_id : protect_configuration_id_or_arn option;The unique identifier of the protect configuration to use.
*)dry_run : Smaws_Lib.Smithy_api.Types.primitive_boolean option;When set to true, the message is checked and validated, but isn't sent to the end recipient.
*)context : context_map option;You can specify custom data in this field. If you do, that data is logged to the event destination.
*)time_to_live : time_to_live option;How long the media message is valid for. By default this is 72 hours.
*)max_price : max_price option;The maximum amount that you want to spend, in US dollars, per each MMS message.
*)configuration_set_name : configuration_set_name_or_arn option;The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.
*)media_urls : media_url_list option;An array of URLs to each media file to send.
The media files have to be stored in an S3 bucket. Supported media file formats are listed in MMS file types, size and character limits. For more information on creating an S3 bucket and managing objects, see Creating a bucket, Uploading objects in the Amazon S3 User Guide, and Setting up an Amazon S3 bucket for MMS files in the Amazon Web Services End User Messaging SMS User Guide.
*)message_body : text_message_body option;The text body of the message.
*)origination_identity : media_message_origination_identity;The origination identity of the message. This can be either the PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.
If you are using a shared End User Messaging SMS resource then you must use the full Amazon Resource Name(ARN).
*)destination_phone_number : phone_number;The destination phone number in E.164 format.
*)}type nonrec send_destination_number_verification_code_result = {message_id : Smaws_Lib.Smithy_api.Types.string_;The unique identifier for the message.
*)}type nonrec send_destination_number_verification_code_request = {destination_country_parameters : destination_country_parameters option;This field is used for any country-specific registration requirements. Currently, this setting is only used when you send messages to recipients in India using a sender ID. For more information see Special requirements for sending SMS messages to recipients in India.
*)context : context_map option;You can specify custom data in this field. If you do, that data is logged to the event destination.
*)configuration_set_name : configuration_set_name_or_arn option;The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.
*)origination_identity : verification_message_origination_identity option;The origination identity of the message. This can be either the PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.
If you are using a shared End User Messaging SMS resource then you must use the full Amazon Resource Name(ARN).
*)language_code : language_code option;Choose the language to use for the message.
*)verification_channel : verification_channel;Choose to send the verification code as an SMS or voice message.
*)verified_destination_number_id : verified_destination_number_id_or_arn;The unique identifier for the verified destination phone number.
*)}type nonrec select_validation = {options : string_list;An array of strings for the possible selection options.
*)max_choices : Smaws_Lib.Smithy_api.Types.integer;The maximum number of choices for the select.
*)min_choices : Smaws_Lib.Smithy_api.Types.integer;The minimum number of choices for the select.
*)}Validation rules for a select field.
type nonrec select_option_description = {description : Smaws_Lib.Smithy_api.Types.string_ option;A description of the option meaning.
*)title : Smaws_Lib.Smithy_api.Types.string_ option;The title of the select option.
*)option_ : Smaws_Lib.Smithy_api.Types.string_;The value of the option.
*)}A description of each select option.
type nonrec select_option_descriptions_list = select_option_description listtype nonrec select_choice_list = select_choice listtype nonrec section_path_list = section_path listtype nonrec request_sender_id_result = {registered : Smaws_Lib.Smithy_api.Types.primitive_boolean;True if the sender ID is registered.
*)deletion_protection_enabled : Smaws_Lib.Smithy_api.Types.primitive_boolean;By default this is set to false. When set to true the sender ID can't be deleted.
*)monthly_leasing_price : Smaws_Lib.Smithy_api.Types.string_;The monthly price, in US dollars, to lease the sender ID.
*)message_types : message_type_list;The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
*)iso_country_code : iso_country_code;The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
*)sender_id : sender_id;The sender ID that was requested.
*)sender_id_arn : Smaws_Lib.Smithy_api.Types.string_;The Amazon Resource Name (ARN) associated with the SenderId.
*)}type nonrec request_sender_id_request = {client_token : client_token option;Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
*)deletion_protection_enabled : Smaws_Lib.Smithy_api.Types.boolean_ option;By default this is set to false. When set to true the sender ID can't be deleted.
*)message_types : message_type_list option;The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
*)iso_country_code : iso_country_code;The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
*)sender_id : sender_id;The sender ID string to request. The sender ID can be 1-11 alphanumeric characters including letters (A-Z, a-z), numbers (0-9), or hyphens (-). The sender ID must contain at least one letter and cannot start or end with a hyphen.
*)}type nonrec request_phone_number_result = {created_timestamp : Smaws_Lib.Smithy_api.Types.timestamp option;registration_id : Smaws_Lib.Smithy_api.Types.string_ option;The unique identifier for the registration.
*)pool_id : Smaws_Lib.Smithy_api.Types.string_ option;The unique identifier of the pool associated with the phone number
*)deletion_protection_enabled : Smaws_Lib.Smithy_api.Types.primitive_boolean
option;By default this is set to false. When set to true the phone number can't be deleted.
*)international_sending_enabled : Smaws_Lib.Smithy_api.Types.primitive_boolean
option;By default this is set to false. When set to true the international sending of phone number is Enabled.
*)opt_out_list_name : opt_out_list_name option;The name of the OptOutList that is associated with the requested phone number.
*)self_managed_opt_outs_enabled : Smaws_Lib.Smithy_api.Types.primitive_boolean
option;By default this is set to false. When set to false and an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, End User Messaging SMS automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
*)two_way_channel_role : iam_role_arn option;An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
*)two_way_channel_arn : two_way_channel_arn option;The ARN used to identify the two way channel.
*)two_way_enabled : Smaws_Lib.Smithy_api.Types.primitive_boolean option;By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
*)monthly_leasing_price : Smaws_Lib.Smithy_api.Types.string_ option;The monthly price, in US dollars, to lease the phone number.
*)number_type : requestable_number_type option;The type of number that was released.
*)number_capabilities : number_capability_list option;Indicates if the phone number will be used for text messages, voice messages or both.
*)message_type : message_type option;The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
*)iso_country_code : iso_country_code option;The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
*)status : number_status option;The current status of the request.
*)phone_number : phone_number option;The new phone number that was requested.
*)phone_number_id : Smaws_Lib.Smithy_api.Types.string_ option;The unique identifier of the new phone number.
*)phone_number_arn : Smaws_Lib.Smithy_api.Types.string_ option;The Amazon Resource Name (ARN) of the requested phone number.
*)}type nonrec request_phone_number_request = {client_token : client_token option;Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
*)deletion_protection_enabled : Smaws_Lib.Smithy_api.Types.boolean_ option;By default this is set to false. When set to true the phone number can't be deleted.
*)international_sending_enabled : Smaws_Lib.Smithy_api.Types.boolean_ option;By default this is set to false. When set to true the international sending of phone number is Enabled.
*)registration_id : registration_id_or_arn option;Use this field to attach your phone number for an external registration process.
*)pool_id : pool_id_or_arn option;The pool to associated with the phone number. You can use the PoolId or PoolArn.
If you are using a shared End User Messaging SMS resource then you must use the full Amazon Resource Name(ARN).
*)opt_out_list_name : opt_out_list_name_or_arn option;The name of the OptOutList to associate with the phone number. You can use the OptOutListName or OptOutListArn.
If you are using a shared End User Messaging SMS resource then you must use the full Amazon Resource Name(ARN).
*)number_type : requestable_number_type;The type of phone number to request.
When you request a SIMULATOR phone number, you must set MessageType as TRANSACTIONAL.
number_capabilities : number_capability_list;Indicates if the phone number will be used for text messages, voice messages, or both.
*)message_type : message_type;The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
iso_country_code : iso_country_code;The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
*)}type nonrec release_sender_id_result = {registration_id : Smaws_Lib.Smithy_api.Types.string_ option;The unique identifier for the registration.
*)registered : Smaws_Lib.Smithy_api.Types.primitive_boolean;True if the sender ID is registered.
*)monthly_leasing_price : Smaws_Lib.Smithy_api.Types.string_;The monthly price, in US dollars, to lease the sender ID.
*)message_types : message_type_list;The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
*)iso_country_code : iso_country_code;The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
*)sender_id : sender_id;The sender ID that was released.
*)sender_id_arn : Smaws_Lib.Smithy_api.Types.string_;The Amazon Resource Name (ARN) associated with the SenderId.
*)}type nonrec release_sender_id_request = {iso_country_code : iso_country_code;The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
*)sender_id : sender_id_or_arn;The sender ID to release.
*)}type nonrec release_phone_number_result = {created_timestamp : Smaws_Lib.Smithy_api.Types.timestamp option;registration_id : Smaws_Lib.Smithy_api.Types.string_ option;The unique identifier for the registration.
*)opt_out_list_name : opt_out_list_name option;The name of the OptOutList that was associated with the phone number.
*)self_managed_opt_outs_enabled : Smaws_Lib.Smithy_api.Types.primitive_boolean
option;By default this is set to false. When set to false and an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, End User Messaging SMS automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
*)two_way_channel_role : iam_role_arn option;An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
*)two_way_channel_arn : two_way_channel_arn option;The Amazon Resource Name (ARN) of the TwoWayChannel.
*)two_way_enabled : Smaws_Lib.Smithy_api.Types.primitive_boolean option;By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
*)monthly_leasing_price : Smaws_Lib.Smithy_api.Types.string_ option;The monthly price of the phone number, in US dollars.
*)number_type : number_type option;The type of number that was released.
*)number_capabilities : number_capability_list option;Specifies if the number could be used for text messages, voice, or both.
*)message_type : message_type option;The message type that was associated with the phone number.
*)iso_country_code : iso_country_code option;The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
*)status : number_status option;The current status of the request.
*)phone_number : phone_number option;The phone number that was released.
*)phone_number_id : Smaws_Lib.Smithy_api.Types.string_ option;The PhoneNumberId of the phone number that was released.
*)phone_number_arn : Smaws_Lib.Smithy_api.Types.string_ option;The PhoneNumberArn of the phone number that was released.
*)}type nonrec release_phone_number_request = {phone_number_id : phone_number_id_or_arn;The PhoneNumberId or PhoneNumberArn of the phone number to release. You can use DescribePhoneNumbers to get the values for PhoneNumberId and PhoneNumberArn.
If you are using a shared End User Messaging SMS resource then you must use the full Amazon Resource Name(ARN).
*)}type nonrec registration_version_number_list = registration_version_number listtype nonrec registration_denied_reason_information = {documentation_link : Smaws_Lib.Smithy_api.Types.string_ option;The link to the document.
*)documentation_title : Smaws_Lib.Smithy_api.Types.string_ option;The title of the document.
*)long_description : Smaws_Lib.Smithy_api.Types.string_ option;A long description of the rejection reason.
*)short_description : Smaws_Lib.Smithy_api.Types.string_;A short description of the rejection reason.
*)reason : Smaws_Lib.Smithy_api.Types.string_;The reason a registration was rejected.
*)}Provides the reason a registration was rejected.
type nonrec registration_denied_reason_information_list =
registration_denied_reason_information listtype nonrec registration_version_information = {feedback : Smaws_Lib.Smithy_api.Types.string_ option;Generative AI feedback information provided during the registration review process. This includes comments, suggestions, or additional requirements.
*)denied_reasons : registration_denied_reason_information_list option;An array of RegistrationDeniedReasonInformation objects.
*)registration_version_status_history : registration_version_status_history;The RegistrationVersionStatusHistory object contains the time stamps for when the reservations status changes.
*)registration_version_status : registration_version_status;The status of the registration.
APPROVED: Your registration has been approved.ARCHIVED: Your previously approved registration version moves into this status when a more recently submitted version is approved.DENIED: You must fix your registration and resubmit it.DISCARDED: You've abandon this version of their registration to start over with a new version.DRAFT: The initial status of a registration version after it’s created.REQUIRES_AUTHENTICATION: You need to complete email authentication.REVIEWING: Your registration has been accepted and is being reviewed.REVOKED: Your previously approved registration has been revoked.SUBMITTED: Your registration has been submitted.version_number : registration_version_number;The version number of the registration.
*)}Provides information about the specified version of the registration.
type nonrec registration_version_information_list =
registration_version_information listtype nonrec registration_version_filter = {values : filter_value_list;An array of values to filter on.
*)name : registration_version_filter_name;The name of the attribute to filter on.
*)}The filter definition for filtering registration versions that meets a specified criteria.
type nonrec registration_version_filter_list = registration_version_filter listtype nonrec registration_type_list = registration_type listtype nonrec registration_type_filter = {values : filter_value_list;An array of values to filter on.
*)name : registration_type_filter_name;The name of the attribute to filter on.
*)}The filter definition for filtering registration types that meets a specified criteria.
type nonrec registration_type_filter_list = registration_type_filter listtype nonrec registration_type_display_hints = {documentation_link : Smaws_Lib.Smithy_api.Types.string_ option;The link to the document the display hint is associated with.
*)documentation_title : Smaws_Lib.Smithy_api.Types.string_ option;The title of the document the display hint is associated with.
*)long_description : Smaws_Lib.Smithy_api.Types.string_ option;A full description of the display hint.
*)short_description : Smaws_Lib.Smithy_api.Types.string_ option;A short description of the display hint.
*)title : Smaws_Lib.Smithy_api.Types.string_;The title of the display hint.
*)}Provides help information on the registration type.
type nonrec registration_type_definition = {display_hints : registration_type_display_hints;Provides help information on the registration.
*)supported_associations : supported_association_list option;The supported association behavior for the registration type.
*)registration_type : registration_type;The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
}Provides information on the supported registration type.
type nonrec registration_type_definition_list =
registration_type_definition listtype nonrec registration_section_display_hints = {documentation_link : Smaws_Lib.Smithy_api.Types.string_ option;The link to the document the display hint is associated with.
*)documentation_title : Smaws_Lib.Smithy_api.Types.string_ option;The title of the document the display hint is associated with.
*)long_description : Smaws_Lib.Smithy_api.Types.string_ option;A full description of the display hint.
*)short_description : Smaws_Lib.Smithy_api.Types.string_;A short description of the display hint.
*)title : Smaws_Lib.Smithy_api.Types.string_;The title of the display hint.
*)}Provides help information on the registration section.
type nonrec registration_section_definition = {display_hints : registration_section_display_hints;The path to the section of the registration.
*)section_path : section_path;The path to the section of the registration.
*)}Provides information on the specified section definition.
type nonrec registration_section_definition_list =
registration_section_definition listtype nonrec registration_information = {created_timestamp : Smaws_Lib.Smithy_api.Types.timestamp;additional_attributes : string_map option;Metadata about a given registration which is specific to that registration type.
*)latest_denied_version_number : registration_version_number option;The latest version number of the registration that was denied.
*)approved_version_number : registration_version_number option;The version number of the registration that was approved.
*)current_version_number : registration_version_number;The current version number of the registration.
*)registration_status : registration_status;The status of the registration.
CLOSED: The phone number or sender ID has been deleted and you must also delete the registration for the number.CREATED: Your registration is created but not submitted.COMPLETE: Your registration has been approved and your origination identity has been created.DELETED: The registration has been deleted.PROVISIONING: Your registration has been approved and your origination identity is being created.REQUIRES_AUTHENTICATION: You need to complete email authentication.REQUIRES_UPDATES: You must fix your registration and resubmit it.REVIEWING: Your registration has been accepted and is being reviewed.SUBMITTED: Your registration has been submitted and is awaiting review.registration_type : registration_type;The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
registration_id : Smaws_Lib.Smithy_api.Types.string_;The unique identifier for the registration.
*)registration_arn : Smaws_Lib.Smithy_api.Types.string_;The Amazon Resource Name (ARN) for the registration.
*)}Provides information about the requested registration.
type nonrec registration_information_list = registration_information listtype nonrec registration_id_list = registration_id_or_arn listtype nonrec registration_filter = {values : filter_value_list;An array of values to filter on.
*)name : registration_filter_name;The name of the attribute to filter on.
*)}The filter definition for filtering registrations that meets a specified criteria.
type nonrec registration_filter_list = registration_filter listtype nonrec registration_field_value_information = {feedback : Smaws_Lib.Smithy_api.Types.string_ option;Generative AI feedback information provided for this specific field during the registration review process. This may include validation errors, suggestions for improvement, or additional requirements.
*)denied_reason : Smaws_Lib.Smithy_api.Types.string_ option;A description of why the registration was denied.
*)registration_attachment_id : registration_attachment_id_or_arn option;The unique identifier for the registration attachment.
*)text_value : text_value option;The text data for a free form field.
*)select_choices : select_choice_list option;An array of values for the form field.
*)field_path : field_path;The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of FieldPaths.
}Provides the values of the specified field.
type nonrec registration_field_value_information_list =
registration_field_value_information listtype nonrec registration_field_display_hints = {example_text_value : Smaws_Lib.Smithy_api.Types.string_ option;Example text of what the value of a field should contain.
*)text_validation_description : Smaws_Lib.Smithy_api.Types.string_ option;The validation rules for the text field.
*)select_option_descriptions : select_option_descriptions_list option;An array of SelectOptionDescription objects.
*)documentation_link : Smaws_Lib.Smithy_api.Types.string_ option;The link to the document the display hint is associated with.
*)documentation_title : Smaws_Lib.Smithy_api.Types.string_ option;The title of the document the display hint is associated with.
*)long_description : Smaws_Lib.Smithy_api.Types.string_ option;A full description of the display hint.
*)short_description : Smaws_Lib.Smithy_api.Types.string_;A short description of the display hint.
*)title : Smaws_Lib.Smithy_api.Types.string_;The title of the display hint.
*)}Provides help information on the registration field.
type nonrec registration_field_definition = {display_hints : registration_field_display_hints;An array of RegistrationFieldDisplayHints objects for the field.
*)text_validation : text_validation option;The validation rules for a text field.
*)select_validation : select_validation option;The validation rules for a select field.
*)field_requirement : field_requirement;Specifies if the field for the registration form is required, conditional or optional.
*)field_type : field_type;The type of field.
*)field_path : field_path;The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of FieldPaths.
section_path : section_path;The section path of the field.
*)}Provides a description of the specified field.
type nonrec registration_field_definition_list =
registration_field_definition listtype nonrec registration_attachments_information = {attachment_url : Smaws_Lib.Smithy_api.Types.string_ option;The URL to the document that's associated with the registration attachment.
*)created_timestamp : Smaws_Lib.Smithy_api.Types.timestamp;attachment_upload_error_reason : attachment_upload_error_reason option;A description of why the upload didn't successfully complete.
*)attachment_status : attachment_status;The status of the registration attachment.
UPLOAD_IN_PROGRESS The attachment is being uploaded.UPLOAD_COMPLETE The attachment has been uploaded.UPLOAD_FAILED The attachment failed to uploaded.DELETED The attachment has been deleted..registration_attachment_id : Smaws_Lib.Smithy_api.Types.string_;The unique identifier for the registration attachment.
*)registration_attachment_arn : Smaws_Lib.Smithy_api.Types.string_;The Amazon Resource Name (ARN) for the registration attachment.
*)}Provides information on the specified registration attachments.
type nonrec registration_attachments_information_list =
registration_attachments_information listtype nonrec registration_attachment_id_list = registration_id_or_arn listtype nonrec registration_attachment_filter = {values : filter_value_list;An array of values to filter on.
*)name : registration_attachment_filter_name;The name of the attribute to filter on.
*)}The filter definition for filtering registration attachments that meets a specified criteria.
type nonrec registration_attachment_filter_list =
registration_attachment_filter listtype nonrec registration_association_metadata = {phone_number : phone_number option;The phone number associated with the registration in E.164 format.
*)iso_country_code : iso_country_code option;The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
*)resource_type : Smaws_Lib.Smithy_api.Types.string_;The origination identity type.
*)resource_id : Smaws_Lib.Smithy_api.Types.string_;The unique identifier for the origination identity. For example this could be a PhoneNumberId or SenderId.
*)resource_arn : Smaws_Lib.Smithy_api.Types.string_;The Amazon Resource Name (ARN) of the origination identity that is associated with the registration.
*)}Metadata for the origination identity that is associated with the registration.
type nonrec registration_association_metadata_list =
registration_association_metadata listtype nonrec registration_association_filter = {values : filter_value_list;An array of values to filter for.
*)name : registration_association_filter_name;The name of the attribute to filter on.
*)}The filter definition for filtering registrations that meets a specified criteria.
type nonrec registration_association_filter_list =
registration_association_filter listtype nonrec rcs_agent_information = {testing_agent : testing_agent_information option;The testing agent information associated with the RCS agent.
*)two_way_rcs_events_enabled : rcs_event_type_list option;The list of RCS event types enabled for two-way messaging on the agent.
*)two_way_media_s3_role : iam_role_arn option;The ARN of the IAM role used to write inbound RCS media files to the S3 bucket.
*)two_way_media_s3_key_prefix : two_way_media_s3_key_prefix option;The key prefix used for inbound RCS media objects in the S3 bucket.
*)two_way_media_s3_bucket_name : two_way_media_s3_bucket_name option;The name of the S3 bucket where inbound RCS media files are stored.
*)pool_id : Smaws_Lib.Smithy_api.Types.string_ option;The unique identifier of the pool associated with the RCS agent.
*)two_way_enabled : Smaws_Lib.Smithy_api.Types.primitive_boolean;When set to true you can receive incoming text messages from your end recipients using the TwoWayChannelArn.
*)two_way_channel_role : iam_role_arn option;An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
*)two_way_channel_arn : two_way_channel_arn option;The Amazon Resource Name (ARN) of the two way channel.
*)self_managed_opt_outs_enabled : Smaws_Lib.Smithy_api.Types.primitive_boolean;When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
*)opt_out_list_name : opt_out_list_name option;The name of the OptOutList associated with the RCS agent.
*)deletion_protection_enabled : Smaws_Lib.Smithy_api.Types.primitive_boolean;When set to true the RCS agent can't be deleted.
*)created_timestamp : Smaws_Lib.Smithy_api.Types.timestamp;status : rcs_agent_status;The current status of the RCS agent.
*)rcs_agent_id : Smaws_Lib.Smithy_api.Types.string_;The unique identifier for the RCS agent.
*)rcs_agent_arn : Smaws_Lib.Smithy_api.Types.string_;The Amazon Resource Name (ARN) of the RCS agent.
*)}The information for an RCS agent in an Amazon Web Services account.
type nonrec rcs_agent_information_list = rcs_agent_information listtype nonrec rcs_agent_id_list = rcs_agent_id_or_arn listtype nonrec rcs_agent_filter = {values : filter_value_list;An array values to filter for.
*)name : rcs_agent_filter_name;The name of the attribute to filter on.
*)}The information for an RCS agent that meets a specified criteria.
type nonrec rcs_agent_filter_list = rcs_agent_filter listtype nonrec put_resource_policy_result = {created_timestamp : Smaws_Lib.Smithy_api.Types.timestamp option;policy : resource_policy option;The JSON formatted Resource Policy.
*)resource_arn : amazon_resource_name option;The Amazon Resource Name (ARN) of the End User Messaging SMS resource attached to the resource-based policy.
*)}type nonrec put_resource_policy_request = {policy : resource_policy;The JSON formatted resource-based policy to attach.
*)resource_arn : amazon_resource_name;The Amazon Resource Name (ARN) of the End User Messaging SMS resource to attach the resource-based policy to.
*)}type nonrec put_registration_field_value_result = {registration_attachment_id : Smaws_Lib.Smithy_api.Types.string_ option;The unique identifier for the registration attachment.
*)text_value : text_value option;The text data for a free form field.
*)select_choices : select_choice_list option;An array of values for the form field.
*)field_path : field_path;The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of FieldPaths.
version_number : registration_version_number;The version number of the registration.
*)registration_id : Smaws_Lib.Smithy_api.Types.string_;The unique identifier for the registration.
*)registration_arn : Smaws_Lib.Smithy_api.Types.string_;The Amazon Resource Name (ARN) for the registration.
*)}type nonrec put_registration_field_value_request = {registration_attachment_id : registration_attachment_id_or_arn option;The unique identifier for the registration attachment.
*)text_value : text_value option;The text data for a free form field.
*)select_choices : select_choice_list option;An array of values for the form field.
*)field_path : field_path;The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of FieldPaths.
registration_id : registration_id_or_arn;The unique identifier for the registration.
*)}type nonrec put_protect_configuration_rule_set_number_override_result = {expiration_timestamp : Smaws_Lib.Smithy_api.Types.timestamp option;The time the rule will expire at.
*)iso_country_code : iso_country_code option;The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
*)action : protect_configuration_rule_override_action;The action for the rule to take.
*)created_timestamp : Smaws_Lib.Smithy_api.Types.timestamp;destination_phone_number : phone_number;The destination phone number in E.164 format.
*)protect_configuration_id : protect_configuration_id;The unique identifier for the protect configuration.
*)protect_configuration_arn : protect_configuration_arn;The Amazon Resource Name (ARN) of the protect configuration.
*)}type nonrec put_protect_configuration_rule_set_number_override_request = {expiration_timestamp : Smaws_Lib.Smithy_api.Types.timestamp option;The time the rule will expire at. If ExpirationTimestamp is not set then the rule does not expire.
action : protect_configuration_rule_override_action;The action for the rule to either block or allow messages to the destination phone number.
*)destination_phone_number : phone_number;The destination phone number in E.164 format.
*)protect_configuration_id : protect_configuration_id_or_arn;The unique identifier for the protect configuration.
*)client_token : client_token option;Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
*)}type nonrec put_opted_out_number_result = {end_user_opted_out : Smaws_Lib.Smithy_api.Types.primitive_boolean option;This is true if it was the end user who requested their phone number be removed.
*)opted_out_timestamp : Smaws_Lib.Smithy_api.Types.timestamp option;opted_out_number : phone_number option;The phone number that was added to the OptOutList.
*)opt_out_list_name : opt_out_list_name option;The OptOutListName that the phone number was removed from.
*)opt_out_list_arn : Smaws_Lib.Smithy_api.Types.string_ option;The OptOutListArn that the phone number was removed from.
*)}type nonrec put_opted_out_number_request = {opted_out_number : phone_number;The phone number to add to the OptOutList in E.164 format.
*)opt_out_list_name : opt_out_list_name_or_arn;The OptOutListName or OptOutListArn to add the phone number to.
If you are using a shared End User Messaging SMS resource then you must use the full Amazon Resource Name(ARN).
*)}type nonrec put_message_feedback_result = {message_feedback_status : message_feedback_status;The current status of the message.
*)message_id : message_id;The unique identifier for the message.
*)}type nonrec put_message_feedback_request = {message_feedback_status : message_feedback_status;Set the message feedback to be either RECEIVED or FAILED.
message_id : message_id;The unique identifier for the message.
*)}type nonrec put_keyword_result = {keyword_action : keyword_action option;The action to perform when the keyword is used.
*)keyword_message : keyword_message option;The message associated with the keyword.
*)keyword : keyword option;The keyword that was added.
*)origination_identity : Smaws_Lib.Smithy_api.Types.string_ option;The PhoneNumberId or PoolId that the keyword was associated with.
*)origination_identity_arn : Smaws_Lib.Smithy_api.Types.string_ option;The PhoneNumberArn or PoolArn that the keyword was associated with.
*)}type nonrec put_keyword_request = {keyword_action : keyword_action option;The action to perform for the new keyword when it is received.
keyword_message : keyword_message;The message associated with the keyword.
*)keyword : keyword;The new keyword to add.
*)origination_identity : phone_or_pool_id_or_arn;The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use DescribePhoneNumbers get the values for PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used to get the values for SenderId and SenderIdArn.
If you are using a shared End User Messaging SMS resource then you must use the full Amazon Resource Name(ARN).
*)}type nonrec protect_configuration_rule_set_number_override = {expiration_timestamp : Smaws_Lib.Smithy_api.Types.timestamp option;The time the rule will expire at. If ExpirationTimestamp is not set then the rule will not expire.
iso_country_code : iso_country_code option;The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
*)action : protect_configuration_rule_override_action;The action for the rule to perform of either blocking or allowing messages to the destination phone number.
*)created_timestamp : Smaws_Lib.Smithy_api.Types.timestamp;destination_phone_number : phone_number;The destination phone number in E.164 format.
*)}Provides details on phone number rule overrides for a protect configuration.
type nonrec protect_configuration_rule_set_number_override_list =
protect_configuration_rule_set_number_override listtype nonrec protect_configuration_rule_set_number_override_filter_item = {values : filter_value_list;An array values to filter for.
*)name : protect_configuration_rule_set_number_override_filter_name;The name of the attribute to filter on.
*)}The information for a protect configuration rule set number override that meets a specified criteria.
type nonrec protect_configuration_information = {deletion_protection_enabled : Smaws_Lib.Smithy_api.Types.primitive_boolean;The status of deletion protection for the protect configuration. When set to true deletion protection is enabled. By default this is set to false.
*)account_default : Smaws_Lib.Smithy_api.Types.primitive_boolean;This is true if the protect configuration is set as your account default protect configuration.
*)created_timestamp : Smaws_Lib.Smithy_api.Types.timestamp;protect_configuration_id : protect_configuration_id;The unique identifier for the protect configuration.
*)protect_configuration_arn : protect_configuration_arn;The Amazon Resource Name (ARN) of the protect configuration.
*)}Provides information on the specified protect configuration.
type nonrec protect_configuration_information_list =
protect_configuration_information listtype nonrec protect_configuration_id_list =
protect_configuration_id_or_arn listtype nonrec protect_configuration_filter = {values : filter_value_list;An array of values to filter for.
*)name : protect_configuration_filter_name;The name of the attribute to filter on.
*)}The filter definition for filtering protect configurations that meet a specified criteria.
type nonrec protect_configuration_filter_list =
protect_configuration_filter listtype nonrec pool_origination_identities_filter = {values : filter_value_list;An array values to filter for.
*)name : pool_origination_identities_filter_name;The name of the attribute to filter on.
*)}Information about origination identities associated with a pool that meets a specified criteria.
type nonrec pool_origination_identities_filter_list =
pool_origination_identities_filter listtype nonrec pool_information = {created_timestamp : Smaws_Lib.Smithy_api.Types.timestamp;deletion_protection_enabled : Smaws_Lib.Smithy_api.Types.primitive_boolean;When set to true the pool can't be deleted.
*)opt_out_list_name : opt_out_list_name;The name of the OptOutList associated with the pool.
*)self_managed_opt_outs_enabled : Smaws_Lib.Smithy_api.Types.primitive_boolean;When set to false, an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, End User Messaging SMS automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests. For more information see Self-managed opt-outs
*)two_way_channel_role : iam_role_arn option;An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
*)two_way_channel_arn : two_way_channel_arn option;The Amazon Resource Name (ARN) of the two way channel.
*)two_way_enabled : Smaws_Lib.Smithy_api.Types.primitive_boolean;When set to true you can receive incoming text messages from your end recipients using the TwoWayChannelArn.
*)message_type : message_type;The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
*)status : pool_status;The current status of the pool.
*)pool_id : Smaws_Lib.Smithy_api.Types.string_;The unique identifier for the pool.
*)pool_arn : Smaws_Lib.Smithy_api.Types.string_;The Amazon Resource Name (ARN) for the pool.
*)}The information for a pool in an Amazon Web Services account.
type nonrec pool_information_list = pool_information listtype nonrec pool_id_list = pool_id_or_arn listtype nonrec pool_filter = {values : filter_value_list;An array values to filter for.
*)name : pool_filter_name;The name of the attribute to filter on.
*)}The information for a pool that meets a specified criteria.
type nonrec pool_filter_list = pool_filter listtype nonrec list_registration_associations_result = {next_token : next_token option;The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
*)registration_associations : registration_association_metadata_list;An array of RegistrationAssociationMetadata objects.
*)registration_type : registration_type;The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
registration_id : Smaws_Lib.Smithy_api.Types.string_;The unique identifier for the registration.
*)registration_arn : Smaws_Lib.Smithy_api.Types.string_;The Amazon Resource Name (ARN) for the registration.
*)}type nonrec list_registration_associations_request = {max_results : max_results option;The maximum number of results to return per each request.
*)next_token : next_token option;The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
*)filters : registration_association_filter_list option;An array of RegistrationAssociationFilter to apply to the results that are returned.
*)registration_id : registration_id_or_arn;The unique identifier for the registration.
*)}type nonrec list_protect_configuration_rule_set_number_overrides_result = {next_token : next_token option;The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
*)rule_set_number_overrides : protect_configuration_rule_set_number_override_list
option;An array of RuleSetNumberOverrides objects.
*)protect_configuration_id : protect_configuration_id;The unique identifier for the protect configuration.
*)protect_configuration_arn : protect_configuration_arn;The Amazon Resource Name (ARN) of the protect configuration.
*)}type nonrec list_protect_configuration_rule_set_number_override_filter =
protect_configuration_rule_set_number_override_filter_item listtype nonrec list_protect_configuration_rule_set_number_overrides_request = {max_results : max_results option;The maximum number of results to return per each request.
*)next_token : next_token option;The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
*)filters : list_protect_configuration_rule_set_number_override_filter option;An array of ProtectConfigurationRuleSetNumberOverrideFilterItem objects to filter the results.
*)protect_configuration_id : protect_configuration_id_or_arn;The unique identifier for the protect configuration.
*)}type nonrec origination_identity_metadata = {phone_number : phone_number option;The phone number in E.164 format.
*)number_capabilities : number_capability_list;Describes if the origination identity can be used for text messages, voice calls or both.
*)iso_country_code : iso_country_code;The two-character code, in ISO 3166-1 alpha-2 format, for the country or region. This field is optional and may not be present for origination identity types that are not country-specific, such as RCS agents.
*)origination_identity : Smaws_Lib.Smithy_api.Types.string_;The unique identifier of the origination identity.
*)origination_identity_arn : Smaws_Lib.Smithy_api.Types.string_;The Amazon Resource Name (ARN) associated with the origination identity.
*)}The metadata for an origination identity associated with a pool.
type nonrec origination_identity_metadata_list =
origination_identity_metadata listtype nonrec list_pool_origination_identities_result = {next_token : next_token option;The token to be used for the next set of paginated results. If this field is empty then there are no more results.
*)origination_identities : origination_identity_metadata_list option;An array of any OriginationIdentityMetadata objects.
*)pool_id : Smaws_Lib.Smithy_api.Types.string_ option;The unique PoolId of the pool.
*)pool_arn : Smaws_Lib.Smithy_api.Types.string_ option;The Amazon Resource Name (ARN) for the pool.
*)}type nonrec list_pool_origination_identities_request = {max_results : max_results option;The maximum number of results to return per each request.
*)next_token : next_token option;The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
*)filters : pool_origination_identities_filter_list option;An array of PoolOriginationIdentitiesFilter objects to filter the results..
*)pool_id : pool_id_or_arn;The unique identifier for the pool. This value can be either the PoolId or PoolArn.
If you are using a shared End User Messaging SMS resource then you must use the full Amazon Resource Name(ARN).
*)}type nonrec notify_use_case_list = notify_configuration_use_case listtype nonrec notify_tier_list = notify_configuration_tier listtype nonrec notify_country_information = {customer_owned_identity_required : Smaws_Lib.Smithy_api.Types.primitive_boolean;Whether a customer-owned identity is required to send notify messages to this country.
*)supported_tiers : notify_tier_list;An array of supported tiers for the country.
*)supported_use_cases : notify_use_case_list;An array of supported use cases for the country.
*)supported_channels : notify_enabled_channels_list;An array of supported channels for the country. Supported values include SMS and VOICE.
country_name : Smaws_Lib.Smithy_api.Types.string_;The name of the country.
*)iso_country_code : iso_country_code;The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
*)}The information for a country that supports notify messaging.
type nonrec notify_country_information_list = notify_country_information listtype nonrec list_notify_countries_result = {next_token : next_token option;The token to be used for the next set of paginated results. If this field is empty then there are no more results.
*)notify_countries : notify_country_information_list option;An array of NotifyCountryInformation objects that contain the results.
*)}type nonrec list_notify_countries_request = {max_results : max_results option;The maximum number of results to return per each request.
*)next_token : next_token option;The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
*)tier : notify_configuration_tier option;The tier to filter the results by.
*)use_cases : notify_use_case_list option;An array of use cases to filter the results by.
*)channels : notify_enabled_channels_list option;An array of channels to filter the results by.
*)}type nonrec get_resource_policy_result = {created_timestamp : Smaws_Lib.Smithy_api.Types.timestamp option;policy : resource_policy option;The JSON formatted string that contains the resource-based policy attached to the End User Messaging SMS resource.
*)resource_arn : amazon_resource_name option;The Amazon Resource Name (ARN) of the End User Messaging SMS resource attached to the resource-based policy.
*)}type nonrec get_resource_policy_request = {resource_arn : amazon_resource_name;The Amazon Resource Name (ARN) of the End User Messaging SMS resource attached to the resource-based policy.
*)}type nonrec get_protect_configuration_country_rule_set_result = {country_rule_set : protect_configuration_country_rule_set;A map of ProtectConfigurationCountryRuleSetInformation objects that contain the details for the requested NumberCapability. The Key is the two-letter ISO country code. For a list of supported ISO country codes, see Supported countries and regions (SMS channel) in the End User Messaging SMS User Guide.
*)number_capability : number_capability;The capability type associated with the returned ProtectConfigurationCountryRuleSetInformation objects.
*)protect_configuration_id : protect_configuration_id;The unique identifier for the protect configuration.
*)protect_configuration_arn : protect_configuration_arn;The Amazon Resource Name (ARN) of the protect configuration.
*)}type nonrec get_protect_configuration_country_rule_set_request = {number_capability : number_capability;The capability type to return the CountryRuleSet for. Valid values are SMS, VOICE, or MMS.
protect_configuration_id : protect_configuration_id_or_arn;The unique identifier for the protect configuration.
*)}type nonrec discard_registration_version_result = {registration_version_status_history : registration_version_status_history;The RegistrationVersionStatusHistory object contains the time stamps for when the reservations status changes.
*)registration_version_status : registration_version_status;The status of the registration version.
APPROVED: Your registration has been approved.ARCHIVED: Your previously approved registration version moves into this status when a more recently submitted version is approved.DENIED: You must fix your registration and resubmit it.DISCARDED: You've abandon this version of their registration to start over with a new version.DRAFT: The initial status of a registration version after it’s created.REQUIRES_AUTHENTICATION: You need to complete email authentication.REVIEWING: Your registration has been accepted and is being reviewed.REVOKED: Your previously approved registration has been revoked.SUBMITTED: Your registration has been submitted.version_number : registration_version_number;The version number of the registration.
*)registration_id : Smaws_Lib.Smithy_api.Types.string_;The unique identifier for the registration.
*)registration_arn : Smaws_Lib.Smithy_api.Types.string_;The Amazon Resource Name (ARN) for the registration.
*)}type nonrec discard_registration_version_request = {registration_id : registration_id_or_arn;The unique identifier for the registration.
*)}type nonrec disassociate_protect_configuration_result = {protect_configuration_id : protect_configuration_id;The unique identifier for the protect configuration.
*)protect_configuration_arn : protect_configuration_arn;The Amazon Resource Name (ARN) of the protect configuration.
*)configuration_set_name : configuration_set_name;The name of the ConfigurationSet.
*)configuration_set_arn : Smaws_Lib.Smithy_api.Types.string_;The Amazon Resource Name (ARN) of the configuration set.
*)}type nonrec disassociate_protect_configuration_request = {configuration_set_name : configuration_set_name_or_arn;The name of the ConfigurationSet.
*)protect_configuration_id : protect_configuration_id_or_arn;The unique identifier for the protect configuration.
*)}type nonrec disassociate_origination_identity_result = {iso_country_code : iso_country_code option;The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
*)origination_identity : Smaws_Lib.Smithy_api.Types.string_ option;The PhoneNumberId or SenderId of the origination identity.
*)origination_identity_arn : Smaws_Lib.Smithy_api.Types.string_ option;The PhoneNumberArn or SenderIdArn of the origination identity.
*)pool_id : Smaws_Lib.Smithy_api.Types.string_ option;The PoolId of the pool no longer associated with the origination identity.
*)pool_arn : Smaws_Lib.Smithy_api.Types.string_ option;The Amazon Resource Name (ARN) of the pool.
*)}type nonrec disassociate_origination_identity_request = {client_token : client_token option;Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
*)iso_country_code : iso_country_code option;The two-character code, in ISO 3166-1 alpha-2 format, for the country or region. This field is optional and is not required for origination identity types that are not country-specific, such as RCS agents.
*)origination_identity : phone_or_sender_id_or_arn;The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use DescribePhoneNumbers find the values for PhoneNumberId and PhoneNumberArn, or use DescribeSenderIds to get the values for SenderId and SenderIdArn.
If you are using a shared End User Messaging SMS resource then you must use the full Amazon Resource Name(ARN).
*)pool_id : pool_id_or_arn;The unique identifier for the pool to disassociate with the origination identity. This value can be either the PoolId or PoolArn.
If you are using a shared End User Messaging SMS resource then you must use the full Amazon Resource Name(ARN).
*)}type nonrec describe_verified_destination_numbers_result = {next_token : next_token option;The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
*)verified_destination_numbers : verified_destination_number_information_list;An array of VerifiedDestinationNumberInformation objects
*)}type nonrec destination_phone_number_list = phone_number listtype nonrec describe_verified_destination_numbers_request = {max_results : max_results option;The maximum number of results to return per each request.
*)next_token : next_token option;The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
*)filters : verified_destination_number_filter_list option;An array of VerifiedDestinationNumberFilter objects to filter the results.
*)destination_phone_numbers : destination_phone_number_list option;An array of verified destination phone number, in E.164 format.
*)verified_destination_number_ids : verified_destination_number_id_list option;An array of VerifiedDestinationNumberid to retrieve.
*)}type nonrec describe_spend_limits_result = {next_token : next_token option;The token to be used for the next set of paginated results. If this field is empty then there are no more results.
*)spend_limits : spend_limit_list option;An array of SpendLimit objects that contain the details for the requested spend limits.
*)}type nonrec describe_spend_limits_request = {max_results : max_results option;The maximum number of results to return per each request.
*)next_token : next_token option;The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
*)}type nonrec describe_sender_ids_result = {next_token : next_token option;The token to be used for the next set of paginated results. If this field is empty then there are no more results.
*)sender_ids : sender_id_information_list option;An array of SernderIdInformation objects that contain the details for the requested SenderIds.
*)}type nonrec describe_sender_ids_request = {owner : owner option;Use SELF to filter the list of Sender Ids to ones your account owns or use SHARED to filter on Sender Ids shared with your account. The Owner and SenderIds parameters can't be used at the same time.
max_results : max_results option;The maximum number of results to return per each request.
*)next_token : next_token option;The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
*)filters : sender_id_filter_list option;An array of SenderIdFilter objects to filter the results.
*)sender_ids : sender_id_list option;An array of SenderIdAndCountry objects to search for.
If you are using a shared End User Messaging SMS resource then you must use the full Amazon Resource Name(ARN).
*)}type nonrec describe_registration_versions_result = {next_token : next_token option;The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
*)registration_versions : registration_version_information_list;An array of RegistrationVersions objects.
*)registration_id : Smaws_Lib.Smithy_api.Types.string_;The unique identifier for the registration.
*)registration_arn : Smaws_Lib.Smithy_api.Types.string_;The Amazon Resource Name (ARN) for the registration.
*)}type nonrec describe_registration_versions_request = {max_results : max_results option;The maximum number of results to return per each request.
*)next_token : next_token option;The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
*)filters : registration_version_filter_list option;An array of RegistrationVersionFilter objects to filter the results.
*)version_numbers : registration_version_number_list option;An array of registration version numbers.
*)registration_id : registration_id_or_arn;The unique identifier for the registration.
*)}type nonrec describe_registration_type_definitions_result = {next_token : next_token option;The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
*)registration_type_definitions : registration_type_definition_list;The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
}type nonrec describe_registration_type_definitions_request = {max_results : max_results option;The maximum number of results to return per each request.
*)next_token : next_token option;The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
*)filters : registration_type_filter_list option;An array of RegistrationFilter objects to filter the results.
*)registration_types : registration_type_list option;The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
}type nonrec describe_registration_section_definitions_result = {next_token : next_token option;The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
*)registration_section_definitions : registration_section_definition_list;An array of RegistrationSectionDefinition objects.
*)registration_type : registration_type;The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
}type nonrec describe_registration_section_definitions_request = {max_results : max_results option;The maximum number of results to return per each request.
*)next_token : next_token option;The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
*)section_paths : section_path_list option;An array of paths for the registration form section.
*)registration_type : registration_type;The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
}type nonrec describe_registrations_result = {next_token : next_token option;The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
*)registrations : registration_information_list;An array of RegistrationInformation objects.
*)}type nonrec describe_registrations_request = {max_results : max_results option;The maximum number of results to return per each request.
*)next_token : next_token option;The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
*)filters : registration_filter_list option;An array of RegistrationFilter objects to filter the results.
*)registration_ids : registration_id_list option;An array of unique identifiers for each registration.
*)}type nonrec describe_registration_field_values_result = {next_token : next_token option;The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
*)registration_field_values : registration_field_value_information_list;An array of RegistrationFieldValues objects that contain the values for the requested registration.
*)version_number : registration_version_number;The current version of the registration.
*)registration_id : Smaws_Lib.Smithy_api.Types.string_;The unique identifier for the registration.
*)registration_arn : Smaws_Lib.Smithy_api.Types.string_;The Amazon Resource Name (ARN) for the registration.
*)}type nonrec field_path_list = field_path listtype nonrec describe_registration_field_values_request = {max_results : max_results option;The maximum number of results to return per each request.
*)next_token : next_token option;The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
*)field_paths : field_path_list option;An array of paths to the registration form field.
*)section_path : section_path option;The path to the section of the registration.
*)version_number : registration_version_number option;The version number of the registration.
*)registration_id : registration_id_or_arn;The unique identifier for the registration.
*)}type nonrec describe_registration_field_definitions_result = {next_token : next_token option;The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
*)registration_field_definitions : registration_field_definition_list;An array of RegistrationFieldDefinitions objects that contain the details for the requested fields.
*)registration_type : registration_type;The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
}type nonrec describe_registration_field_definitions_request = {max_results : max_results option;The maximum number of results to return per each request.
*)next_token : next_token option;The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
*)field_paths : field_path_list option;An array of paths to the registration form field.
*)section_path : section_path option;The path to the section of the registration.
*)registration_type : registration_type;The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
}type nonrec describe_registration_attachments_result = {next_token : next_token option;The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
*)registration_attachments : registration_attachments_information_list;An array of RegistrationAttachments objects that contain the details for the requested registration attachments.
*)}type nonrec describe_registration_attachments_request = {max_results : max_results option;The maximum number of results to return per each request.
*)next_token : next_token option;The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
*)filters : registration_attachment_filter_list option;An array of RegistrationAttachmentFilter objects to filter the results.
*)registration_attachment_ids : registration_attachment_id_list option;The unique identifier of registration attachments to find. This is an array of RegistrationAttachmentId.
*)}type nonrec describe_rcs_agents_result = {next_token : next_token option;The token to be used for the next set of paginated results. If this field is empty then there are no more results.
*)rcs_agents : rcs_agent_information_list option;An array of RcsAgentInformation objects that contain the details for the requested RCS agents.
*)}type nonrec describe_rcs_agents_request = {max_results : max_results option;The maximum number of results to return per each request.
*)next_token : next_token option;The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
*)filters : rcs_agent_filter_list option;An array of RcsAgentFilter objects to filter the results.
*)owner : owner option;Use SELF to filter the list of RCS agents to ones your account owns or use SHARED to filter on RCS agents shared with your account. The Owner and RcsAgentIds parameters can't be used at the same time.
rcs_agent_ids : rcs_agent_id_list option;An array of unique identifiers for the RCS agents. This is an array of strings that can be either the RcsAgentId or RcsAgentArn.
*)}type nonrec carrier_status_information = {status : carrier_status;The launch status for this carrier.
*)carrier_name : Smaws_Lib.Smithy_api.Types.string_;The name of the carrier.
*)}Contains carrier-level launch status details for an RCS agent within a country.
type nonrec carrier_status_information_list = carrier_status_information listtype nonrec country_launch_status_information = {carrier_status : carrier_status_information_list;An array of CarrierStatusInformation objects containing carrier-level launch status details.
*)registration_id : Smaws_Lib.Smithy_api.Types.string_;The unique identifier of the registration associated with this country launch.
*)rcs_platform_id : Smaws_Lib.Smithy_api.Types.string_ option;The RCS platform identifier for this country.
*)status : country_launch_status;The launch status for this country.
*)iso_country_code : iso_country_code;The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
*)}Contains per-country launch status details for an RCS agent.
type nonrec country_launch_status_information_list =
country_launch_status_information listtype nonrec describe_rcs_agent_country_launch_status_result = {next_token : next_token option;The token to be used for the next set of paginated results. If this field is empty then there are no more results.
*)country_launch_status : country_launch_status_information_list option;An array of CountryLaunchStatusInformation objects that contain the per-country launch status details.
*)rcs_agent_arn : Smaws_Lib.Smithy_api.Types.string_;The Amazon Resource Name (ARN) of the RCS agent.
*)rcs_agent_id : Smaws_Lib.Smithy_api.Types.string_;The unique identifier for the RCS agent.
*)}type nonrec country_launch_status_filter = {values : filter_value_list;An array values to filter for.
*)name : country_launch_status_filter_name;The name of the attribute to filter on.
*)}The information for a country launch status that meets a specified criteria.
type nonrec country_launch_status_filter_list =
country_launch_status_filter listtype nonrec describe_rcs_agent_country_launch_status_request = {next_token : next_token option;The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
*)max_results : max_results option;The maximum number of results to return per each request.
*)filters : country_launch_status_filter_list option;An array of CountryLaunchStatusFilter objects to filter the results.
*)iso_country_codes : iso_country_code_list option;An array of two-character ISO country codes, in ISO 3166-1 alpha-2 format, to filter the results.
*)rcs_agent_id : rcs_agent_id_or_arn;The unique identifier of the RCS agent. You can use either the RcsAgentId or RcsAgentArn.
*)}type nonrec describe_protect_configurations_result = {next_token : next_token option;The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
*)protect_configurations : protect_configuration_information_list option;An array of ProtectConfigurationInformation objects that contain the details for the request.
*)}type nonrec describe_protect_configurations_request = {max_results : max_results option;The maximum number of results to return per each request.
*)next_token : next_token option;The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
*)filters : protect_configuration_filter_list option;An array of ProtectConfigurationFilter objects to filter the results.
*)protect_configuration_ids : protect_configuration_id_list option;An array of protect configuration identifiers to search for.
*)}type nonrec describe_pools_result = {next_token : next_token option;The token to be used for the next set of paginated results. If this field is empty then there are no more results.
*)pools : pool_information_list option;An array of PoolInformation objects that contain the details for the requested pools.
*)}type nonrec describe_pools_request = {owner : owner option;Use SELF to filter the list of Pools to ones your account owns or use SHARED to filter on Pools shared with your account. The Owner and PoolIds parameters can't be used at the same time.
max_results : max_results option;The maximum number of results to return per each request.
*)next_token : next_token option;The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
*)filters : pool_filter_list option;An array of PoolFilter objects to filter the results.
*)pool_ids : pool_id_list option;The unique identifier of pools to find. This is an array of strings that can be either the PoolId or PoolArn.
If you are using a shared End User Messaging SMS resource then you must use the full Amazon Resource Name(ARN).
*)}type nonrec phone_number_information = {created_timestamp : Smaws_Lib.Smithy_api.Types.timestamp;registration_id : Smaws_Lib.Smithy_api.Types.string_ option;The unique identifier for the registration.
*)pool_id : Smaws_Lib.Smithy_api.Types.string_ option;The unique identifier of the pool associated with the phone number.
*)deletion_protection_enabled : Smaws_Lib.Smithy_api.Types.primitive_boolean;When set to true the phone number can't be deleted.
*)international_sending_enabled : Smaws_Lib.Smithy_api.Types.primitive_boolean
option;When set to true the international sending of phone number is Enabled.
*)opt_out_list_name : opt_out_list_name;The name of the OptOutList associated with the phone number.
*)self_managed_opt_outs_enabled : Smaws_Lib.Smithy_api.Types.primitive_boolean;When set to false and an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, End User Messaging SMS automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out request. For more information see Self-managed opt-outs
*)two_way_channel_role : iam_role_arn option;An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
*)two_way_channel_arn : two_way_channel_arn option;The Amazon Resource Name (ARN) of the two way channel.
*)two_way_enabled : Smaws_Lib.Smithy_api.Types.primitive_boolean;By default this is set to false. When set to true you can receive incoming text messages from your end recipients using the TwoWayChannelArn.
*)monthly_leasing_price : Smaws_Lib.Smithy_api.Types.string_;The price, in US dollars, to lease the phone number.
*)number_type : number_type;The type of phone number.
*)number_capabilities : number_capability_list;Describes if the origination identity can be used for text messages, voice calls or both.
*)message_type : message_type;The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
*)iso_country_code : iso_country_code;The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
*)status : number_status;The current status of the phone number.
*)phone_number : phone_number;The phone number in E.164 format.
*)phone_number_id : Smaws_Lib.Smithy_api.Types.string_ option;The unique identifier for the phone number.
*)phone_number_arn : Smaws_Lib.Smithy_api.Types.string_;The Amazon Resource Name (ARN) associated with the phone number.
*)}The information for a phone number, in E.164 format, in an Amazon Web Services account.
type nonrec phone_number_information_list = phone_number_information listtype nonrec describe_phone_numbers_result = {next_token : next_token option;The token to be used for the next set of paginated results. If this field is empty then there are no more results.
*)phone_numbers : phone_number_information_list option;An array of PhoneNumberInformation objects that contain the details for the requested phone numbers.
*)}type nonrec phone_number_id_list = phone_number_id_or_arn listtype nonrec phone_number_filter = {values : filter_value_list;An array values to filter for.
*)name : phone_number_filter_name;The name of the attribute to filter on.
*)}The information for a phone number that meets a specified criteria.
type nonrec phone_number_filter_list = phone_number_filter listtype nonrec describe_phone_numbers_request = {owner : owner option;Use SELF to filter the list of phone numbers to ones your account owns or use SHARED to filter on phone numbers shared with your account. The Owner and PhoneNumberIds parameters can't be used at the same time.
max_results : max_results option;The maximum number of results to return per each request.
*)next_token : next_token option;The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
*)filters : phone_number_filter_list option;An array of PhoneNumberFilter objects to filter the results.
*)phone_number_ids : phone_number_id_list option;The unique identifier of phone numbers to find information about. This is an array of strings that can be either the PhoneNumberId or PhoneNumberArn.
If you are using a shared End User Messaging SMS resource then you must use the full Amazon Resource Name(ARN).
*)}type nonrec opt_out_list_information = {created_timestamp : Smaws_Lib.Smithy_api.Types.timestamp;opt_out_list_name : opt_out_list_name;The name of the OptOutList.
*)opt_out_list_arn : Smaws_Lib.Smithy_api.Types.string_;The Amazon Resource Name (ARN) of the OptOutList.
*)}The information for all OptOutList in an Amazon Web Services account.
type nonrec opt_out_list_information_list = opt_out_list_information listtype nonrec describe_opt_out_lists_result = {next_token : next_token option;The token to be used for the next set of paginated results. If this field is empty then there are no more results.
*)opt_out_lists : opt_out_list_information_list option;An array of OptOutListInformation objects that contain the details for the requested OptOutLists.
*)}type nonrec opt_out_list_name_list = opt_out_list_name_or_arn listtype nonrec describe_opt_out_lists_request = {owner : owner option;Use SELF to filter the list of Opt-Out List to ones your account owns or use SHARED to filter on Opt-Out List shared with your account. The Owner and OptOutListNames parameters can't be used at the same time.
max_results : max_results option;The maximum number of results to return per each request.
*)next_token : next_token option;The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
*)opt_out_list_names : opt_out_list_name_list option;The OptOutLists to show the details of. This is an array of strings that can be either the OptOutListName or OptOutListArn.
If you are using a shared End User Messaging SMS resource then you must use the full Amazon Resource Name(ARN).
*)}type nonrec opted_out_number_information = {end_user_opted_out : Smaws_Lib.Smithy_api.Types.primitive_boolean;This is set to true if it was the end recipient that opted out.
*)opted_out_timestamp : Smaws_Lib.Smithy_api.Types.timestamp;opted_out_number : phone_number;The phone number that is opted out.
*)}The information for an opted out number in an Amazon Web Services account.
type nonrec opted_out_number_information_list =
opted_out_number_information listtype nonrec describe_opted_out_numbers_result = {next_token : next_token option;The token to be used for the next set of paginated results. If this field is empty then there are no more results.
*)opted_out_numbers : opted_out_number_information_list option;An array of OptedOutNumbersInformation objects that provide information about the requested OptedOutNumbers.
*)opt_out_list_name : opt_out_list_name option;The name of the OptOutList.
*)opt_out_list_arn : Smaws_Lib.Smithy_api.Types.string_ option;The Amazon Resource Name (ARN) of the OptOutList.
*)}type nonrec opted_out_number_list = phone_number listtype nonrec opted_out_filter = {values : filter_value_list;An array of values to filter for.
*)name : opted_out_filter_name;The name of the attribute to filter on.
*)}The information for opted out numbers that meet a specified criteria.
type nonrec opted_out_filter_list = opted_out_filter listtype nonrec describe_opted_out_numbers_request = {max_results : max_results option;The maximum number of results to return per each request.
*)next_token : next_token option;The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
*)filters : opted_out_filter_list option;An array of OptedOutFilter objects to filter the results on.
*)opted_out_numbers : opted_out_number_list option;An array of phone numbers to search for in the OptOutList.
If you specify an opted out number that isn't valid, an exception is returned.
*)opt_out_list_name : opt_out_list_name_or_arn;The OptOutListName or OptOutListArn of the OptOutList. You can use DescribeOptOutLists to find the values for OptOutListName and OptOutListArn.
If you are using a shared End User Messaging SMS resource then you must use the full Amazon Resource Name(ARN).
*)}type nonrec notify_configuration_tier_list = notify_configuration_tier listtype nonrec notify_template_information = {created_timestamp : Smaws_Lib.Smithy_api.Types.timestamp;supported_voice_ids : voice_id_list option;An array of supported voice IDs for voice templates.
*)variables : template_variables_map option;An array of template variable metadata for the template.
*)content : template_content option;The content of the template.
*)language_code : notify_language_code option;The language code for the template.
*)supported_countries : iso_country_code_list option;An array of supported country codes for the template.
*)status : notify_template_status option;The current status of the template.
*)tier_access : notify_configuration_tier_list option;The tier access level for the template.
*)channels : number_capability_list;The channels for the template. Supported values are SMS and VOICE.
template_type : notify_template_type;The type of the template.
*)version : notify_template_version;The version of the template.
*)template_id : notify_template_id;The unique identifier for the template.
*)}The information for a system-managed notify template in an Amazon Web Services account.
type nonrec notify_template_information_list = notify_template_information listtype nonrec describe_notify_templates_result = {next_token : next_token option;The token to be used for the next set of paginated results. If this field is empty then there are no more results.
*)notify_templates : notify_template_information_list option;An array of NotifyTemplateInformation objects that contain the results.
*)}type nonrec notify_template_id_list = notify_template_id listtype nonrec notify_template_filter = {values : filter_value_list;An array values to filter for.
*)name : notify_template_filter_name;The name of the attribute to filter on.
*)}The information for notify templates that meet a specified criteria.
type nonrec notify_template_filter_list = notify_template_filter listtype nonrec describe_notify_templates_request = {max_results : max_results option;The maximum number of results to return per each request.
*)next_token : next_token option;The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
*)filters : notify_template_filter_list option;An array of NotifyTemplateFilter objects to filter the results on.
*)template_ids : notify_template_id_list option;An array of template IDs to describe.
*)}type nonrec notify_configuration_information = {created_timestamp : Smaws_Lib.Smithy_api.Types.timestamp;deletion_protection_enabled : Smaws_Lib.Smithy_api.Types.primitive_boolean;When set to true deletion protection is enabled. By default this is set to false.
*)rejection_reason : Smaws_Lib.Smithy_api.Types.string_ option;The reason the notify configuration was rejected, if applicable.
*)status : notify_configuration_status;The current status of the notify configuration.
*)tier_upgrade_status : tier_upgrade_status;The tier upgrade status of the notify configuration.
*)tier : notify_configuration_tier;The tier of the notify configuration.
*)enabled_channels : notify_enabled_channels_list;An array of channels enabled for the notify configuration. Supported values include SMS and VOICE.
enabled_countries : iso_country_code_list option;An array of two-character ISO country codes, in ISO 3166-1 alpha-2 format, that are enabled for the notify configuration.
*)pool_id : Smaws_Lib.Smithy_api.Types.string_ option;The identifier of the pool associated with the notify configuration.
*)default_template_id : notify_template_id option;The default template identifier associated with the notify configuration.
*)use_case : notify_configuration_use_case;The use case for the notify configuration.
*)display_name : notify_configuration_display_name;The display name associated with the notify configuration.
*)notify_configuration_id : notify_configuration_id;The unique identifier for the notify configuration.
*)notify_configuration_arn : notify_configuration_arn;The Amazon Resource Name (ARN) for the notify configuration.
*)}The information for a notify configuration in an Amazon Web Services account.
type nonrec notify_configuration_information_list =
notify_configuration_information listtype nonrec describe_notify_configurations_result = {next_token : next_token option;The token to be used for the next set of paginated results. If this field is empty then there are no more results.
*)notify_configurations : notify_configuration_information_list option;An array of NotifyConfigurationInformation objects that contain the results.
*)}type nonrec notify_configuration_id_list = notify_configuration_id_or_arn listtype nonrec notify_configuration_filter = {values : filter_value_list;An array values to filter for.
*)name : notify_configuration_filter_name;The name of the attribute to filter on.
*)}The information for notify configurations that meet a specified criteria.
type nonrec notify_configuration_filter_list = notify_configuration_filter listtype nonrec describe_notify_configurations_request = {max_results : max_results option;The maximum number of results to return per each request.
*)next_token : next_token option;The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
*)filters : notify_configuration_filter_list option;An array of NotifyConfigurationFilter objects to filter the results on.
*)notify_configuration_ids : notify_configuration_id_list option;An array of notify configuration IDs to describe.
*)}type nonrec keyword_information = {keyword_action : keyword_action;The action to perform for the keyword.
*)keyword_message : keyword_message;A custom message that can be used with the keyword.
*)keyword : keyword;The keyword as a string.
*)}The information for all keywords in a pool.
type nonrec keyword_information_list = keyword_information listtype nonrec describe_keywords_result = {next_token : next_token option;The token to be used for the next set of paginated results. If this field is empty then there are no more results.
*)keywords : keyword_information_list option;An array of KeywordInformation objects that contain the results.
*)origination_identity : Smaws_Lib.Smithy_api.Types.string_ option;The PhoneNumberId or PoolId that is associated with the OriginationIdentity.
*)origination_identity_arn : Smaws_Lib.Smithy_api.Types.string_ option;The PhoneNumberArn or PoolArn that is associated with the OriginationIdentity.
*)}type nonrec keyword_list = keyword listtype nonrec keyword_filter = {values : filter_value_list;An array values to filter for.
*)name : keyword_filter_name;The name of the attribute to filter on.
*)}The information for keywords that meet a specified criteria.
type nonrec keyword_filter_list = keyword_filter listtype nonrec describe_keywords_request = {max_results : max_results option;The maximum number of results to return per each request.
*)next_token : next_token option;The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
*)filters : keyword_filter_list option;An array of keyword filters to filter the results.
*)keywords : keyword_list option;An array of keywords to search for.
*)origination_identity : phone_or_pool_id_or_arn;The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use DescribePhoneNumbers to find the values for PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used to get the values for SenderId and SenderIdArn.
If you are using a shared End User Messaging SMS resource then you must use the full Amazon Resource Name(ARN).
*)}type nonrec event_destination_list = event_destination listtype nonrec configuration_set_information = {protect_configuration_id : protect_configuration_id_or_arn option;The unique identifier for the protect configuration.
*)created_timestamp : Smaws_Lib.Smithy_api.Types.timestamp;default_message_feedback_enabled : Smaws_Lib.Smithy_api.Types.boolean_ option;True if message feedback is enabled.
*)default_sender_id : sender_id option;The default sender ID used by the ConfigurationSet.
*)default_message_type : message_type option;The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.
*)event_destinations : event_destination_list;An array of EventDestination objects that describe any events to log and where to log them.
*)configuration_set_name : configuration_set_name;The name of the ConfigurationSet.
*)configuration_set_arn : Smaws_Lib.Smithy_api.Types.string_;The Resource Name (ARN) of the ConfigurationSet.
*)}Information related to a given configuration set in your Amazon Web Services account.
type nonrec configuration_set_information_list =
configuration_set_information listtype nonrec describe_configuration_sets_result = {next_token : next_token option;The token to be used for the next set of paginated results. If this field is empty then there are no more results.
*)configuration_sets : configuration_set_information_list option;An array of ConfigurationSets objects.
*)}type nonrec configuration_set_name_list = configuration_set_name_or_arn listtype nonrec configuration_set_filter = {values : filter_value_list;An array values to filter for.
*)name : configuration_set_filter_name;The name of the attribute to filter on.
*)}The information for configuration sets that meet a specified criteria.
type nonrec configuration_set_filter_list = configuration_set_filter listtype nonrec describe_configuration_sets_request = {max_results : max_results option;The maximum number of results to return per each request.
*)next_token : next_token option;The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
*)filters : configuration_set_filter_list option;An array of filters to apply to the results that are returned.
*)configuration_set_names : configuration_set_name_list option;An array of strings. Each element can be either a ConfigurationSetName or ConfigurationSetArn.
*)}type nonrec account_limit = {max : Smaws_Lib.Smithy_api.Types.primitive_long;The Amazon Web Services set limit for that resource type, in US dollars.
*)used : Smaws_Lib.Smithy_api.Types.primitive_long;The current amount that has been spent, in US dollars.
*)name : account_limit_name;The name of the attribute to apply the account limit to.
*)}The current resource quotas associated with an Amazon Web Services account.
type nonrec account_limit_list = account_limit listtype nonrec describe_account_limits_result = {next_token : next_token option;The token to be used for the next set of paginated results. If this field is empty then there are no more results.
*)account_limits : account_limit_list option;An array of AccountLimit objects that show the current spend limits.
*)}type nonrec describe_account_limits_request = {max_results : max_results option;The maximum number of results to return per each request.
*)next_token : next_token option;The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
*)}type nonrec account_attribute = {value : Smaws_Lib.Smithy_api.Types.string_;The value associated with the account attribute name.
*)name : account_attribute_name;The name of the account attribute.
*)}Displays the attributes associated with a single Amazon Web Services account.
type nonrec account_attribute_list = account_attribute listtype nonrec describe_account_attributes_result = {next_token : next_token option;The token to be used for the next set of paginated results. If this field is empty then there are no more results.
*)account_attributes : account_attribute_list option;An array of AccountAttributes objects.
*)}type nonrec describe_account_attributes_request = {max_results : max_results option;The maximum number of results to return per each request.
*)next_token : next_token option;The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
*)}type nonrec delete_voice_message_spend_limit_override_result = {monthly_limit : monthly_limit option;The current monthly limit, in US dollars.
*)}type nonrec delete_verified_destination_number_result = {created_timestamp : Smaws_Lib.Smithy_api.Types.timestamp;destination_phone_number : phone_number;The verified destination phone number, in E.164 format.
*)verified_destination_number_id : Smaws_Lib.Smithy_api.Types.string_;The unique identifier for the verified destination phone number.
*)verified_destination_number_arn : Smaws_Lib.Smithy_api.Types.string_;The Amazon Resource Name (ARN) for the verified destination phone number.
*)}type nonrec delete_verified_destination_number_request = {verified_destination_number_id : verified_destination_number_id_or_arn;The unique identifier for the verified destination phone number.
*)}type nonrec delete_text_message_spend_limit_override_result = {monthly_limit : monthly_limit option;The current monthly limit, in US dollars.
*)}type nonrec delete_resource_policy_result = {created_timestamp : Smaws_Lib.Smithy_api.Types.timestamp option;policy : resource_policy option;The JSON formatted resource-based policy that was deleted.
*)resource_arn : amazon_resource_name option;The Amazon Resource Name (ARN) of the End User Messaging SMS resource that the resource-based policy was deleted from.
*)}type nonrec delete_resource_policy_request = {resource_arn : amazon_resource_name;The Amazon Resource Name (ARN) of the End User Messaging SMS resource you're deleting the resource-based policy from.
*)}type nonrec delete_registration_field_value_result = {registration_attachment_id : Smaws_Lib.Smithy_api.Types.string_ option;The unique identifier for the registration attachment.
*)text_value : text_value option;The text data for a free form field.
*)select_choices : select_choice_list option;An array of values for the form field.
*)field_path : field_path;The path to the registration form field.
*)version_number : registration_version_number;The version number of the registration.
*)registration_id : Smaws_Lib.Smithy_api.Types.string_;The unique identifier for the registration.
*)registration_arn : Smaws_Lib.Smithy_api.Types.string_;The Amazon Resource Name (ARN) for the registration.
*)}type nonrec delete_registration_field_value_request = {field_path : field_path;The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of FieldPaths.
registration_id : registration_id_or_arn;The unique identifier for the registration.
*)}type nonrec delete_registration_attachment_result = {created_timestamp : Smaws_Lib.Smithy_api.Types.timestamp;attachment_upload_error_reason : attachment_upload_error_reason option;The error message if the upload failed.
*)attachment_status : attachment_status;The status of the registration attachment.
UPLOAD_IN_PROGRESS The attachment is being uploaded.UPLOAD_COMPLETE The attachment has been uploaded.UPLOAD_FAILED The attachment failed to uploaded.DELETED The attachment has been deleted..registration_attachment_id : Smaws_Lib.Smithy_api.Types.string_;The unique identifier for the registration attachment.
*)registration_attachment_arn : Smaws_Lib.Smithy_api.Types.string_;The Amazon Resource Name (ARN) for the registration attachment.
*)}type nonrec delete_registration_attachment_request = {registration_attachment_id : registration_attachment_id_or_arn;The unique identifier for the registration attachment.
*)}type nonrec delete_registration_result = {created_timestamp : Smaws_Lib.Smithy_api.Types.timestamp;additional_attributes : string_map option;Metadata about a given registration which is specific to that registration type.
*)latest_denied_version_number : registration_version_number option;The latest version number of the registration that was denied.
*)approved_version_number : registration_version_number option;The version number of the registration that was approved.
*)current_version_number : registration_version_number;The current version number of the registration.
*)registration_status : registration_status;The status of the registration.
CLOSED: The phone number or sender ID has been deleted and you must also delete the registration for the number.CREATED: Your registration is created but not submitted.COMPLETE: Your registration has been approved and your origination identity has been created.DELETED: The registration has been deleted.PROVISIONING: Your registration has been approved and your origination identity is being created.REQUIRES_AUTHENTICATION: You need to complete email authentication.REQUIRES_UPDATES: You must fix your registration and resubmit it.REVIEWING: Your registration has been accepted and is being reviewed.SUBMITTED: Your registration has been submitted and is awaiting review.registration_type : registration_type;The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
registration_id : Smaws_Lib.Smithy_api.Types.string_;The unique identifier for the registration.
*)registration_arn : Smaws_Lib.Smithy_api.Types.string_;The Amazon Resource Name (ARN) for the registration.
*)}type nonrec delete_registration_request = {registration_id : registration_id_or_arn;The unique identifier for the registration.
*)}type nonrec delete_rcs_message_spend_limit_override_result = {monthly_limit : monthly_limit option;The current monthly limit to enforce on RCS message spending.
*)}type nonrec delete_rcs_agent_result = {two_way_rcs_events_enabled : rcs_event_type_list option;The list of RCS event types that were enabled for two-way messaging on the deleted agent.
*)two_way_enabled : Smaws_Lib.Smithy_api.Types.primitive_boolean;By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
*)two_way_channel_role : iam_role_arn option;An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
*)two_way_channel_arn : two_way_channel_arn option;The Amazon Resource Name (ARN) of the two way channel.
*)self_managed_opt_outs_enabled : Smaws_Lib.Smithy_api.Types.primitive_boolean;By default this is set to false. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
*)opt_out_list_name : opt_out_list_name option;The name of the OptOutList that was associated with the deleted RCS agent.
*)deletion_protection_enabled : Smaws_Lib.Smithy_api.Types.primitive_boolean;When set to true deletion protection is enabled. By default this is set to false.
*)created_timestamp : Smaws_Lib.Smithy_api.Types.timestamp;status : rcs_agent_status;The current status of the RCS agent.
*)rcs_agent_id : Smaws_Lib.Smithy_api.Types.string_;The unique identifier for the deleted RCS agent.
*)rcs_agent_arn : Smaws_Lib.Smithy_api.Types.string_;The Amazon Resource Name (ARN) of the deleted RCS agent.
*)}type nonrec delete_rcs_agent_request = {rcs_agent_id : rcs_agent_id_or_arn;The unique identifier of the RCS agent to delete. You can use either the RcsAgentId or RcsAgentArn.
*)}type nonrec delete_protect_configuration_rule_set_number_override_result = {expiration_timestamp : Smaws_Lib.Smithy_api.Types.timestamp option;iso_country_code : iso_country_code option;The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
*)action : protect_configuration_rule_override_action;The action associated with the rule.
*)created_timestamp : Smaws_Lib.Smithy_api.Types.timestamp;destination_phone_number : phone_number;The destination phone number in E.164 format.
*)protect_configuration_id : protect_configuration_id;The unique identifier for the protect configuration.
*)protect_configuration_arn : protect_configuration_arn;The Amazon Resource Name (ARN) of the protect configuration.
*)}type nonrec delete_protect_configuration_rule_set_number_override_request = {destination_phone_number : phone_number;The destination phone number in E.164 format.
*)protect_configuration_id : protect_configuration_id_or_arn;The unique identifier for the protect configuration.
*)}type nonrec delete_protect_configuration_result = {deletion_protection_enabled : Smaws_Lib.Smithy_api.Types.primitive_boolean;The status of deletion protection for the protect configuration. When set to true deletion protection is enabled. By default this is set to false.
*)account_default : Smaws_Lib.Smithy_api.Types.primitive_boolean;This is true if the protect configuration is set as your account default protect configuration.
*)created_timestamp : Smaws_Lib.Smithy_api.Types.timestamp;protect_configuration_id : protect_configuration_id;The unique identifier for the protect configuration.
*)protect_configuration_arn : protect_configuration_arn;The Amazon Resource Name (ARN) of the protect configuration.
*)}type nonrec delete_protect_configuration_request = {protect_configuration_id : protect_configuration_id_or_arn;The unique identifier for the protect configuration.
*)}type nonrec delete_pool_result = {created_timestamp : Smaws_Lib.Smithy_api.Types.timestamp option;opt_out_list_name : opt_out_list_name option;The name of the OptOutList that was associated with the deleted pool.
*)self_managed_opt_outs_enabled : Smaws_Lib.Smithy_api.Types.primitive_boolean
option;By default this is set to false. When set to false and an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, End User Messaging SMS automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
*)two_way_channel_role : iam_role_arn option;An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
*)two_way_channel_arn : two_way_channel_arn option;The Amazon Resource Name (ARN) of the TwoWayChannel.
*)two_way_enabled : Smaws_Lib.Smithy_api.Types.primitive_boolean option;By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
*)message_type : message_type option;The message type that was associated with the deleted pool.
*)status : pool_status option;The current status of the pool.
pool_id : Smaws_Lib.Smithy_api.Types.string_ option;The PoolId of the pool that was deleted.
*)pool_arn : Smaws_Lib.Smithy_api.Types.string_ option;The Amazon Resource Name (ARN) of the pool that was deleted.
*)}type nonrec delete_pool_request = {pool_id : pool_id_or_arn;The PoolId or PoolArn of the pool to delete. You can use DescribePools to find the values for PoolId and PoolArn .
If you are using a shared End User Messaging SMS resource then you must use the full Amazon Resource Name(ARN).
*)}type nonrec delete_opt_out_list_result = {created_timestamp : Smaws_Lib.Smithy_api.Types.timestamp option;opt_out_list_name : opt_out_list_name option;The name of the OptOutList that was removed.
*)opt_out_list_arn : Smaws_Lib.Smithy_api.Types.string_ option;The Amazon Resource Name (ARN) of the OptOutList that was removed.
*)}type nonrec delete_opt_out_list_request = {opt_out_list_name : opt_out_list_name_or_arn;The OptOutListName or OptOutListArn of the OptOutList to delete. You can use DescribeOptOutLists to find the values for OptOutListName and OptOutListArn.
If you are using a shared End User Messaging SMS resource then you must use the full Amazon Resource Name(ARN).
*)}type nonrec delete_opted_out_number_result = {end_user_opted_out : Smaws_Lib.Smithy_api.Types.primitive_boolean option;This is true if it was the end user who requested their phone number be removed.
*)opted_out_timestamp : Smaws_Lib.Smithy_api.Types.timestamp option;opted_out_number : phone_number option;The phone number that was removed from the OptOutList.
*)opt_out_list_name : opt_out_list_name option;The OptOutListName that the phone number was removed from.
*)opt_out_list_arn : Smaws_Lib.Smithy_api.Types.string_ option;The OptOutListArn that the phone number was removed from.
*)}type nonrec delete_opted_out_number_request = {opted_out_number : phone_number;The phone number, in E.164 format, to remove from the OptOutList.
*)opt_out_list_name : opt_out_list_name_or_arn;The OptOutListName or OptOutListArn to remove the phone number from.
If you are using a shared End User Messaging SMS resource then you must use the full Amazon Resource Name(ARN).
*)}type nonrec delete_notify_message_spend_limit_override_result = {monthly_limit : monthly_limit option;The current monthly limit, in US dollars.
*)}type nonrec delete_notify_configuration_result = {created_timestamp : Smaws_Lib.Smithy_api.Types.timestamp;deletion_protection_enabled : Smaws_Lib.Smithy_api.Types.primitive_boolean;When set to true deletion protection is enabled. By default this is set to false.
*)rejection_reason : Smaws_Lib.Smithy_api.Types.string_ option;The reason the notify configuration was rejected, if applicable.
*)status : notify_configuration_status;The current status of the notify configuration.
*)tier_upgrade_status : tier_upgrade_status;The tier upgrade status of the notify configuration.
*)tier : notify_configuration_tier;The tier of the notify configuration.
*)enabled_channels : notify_enabled_channels_list;An array of channels enabled for the notify configuration. Supported values include SMS and VOICE.
enabled_countries : iso_country_code_list option;An array of two-character ISO country codes, in ISO 3166-1 alpha-2 format, that are enabled for the notify configuration.
*)pool_id : Smaws_Lib.Smithy_api.Types.string_ option;The identifier of the pool associated with the notify configuration.
*)default_template_id : notify_template_id option;The default template identifier associated with the notify configuration.
*)use_case : notify_configuration_use_case;The use case for the notify configuration.
*)display_name : notify_configuration_display_name;The display name associated with the notify configuration.
*)notify_configuration_id : notify_configuration_id;The unique identifier for the notify configuration.
*)notify_configuration_arn : notify_configuration_arn;The Amazon Resource Name (ARN) for the notify configuration.
*)}type nonrec delete_notify_configuration_request = {notify_configuration_id : notify_configuration_id_or_arn;The identifier of the notify configuration to delete. The NotifyConfigurationId can be found using the DescribeNotifyConfigurations operation.
}type nonrec delete_media_message_spend_limit_override_result = {monthly_limit : monthly_limit option;The current monthly limit, in US dollars.
*)}type nonrec delete_keyword_result = {keyword_action : keyword_action option;The action that was associated with the deleted keyword.
*)keyword_message : keyword_message option;The message that was associated with the deleted keyword.
*)keyword : keyword option;The keyword that was deleted.
*)origination_identity : Smaws_Lib.Smithy_api.Types.string_ option;The PhoneNumberId or PoolId that the keyword was associated with.
*)origination_identity_arn : Smaws_Lib.Smithy_api.Types.string_ option;The PhoneNumberArn or PoolArn that the keyword was associated with.
*)}type nonrec delete_keyword_request = {keyword : keyword;The keyword to delete.
*)origination_identity : phone_or_pool_id_or_arn;The origination identity to use such as a PhoneNumberId, PhoneNumberArn, PoolId or PoolArn. You can use DescribePhoneNumbers to find the values for PhoneNumberId and PhoneNumberArn and DescribePools to find the values of PoolId and PoolArn.
If you are using a shared End User Messaging SMS resource then you must use the full Amazon Resource Name(ARN).
*)}type nonrec delete_event_destination_result = {event_destination : event_destination option;The event destination object that was deleted.
*)configuration_set_name : configuration_set_name option;The name of the configuration set the event destination was deleted from.
*)configuration_set_arn : Smaws_Lib.Smithy_api.Types.string_ option;The Amazon Resource Name (ARN) of the configuration set.
*)}type nonrec delete_event_destination_request = {event_destination_name : event_destination_name;The name of the event destination to delete.
*)configuration_set_name : configuration_set_name_or_arn;The name of the configuration set or the configuration set's Amazon Resource Name (ARN) to remove the event destination from. The ConfigurateSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets action.
}type nonrec delete_default_sender_id_result = {sender_id : sender_id option;The current sender ID for the configuration set.
*)configuration_set_name : configuration_set_name option;The name of the configuration set.
*)configuration_set_arn : Smaws_Lib.Smithy_api.Types.string_ option;The Amazon Resource Name (ARN) of the configuration set.
*)}type nonrec delete_default_sender_id_request = {configuration_set_name : configuration_set_name_or_arn;The name of the configuration set or the configuration set Amazon Resource Name (ARN) to delete the default sender ID from. The ConfigurationSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets action.
}type nonrec delete_default_message_type_result = {message_type : message_type option;The current message type for the configuration set.
*)configuration_set_name : configuration_set_name option;The name of the configuration set.
*)configuration_set_arn : Smaws_Lib.Smithy_api.Types.string_ option;The Amazon Resource Name (ARN) of the configuration set.
*)}type nonrec delete_default_message_type_request = {configuration_set_name : configuration_set_name_or_arn;The name of the configuration set or the configuration set Amazon Resource Name (ARN) to delete the default message type from. The ConfigurationSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets action.
}type nonrec delete_configuration_set_result = {created_timestamp : Smaws_Lib.Smithy_api.Types.timestamp option;default_message_feedback_enabled : Smaws_Lib.Smithy_api.Types.boolean_ option;True if the configuration set has message feedback enabled. By default this is set to false.
*)default_sender_id : sender_id option;The default Sender ID of the configuration set that was deleted.
*)default_message_type : message_type option;The default message type of the configuration set that was deleted.
*)event_destinations : event_destination_list option;An array of any EventDestination objects that were associated with the deleted configuration set.
*)configuration_set_name : configuration_set_name option;The name of the deleted configuration set.
*)configuration_set_arn : Smaws_Lib.Smithy_api.Types.string_ option;The Amazon Resource Name (ARN) of the deleted configuration set.
*)}type nonrec delete_configuration_set_request = {configuration_set_name : configuration_set_name_or_arn;The name of the configuration set or the configuration set ARN that you want to delete. The ConfigurationSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets action.
}type nonrec delete_account_default_protect_configuration_result = {default_protect_configuration_id : protect_configuration_id;The unique identifier of the account default protect configuration.
*)default_protect_configuration_arn : protect_configuration_arn;The Amazon Resource Name (ARN) of the account default protect configuration.
*)}type nonrec create_verified_destination_number_result = {created_timestamp : Smaws_Lib.Smithy_api.Types.timestamp;rcs_agent_id : Smaws_Lib.Smithy_api.Types.string_ option;The unique identifier of the RCS agent associated with the verified destination number.
*)status : verification_status;The status of the verified destination phone number.
PENDING: The phone number hasn't been verified yet.VERIFIED: The phone number is verified and can receive messages.destination_phone_number : phone_number;The verified destination phone number, in E.164 format.
*)verified_destination_number_id : Smaws_Lib.Smithy_api.Types.string_;The unique identifier for the verified destination phone number.
*)verified_destination_number_arn : Smaws_Lib.Smithy_api.Types.string_;The Amazon Resource Name (ARN) for the verified destination phone number.
*)}type nonrec create_verified_destination_number_request = {client_token : client_token option;Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
*)rcs_agent_id : rcs_agent_id_or_arn option;The unique identifier of the RCS agent to associate with the verified destination number. You can use either the RcsAgentId or RcsAgentArn.
*)destination_phone_number : phone_number;The verified destination phone number, in E.164 format.
*)}type nonrec create_registration_version_result = {registration_version_status_history : registration_version_status_history;A RegistrationVersionStatusHistory object that contains timestamps for the registration.
*)registration_version_status : registration_version_status;The status of the registration.
APPROVED: Your registration has been approved.ARCHIVED: Your previously approved registration version moves into this status when a more recently submitted version is approved.DENIED: You must fix your registration and resubmit it.DISCARDED: You've abandon this version of their registration to start over with a new version.DRAFT: The initial status of a registration version after it’s created.REQUIRES_AUTHENTICATION: You need to complete email authentication.REVIEWING: Your registration has been accepted and is being reviewed.REVOKED: Your previously approved registration has been revoked.SUBMITTED: Your registration has been submitted.version_number : registration_version_number;The new version number of the registration.
*)registration_id : Smaws_Lib.Smithy_api.Types.string_;The unique identifier for the registration.
*)registration_arn : Smaws_Lib.Smithy_api.Types.string_;The Amazon Resource Name (ARN) for the registration.
*)}type nonrec create_registration_version_request = {registration_id : registration_id_or_arn;The unique identifier for the registration.
*)}type nonrec create_registration_attachment_result = {created_timestamp : Smaws_Lib.Smithy_api.Types.timestamp;attachment_status : attachment_status;The status of the registration attachment.
UPLOAD_IN_PROGRESS The attachment is being uploaded.UPLOAD_COMPLETE The attachment has been uploaded.UPLOAD_FAILED The attachment failed to uploaded.DELETED The attachment has been deleted..registration_attachment_id : Smaws_Lib.Smithy_api.Types.string_;The unique identifier for the registration attachment.
*)registration_attachment_arn : Smaws_Lib.Smithy_api.Types.string_;The Amazon Resource Name (ARN) for the registration attachment.
*)}type nonrec create_registration_attachment_request = {client_token : client_token option;Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
*)attachment_url : attachment_url option;Registration files have to be stored in an Amazon S3 bucket. The URI to use when sending is in the format s3://BucketName/FileName.
attachment_body : attachment_body option;The registration file to upload. The maximum file size is 500KB and valid file extensions are PDF, JPEG and PNG.
*)}type nonrec create_registration_association_result = {phone_number : phone_number option;The phone number associated with the registration in E.164 format.
*)iso_country_code : iso_country_code option;The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
*)resource_type : Smaws_Lib.Smithy_api.Types.string_;The registration type or origination identity type.
*)resource_id : Smaws_Lib.Smithy_api.Types.string_;The unique identifier for the origination identity. For example this could be a PhoneNumberId or SenderId.
*)resource_arn : Smaws_Lib.Smithy_api.Types.string_;The Amazon Resource Name (ARN) of the origination identity that is associated with the registration.
*)registration_type : registration_type;The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
registration_id : Smaws_Lib.Smithy_api.Types.string_;The unique identifier for the registration.
*)registration_arn : Smaws_Lib.Smithy_api.Types.string_;The Amazon Resource Name (ARN) for the registration.
*)}type nonrec create_registration_association_request = {resource_id : resource_id_or_arn;The unique identifier for the origination identity. For example this could be a PhoneNumberId or SenderId.
*)registration_id : registration_id_or_arn;The unique identifier for the registration.
*)}type nonrec create_registration_result = {created_timestamp : Smaws_Lib.Smithy_api.Types.timestamp;additional_attributes : string_map option;Metadata about a given registration which is specific to that registration type.
*)current_version_number : registration_version_number;The current version number of the registration.
*)registration_status : registration_status;The status of the registration.
CLOSED: The phone number or sender ID has been deleted and you must also delete the registration for the number.CREATED: Your registration is created but not submitted.COMPLETE: Your registration has been approved and your origination identity has been created.DELETED: The registration has been deleted.PROVISIONING: Your registration has been approved and your origination identity is being created.REQUIRES_AUTHENTICATION: You need to complete email authentication.REQUIRES_UPDATES: You must fix your registration and resubmit it.REVIEWING: Your registration has been accepted and is being reviewed.SUBMITTED: Your registration has been submitted and is awaiting review.registration_type : registration_type;The type of registration form to create. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
registration_id : Smaws_Lib.Smithy_api.Types.string_;The unique identifier for the registration.
*)registration_arn : Smaws_Lib.Smithy_api.Types.string_;The Amazon Resource Name (ARN) for the registration.
*)}type nonrec create_registration_request = {client_token : client_token option;Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
*)registration_type : registration_type;The type of registration form to create. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.
}type nonrec create_rcs_agent_result = {two_way_rcs_events_enabled : rcs_event_type_list option;The list of RCS event types enabled for two-way messaging on the agent.
*)two_way_media_s3_role : iam_role_arn option;The ARN of the IAM role used to write inbound RCS media files to the S3 bucket. The role must have s3:PutObject permission on the bucket and a trust policy allowing sms-voice.amazonaws.com to assume it.
two_way_media_s3_key_prefix : two_way_media_s3_key_prefix option;The key prefix used for inbound RCS media objects in the S3 bucket.
*)two_way_media_s3_bucket_name : two_way_media_s3_bucket_name option;The name of the S3 bucket where inbound RCS media files are stored.
*)two_way_enabled : Smaws_Lib.Smithy_api.Types.primitive_boolean;By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
*)two_way_channel_role : iam_role_arn option;An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
*)two_way_channel_arn : two_way_channel_arn option;The Amazon Resource Name (ARN) of the two way channel.
*)self_managed_opt_outs_enabled : Smaws_Lib.Smithy_api.Types.primitive_boolean;By default this is set to false. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
*)created_timestamp : Smaws_Lib.Smithy_api.Types.timestamp;opt_out_list_name : opt_out_list_name option;The name of the OptOutList associated with the RCS agent.
*)deletion_protection_enabled : Smaws_Lib.Smithy_api.Types.primitive_boolean;When set to true deletion protection is enabled. By default this is set to false.
*)status : rcs_agent_status;The current status of the RCS agent.
*)rcs_agent_id : Smaws_Lib.Smithy_api.Types.string_;The unique identifier for the RCS agent.
*)rcs_agent_arn : Smaws_Lib.Smithy_api.Types.string_;The Amazon Resource Name (ARN) of the newly created RCS agent.
*)}type nonrec create_rcs_agent_request = {client_token : client_token option;Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
*)opt_out_list_name : opt_out_list_name_or_arn option;The OptOutList to associate with the RCS agent. Valid values are either OptOutListName or OptOutListArn.
*)deletion_protection_enabled : Smaws_Lib.Smithy_api.Types.boolean_ option;By default this is set to false. When set to true the RCS agent can't be deleted. You can change this value using the UpdateRcsAgent action.
}type nonrec create_protect_configuration_result = {deletion_protection_enabled : Smaws_Lib.Smithy_api.Types.primitive_boolean;When set to true deletion protection is enabled. By default this is set to false.
*)account_default : Smaws_Lib.Smithy_api.Types.primitive_boolean;This is true if the protect configuration is set as your account default protect configuration.
*)created_timestamp : Smaws_Lib.Smithy_api.Types.timestamp;protect_configuration_id : protect_configuration_id;The unique identifier for the protect configuration.
*)protect_configuration_arn : protect_configuration_arn;The Amazon Resource Name (ARN) of the protect configuration.
*)}type nonrec create_protect_configuration_request = {deletion_protection_enabled : Smaws_Lib.Smithy_api.Types.boolean_ option;When set to true deletion protection is enabled. By default this is set to false.
*)client_token : client_token option;Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
*)}type nonrec create_pool_result = {created_timestamp : Smaws_Lib.Smithy_api.Types.timestamp option;deletion_protection_enabled : Smaws_Lib.Smithy_api.Types.primitive_boolean
option;When set to true deletion protection is enabled. By default this is set to false.
*)opt_out_list_name : opt_out_list_name option;The name of the OptOutList associated with the pool.
*)self_managed_opt_outs_enabled : Smaws_Lib.Smithy_api.Types.primitive_boolean
option;By default this is set to false. When set to false, and an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, End User Messaging SMS automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
*)two_way_channel_role : iam_role_arn option;An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
*)two_way_channel_arn : two_way_channel_arn option;The Amazon Resource Name (ARN) of the two way channel.
*)two_way_enabled : Smaws_Lib.Smithy_api.Types.primitive_boolean option;By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
*)message_type : message_type option;The type of message for the pool to use.
*)status : pool_status option;The current status of the pool.
pool_id : Smaws_Lib.Smithy_api.Types.string_ option;The unique identifier for the pool.
*)pool_arn : Smaws_Lib.Smithy_api.Types.string_ option;The Amazon Resource Name (ARN) for the pool.
*)}type nonrec create_pool_request = {client_token : client_token option;Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
*)deletion_protection_enabled : Smaws_Lib.Smithy_api.Types.boolean_ option;By default this is set to false. When set to true the pool can't be deleted. You can change this value using the UpdatePool action.
*)message_type : message_type;The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive. After the pool is created the MessageType can't be changed.
*)iso_country_code : iso_country_code option;The new two-character code, in ISO 3166-1 alpha-2 format, for the country or region of the new pool. This field is optional and is not required for origination identity types that are not country-specific, such as RCS agents.
*)origination_identity : phone_or_sender_id_or_arn;The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use DescribePhoneNumbers to find the values for PhoneNumberId and PhoneNumberArn, and use DescribeSenderIds can be used to get the values for SenderId and SenderIdArn.
After the pool is created you can add more origination identities to the pool by using AssociateOriginationIdentity.
If you are using a shared End User Messaging SMS resource then you must use the full Amazon Resource Name(ARN).
*)}type nonrec create_opt_out_list_result = {created_timestamp : Smaws_Lib.Smithy_api.Types.timestamp option;opt_out_list_name : opt_out_list_name option;The name of the new OptOutList.
*)opt_out_list_arn : Smaws_Lib.Smithy_api.Types.string_ option;The Amazon Resource Name (ARN) for the OptOutList.
*)}type nonrec create_opt_out_list_request = {client_token : client_token option;Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
*)opt_out_list_name : opt_out_list_name;The name of the new OptOutList.
*)}type nonrec create_notify_configuration_result = {created_timestamp : Smaws_Lib.Smithy_api.Types.timestamp;deletion_protection_enabled : Smaws_Lib.Smithy_api.Types.primitive_boolean;When set to true deletion protection is enabled. By default this is set to false.
*)rejection_reason : Smaws_Lib.Smithy_api.Types.string_ option;The reason the notify configuration was rejected, if applicable.
*)status : notify_configuration_status;The current status of the notify configuration.
*)tier_upgrade_status : tier_upgrade_status;The tier upgrade status of the notify configuration.
*)tier : notify_configuration_tier;The tier of the notify configuration.
*)enabled_channels : notify_enabled_channels_list;An array of channels enabled for the notify configuration. Supported values include SMS and VOICE.
enabled_countries : iso_country_code_list option;An array of two-character ISO country codes, in ISO 3166-1 alpha-2 format, that are enabled for the notify configuration.
*)pool_id : Smaws_Lib.Smithy_api.Types.string_ option;The identifier of the pool associated with the notify configuration.
*)default_template_id : notify_template_id option;The default template identifier associated with the notify configuration.
*)use_case : notify_configuration_use_case;The use case for the notify configuration.
*)display_name : notify_configuration_display_name;The display name associated with the notify configuration.
*)notify_configuration_id : notify_configuration_id;The unique identifier for the notify configuration.
*)notify_configuration_arn : notify_configuration_arn;The Amazon Resource Name (ARN) for the notify configuration.
*)}type nonrec create_notify_configuration_request = {client_token : client_token option;Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
*)deletion_protection_enabled : Smaws_Lib.Smithy_api.Types.boolean_ option;By default this is set to false. When set to true the notify configuration can't be deleted. You can change this value using the UpdateNotifyConfiguration action.
enabled_channels : notify_enabled_channels_list;An array of channels to enable for the notify configuration. Supported values include SMS and VOICE.
enabled_countries : iso_country_code_list option;An array of two-character ISO country codes, in ISO 3166-1 alpha-2 format, that are enabled for the notify configuration.
*)pool_id : pool_id_or_arn option;The identifier of the pool to associate with the notify configuration.
*)default_template_id : notify_template_id option;The default template identifier to associate with the notify configuration. If specified, this template is used when sending messages without an explicit template identifier.
*)use_case : notify_configuration_use_case;The use case for the notify configuration.
*)display_name : notify_configuration_display_name;The display name to associate with the notify configuration.
*)}type nonrec create_event_destination_result = {event_destination : event_destination option;The details of the destination where events are logged.
*)configuration_set_name : configuration_set_name option;The name of the configuration set.
*)configuration_set_arn : Smaws_Lib.Smithy_api.Types.string_ option;The ARN of the configuration set.
*)}type nonrec create_event_destination_request = {client_token : client_token option;Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
*)sns_destination : sns_destination option;An object that contains information about an event destination for logging to Amazon SNS.
*)kinesis_firehose_destination : kinesis_firehose_destination option;An object that contains information about an event destination for logging to Amazon Data Firehose.
*)cloud_watch_logs_destination : cloud_watch_logs_destination option;An object that contains information about an event destination for logging to Amazon CloudWatch Logs.
*)matching_event_types : event_type_list;An array of event types that determine which events to log. If "ALL" is used, then End User Messaging SMS logs every event type.
The TEXT_SENT event type is not supported.
event_destination_name : event_destination_name;The name that identifies the event destination.
*)configuration_set_name : configuration_set_name_or_arn;Either the name of the configuration set or the configuration set ARN to apply event logging to. The ConfigurateSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets action.
}type nonrec create_configuration_set_result = {created_timestamp : Smaws_Lib.Smithy_api.Types.timestamp option;configuration_set_name : configuration_set_name option;The name of the new configuration set.
*)configuration_set_arn : Smaws_Lib.Smithy_api.Types.string_ option;The Amazon Resource Name (ARN) of the newly created configuration set.
*)}type nonrec create_configuration_set_request = {client_token : client_token option;Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
*)configuration_set_name : configuration_set_name;The name to use for the new configuration set.
*)}type nonrec carrier_lookup_result = {phone_number_type : phone_number_type;Describes the type of phone number. Valid values are: MOBILE, LANDLINE, OTHER, and INVALID. Avoid sending SMS or voice messages to INVALID phone numbers, as these numbers are unlikely to belong to actual recipients.
*)carrier : Smaws_Lib.Smithy_api.Types.string_ option;The carrier or service provider that the phone number is currently registered with. In some countries and regions, this value may be the carrier or service provider that the phone number was originally registered with.
*)mn_c : mnc_type option;The phone number's mobile network code, for mobile phone number types.
*)mc_c : mcc_type option;The phone number's mobile country code, for mobile phone number types
*)country : Smaws_Lib.Smithy_api.Types.string_ option;The name of the country or region for the phone number.
*)iso_country_code : iso_country_code option;The two-character country or region code, in ISO 3166-1 alpha-2 format, for the phone number.
*)dialing_country_code : dialing_country_code_type option;The country or region numeric dialing code for the phone number.
*)e164_phone_number : e164_phone_number_type;The phone number in E164 format, sanitized from the original input by removing any formatting characters.
*)}type nonrec carrier_lookup_request = {phone_number : carrier_lookup_input_phone_number_type;The phone number that you want to retrieve information about. You can provide the phone number in various formats including special characters such as parentheses, brackets, spaces, hyphens, periods, and commas. The service automatically converts the input to E164 format for processing.
*)}type nonrec associate_protect_configuration_result = {protect_configuration_id : protect_configuration_id;The unique identifier for the protect configuration.
*)protect_configuration_arn : protect_configuration_arn;The Amazon Resource Name (ARN) of the protect configuration.
*)configuration_set_name : configuration_set_name;The name of the ConfigurationSet.
*)configuration_set_arn : Smaws_Lib.Smithy_api.Types.string_;The Amazon Resource Name (ARN) of the configuration set.
*)}type nonrec associate_protect_configuration_request = {configuration_set_name : configuration_set_name_or_arn;The name of the ConfigurationSet.
*)protect_configuration_id : protect_configuration_id_or_arn;The unique identifier for the protect configuration.
*)}type nonrec associate_origination_identity_result = {iso_country_code : iso_country_code option;The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
*)origination_identity : Smaws_Lib.Smithy_api.Types.string_ option;The PhoneNumberId or SenderId of the origination identity.
*)origination_identity_arn : Smaws_Lib.Smithy_api.Types.string_ option;The PhoneNumberArn or SenderIdArn of the origination identity.
*)pool_id : Smaws_Lib.Smithy_api.Types.string_ option;The PoolId of the pool that is now associated with the origination identity.
*)pool_arn : Smaws_Lib.Smithy_api.Types.string_ option;The Amazon Resource Name (ARN) of the pool that is now associated with the origination identity.
*)}type nonrec associate_origination_identity_request = {client_token : client_token option;Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
*)iso_country_code : iso_country_code option;The new two-character code, in ISO 3166-1 alpha-2 format, for the country or region of the origination identity. This field is optional and is not required for origination identity types that are not country-specific, such as RCS agents.
*)origination_identity : phone_or_sender_id_or_arn;The origination identity to use, such as PhoneNumberId, PhoneNumberArn, SenderId, or SenderIdArn. You can use DescribePhoneNumbers to find the values for PhoneNumberId and PhoneNumberArn, while DescribeSenderIds can be used to get the values for SenderId and SenderIdArn.
If you are using a shared End User Messaging SMS resource then you must use the full Amazon Resource Name(ARN).
*)pool_id : pool_id_or_arn;The pool to update with the new Identity. This value can be either the PoolId or PoolArn, and you can find these values using DescribePools.
If you are using a shared End User Messaging SMS; resource then you must use the full Amazon Resource Name(ARN).
*)}