RetroSearch Browse

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://docs.aws.amazon.com/sdkforruby/api/Aws/Chime/Client.html below:

Client — AWS SDK for Ruby V2

Instance Method Details #associate_phone_number_with_user(options = {}) ⇒ Struct

Associates a phone number with the specified Amazon Chime user.

#associate_signin_delegate_groups_with_account(options = {}) ⇒ Struct

Associates the specified sign-in delegate groups with the specified Amazon Chime account.

#batch_create_room_membership(options = {}) ⇒ Types::BatchCreateRoomMembershipResponse

Adds up to 50 members to a chat room in an Amazon Chime Enterprise account. Members can be either users or bots. The member role designates whether the member is a chat room administrator or a general chat room member.

#batch_delete_phone_number(options = {}) ⇒ Types::BatchDeletePhoneNumberResponse

Moves phone numbers into the Deletion queue. Phone numbers must be disassociated from any users or Amazon Chime Voice Connectors before they can be deleted.

Phone numbers remain in the Deletion queue for 7 days before they are deleted permanently.

#batch_suspend_user(options = {}) ⇒ Types::BatchSuspendUserResponse

Suspends up to 50 users from a Team or EnterpriseLWA Amazon Chime account. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide.

Users suspended from a Team account are disassociated from the account, but they can continue to use Amazon Chime as free users. To remove the suspension from suspended Team account users, invite them to the Team account again. You can use the InviteUsers action to do so.

Users suspended from an EnterpriseLWA account are immediately signed out of Amazon Chime and can no longer sign in. To remove the suspension from suspended EnterpriseLWA account users, use the BatchUnsuspendUser action.

To sign out users without suspending them, use the LogoutUser action.

#batch_unsuspend_user(options = {}) ⇒ Types::BatchUnsuspendUserResponse

Removes the suspension from up to 50 previously suspended users for the specified Amazon Chime EnterpriseLWA account. Only users on EnterpriseLWA accounts can be unsuspended using this action. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide.

Previously suspended users who are unsuspended using this action are returned to Registered status. Users who are not previously suspended are ignored.

#batch_update_phone_number(options = {}) ⇒ Types::BatchUpdatePhoneNumberResponse

Updates phone number product types or calling names. You can update one attribute at a time for each UpdatePhoneNumberRequestItem. For example, you can update either the product type or the calling name.

For product types, choose from Amazon Chime Business Calling and Amazon Chime Voice Connector. For toll-free numbers, you must use the Amazon Chime Voice Connector product type.

Updates to outbound calling names can take up to 72 hours to complete. Pending updates to outbound calling names must be complete before you can request another update.

#create_account(options = {}) ⇒ Types::CreateAccountResponse

Creates an Amazon Chime account under the administrator's AWS account. Only Team account types are currently supported for this action. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide.

#create_app_instance(options = {}) ⇒ Types::CreateAppInstanceResponse

Creates an Amazon Chime Messaging SDK AppInstance under an AWS Account. Only Messaging SDK customers use this API. CreateAppInstance supports idempotency behavior as described in the AWS API Standard.

#create_app_instance_admin(options = {}) ⇒ Types::CreateAppInstanceAdminResponse

Promotes an AppInstanceUser to an AppInstanceAdmin. The promoted user can perform the following actions.

ChannelModerator actions across all channels in the app instance.
DeleteChannelMessage actions.

Only an AppInstanceUser can be promoted to an AppInstanceAdmin role.

#create_app_instance_user(options = {}) ⇒ Types::CreateAppInstanceUserResponse

Creates a user under an Amazon Chime AppInstance. The request consists of a unique appInstanceUserId and Name for that user.

#create_channel(options = {}) ⇒ Types::CreateChannelResponse

Creates a channel to which you can add users and send messages.

Restriction: You can't change a channel's privacy.

#create_channel_ban(options = {}) ⇒ Types::CreateChannelBanResponse

Permanently bans a member from a channel. Moderators can't add banned members to a channel. To undo a ban, you first have to DeleteChannelBan, and then CreateChannelMembership. Bans are cleaned up when you delete users or channels.

If you ban a user who is already part of a channel, that user is automatically kicked from the channel.

#create_channel_membership(options = {}) ⇒ Types::CreateChannelMembershipResponse

Adds a user to a channel. The InvitedBy response field is derived from the request header. A channel member can:

List messages
Send messages
Receive messages
Edit their own messages
Leave the channel

Privacy settings impact this action as follows:

Public Channels: You do not need to be a member to list messages, but you must be a member to send messages.
Private Channels: You must be a member to list or send messages.

#create_channel_moderator(options = {}) ⇒ Types::CreateChannelModeratorResponse

Creates a new ChannelModerator. A channel moderator can:

Add and remove other members of the channel.
Add and remove other moderators of the channel.
Add and remove user bans for the channel.
Redact messages in the channel.
List messages in the channel.

#create_meeting_dial_out(options = {}) ⇒ Types::CreateMeetingDialOutResponse

Uses the join token and call metadata in a meeting request (From number, To number, and so forth) to initiate an outbound call to a public switched telephone network (PSTN) and joins them into Chime meeting. Also ensures that the From number belongs to the customer.

To play welcome audio or implement an interactive voice response (IVR), use the CreateSipMediaApplicationCall API with the corresponding SIP media application ID.

#create_phone_number_order(options = {}) ⇒ Types::CreatePhoneNumberOrderResponse

Creates an order for phone numbers to be provisioned. Choose from Amazon Chime Business Calling and Amazon Chime Voice Connector product types. For toll-free numbers, you must use the Amazon Chime Voice Connector product type.

#create_proxy_session(options = {}) ⇒ Types::CreateProxySessionResponse

Creates a proxy session on the specified Amazon Chime Voice Connector for the specified participant phone numbers.

#create_room(options = {}) ⇒ Types::CreateRoomResponse

Creates a chat room for the specified Amazon Chime Enterprise account.

#create_room_membership(options = {}) ⇒ Types::CreateRoomMembershipResponse

Adds a member to a chat room in an Amazon Chime Enterprise account. A member can be either a user or a bot. The member role designates whether the member is a chat room administrator or a general chat room member.

#create_sip_media_application_call(options = {}) ⇒ Types::CreateSipMediaApplicationCallResponse

Creates an outbound call to a phone number from the phone number specified in the request, and it invokes the endpoint of the specified sipMediaApplicationId.

#create_sip_rule(options = {}) ⇒ Types::CreateSipRuleResponse

Creates a SIP rule which can be used to run a SIP media application as a target for a specific trigger type.

#create_voice_connector(options = {}) ⇒ Types::CreateVoiceConnectorResponse

Creates an Amazon Chime Voice Connector under the administrator's AWS account. You can choose to create an Amazon Chime Voice Connector in a specific AWS Region.

Enabling CreateVoiceConnectorRequest$RequireEncryption configures your Amazon Chime Voice Connector to use TLS transport for SIP signaling and Secure RTP (SRTP) for media. Inbound calls use TLS transport, and unencrypted outbound calls are blocked.

#create_voice_connector_group(options = {}) ⇒ Types::CreateVoiceConnectorGroupResponse

Creates an Amazon Chime Voice Connector group under the administrator's AWS account. You can associate Amazon Chime Voice Connectors with the Amazon Chime Voice Connector group by including VoiceConnectorItems in the request.

You can include Amazon Chime Voice Connectors from different AWS Regions in your group. This creates a fault tolerant mechanism for fallback in case of availability events.

#delete_account(options = {}) ⇒ Struct

Deletes the specified Amazon Chime account. You must suspend all users before deleting a Team account. You can use the BatchSuspendUser action to do so.

For EnterpriseLWA and EnterpriseAD accounts, you must release the claimed domains for your Amazon Chime account before deletion. As soon as you release the domain, all users under that account are suspended.

Deleted accounts appear in your Disabled accounts list for 90 days. To restore a deleted account from your Disabled accounts list, you must contact AWS Support.

After 90 days, deleted accounts are permanently removed from your Disabled accounts list.

#delete_app_instance(options = {}) ⇒ Struct

Deletes an AppInstance and all associated data asynchronously.

#delete_app_instance_admin(options = {}) ⇒ Struct

Demotes an AppInstanceAdmin to an AppInstanceUser. This action does not delete the user.

#delete_app_instance_streaming_configurations(options = {}) ⇒ Struct

Deletes the streaming configurations of an app instance.

#delete_app_instance_user(options = {}) ⇒ Struct

Deletes an AppInstanceUser.

#delete_attendee(options = {}) ⇒ Struct

Deletes an attendee from the specified Amazon Chime SDK meeting and deletes their JoinToken. Attendees are automatically deleted when a Amazon Chime SDK meeting is deleted. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.

#delete_channel(options = {}) ⇒ Struct

Immediately makes a channel and its memberships inaccessible and marks them for deletion. This is an irreversible process.

#delete_channel_ban(options = {}) ⇒ Struct

Removes a user from a channel's ban list.

#delete_channel_membership(options = {}) ⇒ Struct

Removes a member from a channel.

#delete_channel_message(options = {}) ⇒ Struct

Deletes a channel message. Only admins can perform this action. Deletion makes messages inaccessible immediately. A background process deletes any revisions created by UpdateChannelMessage.

#delete_channel_moderator(options = {}) ⇒ Struct

Deletes a channel moderator.

#delete_events_configuration(options = {}) ⇒ Struct

Deletes the events configuration that allows a bot to receive outgoing events.

#delete_meeting(options = {}) ⇒ Struct

Deletes the specified Amazon Chime SDK meeting. When a meeting is deleted, its attendees are also deleted and clients can no longer join it. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.

#delete_phone_number(options = {}) ⇒ Struct

Moves the specified phone number into the Deletion queue. A phone number must be disassociated from any users or Amazon Chime Voice Connectors before it can be deleted.

Deleted phone numbers remain in the Deletion queue for 7 days before they are deleted permanently.

#delete_proxy_session(options = {}) ⇒ Struct

Deletes the specified proxy session from the specified Amazon Chime Voice Connector.

#delete_room(options = {}) ⇒ Struct

Deletes a chat room in an Amazon Chime Enterprise account.

#delete_room_membership(options = {}) ⇒ Struct

Removes a member from a chat room in an Amazon Chime Enterprise account.

#delete_sip_media_application(options = {}) ⇒ Struct

Deletes a SIP media application.

#delete_sip_rule(options = {}) ⇒ Struct

Deletes a SIP rule. You must disable a SIP rule before you can delete it.

#delete_voice_connector(options = {}) ⇒ Struct

Deletes the specified Amazon Chime Voice Connector. Any phone numbers associated with the Amazon Chime Voice Connector must be disassociated from it before it can be deleted.

#delete_voice_connector_emergency_calling_configuration(options = {}) ⇒ Struct

Deletes the emergency calling configuration details from the specified Amazon Chime Voice Connector.

#delete_voice_connector_group(options = {}) ⇒ Struct

Deletes the specified Amazon Chime Voice Connector group. Any VoiceConnectorItems and phone numbers associated with the group must be removed before it can be deleted.

#delete_voice_connector_origination(options = {}) ⇒ Struct

Deletes the origination settings for the specified Amazon Chime Voice Connector.

If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to deleting the origination settings.

#delete_voice_connector_proxy(options = {}) ⇒ Struct

Deletes the proxy configuration from the specified Amazon Chime Voice Connector.

#delete_voice_connector_streaming_configuration(options = {}) ⇒ Struct

Deletes the streaming configuration for the specified Amazon Chime Voice Connector.

#delete_voice_connector_termination(options = {}) ⇒ Struct

Deletes the termination settings for the specified Amazon Chime Voice Connector.

If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to deleting the termination settings.

#delete_voice_connector_termination_credentials(options = {}) ⇒ Struct

Deletes the specified SIP credentials used by your equipment to authenticate during call termination.

#disassociate_phone_number_from_user(options = {}) ⇒ Struct

Disassociates the primary provisioned phone number from the specified Amazon Chime user.

#disassociate_signin_delegate_groups_from_account(options = {}) ⇒ Struct

Disassociates the specified sign-in delegate groups from the specified Amazon Chime account.

#get_account(options = {}) ⇒ Types::GetAccountResponse

Retrieves details for the specified Amazon Chime account, such as account type and supported licenses.

#get_account_settings(options = {}) ⇒ Types::GetAccountSettingsResponse

Retrieves account settings for the specified Amazon Chime account ID, such as remote control and dial out settings. For more information about these settings, see Use the Policies Page in the Amazon Chime Administration Guide.

#get_attendee(options = {}) ⇒ Types::GetAttendeeResponse

Gets the Amazon Chime SDK attendee details for a specified meeting ID and attendee ID. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.

#get_bot(options = {}) ⇒ Types::GetBotResponse

Retrieves details for the specified bot, such as bot email address, bot type, status, and display name.

#get_events_configuration(options = {}) ⇒ Types::GetEventsConfigurationResponse

Gets details for an events configuration that allows a bot to receive outgoing events, such as an HTTPS endpoint or Lambda function ARN.

#get_global_settings(options = {}) ⇒ Types::GetGlobalSettingsResponse

Retrieves global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.

#get_phone_number(options = {}) ⇒ Types::GetPhoneNumberResponse

Retrieves details for the specified phone number ID, such as associations, capabilities, and product type.

#get_phone_number_order(options = {}) ⇒ Types::GetPhoneNumberOrderResponse

Retrieves details for the specified phone number order, such as order creation timestamp, phone numbers in E.164 format, product type, and order status.

#get_phone_number_settings(options = {}) ⇒ Types::GetPhoneNumberSettingsResponse

Retrieves the phone number settings for the administrator's AWS account, such as the default outbound calling name.

#get_proxy_session(options = {}) ⇒ Types::GetProxySessionResponse

Gets the specified proxy session details for the specified Amazon Chime Voice Connector.

#get_room(options = {}) ⇒ Types::GetRoomResponse

Retrieves room details, such as the room name, for a room in an Amazon Chime Enterprise account.

#get_sip_rule(options = {}) ⇒ Types::GetSipRuleResponse

Retrieves the details of a SIP rule, such as the rule ID, name, triggers, and target endpoints.

#get_user(options = {}) ⇒ Types::GetUserResponse

Retrieves details for the specified user ID, such as primary email address, license type, and personal meeting PIN.

To retrieve user details with an email address instead of a user ID, use the ListUsers action, and then filter by email address.

#get_user_settings(options = {}) ⇒ Types::GetUserSettingsResponse

Retrieves settings for the specified user ID, such as any associated phone number settings.

#get_voice_connector(options = {}) ⇒ Types::GetVoiceConnectorResponse

Retrieves details for the specified Amazon Chime Voice Connector, such as timestamps, name, outbound host, and encryption requirements.

#get_voice_connector_group(options = {}) ⇒ Types::GetVoiceConnectorGroupResponse

Retrieves details for the specified Amazon Chime Voice Connector group, such as timestamps, name, and associated VoiceConnectorItems.

#get_voice_connector_logging_configuration(options = {}) ⇒ Types::GetVoiceConnectorLoggingConfigurationResponse

Retrieves the logging configuration details for the specified Amazon Chime Voice Connector. Shows whether SIP message logs are enabled for sending to Amazon CloudWatch.

#get_voice_connector_streaming_configuration(options = {}) ⇒ Types::GetVoiceConnectorStreamingConfigurationResponse

Retrieves the streaming configuration details for the specified Amazon Chime Voice Connector. Shows whether media streaming is enabled for sending to Amazon Kinesis. It also shows the retention period, in hours, for the Amazon Kinesis data.

#get_voice_connector_termination_health(options = {}) ⇒ Types::GetVoiceConnectorTerminationHealthResponse

Retrieves information about the last time a SIP OPTIONS ping was received from your SIP infrastructure for the specified Amazon Chime Voice Connector.

#invite_users(options = {}) ⇒ Types::InviteUsersResponse

Sends email to a maximum of 50 users, inviting them to the specified Amazon Chime Team account. Only Team account types are currently supported for this action.

#list_accounts(options = {}) ⇒ Types::ListAccountsResponse

Lists the Amazon Chime accounts under the administrator's AWS account. You can filter accounts by account name prefix. To find out which Amazon Chime account a user belongs to, you can filter by the user's email address, which returns one account result.

#list_bots(options = {}) ⇒ Types::ListBotsResponse

Lists the bots associated with the administrator's Amazon Chime Enterprise account ID.

#list_channel_messages(options = {}) ⇒ Types::ListChannelMessagesResponse

List all the messages in a channel. Returns a paginated list of ChannelMessages. Sorted in descending order by default, based on the creation timestamp.

Redacted messages appear in the results as empty, since they are only redacted, not deleted. Deleted messages do not appear in the results. This action always returns the latest version of an edited message.

#list_channels(options = {}) ⇒ Types::ListChannelsResponse

Lists all Channels created under a single Chime App as a paginated list. You can specify filters to narrow results.

Functionality & restrictions

Use privacy = PUBLIC to retrieve all public channels in the account
Only an AppInstanceAdmin can set privacy = PRIVATE to list the private channels in an account.

#list_phone_numbers(options = {}) ⇒ Types::ListPhoneNumbersResponse

Lists the phone numbers for the specified Amazon Chime account, Amazon Chime user, Amazon Chime Voice Connector, or Amazon Chime Voice Connector group.

#list_room_memberships(options = {}) ⇒ Types::ListRoomMembershipsResponse

Lists the membership details for the specified room in an Amazon Chime Enterprise account, such as the members' IDs, email addresses, and names.

#list_rooms(options = {}) ⇒ Types::ListRoomsResponse

Lists the room details for the specified Amazon Chime Enterprise account. Optionally, filter the results by a member ID (user ID or bot ID) to see a list of rooms that the member belongs to.

#list_users(options = {}) ⇒ Types::ListUsersResponse

Lists the users that belong to the specified Amazon Chime account. You can specify an email address to list only the user that the email address belongs to.

#logout_user(options = {}) ⇒ Struct

Logs out the specified user from all of the devices they are currently logged into.

#put_events_configuration(options = {}) ⇒ Types::PutEventsConfigurationResponse

Creates an events configuration that allows a bot to receive outgoing events sent by Amazon Chime. Choose either an HTTPS endpoint or a Lambda function ARN. For more information, see Bot.

#put_retention_settings(options = {}) ⇒ Types::PutRetentionSettingsResponse

Puts retention settings for the specified Amazon Chime Enterprise account. We recommend using AWS CloudTrail to monitor usage of this API for your account. For more information, see Logging Amazon Chime API Calls with AWS CloudTrail in the Amazon Chime Administration Guide.

To turn off existing retention settings, remove the number of days from the corresponding RetentionDays field in the RetentionSettings object. For more information about retention settings, see Managing Chat Retention Policies in the Amazon Chime Administration Guide.

#put_voice_connector_emergency_calling_configuration(options = {}) ⇒ Types::PutVoiceConnectorEmergencyCallingConfigurationResponse

Puts emergency calling configuration details to the specified Amazon Chime Voice Connector, such as emergency phone numbers and calling countries. Origination and termination settings must be enabled for the Amazon Chime Voice Connector before emergency calling can be configured.

#put_voice_connector_logging_configuration(options = {}) ⇒ Types::PutVoiceConnectorLoggingConfigurationResponse

Adds a logging configuration for the specified Amazon Chime Voice Connector. The logging configuration specifies whether SIP message logs are enabled for sending to Amazon CloudWatch Logs.

#put_voice_connector_origination(options = {}) ⇒ Types::PutVoiceConnectorOriginationResponse

Adds origination settings for the specified Amazon Chime Voice Connector.

If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to turning off origination settings.

#put_voice_connector_streaming_configuration(options = {}) ⇒ Types::PutVoiceConnectorStreamingConfigurationResponse

Adds a streaming configuration for the specified Amazon Chime Voice Connector. The streaming configuration specifies whether media streaming is enabled for sending to Amazon Kinesis. It also sets the retention period, in hours, for the Amazon Kinesis data.

#put_voice_connector_termination(options = {}) ⇒ Types::PutVoiceConnectorTerminationResponse

Adds termination settings for the specified Amazon Chime Voice Connector.

If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to turning off termination settings.

#put_voice_connector_termination_credentials(options = {}) ⇒ Struct

Adds termination SIP credentials for the specified Amazon Chime Voice Connector.

#redact_channel_message(options = {}) ⇒ Types::RedactChannelMessageResponse

Redacts message content, but not metadata. The message exists in the back end, but the action returns null content, and the state shows as redacted.

#redact_conversation_message(options = {}) ⇒ Struct

Redacts the specified message from the specified Amazon Chime conversation.

#redact_room_message(options = {}) ⇒ Struct

Redacts the specified message from the specified Amazon Chime channel.

#reset_personal_pin(options = {}) ⇒ Types::ResetPersonalPINResponse

Resets the personal meeting PIN for the specified user on an Amazon Chime account. Returns the User object with the updated personal meeting PIN.

#send_channel_message(options = {}) ⇒ Types::SendChannelMessageResponse

Sends a message to a particular channel that the member is a part of.

STANDARD messages can contain 4KB of data and the 1KB of metadata. CONTROL messages can contain 30 bytes of data and no metadata.

#tag_attendee(options = {}) ⇒ Struct

Applies the specified tags to the specified Amazon Chime SDK attendee.

#tag_meeting(options = {}) ⇒ Struct

Applies the specified tags to the specified Amazon Chime SDK meeting.

#tag_resource(options = {}) ⇒ Struct

Applies the specified tags to the specified Amazon Chime SDK meeting resource.

#untag_attendee(options = {}) ⇒ Struct

Untags the specified tags from the specified Amazon Chime SDK attendee.

#untag_meeting(options = {}) ⇒ Struct

Untags the specified tags from the specified Amazon Chime SDK meeting.

#untag_resource(options = {}) ⇒ Struct

Untags the specified tags from the specified Amazon Chime SDK meeting resource.

#update_account(options = {}) ⇒ Types::UpdateAccountResponse

Updates account details for the specified Amazon Chime account. Currently, only account name updates are supported for this action.

#update_account_settings(options = {}) ⇒ Struct

Updates the settings for the specified Amazon Chime account. You can update settings for remote control of shared screens, or for the dial-out option. For more information about these settings, see Use the Policies Page in the Amazon Chime Administration Guide.

#update_bot(options = {}) ⇒ Types::UpdateBotResponse

Updates the status of the specified bot, such as starting or stopping the bot from running in your Amazon Chime Enterprise account.

#update_channel(options = {}) ⇒ Types::UpdateChannelResponse

Update a channel's attributes.

Restriction: You can't change a channel's privacy.

#update_global_settings(options = {}) ⇒ Struct

Updates global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.

#update_phone_number(options = {}) ⇒ Types::UpdatePhoneNumberResponse

Updates phone number details, such as product type or calling name, for the specified phone number ID. You can update one phone number detail at a time. For example, you can update either the product type or the calling name in one action.

For toll-free numbers, you must use the Amazon Chime Voice Connector product type.

Updates to outbound calling names can take up to 72 hours to complete. Pending updates to outbound calling names must be complete before you can request another update.

#update_phone_number_settings(options = {}) ⇒ Struct

Updates the phone number settings for the administrator's AWS account, such as the default outbound calling name. You can update the default outbound calling name once every seven days. Outbound calling names can take up to 72 hours to update.

#update_room(options = {}) ⇒ Types::UpdateRoomResponse

Updates room details, such as the room name, for a room in an Amazon Chime Enterprise account.

#update_room_membership(options = {}) ⇒ Types::UpdateRoomMembershipResponse

Updates room membership details, such as the member role, for a room in an Amazon Chime Enterprise account. The member role designates whether the member is a chat room administrator or a general chat room member. The member role can be updated only for user IDs.

#update_user(options = {}) ⇒ Types::UpdateUserResponse

Updates user details for a specified user ID. Currently, only LicenseType updates are supported for this action.

#update_user_settings(options = {}) ⇒ Struct

Updates the settings for the specified user, such as phone number settings.

#update_voice_connector_group(options = {}) ⇒ Types::UpdateVoiceConnectorGroupResponse

Updates details for the specified Amazon Chime Voice Connector group, such as the name and Amazon Chime Voice Connector priority ranking.

#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ Boolean

Waiters polls an API operation until a resource enters a desired state.

Basic Usage

Waiters will poll until they are succesful, they fail by entering a terminal state, or until a maximum number of attempts are made.

# polls in a loop, sleeping between attempts client.waiter_until(waiter_name, params)

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You configure waiters by passing a block to #wait_until:

# poll for ~25 seconds
client.wait_until(...) do |w|
  w.max_attempts = 5
  w.delay = 5
end

Callbacks

You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.

started_at = Time.now
client.wait_until(...) do |w|

  # disable max attempts
  w.max_attempts = nil

  # poll for 1 hour, instead of a number of attempts
  w.before_wait do |attempts, response|
    throw :failure if Time.now - started_at > 3600
  end

end

Handling Errors

When a waiter is successful, it returns true. When a waiter fails, it raises an error. All errors raised extend from Waiters::Errors::WaiterFailed.

begin
  client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

#waiter_names ⇒ Array<Symbol>

Returns the list of supported waiters. The following table lists the supported waiters and the client method they call:

Waiter Name Client Method Default Delay: Default Max Attempts:

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4