Struct aws_sdk_chimesdkvoice::client::Client

pub struct Client { /* private fields */ }

Client for Amazon Chime SDK Voice

Client for invoking operations on Amazon Chime SDK Voice. Each operation on Amazon Chime SDK Voice 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_chimesdkvoice::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 Config 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_chimesdkvoice::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 AssociatePhoneNumbersWithVoiceConnector operation has a Client::associate_phone_numbers_with_voice_connector, 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_phone_numbers_with_voice_connector()
    .voice_connector_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_phone_numbers_with_voice_connector( &self ) -> AssociatePhoneNumbersWithVoiceConnectorFluentBuilder

Constructs a fluent builder for the AssociatePhoneNumbersWithVoiceConnector operation.

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

    The Voice Connector ID.

    
    
  • e164_phone_numbers(impl Into<String>) / set_e164_phone_numbers(Option<Vec::<String>>):
    required: true
    

    List of phone numbers, in E.164 format.

    
    
  • force_associate(bool) / set_force_associate(Option<bool>):
    required: false
    

    If true, associates the provided phone numbers with the provided Amazon Chime SDK Voice Connector and removes any previously existing associations. If false, does not associate any phone numbers that have previously existing associations.

    
    
• On success, responds with AssociatePhoneNumbersWithVoiceConnectorOutput with field(s):
  • phone_number_errors(Option<Vec::<PhoneNumberError>>):

    If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.

• On failure, responds with SdkError<AssociatePhoneNumbersWithVoiceConnectorError>

impl Client

pub fn associate_phone_numbers_with_voice_connector_group( &self ) -> AssociatePhoneNumbersWithVoiceConnectorGroupFluentBuilder

Constructs a fluent builder for the AssociatePhoneNumbersWithVoiceConnectorGroup operation.

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

    The Amazon Chime SDK Voice Connector group ID.

    
    
  • e164_phone_numbers(impl Into<String>) / set_e164_phone_numbers(Option<Vec::<String>>):
    required: true
    

    List of phone numbers, in E.164 format.

    
    
  • force_associate(bool) / set_force_associate(Option<bool>):
    required: false
    

    If true, associates the provided phone numbers with the provided Amazon Chime SDK Voice Connector Group and removes any previously existing associations. If false, does not associate any phone numbers that have previously existing associations.

    
    
• On success, responds with AssociatePhoneNumbersWithVoiceConnectorGroupOutput with field(s):
  • phone_number_errors(Option<Vec::<PhoneNumberError>>):

    If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.

• On failure, responds with SdkError<AssociatePhoneNumbersWithVoiceConnectorGroupError>

impl Client

pub fn batch_delete_phone_number(&self) -> BatchDeletePhoneNumberFluentBuilder

Constructs a fluent builder for the BatchDeletePhoneNumber operation.

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

    List of phone number IDs.

    
    
• On success, responds with BatchDeletePhoneNumberOutput with field(s):
  • phone_number_errors(Option<Vec::<PhoneNumberError>>):

    If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.

• On failure, responds with SdkError<BatchDeletePhoneNumberError>

impl Client

pub fn batch_update_phone_number(&self) -> BatchUpdatePhoneNumberFluentBuilder

Constructs a fluent builder for the BatchUpdatePhoneNumber operation.

• The fluent builder is configurable:
  • update_phone_number_request_items(UpdatePhoneNumberRequestItem) / set_update_phone_number_request_items(Option<Vec::<UpdatePhoneNumberRequestItem>>):
    required: true
    

    Lists the phone numbers in the update request.

    
    
• On success, responds with BatchUpdatePhoneNumberOutput with field(s):
  • phone_number_errors(Option<Vec::<PhoneNumberError>>):

    A list of failed phone numbers and their error messages.

• On failure, responds with SdkError<BatchUpdatePhoneNumberError>

impl Client

pub fn create_phone_number_order(&self) -> CreatePhoneNumberOrderFluentBuilder

Constructs a fluent builder for the CreatePhoneNumberOrder operation.

• The fluent builder is configurable:
  • product_type(PhoneNumberProductType) / set_product_type(Option<PhoneNumberProductType>):
    required: true
    

    The phone number product type.

    
    
  • e164_phone_numbers(impl Into<String>) / set_e164_phone_numbers(Option<Vec::<String>>):
    required: true
    

    List of phone numbers, in E.164 format.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    Specifies the name assigned to one or more phone numbers.

    
    
• On success, responds with CreatePhoneNumberOrderOutput with field(s):
  • phone_number_order(Option<PhoneNumberOrder>):

    The phone number order details.

• On failure, responds with SdkError<CreatePhoneNumberOrderError>

impl Client

pub fn create_proxy_session(&self) -> CreateProxySessionFluentBuilder

Constructs a fluent builder for the CreateProxySession operation.

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

    The Voice Connector ID.

    
    
  • participant_phone_numbers(impl Into<String>) / set_participant_phone_numbers(Option<Vec::<String>>):
    required: true
    

    The participant phone numbers.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    The name of the proxy session.

    
    
  • expiry_minutes(i32) / set_expiry_minutes(Option<i32>):
    required: false
    

    The number of minutes allowed for the proxy session.

    
    
  • capabilities(Capability) / set_capabilities(Option<Vec::<Capability>>):
    required: true
    

    The proxy session’s capabilities.

    
    
  • number_selection_behavior(NumberSelectionBehavior) / set_number_selection_behavior(Option<NumberSelectionBehavior>):
    required: false
    

    The preference for proxy phone number reuse, or stickiness, between the same participants across sessions.

    
    
  • geo_match_level(GeoMatchLevel) / set_geo_match_level(Option<GeoMatchLevel>):
    required: false
    

    The preference for matching the country or area code of the proxy phone number with that of the first participant.

    
    
  • geo_match_params(GeoMatchParams) / set_geo_match_params(Option<GeoMatchParams>):
    required: false
    

    The country and area code for the proxy phone number.

    
    
• On success, responds with CreateProxySessionOutput with field(s):
  • proxy_session(Option<ProxySession>):

    The proxy session details.

• On failure, responds with SdkError<CreateProxySessionError>

impl Client

pub fn create_sip_media_application( &self ) -> CreateSipMediaApplicationFluentBuilder

Constructs a fluent builder for the CreateSipMediaApplication operation.

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

    The AWS Region assigned to the SIP media application.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The SIP media application’s name.

    
    
  • endpoints(SipMediaApplicationEndpoint) / set_endpoints(Option<Vec::<SipMediaApplicationEndpoint>>):
    required: true
    

    List of endpoints (Lambda ARNs) specified for the SIP media application.

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

    The tags assigned to the SIP media application.

    
    
• On success, responds with CreateSipMediaApplicationOutput with field(s):
  • sip_media_application(Option<SipMediaApplication>):

    The SIP media application details.

• On failure, responds with SdkError<CreateSipMediaApplicationError>

impl Client

pub fn create_sip_media_application_call( &self ) -> CreateSipMediaApplicationCallFluentBuilder

Constructs a fluent builder for the CreateSipMediaApplicationCall operation.

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

    The phone number that a user calls from. This is a phone number in your Amazon Chime SDK phone number inventory.

    
    
  • to_phone_number(impl Into<String>) / set_to_phone_number(Option<String>):
    required: true
    

    The phone number that the service should call.

    
    
  • sip_media_application_id(impl Into<String>) / set_sip_media_application_id(Option<String>):
    required: true
    

    The ID of the SIP media application.

    
    
  • sip_headers(impl Into<String>, impl Into<String>) / set_sip_headers(Option<HashMap::<String, String>>):
    required: false
    

    The SIP headers added to an outbound call leg.

    
    
  • arguments_map(impl Into<String>, impl Into<String>) / set_arguments_map(Option<HashMap::<String, String>>):
    required: false
    

    Context passed to a CreateSipMediaApplication API call. For example, you could pass key-value pairs such as: “FirstName”: “John”, “LastName”: “Doe”

    
    
• On success, responds with CreateSipMediaApplicationCallOutput with field(s):
  • sip_media_application_call(Option<SipMediaApplicationCall>):

    The actual call.

• On failure, responds with SdkError<CreateSipMediaApplicationCallError>

impl Client

pub fn create_sip_rule(&self) -> CreateSipRuleFluentBuilder

Constructs a fluent builder for the CreateSipRule operation.

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

    The name of the SIP rule.

    
    
  • trigger_type(SipRuleTriggerType) / set_trigger_type(Option<SipRuleTriggerType>):
    required: true
    

    The type of trigger assigned to the SIP rule in TriggerValue, currently RequestUriHostname or ToPhoneNumber.

    
    
  • trigger_value(impl Into<String>) / set_trigger_value(Option<String>):
    required: true
    

    If TriggerType is RequestUriHostname, the value can be the outbound host name of a Voice Connector. If TriggerType is ToPhoneNumber, the value can be a customer-owned phone number in the E164 format. The SipMediaApplication specified in the SipRule is triggered if the request URI in an incoming SIP request matches the RequestUriHostname, or if the To header in the incoming SIP request matches the ToPhoneNumber value.

    
    
  • disabled(bool) / set_disabled(Option<bool>):
    required: false
    

    Disables or enables a SIP rule. You must disable SIP rules before you can delete them.

    
    
  • target_applications(SipRuleTargetApplication) / set_target_applications(Option<Vec::<SipRuleTargetApplication>>):
    required: false
    

    List of SIP media applications, with priority and AWS Region. Only one SIP application per AWS Region can be used.

    
    
• On success, responds with CreateSipRuleOutput with field(s):
  • sip_rule(Option<SipRule>):

    The SIP rule information, including the rule ID, triggers, and target applications.

• On failure, responds with SdkError<CreateSipRuleError>

impl Client

pub fn create_voice_connector(&self) -> CreateVoiceConnectorFluentBuilder

Constructs a fluent builder for the CreateVoiceConnector operation.

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

    The name of the Voice Connector.

    
    
  • aws_region(VoiceConnectorAwsRegion) / set_aws_region(Option<VoiceConnectorAwsRegion>):
    required: false
    

    The AWS Region in which the Amazon Chime SDK Voice Connector is created. Default value: us-east-1 .

    
    
  • require_encryption(bool) / set_require_encryption(Option<bool>):
    required: true
    

    Enables or disables encryption for the Voice Connector.

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

    The tags assigned to the Voice Connector.

    
    
• On success, responds with CreateVoiceConnectorOutput with field(s):
  • voice_connector(Option<VoiceConnector>):

    The details of the Voice Connector.

• On failure, responds with SdkError<CreateVoiceConnectorError>

impl Client

pub fn create_voice_connector_group( &self ) -> CreateVoiceConnectorGroupFluentBuilder

Constructs a fluent builder for the CreateVoiceConnectorGroup operation.

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

    The name of the Voice Connector group.

    
    
  • voice_connector_items(VoiceConnectorItem) / set_voice_connector_items(Option<Vec::<VoiceConnectorItem>>):
    required: false
    

    Lists the Voice Connectors that inbound calls are routed to.

    
    
• On success, responds with CreateVoiceConnectorGroupOutput with field(s):
  • voice_connector_group(Option<VoiceConnectorGroup>):

    The details of the Voice Connector group.

• On failure, responds with SdkError<CreateVoiceConnectorGroupError>

impl Client

pub fn create_voice_profile(&self) -> CreateVoiceProfileFluentBuilder

Constructs a fluent builder for the CreateVoiceProfile operation.

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

    The ID of the speaker search task.

    
    
• On success, responds with CreateVoiceProfileOutput with field(s):
  • voice_profile(Option<VoiceProfile>):

    The requested voice profile.

• On failure, responds with SdkError<CreateVoiceProfileError>

impl Client

pub fn create_voice_profile_domain( &self ) -> CreateVoiceProfileDomainFluentBuilder

Constructs a fluent builder for the CreateVoiceProfileDomain operation.

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

    The name of the voice profile domain.

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

    A description of the voice profile domain.

    
    
  • server_side_encryption_configuration(ServerSideEncryptionConfiguration) / set_server_side_encryption_configuration(Option<ServerSideEncryptionConfiguration>):
    required: true
    

    The server-side encryption configuration for the request.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: false
    

    The unique identifier for the client request. Use a different token for different domain creation requests.

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

    The tags assigned to the domain.

    
    
• On success, responds with CreateVoiceProfileDomainOutput with field(s):
  • voice_profile_domain(Option<VoiceProfileDomain>):

    The requested voice profile domain.

• On failure, responds with SdkError<CreateVoiceProfileDomainError>

impl Client

pub fn delete_phone_number(&self) -> DeletePhoneNumberFluentBuilder

Constructs a fluent builder for the DeletePhoneNumber operation.

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

    The phone number ID.

    
    
• On success, responds with DeletePhoneNumberOutput
• On failure, responds with SdkError<DeletePhoneNumberError>

impl Client

pub fn delete_proxy_session(&self) -> DeleteProxySessionFluentBuilder

Constructs a fluent builder for the DeleteProxySession operation.

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

    The Voice Connector ID.

    
    
  • proxy_session_id(impl Into<String>) / set_proxy_session_id(Option<String>):
    required: true
    

    The proxy session ID.

    
    
• On success, responds with DeleteProxySessionOutput
• On failure, responds with SdkError<DeleteProxySessionError>

impl Client

pub fn delete_sip_media_application( &self ) -> DeleteSipMediaApplicationFluentBuilder

Constructs a fluent builder for the DeleteSipMediaApplication operation.

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

    The SIP media application ID.

    
    
• On success, responds with DeleteSipMediaApplicationOutput
• On failure, responds with SdkError<DeleteSipMediaApplicationError>

impl Client

pub fn delete_sip_rule(&self) -> DeleteSipRuleFluentBuilder

Constructs a fluent builder for the DeleteSipRule operation.

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

    The SIP rule ID.

    
    
• On success, responds with DeleteSipRuleOutput
• On failure, responds with SdkError<DeleteSipRuleError>

impl Client

pub fn delete_voice_connector(&self) -> DeleteVoiceConnectorFluentBuilder

Constructs a fluent builder for the DeleteVoiceConnector operation.

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

    The Voice Connector ID.

    
    
• On success, responds with DeleteVoiceConnectorOutput
• On failure, responds with SdkError<DeleteVoiceConnectorError>

impl Client

pub fn delete_voice_connector_emergency_calling_configuration( &self ) -> DeleteVoiceConnectorEmergencyCallingConfigurationFluentBuilder

Constructs a fluent builder for the DeleteVoiceConnectorEmergencyCallingConfiguration operation.

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

    The Voice Connector ID.

    
    
• On success, responds with DeleteVoiceConnectorEmergencyCallingConfigurationOutput
• On failure, responds with SdkError<DeleteVoiceConnectorEmergencyCallingConfigurationError>

impl Client

pub fn delete_voice_connector_group( &self ) -> DeleteVoiceConnectorGroupFluentBuilder

Constructs a fluent builder for the DeleteVoiceConnectorGroup operation.

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

    The Voice Connector Group ID.

    
    
• On success, responds with DeleteVoiceConnectorGroupOutput
• On failure, responds with SdkError<DeleteVoiceConnectorGroupError>

impl Client

pub fn delete_voice_connector_origination( &self ) -> DeleteVoiceConnectorOriginationFluentBuilder

Constructs a fluent builder for the DeleteVoiceConnectorOrigination operation.

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

    The Voice Connector ID.

    
    
• On success, responds with DeleteVoiceConnectorOriginationOutput
• On failure, responds with SdkError<DeleteVoiceConnectorOriginationError>

impl Client

pub fn delete_voice_connector_proxy( &self ) -> DeleteVoiceConnectorProxyFluentBuilder

Constructs a fluent builder for the DeleteVoiceConnectorProxy operation.

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

    The Voice Connector ID.

    
    
• On success, responds with DeleteVoiceConnectorProxyOutput
• On failure, responds with SdkError<DeleteVoiceConnectorProxyError>

impl Client

pub fn delete_voice_connector_streaming_configuration( &self ) -> DeleteVoiceConnectorStreamingConfigurationFluentBuilder

Constructs a fluent builder for the DeleteVoiceConnectorStreamingConfiguration operation.

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

    The Voice Connector ID.

    
    
• On success, responds with DeleteVoiceConnectorStreamingConfigurationOutput
• On failure, responds with SdkError<DeleteVoiceConnectorStreamingConfigurationError>

impl Client

pub fn delete_voice_connector_termination( &self ) -> DeleteVoiceConnectorTerminationFluentBuilder

Constructs a fluent builder for the DeleteVoiceConnectorTermination operation.

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

    The Voice Connector ID.

    
    
• On success, responds with DeleteVoiceConnectorTerminationOutput
• On failure, responds with SdkError<DeleteVoiceConnectorTerminationError>

impl Client

pub fn delete_voice_connector_termination_credentials( &self ) -> DeleteVoiceConnectorTerminationCredentialsFluentBuilder

Constructs a fluent builder for the DeleteVoiceConnectorTerminationCredentials operation.

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

    The Voice Connector ID.

    
    
  • usernames(impl Into<String>) / set_usernames(Option<Vec::<String>>):
    required: true
    

    The RFC2617 compliant username associated with the SIP credentials, in US-ASCII format.

    
    
• On success, responds with DeleteVoiceConnectorTerminationCredentialsOutput
• On failure, responds with SdkError<DeleteVoiceConnectorTerminationCredentialsError>

impl Client

pub fn delete_voice_profile(&self) -> DeleteVoiceProfileFluentBuilder

Constructs a fluent builder for the DeleteVoiceProfile operation.

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

    The voice profile ID.

    
    
• On success, responds with DeleteVoiceProfileOutput
• On failure, responds with SdkError<DeleteVoiceProfileError>

impl Client

pub fn delete_voice_profile_domain( &self ) -> DeleteVoiceProfileDomainFluentBuilder

Constructs a fluent builder for the DeleteVoiceProfileDomain operation.

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

    The voice profile domain ID.

    
    
• On success, responds with DeleteVoiceProfileDomainOutput
• On failure, responds with SdkError<DeleteVoiceProfileDomainError>

impl Client

pub fn disassociate_phone_numbers_from_voice_connector( &self ) -> DisassociatePhoneNumbersFromVoiceConnectorFluentBuilder

Constructs a fluent builder for the DisassociatePhoneNumbersFromVoiceConnector operation.

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

    The Voice Connector ID.

    
    
  • e164_phone_numbers(impl Into<String>) / set_e164_phone_numbers(Option<Vec::<String>>):
    required: true
    

    List of phone numbers, in E.164 format.

    
    
• On success, responds with DisassociatePhoneNumbersFromVoiceConnectorOutput with field(s):
  • phone_number_errors(Option<Vec::<PhoneNumberError>>):

    If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.

• On failure, responds with SdkError<DisassociatePhoneNumbersFromVoiceConnectorError>

impl Client

pub fn disassociate_phone_numbers_from_voice_connector_group( &self ) -> DisassociatePhoneNumbersFromVoiceConnectorGroupFluentBuilder

Constructs a fluent builder for the DisassociatePhoneNumbersFromVoiceConnectorGroup operation.

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

    The Voice Connector group ID.

    
    
  • e164_phone_numbers(impl Into<String>) / set_e164_phone_numbers(Option<Vec::<String>>):
    required: true
    

    The list of phone numbers, in E.164 format.

    
    
• On success, responds with DisassociatePhoneNumbersFromVoiceConnectorGroupOutput with field(s):
  • phone_number_errors(Option<Vec::<PhoneNumberError>>):

    If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.

• On failure, responds with SdkError<DisassociatePhoneNumbersFromVoiceConnectorGroupError>

impl Client

pub fn get_global_settings(&self) -> GetGlobalSettingsFluentBuilder

Constructs a fluent builder for the GetGlobalSettings operation.

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

    The Voice Connector settings.

• On failure, responds with SdkError<GetGlobalSettingsError>

impl Client

pub fn get_phone_number(&self) -> GetPhoneNumberFluentBuilder

Constructs a fluent builder for the GetPhoneNumber operation.

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

    The phone number ID.

    
    
• On success, responds with GetPhoneNumberOutput with field(s):
  • phone_number(Option<PhoneNumber>):

    The phone number details.

• On failure, responds with SdkError<GetPhoneNumberError>

impl Client

pub fn get_phone_number_order(&self) -> GetPhoneNumberOrderFluentBuilder

Constructs a fluent builder for the GetPhoneNumberOrder operation.

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

    The ID of the phone number order .

    
    
• On success, responds with GetPhoneNumberOrderOutput with field(s):
  • phone_number_order(Option<PhoneNumberOrder>):

    The phone number order details.

• On failure, responds with SdkError<GetPhoneNumberOrderError>

impl Client

pub fn get_phone_number_settings(&self) -> GetPhoneNumberSettingsFluentBuilder

Constructs a fluent builder for the GetPhoneNumberSettings operation.

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

    The default outbound calling name for the account.

  • calling_name_updated_timestamp(Option<DateTime>):

    The updated outbound calling name timestamp, in ISO 8601 format.

• On failure, responds with SdkError<GetPhoneNumberSettingsError>

impl Client

pub fn get_proxy_session(&self) -> GetProxySessionFluentBuilder

Constructs a fluent builder for the GetProxySession operation.

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

    The Voice Connector ID.

    
    
  • proxy_session_id(impl Into<String>) / set_proxy_session_id(Option<String>):
    required: true
    

    The proxy session ID.

    
    
• On success, responds with GetProxySessionOutput with field(s):
  • proxy_session(Option<ProxySession>):

    The proxy session details.

• On failure, responds with SdkError<GetProxySessionError>

impl Client

pub fn get_sip_media_application(&self) -> GetSipMediaApplicationFluentBuilder

Constructs a fluent builder for the GetSipMediaApplication operation.

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

    The SIP media application ID .

    
    
• On success, responds with GetSipMediaApplicationOutput with field(s):
  • sip_media_application(Option<SipMediaApplication>):

    The details of the SIP media application.

• On failure, responds with SdkError<GetSipMediaApplicationError>

impl Client

pub fn get_sip_media_application_alexa_skill_configuration( &self ) -> GetSipMediaApplicationAlexaSkillConfigurationFluentBuilder

👎Deprecated: Due to changes made by the Amazon Alexa service, this API is no longer available for use. For more information, refer to the Alexa Smart Properties page(https://developer.amazon.com/en-US/alexa/alexasmartproperties).

Constructs a fluent builder for the GetSipMediaApplicationAlexaSkillConfiguration operation.

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

    The SIP media application ID.

    
    
• On success, responds with GetSipMediaApplicationAlexaSkillConfigurationOutput with field(s):
  • sip_media_application_alexa_skill_configuration(Option<SipMediaApplicationAlexaSkillConfiguration>):

    Returns the Alexa Skill configuration.

• On failure, responds with SdkError<GetSipMediaApplicationAlexaSkillConfigurationError>

impl Client

pub fn get_sip_media_application_logging_configuration( &self ) -> GetSipMediaApplicationLoggingConfigurationFluentBuilder

Constructs a fluent builder for the GetSipMediaApplicationLoggingConfiguration operation.

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

    The SIP media application ID.

    
    
• On success, responds with GetSipMediaApplicationLoggingConfigurationOutput with field(s):
  • sip_media_application_logging_configuration(Option<SipMediaApplicationLoggingConfiguration>):

    The actual logging configuration.

• On failure, responds with SdkError<GetSipMediaApplicationLoggingConfigurationError>

impl Client

pub fn get_sip_rule(&self) -> GetSipRuleFluentBuilder

Constructs a fluent builder for the GetSipRule operation.

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

    The SIP rule ID.

    
    
• On success, responds with GetSipRuleOutput with field(s):
  • sip_rule(Option<SipRule>):

    The SIP rule details.

• On failure, responds with SdkError<GetSipRuleError>

impl Client

pub fn get_speaker_search_task(&self) -> GetSpeakerSearchTaskFluentBuilder

Constructs a fluent builder for the GetSpeakerSearchTask operation.

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

    The Voice Connector ID.

    
    
  • speaker_search_task_id(impl Into<String>) / set_speaker_search_task_id(Option<String>):
    required: true
    

    The ID of the speaker search task.

    
    
• On success, responds with GetSpeakerSearchTaskOutput with field(s):
  • speaker_search_task(Option<SpeakerSearchTask>):

    The details of the speaker search task.

• On failure, responds with SdkError<GetSpeakerSearchTaskError>

impl Client

pub fn get_voice_connector(&self) -> GetVoiceConnectorFluentBuilder

Constructs a fluent builder for the GetVoiceConnector operation.

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

    The Voice Connector ID.

    
    
• On success, responds with GetVoiceConnectorOutput with field(s):
  • voice_connector(Option<VoiceConnector>):

    The Voice Connector details.

• On failure, responds with SdkError<GetVoiceConnectorError>

impl Client

pub fn get_voice_connector_emergency_calling_configuration( &self ) -> GetVoiceConnectorEmergencyCallingConfigurationFluentBuilder

Constructs a fluent builder for the GetVoiceConnectorEmergencyCallingConfiguration operation.

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

    The Voice Connector ID.

    
    
• On success, responds with GetVoiceConnectorEmergencyCallingConfigurationOutput with field(s):
  • emergency_calling_configuration(Option<EmergencyCallingConfiguration>):

    The details of the emergency calling configuration.

• On failure, responds with SdkError<GetVoiceConnectorEmergencyCallingConfigurationError>

impl Client

pub fn get_voice_connector_group(&self) -> GetVoiceConnectorGroupFluentBuilder

Constructs a fluent builder for the GetVoiceConnectorGroup operation.

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

    The Voice Connector group ID.

    
    
• On success, responds with GetVoiceConnectorGroupOutput with field(s):
  • voice_connector_group(Option<VoiceConnectorGroup>):

    The details of the Voice Connector group.

• On failure, responds with SdkError<GetVoiceConnectorGroupError>

impl Client

pub fn get_voice_connector_logging_configuration( &self ) -> GetVoiceConnectorLoggingConfigurationFluentBuilder

Constructs a fluent builder for the GetVoiceConnectorLoggingConfiguration operation.

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

    The Voice Connector ID.

    
    
• On success, responds with GetVoiceConnectorLoggingConfigurationOutput with field(s):
  • logging_configuration(Option<LoggingConfiguration>):

    The logging configuration details .

• On failure, responds with SdkError<GetVoiceConnectorLoggingConfigurationError>

impl Client

pub fn get_voice_connector_origination( &self ) -> GetVoiceConnectorOriginationFluentBuilder

Constructs a fluent builder for the GetVoiceConnectorOrigination operation.

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

    The Voice Connector ID.

    
    
• On success, responds with GetVoiceConnectorOriginationOutput with field(s):
  • origination(Option<Origination>):

    The origination setting details.

• On failure, responds with SdkError<GetVoiceConnectorOriginationError>

impl Client

pub fn get_voice_connector_proxy(&self) -> GetVoiceConnectorProxyFluentBuilder

Constructs a fluent builder for the GetVoiceConnectorProxy operation.

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

    The Voice Connector ID.

    
    
• On success, responds with GetVoiceConnectorProxyOutput with field(s):
  • proxy(Option<Proxy>):

    The proxy configuration details.

• On failure, responds with SdkError<GetVoiceConnectorProxyError>

impl Client

pub fn get_voice_connector_streaming_configuration( &self ) -> GetVoiceConnectorStreamingConfigurationFluentBuilder

Constructs a fluent builder for the GetVoiceConnectorStreamingConfiguration operation.

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

    The Voice Connector ID.

    
    
• On success, responds with GetVoiceConnectorStreamingConfigurationOutput with field(s):
  • streaming_configuration(Option<StreamingConfiguration>):

    The details of the streaming configuration.

• On failure, responds with SdkError<GetVoiceConnectorStreamingConfigurationError>

impl Client

pub fn get_voice_connector_termination( &self ) -> GetVoiceConnectorTerminationFluentBuilder

Constructs a fluent builder for the GetVoiceConnectorTermination operation.

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

    The Voice Connector ID.

    
    
• On success, responds with GetVoiceConnectorTerminationOutput with field(s):
  • termination(Option<Termination>):

    The termination setting details.

• On failure, responds with SdkError<GetVoiceConnectorTerminationError>

impl Client

pub fn get_voice_connector_termination_health( &self ) -> GetVoiceConnectorTerminationHealthFluentBuilder

Constructs a fluent builder for the GetVoiceConnectorTerminationHealth operation.

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

    The Voice Connector ID.

    
    
• On success, responds with GetVoiceConnectorTerminationHealthOutput with field(s):
  • termination_health(Option<TerminationHealth>):

    The termination health details.

• On failure, responds with SdkError<GetVoiceConnectorTerminationHealthError>

impl Client

pub fn get_voice_profile(&self) -> GetVoiceProfileFluentBuilder

Constructs a fluent builder for the GetVoiceProfile operation.

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

    The voice profile ID.

    
    
• On success, responds with GetVoiceProfileOutput with field(s):
  • voice_profile(Option<VoiceProfile>):

    The voice profile details.

• On failure, responds with SdkError<GetVoiceProfileError>

impl Client

pub fn get_voice_profile_domain(&self) -> GetVoiceProfileDomainFluentBuilder

Constructs a fluent builder for the GetVoiceProfileDomain operation.

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

    The voice profile domain ID.

    
    
• On success, responds with GetVoiceProfileDomainOutput with field(s):
  • voice_profile_domain(Option<VoiceProfileDomain>):

    The details of the voice profile domain.

• On failure, responds with SdkError<GetVoiceProfileDomainError>

impl Client

pub fn get_voice_tone_analysis_task( &self ) -> GetVoiceToneAnalysisTaskFluentBuilder

Constructs a fluent builder for the GetVoiceToneAnalysisTask operation.

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

    The Voice Connector ID.

    
    
  • voice_tone_analysis_task_id(impl Into<String>) / set_voice_tone_analysis_task_id(Option<String>):
    required: true
    

    The ID of the voice tone anlysis task.

    
    
  • is_caller(bool) / set_is_caller(Option<bool>):
    required: true
    

    Specifies whether the voice being analyzed is the caller (originator) or the callee (responder).

    
    
• On success, responds with GetVoiceToneAnalysisTaskOutput with field(s):
  • voice_tone_analysis_task(Option<VoiceToneAnalysisTask>):

    The details of the voice tone analysis task.

• On failure, responds with SdkError<GetVoiceToneAnalysisTaskError>

impl Client

pub fn list_available_voice_connector_regions( &self ) -> ListAvailableVoiceConnectorRegionsFluentBuilder

Constructs a fluent builder for the ListAvailableVoiceConnectorRegions operation.

• The fluent builder takes no input, just send it.
• On success, responds with ListAvailableVoiceConnectorRegionsOutput with field(s):
  • voice_connector_regions(Option<Vec::<VoiceConnectorAwsRegion>>):

    The list of AWS Regions.

• On failure, responds with SdkError<ListAvailableVoiceConnectorRegionsError>

impl Client

pub fn list_phone_number_orders(&self) -> ListPhoneNumberOrdersFluentBuilder

Constructs a fluent builder for the ListPhoneNumberOrders 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 used to retrieve the next page of results.

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

    The maximum number of results to return in a single call.

    
    
• On success, responds with ListPhoneNumberOrdersOutput with field(s):
  • phone_number_orders(Option<Vec::<PhoneNumberOrder>>):

    The phone number order details.

  • next_token(Option<String>):

    The token used to retrieve the next page of results.

• On failure, responds with SdkError<ListPhoneNumberOrdersError>

impl Client

pub fn list_phone_numbers(&self) -> ListPhoneNumbersFluentBuilder

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

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

    The status of your organization’s phone numbers.

    
    
  • product_type(PhoneNumberProductType) / set_product_type(Option<PhoneNumberProductType>):
    required: false
    

    The phone number product types.

    
    
  • filter_name(PhoneNumberAssociationName) / set_filter_name(Option<PhoneNumberAssociationName>):
    required: false
    

    The filter to limit the number of results.

    
    
  • filter_value(impl Into<String>) / set_filter_value(Option<String>):
    required: false
    

    The filter value.

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

    The maximum number of results to return in a single call.

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

    The token used to return the next page of results.

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

    The phone number details.

  • next_token(Option<String>):

    The token used to return the next page of results.

• On failure, responds with SdkError<ListPhoneNumbersError>

impl Client

pub fn list_proxy_sessions(&self) -> ListProxySessionsFluentBuilder

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

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

    The Voice Connector ID.

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

    The proxy session status.

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

    The token used to retrieve the next page of results.

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

    The maximum number of results to return in a single call.

    
    
• On success, responds with ListProxySessionsOutput with field(s):
  • proxy_sessions(Option<Vec::<ProxySession>>):

    The proxy sessions’ details.

  • next_token(Option<String>):

    The token used to retrieve the next page of results.

• On failure, responds with SdkError<ListProxySessionsError>

impl Client

pub fn list_sip_media_applications( &self ) -> ListSipMediaApplicationsFluentBuilder

Constructs a fluent builder for the ListSipMediaApplications 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 in a single call. Defaults to 100.

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

    The token used to return the next page of results.

    
    
• On success, responds with ListSipMediaApplicationsOutput with field(s):
  • sip_media_applications(Option<Vec::<SipMediaApplication>>):

    The list of SIP media applications and application details.

  • next_token(Option<String>):

    The token used to return the next page of results.

• On failure, responds with SdkError<ListSipMediaApplicationsError>

impl Client

pub fn list_sip_rules(&self) -> ListSipRulesFluentBuilder

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

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

    The SIP media application ID.

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

    The maximum number of results to return in a single call. Defaults to 100.

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

    The token used to return the next page of results.

    
    
• On success, responds with ListSipRulesOutput with field(s):
  • sip_rules(Option<Vec::<SipRule>>):

    The list of SIP rules and details.

  • next_token(Option<String>):

    The token used to return the next page of results.

• On failure, responds with SdkError<ListSipRulesError>

impl Client

pub fn list_supported_phone_number_countries( &self ) -> ListSupportedPhoneNumberCountriesFluentBuilder

Constructs a fluent builder for the ListSupportedPhoneNumberCountries operation.

• The fluent builder is configurable:
  • product_type(PhoneNumberProductType) / set_product_type(Option<PhoneNumberProductType>):
    required: true
    

    The phone number product type.

    
    
• On success, responds with ListSupportedPhoneNumberCountriesOutput with field(s):
  • phone_number_countries(Option<Vec::<PhoneNumberCountry>>):

    The supported phone number countries.

• On failure, responds with SdkError<ListSupportedPhoneNumberCountriesError>

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

    
    
• On success, responds with ListTagsForResourceOutput with field(s):
  • tags(Option<Vec::<Tag>>):

    The tags in the list.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn list_voice_connector_groups( &self ) -> ListVoiceConnectorGroupsFluentBuilder

Constructs a fluent builder for the ListVoiceConnectorGroups 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 used to return the next page of results.

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

    The maximum number of results to return in a single call.

    
    
• On success, responds with ListVoiceConnectorGroupsOutput with field(s):
  • voice_connector_groups(Option<Vec::<VoiceConnectorGroup>>):

    The details of the Voice Connector groups.

  • next_token(Option<String>):

    The token used to return the next page of results.

• On failure, responds with SdkError<ListVoiceConnectorGroupsError>

impl Client

pub fn list_voice_connector_termination_credentials( &self ) -> ListVoiceConnectorTerminationCredentialsFluentBuilder

Constructs a fluent builder for the ListVoiceConnectorTerminationCredentials operation.

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

    The Voice Connector ID.

    
    
• On success, responds with ListVoiceConnectorTerminationCredentialsOutput with field(s):
  • usernames(Option<Vec::<String>>):

    A list of user names.

• On failure, responds with SdkError<ListVoiceConnectorTerminationCredentialsError>

impl Client

pub fn list_voice_connectors(&self) -> ListVoiceConnectorsFluentBuilder

Constructs a fluent builder for the ListVoiceConnectors 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 used to return the next page of results.

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

    The maximum number of results to return in a single call.

    
    
• On success, responds with ListVoiceConnectorsOutput with field(s):
  • voice_connectors(Option<Vec::<VoiceConnector>>):

    The details of the Voice Connectors.

  • next_token(Option<String>):

    The token used to return the next page of results.

• On failure, responds with SdkError<ListVoiceConnectorsError>

impl Client

pub fn list_voice_profile_domains(&self) -> ListVoiceProfileDomainsFluentBuilder

Constructs a fluent builder for the ListVoiceProfileDomains 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 used to return the next page of results.

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

    The maximum number of results to return in a single call.

    
    
• On success, responds with ListVoiceProfileDomainsOutput with field(s):
  • voice_profile_domains(Option<Vec::<VoiceProfileDomainSummary>>):

    The list of voice profile domains.

  • next_token(Option<String>):

    The token used to return the next page of results.

• On failure, responds with SdkError<ListVoiceProfileDomainsError>

impl Client

pub fn list_voice_profiles(&self) -> ListVoiceProfilesFluentBuilder

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

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

    The ID of the voice profile domain.

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

    The token used to retrieve the next page of results.

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

    The maximum number of results in the request.

    
    
• On success, responds with ListVoiceProfilesOutput with field(s):
  • voice_profiles(Option<Vec::<VoiceProfileSummary>>):

    The list of voice profiles.

  • next_token(Option<String>):

    The token used to retrieve the next page of results.

• On failure, responds with SdkError<ListVoiceProfilesError>

impl Client

pub fn put_sip_media_application_alexa_skill_configuration( &self ) -> PutSipMediaApplicationAlexaSkillConfigurationFluentBuilder

👎Deprecated: Due to changes made by the Amazon Alexa service, this API is no longer available for use. For more information, refer to the Alexa Smart Properties page(https://developer.amazon.com/en-US/alexa/alexasmartproperties).

Constructs a fluent builder for the PutSipMediaApplicationAlexaSkillConfiguration operation.

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

    The SIP media application ID.

    
    
  • sip_media_application_alexa_skill_configuration(SipMediaApplicationAlexaSkillConfiguration) / set_sip_media_application_alexa_skill_configuration(Option<SipMediaApplicationAlexaSkillConfiguration>):
    required: false
    

    The Alexa Skill configuration.

    
    
• On success, responds with PutSipMediaApplicationAlexaSkillConfigurationOutput with field(s):
  • sip_media_application_alexa_skill_configuration(Option<SipMediaApplicationAlexaSkillConfiguration>):

    Returns the Alexa Skill configuration.

• On failure, responds with SdkError<PutSipMediaApplicationAlexaSkillConfigurationError>

impl Client

pub fn put_sip_media_application_logging_configuration( &self ) -> PutSipMediaApplicationLoggingConfigurationFluentBuilder

Constructs a fluent builder for the PutSipMediaApplicationLoggingConfiguration operation.

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

    The SIP media application ID.

    
    
  • sip_media_application_logging_configuration(SipMediaApplicationLoggingConfiguration) / set_sip_media_application_logging_configuration(Option<SipMediaApplicationLoggingConfiguration>):
    required: false
    

    The logging configuration for the specified SIP media application.

    
    
• On success, responds with PutSipMediaApplicationLoggingConfigurationOutput with field(s):
  • sip_media_application_logging_configuration(Option<SipMediaApplicationLoggingConfiguration>):

    The updated logging configuration for the specified SIP media application.

• On failure, responds with SdkError<PutSipMediaApplicationLoggingConfigurationError>

impl Client

pub fn put_voice_connector_emergency_calling_configuration( &self ) -> PutVoiceConnectorEmergencyCallingConfigurationFluentBuilder

Constructs a fluent builder for the PutVoiceConnectorEmergencyCallingConfiguration operation.

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

    The Voice Connector ID.

    
    
  • emergency_calling_configuration(EmergencyCallingConfiguration) / set_emergency_calling_configuration(Option<EmergencyCallingConfiguration>):
    required: true
    

    The configuration being updated.

    
    
• On success, responds with PutVoiceConnectorEmergencyCallingConfigurationOutput with field(s):
  • emergency_calling_configuration(Option<EmergencyCallingConfiguration>):

    The updated configuration.

• On failure, responds with SdkError<PutVoiceConnectorEmergencyCallingConfigurationError>

impl Client

pub fn put_voice_connector_logging_configuration( &self ) -> PutVoiceConnectorLoggingConfigurationFluentBuilder

Constructs a fluent builder for the PutVoiceConnectorLoggingConfiguration operation.

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

    The Voice Connector ID.

    
    
  • logging_configuration(LoggingConfiguration) / set_logging_configuration(Option<LoggingConfiguration>):
    required: true
    

    The logging configuration being updated.

    
    
• On success, responds with PutVoiceConnectorLoggingConfigurationOutput with field(s):
  • logging_configuration(Option<LoggingConfiguration>):

    The updated logging configuration.

• On failure, responds with SdkError<PutVoiceConnectorLoggingConfigurationError>

impl Client

pub fn put_voice_connector_origination( &self ) -> PutVoiceConnectorOriginationFluentBuilder

Constructs a fluent builder for the PutVoiceConnectorOrigination operation.

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

    The Voice Connector ID.

    
    
  • origination(Origination) / set_origination(Option<Origination>):
    required: true
    

    The origination settings being updated.

    
    
• On success, responds with PutVoiceConnectorOriginationOutput with field(s):
  • origination(Option<Origination>):

    The updated origination settings.

• On failure, responds with SdkError<PutVoiceConnectorOriginationError>

impl Client

pub fn put_voice_connector_proxy(&self) -> PutVoiceConnectorProxyFluentBuilder

Constructs a fluent builder for the PutVoiceConnectorProxy operation.

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

    The Voice Connector ID.

    
    
  • default_session_expiry_minutes(i32) / set_default_session_expiry_minutes(Option<i32>):
    required: true
    

    The default number of minutes allowed for proxy session.

    
    
  • phone_number_pool_countries(impl Into<String>) / set_phone_number_pool_countries(Option<Vec::<String>>):
    required: true
    

    The countries for proxy phone numbers to be selected from.

    
    
  • fall_back_phone_number(impl Into<String>) / set_fall_back_phone_number(Option<String>):
    required: false
    

    The phone number to route calls to after a proxy session expires.

    
    
  • disabled(bool) / set_disabled(Option<bool>):
    required: false
    

    When true, stops proxy sessions from being created on the specified Amazon Chime SDK Voice Connector.

    
    
• On success, responds with PutVoiceConnectorProxyOutput with field(s):
  • proxy(Option<Proxy>):

    The proxy configuration details.

• On failure, responds with SdkError<PutVoiceConnectorProxyError>

impl Client

pub fn put_voice_connector_streaming_configuration( &self ) -> PutVoiceConnectorStreamingConfigurationFluentBuilder

Constructs a fluent builder for the PutVoiceConnectorStreamingConfiguration operation.

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

    The Voice Connector ID.

    
    
  • streaming_configuration(StreamingConfiguration) / set_streaming_configuration(Option<StreamingConfiguration>):
    required: true
    

    The streaming settings being updated.

    
    
• On success, responds with PutVoiceConnectorStreamingConfigurationOutput with field(s):
  • streaming_configuration(Option<StreamingConfiguration>):

    The updated streaming settings.

• On failure, responds with SdkError<PutVoiceConnectorStreamingConfigurationError>

impl Client

pub fn put_voice_connector_termination( &self ) -> PutVoiceConnectorTerminationFluentBuilder

Constructs a fluent builder for the PutVoiceConnectorTermination operation.

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

    The Voice Connector ID.

    
    
  • termination(Termination) / set_termination(Option<Termination>):
    required: true
    

    The termination settings to be updated.

    
    
• On success, responds with PutVoiceConnectorTerminationOutput with field(s):
  • termination(Option<Termination>):

    The updated termination settings.

• On failure, responds with SdkError<PutVoiceConnectorTerminationError>

impl Client

pub fn put_voice_connector_termination_credentials( &self ) -> PutVoiceConnectorTerminationCredentialsFluentBuilder

Constructs a fluent builder for the PutVoiceConnectorTerminationCredentials operation.

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

    The Voice Connector ID.

    
    
  • credentials(Credential) / set_credentials(Option<Vec::<Credential>>):
    required: false
    

    The termination credentials being updated.

    
    
• On success, responds with PutVoiceConnectorTerminationCredentialsOutput
• On failure, responds with SdkError<PutVoiceConnectorTerminationCredentialsError>

impl Client

pub fn restore_phone_number(&self) -> RestorePhoneNumberFluentBuilder

Constructs a fluent builder for the RestorePhoneNumber operation.

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

    The ID of the phone number being restored.

    
    
• On success, responds with RestorePhoneNumberOutput with field(s):
  • phone_number(Option<PhoneNumber>):

    The restored phone number.

• On failure, responds with SdkError<RestorePhoneNumberError>

impl Client

pub fn search_available_phone_numbers( &self ) -> SearchAvailablePhoneNumbersFluentBuilder

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

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

    Confines a search to just the phone numbers associated with the specified area code.

    
    
  • city(impl Into<String>) / set_city(Option<String>):
    required: false
    

    Confines a search to just the phone numbers associated with the specified city.

    
    
  • country(impl Into<String>) / set_country(Option<String>):
    required: false
    

    Confines a search to just the phone numbers associated with the specified country.

    
    
  • state(impl Into<String>) / set_state(Option<String>):
    required: false
    

    Confines a search to just the phone numbers associated with the specified state.

    
    
  • toll_free_prefix(impl Into<String>) / set_toll_free_prefix(Option<String>):
    required: false
    

    Confines a search to just the phone numbers associated with the specified toll-free prefix.

    
    
  • phone_number_type(PhoneNumberType) / set_phone_number_type(Option<PhoneNumberType>):
    required: false
    

    Confines a search to just the phone numbers associated with the specified phone number type, either local or toll-free.

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

    The maximum number of results to return.

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

    The token used to return the next page of results.

    
    
• On success, responds with SearchAvailablePhoneNumbersOutput with field(s):
  • e164_phone_numbers(Option<Vec::<String>>):

    Confines a search to just the phone numbers in the E.164 format.

  • next_token(Option<String>):

    The token used to return the next page of results.

• On failure, responds with SdkError<SearchAvailablePhoneNumbersError>

impl Client

pub fn start_speaker_search_task(&self) -> StartSpeakerSearchTaskFluentBuilder

Constructs a fluent builder for the StartSpeakerSearchTask operation.

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

    The Voice Connector ID.

    
    
  • transaction_id(impl Into<String>) / set_transaction_id(Option<String>):
    required: true
    

    The transaction ID of the call being analyzed.

    
    
  • voice_profile_domain_id(impl Into<String>) / set_voice_profile_domain_id(Option<String>):
    required: true
    

    The ID of the voice profile domain that will store the voice profile.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: false
    

    The unique identifier for the client request. Use a different token for different speaker search tasks.

    
    
  • call_leg(CallLegType) / set_call_leg(Option<CallLegType>):
    required: false
    

    Specifies which call leg to stream for speaker search.

    
    
• On success, responds with StartSpeakerSearchTaskOutput with field(s):
  • speaker_search_task(Option<SpeakerSearchTask>):

    The details of the speaker search task.

• On failure, responds with SdkError<StartSpeakerSearchTaskError>

impl Client

pub fn start_voice_tone_analysis_task( &self ) -> StartVoiceToneAnalysisTaskFluentBuilder

Constructs a fluent builder for the StartVoiceToneAnalysisTask operation.

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

    The Voice Connector ID.

    
    
  • transaction_id(impl Into<String>) / set_transaction_id(Option<String>):
    required: true
    

    The transaction ID.

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

    The language code.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: false
    

    The unique identifier for the client request. Use a different token for different voice tone analysis tasks.

    
    
• On success, responds with StartVoiceToneAnalysisTaskOutput with field(s):
  • voice_tone_analysis_task(Option<VoiceToneAnalysisTask>):

    The details of the voice tone analysis task.

• On failure, responds with SdkError<StartVoiceToneAnalysisTaskError>

impl Client

pub fn stop_speaker_search_task(&self) -> StopSpeakerSearchTaskFluentBuilder

Constructs a fluent builder for the StopSpeakerSearchTask operation.

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

    The Voice Connector ID.

    
    
  • speaker_search_task_id(impl Into<String>) / set_speaker_search_task_id(Option<String>):
    required: true
    

    The speaker search task ID.

    
    
• On success, responds with StopSpeakerSearchTaskOutput
• On failure, responds with SdkError<StopSpeakerSearchTaskError>

impl Client

pub fn stop_voice_tone_analysis_task( &self ) -> StopVoiceToneAnalysisTaskFluentBuilder

Constructs a fluent builder for the StopVoiceToneAnalysisTask operation.

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

    The Voice Connector ID.

    
    
  • voice_tone_analysis_task_id(impl Into<String>) / set_voice_tone_analysis_task_id(Option<String>):
    required: true
    

    The ID of the voice tone analysis task.

    
    
• On success, responds with StopVoiceToneAnalysisTaskOutput
• On failure, responds with SdkError<StopVoiceToneAnalysisTaskError>

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 ARN of the resource being tagged.

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

    A list of the tags being added to 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 ARN of the resource having its tags removed.

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

    The keys of the tags being removed from the resource.

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

impl Client

pub fn update_global_settings(&self) -> UpdateGlobalSettingsFluentBuilder

Constructs a fluent builder for the UpdateGlobalSettings operation.

• The fluent builder is configurable:
  • voice_connector(VoiceConnectorSettings) / set_voice_connector(Option<VoiceConnectorSettings>):
    required: false
    

    The Voice Connector settings.

    
    
• On success, responds with UpdateGlobalSettingsOutput
• On failure, responds with SdkError<UpdateGlobalSettingsError>

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 phone number ID.

    
    
  • product_type(PhoneNumberProductType) / set_product_type(Option<PhoneNumberProductType>):
    required: false
    

    The product type.

    
    
  • calling_name(impl Into<String>) / set_calling_name(Option<String>):
    required: false
    

    The outbound calling name associated with the phone number.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    Specifies the updated name assigned to one or more phone numbers.

    
    
• On success, responds with UpdatePhoneNumberOutput with field(s):
  • phone_number(Option<PhoneNumber>):

    The updated phone number details.

• On failure, responds with SdkError<UpdatePhoneNumberError>

impl Client

pub fn update_phone_number_settings( &self ) -> UpdatePhoneNumberSettingsFluentBuilder

Constructs a fluent builder for the UpdatePhoneNumberSettings operation.

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

    The default outbound calling name for the account.

    
    
• On success, responds with UpdatePhoneNumberSettingsOutput
• On failure, responds with SdkError<UpdatePhoneNumberSettingsError>

impl Client

pub fn update_proxy_session(&self) -> UpdateProxySessionFluentBuilder

Constructs a fluent builder for the UpdateProxySession operation.

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

    The Voice Connector ID.

    
    
  • proxy_session_id(impl Into<String>) / set_proxy_session_id(Option<String>):
    required: true
    

    The proxy session ID.

    
    
  • capabilities(Capability) / set_capabilities(Option<Vec::<Capability>>):
    required: true
    

    The proxy session capabilities.

    
    
  • expiry_minutes(i32) / set_expiry_minutes(Option<i32>):
    required: false
    

    The number of minutes allowed for the proxy session.

    
    
• On success, responds with UpdateProxySessionOutput with field(s):
  • proxy_session(Option<ProxySession>):

    The updated proxy session details.

• On failure, responds with SdkError<UpdateProxySessionError>

impl Client

pub fn update_sip_media_application( &self ) -> UpdateSipMediaApplicationFluentBuilder

Constructs a fluent builder for the UpdateSipMediaApplication operation.

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

    The SIP media application ID.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    The new name for the specified SIP media application.

    
    
  • endpoints(SipMediaApplicationEndpoint) / set_endpoints(Option<Vec::<SipMediaApplicationEndpoint>>):
    required: false
    

    The new set of endpoints for the specified SIP media application.

    
    
• On success, responds with UpdateSipMediaApplicationOutput with field(s):
  • sip_media_application(Option<SipMediaApplication>):

    The updated SIP media application’s details.

• On failure, responds with SdkError<UpdateSipMediaApplicationError>

impl Client

pub fn update_sip_media_application_call( &self ) -> UpdateSipMediaApplicationCallFluentBuilder

Constructs a fluent builder for the UpdateSipMediaApplicationCall operation.

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

    The ID of the SIP media application handling the call.

    
    
  • transaction_id(impl Into<String>) / set_transaction_id(Option<String>):
    required: true
    

    The ID of the call transaction.

    
    
  • arguments(impl Into<String>, impl Into<String>) / set_arguments(Option<HashMap::<String, String>>):
    required: true
    

    Arguments made available to the Lambda function as part of the CALL_UPDATE_REQUESTED event. Can contain 0-20 key-value pairs.

    
    
• On success, responds with UpdateSipMediaApplicationCallOutput with field(s):
  • sip_media_application_call(Option<SipMediaApplicationCall>):

    A Call instance for a SIP media application.

• On failure, responds with SdkError<UpdateSipMediaApplicationCallError>

impl Client

pub fn update_sip_rule(&self) -> UpdateSipRuleFluentBuilder

Constructs a fluent builder for the UpdateSipRule operation.

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

    The SIP rule ID.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The new name for the specified SIP rule.

    
    
  • disabled(bool) / set_disabled(Option<bool>):
    required: false
    

    The new value that indicates whether the rule is disabled.

    
    
  • target_applications(SipRuleTargetApplication) / set_target_applications(Option<Vec::<SipRuleTargetApplication>>):
    required: false
    

    The new list of target applications.

    
    
• On success, responds with UpdateSipRuleOutput with field(s):
  • sip_rule(Option<SipRule>):

    The updated SIP rule details.

• On failure, responds with SdkError<UpdateSipRuleError>

impl Client

pub fn update_voice_connector(&self) -> UpdateVoiceConnectorFluentBuilder

Constructs a fluent builder for the UpdateVoiceConnector operation.

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

    The Voice Connector ID.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the Voice Connector.

    
    
  • require_encryption(bool) / set_require_encryption(Option<bool>):
    required: true
    

    When enabled, requires encryption for the Voice Connector.

    
    
• On success, responds with UpdateVoiceConnectorOutput with field(s):
  • voice_connector(Option<VoiceConnector>):

    The updated Voice Connector details.

• On failure, responds with SdkError<UpdateVoiceConnectorError>

impl Client

pub fn update_voice_connector_group( &self ) -> UpdateVoiceConnectorGroupFluentBuilder

Constructs a fluent builder for the UpdateVoiceConnectorGroup operation.

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

    The Voice Connector ID.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the Voice Connector group.

    
    
  • voice_connector_items(VoiceConnectorItem) / set_voice_connector_items(Option<Vec::<VoiceConnectorItem>>):
    required: true
    

    The VoiceConnectorItems to associate with the Voice Connector group.

    
    
• On success, responds with UpdateVoiceConnectorGroupOutput with field(s):
  • voice_connector_group(Option<VoiceConnectorGroup>):

    The updated Voice Connector group.

• On failure, responds with SdkError<UpdateVoiceConnectorGroupError>

impl Client

pub fn update_voice_profile(&self) -> UpdateVoiceProfileFluentBuilder

Constructs a fluent builder for the UpdateVoiceProfile operation.

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

    The profile ID.

    
    
  • speaker_search_task_id(impl Into<String>) / set_speaker_search_task_id(Option<String>):
    required: true
    

    The ID of the speaker search task.

    
    
• On success, responds with UpdateVoiceProfileOutput with field(s):
  • voice_profile(Option<VoiceProfile>):

    The updated voice profile settings.

• On failure, responds with SdkError<UpdateVoiceProfileError>

impl Client

pub fn update_voice_profile_domain( &self ) -> UpdateVoiceProfileDomainFluentBuilder

Constructs a fluent builder for the UpdateVoiceProfileDomain operation.

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

    The domain ID.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    The name of the voice profile domain.

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

    The description of the voice profile domain.

    
    
• On success, responds with UpdateVoiceProfileDomainOutput with field(s):
  • voice_profile_domain(Option<VoiceProfileDomain>):

    The updated details of the voice profile domain.

• On failure, responds with SdkError<UpdateVoiceProfileDomainError>

impl Client

pub fn validate_e911_address(&self) -> ValidateE911AddressFluentBuilder

Constructs a fluent builder for the ValidateE911Address operation.

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

    The AWS account ID.

    
    
  • street_number(impl Into<String>) / set_street_number(Option<String>):
    required: true
    

    The address street number, such as 200 or 2121.

    
    
  • street_info(impl Into<String>) / set_street_info(Option<String>):
    required: true
    

    The address street information, such as 8th Avenue.

    
    
  • city(impl Into<String>) / set_city(Option<String>):
    required: true
    

    The address city, such as Portland.

    
    
  • state(impl Into<String>) / set_state(Option<String>):
    required: true
    

    The address state, such as ME.

    
    
  • country(impl Into<String>) / set_country(Option<String>):
    required: true
    

    The country in the address being validated.

    
    
  • postal_code(impl Into<String>) / set_postal_code(Option<String>):
    required: true
    

    The dress postal code, such 04352.

    
    
• On success, responds with ValidateE911AddressOutput with field(s):
  • validation_result(i32):

    Number indicating the result of address validation. 0 means the address was perfect as-is and successfully validated. 1 means the address was corrected. 2 means the address sent was not close enough and was not validated.

  • address_external_id(Option<String>):

    The ID that represents the address.

  • address(Option<Address>):

    The validated address.

  • candidate_address_list(Option<Vec::<CandidateAddress>>):

    The list of address suggestions..

• On failure, responds with SdkError<ValidateE911AddressError>

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