Struct Client 

pub struct Client { /* private fields */ }

Client for AWS End User Messaging

Client for invoking operations on AWS End User Messaging. Each operation on AWS End User Messaging 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_endusermessaging::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_endusermessaging::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 CreateBrandProfile operation has a Client::create_brand_profile, 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.create_brand_profile()
    .brand_profile_name("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.

Waiters

This client provides wait_until methods behind the Waiters trait. To use them, simply import the trait, and then call one of the wait_until methods. This will return a waiter fluent builder that takes various parameters, which are documented on the builder type. Once parameters have been provided, the wait method can be called to initiate waiting.

For example, if there was a wait_until_thing method, it could look like:

let result = client.wait_until_thing()
    .thing_id("someId")
    .wait(Duration::from_secs(120))
    .await;

Implementations

impl Client

pub fn create_brand_profile(&self) -> CreateBrandProfileFluentBuilder

Constructs a fluent builder for the CreateBrandProfile operation.

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

    The name of the brand profile. The name can contain alphanumeric characters, underscores, hyphens, and spaces.

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

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you do not specify a client token, the AWS SDK automatically generates one.

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

    Specifies whether deletion protection is enabled. When enabled, the resource cannot be deleted until deletion protection is turned off.

    
    
  • 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 CreateBrandProfileOutput with field(s):
  • brand_profile_id(String):

    The unique identifier of the brand profile.

  • brand_profile_arn(String):

    The Amazon Resource Name (ARN) of the brand profile.

  • brand_profile_name(String):

    The name of the brand profile. The name can contain alphanumeric characters, underscores, hyphens, and spaces.

  • status(Status):

    The current lifecycle status of the brand profile.

  • deletion_protection_enabled(bool):

    Specifies whether deletion protection is enabled. When enabled, the resource cannot be deleted until deletion protection is turned off.

  • created_at(DateTime):

    The time when the resource was created, in Unix epoch time.

  • updated_at(DateTime):

    The time when the resource was last updated, in Unix epoch time.

  • attributes_created(i32):

    The number of default attributes that were created for the brand profile.

• On failure, responds with SdkError<CreateBrandProfileError>

impl Client

pub fn create_brand_profile_attributes( &self, ) -> CreateBrandProfileAttributesFluentBuilder

Constructs a fluent builder for the CreateBrandProfileAttributes operation.

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

    The unique identifier of the brand profile. You can specify either the bare ID or the full Amazon Resource Name (ARN).

    
    
  • attributes(BrandProfileAttributeInput) / set_attributes(Option<Vec::<BrandProfileAttributeInput>>):
    required: true
    

    The brand profile attributes.

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

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you do not specify a client token, the AWS SDK automatically generates one.

    
    
• On success, responds with CreateBrandProfileAttributesOutput with field(s):
  • attributes(Vec::<BrandProfileAttributeOutput>):

    The brand profile attributes.

• On failure, responds with SdkError<CreateBrandProfileAttributesError>

impl Client

pub fn create_brand_profile_from_registration( &self, ) -> CreateBrandProfileFromRegistrationFluentBuilder

Constructs a fluent builder for the CreateBrandProfileFromRegistration operation.

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

    The identifier or Amazon Resource Name (ARN) of the registration to populate the brand profile from.

    
    
  • brand_profile_name(impl Into<String>) / set_brand_profile_name(Option<String>):
    required: true
    

    The name of the brand profile. The name can contain alphanumeric characters, underscores, hyphens, and spaces.

    
    
  • smart_match(bool) / set_smart_match(Option<bool>):
    required: false
    

    Specifies whether to use semantic field mapping between brand profile attributes and registration fields. The default is true. When false, the service maps fields using a fixed set of standard field types.

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

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

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

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you do not specify a client token, the AWS SDK automatically generates one.

    
    
• On success, responds with CreateBrandProfileFromRegistrationOutput with field(s):
  • results(Vec::<JobResult>):

    The results of the operation. Each result pairs a requested item with the asynchronous job that processes it.

• On failure, responds with SdkError<CreateBrandProfileFromRegistrationError>

impl Client

pub fn create_notify_code_configuration( &self, ) -> CreateNotifyCodeConfigurationFluentBuilder

Constructs a fluent builder for the CreateNotifyCodeConfiguration operation.

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

    The name of the notify code configuration.

    
    
  • code_configuration_parameters(CodeConfigurationParameters) / set_code_configuration_parameters(Option<CodeConfigurationParameters>):
    required: false
    

    The passcode policy parameters, including the code type, length, validity period, and maximum number of attempts. Each member is optional. When you omit a member, no value is applied at create time and the default is applied when a passcode is sent.

    
    
  • channel_parameters(ChannelParameters) / set_channel_parameters(Option<ChannelParameters>):
    required: false
    

    The channel-specific parameters used to render and deliver the one-time passcode. Provide parameters for any subset of channels. Each member configures one delivery route, and the route that is selected at send time uses the matching channel.

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

    Specifies whether deletion protection is enabled. When enabled, the resource cannot be deleted until deletion protection is turned off.

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

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you do not specify a client token, the AWS SDK automatically generates one.

    
    
  • 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 CreateNotifyCodeConfigurationOutput with field(s):
  • notify_code_configuration(Option<NotifyCodeConfiguration>):

    The notify code configuration resource.

• On failure, responds with SdkError<CreateNotifyCodeConfigurationError>

impl Client

pub fn create_registrations_from_brand_profile( &self, ) -> CreateRegistrationsFromBrandProfileFluentBuilder

Constructs a fluent builder for the CreateRegistrationsFromBrandProfile operation.

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

    The unique identifier of the brand profile. You can specify either the bare ID or the full Amazon Resource Name (ARN).

    
    
  • registration_types(impl Into<String>) / set_registration_types(Option<Vec::<String>>):
    required: true
    

    The registration types to create, for example US_TOLL_FREE_REGISTRATION or SENDER_ID.

    
    
  • smart_match(bool) / set_smart_match(Option<bool>):
    required: false
    

    Specifies whether to use semantic field mapping between brand profile attributes and registration fields. The default is true. When false, the service maps fields using a fixed set of standard field types.

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

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you do not specify a client token, the AWS SDK automatically generates one.

    
    
• On success, responds with CreateRegistrationsFromBrandProfileOutput with field(s):
  • results(Vec::<JobResult>):

    The results of the operation. Each result pairs a requested item with the asynchronous job that processes it.

• On failure, responds with SdkError<CreateRegistrationsFromBrandProfileError>

impl Client

pub fn delete_brand_profile(&self) -> DeleteBrandProfileFluentBuilder

Constructs a fluent builder for the DeleteBrandProfile operation.

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

    The unique identifier of the brand profile. You can specify either the bare ID or the full Amazon Resource Name (ARN).

    
    
• On success, responds with DeleteBrandProfileOutput with field(s):
  • brand_profile_id(String):

    The unique identifier of the brand profile.

  • brand_profile_arn(String):

    The Amazon Resource Name (ARN) of the brand profile.

• On failure, responds with SdkError<DeleteBrandProfileError>

impl Client

pub fn delete_brand_profile_attribute( &self, ) -> DeleteBrandProfileAttributeFluentBuilder

Constructs a fluent builder for the DeleteBrandProfileAttribute operation.

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

    The unique identifier of the brand profile. You can specify either the bare ID or the full Amazon Resource Name (ARN).

    
    
  • attribute_name(impl Into<String>) / set_attribute_name(Option<String>):
    required: true
    

    The name of the brand profile attribute. The name is unique within a brand profile.

    
    
• On success, responds with DeleteBrandProfileAttributeOutput with field(s):
  • brand_profile_id(String):

    The unique identifier of the brand profile.

  • attribute_name(String):

    The name of the brand profile attribute. The name is unique within a brand profile.

• On failure, responds with SdkError<DeleteBrandProfileAttributeError>

impl Client

pub fn delete_notify_code_configuration( &self, ) -> DeleteNotifyCodeConfigurationFluentBuilder

Constructs a fluent builder for the DeleteNotifyCodeConfiguration operation.

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

    The unique identifier of the notify code configuration. You can specify either the bare ID or the full Amazon Resource Name (ARN).

    
    
• On success, responds with DeleteNotifyCodeConfigurationOutput
• On failure, responds with SdkError<DeleteNotifyCodeConfigurationError>

impl Client

pub fn get_brand_profile(&self) -> GetBrandProfileFluentBuilder

Constructs a fluent builder for the GetBrandProfile operation.

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

    The unique identifier of the brand profile. You can specify either the bare ID or the full Amazon Resource Name (ARN).

    
    
• On success, responds with GetBrandProfileOutput with field(s):
  • brand_profile_id(String):

    The unique identifier of the brand profile.

  • brand_profile_arn(String):

    The Amazon Resource Name (ARN) of the brand profile.

  • brand_profile_name(String):

    The name of the brand profile. The name can contain alphanumeric characters, underscores, hyphens, and spaces.

  • status(Status):

    The current lifecycle status of the brand profile.

  • deletion_protection_enabled(bool):

    Specifies whether deletion protection is enabled. When enabled, the resource cannot be deleted until deletion protection is turned off.

  • created_at(DateTime):

    The time when the resource was created, in Unix epoch time.

  • updated_at(DateTime):

    The time when the resource was last updated, in Unix epoch time.

• On failure, responds with SdkError<GetBrandProfileError>

impl Client

pub fn get_brand_profile_attribute( &self, ) -> GetBrandProfileAttributeFluentBuilder

Constructs a fluent builder for the GetBrandProfileAttribute operation.

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

    The unique identifier of the brand profile. You can specify either the bare ID or the full Amazon Resource Name (ARN).

    
    
  • attribute_name(impl Into<String>) / set_attribute_name(Option<String>):
    required: true
    

    The name of the brand profile attribute. The name is unique within a brand profile.

    
    
• On success, responds with GetBrandProfileAttributeOutput with field(s):
  • attribute_name(String):

    The name of the brand profile attribute. The name is unique within a brand profile.

  • attribute_type(BrandProfileAttributeType):

    The type of the attribute. TEXT stores an inline value. IMAGE and DOCUMENT store binary media that you upload.

  • attribute_value(Option<String>):

    The text value of the attribute. This value applies to attributes of type TEXT.

  • description(Option<String>):

    A description of the attribute.

  • category(Option<String>):

    The category of the attribute.

  • media_content_type(Option<String>):

    The MIME content type of the attribute media.

  • media_size_bytes(Option<i64>):

    The size of the attribute media, in bytes.

  • media_download_url(Option<String>):

    A presigned Amazon S3 URL that you can use to download the attribute media. The URL is valid for one hour and is present only for attributes of type IMAGE or DOCUMENT.

  • created_at(DateTime):

    The time when the resource was created, in Unix epoch time.

  • updated_at(DateTime):

    The time when the resource was last updated, in Unix epoch time.

• On failure, responds with SdkError<GetBrandProfileAttributeError>

impl Client

pub fn get_job(&self) -> GetJobFluentBuilder

Constructs a fluent builder for the GetJob operation.

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

    The unique identifier of the asynchronous job. Use the GetJob operation to check the status of the job and to retrieve its results.

    
    
• On success, responds with GetJobOutput with field(s):
  • job_id(String):

    The unique identifier of the asynchronous job. Use the GetJob operation to check the status of the job and to retrieve its results.

  • status(JobStatus):

    The current lifecycle status of the job.

  • operation_type(String):

    The type of mutating operation that created the job.

  • created_at(DateTime):

    The time when the resource was created, in Unix epoch time.

  • updated_at(DateTime):

    The time when the resource was last updated, in Unix epoch time.

  • brand_profile_id(Option<String>):

    The brand profile that the job operates on. This value is absent for operations that create a brand profile.

  • error_code(Option<String>):

    A machine-readable code that identifies why the job failed. This value is present only when the job status is FAILED.

  • error_message(Option<String>):

    A human-readable description of why the job failed. This value is present only when the job status is FAILED.

  • resources(Option<Vec::<JobResource>>):

    The resources that were created or updated by the job.

• On failure, responds with SdkError<GetJobError>

impl Client

pub fn get_notify_code_configuration( &self, ) -> GetNotifyCodeConfigurationFluentBuilder

Constructs a fluent builder for the GetNotifyCodeConfiguration operation.

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

    The unique identifier of the notify code configuration. You can specify either the bare ID or the full Amazon Resource Name (ARN).

    
    
• On success, responds with GetNotifyCodeConfigurationOutput with field(s):
  • notify_code_configuration(Option<NotifyCodeConfiguration>):

    The notify code configuration resource.

• On failure, responds with SdkError<GetNotifyCodeConfigurationError>

impl Client

pub fn list_brand_profile_attributes( &self, ) -> ListBrandProfileAttributesFluentBuilder

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

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

    The unique identifier of the brand profile. You can specify either the bare ID or the full Amazon Resource Name (ARN).

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

    The token to retrieve the next page of results. This value is returned when more results are available, and is null when there are no more results to return.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return per page.

    
    
• On success, responds with ListBrandProfileAttributesOutput with field(s):
  • brand_profile_attributes(Vec::<BrandProfileAttributeSummary>):

    The list of brand profile attributes.

  • next_token(Option<String>):

    The token to retrieve the next page of results. This value is returned when more results are available, and is null when there are no more results to return.

• On failure, responds with SdkError<ListBrandProfileAttributesError>

impl Client

pub fn list_brand_profiles(&self) -> ListBrandProfilesFluentBuilder

Constructs a fluent builder for the ListBrandProfiles 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 retrieve the next page of results. This value is returned when more results are available, and is null when there are no more results to return.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return per page.

    
    
• On success, responds with ListBrandProfilesOutput with field(s):
  • brand_profiles(Vec::<BrandProfileInfo>):

    The list of brand profiles.

  • next_token(Option<String>):

    The token to retrieve the next page of results. This value is returned when more results are available, and is null when there are no more results to return.

• On failure, responds with SdkError<ListBrandProfilesError>

impl Client

pub fn list_jobs(&self) -> ListJobsFluentBuilder

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

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return per page.

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

    The token to retrieve the next page of results. This value is returned when more results are available, and is null when there are no more results to return.

    
    
  • status(JobStatus) / set_status(Option<JobStatus>):
    required: false
    

    Filters the results to jobs that have the specified status.

    
    
  • brand_profile_id(impl Into<String>) / set_brand_profile_id(Option<String>):
    required: false
    

    Filters the results to jobs for the specified brand profile.

    
    
  • operation_type(impl Into<String>) / set_operation_type(Option<String>):
    required: false
    

    Filters the results to jobs of the specified operation type.

    
    
• On success, responds with ListJobsOutput with field(s):
  • jobs(Vec::<JobSummary>):

    The list of asynchronous jobs.

  • next_token(Option<String>):

    The token to retrieve the next page of results. This value is returned when more results are available, and is null when there are no more results to return.

• On failure, responds with SdkError<ListJobsError>

impl Client

pub fn list_notify_code_configurations( &self, ) -> ListNotifyCodeConfigurationsFluentBuilder

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

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return per page.

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

    The token to retrieve the next page of results. This value is returned when more results are available, and is null when there are no more results to return.

    
    
• On success, responds with ListNotifyCodeConfigurationsOutput with field(s):
  • notify_code_configurations(Vec::<NotifyCodeConfiguration>):

    The list of notify code configurations.

  • next_token(Option<String>):

    The token to retrieve the next page of results. This value is returned when more results are available, and is null when there are no more results to return.

• On failure, responds with SdkError<ListNotifyCodeConfigurationsError>

impl Client

pub fn list_registrations_from_brand_profile( &self, ) -> ListRegistrationsFromBrandProfileFluentBuilder

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

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

    The unique identifier of the brand profile. You can specify either the bare ID or the full Amazon Resource Name (ARN).

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return per page.

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

    The token to retrieve the next page of results. This value is returned when more results are available, and is null when there are no more results to return.

    
    
• On success, responds with ListRegistrationsFromBrandProfileOutput with field(s):
  • registration_associations(Vec::<RegistrationAssociationSummary>):

    The list of registrations that are associated with the brand profile.

  • next_token(Option<String>):

    The token to retrieve the next page of results. This value is returned when more results are available, and is null when there are no more results to return.

• On failure, responds with SdkError<ListRegistrationsFromBrandProfileError>

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.

    
    
• On success, responds with ListTagsForResourceOutput with field(s):
  • 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 send_notify_code_verification( &self, ) -> SendNotifyCodeVerificationFluentBuilder

Constructs a fluent builder for the SendNotifyCodeVerification operation.

• The fluent builder is configurable:
  • channel(NotifyChannel) / set_channel(Option<NotifyChannel>):
    required: true
    

    The channel used to deliver the one-time passcode to the recipient.

    
    
  • destination_identity(impl Into<String>) / set_destination_identity(Option<String>):
    required: true
    

    The recipient identifier. For the TEXT and VOICE channels, specify an E.164 phone number. For the WhatsApp channel, specify a WhatsApp address.

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

    The identity used to send the message, such as a phone number, sender ID, or pool that is owned by your account.

    
    
  • notify_code_configuration(impl Into<String>) / set_notify_code_configuration(Option<String>):
    required: false
    

    The identifier or Amazon Resource Name (ARN) of the notify code configuration that supplies the passcode policy and template defaults. When you do not specify a configuration, you must supply the template in the request.

    
    
  • override_channel_parameters(ChannelParameters) / set_override_channel_parameters(Option<ChannelParameters>):
    required: false
    

    The channel-specific parameters used to render and deliver the one-time passcode for this request. The route that is derived from the channel and the origination identity selects the matching channel. When you do not specify channel parameters, the service uses the parameters from the referenced notify code configuration.

    
    
  • override_code_configuration_parameters(CodeConfigurationParameters) / set_override_code_configuration_parameters(Option<CodeConfigurationParameters>):
    required: false
    

    The per-send overrides for the passcode policy parameters, including the code type, length, validity period, and maximum number of attempts. These values override the values from the referenced notify code configuration. When you do not specify a value, the value from the configuration is used, and if neither is set, the service default applies.

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

    The name of the configuration set used to control how delivery events for the message are handled.

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

    A map of custom key and value pairs that are propagated to the delivery events for this verification.

    
    
  • reference_id(impl Into<String>) / set_reference_id(Option<String>):
    required: false
    

    A caller-supplied reference identifier that binds a send request to a later validate request. Specify the same value in both requests.

    
    
• On success, responds with SendNotifyCodeVerificationOutput with field(s):
  • verification_id(String):

    The service-generated identifier for the verification.

  • message_id(String):

    The service-generated identifier for the message that delivers the one-time passcode.

• On failure, responds with SdkError<SendNotifyCodeVerificationError>

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
    

    The list of tag keys to remove from the resource.

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

impl Client

pub fn update_brand_profile(&self) -> UpdateBrandProfileFluentBuilder

Constructs a fluent builder for the UpdateBrandProfile operation.

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

    The unique identifier of the brand profile. You can specify either the bare ID or the full Amazon Resource Name (ARN).

    
    
  • brand_profile_name(impl Into<String>) / set_brand_profile_name(Option<String>):
    required: false
    

    The name of the brand profile. The name can contain alphanumeric characters, underscores, hyphens, and spaces.

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

    Specifies whether deletion protection is enabled. When enabled, the resource cannot be deleted until deletion protection is turned off.

    
    
• On success, responds with UpdateBrandProfileOutput with field(s):
  • brand_profile_id(String):

    The unique identifier of the brand profile.

  • brand_profile_arn(String):

    The Amazon Resource Name (ARN) of the brand profile.

  • brand_profile_name(String):

    The name of the brand profile. The name can contain alphanumeric characters, underscores, hyphens, and spaces.

  • status(Status):

    The current lifecycle status of the brand profile.

  • deletion_protection_enabled(bool):

    Specifies whether deletion protection is enabled. When enabled, the resource cannot be deleted until deletion protection is turned off.

  • created_at(DateTime):

    The time when the resource was created, in Unix epoch time.

  • updated_at(DateTime):

    The time when the resource was last updated, in Unix epoch time.

• On failure, responds with SdkError<UpdateBrandProfileError>

impl Client

pub fn update_brand_profile_attribute( &self, ) -> UpdateBrandProfileAttributeFluentBuilder

Constructs a fluent builder for the UpdateBrandProfileAttribute operation.

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

    The unique identifier of the brand profile. You can specify either the bare ID or the full Amazon Resource Name (ARN).

    
    
  • attribute_name(impl Into<String>) / set_attribute_name(Option<String>):
    required: true
    

    The name of the brand profile attribute. The name is unique within a brand profile.

    
    
  • attribute_value(impl Into<String>) / set_attribute_value(Option<String>):
    required: false
    

    The text value of the attribute. This value applies to attributes of type TEXT.

    
    
  • attachment_body(Blob) / set_attachment_body(Option<Blob>):
    required: false
    

    The binary content for an attribute of type IMAGE or DOCUMENT. The content is base64-encoded when it is sent over the wire.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A description of the attribute.

    
    
  • category(impl Into<String>) / set_category(Option<String>):
    required: false
    

    The category of the attribute.

    
    
• On success, responds with UpdateBrandProfileAttributeOutput with field(s):
  • attribute_name(String):

    The name of the brand profile attribute. The name is unique within a brand profile.

  • attribute_type(BrandProfileAttributeType):

    The type of the attribute. TEXT stores an inline value. IMAGE and DOCUMENT store binary media that you upload.

  • attribute_value(Option<String>):

    The text value of the attribute. This value applies to attributes of type TEXT.

  • description(Option<String>):

    A description of the attribute.

  • category(Option<String>):

    The category of the attribute.

  • media_content_type(Option<String>):

    The MIME content type of the attribute media.

  • media_size_bytes(Option<i64>):

    The size of the attribute media, in bytes.

  • created_at(DateTime):

    The time when the resource was created, in Unix epoch time.

  • updated_at(DateTime):

    The time when the resource was last updated, in Unix epoch time.

• On failure, responds with SdkError<UpdateBrandProfileAttributeError>

impl Client

pub fn update_brand_profile_from_registration( &self, ) -> UpdateBrandProfileFromRegistrationFluentBuilder

Constructs a fluent builder for the UpdateBrandProfileFromRegistration operation.

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

    The unique identifier of the brand profile. You can specify either the bare ID or the full Amazon Resource Name (ARN).

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

    The identifier or Amazon Resource Name (ARN) of the registration to import attributes from.

    
    
  • smart_match(bool) / set_smart_match(Option<bool>):
    required: false
    

    Specifies whether to use semantic field mapping between brand profile attributes and registration fields. The default is true. When false, the service maps fields using a fixed set of standard field types.

    
    
  • on_attribute_conflict(OnAttributeConflict) / set_on_attribute_conflict(Option<OnAttributeConflict>):
    required: false
    

    Specifies how the service resolves an attribute that already exists. REPLACE overwrites the existing value with the incoming value. PRESERVE keeps the existing value.

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

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you do not specify a client token, the AWS SDK automatically generates one.

    
    
• On success, responds with UpdateBrandProfileFromRegistrationOutput with field(s):
  • results(Vec::<JobResult>):

    The results of the operation. Each result pairs a requested item with the asynchronous job that processes it.

• On failure, responds with SdkError<UpdateBrandProfileFromRegistrationError>

impl Client

pub fn update_notify_code_configuration( &self, ) -> UpdateNotifyCodeConfigurationFluentBuilder

Constructs a fluent builder for the UpdateNotifyCodeConfiguration operation.

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

    The unique identifier of the notify code configuration. You can specify either the bare ID or the full Amazon Resource Name (ARN).

    
    
  • notify_code_configuration_name(impl Into<String>) / set_notify_code_configuration_name(Option<String>):
    required: false
    

    The name of the notify code configuration.

    
    
  • code_configuration_parameters(UpdateCodeConfigurationParameters) / set_code_configuration_parameters(Option<UpdateCodeConfigurationParameters>):
    required: false
    

    The updated passcode policy parameters, including the code type, length, validity period, and maximum number of attempts. When you omit a member, its current value is preserved.

    
    
  • channel_parameters(UpdateChannelParameters) / set_channel_parameters(Option<UpdateChannelParameters>):
    required: false
    

    The updated channel-specific parameters used to render and deliver the one-time passcode. This is a loose, nested update: when you omit a channel, that channel’s parameters remain unchanged. Within a supplied channel, an empty string on a string member, or an empty map on the destination-country parameters, clears the currently stored value, and absent members preserve the current value.

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

    Specifies whether deletion protection is enabled. When enabled, the resource cannot be deleted until deletion protection is turned off.

    
    
• On success, responds with UpdateNotifyCodeConfigurationOutput with field(s):
  • notify_code_configuration(Option<NotifyCodeConfiguration>):

    The notify code configuration resource.

• On failure, responds with SdkError<UpdateNotifyCodeConfigurationError>

impl Client

pub fn update_registrations_from_brand_profile( &self, ) -> UpdateRegistrationsFromBrandProfileFluentBuilder

Constructs a fluent builder for the UpdateRegistrationsFromBrandProfile operation.

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

    The unique identifier of the brand profile. You can specify either the bare ID or the full Amazon Resource Name (ARN).

    
    
  • registration_ids(impl Into<String>) / set_registration_ids(Option<Vec::<String>>):
    required: true
    

    The identifiers of the registrations.

    
    
  • smart_match(bool) / set_smart_match(Option<bool>):
    required: false
    

    Specifies whether to use semantic field mapping between brand profile attributes and registration fields. The default is true. When false, the service maps fields using a fixed set of standard field types.

    
    
  • on_attribute_conflict(OnAttributeConflict) / set_on_attribute_conflict(Option<OnAttributeConflict>):
    required: false
    

    Specifies how the service resolves an attribute that already exists. REPLACE overwrites the existing value with the incoming value. PRESERVE keeps the existing value.

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

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you do not specify a client token, the AWS SDK automatically generates one.

    
    
• On success, responds with UpdateRegistrationsFromBrandProfileOutput with field(s):
  • results(Vec::<JobResult>):

    The results of the operation. Each result pairs a requested item with the asynchronous job that processes it.

• On failure, responds with SdkError<UpdateRegistrationsFromBrandProfileError>

impl Client

pub fn validate_notify_code_verification( &self, ) -> ValidateNotifyCodeVerificationFluentBuilder

Constructs a fluent builder for the ValidateNotifyCodeVerification operation.

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

    The recipient identifier. For the TEXT and VOICE channels, specify an E.164 phone number. For the WhatsApp channel, specify a WhatsApp address.

    
    
  • reference_id(impl Into<String>) / set_reference_id(Option<String>):
    required: false
    

    The caller-supplied reference identifier used to locate the verification. This value must match the value that you supplied to the SendNotifyCodeVerification operation.

    
    
  • code(impl Into<String>) / set_code(Option<String>):
    required: true
    

    The one-time passcode that the recipient submitted for validation.

    
    
• On success, responds with ValidateNotifyCodeVerificationOutput with field(s):
  • status(VerificationStatus):

    The outcome of the validation attempt. VALID indicates that the submitted passcode matched an active verification. INVALID indicates that the passcode did not match, expired, or exceeded its attempt limit.

• On failure, responds with SdkError<ValidateNotifyCodeVerificationError>

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) -> Self

Returns a duplicate of the value.

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.

impl Waiters for Client

fn wait_until_brand_profile_active(&self) -> BrandProfileActiveFluentBuilder

Wait until a brand profile reaches the ACTIVE state.

fn wait_until_job_success(&self) -> JobSuccessFluentBuilder

Wait until an async job reaches the SUCCESS terminal state.