Struct Client

pub struct Client { /* private fields */ }

Client for Amazon Chime

Client for invoking operations on Amazon Chime. Each operation on Amazon Chime 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_chime::Client::new(&config);

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

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_chime::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 AssociatePhoneNumberWithUser operation has a Client::associate_phone_number_with_user, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.associate_phone_number_with_user()
    .account_id("example")
    .send()
    .await;

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

Implementations

impl Client

pub fn associate_phone_number_with_user( &self, ) -> AssociatePhoneNumberWithUserFluentBuilder

Constructs a fluent builder for the AssociatePhoneNumberWithUser operation.

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

    The Amazon Chime account ID.

    
    
  • user_id(impl Into<String>) / set_user_id(Option<String>):
    required: true
    

    The user ID.

    
    
  • e164_phone_number(impl Into<String>) / set_e164_phone_number(Option<String>):
    required: true
    

    The phone number, in E.164 format.

    
    
• On success, responds with AssociatePhoneNumberWithUserOutput
• On failure, responds with SdkError<AssociatePhoneNumberWithUserError>

impl Client

pub fn associate_signin_delegate_groups_with_account( &self, ) -> AssociateSigninDelegateGroupsWithAccountFluentBuilder

Constructs a fluent builder for the AssociateSigninDelegateGroupsWithAccount operation.

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

    The Amazon Chime account ID.

    
    
  • signin_delegate_groups(SigninDelegateGroup) / set_signin_delegate_groups(Option<Vec::<SigninDelegateGroup>>):
    required: true
    

    The sign-in delegate groups.

    
    
• On success, responds with AssociateSigninDelegateGroupsWithAccountOutput
• On failure, responds with SdkError<AssociateSigninDelegateGroupsWithAccountError>

impl Client

pub fn batch_create_room_membership( &self, ) -> BatchCreateRoomMembershipFluentBuilder

Constructs a fluent builder for the BatchCreateRoomMembership operation.

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

    The Amazon Chime account ID.

    
    
  • room_id(impl Into<String>) / set_room_id(Option<String>):
    required: true
    

    The room ID.

    
    
  • membership_item_list(MembershipItem) / set_membership_item_list(Option<Vec::<MembershipItem>>):
    required: true
    

    The list of membership items.

    
    
• On success, responds with BatchCreateRoomMembershipOutput with field(s):
  • errors(Option<Vec::<MemberError>>):

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

• On failure, responds with SdkError<BatchCreateRoomMembershipError>

impl Client

pub fn batch_delete_phone_number(&self) -> BatchDeletePhoneNumberFluentBuilder

Constructs a fluent builder for the BatchDeletePhoneNumber operation.

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

    List of phone number IDs.

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

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

• On failure, responds with SdkError<BatchDeletePhoneNumberError>

impl Client

pub fn batch_suspend_user(&self) -> BatchSuspendUserFluentBuilder

Constructs a fluent builder for the BatchSuspendUser operation.

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

    The Amazon Chime account ID.

    
    
  • user_id_list(impl Into<String>) / set_user_id_list(Option<Vec::<String>>):
    required: true
    

    The request containing the user IDs to suspend.

    
    
• On success, responds with BatchSuspendUserOutput with field(s):
  • user_errors(Option<Vec::<UserError>>):

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

• On failure, responds with SdkError<BatchSuspendUserError>

impl Client

pub fn batch_unsuspend_user(&self) -> BatchUnsuspendUserFluentBuilder

Constructs a fluent builder for the BatchUnsuspendUser operation.

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

    The Amazon Chime account ID.

    
    
  • user_id_list(impl Into<String>) / set_user_id_list(Option<Vec::<String>>):
    required: true
    

    The request containing the user IDs to unsuspend.

    
    
• On success, responds with BatchUnsuspendUserOutput with field(s):
  • user_errors(Option<Vec::<UserError>>):

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

• On failure, responds with SdkError<BatchUnsuspendUserError>

impl Client

pub fn batch_update_phone_number(&self) -> BatchUpdatePhoneNumberFluentBuilder

Constructs a fluent builder for the BatchUpdatePhoneNumber operation.

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

    The request containing the phone number IDs and product types or calling names to update.

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

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

• On failure, responds with SdkError<BatchUpdatePhoneNumberError>

impl Client

pub fn batch_update_user(&self) -> BatchUpdateUserFluentBuilder

Constructs a fluent builder for the BatchUpdateUser operation.

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

    The Amazon Chime account ID.

    
    
  • update_user_request_items(UpdateUserRequestItem) / set_update_user_request_items(Option<Vec::<UpdateUserRequestItem>>):
    required: true
    

    The request containing the user IDs and details to update.

    
    
• On success, responds with BatchUpdateUserOutput with field(s):
  • user_errors(Option<Vec::<UserError>>):

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

• On failure, responds with SdkError<BatchUpdateUserError>

impl Client

pub fn create_account(&self) -> CreateAccountFluentBuilder

Constructs a fluent builder for the CreateAccount operation.

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

    The name of the Amazon Chime account.

    
    
• On success, responds with CreateAccountOutput with field(s):
  • account(Option<Account>):

    The Amazon Chime account details.

• On failure, responds with SdkError<CreateAccountError>

impl Client

pub fn create_bot(&self) -> CreateBotFluentBuilder

Constructs a fluent builder for the CreateBot operation.

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

    The Amazon Chime account ID.

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

    The bot display name.

    
    
  • domain(impl Into<String>) / set_domain(Option<String>):
    required: false
    

    The domain of the Amazon Chime Enterprise account.

    
    
• On success, responds with CreateBotOutput with field(s):
  • bot(Option<Bot>):

    The bot details.

• On failure, responds with SdkError<CreateBotError>

impl Client

pub fn create_meeting_dial_out(&self) -> CreateMeetingDialOutFluentBuilder

Constructs a fluent builder for the CreateMeetingDialOut operation.

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

    The Amazon Chime SDK meeting ID.

    
    
  • from_phone_number(impl Into<String>) / set_from_phone_number(Option<String>):
    required: true
    

    Phone number used as the caller ID when the remote party receives a call.

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

    Phone number called when inviting someone to a meeting.

    
    
  • join_token(impl Into<String>) / set_join_token(Option<String>):
    required: true
    

    Token used by the Amazon Chime SDK attendee. Call the CreateAttendee action to get a join token.

    
    
• On success, responds with CreateMeetingDialOutOutput with field(s):
  • transaction_id(Option<String>):

    Unique ID that tracks API calls.

• On failure, responds with SdkError<CreateMeetingDialOutError>

impl Client

pub fn create_phone_number_order(&self) -> CreatePhoneNumberOrderFluentBuilder

Constructs a fluent builder for the CreatePhoneNumberOrder operation.

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

    The phone number product type.

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

    List of phone numbers, in E.164 format.

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

    The phone number order details.

• On failure, responds with SdkError<CreatePhoneNumberOrderError>

impl Client

pub fn create_room(&self) -> CreateRoomFluentBuilder

Constructs a fluent builder for the CreateRoom operation.

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

    The Amazon Chime account ID.

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

    The room name.

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

    The idempotency token for the request.

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

    The room details.

• On failure, responds with SdkError<CreateRoomError>

impl Client

pub fn create_room_membership(&self) -> CreateRoomMembershipFluentBuilder

Constructs a fluent builder for the CreateRoomMembership operation.

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

    The Amazon Chime account ID.

    
    
  • room_id(impl Into<String>) / set_room_id(Option<String>):
    required: true
    

    The room ID.

    
    
  • member_id(impl Into<String>) / set_member_id(Option<String>):
    required: true
    

    The Amazon Chime member ID (user ID or bot ID).

    
    
  • role(RoomMembershipRole) / set_role(Option<RoomMembershipRole>):
    required: false
    

    The role of the member.

    
    
• On success, responds with CreateRoomMembershipOutput with field(s):
  • room_membership(Option<RoomMembership>):

    The room membership details.

• On failure, responds with SdkError<CreateRoomMembershipError>

impl Client

pub fn create_user(&self) -> CreateUserFluentBuilder

Constructs a fluent builder for the CreateUser operation.

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

    The Amazon Chime account ID.

    
    
  • username(impl Into<String>) / set_username(Option<String>):
    required: false
    

    The user name.

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

    The user’s email address.

    
    
  • user_type(UserType) / set_user_type(Option<UserType>):
    required: false
    

    The user type.

    
    
• On success, responds with CreateUserOutput with field(s):
  • user(Option<User>):

    The user on the Amazon Chime account.

• On failure, responds with SdkError<CreateUserError>

impl Client

pub fn delete_account(&self) -> DeleteAccountFluentBuilder

Constructs a fluent builder for the DeleteAccount operation.

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

    The Amazon Chime account ID.

    
    
• On success, responds with DeleteAccountOutput
• On failure, responds with SdkError<DeleteAccountError>

impl Client

pub fn delete_events_configuration( &self, ) -> DeleteEventsConfigurationFluentBuilder

Constructs a fluent builder for the DeleteEventsConfiguration operation.

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

    The Amazon Chime account ID.

    
    
  • bot_id(impl Into<String>) / set_bot_id(Option<String>):
    required: true
    

    The bot ID.

    
    
• On success, responds with DeleteEventsConfigurationOutput
• On failure, responds with SdkError<DeleteEventsConfigurationError>

impl Client

pub fn delete_phone_number(&self) -> DeletePhoneNumberFluentBuilder

Constructs a fluent builder for the DeletePhoneNumber operation.

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

    The phone number ID.

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

impl Client

pub fn delete_room(&self) -> DeleteRoomFluentBuilder

Constructs a fluent builder for the DeleteRoom operation.

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

    The Amazon Chime account ID.

    
    
  • room_id(impl Into<String>) / set_room_id(Option<String>):
    required: true
    

    The chat room ID.

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

impl Client

pub fn delete_room_membership(&self) -> DeleteRoomMembershipFluentBuilder

Constructs a fluent builder for the DeleteRoomMembership operation.

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

    The Amazon Chime account ID.

    
    
  • room_id(impl Into<String>) / set_room_id(Option<String>):
    required: true
    

    The room ID.

    
    
  • member_id(impl Into<String>) / set_member_id(Option<String>):
    required: true
    

    The member ID (user ID or bot ID).

    
    
• On success, responds with DeleteRoomMembershipOutput
• On failure, responds with SdkError<DeleteRoomMembershipError>

impl Client

pub fn disassociate_phone_number_from_user( &self, ) -> DisassociatePhoneNumberFromUserFluentBuilder

Constructs a fluent builder for the DisassociatePhoneNumberFromUser operation.

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

    The Amazon Chime account ID.

    
    
  • user_id(impl Into<String>) / set_user_id(Option<String>):
    required: true
    

    The user ID.

    
    
• On success, responds with DisassociatePhoneNumberFromUserOutput
• On failure, responds with SdkError<DisassociatePhoneNumberFromUserError>

impl Client

pub fn disassociate_signin_delegate_groups_from_account( &self, ) -> DisassociateSigninDelegateGroupsFromAccountFluentBuilder

Constructs a fluent builder for the DisassociateSigninDelegateGroupsFromAccount operation.

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

    The Amazon Chime account ID.

    
    
  • group_names(impl Into<String>) / set_group_names(Option<Vec::<String>>):
    required: true
    

    The sign-in delegate group names.

    
    
• On success, responds with DisassociateSigninDelegateGroupsFromAccountOutput
• On failure, responds with SdkError<DisassociateSigninDelegateGroupsFromAccountError>

impl Client

pub fn get_account(&self) -> GetAccountFluentBuilder

Constructs a fluent builder for the GetAccount operation.

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

    The Amazon Chime account ID.

    
    
• On success, responds with GetAccountOutput with field(s):
  • account(Option<Account>):

    The Amazon Chime account details.

• On failure, responds with SdkError<GetAccountError>

impl Client

pub fn get_account_settings(&self) -> GetAccountSettingsFluentBuilder

Constructs a fluent builder for the GetAccountSettings operation.

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

    The Amazon Chime account ID.

    
    
• On success, responds with GetAccountSettingsOutput with field(s):
  • account_settings(Option<AccountSettings>):

    The Amazon Chime account settings.

• On failure, responds with SdkError<GetAccountSettingsError>

impl Client

pub fn get_bot(&self) -> GetBotFluentBuilder

Constructs a fluent builder for the GetBot operation.

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

    The Amazon Chime account ID.

    
    
  • bot_id(impl Into<String>) / set_bot_id(Option<String>):
    required: true
    

    The bot ID.

    
    
• On success, responds with GetBotOutput with field(s):
  • bot(Option<Bot>):

    The chat bot details.

• On failure, responds with SdkError<GetBotError>

impl Client

pub fn get_events_configuration(&self) -> GetEventsConfigurationFluentBuilder

Constructs a fluent builder for the GetEventsConfiguration operation.

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

    The Amazon Chime account ID.

    
    
  • bot_id(impl Into<String>) / set_bot_id(Option<String>):
    required: true
    

    The bot ID.

    
    
• On success, responds with GetEventsConfigurationOutput with field(s):
  • events_configuration(Option<EventsConfiguration>):

    The events configuration details.

• On failure, responds with SdkError<GetEventsConfigurationError>

impl Client

pub fn get_global_settings(&self) -> GetGlobalSettingsFluentBuilder

Constructs a fluent builder for the GetGlobalSettings operation.

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

    The Amazon Chime Business Calling settings.

  • voice_connector(Option<VoiceConnectorSettings>):

    The Amazon Chime Voice Connector settings.

• On failure, responds with SdkError<GetGlobalSettingsError>

impl Client

pub fn get_phone_number(&self) -> GetPhoneNumberFluentBuilder

Constructs a fluent builder for the GetPhoneNumber operation.

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

    The phone number ID.

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

    The phone number details.

• On failure, responds with SdkError<GetPhoneNumberError>

impl Client

pub fn get_phone_number_order(&self) -> GetPhoneNumberOrderFluentBuilder

Constructs a fluent builder for the GetPhoneNumberOrder operation.

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

    The ID for the phone number order.

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

    The phone number order details.

• On failure, responds with SdkError<GetPhoneNumberOrderError>

impl Client

pub fn get_phone_number_settings(&self) -> GetPhoneNumberSettingsFluentBuilder

Constructs a fluent builder for the GetPhoneNumberSettings operation.

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

    The default outbound calling name for the account.

  • calling_name_updated_timestamp(Option<DateTime>):

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

• On failure, responds with SdkError<GetPhoneNumberSettingsError>

impl Client

pub fn get_retention_settings(&self) -> GetRetentionSettingsFluentBuilder

Constructs a fluent builder for the GetRetentionSettings operation.

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

    The Amazon Chime account ID.

    
    
• On success, responds with GetRetentionSettingsOutput with field(s):
  • retention_settings(Option<RetentionSettings>):

    The retention settings.

  • initiate_deletion_timestamp(Option<DateTime>):

    The timestamp representing the time at which the specified items are permanently deleted, in ISO 8601 format.

• On failure, responds with SdkError<GetRetentionSettingsError>

impl Client

pub fn get_room(&self) -> GetRoomFluentBuilder

Constructs a fluent builder for the GetRoom operation.

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

    The Amazon Chime account ID.

    
    
  • room_id(impl Into<String>) / set_room_id(Option<String>):
    required: true
    

    The room ID.

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

    The room details.

• On failure, responds with SdkError<GetRoomError>

impl Client

pub fn get_user(&self) -> GetUserFluentBuilder

Constructs a fluent builder for the GetUser operation.

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

    The Amazon Chime account ID.

    
    
  • user_id(impl Into<String>) / set_user_id(Option<String>):
    required: true
    

    The user ID.

    
    
• On success, responds with GetUserOutput with field(s):
  • user(Option<User>):

    The user details.

• On failure, responds with SdkError<GetUserError>

impl Client

pub fn get_user_settings(&self) -> GetUserSettingsFluentBuilder

Constructs a fluent builder for the GetUserSettings operation.

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

    The Amazon Chime account ID.

    
    
  • user_id(impl Into<String>) / set_user_id(Option<String>):
    required: true
    

    The user ID.

    
    
• On success, responds with GetUserSettingsOutput with field(s):
  • user_settings(Option<UserSettings>):

    The user settings.

• On failure, responds with SdkError<GetUserSettingsError>

impl Client

pub fn invite_users(&self) -> InviteUsersFluentBuilder

Constructs a fluent builder for the InviteUsers operation.

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

    The Amazon Chime account ID.

    
    
  • user_email_list(impl Into<String>) / set_user_email_list(Option<Vec::<String>>):
    required: true
    

    The user email addresses to which to send the email invitation.

    
    
  • user_type(UserType) / set_user_type(Option<UserType>):
    required: false
    

    The user type.

    
    
• On success, responds with InviteUsersOutput with field(s):
  • invites(Option<Vec::<Invite>>):

    The email invitation details.

• On failure, responds with SdkError<InviteUsersError>

impl Client

pub fn list_accounts(&self) -> ListAccountsFluentBuilder

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

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

    Amazon Chime account name prefix with which to filter results.

    
    
  • user_email(impl Into<String>) / set_user_email(Option<String>):
    required: false
    

    User email address with which to filter results.

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

    The token to use to retrieve the next page of results.

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

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

    
    
• On success, responds with ListAccountsOutput with field(s):
  • accounts(Option<Vec::<Account>>):

    List of Amazon Chime accounts and account details.

  • next_token(Option<String>):

    The token to use to retrieve the next page of results.

• On failure, responds with SdkError<ListAccountsError>

impl Client

pub fn list_bots(&self) -> ListBotsFluentBuilder

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

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

    The Amazon Chime account ID.

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

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

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

    The token to use to retrieve the next page of results.

    
    
• On success, responds with ListBotsOutput with field(s):
  • bots(Option<Vec::<Bot>>):

    List of bots and bot details.

  • next_token(Option<String>):

    The token to use to retrieve the next page of results.

• On failure, responds with SdkError<ListBotsError>

impl Client

pub fn list_phone_number_orders(&self) -> ListPhoneNumberOrdersFluentBuilder

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

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

    The token to use to retrieve the next page of results.

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

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

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

    The phone number order details.

  • next_token(Option<String>):

    The token to use to retrieve the next page of results.

• On failure, responds with SdkError<ListPhoneNumberOrdersError>

impl Client

pub fn list_phone_numbers(&self) -> ListPhoneNumbersFluentBuilder

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

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

    The phone number status.

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

    The phone number product type.

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

    The filter to use to limit the number of results.

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

    The value to use for the filter.

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

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

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

    The token to use to retrieve the next page of results.

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

    The phone number details.

  • next_token(Option<String>):

    The token to use to retrieve the next page of results.

• On failure, responds with SdkError<ListPhoneNumbersError>

impl Client

pub fn list_room_memberships(&self) -> ListRoomMembershipsFluentBuilder

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

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

    The Amazon Chime account ID.

    
    
  • room_id(impl Into<String>) / set_room_id(Option<String>):
    required: true
    

    The room ID.

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

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

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

    The token to use to retrieve the next page of results.

    
    
• On success, responds with ListRoomMembershipsOutput with field(s):
  • room_memberships(Option<Vec::<RoomMembership>>):

    The room membership details.

  • next_token(Option<String>):

    The token to use to retrieve the next page of results.

• On failure, responds with SdkError<ListRoomMembershipsError>

impl Client

pub fn list_rooms(&self) -> ListRoomsFluentBuilder

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

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

    The Amazon Chime account ID.

    
    
  • member_id(impl Into<String>) / set_member_id(Option<String>):
    required: false
    

    The member ID (user ID or bot ID).

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

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

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

    The token to use to retrieve the next page of results.

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

    The room details.

  • next_token(Option<String>):

    The token to use to retrieve the next page of results.

• On failure, responds with SdkError<ListRoomsError>

impl Client

pub fn list_supported_phone_number_countries( &self, ) -> ListSupportedPhoneNumberCountriesFluentBuilder

Constructs a fluent builder for the ListSupportedPhoneNumberCountries operation.

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

    The phone number product type.

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

    The supported phone number countries.

• On failure, responds with SdkError<ListSupportedPhoneNumberCountriesError>

impl Client

pub fn list_users(&self) -> ListUsersFluentBuilder

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

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

    The Amazon Chime account ID.

    
    
  • user_email(impl Into<String>) / set_user_email(Option<String>):
    required: false
    

    Optional. The user email address used to filter results. Maximum 1.

    
    
  • user_type(UserType) / set_user_type(Option<UserType>):
    required: false
    

    The user type.

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

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

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

    The token to use to retrieve the next page of results.

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

    List of users and user details.

  • next_token(Option<String>):

    The token to use to retrieve the next page of results.

• On failure, responds with SdkError<ListUsersError>

impl Client

pub fn logout_user(&self) -> LogoutUserFluentBuilder

Constructs a fluent builder for the LogoutUser operation.

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

    The Amazon Chime account ID.

    
    
  • user_id(impl Into<String>) / set_user_id(Option<String>):
    required: true
    

    The user ID.

    
    
• On success, responds with LogoutUserOutput
• On failure, responds with SdkError<LogoutUserError>

impl Client

pub fn put_events_configuration(&self) -> PutEventsConfigurationFluentBuilder

Constructs a fluent builder for the PutEventsConfiguration operation.

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

    The Amazon Chime account ID.

    
    
  • bot_id(impl Into<String>) / set_bot_id(Option<String>):
    required: true
    

    The bot ID.

    
    
  • outbound_events_https_endpoint(impl Into<String>) / set_outbound_events_https_endpoint(Option<String>):
    required: false
    

    HTTPS endpoint that allows the bot to receive outgoing events.

    
    
  • lambda_function_arn(impl Into<String>) / set_lambda_function_arn(Option<String>):
    required: false
    

    Lambda function ARN that allows the bot to receive outgoing events.

    
    
• On success, responds with PutEventsConfigurationOutput with field(s):
  • events_configuration(Option<EventsConfiguration>):

    The configuration that allows a bot to receive outgoing events. Can be an HTTPS endpoint or an AWS Lambda function ARN.

• On failure, responds with SdkError<PutEventsConfigurationError>

impl Client

pub fn put_retention_settings(&self) -> PutRetentionSettingsFluentBuilder

Constructs a fluent builder for the PutRetentionSettings operation.

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

    The Amazon Chime account ID.

    
    
  • retention_settings(RetentionSettings) / set_retention_settings(Option<RetentionSettings>):
    required: true
    

    The retention settings.

    
    
• On success, responds with PutRetentionSettingsOutput with field(s):
  • retention_settings(Option<RetentionSettings>):

    The retention settings.

  • initiate_deletion_timestamp(Option<DateTime>):

    The timestamp representing the time at which the specified items are permanently deleted, in ISO 8601 format.

• On failure, responds with SdkError<PutRetentionSettingsError>

impl Client

pub fn redact_conversation_message( &self, ) -> RedactConversationMessageFluentBuilder

Constructs a fluent builder for the RedactConversationMessage operation.

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

    The Amazon Chime account ID.

    
    
  • conversation_id(impl Into<String>) / set_conversation_id(Option<String>):
    required: true
    

    The conversation ID.

    
    
  • message_id(impl Into<String>) / set_message_id(Option<String>):
    required: true
    

    The message ID.

    
    
• On success, responds with RedactConversationMessageOutput
• On failure, responds with SdkError<RedactConversationMessageError>

impl Client

pub fn redact_room_message(&self) -> RedactRoomMessageFluentBuilder

Constructs a fluent builder for the RedactRoomMessage operation.

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

    The Amazon Chime account ID.

    
    
  • room_id(impl Into<String>) / set_room_id(Option<String>):
    required: true
    

    The room ID.

    
    
  • message_id(impl Into<String>) / set_message_id(Option<String>):
    required: true
    

    The message ID.

    
    
• On success, responds with RedactRoomMessageOutput
• On failure, responds with SdkError<RedactRoomMessageError>

impl Client

pub fn regenerate_security_token(&self) -> RegenerateSecurityTokenFluentBuilder

Constructs a fluent builder for the RegenerateSecurityToken operation.

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

    The Amazon Chime account ID.

    
    
  • bot_id(impl Into<String>) / set_bot_id(Option<String>):
    required: true
    

    The bot ID.

    
    
• On success, responds with RegenerateSecurityTokenOutput with field(s):
  • bot(Option<Bot>):

    A resource that allows Enterprise account administrators to configure an interface that receives events from Amazon Chime.

• On failure, responds with SdkError<RegenerateSecurityTokenError>

impl Client

pub fn reset_personal_pin(&self) -> ResetPersonalPINFluentBuilder

Constructs a fluent builder for the ResetPersonalPIN operation.

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

    The Amazon Chime account ID.

    
    
  • user_id(impl Into<String>) / set_user_id(Option<String>):
    required: true
    

    The user ID.

    
    
• On success, responds with ResetPersonalPinOutput with field(s):
  • user(Option<User>):

    The user details and new personal meeting PIN.

• On failure, responds with SdkError<ResetPersonalPINError>

impl Client

pub fn restore_phone_number(&self) -> RestorePhoneNumberFluentBuilder

Constructs a fluent builder for the RestorePhoneNumber operation.

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

    The phone number.

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

    The phone number details.

• On failure, responds with SdkError<RestorePhoneNumberError>

impl Client

pub fn search_available_phone_numbers( &self, ) -> SearchAvailablePhoneNumbersFluentBuilder

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

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

    The area code used to filter results. Only applies to the US.

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

    The city used to filter results. Only applies to the US.

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

    The country used to filter results. Defaults to the US Format: ISO 3166-1 alpha-2.

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

    The state used to filter results. Required only if you provide City. Only applies to the US.

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

    The toll-free prefix that you use to filter results. Only applies to the US.

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

    The phone number type used to filter results. Required for non-US numbers.

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

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

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

    The token used to retrieve the next page of results.

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

    List of phone numbers, in E.164 format.

  • next_token(Option<String>):

    The token used to retrieve the next page of search results.

• On failure, responds with SdkError<SearchAvailablePhoneNumbersError>

impl Client

pub fn update_account(&self) -> UpdateAccountFluentBuilder

Constructs a fluent builder for the UpdateAccount operation.

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

    The Amazon Chime account ID.

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

    The new name for the specified Amazon Chime account.

    
    
  • default_license(License) / set_default_license(Option<License>):
    required: false
    

    The default license applied when you add users to an Amazon Chime account.

    
    
• On success, responds with UpdateAccountOutput with field(s):
  • account(Option<Account>):

    The updated Amazon Chime account details.

• On failure, responds with SdkError<UpdateAccountError>

impl Client

pub fn update_account_settings(&self) -> UpdateAccountSettingsFluentBuilder

Constructs a fluent builder for the UpdateAccountSettings operation.

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

    The Amazon Chime account ID.

    
    
  • account_settings(AccountSettings) / set_account_settings(Option<AccountSettings>):
    required: true
    

    The Amazon Chime account settings to update.

    
    
• On success, responds with UpdateAccountSettingsOutput
• On failure, responds with SdkError<UpdateAccountSettingsError>

impl Client

pub fn update_bot(&self) -> UpdateBotFluentBuilder

Constructs a fluent builder for the UpdateBot operation.

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

    The Amazon Chime account ID.

    
    
  • bot_id(impl Into<String>) / set_bot_id(Option<String>):
    required: true
    

    The bot ID.

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

    When true, stops the specified bot from running in your account.

    
    
• On success, responds with UpdateBotOutput with field(s):
  • bot(Option<Bot>):

    The updated bot details.

• On failure, responds with SdkError<UpdateBotError>

impl Client

pub fn update_global_settings(&self) -> UpdateGlobalSettingsFluentBuilder

Constructs a fluent builder for the UpdateGlobalSettings operation.

• The fluent builder is configurable:
  • business_calling(BusinessCallingSettings) / set_business_calling(Option<BusinessCallingSettings>):
    required: false
    

    The Amazon Chime Business Calling settings.

    
    
  • voice_connector(VoiceConnectorSettings) / set_voice_connector(Option<VoiceConnectorSettings>):
    required: false
    

    The Amazon Chime Voice Connector settings.

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

impl Client

pub fn update_phone_number(&self) -> UpdatePhoneNumberFluentBuilder

Constructs a fluent builder for the UpdatePhoneNumber operation.

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

    The phone number ID.

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

    The product type.

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

    The outbound calling name associated with the phone number.

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

    The updated phone number details.

• On failure, responds with SdkError<UpdatePhoneNumberError>

impl Client

pub fn update_phone_number_settings( &self, ) -> UpdatePhoneNumberSettingsFluentBuilder

Constructs a fluent builder for the UpdatePhoneNumberSettings operation.

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

    The default outbound calling name for the account.

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

impl Client

pub fn update_room(&self) -> UpdateRoomFluentBuilder

Constructs a fluent builder for the UpdateRoom operation.

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

    The Amazon Chime account ID.

    
    
  • room_id(impl Into<String>) / set_room_id(Option<String>):
    required: true
    

    The room ID.

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

    The room name.

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

    The room details.

• On failure, responds with SdkError<UpdateRoomError>

impl Client

pub fn update_room_membership(&self) -> UpdateRoomMembershipFluentBuilder

Constructs a fluent builder for the UpdateRoomMembership operation.

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

    The Amazon Chime account ID.

    
    
  • room_id(impl Into<String>) / set_room_id(Option<String>):
    required: true
    

    The room ID.

    
    
  • member_id(impl Into<String>) / set_member_id(Option<String>):
    required: true
    

    The member ID.

    
    
  • role(RoomMembershipRole) / set_role(Option<RoomMembershipRole>):
    required: false
    

    The role of the member.

    
    
• On success, responds with UpdateRoomMembershipOutput with field(s):
  • room_membership(Option<RoomMembership>):

    The room membership details.

• On failure, responds with SdkError<UpdateRoomMembershipError>

impl Client

pub fn update_user(&self) -> UpdateUserFluentBuilder

Constructs a fluent builder for the UpdateUser operation.

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

    The Amazon Chime account ID.

    
    
  • user_id(impl Into<String>) / set_user_id(Option<String>):
    required: true
    

    The user ID.

    
    
  • license_type(License) / set_license_type(Option<License>):
    required: false
    

    The user license type to update. This must be a supported license type for the Amazon Chime account that the user belongs to.

    
    
  • user_type(UserType) / set_user_type(Option<UserType>):
    required: false
    

    The user type.

    
    
  • alexa_for_business_metadata(AlexaForBusinessMetadata) / set_alexa_for_business_metadata(Option<AlexaForBusinessMetadata>):
    required: false
    

    The Alexa for Business metadata.

    
    
• On success, responds with UpdateUserOutput with field(s):
  • user(Option<User>):

    The updated user details.

• On failure, responds with SdkError<UpdateUserError>

impl Client

pub fn update_user_settings(&self) -> UpdateUserSettingsFluentBuilder

Constructs a fluent builder for the UpdateUserSettings operation.

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

    The Amazon Chime account ID.

    
    
  • user_id(impl Into<String>) / set_user_id(Option<String>):
    required: true
    

    The user ID.

    
    
  • user_settings(UserSettings) / set_user_settings(Option<UserSettings>):
    required: true
    

    The user settings to update.

    
    
• On success, responds with UpdateUserSettingsOutput
• On failure, responds with SdkError<UpdateUserSettingsError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

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

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

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

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

Creates a new client from an SDK Config.

Panics

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

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Client

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

Formats the value using the given formatter.