Class: Aws::AlexaForBusiness::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::AlexaForBusiness::Client
- Includes:
- ClientStubs
- Defined in:
- lib/aws-sdk-alexaforbusiness/client.rb
Class Attribute Summary collapse
- .identifier ⇒ Object readonly private
API Operations collapse
-
#approve_skill(params = {}) ⇒ Struct
Associates a skill with the organization under the customer’s AWS account.
-
#associate_contact_with_address_book(params = {}) ⇒ Struct
Associates a contact with a given address book.
-
#associate_device_with_room(params = {}) ⇒ Struct
Associates a device with a given room.
-
#associate_skill_group_with_room(params = {}) ⇒ Struct
Associates a skill group with a given room.
-
#associate_skill_with_skill_group(params = {}) ⇒ Struct
Associates a skill with a skill group.
-
#associate_skill_with_users(params = {}) ⇒ Struct
Makes a private skill available for enrolled users to enable on their devices.
-
#create_address_book(params = {}) ⇒ Types::CreateAddressBookResponse
Creates an address book with the specified details.
-
#create_business_report_schedule(params = {}) ⇒ Types::CreateBusinessReportScheduleResponse
Creates a recurring schedule for usage reports to deliver to the specified S3 location with a specified daily or weekly interval.
-
#create_conference_provider(params = {}) ⇒ Types::CreateConferenceProviderResponse
Adds a new conference provider under the user’s AWS account.
-
#create_contact(params = {}) ⇒ Types::CreateContactResponse
Creates a contact with the specified details.
-
#create_profile(params = {}) ⇒ Types::CreateProfileResponse
Creates a new room profile with the specified details.
-
#create_room(params = {}) ⇒ Types::CreateRoomResponse
Creates a room with the specified details.
-
#create_skill_group(params = {}) ⇒ Types::CreateSkillGroupResponse
Creates a skill group with a specified name and description.
-
#create_user(params = {}) ⇒ Types::CreateUserResponse
Creates a user.
-
#delete_address_book(params = {}) ⇒ Struct
Deletes an address book by the address book ARN.
-
#delete_business_report_schedule(params = {}) ⇒ Struct
Deletes the recurring report delivery schedule with the specified schedule ARN.
-
#delete_conference_provider(params = {}) ⇒ Struct
Deletes a conference provider.
-
#delete_contact(params = {}) ⇒ Struct
Deletes a contact by the contact ARN.
-
#delete_device(params = {}) ⇒ Struct
Removes a device from Alexa For Business.
-
#delete_profile(params = {}) ⇒ Struct
Deletes a room profile by the profile ARN.
-
#delete_room(params = {}) ⇒ Struct
Deletes a room by the room ARN.
-
#delete_room_skill_parameter(params = {}) ⇒ Struct
Deletes room skill parameter details by room, skill, and parameter key ID.
-
#delete_skill_authorization(params = {}) ⇒ Struct
Unlinks a third-party account from a skill.
-
#delete_skill_group(params = {}) ⇒ Struct
Deletes a skill group by skill group ARN.
-
#delete_user(params = {}) ⇒ Struct
Deletes a specified user by user ARN and enrollment ARN.
-
#disassociate_contact_from_address_book(params = {}) ⇒ Struct
Disassociates a contact from a given address book.
-
#disassociate_device_from_room(params = {}) ⇒ Struct
Disassociates a device from its current room.
-
#disassociate_skill_from_skill_group(params = {}) ⇒ Struct
Disassociates a skill from a skill group.
-
#disassociate_skill_from_users(params = {}) ⇒ Struct
Makes a private skill unavailable for enrolled users and prevents them from enabling it on their devices.
-
#disassociate_skill_group_from_room(params = {}) ⇒ Struct
Disassociates a skill group from a specified room.
-
#forget_smart_home_appliances(params = {}) ⇒ Struct
Forgets smart home appliances associated to a room.
-
#get_address_book(params = {}) ⇒ Types::GetAddressBookResponse
Gets address the book details by the address book ARN.
-
#get_conference_preference(params = {}) ⇒ Types::GetConferencePreferenceResponse
Retrieves the existing conference preferences.
-
#get_conference_provider(params = {}) ⇒ Types::GetConferenceProviderResponse
Gets details about a specific conference provider.
-
#get_contact(params = {}) ⇒ Types::GetContactResponse
Gets the contact details by the contact ARN.
-
#get_device(params = {}) ⇒ Types::GetDeviceResponse
Gets the details of a device by device ARN.
-
#get_profile(params = {}) ⇒ Types::GetProfileResponse
Gets the details of a room profile by profile ARN.
-
#get_room(params = {}) ⇒ Types::GetRoomResponse
Gets room details by room ARN.
-
#get_room_skill_parameter(params = {}) ⇒ Types::GetRoomSkillParameterResponse
Gets room skill parameter details by room, skill, and parameter key ARN.
-
#get_skill_group(params = {}) ⇒ Types::GetSkillGroupResponse
Gets skill group details by skill group ARN.
-
#list_business_report_schedules(params = {}) ⇒ Types::ListBusinessReportSchedulesResponse
Lists the details of the schedules that a user configured.
-
#list_conference_providers(params = {}) ⇒ Types::ListConferenceProvidersResponse
Lists conference providers under a specific AWS account.
-
#list_device_events(params = {}) ⇒ Types::ListDeviceEventsResponse
Lists the device event history, including device connection status, for up to 30 days.
-
#list_skills(params = {}) ⇒ Types::ListSkillsResponse
Lists all enabled skills in a specific skill group.
-
#list_skills_store_categories(params = {}) ⇒ Types::ListSkillsStoreCategoriesResponse
Lists all categories in the Alexa skill store.
-
#list_skills_store_skills_by_category(params = {}) ⇒ Types::ListSkillsStoreSkillsByCategoryResponse
Lists all skills in the Alexa skill store by category.
-
#list_smart_home_appliances(params = {}) ⇒ Types::ListSmartHomeAppliancesResponse
Lists all of the smart home appliances associated with a room.
-
#list_tags(params = {}) ⇒ Types::ListTagsResponse
Lists all tags for the specified resource.
-
#put_conference_preference(params = {}) ⇒ Struct
Sets the conference preferences on a specific conference provider at the account level.
-
#put_room_skill_parameter(params = {}) ⇒ Struct
Updates room skill parameter details by room, skill, and parameter key ID.
-
#put_skill_authorization(params = {}) ⇒ Struct
Links a user’s account to a third-party skill provider.
-
#register_avs_device(params = {}) ⇒ Types::RegisterAVSDeviceResponse
Registers an Alexa-enabled device built by an Original Equipment Manufacturer (OEM) using Alexa Voice Service (AVS).
-
#reject_skill(params = {}) ⇒ Struct
Disassociates a skill from the organization under a user’s AWS account.
-
#resolve_room(params = {}) ⇒ Types::ResolveRoomResponse
Determines the details for the room from which a skill request was invoked.
-
#revoke_invitation(params = {}) ⇒ Struct
Revokes an invitation and invalidates the enrollment URL.
-
#search_address_books(params = {}) ⇒ Types::SearchAddressBooksResponse
Searches address books and lists the ones that meet a set of filter and sort criteria.
-
#search_contacts(params = {}) ⇒ Types::SearchContactsResponse
Searches contacts and lists the ones that meet a set of filter and sort criteria.
-
#search_devices(params = {}) ⇒ Types::SearchDevicesResponse
Searches devices and lists the ones that meet a set of filter criteria.
-
#search_profiles(params = {}) ⇒ Types::SearchProfilesResponse
Searches room profiles and lists the ones that meet a set of filter criteria.
-
#search_rooms(params = {}) ⇒ Types::SearchRoomsResponse
Searches rooms and lists the ones that meet a set of filter and sort criteria.
-
#search_skill_groups(params = {}) ⇒ Types::SearchSkillGroupsResponse
Searches skill groups and lists the ones that meet a set of filter and sort criteria.
-
#search_users(params = {}) ⇒ Types::SearchUsersResponse
Searches users and lists the ones that meet a set of filter and sort criteria.
-
#send_invitation(params = {}) ⇒ Struct
Sends an enrollment invitation email with a URL to a user.
-
#start_device_sync(params = {}) ⇒ Struct
Resets a device and its account to the known default settings, by clearing all information and settings set by previous users.
-
#start_smart_home_appliance_discovery(params = {}) ⇒ Struct
Initiates the discovery of any smart home appliances associated with the room.
-
#tag_resource(params = {}) ⇒ Struct
Adds metadata tags to a specified resource.
-
#untag_resource(params = {}) ⇒ Struct
Removes metadata tags from a specified resource.
-
#update_address_book(params = {}) ⇒ Struct
Updates address book details by the address book ARN.
-
#update_business_report_schedule(params = {}) ⇒ Struct
Updates the configuration of the report delivery schedule with the specified schedule ARN.
-
#update_conference_provider(params = {}) ⇒ Struct
Updates an existing conference provider’s settings.
-
#update_contact(params = {}) ⇒ Struct
Updates the contact details by the contact ARN.
-
#update_device(params = {}) ⇒ Struct
Updates the device name by device ARN.
-
#update_profile(params = {}) ⇒ Struct
Updates an existing room profile by room profile ARN.
-
#update_room(params = {}) ⇒ Struct
Updates room details by room ARN.
-
#update_skill_group(params = {}) ⇒ Struct
Updates skill group details by skill group ARN.
Class Method Summary collapse
- .errors_module ⇒ Object private
Instance Method Summary collapse
- #build_request(operation_name, params = {}) ⇒ Object private
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
- #waiter_names ⇒ Object deprecated private Deprecated.
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
212 213 214 |
# File 'lib/aws-sdk-alexaforbusiness/client.rb', line 212 def initialize(*args) super end |
Class Attribute Details
.identifier ⇒ Object (readonly)
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
3127 3128 3129 |
# File 'lib/aws-sdk-alexaforbusiness/client.rb', line 3127 def identifier @identifier end |
Class Method Details
.errors_module ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
3130 3131 3132 |
# File 'lib/aws-sdk-alexaforbusiness/client.rb', line 3130 def errors_module Errors end |
Instance Method Details
#approve_skill(params = {}) ⇒ 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.
237 238 239 240 |
# File 'lib/aws-sdk-alexaforbusiness/client.rb', line 237 def approve_skill(params = {}, = {}) req = build_request(:approve_skill, params) req.send_request() end |
#associate_contact_with_address_book(params = {}) ⇒ Struct
Associates a contact with a given address book.
263 264 265 266 |
# File 'lib/aws-sdk-alexaforbusiness/client.rb', line 263 def associate_contact_with_address_book(params = {}, = {}) req = build_request(:associate_contact_with_address_book, params) req.send_request() end |
#associate_device_with_room(params = {}) ⇒ 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.
292 293 294 295 |
# File 'lib/aws-sdk-alexaforbusiness/client.rb', line 292 def associate_device_with_room(params = {}, = {}) req = build_request(:associate_device_with_room, params) req.send_request() end |
#associate_skill_group_with_room(params = {}) ⇒ Struct
Associates a skill group with a given room. This enables all skills in the associated skill group on all devices in the room.
319 320 321 322 |
# File 'lib/aws-sdk-alexaforbusiness/client.rb', line 319 def associate_skill_group_with_room(params = {}, = {}) req = build_request(:associate_skill_group_with_room, params) req.send_request() end |
#associate_skill_with_skill_group(params = {}) ⇒ Struct
Associates a skill with a skill group.
345 346 347 348 |
# File 'lib/aws-sdk-alexaforbusiness/client.rb', line 345 def associate_skill_with_skill_group(params = {}, = {}) req = build_request(:associate_skill_with_skill_group, params) req.send_request() end |
#associate_skill_with_users(params = {}) ⇒ Struct
Makes a private skill available for enrolled users to enable on their devices.
372 373 374 375 |
# File 'lib/aws-sdk-alexaforbusiness/client.rb', line 372 def associate_skill_with_users(params = {}, = {}) req = build_request(:associate_skill_with_users, params) req.send_request() end |
#build_request(operation_name, params = {}) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 |
# File 'lib/aws-sdk-alexaforbusiness/client.rb', line 3105 def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-alexaforbusiness' context[:gem_version] = '1.15.0' Seahorse::Client::Request.new(handlers, context) end |
#create_address_book(params = {}) ⇒ Types::CreateAddressBookResponse
Creates an address book with the specified details.
412 413 414 415 |
# File 'lib/aws-sdk-alexaforbusiness/client.rb', line 412 def create_address_book(params = {}, = {}) req = build_request(:create_address_book, params) req.send_request() end |
#create_business_report_schedule(params = {}) ⇒ Types::CreateBusinessReportScheduleResponse
Creates a recurring schedule for usage reports to deliver to the specified S3 location with a specified daily or weekly interval.
473 474 475 476 |
# File 'lib/aws-sdk-alexaforbusiness/client.rb', line 473 def create_business_report_schedule(params = {}, = {}) req = build_request(:create_business_report_schedule, params) req.send_request() end |
#create_conference_provider(params = {}) ⇒ Types::CreateConferenceProviderResponse
Adds a new conference provider under the user’s AWS account.
534 535 536 537 |
# File 'lib/aws-sdk-alexaforbusiness/client.rb', line 534 def create_conference_provider(params = {}, = {}) req = build_request(:create_conference_provider, params) req.send_request() end |
#create_contact(params = {}) ⇒ Types::CreateContactResponse
Creates a contact with the specified details.
584 585 586 587 |
# File 'lib/aws-sdk-alexaforbusiness/client.rb', line 584 def create_contact(params = {}, = {}) req = build_request(:create_contact, params) req.send_request() end |
#create_profile(params = {}) ⇒ Types::CreateProfileResponse
Creates a new room profile with the specified details.
652 653 654 655 |
# File 'lib/aws-sdk-alexaforbusiness/client.rb', line 652 def create_profile(params = {}, = {}) req = build_request(:create_profile, params) req.send_request() end |
#create_room(params = {}) ⇒ Types::CreateRoomResponse
Creates a room with the specified details.
709 710 711 712 |
# File 'lib/aws-sdk-alexaforbusiness/client.rb', line 709 def create_room(params = {}, = {}) req = build_request(:create_room, params) req.send_request() end |
#create_skill_group(params = {}) ⇒ Types::CreateSkillGroupResponse
Creates a skill group with a specified name and description.
749 750 751 752 |
# File 'lib/aws-sdk-alexaforbusiness/client.rb', line 749 def create_skill_group(params = {}, = {}) req = build_request(:create_skill_group, params) req.send_request() end |
#create_user(params = {}) ⇒ Types::CreateUserResponse
Creates a user.
806 807 808 809 |
# File 'lib/aws-sdk-alexaforbusiness/client.rb', line 806 def create_user(params = {}, = {}) req = build_request(:create_user, params) req.send_request() end |
#delete_address_book(params = {}) ⇒ Struct
Deletes an address book by the address book ARN.
828 829 830 831 |
# File 'lib/aws-sdk-alexaforbusiness/client.rb', line 828 def delete_address_book(params = {}, = {}) req = build_request(:delete_address_book, params) req.send_request() end |
#delete_business_report_schedule(params = {}) ⇒ Struct
Deletes the recurring report delivery schedule with the specified schedule ARN.
851 852 853 854 |
# File 'lib/aws-sdk-alexaforbusiness/client.rb', line 851 def delete_business_report_schedule(params = {}, = {}) req = build_request(:delete_business_report_schedule, params) req.send_request() end |
#delete_conference_provider(params = {}) ⇒ Struct
Deletes a conference provider.
873 874 875 876 |
# File 'lib/aws-sdk-alexaforbusiness/client.rb', line 873 def delete_conference_provider(params = {}, = {}) req = build_request(:delete_conference_provider, params) req.send_request() end |
#delete_contact(params = {}) ⇒ Struct
Deletes a contact by the contact ARN.
895 896 897 898 |
# File 'lib/aws-sdk-alexaforbusiness/client.rb', line 895 def delete_contact(params = {}, = {}) req = build_request(:delete_contact, params) req.send_request() end |
#delete_device(params = {}) ⇒ Struct
Removes a device from Alexa For Business.
917 918 919 920 |
# File 'lib/aws-sdk-alexaforbusiness/client.rb', line 917 def delete_device(params = {}, = {}) req = build_request(:delete_device, params) req.send_request() end |
#delete_profile(params = {}) ⇒ Struct
Deletes a room profile by the profile ARN.
939 940 941 942 |
# File 'lib/aws-sdk-alexaforbusiness/client.rb', line 939 def delete_profile(params = {}, = {}) req = build_request(:delete_profile, params) req.send_request() end |
#delete_room(params = {}) ⇒ Struct
Deletes a room by the room ARN.
961 962 963 964 |
# File 'lib/aws-sdk-alexaforbusiness/client.rb', line 961 def delete_room(params = {}, = {}) req = build_request(:delete_room, params) req.send_request() end |
#delete_room_skill_parameter(params = {}) ⇒ Struct
Deletes room skill parameter details by room, skill, and parameter key ID.
994 995 996 997 |
# File 'lib/aws-sdk-alexaforbusiness/client.rb', line 994 def delete_room_skill_parameter(params = {}, = {}) req = build_request(:delete_room_skill_parameter, params) req.send_request() end |
#delete_skill_authorization(params = {}) ⇒ Struct
Unlinks a third-party account from a skill.
1020 1021 1022 1023 |
# File 'lib/aws-sdk-alexaforbusiness/client.rb', line 1020 def (params = {}, = {}) req = build_request(:delete_skill_authorization, params) req.send_request() end |
#delete_skill_group(params = {}) ⇒ Struct
Deletes a skill group by skill group ARN.
1042 1043 1044 1045 |
# File 'lib/aws-sdk-alexaforbusiness/client.rb', line 1042 def delete_skill_group(params = {}, = {}) req = build_request(:delete_skill_group, params) req.send_request() end |
#delete_user(params = {}) ⇒ Struct
Deletes a specified user by user ARN and enrollment ARN.
1068 1069 1070 1071 |
# File 'lib/aws-sdk-alexaforbusiness/client.rb', line 1068 def delete_user(params = {}, = {}) req = build_request(:delete_user, params) req.send_request() end |
#disassociate_contact_from_address_book(params = {}) ⇒ Struct
Disassociates a contact from a given address book.
1094 1095 1096 1097 |
# File 'lib/aws-sdk-alexaforbusiness/client.rb', line 1094 def disassociate_contact_from_address_book(params = {}, = {}) req = build_request(:disassociate_contact_from_address_book, params) req.send_request() end |
#disassociate_device_from_room(params = {}) ⇒ 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.
1118 1119 1120 1121 |
# File 'lib/aws-sdk-alexaforbusiness/client.rb', line 1118 def disassociate_device_from_room(params = {}, = {}) req = build_request(:disassociate_device_from_room, params) req.send_request() end |
#disassociate_skill_from_skill_group(params = {}) ⇒ Struct
Disassociates a skill from a skill group.
1144 1145 1146 1147 |
# File 'lib/aws-sdk-alexaforbusiness/client.rb', line 1144 def disassociate_skill_from_skill_group(params = {}, = {}) req = build_request(:disassociate_skill_from_skill_group, params) req.send_request() end |
#disassociate_skill_from_users(params = {}) ⇒ Struct
Makes a private skill unavailable for enrolled users and prevents them from enabling it on their devices.
1171 1172 1173 1174 |
# File 'lib/aws-sdk-alexaforbusiness/client.rb', line 1171 def disassociate_skill_from_users(params = {}, = {}) req = build_request(:disassociate_skill_from_users, params) req.send_request() end |
#disassociate_skill_group_from_room(params = {}) ⇒ Struct
Disassociates a skill group from a specified room. This disables all skills in the skill group on all devices in the room.
1199 1200 1201 1202 |
# File 'lib/aws-sdk-alexaforbusiness/client.rb', line 1199 def disassociate_skill_group_from_room(params = {}, = {}) req = build_request(:disassociate_skill_group_from_room, params) req.send_request() end |
#forget_smart_home_appliances(params = {}) ⇒ Struct
Forgets smart home appliances associated to a room.
1221 1222 1223 1224 |
# File 'lib/aws-sdk-alexaforbusiness/client.rb', line 1221 def forget_smart_home_appliances(params = {}, = {}) req = build_request(:forget_smart_home_appliances, params) req.send_request() end |
#get_address_book(params = {}) ⇒ Types::GetAddressBookResponse
Gets address the book details by the address book ARN.
1251 1252 1253 1254 |
# File 'lib/aws-sdk-alexaforbusiness/client.rb', line 1251 def get_address_book(params = {}, = {}) req = build_request(:get_address_book, params) req.send_request() end |
#get_conference_preference(params = {}) ⇒ Types::GetConferencePreferenceResponse
Retrieves the existing conference preferences.
1270 1271 1272 1273 |
# File 'lib/aws-sdk-alexaforbusiness/client.rb', line 1270 def get_conference_preference(params = {}, = {}) req = build_request(:get_conference_preference, params) req.send_request() end |
#get_conference_provider(params = {}) ⇒ Types::GetConferenceProviderResponse
Gets details about a specific conference provider.
1307 1308 1309 1310 |
# File 'lib/aws-sdk-alexaforbusiness/client.rb', line 1307 def get_conference_provider(params = {}, = {}) req = build_request(:get_conference_provider, params) req.send_request() end |
#get_contact(params = {}) ⇒ Types::GetContactResponse
Gets the contact details by the contact ARN.
1339 1340 1341 1342 |
# File 'lib/aws-sdk-alexaforbusiness/client.rb', line 1339 def get_contact(params = {}, = {}) req = build_request(:get_contact, params) req.send_request() end |
#get_device(params = {}) ⇒ Types::GetDeviceResponse
Gets the details of a device by device ARN.
1377 1378 1379 1380 |
# File 'lib/aws-sdk-alexaforbusiness/client.rb', line 1377 def get_device(params = {}, = {}) req = build_request(:get_device, params) req.send_request() end |
#get_profile(params = {}) ⇒ Types::GetProfileResponse
Gets the details of a room profile by profile ARN.
1416 1417 1418 1419 |
# File 'lib/aws-sdk-alexaforbusiness/client.rb', line 1416 def get_profile(params = {}, = {}) req = build_request(:get_profile, params) req.send_request() end |
#get_room(params = {}) ⇒ Types::GetRoomResponse
Gets room details by room ARN.
1448 1449 1450 1451 |
# File 'lib/aws-sdk-alexaforbusiness/client.rb', line 1448 def get_room(params = {}, = {}) req = build_request(:get_room, params) req.send_request() end |
#get_room_skill_parameter(params = {}) ⇒ Types::GetRoomSkillParameterResponse
Gets room skill parameter details by room, skill, and parameter key ARN.
1488 1489 1490 1491 |
# File 'lib/aws-sdk-alexaforbusiness/client.rb', line 1488 def get_room_skill_parameter(params = {}, = {}) req = build_request(:get_room_skill_parameter, params) req.send_request() end |
#get_skill_group(params = {}) ⇒ Types::GetSkillGroupResponse
Gets skill group details by skill group ARN.
1518 1519 1520 1521 |
# File 'lib/aws-sdk-alexaforbusiness/client.rb', line 1518 def get_skill_group(params = {}, = {}) req = build_request(:get_skill_group, params) req.send_request() end |
#list_business_report_schedules(params = {}) ⇒ Types::ListBusinessReportSchedulesResponse
Lists the details of the schedules that a user configured.
1566 1567 1568 1569 |
# File 'lib/aws-sdk-alexaforbusiness/client.rb', line 1566 def list_business_report_schedules(params = {}, = {}) req = build_request(:list_business_report_schedules, params) req.send_request() end |
#list_conference_providers(params = {}) ⇒ Types::ListConferenceProvidersResponse
Lists conference providers under a specific AWS account.
1611 1612 1613 1614 |
# File 'lib/aws-sdk-alexaforbusiness/client.rb', line 1611 def list_conference_providers(params = {}, = {}) req = build_request(:list_conference_providers, params) req.send_request() end |
#list_device_events(params = {}) ⇒ Types::ListDeviceEventsResponse
Lists the device event history, including device connection status, for up to 30 days.
1667 1668 1669 1670 |
# File 'lib/aws-sdk-alexaforbusiness/client.rb', line 1667 def list_device_events(params = {}, = {}) req = build_request(:list_device_events, params) req.send_request() end |
#list_skills(params = {}) ⇒ Types::ListSkillsResponse
Lists all enabled skills in a specific skill group.
1725 1726 1727 1728 |
# File 'lib/aws-sdk-alexaforbusiness/client.rb', line 1725 def list_skills(params = {}, = {}) req = build_request(:list_skills, params) req.send_request() end |
#list_skills_store_categories(params = {}) ⇒ Types::ListSkillsStoreCategoriesResponse
Lists all categories in the Alexa skill store.
1761 1762 1763 1764 |
# File 'lib/aws-sdk-alexaforbusiness/client.rb', line 1761 def list_skills_store_categories(params = {}, = {}) req = build_request(:list_skills_store_categories, params) req.send_request() end |
#list_skills_store_skills_by_category(params = {}) ⇒ Types::ListSkillsStoreSkillsByCategoryResponse
Lists all skills in the Alexa skill store by category.
1825 1826 1827 1828 |
# File 'lib/aws-sdk-alexaforbusiness/client.rb', line 1825 def list_skills_store_skills_by_category(params = {}, = {}) req = build_request(:list_skills_store_skills_by_category, params) req.send_request() end |
#list_smart_home_appliances(params = {}) ⇒ Types::ListSmartHomeAppliancesResponse
Lists all of the smart home appliances associated with a room.
1866 1867 1868 1869 |
# File 'lib/aws-sdk-alexaforbusiness/client.rb', line 1866 def list_smart_home_appliances(params = {}, = {}) req = build_request(:list_smart_home_appliances, params) req.send_request() end |
#list_tags(params = {}) ⇒ Types::ListTagsResponse
Lists all tags for the specified resource.
1912 1913 1914 1915 |
# File 'lib/aws-sdk-alexaforbusiness/client.rb', line 1912 def (params = {}, = {}) req = build_request(:list_tags, params) req.send_request() end |
#put_conference_preference(params = {}) ⇒ Struct
Sets the conference preferences on a specific conference provider at the account level.
1937 1938 1939 1940 |
# File 'lib/aws-sdk-alexaforbusiness/client.rb', line 1937 def put_conference_preference(params = {}, = {}) req = build_request(:put_conference_preference, params) req.send_request() end |
#put_room_skill_parameter(params = {}) ⇒ Struct
Updates room skill parameter details by room, skill, and parameter key ID. Not all skills have a room skill parameter.
1973 1974 1975 1976 |
# File 'lib/aws-sdk-alexaforbusiness/client.rb', line 1973 def put_room_skill_parameter(params = {}, = {}) req = build_request(:put_room_skill_parameter, params) req.send_request() end |
#put_skill_authorization(params = {}) ⇒ 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.
2010 2011 2012 2013 |
# File 'lib/aws-sdk-alexaforbusiness/client.rb', line 2010 def (params = {}, = {}) req = build_request(:put_skill_authorization, params) req.send_request() end |
#register_avs_device(params = {}) ⇒ Types::RegisterAVSDeviceResponse
Registers an Alexa-enabled device built by an Original Equipment Manufacturer (OEM) using Alexa Voice Service (AVS).
2060 2061 2062 2063 |
# File 'lib/aws-sdk-alexaforbusiness/client.rb', line 2060 def register_avs_device(params = {}, = {}) req = build_request(:register_avs_device, params) req.send_request() end |
#reject_skill(params = {}) ⇒ 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.
2085 2086 2087 2088 |
# File 'lib/aws-sdk-alexaforbusiness/client.rb', line 2085 def reject_skill(params = {}, = {}) req = build_request(:reject_skill, params) req.send_request() end |
#resolve_room(params = {}) ⇒ Types::ResolveRoomResponse
Determines the details for the room from which a skill request was invoked. This operation is used by skill developers.
2124 2125 2126 2127 |
# File 'lib/aws-sdk-alexaforbusiness/client.rb', line 2124 def resolve_room(params = {}, = {}) req = build_request(:resolve_room, params) req.send_request() end |
#revoke_invitation(params = {}) ⇒ Struct
Revokes an invitation and invalidates the enrollment URL.
2151 2152 2153 2154 |
# File 'lib/aws-sdk-alexaforbusiness/client.rb', line 2151 def revoke_invitation(params = {}, = {}) req = build_request(:revoke_invitation, params) req.send_request() end |
#search_address_books(params = {}) ⇒ Types::SearchAddressBooksResponse
Searches address books and lists the ones that meet a set of filter and sort criteria.
2216 2217 2218 2219 |
# File 'lib/aws-sdk-alexaforbusiness/client.rb', line 2216 def search_address_books(params = {}, = {}) req = build_request(:search_address_books, params) req.send_request() end |
#search_contacts(params = {}) ⇒ Types::SearchContactsResponse
Searches contacts and lists the ones that meet a set of filter and sort criteria.
2284 2285 2286 2287 |
# File 'lib/aws-sdk-alexaforbusiness/client.rb', line 2284 def search_contacts(params = {}, = {}) req = build_request(:search_contacts, params) req.send_request() end |
#search_devices(params = {}) ⇒ Types::SearchDevicesResponse
Searches devices and lists the ones that meet a set of filter criteria.
2362 2363 2364 2365 |
# File 'lib/aws-sdk-alexaforbusiness/client.rb', line 2362 def search_devices(params = {}, = {}) req = build_request(:search_devices, params) req.send_request() end |
#search_profiles(params = {}) ⇒ Types::SearchProfilesResponse
Searches room profiles and lists the ones that meet a set of filter criteria.
2433 2434 2435 2436 |
# File 'lib/aws-sdk-alexaforbusiness/client.rb', line 2433 def search_profiles(params = {}, = {}) req = build_request(:search_profiles, params) req.send_request() end |
#search_rooms(params = {}) ⇒ Types::SearchRoomsResponse
Searches rooms and lists the ones that meet a set of filter and sort criteria.
2502 2503 2504 2505 |
# File 'lib/aws-sdk-alexaforbusiness/client.rb', line 2502 def search_rooms(params = {}, = {}) req = build_request(:search_rooms, params) req.send_request() end |
#search_skill_groups(params = {}) ⇒ Types::SearchSkillGroupsResponse
Searches skill groups and lists the ones that meet a set of filter and sort criteria.
2568 2569 2570 2571 |
# File 'lib/aws-sdk-alexaforbusiness/client.rb', line 2568 def search_skill_groups(params = {}, = {}) req = build_request(:search_skill_groups, params) req.send_request() end |
#search_users(params = {}) ⇒ Types::SearchUsersResponse
Searches users and lists the ones that meet a set of filter and sort criteria.
2639 2640 2641 2642 |
# File 'lib/aws-sdk-alexaforbusiness/client.rb', line 2639 def search_users(params = {}, = {}) req = build_request(:search_users, params) req.send_request() end |
#send_invitation(params = {}) ⇒ Struct
Sends an enrollment invitation email with a URL to a user. The URL is valid for 72 hours or until you call this operation again, whichever comes first.
2663 2664 2665 2666 |
# File 'lib/aws-sdk-alexaforbusiness/client.rb', line 2663 def send_invitation(params = {}, = {}) req = build_request(:send_invitation, params) req.send_request() end |
#start_device_sync(params = {}) ⇒ Struct
Resets a device and its account to the known default settings, by clearing all information and settings set by previous users.
2695 2696 2697 2698 |
# File 'lib/aws-sdk-alexaforbusiness/client.rb', line 2695 def start_device_sync(params = {}, = {}) req = build_request(:start_device_sync, params) req.send_request() end |
#start_smart_home_appliance_discovery(params = {}) ⇒ Struct
Initiates the discovery of any smart home appliances associated with the room.
2718 2719 2720 2721 |
# File 'lib/aws-sdk-alexaforbusiness/client.rb', line 2718 def start_smart_home_appliance_discovery(params = {}, = {}) req = build_request(:start_smart_home_appliance_discovery, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Adds metadata tags to a specified resource.
2750 2751 2752 2753 |
# File 'lib/aws-sdk-alexaforbusiness/client.rb', line 2750 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes metadata tags from a specified resource.
2777 2778 2779 2780 |
# File 'lib/aws-sdk-alexaforbusiness/client.rb', line 2777 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_address_book(params = {}) ⇒ Struct
Updates address book details by the address book ARN.
2807 2808 2809 2810 |
# File 'lib/aws-sdk-alexaforbusiness/client.rb', line 2807 def update_address_book(params = {}, = {}) req = build_request(:update_address_book, params) req.send_request() end |
#update_business_report_schedule(params = {}) ⇒ Struct
Updates the configuration of the report delivery schedule with the specified schedule ARN.
2853 2854 2855 2856 |
# File 'lib/aws-sdk-alexaforbusiness/client.rb', line 2853 def update_business_report_schedule(params = {}, = {}) req = build_request(:update_business_report_schedule, params) req.send_request() end |
#update_conference_provider(params = {}) ⇒ Struct
Updates an existing conference provider’s settings.
2901 2902 2903 2904 |
# File 'lib/aws-sdk-alexaforbusiness/client.rb', line 2901 def update_conference_provider(params = {}, = {}) req = build_request(:update_conference_provider, params) req.send_request() end |
#update_contact(params = {}) ⇒ Struct
Updates the contact details by the contact ARN.
2939 2940 2941 2942 |
# File 'lib/aws-sdk-alexaforbusiness/client.rb', line 2939 def update_contact(params = {}, = {}) req = build_request(:update_contact, params) req.send_request() end |
#update_device(params = {}) ⇒ Struct
Updates the device name by device ARN.
2965 2966 2967 2968 |
# File 'lib/aws-sdk-alexaforbusiness/client.rb', line 2965 def update_device(params = {}, = {}) req = build_request(:update_device, params) req.send_request() end |
#update_profile(params = {}) ⇒ Struct
Updates an existing room profile by room profile ARN.
3028 3029 3030 3031 |
# File 'lib/aws-sdk-alexaforbusiness/client.rb', line 3028 def update_profile(params = {}, = {}) req = build_request(:update_profile, params) req.send_request() end |
#update_room(params = {}) ⇒ Struct
Updates room details by room ARN.
3066 3067 3068 3069 |
# File 'lib/aws-sdk-alexaforbusiness/client.rb', line 3066 def update_room(params = {}, = {}) req = build_request(:update_room, params) req.send_request() end |
#update_skill_group(params = {}) ⇒ Struct
Updates skill group details by skill group ARN.
3096 3097 3098 3099 |
# File 'lib/aws-sdk-alexaforbusiness/client.rb', line 3096 def update_skill_group(params = {}, = {}) req = build_request(:update_skill_group, params) req.send_request() end |
#waiter_names ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
3120 3121 3122 |
# File 'lib/aws-sdk-alexaforbusiness/client.rb', line 3120 def waiter_names [] end |