RetroSearch Browse

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

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

Client — AWS SDK for Ruby V2

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

Associates a skill with the organization under the customer's AWS account. If a skill is private, the user implicitly accepts access to this skill during enablement.

#associate_contact_with_address_book(options = {}) ⇒ Struct

Associates a contact with a given address book.

#associate_device_with_network_profile(options = {}) ⇒ Struct

Associates a device with the specified network profile.

#associate_device_with_room(options = {}) ⇒ Struct

Associates a device with a given room. This applies all the settings from the room profile to the device, and all the skills in any skill groups added to that room. This operation requires the device to be online, or else a manual sync is required.

#associate_skill_group_with_room(options = {}) ⇒ Struct

Associates a skill group with a given room. This enables all skills in the associated skill group on all devices in the room.

#associate_skill_with_skill_group(options = {}) ⇒ Struct

Associates a skill with a skill group.

#associate_skill_with_users(options = {}) ⇒ Struct

Makes a private skill available for enrolled users to enable on their devices.

#create_business_report_schedule(options = {}) ⇒ Types::CreateBusinessReportScheduleResponse

Creates a recurring schedule for usage reports to deliver to the specified S3 location with a specified daily or weekly interval.

#delete_address_book(options = {}) ⇒ Struct

Deletes an address book by the address book ARN.

#delete_business_report_schedule(options = {}) ⇒ Struct

Deletes the recurring report delivery schedule with the specified schedule ARN.

#delete_conference_provider(options = {}) ⇒ Struct

Deletes a conference provider.

#delete_contact(options = {}) ⇒ Struct

Deletes a contact by the contact ARN.

#delete_device(options = {}) ⇒ Struct

Removes a device from Alexa For Business.

#delete_device_usage_data(options = {}) ⇒ Struct

When this action is called for a specified shared device, it allows authorized users to delete the device's entire previous history of voice input data and associated response data. This action can be called once every 24 hours for a specific shared device.

#delete_gateway_group(options = {}) ⇒ Struct #delete_network_profile(options = {}) ⇒ Struct

Deletes a network profile by the network profile ARN.

#delete_profile(options = {}) ⇒ Struct

Deletes a room profile by the profile ARN.

#delete_room(options = {}) ⇒ Struct

Deletes a room by the room ARN.

#delete_room_skill_parameter(options = {}) ⇒ Struct

Deletes room skill parameter details by room, skill, and parameter key ID.

Unlinks a third-party account from a skill.

#delete_skill_group(options = {}) ⇒ Struct

Deletes a skill group by skill group ARN.

#delete_user(options = {}) ⇒ Struct

Deletes a specified user by user ARN and enrollment ARN.

#disassociate_contact_from_address_book(options = {}) ⇒ Struct

Disassociates a contact from a given address book.

#disassociate_device_from_room(options = {}) ⇒ Struct

Disassociates a device from its current room. The device continues to be connected to the Wi-Fi network and is still registered to the account. The device settings and skills are removed from the room.

#disassociate_skill_from_skill_group(options = {}) ⇒ Struct

Disassociates a skill from a skill group.

#disassociate_skill_from_users(options = {}) ⇒ Struct

Makes a private skill unavailable for enrolled users and prevents them from enabling it on their devices.

#disassociate_skill_group_from_room(options = {}) ⇒ Struct

Disassociates a skill group from a specified room. This disables all skills in the skill group on all devices in the room.

#forget_smart_home_appliances(options = {}) ⇒ Struct

Forgets smart home appliances associated to a room.

#list_business_report_schedules(options = {}) ⇒ Types::ListBusinessReportSchedulesResponse

Lists the details of the schedules that a user configured. A download URL of the report associated with each schedule is returned every time this action is called. A new download URL is returned each time, and is valid for 24 hours.

#list_gateway_groups(options = {}) ⇒ Types::ListGatewayGroupsResponse

Retrieves a list of gateway group summaries. Use GetGatewayGroup to retrieve details of a specific gateway group.

#list_gateways(options = {}) ⇒ Types::ListGatewaysResponse

Retrieves a list of gateway summaries. Use GetGateway to retrieve details of a specific gateway. An optional gateway group ARN can be provided to only retrieve gateway summaries of gateways that are associated with that gateway group ARN.

#put_conference_preference(options = {}) ⇒ Struct

Sets the conference preferences on a specific conference provider at the account level.

#put_invitation_configuration(options = {}) ⇒ Struct

Configures the email template for the user enrollment invitation with the specified attributes.

#put_room_skill_parameter(options = {}) ⇒ Struct

Updates room skill parameter details by room, skill, and parameter key ID. Not all skills have a room skill parameter.

#put_skill_authorization(options = {}) ⇒ Struct

Links a user's account to a third-party skill provider. If this API operation is called by an assumed IAM role, the skill being linked must be a private skill. Also, the skill must be owned by the AWS account that assumed the IAM role.

#register_avs_device(options = {}) ⇒ Types::RegisterAVSDeviceResponse

Registers an Alexa-enabled device built by an Original Equipment Manufacturer (OEM) using Alexa Voice Service (AVS).

#reject_skill(options = {}) ⇒ Struct

Disassociates a skill from the organization under a user's AWS account. If the skill is a private skill, it moves to an AcceptStatus of PENDING. Any private or public skill that is rejected can be added later by calling the ApproveSkill API.

#resolve_room(options = {}) ⇒ Types::ResolveRoomResponse

Determines the details for the room from which a skill request was invoked. This operation is used by skill developers.

#revoke_invitation(options = {}) ⇒ Struct

Revokes an invitation and invalidates the enrollment URL.

#search_rooms(options = {}) ⇒ Types::SearchRoomsResponse

Searches rooms and lists the ones that meet a set of filter and sort criteria.

#search_users(options = {}) ⇒ Types::SearchUsersResponse

Searches users and lists the ones that meet a set of filter and sort criteria.

#send_announcement(options = {}) ⇒ Types::SendAnnouncementResponse

Triggers an asynchronous flow to send text, SSML, or audio announcements to rooms that are identified by a search or filter.

#send_invitation(options = {}) ⇒ Struct

Sends an enrollment invitation email with a URL to a user. The URL is valid for 30 days or until you call this operation again, whichever comes first.

#start_device_sync(options = {}) ⇒ Struct

Resets a device and its account to the known default settings. This clears all information and settings set by previous users in the following ways:

Bluetooth - This unpairs all bluetooth devices paired with your echo device.
Volume - This resets the echo device's volume to the default value.
Notifications - This clears all notifications from your echo device.
Lists - This clears all to-do items from your echo device.
Settings - This internally syncs the room's profile (if the device is assigned to a room), contacts, address books, delegation access for account linking, and communications (if enabled on the room profile).

#start_smart_home_appliance_discovery(options = {}) ⇒ Struct

Initiates the discovery of any smart home appliances associated with the room.

#tag_resource(options = {}) ⇒ Struct

Adds metadata tags to a specified resource.

#untag_resource(options = {}) ⇒ Struct

Removes metadata tags from a specified resource.

#update_address_book(options = {}) ⇒ Struct

Updates address book details by the address book ARN.

#update_business_report_schedule(options = {}) ⇒ Struct

Updates the configuration of the report delivery schedule with the specified schedule ARN.

#update_conference_provider(options = {}) ⇒ Struct

Updates an existing conference provider's settings.

#update_contact(options = {}) ⇒ Struct

Updates the contact details by the contact ARN.

#update_device(options = {}) ⇒ Struct

Updates the device name by device ARN.

#update_gateway(options = {}) ⇒ Struct

Updates the details of a gateway. If any optional field is not provided, the existing corresponding value is left unmodified.

#update_gateway_group(options = {}) ⇒ Struct

Updates the details of a gateway group. If any optional field is not provided, the existing corresponding value is left unmodified.

#update_network_profile(options = {}) ⇒ Struct

Updates a network profile by the network profile ARN.

#update_profile(options = {}) ⇒ Struct

Updates an existing room profile by room profile ARN.

#update_room(options = {}) ⇒ Struct

Updates room details by room ARN.

#update_skill_group(options = {}) ⇒ Struct

Updates skill group details by skill group ARN.

#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