Struct Client

pub struct Client { /* private fields */ }

Client for Amazon Pinpoint SMS Voice V2

Client for invoking operations on Amazon Pinpoint SMS Voice V2. Each operation on Amazon Pinpoint SMS Voice V2 is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_pinpointsmsvoicev2::Client::new(&config);

Occasionally, SDKs may have additional service-specific values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Builder struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_pinpointsmsvoicev2::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the AssociateOriginationIdentity operation has a Client::associate_origination_identity, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.associate_origination_identity()
    .pool_id("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Implementations

impl Client

pub fn associate_origination_identity( &self, ) -> AssociateOriginationIdentityFluentBuilder

Constructs a fluent builder for the AssociateOriginationIdentity operation.

• The fluent builder is configurable:
  • pool_id(impl Into<String>) / set_pool_id(Option<String>):
    required: true
    

    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 AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

    
    
  • origination_identity(impl Into<String>) / set_origination_identity(Option<String>):
    required: true
    

    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 AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

    
    
  • iso_country_code(impl Into<String>) / set_iso_country_code(Option<String>):
    required: true
    

    The new two-character code, in ISO 3166-1 alpha-2 format, for the country or region of the origination identity.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    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.

    
    
• On success, responds with AssociateOriginationIdentityOutput with field(s):
  • pool_arn(Option<String>):

    The Amazon Resource Name (ARN) of the pool that is now associated with the origination identity.

  • pool_id(Option<String>):

    The PoolId of the pool that is now associated with the origination identity.

  • origination_identity_arn(Option<String>):

    The PhoneNumberArn or SenderIdArn of the origination identity.

  • origination_identity(Option<String>):

    The PhoneNumberId or SenderId of the origination identity.

  • iso_country_code(Option<String>):

    The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

• On failure, responds with SdkError<AssociateOriginationIdentityError>

impl Client

pub fn associate_protect_configuration( &self, ) -> AssociateProtectConfigurationFluentBuilder

Constructs a fluent builder for the AssociateProtectConfiguration operation.

• The fluent builder is configurable:
  • protect_configuration_id(impl Into<String>) / set_protect_configuration_id(Option<String>):
    required: true
    

    The unique identifier for the protect configuration.

    
    
  • configuration_set_name(impl Into<String>) / set_configuration_set_name(Option<String>):
    required: true
    

    The name of the ConfigurationSet.

    
    
• On success, responds with AssociateProtectConfigurationOutput with field(s):
  • configuration_set_arn(String):

    The Amazon Resource Name (ARN) of the configuration set.

  • configuration_set_name(String):

    The name of the ConfigurationSet.

  • protect_configuration_arn(String):

    The Amazon Resource Name (ARN) of the protect configuration.

  • protect_configuration_id(String):

    The unique identifier for the protect configuration.

• On failure, responds with SdkError<AssociateProtectConfigurationError>

impl Client

pub fn create_configuration_set(&self) -> CreateConfigurationSetFluentBuilder

Constructs a fluent builder for the CreateConfigurationSet operation.

• The fluent builder is configurable:
  • configuration_set_name(impl Into<String>) / set_configuration_set_name(Option<String>):
    required: true
    

    The name to use for the new configuration set.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    An array of key and value pair tags that’s associated with the new configuration set.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    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.

    
    
• On success, responds with CreateConfigurationSetOutput with field(s):
  • configuration_set_arn(Option<String>):

    The Amazon Resource Name (ARN) of the newly created configuration set.

  • configuration_set_name(Option<String>):

    The name of the new configuration set.

  • tags(Option<Vec::<Tag>>):

    An array of key and value pair tags that’s associated with the configuration set.

  • created_timestamp(Option<DateTime>):

    The time when the configuration set was created, in UNIX epoch time format.

• On failure, responds with SdkError<CreateConfigurationSetError>

impl Client

pub fn create_event_destination(&self) -> CreateEventDestinationFluentBuilder

Constructs a fluent builder for the CreateEventDestination operation.

• The fluent builder is configurable:
  • configuration_set_name(impl Into<String>) / set_configuration_set_name(Option<String>):
    required: true
    

    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.

    
    
  • event_destination_name(impl Into<String>) / set_event_destination_name(Option<String>):
    required: true
    

    The name that identifies the event destination.

    
    
  • matching_event_types(EventType) / set_matching_event_types(Option<Vec::<EventType>>):
    required: true
    

    An array of event types that determine which events to log. If “ALL” is used, then AWS End User Messaging SMS and Voice logs every event type.

    The TEXT_SENT event type is not supported.

    
    
  • cloud_watch_logs_destination(CloudWatchLogsDestination) / set_cloud_watch_logs_destination(Option<CloudWatchLogsDestination>):
    required: false
    

    An object that contains information about an event destination for logging to Amazon CloudWatch Logs.

    
    
  • kinesis_firehose_destination(KinesisFirehoseDestination) / set_kinesis_firehose_destination(Option<KinesisFirehoseDestination>):
    required: false
    

    An object that contains information about an event destination for logging to Amazon Data Firehose.

    
    
  • sns_destination(SnsDestination) / set_sns_destination(Option<SnsDestination>):
    required: false
    

    An object that contains information about an event destination for logging to Amazon SNS.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    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.

    
    
• On success, responds with CreateEventDestinationOutput with field(s):
  • configuration_set_arn(Option<String>):

    The ARN of the configuration set.

  • configuration_set_name(Option<String>):

    The name of the configuration set.

  • event_destination(Option<EventDestination>):

    The details of the destination where events are logged.

• On failure, responds with SdkError<CreateEventDestinationError>

impl Client

pub fn create_opt_out_list(&self) -> CreateOptOutListFluentBuilder

Constructs a fluent builder for the CreateOptOutList operation.

• The fluent builder is configurable:
  • opt_out_list_name(impl Into<String>) / set_opt_out_list_name(Option<String>):
    required: true
    

    The name of the new OptOutList.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    An array of tags (key and value pairs) to associate with the new OptOutList.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    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.

    
    
• On success, responds with CreateOptOutListOutput with field(s):
  • opt_out_list_arn(Option<String>):

    The Amazon Resource Name (ARN) for the OptOutList.

  • opt_out_list_name(Option<String>):

    The name of the new OptOutList.

  • tags(Option<Vec::<Tag>>):

    An array of tags (key and value pairs) associated with the new OptOutList.

  • created_timestamp(Option<DateTime>):

    The time when the pool was created, in UNIX epoch time format.

• On failure, responds with SdkError<CreateOptOutListError>

impl Client

pub fn create_pool(&self) -> CreatePoolFluentBuilder

Constructs a fluent builder for the CreatePool operation.

• The fluent builder is configurable:
  • origination_identity(impl Into<String>) / set_origination_identity(Option<String>):
    required: true
    

    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.

    After the pool is created you can add more origination identities to the pool by using AssociateOriginationIdentity.

    If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

    
    
  • iso_country_code(impl Into<String>) / set_iso_country_code(Option<String>):
    required: true
    

    The new two-character code, in ISO 3166-1 alpha-2 format, for the country or region of the new pool.

    
    
  • message_type(MessageType) / set_message_type(Option<MessageType>):
    required: true
    

    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.

    
    
  • deletion_protection_enabled(bool) / set_deletion_protection_enabled(Option<bool>):
    required: false
    

    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.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    An array of tags (key and value pairs) associated with the pool.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    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.

    
    
• On success, responds with CreatePoolOutput with field(s):
  • pool_arn(Option<String>):

    The Amazon Resource Name (ARN) for the pool.

  • pool_id(Option<String>):

    The unique identifier for the pool.

  • status(Option<PoolStatus>):

    The current status of the pool.

    • CREATING: The pool is currently being created and isn’t yet available for use.

    • ACTIVE: The pool is active and available for use.

    • DELETING: The pool is being deleted.

  • message_type(Option<MessageType>):

    The type of message for the pool to use.

  • two_way_enabled(bool):

    By default this is set to false. When set to true you can receive incoming text messages from your end recipients.

  • two_way_channel_arn(Option<String>):

    The Amazon Resource Name (ARN) of the two way channel.

  • two_way_channel_role(Option<String>):

    An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.

  • self_managed_opt_outs_enabled(bool):

    By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice 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.

  • opt_out_list_name(Option<String>):

    The name of the OptOutList associated with the pool.

  • shared_routes_enabled(bool):

    Indicates whether shared routes are enabled for the pool. Set to false and only origination identities in this pool are used to send messages.

  • deletion_protection_enabled(bool):

    When set to true deletion protection is enabled. By default this is set to false.

  • tags(Option<Vec::<Tag>>):

    An array of tags (key and value pairs) associated with the pool.

  • created_timestamp(Option<DateTime>):

    The time when the pool was created, in UNIX epoch time format.

• On failure, responds with SdkError<CreatePoolError>

impl Client

pub fn create_protect_configuration( &self, ) -> CreateProtectConfigurationFluentBuilder

Constructs a fluent builder for the CreateProtectConfiguration operation.

• The fluent builder is configurable:
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    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(bool) / set_deletion_protection_enabled(Option<bool>):
    required: false
    

    When set to true deletion protection is enabled. By default this is set to false.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    An array of key and value pair tags that are associated with the resource.

    
    
• On success, responds with CreateProtectConfigurationOutput with field(s):
  • protect_configuration_arn(String):

    The Amazon Resource Name (ARN) of the protect configuration.

  • protect_configuration_id(String):

    The unique identifier for the protect configuration.

  • created_timestamp(DateTime):

    The time when the protect configuration was created, in UNIX epoch time format.

  • account_default(bool):

    This is true if the protect configuration is set as your account default protect configuration.

  • deletion_protection_enabled(bool):

    When set to true deletion protection is enabled. By default this is set to false.

  • tags(Option<Vec::<Tag>>):

    An array of key and value pair tags that are associated with the resource.

• On failure, responds with SdkError<CreateProtectConfigurationError>

impl Client

pub fn create_registration(&self) -> CreateRegistrationFluentBuilder

Constructs a fluent builder for the CreateRegistration operation.

• The fluent builder is configurable:
  • registration_type(impl Into<String>) / set_registration_type(Option<String>):
    required: true
    

    The type of registration form to create. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    An array of tags (key and value pairs) to associate with the registration.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    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.

    
    
• On success, responds with CreateRegistrationOutput with field(s):
  • registration_arn(String):

    The Amazon Resource Name (ARN) for the registration.

  • registration_id(String):

    The unique identifier for the registration.

  • registration_type(String):

    The type of registration form to create. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.

  • registration_status(RegistrationStatus):

    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.

  • current_version_number(i64):

    The current version number of the registration.

  • additional_attributes(Option<HashMap::<String, String>>):

    Metadata about a given registration which is specific to that registration type.

  • tags(Option<Vec::<Tag>>):

    An array of tags (key and value pairs) to associate with the registration.

  • created_timestamp(DateTime):

    The time when the registration was created, in UNIX epoch time format.

• On failure, responds with SdkError<CreateRegistrationError>

impl Client

pub fn create_registration_association( &self, ) -> CreateRegistrationAssociationFluentBuilder

Constructs a fluent builder for the CreateRegistrationAssociation operation.

• The fluent builder is configurable:
  • registration_id(impl Into<String>) / set_registration_id(Option<String>):
    required: true
    

    The unique identifier for the registration.

    
    
  • resource_id(impl Into<String>) / set_resource_id(Option<String>):
    required: true
    

    The unique identifier for the origination identity. For example this could be a PhoneNumberId or SenderId.

    
    
• On success, responds with CreateRegistrationAssociationOutput with field(s):
  • registration_arn(String):

    The Amazon Resource Name (ARN) for the registration.

  • registration_id(String):

    The unique identifier for the registration.

  • registration_type(String):

    The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.

  • resource_arn(String):

    The Amazon Resource Name (ARN) of the origination identity that is associated with the registration.

  • resource_id(String):

    The unique identifier for the origination identity. For example this could be a PhoneNumberId or SenderId.

  • resource_type(String):

    The registration type or origination identity type.

  • iso_country_code(Option<String>):

    The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

  • phone_number(Option<String>):

    The phone number associated with the registration in E.164 format.

• On failure, responds with SdkError<CreateRegistrationAssociationError>

impl Client

pub fn create_registration_attachment( &self, ) -> CreateRegistrationAttachmentFluentBuilder

Constructs a fluent builder for the CreateRegistrationAttachment operation.

• The fluent builder is configurable:
  • attachment_body(Blob) / set_attachment_body(Option<Blob>):
    required: false
    

    The registration file to upload. The maximum file size is 500KB and valid file extensions are PDF, JPEG and PNG.

    
    
  • attachment_url(impl Into<String>) / set_attachment_url(Option<String>):
    required: false
    

    Registration files have to be stored in an Amazon S3 bucket. The URI to use when sending is in the format s3://BucketName/FileName.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    An array of tags (key and value pairs) to associate with the registration attachment.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    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.

    
    
• On success, responds with CreateRegistrationAttachmentOutput with field(s):
  • registration_attachment_arn(String):

    The Amazon Resource Name (ARN) for the registration attachment.

  • registration_attachment_id(String):

    The unique identifier for the registration attachment.

  • attachment_status(AttachmentStatus):

    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..

  • tags(Option<Vec::<Tag>>):

    An array of tags (key and value pairs) to associate with the registration attachment.

  • created_timestamp(DateTime):

    The time when the registration attachment was created, in UNIX epoch time format.

• On failure, responds with SdkError<CreateRegistrationAttachmentError>

impl Client

pub fn create_registration_version( &self, ) -> CreateRegistrationVersionFluentBuilder

Constructs a fluent builder for the CreateRegistrationVersion operation.

• The fluent builder is configurable:
  • registration_id(impl Into<String>) / set_registration_id(Option<String>):
    required: true
    

    The unique identifier for the registration.

    
    
• On success, responds with CreateRegistrationVersionOutput with field(s):
  • registration_arn(String):

    The Amazon Resource Name (ARN) for the registration.

  • registration_id(String):

    The unique identifier for the registration.

  • version_number(i64):

    The new version number of the registration.

  • registration_version_status(RegistrationVersionStatus):

    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.

  • registration_version_status_history(Option<RegistrationVersionStatusHistory>):

    A RegistrationVersionStatusHistory object that contains timestamps for the registration.

• On failure, responds with SdkError<CreateRegistrationVersionError>

impl Client

pub fn create_verified_destination_number( &self, ) -> CreateVerifiedDestinationNumberFluentBuilder

Constructs a fluent builder for the CreateVerifiedDestinationNumber operation.

• The fluent builder is configurable:
  • destination_phone_number(impl Into<String>) / set_destination_phone_number(Option<String>):
    required: true
    

    The verified destination phone number, in E.164 format.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    An array of tags (key and value pairs) to associate with the destination number.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    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.

    
    
• On success, responds with CreateVerifiedDestinationNumberOutput with field(s):
  • verified_destination_number_arn(String):

    The Amazon Resource Name (ARN) for the verified destination phone number.

  • verified_destination_number_id(String):

    The unique identifier for the verified destination phone number.

  • destination_phone_number(String):

    The verified destination phone number, in E.164 format.

  • status(VerificationStatus):

    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.

  • tags(Option<Vec::<Tag>>):

    An array of tags (key and value pairs) to associate with the destination number.

  • created_timestamp(DateTime):

    The time when the verified phone number was created, in UNIX epoch time format.

• On failure, responds with SdkError<CreateVerifiedDestinationNumberError>

impl Client

pub fn delete_account_default_protect_configuration( &self, ) -> DeleteAccountDefaultProtectConfigurationFluentBuilder

Constructs a fluent builder for the DeleteAccountDefaultProtectConfiguration operation.

• The fluent builder takes no input, just send it.
• On success, responds with DeleteAccountDefaultProtectConfigurationOutput with field(s):
  • default_protect_configuration_arn(String):

    The Amazon Resource Name (ARN) of the account default protect configuration.

  • default_protect_configuration_id(String):

    The unique identifier of the account default protect configuration.

• On failure, responds with SdkError<DeleteAccountDefaultProtectConfigurationError>

impl Client

pub fn delete_configuration_set(&self) -> DeleteConfigurationSetFluentBuilder

Constructs a fluent builder for the DeleteConfigurationSet operation.

• The fluent builder is configurable:
  • configuration_set_name(impl Into<String>) / set_configuration_set_name(Option<String>):
    required: true
    

    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.

    
    
• On success, responds with DeleteConfigurationSetOutput with field(s):
  • configuration_set_arn(Option<String>):

    The Amazon Resource Name (ARN) of the deleted configuration set.

  • configuration_set_name(Option<String>):

    The name of the deleted configuration set.

  • event_destinations(Option<Vec::<EventDestination>>):

    An array of any EventDestination objects that were associated with the deleted configuration set.

  • default_message_type(Option<MessageType>):

    The default message type of the configuration set that was deleted.

  • default_sender_id(Option<String>):

    The default Sender ID of the configuration set that was deleted.

  • default_message_feedback_enabled(Option<bool>):

    True if the configuration set has message feedback enabled. By default this is set to false.

  • created_timestamp(Option<DateTime>):

    The time that the deleted configuration set was created in UNIX epoch time format.

• On failure, responds with SdkError<DeleteConfigurationSetError>

impl Client

pub fn delete_default_message_type( &self, ) -> DeleteDefaultMessageTypeFluentBuilder

Constructs a fluent builder for the DeleteDefaultMessageType operation.

• The fluent builder is configurable:
  • configuration_set_name(impl Into<String>) / set_configuration_set_name(Option<String>):
    required: true
    

    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.

    
    
• On success, responds with DeleteDefaultMessageTypeOutput with field(s):
  • configuration_set_arn(Option<String>):

    The Amazon Resource Name (ARN) of the configuration set.

  • configuration_set_name(Option<String>):

    The name of the configuration set.

  • message_type(Option<MessageType>):

    The current message type for the configuration set.

• On failure, responds with SdkError<DeleteDefaultMessageTypeError>

impl Client

pub fn delete_default_sender_id(&self) -> DeleteDefaultSenderIdFluentBuilder

Constructs a fluent builder for the DeleteDefaultSenderId operation.

• The fluent builder is configurable:
  • configuration_set_name(impl Into<String>) / set_configuration_set_name(Option<String>):
    required: true
    

    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.

    
    
• On success, responds with DeleteDefaultSenderIdOutput with field(s):
  • configuration_set_arn(Option<String>):

    The Amazon Resource Name (ARN) of the configuration set.

  • configuration_set_name(Option<String>):

    The name of the configuration set.

  • sender_id(Option<String>):

    The current sender ID for the configuration set.

• On failure, responds with SdkError<DeleteDefaultSenderIdError>

impl Client

pub fn delete_event_destination(&self) -> DeleteEventDestinationFluentBuilder

Constructs a fluent builder for the DeleteEventDestination operation.

• The fluent builder is configurable:
  • configuration_set_name(impl Into<String>) / set_configuration_set_name(Option<String>):
    required: true
    

    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.

    
    
  • event_destination_name(impl Into<String>) / set_event_destination_name(Option<String>):
    required: true
    

    The name of the event destination to delete.

    
    
• On success, responds with DeleteEventDestinationOutput with field(s):
  • configuration_set_arn(Option<String>):

    The Amazon Resource Name (ARN) of the configuration set.

  • configuration_set_name(Option<String>):

    The name of the configuration set the event destination was deleted from.

  • event_destination(Option<EventDestination>):

    The event destination object that was deleted.

• On failure, responds with SdkError<DeleteEventDestinationError>

impl Client

pub fn delete_keyword(&self) -> DeleteKeywordFluentBuilder

Constructs a fluent builder for the DeleteKeyword operation.

• The fluent builder is configurable:
  • origination_identity(impl Into<String>) / set_origination_identity(Option<String>):
    required: true
    

    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 AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

    
    
  • keyword(impl Into<String>) / set_keyword(Option<String>):
    required: true
    

    The keyword to delete.

    
    
• On success, responds with DeleteKeywordOutput with field(s):
  • origination_identity_arn(Option<String>):

    The PhoneNumberArn or PoolArn that the keyword was associated with.

  • origination_identity(Option<String>):

    The PhoneNumberId or PoolId that the keyword was associated with.

  • keyword(Option<String>):

    The keyword that was deleted.

  • keyword_message(Option<String>):

    The message that was associated with the deleted keyword.

  • keyword_action(Option<KeywordAction>):

    The action that was associated with the deleted keyword.

• On failure, responds with SdkError<DeleteKeywordError>

impl Client

pub fn delete_media_message_spend_limit_override( &self, ) -> DeleteMediaMessageSpendLimitOverrideFluentBuilder

Constructs a fluent builder for the DeleteMediaMessageSpendLimitOverride operation.

• The fluent builder takes no input, just send it.
• On success, responds with DeleteMediaMessageSpendLimitOverrideOutput with field(s):
  • monthly_limit(Option<i64>):

    The current monthly limit, in US dollars.

• On failure, responds with SdkError<DeleteMediaMessageSpendLimitOverrideError>

impl Client

pub fn delete_opt_out_list(&self) -> DeleteOptOutListFluentBuilder

Constructs a fluent builder for the DeleteOptOutList operation.

• The fluent builder is configurable:
  • opt_out_list_name(impl Into<String>) / set_opt_out_list_name(Option<String>):
    required: true
    

    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 AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

    
    
• On success, responds with DeleteOptOutListOutput with field(s):
  • opt_out_list_arn(Option<String>):

    The Amazon Resource Name (ARN) of the OptOutList that was removed.

  • opt_out_list_name(Option<String>):

    The name of the OptOutList that was removed.

  • created_timestamp(Option<DateTime>):

    The time when the OptOutList was created, in UNIX epoch time format.

• On failure, responds with SdkError<DeleteOptOutListError>

impl Client

pub fn delete_opted_out_number(&self) -> DeleteOptedOutNumberFluentBuilder

Constructs a fluent builder for the DeleteOptedOutNumber operation.

• The fluent builder is configurable:
  • opt_out_list_name(impl Into<String>) / set_opt_out_list_name(Option<String>):
    required: true
    

    The OptOutListName or OptOutListArn to remove the phone number from.

    If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

    
    
  • opted_out_number(impl Into<String>) / set_opted_out_number(Option<String>):
    required: true
    

    The phone number, in E.164 format, to remove from the OptOutList.

    
    
• On success, responds with DeleteOptedOutNumberOutput with field(s):
  • opt_out_list_arn(Option<String>):

    The OptOutListArn that the phone number was removed from.

  • opt_out_list_name(Option<String>):

    The OptOutListName that the phone number was removed from.

  • opted_out_number(Option<String>):

    The phone number that was removed from the OptOutList.

  • opted_out_timestamp(Option<DateTime>):

    The time that the number was removed at, in UNIX epoch time format.

  • end_user_opted_out(bool):

    This is true if it was the end user who requested their phone number be removed.

• On failure, responds with SdkError<DeleteOptedOutNumberError>

impl Client

pub fn delete_pool(&self) -> DeletePoolFluentBuilder

Constructs a fluent builder for the DeletePool operation.

• The fluent builder is configurable:
  • pool_id(impl Into<String>) / set_pool_id(Option<String>):
    required: true
    

    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 AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

    
    
• On success, responds with DeletePoolOutput with field(s):
  • pool_arn(Option<String>):

    The Amazon Resource Name (ARN) of the pool that was deleted.

  • pool_id(Option<String>):

    The PoolId of the pool that was deleted.

  • status(Option<PoolStatus>):

    The current status of the pool.

    • CREATING: The pool is currently being created and isn’t yet available for use.

    • ACTIVE: The pool is active and available for use.

    • DELETING: The pool is being deleted.

  • message_type(Option<MessageType>):

    The message type that was associated with the deleted pool.

  • two_way_enabled(bool):

    By default this is set to false. When set to true you can receive incoming text messages from your end recipients.

  • two_way_channel_arn(Option<String>):

    The Amazon Resource Name (ARN) of the TwoWayChannel.

  • two_way_channel_role(Option<String>):

    An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.

  • self_managed_opt_outs_enabled(bool):

    By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice 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.

  • opt_out_list_name(Option<String>):

    The name of the OptOutList that was associated with the deleted pool.

  • shared_routes_enabled(bool):

    Indicates whether shared routes are enabled for the pool.

  • created_timestamp(Option<DateTime>):

    The time when the pool was created, in UNIX epoch time format.

• On failure, responds with SdkError<DeletePoolError>

impl Client

pub fn delete_protect_configuration( &self, ) -> DeleteProtectConfigurationFluentBuilder

Constructs a fluent builder for the DeleteProtectConfiguration operation.

• The fluent builder is configurable:
  • protect_configuration_id(impl Into<String>) / set_protect_configuration_id(Option<String>):
    required: true
    

    The unique identifier for the protect configuration.

    
    
• On success, responds with DeleteProtectConfigurationOutput with field(s):
  • protect_configuration_arn(String):

    The Amazon Resource Name (ARN) of the protect configuration.

  • protect_configuration_id(String):

    The unique identifier for the protect configuration.

  • created_timestamp(DateTime):

    The time when the protect configuration was created, in UNIX epoch time format.

  • account_default(bool):

    This is true if the protect configuration is set as your account default protect configuration.

  • deletion_protection_enabled(bool):

    The status of deletion protection for the protect configuration. When set to true deletion protection is enabled. By default this is set to false.

• On failure, responds with SdkError<DeleteProtectConfigurationError>

impl Client

pub fn delete_protect_configuration_rule_set_number_override( &self, ) -> DeleteProtectConfigurationRuleSetNumberOverrideFluentBuilder

Constructs a fluent builder for the DeleteProtectConfigurationRuleSetNumberOverride operation.

• The fluent builder is configurable:
  • protect_configuration_id(impl Into<String>) / set_protect_configuration_id(Option<String>):
    required: true
    

    The unique identifier for the protect configuration.

    
    
  • destination_phone_number(impl Into<String>) / set_destination_phone_number(Option<String>):
    required: true
    

    The destination phone number in E.164 format.

    
    
• On success, responds with DeleteProtectConfigurationRuleSetNumberOverrideOutput with field(s):
  • protect_configuration_arn(String):

    The Amazon Resource Name (ARN) of the protect configuration.

  • protect_configuration_id(String):

    The unique identifier for the protect configuration.

  • destination_phone_number(String):

    The destination phone number in E.164 format.

  • created_timestamp(DateTime):

    The time when the rule was created, in UNIX epoch time format.

  • action(ProtectConfigurationRuleOverrideAction):

    The action associated with the rule.

  • iso_country_code(Option<String>):

    The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

  • expiration_timestamp(Option<DateTime>):

    The time when the resource-based policy was created, in UNIX epoch time format.

• On failure, responds with SdkError<DeleteProtectConfigurationRuleSetNumberOverrideError>

impl Client

pub fn delete_registration(&self) -> DeleteRegistrationFluentBuilder

Constructs a fluent builder for the DeleteRegistration operation.

• The fluent builder is configurable:
  • registration_id(impl Into<String>) / set_registration_id(Option<String>):
    required: true
    

    The unique identifier for the registration.

    
    
• On success, responds with DeleteRegistrationOutput with field(s):
  • registration_arn(String):

    The Amazon Resource Name (ARN) for the registration.

  • registration_id(String):

    The unique identifier for the registration.

  • registration_type(String):

    The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.

  • registration_status(RegistrationStatus):

    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.

  • current_version_number(i64):

    The current version number of the registration.

  • approved_version_number(Option<i64>):

    The version number of the registration that was approved.

  • latest_denied_version_number(Option<i64>):

    The latest version number of the registration that was denied.

  • additional_attributes(Option<HashMap::<String, String>>):

    Metadata about a given registration which is specific to that registration type.

  • created_timestamp(DateTime):

    The time when the registration was created, in UNIX epoch time format.

• On failure, responds with SdkError<DeleteRegistrationError>

impl Client

pub fn delete_registration_attachment( &self, ) -> DeleteRegistrationAttachmentFluentBuilder

Constructs a fluent builder for the DeleteRegistrationAttachment operation.

• The fluent builder is configurable:
  • registration_attachment_id(impl Into<String>) / set_registration_attachment_id(Option<String>):
    required: true
    

    The unique identifier for the registration attachment.

    
    
• On success, responds with DeleteRegistrationAttachmentOutput with field(s):
  • registration_attachment_arn(String):

    The Amazon Resource Name (ARN) for the registration attachment.

  • registration_attachment_id(String):

    The unique identifier for the registration attachment.

  • attachment_status(AttachmentStatus):

    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..

  • attachment_upload_error_reason(Option<AttachmentUploadErrorReason>):

    The error message if the upload failed.

  • created_timestamp(DateTime):

    The time when the registration attachment was created, in UNIX epoch time format.

• On failure, responds with SdkError<DeleteRegistrationAttachmentError>

impl Client

pub fn delete_registration_field_value( &self, ) -> DeleteRegistrationFieldValueFluentBuilder

Constructs a fluent builder for the DeleteRegistrationFieldValue operation.

• The fluent builder is configurable:
  • registration_id(impl Into<String>) / set_registration_id(Option<String>):
    required: true
    

    The unique identifier for the registration.

    
    
  • field_path(impl Into<String>) / set_field_path(Option<String>):
    required: true
    

    The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of FieldPaths.

    
    
• On success, responds with DeleteRegistrationFieldValueOutput with field(s):
  • registration_arn(String):

    The Amazon Resource Name (ARN) for the registration.

  • registration_id(String):

    The unique identifier for the registration.

  • version_number(i64):

    The version number of the registration.

  • field_path(String):

    The path to the registration form field.

  • select_choices(Option<Vec::<String>>):

    An array of values for the form field.

  • text_value(Option<String>):

    The text data for a free form field.

  • registration_attachment_id(Option<String>):

    The unique identifier for the registration attachment.

• On failure, responds with SdkError<DeleteRegistrationFieldValueError>

impl Client

pub fn delete_resource_policy(&self) -> DeleteResourcePolicyFluentBuilder

Constructs a fluent builder for the DeleteResourcePolicy operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the AWS End User Messaging SMS and Voice resource you’re deleting the resource-based policy from.

    
    
• On success, responds with DeleteResourcePolicyOutput with field(s):
  • resource_arn(Option<String>):

    The Amazon Resource Name (ARN) of the AWS End User Messaging SMS and Voice resource that the resource-based policy was deleted from.

  • policy(Option<String>):

    The JSON formatted resource-based policy that was deleted.

  • created_timestamp(Option<DateTime>):

    The time when the resource-based policy was created, in UNIX epoch time format.

• On failure, responds with SdkError<DeleteResourcePolicyError>

impl Client

pub fn delete_text_message_spend_limit_override( &self, ) -> DeleteTextMessageSpendLimitOverrideFluentBuilder

Constructs a fluent builder for the DeleteTextMessageSpendLimitOverride operation.

• The fluent builder takes no input, just send it.
• On success, responds with DeleteTextMessageSpendLimitOverrideOutput with field(s):
  • monthly_limit(Option<i64>):

    The current monthly limit, in US dollars.

• On failure, responds with SdkError<DeleteTextMessageSpendLimitOverrideError>

impl Client

pub fn delete_verified_destination_number( &self, ) -> DeleteVerifiedDestinationNumberFluentBuilder

Constructs a fluent builder for the DeleteVerifiedDestinationNumber operation.

• The fluent builder is configurable:
  • verified_destination_number_id(impl Into<String>) / set_verified_destination_number_id(Option<String>):
    required: true
    

    The unique identifier for the verified destination phone number.

    
    
• On success, responds with DeleteVerifiedDestinationNumberOutput with field(s):
  • verified_destination_number_arn(String):

    The Amazon Resource Name (ARN) for the verified destination phone number.

  • verified_destination_number_id(String):

    The unique identifier for the verified destination phone number.

  • destination_phone_number(String):

    The verified destination phone number, in E.164 format.

  • created_timestamp(DateTime):

    The time when the destination phone number was created, in UNIX epoch time format.

• On failure, responds with SdkError<DeleteVerifiedDestinationNumberError>

impl Client

pub fn delete_voice_message_spend_limit_override( &self, ) -> DeleteVoiceMessageSpendLimitOverrideFluentBuilder

Constructs a fluent builder for the DeleteVoiceMessageSpendLimitOverride operation.

• The fluent builder takes no input, just send it.
• On success, responds with DeleteVoiceMessageSpendLimitOverrideOutput with field(s):
  • monthly_limit(Option<i64>):

    The current monthly limit, in US dollars.

• On failure, responds with SdkError<DeleteVoiceMessageSpendLimitOverrideError>

impl Client

pub fn describe_account_attributes( &self, ) -> DescribeAccountAttributesFluentBuilder

Constructs a fluent builder for the DescribeAccountAttributes operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return per each request.

    
    
• On success, responds with DescribeAccountAttributesOutput with field(s):
  • account_attributes(Option<Vec::<AccountAttribute>>):

    An array of AccountAttributes objects.

  • next_token(Option<String>):

    The token to be used for the next set of paginated results. If this field is empty then there are no more results.

• On failure, responds with SdkError<DescribeAccountAttributesError>

impl Client

pub fn describe_account_limits(&self) -> DescribeAccountLimitsFluentBuilder

Constructs a fluent builder for the DescribeAccountLimits operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return per each request.

    
    
• On success, responds with DescribeAccountLimitsOutput with field(s):
  • account_limits(Option<Vec::<AccountLimit>>):

    An array of AccountLimit objects that show the current spend limits.

  • next_token(Option<String>):

    The token to be used for the next set of paginated results. If this field is empty then there are no more results.

• On failure, responds with SdkError<DescribeAccountLimitsError>

impl Client

pub fn describe_configuration_sets( &self, ) -> DescribeConfigurationSetsFluentBuilder

Constructs a fluent builder for the DescribeConfigurationSets operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • configuration_set_names(impl Into<String>) / set_configuration_set_names(Option<Vec::<String>>):
    required: false
    

    An array of strings. Each element can be either a ConfigurationSetName or ConfigurationSetArn.

    
    
  • filters(ConfigurationSetFilter) / set_filters(Option<Vec::<ConfigurationSetFilter>>):
    required: false
    

    An array of filters to apply to the results that are returned.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return per each request.

    
    
• On success, responds with DescribeConfigurationSetsOutput with field(s):
  • configuration_sets(Option<Vec::<ConfigurationSetInformation>>):

    An array of ConfigurationSets objects.

  • next_token(Option<String>):

    The token to be used for the next set of paginated results. If this field is empty then there are no more results.

• On failure, responds with SdkError<DescribeConfigurationSetsError>

impl Client

pub fn describe_keywords(&self) -> DescribeKeywordsFluentBuilder

Constructs a fluent builder for the DescribeKeywords operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • origination_identity(impl Into<String>) / set_origination_identity(Option<String>):
    required: true
    

    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 AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

    
    
  • keywords(impl Into<String>) / set_keywords(Option<Vec::<String>>):
    required: false
    

    An array of keywords to search for.

    
    
  • filters(KeywordFilter) / set_filters(Option<Vec::<KeywordFilter>>):
    required: false
    

    An array of keyword filters to filter the results.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return per each request.

    
    
• On success, responds with DescribeKeywordsOutput with field(s):
  • origination_identity_arn(Option<String>):

    The PhoneNumberArn or PoolArn that is associated with the OriginationIdentity.

  • origination_identity(Option<String>):

    The PhoneNumberId or PoolId that is associated with the OriginationIdentity.

  • keywords(Option<Vec::<KeywordInformation>>):

    An array of KeywordInformation objects that contain the results.

  • next_token(Option<String>):

    The token to be used for the next set of paginated results. If this field is empty then there are no more results.

• On failure, responds with SdkError<DescribeKeywordsError>

impl Client

pub fn describe_opt_out_lists(&self) -> DescribeOptOutListsFluentBuilder

Constructs a fluent builder for the DescribeOptOutLists operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • opt_out_list_names(impl Into<String>) / set_opt_out_list_names(Option<Vec::<String>>):
    required: false
    

    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 AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return per each request.

    
    
  • owner(Owner) / set_owner(Option<Owner>):
    required: false
    

    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.

    
    
• On success, responds with DescribeOptOutListsOutput with field(s):
  • opt_out_lists(Option<Vec::<OptOutListInformation>>):

    An array of OptOutListInformation objects that contain the details for the requested OptOutLists.

  • next_token(Option<String>):

    The token to be used for the next set of paginated results. If this field is empty then there are no more results.

• On failure, responds with SdkError<DescribeOptOutListsError>

impl Client

pub fn describe_opted_out_numbers(&self) -> DescribeOptedOutNumbersFluentBuilder

Constructs a fluent builder for the DescribeOptedOutNumbers operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • opt_out_list_name(impl Into<String>) / set_opt_out_list_name(Option<String>):
    required: true
    

    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 AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

    
    
  • opted_out_numbers(impl Into<String>) / set_opted_out_numbers(Option<Vec::<String>>):
    required: false
    

    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.

    
    
  • filters(OptedOutFilter) / set_filters(Option<Vec::<OptedOutFilter>>):
    required: false
    

    An array of OptedOutFilter objects to filter the results on.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return per each request.

    
    
• On success, responds with DescribeOptedOutNumbersOutput with field(s):
  • opt_out_list_arn(Option<String>):

    The Amazon Resource Name (ARN) of the OptOutList.

  • opt_out_list_name(Option<String>):

    The name of the OptOutList.

  • opted_out_numbers(Option<Vec::<OptedOutNumberInformation>>):

    An array of OptedOutNumbersInformation objects that provide information about the requested OptedOutNumbers.

  • next_token(Option<String>):

    The token to be used for the next set of paginated results. If this field is empty then there are no more results.

• On failure, responds with SdkError<DescribeOptedOutNumbersError>

impl Client

pub fn describe_phone_numbers(&self) -> DescribePhoneNumbersFluentBuilder

Constructs a fluent builder for the DescribePhoneNumbers operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • phone_number_ids(impl Into<String>) / set_phone_number_ids(Option<Vec::<String>>):
    required: false
    

    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 AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

    
    
  • filters(PhoneNumberFilter) / set_filters(Option<Vec::<PhoneNumberFilter>>):
    required: false
    

    An array of PhoneNumberFilter objects to filter the results.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return per each request.

    
    
  • owner(Owner) / set_owner(Option<Owner>):
    required: false
    

    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.

    
    
• On success, responds with DescribePhoneNumbersOutput with field(s):
  • phone_numbers(Option<Vec::<PhoneNumberInformation>>):

    An array of PhoneNumberInformation objects that contain the details for the requested phone numbers.

  • next_token(Option<String>):

    The token to be used for the next set of paginated results. If this field is empty then there are no more results.

• On failure, responds with SdkError<DescribePhoneNumbersError>

impl Client

pub fn describe_pools(&self) -> DescribePoolsFluentBuilder

Constructs a fluent builder for the DescribePools operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • pool_ids(impl Into<String>) / set_pool_ids(Option<Vec::<String>>):
    required: false
    

    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 AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

    
    
  • filters(PoolFilter) / set_filters(Option<Vec::<PoolFilter>>):
    required: false
    

    An array of PoolFilter objects to filter the results.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return per each request.

    
    
  • owner(Owner) / set_owner(Option<Owner>):
    required: false
    

    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.

    
    
• On success, responds with DescribePoolsOutput with field(s):
  • pools(Option<Vec::<PoolInformation>>):

    An array of PoolInformation objects that contain the details for the requested pools.

  • next_token(Option<String>):

    The token to be used for the next set of paginated results. If this field is empty then there are no more results.

• On failure, responds with SdkError<DescribePoolsError>

impl Client

pub fn describe_protect_configurations( &self, ) -> DescribeProtectConfigurationsFluentBuilder

Constructs a fluent builder for the DescribeProtectConfigurations operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • protect_configuration_ids(impl Into<String>) / set_protect_configuration_ids(Option<Vec::<String>>):
    required: false
    

    An array of protect configuration identifiers to search for.

    
    
  • filters(ProtectConfigurationFilter) / set_filters(Option<Vec::<ProtectConfigurationFilter>>):
    required: false
    

    An array of ProtectConfigurationFilter objects to filter the results.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return per each request.

    
    
• On success, responds with DescribeProtectConfigurationsOutput with field(s):
  • protect_configurations(Option<Vec::<ProtectConfigurationInformation>>):

    An array of ProtectConfigurationInformation objects that contain the details for the request.

  • next_token(Option<String>):

    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.

• On failure, responds with SdkError<DescribeProtectConfigurationsError>

impl Client

pub fn describe_registration_attachments( &self, ) -> DescribeRegistrationAttachmentsFluentBuilder

Constructs a fluent builder for the DescribeRegistrationAttachments operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • registration_attachment_ids(impl Into<String>) / set_registration_attachment_ids(Option<Vec::<String>>):
    required: false
    

    The unique identifier of registration attachments to find. This is an array of RegistrationAttachmentId.

    
    
  • filters(RegistrationAttachmentFilter) / set_filters(Option<Vec::<RegistrationAttachmentFilter>>):
    required: false
    

    An array of RegistrationAttachmentFilter objects to filter the results.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return per each request.

    
    
• On success, responds with DescribeRegistrationAttachmentsOutput with field(s):
  • registration_attachments(Vec::<RegistrationAttachmentsInformation>):

    An array of RegistrationAttachments objects that contain the details for the requested registration attachments.

  • next_token(Option<String>):

    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.

• On failure, responds with SdkError<DescribeRegistrationAttachmentsError>

impl Client

pub fn describe_registration_field_definitions( &self, ) -> DescribeRegistrationFieldDefinitionsFluentBuilder

Constructs a fluent builder for the DescribeRegistrationFieldDefinitions operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • registration_type(impl Into<String>) / set_registration_type(Option<String>):
    required: true
    

    The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.

    
    
  • section_path(impl Into<String>) / set_section_path(Option<String>):
    required: false
    

    The path to the section of the registration.

    
    
  • field_paths(impl Into<String>) / set_field_paths(Option<Vec::<String>>):
    required: false
    

    An array of paths to the registration form field.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return per each request.

    
    
• On success, responds with DescribeRegistrationFieldDefinitionsOutput with field(s):
  • registration_type(String):

    The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.

  • registration_field_definitions(Vec::<RegistrationFieldDefinition>):

    An array of RegistrationFieldDefinitions objects that contain the details for the requested fields.

  • next_token(Option<String>):

    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.

• On failure, responds with SdkError<DescribeRegistrationFieldDefinitionsError>

impl Client

pub fn describe_registration_field_values( &self, ) -> DescribeRegistrationFieldValuesFluentBuilder

Constructs a fluent builder for the DescribeRegistrationFieldValues operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • registration_id(impl Into<String>) / set_registration_id(Option<String>):
    required: true
    

    The unique identifier for the registration.

    
    
  • version_number(i64) / set_version_number(Option<i64>):
    required: false
    

    The version number of the registration.

    
    
  • section_path(impl Into<String>) / set_section_path(Option<String>):
    required: false
    

    The path to the section of the registration.

    
    
  • field_paths(impl Into<String>) / set_field_paths(Option<Vec::<String>>):
    required: false
    

    An array of paths to the registration form field.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return per each request.

    
    
• On success, responds with DescribeRegistrationFieldValuesOutput with field(s):
  • registration_arn(String):

    The Amazon Resource Name (ARN) for the registration.

  • registration_id(String):

    The unique identifier for the registration.

  • version_number(i64):

    The current version of the registration.

  • registration_field_values(Vec::<RegistrationFieldValueInformation>):

    An array of RegistrationFieldValues objects that contain the values for the requested registration.

  • next_token(Option<String>):

    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.

• On failure, responds with SdkError<DescribeRegistrationFieldValuesError>

impl Client

pub fn describe_registration_section_definitions( &self, ) -> DescribeRegistrationSectionDefinitionsFluentBuilder

Constructs a fluent builder for the DescribeRegistrationSectionDefinitions operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • registration_type(impl Into<String>) / set_registration_type(Option<String>):
    required: true
    

    The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.

    
    
  • section_paths(impl Into<String>) / set_section_paths(Option<Vec::<String>>):
    required: false
    

    An array of paths for the registration form section.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return per each request.

    
    
• On success, responds with DescribeRegistrationSectionDefinitionsOutput with field(s):
  • registration_type(String):

    The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.

  • registration_section_definitions(Vec::<RegistrationSectionDefinition>):

    An array of RegistrationSectionDefinition objects.

  • next_token(Option<String>):

    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.

• On failure, responds with SdkError<DescribeRegistrationSectionDefinitionsError>

impl Client

pub fn describe_registration_type_definitions( &self, ) -> DescribeRegistrationTypeDefinitionsFluentBuilder

Constructs a fluent builder for the DescribeRegistrationTypeDefinitions operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • registration_types(impl Into<String>) / set_registration_types(Option<Vec::<String>>):
    required: false
    

    The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.

    
    
  • filters(RegistrationTypeFilter) / set_filters(Option<Vec::<RegistrationTypeFilter>>):
    required: false
    

    An array of RegistrationFilter objects to filter the results.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return per each request.

    
    
• On success, responds with DescribeRegistrationTypeDefinitionsOutput with field(s):
  • registration_type_definitions(Vec::<RegistrationTypeDefinition>):

    The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.

  • next_token(Option<String>):

    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.

• On failure, responds with SdkError<DescribeRegistrationTypeDefinitionsError>

impl Client

pub fn describe_registration_versions( &self, ) -> DescribeRegistrationVersionsFluentBuilder

Constructs a fluent builder for the DescribeRegistrationVersions operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • registration_id(impl Into<String>) / set_registration_id(Option<String>):
    required: true
    

    The unique identifier for the registration.

    
    
  • version_numbers(i64) / set_version_numbers(Option<Vec::<i64>>):
    required: false
    

    An array of registration version numbers.

    
    
  • filters(RegistrationVersionFilter) / set_filters(Option<Vec::<RegistrationVersionFilter>>):
    required: false
    

    An array of RegistrationVersionFilter objects to filter the results.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return per each request.

    
    
• On success, responds with DescribeRegistrationVersionsOutput with field(s):
  • registration_arn(String):

    The Amazon Resource Name (ARN) for the registration.

  • registration_id(String):

    The unique identifier for the registration.

  • registration_versions(Vec::<RegistrationVersionInformation>):

    An array of RegistrationVersions objects.

  • next_token(Option<String>):

    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.

• On failure, responds with SdkError<DescribeRegistrationVersionsError>

impl Client

pub fn describe_registrations(&self) -> DescribeRegistrationsFluentBuilder

Constructs a fluent builder for the DescribeRegistrations operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • registration_ids(impl Into<String>) / set_registration_ids(Option<Vec::<String>>):
    required: false
    

    An array of unique identifiers for each registration.

    
    
  • filters(RegistrationFilter) / set_filters(Option<Vec::<RegistrationFilter>>):
    required: false
    

    An array of RegistrationFilter objects to filter the results.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return per each request.

    
    
• On success, responds with DescribeRegistrationsOutput with field(s):
  • registrations(Vec::<RegistrationInformation>):

    An array of RegistrationInformation objects.

  • next_token(Option<String>):

    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.

• On failure, responds with SdkError<DescribeRegistrationsError>

impl Client

pub fn describe_sender_ids(&self) -> DescribeSenderIdsFluentBuilder

Constructs a fluent builder for the DescribeSenderIds operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • sender_ids(SenderIdAndCountry) / set_sender_ids(Option<Vec::<SenderIdAndCountry>>):
    required: false
    

    An array of SenderIdAndCountry objects to search for.

    If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

    
    
  • filters(SenderIdFilter) / set_filters(Option<Vec::<SenderIdFilter>>):
    required: false
    

    An array of SenderIdFilter objects to filter the results.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return per each request.

    
    
  • owner(Owner) / set_owner(Option<Owner>):
    required: false
    

    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.

    
    
• On success, responds with DescribeSenderIdsOutput with field(s):
  • sender_ids(Option<Vec::<SenderIdInformation>>):

    An array of SernderIdInformation objects that contain the details for the requested SenderIds.

  • next_token(Option<String>):

    The token to be used for the next set of paginated results. If this field is empty then there are no more results.

• On failure, responds with SdkError<DescribeSenderIdsError>

impl Client

pub fn describe_spend_limits(&self) -> DescribeSpendLimitsFluentBuilder

Constructs a fluent builder for the DescribeSpendLimits operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return per each request.

    
    
• On success, responds with DescribeSpendLimitsOutput with field(s):
  • spend_limits(Option<Vec::<SpendLimit>>):

    An array of SpendLimit objects that contain the details for the requested spend limits.

  • next_token(Option<String>):

    The token to be used for the next set of paginated results. If this field is empty then there are no more results.

• On failure, responds with SdkError<DescribeSpendLimitsError>

impl Client

pub fn describe_verified_destination_numbers( &self, ) -> DescribeVerifiedDestinationNumbersFluentBuilder

Constructs a fluent builder for the DescribeVerifiedDestinationNumbers operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • verified_destination_number_ids(impl Into<String>) / set_verified_destination_number_ids(Option<Vec::<String>>):
    required: false
    

    An array of VerifiedDestinationNumberid to retrieve.

    
    
  • destination_phone_numbers(impl Into<String>) / set_destination_phone_numbers(Option<Vec::<String>>):
    required: false
    

    An array of verified destination phone number, in E.164 format.

    
    
  • filters(VerifiedDestinationNumberFilter) / set_filters(Option<Vec::<VerifiedDestinationNumberFilter>>):
    required: false
    

    An array of VerifiedDestinationNumberFilter objects to filter the results.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return per each request.

    
    
• On success, responds with DescribeVerifiedDestinationNumbersOutput with field(s):
  • verified_destination_numbers(Vec::<VerifiedDestinationNumberInformation>):

    An array of VerifiedDestinationNumberInformation objects

  • next_token(Option<String>):

    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.

• On failure, responds with SdkError<DescribeVerifiedDestinationNumbersError>

impl Client

pub fn disassociate_origination_identity( &self, ) -> DisassociateOriginationIdentityFluentBuilder

Constructs a fluent builder for the DisassociateOriginationIdentity operation.

• The fluent builder is configurable:
  • pool_id(impl Into<String>) / set_pool_id(Option<String>):
    required: true
    

    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 AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

    
    
  • origination_identity(impl Into<String>) / set_origination_identity(Option<String>):
    required: true
    

    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 AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

    
    
  • iso_country_code(impl Into<String>) / set_iso_country_code(Option<String>):
    required: true
    

    The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    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.

    
    
• On success, responds with DisassociateOriginationIdentityOutput with field(s):
  • pool_arn(Option<String>):

    The Amazon Resource Name (ARN) of the pool.

  • pool_id(Option<String>):

    The PoolId of the pool no longer associated with the origination identity.

  • origination_identity_arn(Option<String>):

    The PhoneNumberArn or SenderIdArn of the origination identity.

  • origination_identity(Option<String>):

    The PhoneNumberId or SenderId of the origination identity.

  • iso_country_code(Option<String>):

    The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

• On failure, responds with SdkError<DisassociateOriginationIdentityError>

impl Client

pub fn disassociate_protect_configuration( &self, ) -> DisassociateProtectConfigurationFluentBuilder

Constructs a fluent builder for the DisassociateProtectConfiguration operation.

• The fluent builder is configurable:
  • protect_configuration_id(impl Into<String>) / set_protect_configuration_id(Option<String>):
    required: true
    

    The unique identifier for the protect configuration.

    
    
  • configuration_set_name(impl Into<String>) / set_configuration_set_name(Option<String>):
    required: true
    

    The name of the ConfigurationSet.

    
    
• On success, responds with DisassociateProtectConfigurationOutput with field(s):
  • configuration_set_arn(String):

    The Amazon Resource Name (ARN) of the configuration set.

  • configuration_set_name(String):

    The name of the ConfigurationSet.

  • protect_configuration_arn(String):

    The Amazon Resource Name (ARN) of the protect configuration.

  • protect_configuration_id(String):

    The unique identifier for the protect configuration.

• On failure, responds with SdkError<DisassociateProtectConfigurationError>

impl Client

pub fn discard_registration_version( &self, ) -> DiscardRegistrationVersionFluentBuilder

Constructs a fluent builder for the DiscardRegistrationVersion operation.

• The fluent builder is configurable:
  • registration_id(impl Into<String>) / set_registration_id(Option<String>):
    required: true
    

    The unique identifier for the registration.

    
    
• On success, responds with DiscardRegistrationVersionOutput with field(s):
  • registration_arn(String):

    The Amazon Resource Name (ARN) for the registration.

  • registration_id(String):

    The unique identifier for the registration.

  • version_number(i64):

    The version number of the registration.

  • registration_version_status(RegistrationVersionStatus):

    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.

  • registration_version_status_history(Option<RegistrationVersionStatusHistory>):

    The RegistrationVersionStatusHistory object contains the time stamps for when the reservations status changes.

• On failure, responds with SdkError<DiscardRegistrationVersionError>

impl Client

pub fn get_protect_configuration_country_rule_set( &self, ) -> GetProtectConfigurationCountryRuleSetFluentBuilder

Constructs a fluent builder for the GetProtectConfigurationCountryRuleSet operation.

• The fluent builder is configurable:
  • protect_configuration_id(impl Into<String>) / set_protect_configuration_id(Option<String>):
    required: true
    

    The unique identifier for the protect configuration.

    
    
  • number_capability(NumberCapability) / set_number_capability(Option<NumberCapability>):
    required: true
    

    The capability type to return the CountryRuleSet for. Valid values are SMS, VOICE, or MMS.

    
    
• On success, responds with GetProtectConfigurationCountryRuleSetOutput with field(s):
  • protect_configuration_arn(String):

    The Amazon Resource Name (ARN) of the protect configuration.

  • protect_configuration_id(String):

    The unique identifier for the protect configuration.

  • number_capability(NumberCapability):

    The capability type associated with the returned ProtectConfigurationCountryRuleSetInformation objects.

  • country_rule_set(HashMap::<String, ProtectConfigurationCountryRuleSetInformation>):

    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 AWS End User Messaging SMS User Guide.

• On failure, responds with SdkError<GetProtectConfigurationCountryRuleSetError>

impl Client

pub fn get_resource_policy(&self) -> GetResourcePolicyFluentBuilder

Constructs a fluent builder for the GetResourcePolicy operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the AWS End User Messaging SMS and Voice resource attached to the resource-based policy.

    
    
• On success, responds with GetResourcePolicyOutput with field(s):
  • resource_arn(Option<String>):

    The Amazon Resource Name (ARN) of the AWS End User Messaging SMS and Voice resource attached to the resource-based policy.

  • policy(Option<String>):

    The JSON formatted string that contains the resource-based policy attached to the AWS End User Messaging SMS and Voice resource.

  • created_timestamp(Option<DateTime>):

    The time when the resource-based policy was created, in UNIX epoch time format.

• On failure, responds with SdkError<GetResourcePolicyError>

impl Client

pub fn list_pool_origination_identities( &self, ) -> ListPoolOriginationIdentitiesFluentBuilder

Constructs a fluent builder for the ListPoolOriginationIdentities operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • pool_id(impl Into<String>) / set_pool_id(Option<String>):
    required: true
    

    The unique identifier for the pool. This value can be either the PoolId or PoolArn.

    If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

    
    
  • filters(PoolOriginationIdentitiesFilter) / set_filters(Option<Vec::<PoolOriginationIdentitiesFilter>>):
    required: false
    

    An array of PoolOriginationIdentitiesFilter objects to filter the results..

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return per each request.

    
    
• On success, responds with ListPoolOriginationIdentitiesOutput with field(s):
  • pool_arn(Option<String>):

    The Amazon Resource Name (ARN) for the pool.

  • pool_id(Option<String>):

    The unique PoolId of the pool.

  • origination_identities(Option<Vec::<OriginationIdentityMetadata>>):

    An array of any OriginationIdentityMetadata objects.

  • next_token(Option<String>):

    The token to be used for the next set of paginated results. If this field is empty then there are no more results.

• On failure, responds with SdkError<ListPoolOriginationIdentitiesError>

impl Client

pub fn list_protect_configuration_rule_set_number_overrides( &self, ) -> ListProtectConfigurationRuleSetNumberOverridesFluentBuilder

Constructs a fluent builder for the ListProtectConfigurationRuleSetNumberOverrides operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • protect_configuration_id(impl Into<String>) / set_protect_configuration_id(Option<String>):
    required: true
    

    The unique identifier for the protect configuration.

    
    
  • filters(ProtectConfigurationRuleSetNumberOverrideFilterItem) / set_filters(Option<Vec::<ProtectConfigurationRuleSetNumberOverrideFilterItem>>):
    required: false
    

    An array of ProtectConfigurationRuleSetNumberOverrideFilterItem objects to filter the results.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return per each request.

    
    
• On success, responds with ListProtectConfigurationRuleSetNumberOverridesOutput with field(s):
  • protect_configuration_arn(String):

    The Amazon Resource Name (ARN) of the protect configuration.

  • protect_configuration_id(String):

    The unique identifier for the protect configuration.

  • rule_set_number_overrides(Option<Vec::<ProtectConfigurationRuleSetNumberOverride>>):

    An array of RuleSetNumberOverrides objects.

  • next_token(Option<String>):

    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.

• On failure, responds with SdkError<ListProtectConfigurationRuleSetNumberOverridesError>

impl Client

pub fn list_registration_associations( &self, ) -> ListRegistrationAssociationsFluentBuilder

Constructs a fluent builder for the ListRegistrationAssociations operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • registration_id(impl Into<String>) / set_registration_id(Option<String>):
    required: true
    

    The unique identifier for the registration.

    
    
  • filters(RegistrationAssociationFilter) / set_filters(Option<Vec::<RegistrationAssociationFilter>>):
    required: false
    

    An array of RegistrationAssociationFilter to apply to the results that are returned.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return per each request.

    
    
• On success, responds with ListRegistrationAssociationsOutput with field(s):
  • registration_arn(String):

    The Amazon Resource Name (ARN) for the registration.

  • registration_id(String):

    The unique identifier for the registration.

  • registration_type(String):

    The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.

  • registration_associations(Vec::<RegistrationAssociationMetadata>):

    An array of RegistrationAssociationMetadata objects.

  • next_token(Option<String>):

    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.

• On failure, responds with SdkError<ListRegistrationAssociationsError>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the resource to query for.

    
    
• On success, responds with ListTagsForResourceOutput with field(s):
  • resource_arn(Option<String>):

    The ARN of the resource.

  • tags(Option<Vec::<Tag>>):

    An array of key and value pair tags that are associated with the resource.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn put_keyword(&self) -> PutKeywordFluentBuilder

Constructs a fluent builder for the PutKeyword operation.

• The fluent builder is configurable:
  • origination_identity(impl Into<String>) / set_origination_identity(Option<String>):
    required: true
    

    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 AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

    
    
  • keyword(impl Into<String>) / set_keyword(Option<String>):
    required: true
    

    The new keyword to add.

    
    
  • keyword_message(impl Into<String>) / set_keyword_message(Option<String>):
    required: true
    

    The message associated with the keyword.

    
    
  • keyword_action(KeywordAction) / set_keyword_action(Option<KeywordAction>):
    required: false
    

    The action to perform for the new keyword when it is received.

    • AUTOMATIC_RESPONSE: A message is sent to the recipient.

    • OPT_OUT: Keeps the recipient from receiving future messages.

    • OPT_IN: The recipient wants to receive future messages.

    
    
• On success, responds with PutKeywordOutput with field(s):
  • origination_identity_arn(Option<String>):

    The PhoneNumberArn or PoolArn that the keyword was associated with.

  • origination_identity(Option<String>):

    The PhoneNumberId or PoolId that the keyword was associated with.

  • keyword(Option<String>):

    The keyword that was added.

  • keyword_message(Option<String>):

    The message associated with the keyword.

  • keyword_action(Option<KeywordAction>):

    The action to perform when the keyword is used.

• On failure, responds with SdkError<PutKeywordError>

impl Client

pub fn put_message_feedback(&self) -> PutMessageFeedbackFluentBuilder

Constructs a fluent builder for the PutMessageFeedback operation.

• The fluent builder is configurable:
  • message_id(impl Into<String>) / set_message_id(Option<String>):
    required: true
    

    The unique identifier for the message.

    
    
  • message_feedback_status(MessageFeedbackStatus) / set_message_feedback_status(Option<MessageFeedbackStatus>):
    required: true
    

    Set the message feedback to be either RECEIVED or FAILED.

    
    
• On success, responds with PutMessageFeedbackOutput with field(s):
  • message_id(String):

    The unique identifier for the message.

  • message_feedback_status(MessageFeedbackStatus):

    The current status of the message.

• On failure, responds with SdkError<PutMessageFeedbackError>

impl Client

pub fn put_opted_out_number(&self) -> PutOptedOutNumberFluentBuilder

Constructs a fluent builder for the PutOptedOutNumber operation.

• The fluent builder is configurable:
  • opt_out_list_name(impl Into<String>) / set_opt_out_list_name(Option<String>):
    required: true
    

    The OptOutListName or OptOutListArn to add the phone number to.

    If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

    
    
  • opted_out_number(impl Into<String>) / set_opted_out_number(Option<String>):
    required: true
    

    The phone number to add to the OptOutList in E.164 format.

    
    
• On success, responds with PutOptedOutNumberOutput with field(s):
  • opt_out_list_arn(Option<String>):

    The OptOutListArn that the phone number was removed from.

  • opt_out_list_name(Option<String>):

    The OptOutListName that the phone number was removed from.

  • opted_out_number(Option<String>):

    The phone number that was added to the OptOutList.

  • opted_out_timestamp(Option<DateTime>):

    The time that the phone number was added to the OptOutList, in UNIX epoch time format.

  • end_user_opted_out(bool):

    This is true if it was the end user who requested their phone number be removed.

• On failure, responds with SdkError<PutOptedOutNumberError>

impl Client

pub fn put_protect_configuration_rule_set_number_override( &self, ) -> PutProtectConfigurationRuleSetNumberOverrideFluentBuilder

Constructs a fluent builder for the PutProtectConfigurationRuleSetNumberOverride operation.

• The fluent builder is configurable:
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    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.

    
    
  • protect_configuration_id(impl Into<String>) / set_protect_configuration_id(Option<String>):
    required: true
    

    The unique identifier for the protect configuration.

    
    
  • destination_phone_number(impl Into<String>) / set_destination_phone_number(Option<String>):
    required: true
    

    The destination phone number in E.164 format.

    
    
  • action(ProtectConfigurationRuleOverrideAction) / set_action(Option<ProtectConfigurationRuleOverrideAction>):
    required: true
    

    The action for the rule to either block or allow messages to the destination phone number.

    
    
  • expiration_timestamp(DateTime) / set_expiration_timestamp(Option<DateTime>):
    required: false
    

    The time the rule will expire at. If ExpirationTimestamp is not set then the rule does not expire.

    
    
• On success, responds with PutProtectConfigurationRuleSetNumberOverrideOutput with field(s):
  • protect_configuration_arn(String):

    The Amazon Resource Name (ARN) of the protect configuration.

  • protect_configuration_id(String):

    The unique identifier for the protect configuration.

  • destination_phone_number(String):

    The destination phone number in E.164 format.

  • created_timestamp(DateTime):

    The time when the rule was created, in UNIX epoch time format.

  • action(ProtectConfigurationRuleOverrideAction):

    The action for the rule to take.

  • iso_country_code(Option<String>):

    The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

  • expiration_timestamp(Option<DateTime>):

    The time the rule will expire at.

• On failure, responds with SdkError<PutProtectConfigurationRuleSetNumberOverrideError>

impl Client

pub fn put_registration_field_value( &self, ) -> PutRegistrationFieldValueFluentBuilder

Constructs a fluent builder for the PutRegistrationFieldValue operation.

• The fluent builder is configurable:
  • registration_id(impl Into<String>) / set_registration_id(Option<String>):
    required: true
    

    The unique identifier for the registration.

    
    
  • field_path(impl Into<String>) / set_field_path(Option<String>):
    required: true
    

    The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of FieldPaths.

    
    
  • select_choices(impl Into<String>) / set_select_choices(Option<Vec::<String>>):
    required: false
    

    An array of values for the form field.

    
    
  • text_value(impl Into<String>) / set_text_value(Option<String>):
    required: false
    

    The text data for a free form field.

    
    
  • registration_attachment_id(impl Into<String>) / set_registration_attachment_id(Option<String>):
    required: false
    

    The unique identifier for the registration attachment.

    
    
• On success, responds with PutRegistrationFieldValueOutput with field(s):
  • registration_arn(String):

    The Amazon Resource Name (ARN) for the registration.

  • registration_id(String):

    The unique identifier for the registration.

  • version_number(i64):

    The version number of the registration.

  • field_path(String):

    The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of FieldPaths.

  • select_choices(Option<Vec::<String>>):

    An array of values for the form field.

  • text_value(Option<String>):

    The text data for a free form field.

  • registration_attachment_id(Option<String>):

    The unique identifier for the registration attachment.

• On failure, responds with SdkError<PutRegistrationFieldValueError>

impl Client

pub fn put_resource_policy(&self) -> PutResourcePolicyFluentBuilder

Constructs a fluent builder for the PutResourcePolicy operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the AWS End User Messaging SMS and Voice resource to attach the resource-based policy to.

    
    
  • policy(impl Into<String>) / set_policy(Option<String>):
    required: true
    

    The JSON formatted resource-based policy to attach.

    
    
• On success, responds with PutResourcePolicyOutput with field(s):
  • resource_arn(Option<String>):

    The Amazon Resource Name (ARN) of the AWS End User Messaging SMS and Voice resource attached to the resource-based policy.

  • policy(Option<String>):

    The JSON formatted Resource Policy.

  • created_timestamp(Option<DateTime>):

    The time when the resource-based policy was created, in UNIX epoch time format.

• On failure, responds with SdkError<PutResourcePolicyError>

impl Client

pub fn release_phone_number(&self) -> ReleasePhoneNumberFluentBuilder

Constructs a fluent builder for the ReleasePhoneNumber operation.

• The fluent builder is configurable:
  • phone_number_id(impl Into<String>) / set_phone_number_id(Option<String>):
    required: true
    

    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 AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

    
    
• On success, responds with ReleasePhoneNumberOutput with field(s):
  • phone_number_arn(Option<String>):

    The PhoneNumberArn of the phone number that was released.

  • phone_number_id(Option<String>):

    The PhoneNumberId of the phone number that was released.

  • phone_number(Option<String>):

    The phone number that was released.

  • status(Option<NumberStatus>):

    The current status of the request.

  • iso_country_code(Option<String>):

    The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

  • message_type(Option<MessageType>):

    The message type that was associated with the phone number.

  • number_capabilities(Option<Vec::<NumberCapability>>):

    Specifies if the number could be used for text messages, voice, or both.

  • number_type(Option<NumberType>):

    The type of number that was released.

  • monthly_leasing_price(Option<String>):

    The monthly price of the phone number, in US dollars.

  • two_way_enabled(bool):

    By default this is set to false. When set to true you can receive incoming text messages from your end recipients.

  • two_way_channel_arn(Option<String>):

    The Amazon Resource Name (ARN) of the TwoWayChannel.

  • two_way_channel_role(Option<String>):

    An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.

  • self_managed_opt_outs_enabled(bool):

    By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice 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.

  • opt_out_list_name(Option<String>):

    The name of the OptOutList that was associated with the phone number.

  • registration_id(Option<String>):

    The unique identifier for the registration.

  • created_timestamp(Option<DateTime>):

    The time when the phone number was created, in UNIX epoch time format.

• On failure, responds with SdkError<ReleasePhoneNumberError>

impl Client

pub fn release_sender_id(&self) -> ReleaseSenderIdFluentBuilder

Constructs a fluent builder for the ReleaseSenderId operation.

• The fluent builder is configurable:
  • sender_id(impl Into<String>) / set_sender_id(Option<String>):
    required: true
    

    The sender ID to release.

    
    
  • iso_country_code(impl Into<String>) / set_iso_country_code(Option<String>):
    required: true
    

    The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

    
    
• On success, responds with ReleaseSenderIdOutput with field(s):
  • sender_id_arn(String):

    The Amazon Resource Name (ARN) associated with the SenderId.

  • sender_id(String):

    The sender ID that was released.

  • iso_country_code(String):

    The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

  • message_types(Vec::<MessageType>):

    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.

  • monthly_leasing_price(String):

    The monthly price, in US dollars, to lease the sender ID.

  • registered(bool):

    True if the sender ID is registered.

  • registration_id(Option<String>):

    The unique identifier for the registration.

• On failure, responds with SdkError<ReleaseSenderIdError>

impl Client

pub fn request_phone_number(&self) -> RequestPhoneNumberFluentBuilder

Constructs a fluent builder for the RequestPhoneNumber operation.

• The fluent builder is configurable:
  • iso_country_code(impl Into<String>) / set_iso_country_code(Option<String>):
    required: true
    

    The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

    
    
  • message_type(MessageType) / set_message_type(Option<MessageType>):
    required: true
    

    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.

    
    
  • number_capabilities(NumberCapability) / set_number_capabilities(Option<Vec::<NumberCapability>>):
    required: true
    

    Indicates if the phone number will be used for text messages, voice messages, or both.

    
    
  • number_type(RequestableNumberType) / set_number_type(Option<RequestableNumberType>):
    required: true
    

    The type of phone number to request.

    When you request a SIMULATOR phone number, you must set MessageType as TRANSACTIONAL.

    
    
  • opt_out_list_name(impl Into<String>) / set_opt_out_list_name(Option<String>):
    required: false
    

    The name of the OptOutList to associate with the phone number. You can use the OptOutListName or OptOutListArn.

    If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

    
    
  • pool_id(impl Into<String>) / set_pool_id(Option<String>):
    required: false
    

    The pool to associated with the phone number. You can use the PoolId or PoolArn.

    If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

    
    
  • registration_id(impl Into<String>) / set_registration_id(Option<String>):
    required: false
    

    Use this field to attach your phone number for an external registration process.

    
    
  • deletion_protection_enabled(bool) / set_deletion_protection_enabled(Option<bool>):
    required: false
    

    By default this is set to false. When set to true the phone number can’t be deleted.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    An array of tags (key and value pairs) associate with the requested phone number.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    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.

    
    
• On success, responds with RequestPhoneNumberOutput with field(s):
  • phone_number_arn(Option<String>):

    The Amazon Resource Name (ARN) of the requested phone number.

  • phone_number_id(Option<String>):

    The unique identifier of the new phone number.

  • phone_number(Option<String>):

    The new phone number that was requested.

  • status(Option<NumberStatus>):

    The current status of the request.

  • iso_country_code(Option<String>):

    The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

  • message_type(Option<MessageType>):

    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.

  • number_capabilities(Option<Vec::<NumberCapability>>):

    Indicates if the phone number will be used for text messages, voice messages or both.

  • number_type(Option<RequestableNumberType>):

    The type of number that was released.

  • monthly_leasing_price(Option<String>):

    The monthly price, in US dollars, to lease the phone number.

  • two_way_enabled(bool):

    By default this is set to false. When set to true you can receive incoming text messages from your end recipients.

  • two_way_channel_arn(Option<String>):

    The ARN used to identify the two way channel.

  • two_way_channel_role(Option<String>):

    An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.

  • self_managed_opt_outs_enabled(bool):

    By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice 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.

  • opt_out_list_name(Option<String>):

    The name of the OptOutList that is associated with the requested phone number.

  • deletion_protection_enabled(bool):

    By default this is set to false. When set to true the phone number can’t be deleted.

  • pool_id(Option<String>):

    The unique identifier of the pool associated with the phone number

  • registration_id(Option<String>):

    The unique identifier for the registration.

  • tags(Option<Vec::<Tag>>):

    An array of key and value pair tags that are associated with the phone number.

  • created_timestamp(Option<DateTime>):

    The time when the phone number was created, in UNIX epoch time format.

• On failure, responds with SdkError<RequestPhoneNumberError>

impl Client

pub fn request_sender_id(&self) -> RequestSenderIdFluentBuilder

Constructs a fluent builder for the RequestSenderId operation.

• The fluent builder is configurable:
  • sender_id(impl Into<String>) / set_sender_id(Option<String>):
    required: true
    

    The sender ID string to request.

    
    
  • iso_country_code(impl Into<String>) / set_iso_country_code(Option<String>):
    required: true
    

    The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

    
    
  • message_types(MessageType) / set_message_types(Option<Vec::<MessageType>>):
    required: false
    

    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.

    
    
  • deletion_protection_enabled(bool) / set_deletion_protection_enabled(Option<bool>):
    required: false
    

    By default this is set to false. When set to true the sender ID can’t be deleted.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    An array of tags (key and value pairs) to associate with the sender ID.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    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.

    
    
• On success, responds with RequestSenderIdOutput with field(s):
  • sender_id_arn(String):

    The Amazon Resource Name (ARN) associated with the SenderId.

  • sender_id(String):

    The sender ID that was requested.

  • iso_country_code(String):

    The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

  • message_types(Vec::<MessageType>):

    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.

  • monthly_leasing_price(String):

    The monthly price, in US dollars, to lease the sender ID.

  • deletion_protection_enabled(bool):

    By default this is set to false. When set to true the sender ID can’t be deleted.

  • registered(bool):

    True if the sender ID is registered.

  • tags(Option<Vec::<Tag>>):

    An array of tags (key and value pairs) to associate with the sender ID.

• On failure, responds with SdkError<RequestSenderIdError>

impl Client

pub fn send_destination_number_verification_code( &self, ) -> SendDestinationNumberVerificationCodeFluentBuilder

Constructs a fluent builder for the SendDestinationNumberVerificationCode operation.

• The fluent builder is configurable:
  • verified_destination_number_id(impl Into<String>) / set_verified_destination_number_id(Option<String>):
    required: true
    

    The unique identifier for the verified destination phone number.

    
    
  • verification_channel(VerificationChannel) / set_verification_channel(Option<VerificationChannel>):
    required: true
    

    Choose to send the verification code as an SMS or voice message.

    
    
  • language_code(LanguageCode) / set_language_code(Option<LanguageCode>):
    required: false
    

    Choose the language to use for the message.

    
    
  • origination_identity(impl Into<String>) / set_origination_identity(Option<String>):
    required: false
    

    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 AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

    
    
  • configuration_set_name(impl Into<String>) / set_configuration_set_name(Option<String>):
    required: false
    

    The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.

    
    
  • context(impl Into<String>, impl Into<String>) / set_context(Option<HashMap::<String, String>>):
    required: false
    

    You can specify custom data in this field. If you do, that data is logged to the event destination.

    
    
  • destination_country_parameters(DestinationCountryParameterKey, impl Into<String>) / set_destination_country_parameters(Option<HashMap::<DestinationCountryParameterKey, String>>):
    required: false
    

    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.

    
    
• On success, responds with SendDestinationNumberVerificationCodeOutput with field(s):
  • message_id(String):

    The unique identifier for the message.

• On failure, responds with SdkError<SendDestinationNumberVerificationCodeError>

impl Client

pub fn send_media_message(&self) -> SendMediaMessageFluentBuilder

Constructs a fluent builder for the SendMediaMessage operation.

• The fluent builder is configurable:
  • destination_phone_number(impl Into<String>) / set_destination_phone_number(Option<String>):
    required: true
    

    The destination phone number in E.164 format.

    
    
  • origination_identity(impl Into<String>) / set_origination_identity(Option<String>):
    required: true
    

    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 AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

    
    
  • message_body(impl Into<String>) / set_message_body(Option<String>):
    required: false
    

    The text body of the message.

    
    
  • media_urls(impl Into<String>) / set_media_urls(Option<Vec::<String>>):
    required: false
    

    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.

    
    
  • configuration_set_name(impl Into<String>) / set_configuration_set_name(Option<String>):
    required: false
    

    The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.

    
    
  • max_price(impl Into<String>) / set_max_price(Option<String>):
    required: false
    

    The maximum amount that you want to spend, in US dollars, per each MMS message.

    
    
  • time_to_live(i32) / set_time_to_live(Option<i32>):
    required: false
    

    How long the media message is valid for. By default this is 72 hours.

    
    
  • context(impl Into<String>, impl Into<String>) / set_context(Option<HashMap::<String, String>>):
    required: false
    

    You can specify custom data in this field. If you do, that data is logged to the event destination.

    
    
  • dry_run(bool) / set_dry_run(Option<bool>):
    required: false
    

    When set to true, the message is checked and validated, but isn’t sent to the end recipient.

    
    
  • protect_configuration_id(impl Into<String>) / set_protect_configuration_id(Option<String>):
    required: false
    

    The unique identifier of the protect configuration to use.

    
    
  • message_feedback_enabled(bool) / set_message_feedback_enabled(Option<bool>):
    required: false
    

    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.

    
    
• On success, responds with SendMediaMessageOutput with field(s):
  • message_id(Option<String>):

    The unique identifier for the message.

• On failure, responds with SdkError<SendMediaMessageError>

impl Client

pub fn send_text_message(&self) -> SendTextMessageFluentBuilder

Constructs a fluent builder for the SendTextMessage operation.

• The fluent builder is configurable:
  • destination_phone_number(impl Into<String>) / set_destination_phone_number(Option<String>):
    required: true
    

    The destination phone number in E.164 format.

    
    
  • origination_identity(impl Into<String>) / set_origination_identity(Option<String>):
    required: false
    

    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 AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

    
    
  • message_body(impl Into<String>) / set_message_body(Option<String>):
    required: false
    

    The body of the text message.

    
    
  • message_type(MessageType) / set_message_type(Option<MessageType>):
    required: false
    

    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.

    
    
  • keyword(impl Into<String>) / set_keyword(Option<String>):
    required: false
    

    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.

    
    
  • configuration_set_name(impl Into<String>) / set_configuration_set_name(Option<String>):
    required: false
    

    The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.

    
    
  • max_price(impl Into<String>) / set_max_price(Option<String>):
    required: false
    

    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.

    
    
  • time_to_live(i32) / set_time_to_live(Option<i32>):
    required: false
    

    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.

    
    
  • context(impl Into<String>, impl Into<String>) / set_context(Option<HashMap::<String, String>>):
    required: false
    

    You can specify custom data in this field. If you do, that data is logged to the event destination.

    
    
  • destination_country_parameters(DestinationCountryParameterKey, impl Into<String>) / set_destination_country_parameters(Option<HashMap::<DestinationCountryParameterKey, String>>):
    required: false
    

    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.

    
    
  • dry_run(bool) / set_dry_run(Option<bool>):
    required: false
    

    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 AWS End User Messaging SMS User Guide..

    
    
  • protect_configuration_id(impl Into<String>) / set_protect_configuration_id(Option<String>):
    required: false
    

    The unique identifier for the protect configuration.

    
    
  • message_feedback_enabled(bool) / set_message_feedback_enabled(Option<bool>):
    required: false
    

    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.

    
    
• On success, responds with SendTextMessageOutput with field(s):
  • message_id(Option<String>):

    The unique identifier for the message.

• On failure, responds with SdkError<SendTextMessageError>

impl Client

pub fn send_voice_message(&self) -> SendVoiceMessageFluentBuilder

Constructs a fluent builder for the SendVoiceMessage operation.

• The fluent builder is configurable:
  • destination_phone_number(impl Into<String>) / set_destination_phone_number(Option<String>):
    required: true
    

    The destination phone number in E.164 format.

    
    
  • origination_identity(impl Into<String>) / set_origination_identity(Option<String>):
    required: true
    

    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 AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

    
    
  • message_body(impl Into<String>) / set_message_body(Option<String>):
    required: false
    

    The text to convert to a voice message.

    
    
  • message_body_text_type(VoiceMessageBodyTextType) / set_message_body_text_type(Option<VoiceMessageBodyTextType>):
    required: false
    

    Specifies if the MessageBody field contains text or speech synthesis markup language (SSML).

    • TEXT: This is the default value. When used the maximum character limit is 3000.

    • SSML: When used the maximum character limit is 6000 including SSML tagging.

    
    
  • voice_id(VoiceId) / set_voice_id(Option<VoiceId>):
    required: false
    

    The voice for the Amazon Polly service to use. By default this is set to “MATTHEW”.

    
    
  • configuration_set_name(impl Into<String>) / set_configuration_set_name(Option<String>):
    required: false
    

    The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.

    
    
  • max_price_per_minute(impl Into<String>) / set_max_price_per_minute(Option<String>):
    required: false
    

    The maximum amount to spend per voice message, in US dollars.

    
    
  • time_to_live(i32) / set_time_to_live(Option<i32>):
    required: false
    

    How long the voice message is valid for. By default this is 72 hours.

    
    
  • context(impl Into<String>, impl Into<String>) / set_context(Option<HashMap::<String, String>>):
    required: false
    

    You can specify custom data in this field. If you do, that data is logged to the event destination.

    
    
  • dry_run(bool) / set_dry_run(Option<bool>):
    required: false
    

    When set to true, the message is checked and validated, but isn’t sent to the end recipient.

    
    
  • protect_configuration_id(impl Into<String>) / set_protect_configuration_id(Option<String>):
    required: false
    

    The unique identifier for the protect configuration.

    
    
  • message_feedback_enabled(bool) / set_message_feedback_enabled(Option<bool>):
    required: false
    

    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.

    
    
• On success, responds with SendVoiceMessageOutput with field(s):
  • message_id(Option<String>):

    The unique identifier for the message.

• On failure, responds with SdkError<SendVoiceMessageError>

impl Client

pub fn set_account_default_protect_configuration( &self, ) -> SetAccountDefaultProtectConfigurationFluentBuilder

Constructs a fluent builder for the SetAccountDefaultProtectConfiguration operation.

• The fluent builder is configurable:
  • protect_configuration_id(impl Into<String>) / set_protect_configuration_id(Option<String>):
    required: true
    

    The unique identifier for the protect configuration.

    
    
• On success, responds with SetAccountDefaultProtectConfigurationOutput with field(s):
  • default_protect_configuration_arn(String):

    The Amazon Resource Name (ARN) of the account default protect configuration.

  • default_protect_configuration_id(String):

    The unique identifier of the account default protect configuration.

• On failure, responds with SdkError<SetAccountDefaultProtectConfigurationError>

impl Client

pub fn set_default_message_feedback_enabled( &self, ) -> SetDefaultMessageFeedbackEnabledFluentBuilder

Constructs a fluent builder for the SetDefaultMessageFeedbackEnabled operation.

• The fluent builder is configurable:
  • configuration_set_name(impl Into<String>) / set_configuration_set_name(Option<String>):
    required: true
    

    The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.

    
    
  • message_feedback_enabled(bool) / set_message_feedback_enabled(Option<bool>):
    required: true
    

    Set to true to enable message feedback.

    
    
• On success, responds with SetDefaultMessageFeedbackEnabledOutput with field(s):
  • configuration_set_arn(Option<String>):

    The arn of the configuration set.

  • configuration_set_name(Option<String>):

    The name of the configuration.

  • message_feedback_enabled(Option<bool>):

    True if message feedback is enabled.

• On failure, responds with SdkError<SetDefaultMessageFeedbackEnabledError>

impl Client

pub fn set_default_message_type(&self) -> SetDefaultMessageTypeFluentBuilder

Constructs a fluent builder for the SetDefaultMessageType operation.

• The fluent builder is configurable:
  • configuration_set_name(impl Into<String>) / set_configuration_set_name(Option<String>):
    required: true
    

    The configuration set to update with a new default message type. This field can be the ConsigurationSetName or ConfigurationSetArn.

    
    
  • message_type(MessageType) / set_message_type(Option<MessageType>):
    required: true
    

    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.

    
    
• On success, responds with SetDefaultMessageTypeOutput with field(s):
  • configuration_set_arn(Option<String>):

    The Amazon Resource Name (ARN) of the updated configuration set.

  • configuration_set_name(Option<String>):

    The name of the configuration set that was updated.

  • message_type(Option<MessageType>):

    The new default message type of the configuration set.

• On failure, responds with SdkError<SetDefaultMessageTypeError>

impl Client

pub fn set_default_sender_id(&self) -> SetDefaultSenderIdFluentBuilder

Constructs a fluent builder for the SetDefaultSenderId operation.

• The fluent builder is configurable:
  • configuration_set_name(impl Into<String>) / set_configuration_set_name(Option<String>):
    required: true
    

    The configuration set to updated with a new default SenderId. This field can be the ConsigurationSetName or ConfigurationSetArn.

    
    
  • sender_id(impl Into<String>) / set_sender_id(Option<String>):
    required: true
    

    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’.

    
    
• On success, responds with SetDefaultSenderIdOutput with field(s):
  • configuration_set_arn(Option<String>):

    The Amazon Resource Name (ARN) of the updated configuration set.

  • configuration_set_name(Option<String>):

    The name of the configuration set that was updated.

  • sender_id(Option<String>):

    The default sender ID to set for the ConfigurationSet.

• On failure, responds with SdkError<SetDefaultSenderIdError>

impl Client

pub fn set_media_message_spend_limit_override( &self, ) -> SetMediaMessageSpendLimitOverrideFluentBuilder

Constructs a fluent builder for the SetMediaMessageSpendLimitOverride operation.

• The fluent builder is configurable:
  • monthly_limit(i64) / set_monthly_limit(Option<i64>):
    required: true
    

    The new monthly limit to enforce on text messages.

    
    
• On success, responds with SetMediaMessageSpendLimitOverrideOutput with field(s):
  • monthly_limit(Option<i64>):

    The current monthly limit to enforce on sending text messages.

• On failure, responds with SdkError<SetMediaMessageSpendLimitOverrideError>

impl Client

pub fn set_text_message_spend_limit_override( &self, ) -> SetTextMessageSpendLimitOverrideFluentBuilder

Constructs a fluent builder for the SetTextMessageSpendLimitOverride operation.

• The fluent builder is configurable:
  • monthly_limit(i64) / set_monthly_limit(Option<i64>):
    required: true
    

    The new monthly limit to enforce on text messages.

    
    
• On success, responds with SetTextMessageSpendLimitOverrideOutput with field(s):
  • monthly_limit(Option<i64>):

    The current monthly limit to enforce on sending text messages.

• On failure, responds with SdkError<SetTextMessageSpendLimitOverrideError>

impl Client

pub fn set_voice_message_spend_limit_override( &self, ) -> SetVoiceMessageSpendLimitOverrideFluentBuilder

Constructs a fluent builder for the SetVoiceMessageSpendLimitOverride operation.

• The fluent builder is configurable:
  • monthly_limit(i64) / set_monthly_limit(Option<i64>):
    required: true
    

    The new monthly limit to enforce on voice messages.

    
    
• On success, responds with SetVoiceMessageSpendLimitOverrideOutput with field(s):
  • monthly_limit(Option<i64>):

    The current monthly limit to enforce on sending voice messages.

• On failure, responds with SdkError<SetVoiceMessageSpendLimitOverrideError>

impl Client

pub fn submit_registration_version( &self, ) -> SubmitRegistrationVersionFluentBuilder

Constructs a fluent builder for the SubmitRegistrationVersion operation.

• The fluent builder is configurable:
  • registration_id(impl Into<String>) / set_registration_id(Option<String>):
    required: true
    

    The unique identifier for the registration.

    
    
• On success, responds with SubmitRegistrationVersionOutput with field(s):
  • registration_arn(String):

    The Amazon Resource Name (ARN) for the registration.

  • registration_id(String):

    The unique identifier for the registration.

  • version_number(i64):

    The version number of the registration.

  • registration_version_status(RegistrationVersionStatus):

    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.

  • registration_version_status_history(Option<RegistrationVersionStatusHistory>):

    The RegistrationVersionStatusHistory object contains the time stamps for when the reservations status changes.

• On failure, responds with SdkError<SubmitRegistrationVersionError>

impl Client

pub fn tag_resource(&self) -> TagResourceFluentBuilder

Constructs a fluent builder for the TagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the resource.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: true
    

    An array of key and value pair tags that are associated with the resource.

    
    
• On success, responds with TagResourceOutput
• On failure, responds with SdkError<TagResourceError>

impl Client

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the resource.

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: true
    

    An array of tag key values to unassociate with the resource.

    
    
• On success, responds with UntagResourceOutput
• On failure, responds with SdkError<UntagResourceError>

impl Client

pub fn update_event_destination(&self) -> UpdateEventDestinationFluentBuilder

Constructs a fluent builder for the UpdateEventDestination operation.

• The fluent builder is configurable:
  • configuration_set_name(impl Into<String>) / set_configuration_set_name(Option<String>):
    required: true
    

    The configuration set to update with the new event destination. Valid values for this can be the ConfigurationSetName or ConfigurationSetArn.

    
    
  • event_destination_name(impl Into<String>) / set_event_destination_name(Option<String>):
    required: true
    

    The name to use for the event destination.

    
    
  • enabled(bool) / set_enabled(Option<bool>):
    required: false
    

    When set to true logging is enabled.

    
    
  • matching_event_types(EventType) / set_matching_event_types(Option<Vec::<EventType>>):
    required: false
    

    An array of event types that determine which events to log.

    The TEXT_SENT event type is not supported.

    
    
  • cloud_watch_logs_destination(CloudWatchLogsDestination) / set_cloud_watch_logs_destination(Option<CloudWatchLogsDestination>):
    required: false
    

    An object that contains information about an event destination that sends data to CloudWatch Logs.

    
    
  • kinesis_firehose_destination(KinesisFirehoseDestination) / set_kinesis_firehose_destination(Option<KinesisFirehoseDestination>):
    required: false
    

    An object that contains information about an event destination for logging to Firehose.

    
    
  • sns_destination(SnsDestination) / set_sns_destination(Option<SnsDestination>):
    required: false
    

    An object that contains information about an event destination that sends data to Amazon SNS.

    
    
• On success, responds with UpdateEventDestinationOutput with field(s):
  • configuration_set_arn(Option<String>):

    The Amazon Resource Name (ARN) for the ConfigurationSet that was updated.

  • configuration_set_name(Option<String>):

    The name of the configuration set.

  • event_destination(Option<EventDestination>):

    An EventDestination object containing the details of where events will be logged.

• On failure, responds with SdkError<UpdateEventDestinationError>

impl Client

pub fn update_phone_number(&self) -> UpdatePhoneNumberFluentBuilder

Constructs a fluent builder for the UpdatePhoneNumber operation.

• The fluent builder is configurable:
  • phone_number_id(impl Into<String>) / set_phone_number_id(Option<String>):
    required: true
    

    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 AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

    
    
  • two_way_enabled(bool) / set_two_way_enabled(Option<bool>):
    required: false
    

    By default this is set to false. When set to true you can receive incoming text messages from your end recipients.

    
    
  • two_way_channel_arn(impl Into<String>) / set_two_way_channel_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the two way channel.

    
    
  • two_way_channel_role(impl Into<String>) / set_two_way_channel_role(Option<String>):
    required: false
    

    An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.

    
    
  • self_managed_opt_outs_enabled(bool) / set_self_managed_opt_outs_enabled(Option<bool>):
    required: false
    

    By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice 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.

    
    
  • opt_out_list_name(impl Into<String>) / set_opt_out_list_name(Option<String>):
    required: false
    

    The OptOutList to add the phone number to. Valid values for this field can be either the OutOutListName or OutOutListArn.

    
    
  • deletion_protection_enabled(bool) / set_deletion_protection_enabled(Option<bool>):
    required: false
    

    By default this is set to false. When set to true the phone number can’t be deleted.

    
    
• On success, responds with UpdatePhoneNumberOutput with field(s):
  • phone_number_arn(Option<String>):

    The Amazon Resource Name (ARN) of the updated phone number.

  • phone_number_id(Option<String>):

    The unique identifier of the phone number.

  • phone_number(Option<String>):

    The phone number that was updated.

  • status(Option<NumberStatus>):

    The current status of the request.

  • iso_country_code(Option<String>):

    The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

  • message_type(Option<MessageType>):

    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.

  • number_capabilities(Option<Vec::<NumberCapability>>):

    Specifies if the number could be used for text messages, voice or both.

  • number_type(Option<NumberType>):

    The type of number that was requested.

  • monthly_leasing_price(Option<String>):

    The monthly leasing price of the phone number, in US dollars.

  • two_way_enabled(bool):

    By default this is set to false. When set to true you can receive incoming text messages from your end recipients.

  • two_way_channel_arn(Option<String>):

    The Amazon Resource Name (ARN) of the two way channel.

  • two_way_channel_role(Option<String>):

    An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.

  • self_managed_opt_outs_enabled(bool):

    This is true if self managed opt-out are enabled.

  • opt_out_list_name(Option<String>):

    The name of the OptOutList associated with the phone number.

  • deletion_protection_enabled(bool):

    When set to true the phone number can’t be deleted.

  • registration_id(Option<String>):

    The unique identifier for the registration.

  • created_timestamp(Option<DateTime>):

    The time when the phone number was created, in UNIX epoch time format.

• On failure, responds with SdkError<UpdatePhoneNumberError>

impl Client

pub fn update_pool(&self) -> UpdatePoolFluentBuilder

Constructs a fluent builder for the UpdatePool operation.

• The fluent builder is configurable:
  • pool_id(impl Into<String>) / set_pool_id(Option<String>):
    required: true
    

    The unique identifier of the pool to update. Valid values are either the PoolId or PoolArn.

    If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

    
    
  • two_way_enabled(bool) / set_two_way_enabled(Option<bool>):
    required: false
    

    By default this is set to false. When set to true you can receive incoming text messages from your end recipients.

    
    
  • two_way_channel_arn(impl Into<String>) / set_two_way_channel_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the two way channel.

    
    
  • two_way_channel_role(impl Into<String>) / set_two_way_channel_role(Option<String>):
    required: false
    

    An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.

    
    
  • self_managed_opt_outs_enabled(bool) / set_self_managed_opt_outs_enabled(Option<bool>):
    required: false
    

    By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice 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.

    
    
  • opt_out_list_name(impl Into<String>) / set_opt_out_list_name(Option<String>):
    required: false
    

    The OptOutList to associate with the pool. Valid values are either OptOutListName or OptOutListArn.

    If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

    
    
  • shared_routes_enabled(bool) / set_shared_routes_enabled(Option<bool>):
    required: false
    

    Indicates whether shared routes are enabled for the pool.

    
    
  • deletion_protection_enabled(bool) / set_deletion_protection_enabled(Option<bool>):
    required: false
    

    When set to true the pool can’t be deleted.

    
    
• On success, responds with UpdatePoolOutput with field(s):
  • pool_arn(Option<String>):

    The ARN of the pool.

  • pool_id(Option<String>):

    The unique identifier of the pool.

  • status(Option<PoolStatus>):

    The current status of the pool update request.

  • message_type(Option<MessageType>):

    The type of message for the pool to use.

  • two_way_enabled(bool):

    By default this is set to false. When set to true you can receive incoming text messages from your end recipients.

  • two_way_channel_arn(Option<String>):

    The Amazon Resource Name (ARN) of the two way channel.

  • two_way_channel_role(Option<String>):

    An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.

  • self_managed_opt_outs_enabled(bool):

    When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice 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.

  • opt_out_list_name(Option<String>):

    The name of the OptOutList associated with the pool.

  • shared_routes_enabled(bool):

    Indicates whether shared routes are enabled for the pool.

  • deletion_protection_enabled(bool):

    When set to true the pool can’t be deleted.

  • created_timestamp(Option<DateTime>):

    The time when the pool was created, in UNIX epoch time format.

• On failure, responds with SdkError<UpdatePoolError>

impl Client

pub fn update_protect_configuration( &self, ) -> UpdateProtectConfigurationFluentBuilder

Constructs a fluent builder for the UpdateProtectConfiguration operation.

• The fluent builder is configurable:
  • protect_configuration_id(impl Into<String>) / set_protect_configuration_id(Option<String>):
    required: true
    

    The unique identifier for the protect configuration.

    
    
  • deletion_protection_enabled(bool) / set_deletion_protection_enabled(Option<bool>):
    required: false
    

    When set to true deletion protection is enabled. By default this is set to false.

    
    
• On success, responds with UpdateProtectConfigurationOutput with field(s):
  • protect_configuration_arn(String):

    The Amazon Resource Name (ARN) of the protect configuration.

  • protect_configuration_id(String):

    The unique identifier for the protect configuration.

  • created_timestamp(DateTime):

    The time when the protect configuration was created, in UNIX epoch time format.

  • account_default(bool):

    This is true if the protect configuration is set as your account default protect configuration.

  • deletion_protection_enabled(bool):

    The status of deletion protection for the protect configuration. When set to true deletion protection is enabled. By default this is set to false.

• On failure, responds with SdkError<UpdateProtectConfigurationError>

impl Client

pub fn update_protect_configuration_country_rule_set( &self, ) -> UpdateProtectConfigurationCountryRuleSetFluentBuilder

Constructs a fluent builder for the UpdateProtectConfigurationCountryRuleSet operation.

• The fluent builder is configurable:
  • protect_configuration_id(impl Into<String>) / set_protect_configuration_id(Option<String>):
    required: true
    

    The unique identifier for the protect configuration.

    
    
  • number_capability(NumberCapability) / set_number_capability(Option<NumberCapability>):
    required: true
    

    The number capability to apply the CountryRuleSetUpdates updates to.

    
    
  • country_rule_set_updates(impl Into<String>, ProtectConfigurationCountryRuleSetInformation) / set_country_rule_set_updates(Option<HashMap::<String, ProtectConfigurationCountryRuleSetInformation>>):
    required: true
    

    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 AWS 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” } }

    
    
• On success, responds with UpdateProtectConfigurationCountryRuleSetOutput with field(s):
  • protect_configuration_arn(String):

    The Amazon Resource Name (ARN) of the protect configuration.

  • protect_configuration_id(String):

    The unique identifier for the protect configuration.

  • number_capability(NumberCapability):

    The number capability that was updated

  • country_rule_set(HashMap::<String, ProtectConfigurationCountryRuleSetInformation>):

    An array of ProtectConfigurationCountryRuleSetInformation containing the rules for the NumberCapability.

• On failure, responds with SdkError<UpdateProtectConfigurationCountryRuleSetError>

impl Client

pub fn update_sender_id(&self) -> UpdateSenderIdFluentBuilder

Constructs a fluent builder for the UpdateSenderId operation.

• The fluent builder is configurable:
  • sender_id(impl Into<String>) / set_sender_id(Option<String>):
    required: true
    

    The sender ID to update.

    
    
  • iso_country_code(impl Into<String>) / set_iso_country_code(Option<String>):
    required: true
    

    The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

    
    
  • deletion_protection_enabled(bool) / set_deletion_protection_enabled(Option<bool>):
    required: false
    

    By default this is set to false. When set to true the sender ID can’t be deleted.

    
    
• On success, responds with UpdateSenderIdOutput with field(s):
  • sender_id_arn(String):

    The Amazon Resource Name (ARN) associated with the SenderId.

  • sender_id(String):

    The sender ID that was updated.

  • iso_country_code(String):

    The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

  • message_types(Vec::<MessageType>):

    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.

  • monthly_leasing_price(String):

    The monthly price, in US dollars, to lease the sender ID.

  • deletion_protection_enabled(bool):

    By default this is set to false. When set to true the sender ID can’t be deleted.

  • registered(bool):

    True if the sender ID is registered..

  • registration_id(Option<String>):

    The unique identifier for the registration.

• On failure, responds with SdkError<UpdateSenderIdError>

impl Client

pub fn verify_destination_number(&self) -> VerifyDestinationNumberFluentBuilder

Constructs a fluent builder for the VerifyDestinationNumber operation.

• The fluent builder is configurable:
  • verified_destination_number_id(impl Into<String>) / set_verified_destination_number_id(Option<String>):
    required: true
    

    The unique identifier for the verififed destination phone number.

    
    
  • verification_code(impl Into<String>) / set_verification_code(Option<String>):
    required: true
    

    The verification code that was received by the verified destination phone number.

    
    
• On success, responds with VerifyDestinationNumberOutput with field(s):
  • verified_destination_number_arn(String):

    The Amazon Resource Name (ARN) for the verified destination phone number.

  • verified_destination_number_id(String):

    The unique identifier for the verified destination phone number.

  • destination_phone_number(String):

    The phone number in E.164 format.

  • status(VerificationStatus):

    The status for being able to send messages to the phone number.

  • created_timestamp(DateTime):

    The time when the destination phone number was created, in UNIX epoch time format.

• On failure, responds with SdkError<VerifyDestinationNumberError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

• Retries or timeouts are enabled without a sleep_impl configured.
• Identity caching is enabled without a sleep_impl and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.