Struct aws_sdk_alexaforbusiness::client::Client

pub struct Client { /* private fields */ }

Client for Alexa For Business

Client for invoking operations on Alexa For Business. Each operation on Alexa For Business 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_alexaforbusiness::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_alexaforbusiness::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 ApproveSkill operation has a Client::approve_skill, 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.approve_skill()
    .skill_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 approve_skill(&self) -> ApproveSkillFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

Constructs a fluent builder for the ApproveSkill operation.

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

    The unique identifier of the skill.

    
    
• On success, responds with ApproveSkillOutput
• On failure, responds with SdkError<ApproveSkillError>

impl Client

pub fn associate_contact_with_address_book( &self ) -> AssociateContactWithAddressBookFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

Constructs a fluent builder for the AssociateContactWithAddressBook operation.

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

    The ARN of the contact to associate with an address book.

    
    
  • address_book_arn(impl Into<String>) / set_address_book_arn(Option<String>):
    required: true
    

    The ARN of the address book with which to associate the contact.

    
    
• On success, responds with AssociateContactWithAddressBookOutput
• On failure, responds with SdkError<AssociateContactWithAddressBookError>

impl Client

pub fn associate_device_with_network_profile( &self ) -> AssociateDeviceWithNetworkProfileFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

Constructs a fluent builder for the AssociateDeviceWithNetworkProfile operation.

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

    The device ARN.

    
    
  • network_profile_arn(impl Into<String>) / set_network_profile_arn(Option<String>):
    required: true
    

    The ARN of the network profile to associate with a device.

    
    
• On success, responds with AssociateDeviceWithNetworkProfileOutput
• On failure, responds with SdkError<AssociateDeviceWithNetworkProfileError>

impl Client

pub fn associate_device_with_room(&self) -> AssociateDeviceWithRoomFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

Constructs a fluent builder for the AssociateDeviceWithRoom operation.

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

    The ARN of the device to associate to a room. Required.

    
    
  • room_arn(impl Into<String>) / set_room_arn(Option<String>):
    required: false
    

    The ARN of the room with which to associate the device. Required.

    
    
• On success, responds with AssociateDeviceWithRoomOutput
• On failure, responds with SdkError<AssociateDeviceWithRoomError>

impl Client

pub fn associate_skill_group_with_room( &self ) -> AssociateSkillGroupWithRoomFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

Constructs a fluent builder for the AssociateSkillGroupWithRoom operation.

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

    The ARN of the skill group to associate with a room. Required.

    
    
  • room_arn(impl Into<String>) / set_room_arn(Option<String>):
    required: false
    

    The ARN of the room with which to associate the skill group. Required.

    
    
• On success, responds with AssociateSkillGroupWithRoomOutput
• On failure, responds with SdkError<AssociateSkillGroupWithRoomError>

impl Client

pub fn associate_skill_with_skill_group( &self ) -> AssociateSkillWithSkillGroupFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

Constructs a fluent builder for the AssociateSkillWithSkillGroup operation.

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

    The ARN of the skill group to associate the skill to. Required.

    
    
  • skill_id(impl Into<String>) / set_skill_id(Option<String>):
    required: true
    

    The unique identifier of the skill.

    
    
• On success, responds with AssociateSkillWithSkillGroupOutput
• On failure, responds with SdkError<AssociateSkillWithSkillGroupError>

impl Client

pub fn associate_skill_with_users(&self) -> AssociateSkillWithUsersFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

Constructs a fluent builder for the AssociateSkillWithUsers operation.

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

    The private skill ID you want to make available to enrolled users.

    
    
• On success, responds with AssociateSkillWithUsersOutput
• On failure, responds with SdkError<AssociateSkillWithUsersError>

impl Client

pub fn create_address_book(&self) -> CreateAddressBookFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

Constructs a fluent builder for the CreateAddressBook operation.

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

    The name of the address book.

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

    The description of the address book.

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

    A unique, user-specified identifier for the request that ensures idempotency.

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

    The tags to be added to the specified resource. Do not provide system tags.

    
    
• On success, responds with CreateAddressBookOutput with field(s):
  • address_book_arn(Option<String>):

    The ARN of the newly created address book.

• On failure, responds with SdkError<CreateAddressBookError>

impl Client

pub fn create_business_report_schedule( &self ) -> CreateBusinessReportScheduleFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

Constructs a fluent builder for the CreateBusinessReportSchedule operation.

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

    The name identifier of the schedule.

    
    
  • s3_bucket_name(impl Into<String>) / set_s3_bucket_name(Option<String>):
    required: false
    

    The S3 bucket name of the output reports. If this isn’t specified, the report can be retrieved from a download link by calling ListBusinessReportSchedule.

    
    
  • s3_key_prefix(impl Into<String>) / set_s3_key_prefix(Option<String>):
    required: false
    

    The S3 key where the report is delivered.

    
    
  • format(BusinessReportFormat) / set_format(Option<BusinessReportFormat>):
    required: true
    

    The format of the generated report (individual CSV files or zipped files of individual files).

    
    
  • content_range(BusinessReportContentRange) / set_content_range(Option<BusinessReportContentRange>):
    required: true
    

    The content range of the reports.

    
    
  • recurrence(BusinessReportRecurrence) / set_recurrence(Option<BusinessReportRecurrence>):
    required: false
    

    The recurrence of the reports. If this isn’t specified, the report will only be delivered one time when the API is called.

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

    The client request token.

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

    The tags for the business report schedule.

    
    
• On success, responds with CreateBusinessReportScheduleOutput with field(s):
  • schedule_arn(Option<String>):

    The ARN of the business report schedule.

• On failure, responds with SdkError<CreateBusinessReportScheduleError>

impl Client

pub fn create_conference_provider( &self ) -> CreateConferenceProviderFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

Constructs a fluent builder for the CreateConferenceProvider operation.

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

    The name of the conference provider.

    
    
  • conference_provider_type(ConferenceProviderType) / set_conference_provider_type(Option<ConferenceProviderType>):
    required: true
    

    Represents a type within a list of predefined types.

    
    
  • ip_dial_in(IpDialIn) / set_ip_dial_in(Option<IpDialIn>):
    required: false
    

    The IP endpoint and protocol for calling.

    
    
  • pstn_dial_in(PstnDialIn) / set_pstn_dial_in(Option<PstnDialIn>):
    required: false
    

    The information for PSTN conferencing.

    
    
  • meeting_setting(MeetingSetting) / set_meeting_setting(Option<MeetingSetting>):
    required: true
    

    The meeting settings for the conference provider.

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

    The request token of the client.

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

    The tags to be added to the specified resource. Do not provide system tags.

    
    
• On success, responds with CreateConferenceProviderOutput with field(s):
  • conference_provider_arn(Option<String>):

    The ARN of the newly-created conference provider.

• On failure, responds with SdkError<CreateConferenceProviderError>

impl Client

pub fn create_contact(&self) -> CreateContactFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

Constructs a fluent builder for the CreateContact operation.

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

    The name of the contact to display on the console.

    
    
  • first_name(impl Into<String>) / set_first_name(Option<String>):
    required: true
    

    The first name of the contact that is used to call the contact on the device.

    
    
  • last_name(impl Into<String>) / set_last_name(Option<String>):
    required: false
    

    The last name of the contact that is used to call the contact on the device.

    
    
  • phone_number(impl Into<String>) / set_phone_number(Option<String>):
    required: false
    

    The phone number of the contact in E.164 format. The phone number type defaults to WORK. You can specify PhoneNumber or PhoneNumbers. We recommend that you use PhoneNumbers, which lets you specify the phone number type and multiple numbers.

    
    
  • phone_numbers(PhoneNumber) / set_phone_numbers(Option<Vec::<PhoneNumber>>):
    required: false
    

    The list of phone numbers for the contact.

    
    
  • sip_addresses(SipAddress) / set_sip_addresses(Option<Vec::<SipAddress>>):
    required: false
    

    The list of SIP addresses for the contact.

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

    A unique, user-specified identifier for this request that ensures idempotency.

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

    The tags to be added to the specified resource. Do not provide system tags.

    
    
• On success, responds with CreateContactOutput with field(s):
  • contact_arn(Option<String>):

    The ARN of the newly created address book.

• On failure, responds with SdkError<CreateContactError>

impl Client

pub fn create_gateway_group(&self) -> CreateGatewayGroupFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

Constructs a fluent builder for the CreateGatewayGroup operation.

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

    The name of the gateway group.

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

    The description of the gateway group.

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

    A unique, user-specified identifier for the request that ensures idempotency.

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

    The tags to be added to the specified resource. Do not provide system tags.

    
    
• On success, responds with CreateGatewayGroupOutput with field(s):
  • gateway_group_arn(Option<String>):

    The ARN of the created gateway group.

• On failure, responds with SdkError<CreateGatewayGroupError>

impl Client

pub fn create_network_profile(&self) -> CreateNetworkProfileFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

Constructs a fluent builder for the CreateNetworkProfile operation.

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

    The name of the network profile associated with a device.

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

    Detailed information about a device’s network profile.

    
    
  • ssid(impl Into<String>) / set_ssid(Option<String>):
    required: true
    

    The SSID of the Wi-Fi network.

    
    
  • security_type(NetworkSecurityType) / set_security_type(Option<NetworkSecurityType>):
    required: true
    

    The security type of the Wi-Fi network. This can be WPA2_ENTERPRISE, WPA2_PSK, WPA_PSK, WEP, or OPEN.

    
    
  • eap_method(NetworkEapMethod) / set_eap_method(Option<NetworkEapMethod>):
    required: false
    

    The authentication standard that is used in the EAP framework. Currently, EAP_TLS is supported.

    
    
  • current_password(impl Into<String>) / set_current_password(Option<String>):
    required: false
    

    The current password of the Wi-Fi network.

    
    
  • next_password(impl Into<String>) / set_next_password(Option<String>):
    required: false
    

    The next, or subsequent, password of the Wi-Fi network. This password is asynchronously transmitted to the device and is used when the password of the network changes to NextPassword.

    
    
  • certificate_authority_arn(impl Into<String>) / set_certificate_authority_arn(Option<String>):
    required: false
    

    The ARN of the Private Certificate Authority (PCA) created in AWS Certificate Manager (ACM). This is used to issue certificates to the devices.

    
    
  • trust_anchors(impl Into<String>) / set_trust_anchors(Option<Vec::<String>>):
    required: false
    

    The root certificates of your authentication server that is installed on your devices and used to trust your authentication server during EAP negotiation.

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

    A unique, user-specified identifier for the request that ensures idempotency.

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

    The tags to be added to the specified resource. Do not provide system tags.

    
    
• On success, responds with CreateNetworkProfileOutput with field(s):
  • network_profile_arn(Option<String>):

    The ARN of the network profile associated with a device.

• On failure, responds with SdkError<CreateNetworkProfileError>

impl Client

pub fn create_profile(&self) -> CreateProfileFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

Constructs a fluent builder for the CreateProfile operation.

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

    The name of a room profile.

    
    
  • timezone(impl Into<String>) / set_timezone(Option<String>):
    required: true
    

    The time zone used by a room profile.

    
    
  • address(impl Into<String>) / set_address(Option<String>):
    required: true
    

    The valid address for the room.

    
    
  • distance_unit(DistanceUnit) / set_distance_unit(Option<DistanceUnit>):
    required: true
    

    The distance unit to be used by devices in the profile.

    
    
  • temperature_unit(TemperatureUnit) / set_temperature_unit(Option<TemperatureUnit>):
    required: true
    

    The temperature unit to be used by devices in the profile.

    
    
  • wake_word(WakeWord) / set_wake_word(Option<WakeWord>):
    required: true
    

    A wake word for Alexa, Echo, Amazon, or a computer.

    
    
  • locale(impl Into<String>) / set_locale(Option<String>):
    required: false
    

    The locale of the room profile. (This is currently only available to a limited preview audience.)

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

    The user-specified token that is used during the creation of a profile.

    
    
  • setup_mode_disabled(bool) / set_setup_mode_disabled(Option<bool>):
    required: false
    

    Whether room profile setup is enabled.

    
    
  • max_volume_limit(i32) / set_max_volume_limit(Option<i32>):
    required: false
    

    The maximum volume limit for a room profile.

    
    
  • pstn_enabled(bool) / set_pstn_enabled(Option<bool>):
    required: false
    

    Whether PSTN calling is enabled.

    
    
  • data_retention_opt_in(bool) / set_data_retention_opt_in(Option<bool>):
    required: false
    

    Whether data retention of the profile is enabled.

    
    
  • meeting_room_configuration(CreateMeetingRoomConfiguration) / set_meeting_room_configuration(Option<CreateMeetingRoomConfiguration>):
    required: false
    

    The meeting room settings of a room profile.

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

    The tags for the profile.

    
    
• On success, responds with CreateProfileOutput with field(s):
  • profile_arn(Option<String>):

    The ARN of the newly created room profile in the response.

• On failure, responds with SdkError<CreateProfileError>

impl Client

pub fn create_room(&self) -> CreateRoomFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

Constructs a fluent builder for the CreateRoom operation.

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

    The name for the room.

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

    The description for the room.

    
    
  • profile_arn(impl Into<String>) / set_profile_arn(Option<String>):
    required: false
    

    The profile ARN for the room. This is required.

    
    
  • provider_calendar_id(impl Into<String>) / set_provider_calendar_id(Option<String>):
    required: false
    

    The calendar ARN for the room.

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

    A unique, user-specified identifier for this request that ensures idempotency.

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

    The tags for the room.

    
    
• On success, responds with CreateRoomOutput with field(s):
  • room_arn(Option<String>):

    The ARN of the newly created room in the response.

• On failure, responds with SdkError<CreateRoomError>

impl Client

pub fn create_skill_group(&self) -> CreateSkillGroupFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

Constructs a fluent builder for the CreateSkillGroup operation.

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

    The name for the skill group.

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

    The description for the skill group.

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

    A unique, user-specified identifier for this request that ensures idempotency.

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

    The tags for the skill group.

    
    
• On success, responds with CreateSkillGroupOutput with field(s):
  • skill_group_arn(Option<String>):

    The ARN of the newly created skill group in the response.

• On failure, responds with SdkError<CreateSkillGroupError>

impl Client

pub fn create_user(&self) -> CreateUserFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

Constructs a fluent builder for the CreateUser operation.

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

    The ARN for the user.

    
    
  • first_name(impl Into<String>) / set_first_name(Option<String>):
    required: false
    

    The first name for the user.

    
    
  • last_name(impl Into<String>) / set_last_name(Option<String>):
    required: false
    

    The last name for the user.

    
    
  • email(impl Into<String>) / set_email(Option<String>):
    required: false
    

    The email address for the user.

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

    A unique, user-specified identifier for this request that ensures idempotency.

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

    The tags for the user.

    
    
• On success, responds with CreateUserOutput with field(s):
  • user_arn(Option<String>):

    The ARN of the newly created user in the response.

• On failure, responds with SdkError<CreateUserError>

impl Client

pub fn delete_address_book(&self) -> DeleteAddressBookFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

Constructs a fluent builder for the DeleteAddressBook operation.

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

    The ARN of the address book to delete.

    
    
• On success, responds with DeleteAddressBookOutput
• On failure, responds with SdkError<DeleteAddressBookError>

impl Client

pub fn delete_business_report_schedule( &self ) -> DeleteBusinessReportScheduleFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

Constructs a fluent builder for the DeleteBusinessReportSchedule operation.

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

    The ARN of the business report schedule.

    
    
• On success, responds with DeleteBusinessReportScheduleOutput
• On failure, responds with SdkError<DeleteBusinessReportScheduleError>

impl Client

pub fn delete_conference_provider( &self ) -> DeleteConferenceProviderFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

Constructs a fluent builder for the DeleteConferenceProvider operation.

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

    The ARN of the conference provider.

    
    
• On success, responds with DeleteConferenceProviderOutput
• On failure, responds with SdkError<DeleteConferenceProviderError>

impl Client

pub fn delete_contact(&self) -> DeleteContactFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

Constructs a fluent builder for the DeleteContact operation.

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

    The ARN of the contact to delete.

    
    
• On success, responds with DeleteContactOutput
• On failure, responds with SdkError<DeleteContactError>

impl Client

pub fn delete_device(&self) -> DeleteDeviceFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

Constructs a fluent builder for the DeleteDevice operation.

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

    The ARN of the device for which to request details.

    
    
• On success, responds with DeleteDeviceOutput
• On failure, responds with SdkError<DeleteDeviceError>

impl Client

pub fn delete_device_usage_data(&self) -> DeleteDeviceUsageDataFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

Constructs a fluent builder for the DeleteDeviceUsageData operation.

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

    The ARN of the device.

    
    
  • device_usage_type(DeviceUsageType) / set_device_usage_type(Option<DeviceUsageType>):
    required: true
    

    The type of usage data to delete.

    
    
• On success, responds with DeleteDeviceUsageDataOutput
• On failure, responds with SdkError<DeleteDeviceUsageDataError>

impl Client

pub fn delete_gateway_group(&self) -> DeleteGatewayGroupFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

Constructs a fluent builder for the DeleteGatewayGroup operation.

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

    The ARN of the gateway group to delete.

    
    
• On success, responds with DeleteGatewayGroupOutput
• On failure, responds with SdkError<DeleteGatewayGroupError>

impl Client

pub fn delete_network_profile(&self) -> DeleteNetworkProfileFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

Constructs a fluent builder for the DeleteNetworkProfile operation.

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

    The ARN of the network profile associated with a device.

    
    
• On success, responds with DeleteNetworkProfileOutput
• On failure, responds with SdkError<DeleteNetworkProfileError>

impl Client

pub fn delete_profile(&self) -> DeleteProfileFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

Constructs a fluent builder for the DeleteProfile operation.

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

    The ARN of the room profile to delete. Required.

    
    
• On success, responds with DeleteProfileOutput
• On failure, responds with SdkError<DeleteProfileError>

impl Client

pub fn delete_room(&self) -> DeleteRoomFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

Constructs a fluent builder for the DeleteRoom operation.

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

    The ARN of the room to delete. Required.

    
    
• On success, responds with DeleteRoomOutput
• On failure, responds with SdkError<DeleteRoomError>

impl Client

pub fn delete_room_skill_parameter( &self ) -> DeleteRoomSkillParameterFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

Constructs a fluent builder for the DeleteRoomSkillParameter operation.

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

    The ARN of the room from which to remove the room skill parameter details.

    
    
  • skill_id(impl Into<String>) / set_skill_id(Option<String>):
    required: true
    

    The ID of the skill from which to remove the room skill parameter details.

    
    
  • parameter_key(impl Into<String>) / set_parameter_key(Option<String>):
    required: true
    

    The room skill parameter key for which to remove details.

    
    
• On success, responds with DeleteRoomSkillParameterOutput
• On failure, responds with SdkError<DeleteRoomSkillParameterError>

impl Client

pub fn delete_skill_authorization( &self ) -> DeleteSkillAuthorizationFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

Constructs a fluent builder for the DeleteSkillAuthorization operation.

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

    The unique identifier of a skill.

    
    
  • room_arn(impl Into<String>) / set_room_arn(Option<String>):
    required: false
    

    The room that the skill is authorized for.

    
    
• On success, responds with DeleteSkillAuthorizationOutput
• On failure, responds with SdkError<DeleteSkillAuthorizationError>

impl Client

pub fn delete_skill_group(&self) -> DeleteSkillGroupFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

Constructs a fluent builder for the DeleteSkillGroup operation.

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

    The ARN of the skill group to delete. Required.

    
    
• On success, responds with DeleteSkillGroupOutput
• On failure, responds with SdkError<DeleteSkillGroupError>

impl Client

pub fn delete_user(&self) -> DeleteUserFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

Constructs a fluent builder for the DeleteUser operation.

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

    The ARN of the user to delete in the organization. Required.

    
    
  • enrollment_id(impl Into<String>) / set_enrollment_id(Option<String>):
    required: true
    

    The ARN of the user’s enrollment in the organization. Required.

    
    
• On success, responds with DeleteUserOutput
• On failure, responds with SdkError<DeleteUserError>

impl Client

pub fn disassociate_contact_from_address_book( &self ) -> DisassociateContactFromAddressBookFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

Constructs a fluent builder for the DisassociateContactFromAddressBook operation.

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

    The ARN of the contact to disassociate from an address book.

    
    
  • address_book_arn(impl Into<String>) / set_address_book_arn(Option<String>):
    required: true
    

    The ARN of the address from which to disassociate the contact.

    
    
• On success, responds with DisassociateContactFromAddressBookOutput
• On failure, responds with SdkError<DisassociateContactFromAddressBookError>

impl Client

pub fn disassociate_device_from_room( &self ) -> DisassociateDeviceFromRoomFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

Constructs a fluent builder for the DisassociateDeviceFromRoom operation.

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

    The ARN of the device to disassociate from a room. Required.

    
    
• On success, responds with DisassociateDeviceFromRoomOutput
• On failure, responds with SdkError<DisassociateDeviceFromRoomError>

impl Client

pub fn disassociate_skill_from_skill_group( &self ) -> DisassociateSkillFromSkillGroupFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

Constructs a fluent builder for the DisassociateSkillFromSkillGroup operation.

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

    The unique identifier of a skill. Required.

    
    
  • skill_id(impl Into<String>) / set_skill_id(Option<String>):
    required: true
    

    The ARN of a skill group to associate to a skill.

    
    
• On success, responds with DisassociateSkillFromSkillGroupOutput
• On failure, responds with SdkError<DisassociateSkillFromSkillGroupError>

impl Client

pub fn disassociate_skill_from_users( &self ) -> DisassociateSkillFromUsersFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

Constructs a fluent builder for the DisassociateSkillFromUsers operation.

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

    The private skill ID you want to make unavailable for enrolled users.

    
    
• On success, responds with DisassociateSkillFromUsersOutput
• On failure, responds with SdkError<DisassociateSkillFromUsersError>

impl Client

pub fn disassociate_skill_group_from_room( &self ) -> DisassociateSkillGroupFromRoomFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

Constructs a fluent builder for the DisassociateSkillGroupFromRoom operation.

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

    The ARN of the skill group to disassociate from a room. Required.

    
    
  • room_arn(impl Into<String>) / set_room_arn(Option<String>):
    required: false
    

    The ARN of the room from which the skill group is to be disassociated. Required.

    
    
• On success, responds with DisassociateSkillGroupFromRoomOutput
• On failure, responds with SdkError<DisassociateSkillGroupFromRoomError>

impl Client

pub fn forget_smart_home_appliances( &self ) -> ForgetSmartHomeAppliancesFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

Constructs a fluent builder for the ForgetSmartHomeAppliances operation.

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

    The room that the appliances are associated with.

    
    
• On success, responds with ForgetSmartHomeAppliancesOutput
• On failure, responds with SdkError<ForgetSmartHomeAppliancesError>

impl Client

pub fn get_address_book(&self) -> GetAddressBookFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

Constructs a fluent builder for the GetAddressBook operation.

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

    The ARN of the address book for which to request details.

    
    
• On success, responds with GetAddressBookOutput with field(s):
  • address_book(Option<AddressBook>):

    The details of the requested address book.

• On failure, responds with SdkError<GetAddressBookError>

impl Client

pub fn get_conference_preference(&self) -> GetConferencePreferenceFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

Constructs a fluent builder for the GetConferencePreference operation.

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

    The conference preference.

• On failure, responds with SdkError<GetConferencePreferenceError>

impl Client

pub fn get_conference_provider(&self) -> GetConferenceProviderFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

Constructs a fluent builder for the GetConferenceProvider operation.

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

    The ARN of the newly created conference provider.

    
    
• On success, responds with GetConferenceProviderOutput with field(s):
  • conference_provider(Option<ConferenceProvider>):

    The conference provider.

• On failure, responds with SdkError<GetConferenceProviderError>

impl Client

pub fn get_contact(&self) -> GetContactFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

Constructs a fluent builder for the GetContact operation.

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

    The ARN of the contact for which to request details.

    
    
• On success, responds with GetContactOutput with field(s):
  • contact(Option<Contact>):

    The details of the requested contact.

• On failure, responds with SdkError<GetContactError>

impl Client

pub fn get_device(&self) -> GetDeviceFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

Constructs a fluent builder for the GetDevice operation.

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

    The ARN of the device for which to request details. Required.

    
    
• On success, responds with GetDeviceOutput with field(s):
  • device(Option<Device>):

    The details of the device requested. Required.

• On failure, responds with SdkError<GetDeviceError>

impl Client

pub fn get_gateway(&self) -> GetGatewayFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

Constructs a fluent builder for the GetGateway operation.

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

    The ARN of the gateway to get.

    
    
• On success, responds with GetGatewayOutput with field(s):
  • gateway(Option<Gateway>):

    The details of the gateway.

• On failure, responds with SdkError<GetGatewayError>

impl Client

pub fn get_gateway_group(&self) -> GetGatewayGroupFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

Constructs a fluent builder for the GetGatewayGroup operation.

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

    The ARN of the gateway group to get.

    
    
• On success, responds with GetGatewayGroupOutput with field(s):
  • gateway_group(Option<GatewayGroup>):

    The details of the gateway group.

• On failure, responds with SdkError<GetGatewayGroupError>

impl Client

pub fn get_invitation_configuration( &self ) -> GetInvitationConfigurationFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

Constructs a fluent builder for the GetInvitationConfiguration operation.

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

    The name of the organization sending the enrollment invite to a user.

  • contact_email(Option<String>):

    The email ID of the organization or individual contact that the enrolled user can use.

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

    The list of private skill IDs that you want to recommend to the user to enable in the invitation.

• On failure, responds with SdkError<GetInvitationConfigurationError>

impl Client

pub fn get_network_profile(&self) -> GetNetworkProfileFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

Constructs a fluent builder for the GetNetworkProfile operation.

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

    The ARN of the network profile associated with a device.

    
    
• On success, responds with GetNetworkProfileOutput with field(s):
  • network_profile(Option<NetworkProfile>):

    The network profile associated with a device.

• On failure, responds with SdkError<GetNetworkProfileError>

impl Client

pub fn get_profile(&self) -> GetProfileFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

Constructs a fluent builder for the GetProfile operation.

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

    The ARN of the room profile for which to request details. Required.

    
    
• On success, responds with GetProfileOutput with field(s):
  • profile(Option<Profile>):

    The details of the room profile requested. Required.

• On failure, responds with SdkError<GetProfileError>

impl Client

pub fn get_room(&self) -> GetRoomFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

Constructs a fluent builder for the GetRoom operation.

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

    The ARN of the room for which to request details. Required.

    
    
• On success, responds with GetRoomOutput with field(s):
  • room(Option<Room>):

    The details of the room requested.

• On failure, responds with SdkError<GetRoomError>

impl Client

pub fn get_room_skill_parameter(&self) -> GetRoomSkillParameterFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

Constructs a fluent builder for the GetRoomSkillParameter operation.

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

    The ARN of the room from which to get the room skill parameter details.

    
    
  • skill_id(impl Into<String>) / set_skill_id(Option<String>):
    required: true
    

    The ARN of the skill from which to get the room skill parameter details. Required.

    
    
  • parameter_key(impl Into<String>) / set_parameter_key(Option<String>):
    required: true
    

    The room skill parameter key for which to get details. Required.

    
    
• On success, responds with GetRoomSkillParameterOutput with field(s):
  • room_skill_parameter(Option<RoomSkillParameter>):

    The details of the room skill parameter requested. Required.

• On failure, responds with SdkError<GetRoomSkillParameterError>

impl Client

pub fn get_skill_group(&self) -> GetSkillGroupFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

Constructs a fluent builder for the GetSkillGroup operation.

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

    The ARN of the skill group for which to get details. Required.

    
    
• On success, responds with GetSkillGroupOutput with field(s):
  • skill_group(Option<SkillGroup>):

    The details of the skill group requested. Required.

• On failure, responds with SdkError<GetSkillGroupError>

impl Client

pub fn list_business_report_schedules( &self ) -> ListBusinessReportSchedulesFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

Constructs a fluent builder for the ListBusinessReportSchedules 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 list the remaining schedules from the previous API call.

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

    The maximum number of schedules listed in the call.

    
    
• On success, responds with ListBusinessReportSchedulesOutput with field(s):
  • business_report_schedules(Option<Vec::<BusinessReportSchedule>>):

    The schedule of the reports.

  • next_token(Option<String>):

    The token used to list the remaining schedules from the previous API call.

• On failure, responds with SdkError<ListBusinessReportSchedulesError>

impl Client

pub fn list_conference_providers(&self) -> ListConferenceProvidersFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

Constructs a fluent builder for the ListConferenceProviders 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 tokens used for pagination.

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

    The maximum number of conference providers to be returned, per paginated calls.

    
    
• On success, responds with ListConferenceProvidersOutput with field(s):
  • conference_providers(Option<Vec::<ConferenceProvider>>):

    The conference providers.

  • next_token(Option<String>):

    The tokens used for pagination.

• On failure, responds with SdkError<ListConferenceProvidersError>

impl Client

pub fn list_device_events(&self) -> ListDeviceEventsFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

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

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

    The ARN of a device.

    
    
  • event_type(DeviceEventType) / set_event_type(Option<DeviceEventType>):
    required: false
    

    The event type to filter device events. If EventType isn’t specified, this returns a list of all device events in reverse chronological order. If EventType is specified, this returns a list of device events for that EventType in reverse chronological order.

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

    An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response only includes results beyond the token, up to the value specified by MaxResults. When the end of results is reached, the response has a value of null.

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

    The maximum number of results to include in the response. The default value is 50. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

    
    
• On success, responds with ListDeviceEventsOutput with field(s):
  • device_events(Option<Vec::<DeviceEvent>>):

    The device events requested for the device ARN.

  • next_token(Option<String>):

    The token returned to indicate that there is more data available.

• On failure, responds with SdkError<ListDeviceEventsError>

impl Client

pub fn list_gateway_groups(&self) -> ListGatewayGroupsFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

Constructs a fluent builder for the ListGatewayGroups 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 paginate though multiple pages of gateway group summaries.

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

    The maximum number of gateway group summaries to return. The default is 50.

    
    
• On success, responds with ListGatewayGroupsOutput with field(s):
  • gateway_groups(Option<Vec::<GatewayGroupSummary>>):

    The gateway groups in the list.

  • next_token(Option<String>):

    The token used to paginate though multiple pages of gateway group summaries.

• On failure, responds with SdkError<ListGatewayGroupsError>

impl Client

pub fn list_gateways(&self) -> ListGatewaysFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

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

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

    The gateway group ARN for which to list gateways.

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

    The token used to paginate though multiple pages of gateway summaries.

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

    The maximum number of gateway summaries to return. The default is 50.

    
    
• On success, responds with ListGatewaysOutput with field(s):
  • gateways(Option<Vec::<GatewaySummary>>):

    The gateways in the list.

  • next_token(Option<String>):

    The token used to paginate though multiple pages of gateway summaries.

• On failure, responds with SdkError<ListGatewaysError>

impl Client

pub fn list_skills(&self) -> ListSkillsFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

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

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

    The ARN of the skill group for which to list enabled skills.

    
    
  • enablement_type(EnablementTypeFilter) / set_enablement_type(Option<EnablementTypeFilter>):
    required: false
    

    Whether the skill is enabled under the user’s account.

    
    
  • skill_type(SkillTypeFilter) / set_skill_type(Option<SkillTypeFilter>):
    required: false
    

    Whether the skill is publicly available or is a private skill.

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

    An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

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

    The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

    
    
• On success, responds with ListSkillsOutput with field(s):
  • skill_summaries(Option<Vec::<SkillSummary>>):

    The list of enabled skills requested. Required.

  • next_token(Option<String>):

    The token returned to indicate that there is more data available.

• On failure, responds with SdkError<ListSkillsError>

impl Client

pub fn list_skills_store_categories( &self ) -> ListSkillsStoreCategoriesFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

Constructs a fluent builder for the ListSkillsStoreCategories 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 tokens used for pagination.

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

    The maximum number of categories returned, per paginated calls.

    
    
• On success, responds with ListSkillsStoreCategoriesOutput with field(s):
  • category_list(Option<Vec::<Category>>):

    The list of categories.

  • next_token(Option<String>):

    The tokens used for pagination.

• On failure, responds with SdkError<ListSkillsStoreCategoriesError>

impl Client

pub fn list_skills_store_skills_by_category( &self ) -> ListSkillsStoreSkillsByCategoryFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

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

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

    The category ID for which the skills are being retrieved from the skill store.

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

    The tokens used for pagination.

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

    The maximum number of skills returned per paginated calls.

    
    
• On success, responds with ListSkillsStoreSkillsByCategoryOutput with field(s):
  • skills_store_skills(Option<Vec::<SkillsStoreSkill>>):

    The skill store skills.

  • next_token(Option<String>):

    The tokens used for pagination.

• On failure, responds with SdkError<ListSkillsStoreSkillsByCategoryError>

impl Client

pub fn list_smart_home_appliances(&self) -> ListSmartHomeAppliancesFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

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

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

    The room that the appliances are associated with.

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

    The maximum number of appliances to be returned, per paginated calls.

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

    The tokens used for pagination.

    
    
• On success, responds with ListSmartHomeAppliancesOutput with field(s):
  • smart_home_appliances(Option<Vec::<SmartHomeAppliance>>):

    The smart home appliances.

  • next_token(Option<String>):

    The tokens used for pagination.

• On failure, responds with SdkError<ListSmartHomeAppliancesError>

impl Client

pub fn list_tags(&self) -> ListTagsFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

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

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

    The ARN of the specified resource for which to list tags.

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

    An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

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

    The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

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

    The tags requested for the specified resource.

  • next_token(Option<String>):

    The token returned to indicate that there is more data available.

• On failure, responds with SdkError<ListTagsError>

impl Client

pub fn put_conference_preference(&self) -> PutConferencePreferenceFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

Constructs a fluent builder for the PutConferencePreference operation.

• The fluent builder is configurable:
  • conference_preference(ConferencePreference) / set_conference_preference(Option<ConferencePreference>):
    required: true
    

    The conference preference of a specific conference provider.

    
    
• On success, responds with PutConferencePreferenceOutput
• On failure, responds with SdkError<PutConferencePreferenceError>

impl Client

pub fn put_invitation_configuration( &self ) -> PutInvitationConfigurationFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

Constructs a fluent builder for the PutInvitationConfiguration operation.

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

    The name of the organization sending the enrollment invite to a user.

    
    
  • contact_email(impl Into<String>) / set_contact_email(Option<String>):
    required: false
    

    The email ID of the organization or individual contact that the enrolled user can use.

    
    
  • private_skill_ids(impl Into<String>) / set_private_skill_ids(Option<Vec::<String>>):
    required: false
    

    The list of private skill IDs that you want to recommend to the user to enable in the invitation.

    
    
• On success, responds with PutInvitationConfigurationOutput
• On failure, responds with SdkError<PutInvitationConfigurationError>

impl Client

pub fn put_room_skill_parameter(&self) -> PutRoomSkillParameterFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

Constructs a fluent builder for the PutRoomSkillParameter operation.

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

    The ARN of the room associated with the room skill parameter. Required.

    
    
  • skill_id(impl Into<String>) / set_skill_id(Option<String>):
    required: true
    

    The ARN of the skill associated with the room skill parameter. Required.

    
    
  • room_skill_parameter(RoomSkillParameter) / set_room_skill_parameter(Option<RoomSkillParameter>):
    required: true
    

    The updated room skill parameter. Required.

    
    
• On success, responds with PutRoomSkillParameterOutput
• On failure, responds with SdkError<PutRoomSkillParameterError>

impl Client

pub fn put_skill_authorization(&self) -> PutSkillAuthorizationFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

Constructs a fluent builder for the PutSkillAuthorization operation.

• The fluent builder is configurable:
  • authorization_result(impl Into<String>, impl Into<String>) / set_authorization_result(Option<HashMap::<String, String>>):
    required: true
    

    The authorization result specific to OAUTH code grant output. “Code” must be populated in the AuthorizationResult map to establish the authorization.

    
    
  • skill_id(impl Into<String>) / set_skill_id(Option<String>):
    required: true
    

    The unique identifier of a skill.

    
    
  • room_arn(impl Into<String>) / set_room_arn(Option<String>):
    required: false
    

    The room that the skill is authorized for.

    
    
• On success, responds with PutSkillAuthorizationOutput
• On failure, responds with SdkError<PutSkillAuthorizationError>

impl Client

pub fn register_avs_device(&self) -> RegisterAVSDeviceFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

Constructs a fluent builder for the RegisterAVSDevice operation.

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

    The client ID of the OEM used for code-based linking authorization on an AVS device.

    
    
  • user_code(impl Into<String>) / set_user_code(Option<String>):
    required: true
    

    The code that is obtained after your AVS device has made a POST request to LWA as a part of the Device Authorization Request component of the OAuth code-based linking specification.

    
    
  • product_id(impl Into<String>) / set_product_id(Option<String>):
    required: true
    

    The product ID used to identify your AVS device during authorization.

    
    
  • device_serial_number(impl Into<String>) / set_device_serial_number(Option<String>):
    required: false
    

    The key generated by the OEM that uniquely identifies a specified instance of your AVS device.

    
    
  • amazon_id(impl Into<String>) / set_amazon_id(Option<String>):
    required: true
    

    The device type ID for your AVS device generated by Amazon when the OEM creates a new product on Amazon’s Developer Console.

    
    
  • room_arn(impl Into<String>) / set_room_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the room with which to associate your AVS device.

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

    The tags to be added to the specified resource. Do not provide system tags.

    
    
• On success, responds with RegisterAvsDeviceOutput with field(s):
  • device_arn(Option<String>):

    The ARN of the device.

• On failure, responds with SdkError<RegisterAVSDeviceError>

impl Client

pub fn reject_skill(&self) -> RejectSkillFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

Constructs a fluent builder for the RejectSkill operation.

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

    The unique identifier of the skill.

    
    
• On success, responds with RejectSkillOutput
• On failure, responds with SdkError<RejectSkillError>

impl Client

pub fn resolve_room(&self) -> ResolveRoomFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

Constructs a fluent builder for the ResolveRoom operation.

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

    The ARN of the user. Required.

    
    
  • skill_id(impl Into<String>) / set_skill_id(Option<String>):
    required: true
    

    The ARN of the skill that was requested. Required.

    
    
• On success, responds with ResolveRoomOutput with field(s):
  • room_arn(Option<String>):

    The ARN of the room from which the skill request was invoked.

  • room_name(Option<String>):

    The name of the room from which the skill request was invoked.

  • room_skill_parameters(Option<Vec::<RoomSkillParameter>>):

    Response to get the room profile request. Required.

• On failure, responds with SdkError<ResolveRoomError>

impl Client

pub fn revoke_invitation(&self) -> RevokeInvitationFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

Constructs a fluent builder for the RevokeInvitation operation.

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

    The ARN of the user for whom to revoke an enrollment invitation. Required.

    
    
  • enrollment_id(impl Into<String>) / set_enrollment_id(Option<String>):
    required: false
    

    The ARN of the enrollment invitation to revoke. Required.

    
    
• On success, responds with RevokeInvitationOutput
• On failure, responds with SdkError<RevokeInvitationError>

impl Client

pub fn search_address_books(&self) -> SearchAddressBooksFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

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

• The fluent builder is configurable:
  • filters(Filter) / set_filters(Option<Vec::<Filter>>):
    required: false
    

    The filters to use to list a specified set of address books. The supported filter key is AddressBookName.

    
    
  • sort_criteria(Sort) / set_sort_criteria(Option<Vec::<Sort>>):
    required: false
    

    The sort order to use in listing the specified set of address books. The supported sort key is AddressBookName.

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

    An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response only includes results beyond the token, up to the value specified by MaxResults.

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

    The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

    
    
• On success, responds with SearchAddressBooksOutput with field(s):
  • address_books(Option<Vec::<AddressBookData>>):

    The address books that meet the specified set of filter criteria, in sort order.

  • next_token(Option<String>):

    The token returned to indicate that there is more data available.

  • total_count(Option<i32>):

    The total number of address books returned.

• On failure, responds with SdkError<SearchAddressBooksError>

impl Client

pub fn search_contacts(&self) -> SearchContactsFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

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

• The fluent builder is configurable:
  • filters(Filter) / set_filters(Option<Vec::<Filter>>):
    required: false
    

    The filters to use to list a specified set of address books. The supported filter keys are DisplayName, FirstName, LastName, and AddressBookArns.

    
    
  • sort_criteria(Sort) / set_sort_criteria(Option<Vec::<Sort>>):
    required: false
    

    The sort order to use in listing the specified set of contacts. The supported sort keys are DisplayName, FirstName, and LastName.

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

    An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response only includes results beyond the token, up to the value specified by MaxResults.

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

    The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

    
    
• On success, responds with SearchContactsOutput with field(s):
  • contacts(Option<Vec::<ContactData>>):

    The contacts that meet the specified set of filter criteria, in sort order.

  • next_token(Option<String>):

    The token returned to indicate that there is more data available.

  • total_count(Option<i32>):

    The total number of contacts returned.

• On failure, responds with SdkError<SearchContactsError>

impl Client

pub fn search_devices(&self) -> SearchDevicesFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

Constructs a fluent builder for the SearchDevices 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
    

    An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

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

    The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

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

    The filters to use to list a specified set of devices. Supported filter keys are DeviceName, DeviceStatus, DeviceStatusDetailCode, RoomName, DeviceType, DeviceSerialNumber, UnassociatedOnly, ConnectionStatus (ONLINE and OFFLINE), NetworkProfileName, NetworkProfileArn, Feature, and FailureCode.

    
    
  • sort_criteria(Sort) / set_sort_criteria(Option<Vec::<Sort>>):
    required: false
    

    The sort order to use in listing the specified set of devices. Supported sort keys are DeviceName, DeviceStatus, RoomName, DeviceType, DeviceSerialNumber, ConnectionStatus, NetworkProfileName, NetworkProfileArn, Feature, and FailureCode.

    
    
• On success, responds with SearchDevicesOutput with field(s):
  • devices(Option<Vec::<DeviceData>>):

    The devices that meet the specified set of filter criteria, in sort order.

  • next_token(Option<String>):

    The token returned to indicate that there is more data available.

  • total_count(Option<i32>):

    The total number of devices returned.

• On failure, responds with SdkError<SearchDevicesError>

impl Client

pub fn search_network_profiles(&self) -> SearchNetworkProfilesFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

Constructs a fluent builder for the SearchNetworkProfiles 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
    

    An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

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

    The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

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

    The filters to use to list a specified set of network profiles. Valid filters are NetworkProfileName, Ssid, and SecurityType.

    
    
  • sort_criteria(Sort) / set_sort_criteria(Option<Vec::<Sort>>):
    required: false
    

    The sort order to use to list the specified set of network profiles. Valid sort criteria includes NetworkProfileName, Ssid, and SecurityType.

    
    
• On success, responds with SearchNetworkProfilesOutput with field(s):
  • network_profiles(Option<Vec::<NetworkProfileData>>):

    The network profiles that meet the specified set of filter criteria, in sort order. It is a list of NetworkProfileData objects.

  • next_token(Option<String>):

    An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

  • total_count(Option<i32>):

    The total number of network profiles returned.

• On failure, responds with SdkError<SearchNetworkProfilesError>

impl Client

pub fn search_profiles(&self) -> SearchProfilesFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

Constructs a fluent builder for the SearchProfiles 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
    

    An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

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

    The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

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

    The filters to use to list a specified set of room profiles. Supported filter keys are ProfileName and Address. Required.

    
    
  • sort_criteria(Sort) / set_sort_criteria(Option<Vec::<Sort>>):
    required: false
    

    The sort order to use in listing the specified set of room profiles. Supported sort keys are ProfileName and Address.

    
    
• On success, responds with SearchProfilesOutput with field(s):
  • profiles(Option<Vec::<ProfileData>>):

    The profiles that meet the specified set of filter criteria, in sort order.

  • next_token(Option<String>):

    The token returned to indicate that there is more data available.

  • total_count(Option<i32>):

    The total number of room profiles returned.

• On failure, responds with SdkError<SearchProfilesError>

impl Client

pub fn search_rooms(&self) -> SearchRoomsFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

Constructs a fluent builder for the SearchRooms 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
    

    An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

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

    The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

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

    The filters to use to list a specified set of rooms. The supported filter keys are RoomName and ProfileName.

    
    
  • sort_criteria(Sort) / set_sort_criteria(Option<Vec::<Sort>>):
    required: false
    

    The sort order to use in listing the specified set of rooms. The supported sort keys are RoomName and ProfileName.

    
    
• On success, responds with SearchRoomsOutput with field(s):
  • rooms(Option<Vec::<RoomData>>):

    The rooms that meet the specified set of filter criteria, in sort order.

  • next_token(Option<String>):

    The token returned to indicate that there is more data available.

  • total_count(Option<i32>):

    The total number of rooms returned.

• On failure, responds with SdkError<SearchRoomsError>

impl Client

pub fn search_skill_groups(&self) -> SearchSkillGroupsFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

Constructs a fluent builder for the SearchSkillGroups 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
    

    An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults. Required.

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

    The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

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

    The filters to use to list a specified set of skill groups. The supported filter key is SkillGroupName.

    
    
  • sort_criteria(Sort) / set_sort_criteria(Option<Vec::<Sort>>):
    required: false
    

    The sort order to use in listing the specified set of skill groups. The supported sort key is SkillGroupName.

    
    
• On success, responds with SearchSkillGroupsOutput with field(s):
  • skill_groups(Option<Vec::<SkillGroupData>>):

    The skill groups that meet the filter criteria, in sort order.

  • next_token(Option<String>):

    The token returned to indicate that there is more data available.

  • total_count(Option<i32>):

    The total number of skill groups returned.

• On failure, responds with SdkError<SearchSkillGroupsError>

impl Client

pub fn search_users(&self) -> SearchUsersFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

Constructs a fluent builder for the SearchUsers 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
    

    An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults. Required.

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

    The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved. Required.

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

    The filters to use for listing a specific set of users. Required. Supported filter keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.

    
    
  • sort_criteria(Sort) / set_sort_criteria(Option<Vec::<Sort>>):
    required: false
    

    The sort order to use in listing the filtered set of users. Required. Supported sort keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.

    
    
• On success, responds with SearchUsersOutput with field(s):
  • users(Option<Vec::<UserData>>):

    The users that meet the specified set of filter criteria, in sort order.

  • next_token(Option<String>):

    The token returned to indicate that there is more data available.

  • total_count(Option<i32>):

    The total number of users returned.

• On failure, responds with SdkError<SearchUsersError>

impl Client

pub fn send_announcement(&self) -> SendAnnouncementFluentBuilder

Constructs a fluent builder for the SendAnnouncement operation.

• The fluent builder is configurable:
  • room_filters(Filter) / set_room_filters(Option<Vec::<Filter>>):
    required: true
    

    The filters to use to send an announcement to a specified list of rooms. The supported filter keys are RoomName, ProfileName, RoomArn, and ProfileArn. To send to all rooms, specify an empty RoomFilters list.

    
    
  • content(Content) / set_content(Option<Content>):
    required: true
    

    The announcement content. This can contain only one of the three possible announcement types (text, SSML or audio).

    
    
  • time_to_live_in_seconds(i32) / set_time_to_live_in_seconds(Option<i32>):
    required: false
    

    The time to live for an announcement. Default is 300. If delivery doesn’t occur within this time, the announcement is not delivered.

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

    The unique, user-specified identifier for the request that ensures idempotency.

    
    
• On success, responds with SendAnnouncementOutput with field(s):
  • announcement_arn(Option<String>):

    The identifier of the announcement.

• On failure, responds with SdkError<SendAnnouncementError>

impl Client

pub fn send_invitation(&self) -> SendInvitationFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

Constructs a fluent builder for the SendInvitation operation.

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

    The ARN of the user to whom to send an invitation. Required.

    
    
• On success, responds with SendInvitationOutput
• On failure, responds with SdkError<SendInvitationError>

impl Client

pub fn start_device_sync(&self) -> StartDeviceSyncFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

Constructs a fluent builder for the StartDeviceSync operation.

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

    The ARN of the room with which the device to sync is associated. Required.

    
    
  • device_arn(impl Into<String>) / set_device_arn(Option<String>):
    required: false
    

    The ARN of the device to sync. Required.

    
    
  • features(Feature) / set_features(Option<Vec::<Feature>>):
    required: true
    

    Request structure to start the device sync. Required.

    
    
• On success, responds with StartDeviceSyncOutput
• On failure, responds with SdkError<StartDeviceSyncError>

impl Client

pub fn start_smart_home_appliance_discovery( &self ) -> StartSmartHomeApplianceDiscoveryFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

Constructs a fluent builder for the StartSmartHomeApplianceDiscovery operation.

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

    The room where smart home appliance discovery was initiated.

    
    
• On success, responds with StartSmartHomeApplianceDiscoveryOutput
• On failure, responds with SdkError<StartSmartHomeApplianceDiscoveryError>

impl Client

pub fn tag_resource(&self) -> TagResourceFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

Constructs a fluent builder for the TagResource operation.

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

    The ARN of the resource to which to add metadata tags. Required.

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

    The tags to be added to the specified resource. Do not provide system tags. Required.

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

impl Client

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

Constructs a fluent builder for the UntagResource operation.

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

    The ARN of the resource from which to remove metadata tags. Required.

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

    The tags to be removed from the specified resource. Do not provide system tags. Required.

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

impl Client

pub fn update_address_book(&self) -> UpdateAddressBookFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

Constructs a fluent builder for the UpdateAddressBook operation.

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

    The ARN of the room to update.

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

    The updated name of the room.

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

    The updated description of the room.

    
    
• On success, responds with UpdateAddressBookOutput
• On failure, responds with SdkError<UpdateAddressBookError>

impl Client

pub fn update_business_report_schedule( &self ) -> UpdateBusinessReportScheduleFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

Constructs a fluent builder for the UpdateBusinessReportSchedule operation.

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

    The ARN of the business report schedule.

    
    
  • s3_bucket_name(impl Into<String>) / set_s3_bucket_name(Option<String>):
    required: false
    

    The S3 location of the output reports.

    
    
  • s3_key_prefix(impl Into<String>) / set_s3_key_prefix(Option<String>):
    required: false
    

    The S3 key where the report is delivered.

    
    
  • format(BusinessReportFormat) / set_format(Option<BusinessReportFormat>):
    required: false
    

    The format of the generated report (individual CSV files or zipped files of individual files).

    
    
  • schedule_name(impl Into<String>) / set_schedule_name(Option<String>):
    required: false
    

    The name identifier of the schedule.

    
    
  • recurrence(BusinessReportRecurrence) / set_recurrence(Option<BusinessReportRecurrence>):
    required: false
    

    The recurrence of the reports.

    
    
• On success, responds with UpdateBusinessReportScheduleOutput
• On failure, responds with SdkError<UpdateBusinessReportScheduleError>

impl Client

pub fn update_conference_provider( &self ) -> UpdateConferenceProviderFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

Constructs a fluent builder for the UpdateConferenceProvider operation.

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

    The ARN of the conference provider.

    
    
  • conference_provider_type(ConferenceProviderType) / set_conference_provider_type(Option<ConferenceProviderType>):
    required: true
    

    The type of the conference provider.

    
    
  • ip_dial_in(IpDialIn) / set_ip_dial_in(Option<IpDialIn>):
    required: false
    

    The IP endpoint and protocol for calling.

    
    
  • pstn_dial_in(PstnDialIn) / set_pstn_dial_in(Option<PstnDialIn>):
    required: false
    

    The information for PSTN conferencing.

    
    
  • meeting_setting(MeetingSetting) / set_meeting_setting(Option<MeetingSetting>):
    required: true
    

    The meeting settings for the conference provider.

    
    
• On success, responds with UpdateConferenceProviderOutput
• On failure, responds with SdkError<UpdateConferenceProviderError>

impl Client

pub fn update_contact(&self) -> UpdateContactFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

Constructs a fluent builder for the UpdateContact operation.

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

    The ARN of the contact to update.

    
    
  • display_name(impl Into<String>) / set_display_name(Option<String>):
    required: false
    

    The updated display name of the contact.

    
    
  • first_name(impl Into<String>) / set_first_name(Option<String>):
    required: false
    

    The updated first name of the contact.

    
    
  • last_name(impl Into<String>) / set_last_name(Option<String>):
    required: false
    

    The updated last name of the contact.

    
    
  • phone_number(impl Into<String>) / set_phone_number(Option<String>):
    required: false
    

    The updated phone number of the contact. The phone number type defaults to WORK. You can either specify PhoneNumber or PhoneNumbers. We recommend that you use PhoneNumbers, which lets you specify the phone number type and multiple numbers.

    
    
  • phone_numbers(PhoneNumber) / set_phone_numbers(Option<Vec::<PhoneNumber>>):
    required: false
    

    The list of phone numbers for the contact.

    
    
  • sip_addresses(SipAddress) / set_sip_addresses(Option<Vec::<SipAddress>>):
    required: false
    

    The list of SIP addresses for the contact.

    
    
• On success, responds with UpdateContactOutput
• On failure, responds with SdkError<UpdateContactError>

impl Client

pub fn update_device(&self) -> UpdateDeviceFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

Constructs a fluent builder for the UpdateDevice operation.

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

    The ARN of the device to update. Required.

    
    
  • device_name(impl Into<String>) / set_device_name(Option<String>):
    required: false
    

    The updated device name. Required.

    
    
• On success, responds with UpdateDeviceOutput
• On failure, responds with SdkError<UpdateDeviceError>

impl Client

pub fn update_gateway(&self) -> UpdateGatewayFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

Constructs a fluent builder for the UpdateGateway operation.

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

    The ARN of the gateway to update.

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

    The updated name of the gateway.

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

    The updated description of the gateway.

    
    
  • software_version(impl Into<String>) / set_software_version(Option<String>):
    required: false
    

    The updated software version of the gateway. The gateway automatically updates its software version during normal operation.

    
    
• On success, responds with UpdateGatewayOutput
• On failure, responds with SdkError<UpdateGatewayError>

impl Client

pub fn update_gateway_group(&self) -> UpdateGatewayGroupFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

Constructs a fluent builder for the UpdateGatewayGroup operation.

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

    The ARN of the gateway group to update.

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

    The updated name of the gateway group.

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

    The updated description of the gateway group.

    
    
• On success, responds with UpdateGatewayGroupOutput
• On failure, responds with SdkError<UpdateGatewayGroupError>

impl Client

pub fn update_network_profile(&self) -> UpdateNetworkProfileFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

Constructs a fluent builder for the UpdateNetworkProfile operation.

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

    The ARN of the network profile associated with a device.

    
    
  • network_profile_name(impl Into<String>) / set_network_profile_name(Option<String>):
    required: false
    

    The name of the network profile associated with a device.

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

    Detailed information about a device’s network profile.

    
    
  • current_password(impl Into<String>) / set_current_password(Option<String>):
    required: false
    

    The current password of the Wi-Fi network.

    
    
  • next_password(impl Into<String>) / set_next_password(Option<String>):
    required: false
    

    The next, or subsequent, password of the Wi-Fi network. This password is asynchronously transmitted to the device and is used when the password of the network changes to NextPassword.

    
    
  • certificate_authority_arn(impl Into<String>) / set_certificate_authority_arn(Option<String>):
    required: false
    

    The ARN of the Private Certificate Authority (PCA) created in AWS Certificate Manager (ACM). This is used to issue certificates to the devices.

    
    
  • trust_anchors(impl Into<String>) / set_trust_anchors(Option<Vec::<String>>):
    required: false
    

    The root certificate(s) of your authentication server that will be installed on your devices and used to trust your authentication server during EAP negotiation.

    
    
• On success, responds with UpdateNetworkProfileOutput
• On failure, responds with SdkError<UpdateNetworkProfileError>

impl Client

pub fn update_profile(&self) -> UpdateProfileFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

Constructs a fluent builder for the UpdateProfile operation.

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

    The ARN of the room profile to update. Required.

    
    
  • profile_name(impl Into<String>) / set_profile_name(Option<String>):
    required: false
    

    The updated name for the room profile.

    
    
  • is_default(bool) / set_is_default(Option<bool>):
    required: false
    

    Sets the profile as default if selected. If this is missing, no update is done to the default status.

    
    
  • timezone(impl Into<String>) / set_timezone(Option<String>):
    required: false
    

    The updated timezone for the room profile.

    
    
  • address(impl Into<String>) / set_address(Option<String>):
    required: false
    

    The updated address for the room profile.

    
    
  • distance_unit(DistanceUnit) / set_distance_unit(Option<DistanceUnit>):
    required: false
    

    The updated distance unit for the room profile.

    
    
  • temperature_unit(TemperatureUnit) / set_temperature_unit(Option<TemperatureUnit>):
    required: false
    

    The updated temperature unit for the room profile.

    
    
  • wake_word(WakeWord) / set_wake_word(Option<WakeWord>):
    required: false
    

    The updated wake word for the room profile.

    
    
  • locale(impl Into<String>) / set_locale(Option<String>):
    required: false
    

    The updated locale for the room profile. (This is currently only available to a limited preview audience.)

    
    
  • setup_mode_disabled(bool) / set_setup_mode_disabled(Option<bool>):
    required: false
    

    Whether the setup mode of the profile is enabled.

    
    
  • max_volume_limit(i32) / set_max_volume_limit(Option<i32>):
    required: false
    

    The updated maximum volume limit for the room profile.

    
    
  • pstn_enabled(bool) / set_pstn_enabled(Option<bool>):
    required: false
    

    Whether the PSTN setting of the room profile is enabled.

    
    
  • data_retention_opt_in(bool) / set_data_retention_opt_in(Option<bool>):
    required: false
    

    Whether data retention of the profile is enabled.

    
    
  • meeting_room_configuration(UpdateMeetingRoomConfiguration) / set_meeting_room_configuration(Option<UpdateMeetingRoomConfiguration>):
    required: false
    

    The updated meeting room settings of a room profile.

    
    
• On success, responds with UpdateProfileOutput
• On failure, responds with SdkError<UpdateProfileError>

impl Client

pub fn update_room(&self) -> UpdateRoomFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

Constructs a fluent builder for the UpdateRoom operation.

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

    The ARN of the room to update.

    
    
  • room_name(impl Into<String>) / set_room_name(Option<String>):
    required: false
    

    The updated name for the room.

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

    The updated description for the room.

    
    
  • provider_calendar_id(impl Into<String>) / set_provider_calendar_id(Option<String>):
    required: false
    

    The updated provider calendar ARN for the room.

    
    
  • profile_arn(impl Into<String>) / set_profile_arn(Option<String>):
    required: false
    

    The updated profile ARN for the room.

    
    
• On success, responds with UpdateRoomOutput
• On failure, responds with SdkError<UpdateRoomError>

impl Client

pub fn update_skill_group(&self) -> UpdateSkillGroupFluentBuilder

👎Deprecated: Alexa For Business is no longer supported

Constructs a fluent builder for the UpdateSkillGroup operation.

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

    The ARN of the skill group to update.

    
    
  • skill_group_name(impl Into<String>) / set_skill_group_name(Option<String>):
    required: false
    

    The updated name for the skill group.

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

    The updated description for the skill group.

    
    
• On success, responds with UpdateSkillGroupOutput
• On failure, responds with SdkError<UpdateSkillGroupError>

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.