You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::AlexaForBusiness::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(*args) ⇒ Client

Returns a new instance of Client

Parameters:

  • options (Hash)

    a customizable set of options



163
164
165
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 163

def initialize(*args)
  super
end

Instance Method Details

#associate_contact_with_address_book(params = {}) ⇒ Struct

Associates a contact with a given address book.

Examples:

Request syntax with placeholder values


resp = client.associate_contact_with_address_book({
  contact_arn: "Arn", # required
  address_book_arn: "Arn", # required
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :contact_arn (required, String)

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

  • :address_book_arn (required, String)

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

Returns:

  • (Struct)

    Returns an empty response.

See Also:



190
191
192
193
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 190

def associate_contact_with_address_book(params = {}, options = {})
  req = build_request(:associate_contact_with_address_book, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.associate_device_with_room({
  device_arn: "Arn",
  room_arn: "Arn",
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :device_arn (String)

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

  • :room_arn (String)

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

Returns:

  • (Struct)

    Returns an empty response.

See Also:



219
220
221
222
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 219

def associate_device_with_room(params = {}, options = {})
  req = build_request(:associate_device_with_room, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.associate_skill_group_with_room({
  skill_group_arn: "Arn",
  room_arn: "Arn",
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :skill_group_arn (String)

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

  • :room_arn (String)

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

Returns:

  • (Struct)

    Returns an empty response.

See Also:



246
247
248
249
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 246

def associate_skill_group_with_room(params = {}, options = {})
  req = build_request(:associate_skill_group_with_room, params)
  req.send_request(options)
end

#create_address_book(params = {}) ⇒ Types::CreateAddressBookResponse

Creates an address book with the specified details.

Examples:

Request syntax with placeholder values


resp = client.create_address_book({
  name: "AddressBookName", # required
  description: "AddressBookDescription",
  client_request_token: "ClientRequestToken",
})

Response structure


resp.address_book_arn #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :name (required, String)

    The name of the address book.

  • :description (String)

    The description of the address book.

  • :client_request_token (String)

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

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



286
287
288
289
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 286

def create_address_book(params = {}, options = {})
  req = build_request(:create_address_book, params)
  req.send_request(options)
end

#create_contact(params = {}) ⇒ Types::CreateContactResponse

Creates a contact with the specified details.

Examples:

Request syntax with placeholder values


resp = client.create_contact({
  display_name: "ContactName",
  first_name: "ContactName", # required
  last_name: "ContactName",
  phone_number: "E164PhoneNumber", # required
  client_request_token: "ClientRequestToken",
})

Response structure


resp.contact_arn #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :display_name (String)

    The name of the contact to display on the console.

  • :first_name (required, String)

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

  • :last_name (String)

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

  • :phone_number (required, String)

    The phone number of the contact in E.164 format.

  • :client_request_token (String)

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

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



336
337
338
339
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 336

def create_contact(params = {}, options = {})
  req = build_request(:create_contact, params)
  req.send_request(options)
end

#create_profile(params = {}) ⇒ Types::CreateProfileResponse

Creates a new room profile with the specified details.

Examples:

Request syntax with placeholder values


resp = client.create_profile({
  profile_name: "ProfileName", # required
  timezone: "Timezone", # required
  address: "Address", # required
  distance_unit: "METRIC", # required, accepts METRIC, IMPERIAL
  temperature_unit: "FAHRENHEIT", # required, accepts FAHRENHEIT, CELSIUS
  wake_word: "ALEXA", # required, accepts ALEXA, AMAZON, ECHO, COMPUTER
  client_request_token: "ClientRequestToken",
  setup_mode_disabled: false,
  max_volume_limit: 1,
  pstn_enabled: false,
})

Response structure


resp.profile_arn #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :profile_name (required, String)

    The name of a room profile.

  • :timezone (required, String)

    The time zone used by a room profile.

  • :address (required, String)

    The valid address for the room.

  • :distance_unit (required, String)

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

  • :temperature_unit (required, String)

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

  • :wake_word (required, String)

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

  • :client_request_token (String)

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

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :setup_mode_disabled (Boolean)

    Whether room profile setup is enabled.

  • :max_volume_limit (Integer)

    The maximum volume limit for a room profile.

  • :pstn_enabled (Boolean)

    Whether PSTN calling is enabled.

Returns:

See Also:



404
405
406
407
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 404

def create_profile(params = {}, options = {})
  req = build_request(:create_profile, params)
  req.send_request(options)
end

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

Creates a room with the specified details.

Examples:

Request syntax with placeholder values


resp = client.create_room({
  room_name: "RoomName", # required
  description: "RoomDescription",
  profile_arn: "Arn",
  provider_calendar_id: "ProviderCalendarId",
  client_request_token: "ClientRequestToken",
  tags: [
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
})

Response structure


resp.room_arn #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :room_name (required, String)

    The name for the room.

  • :description (String)

    The description for the room.

  • :profile_arn (String)

    The profile ARN for the room.

  • :provider_calendar_id (String)

    The calendar ARN for the room.

  • :client_request_token (String)

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

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :tags (Array<Types::Tag>)

    The tags for the room.

Returns:

See Also:



461
462
463
464
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 461

def create_room(params = {}, options = {})
  req = build_request(:create_room, params)
  req.send_request(options)
end

#create_skill_group(params = {}) ⇒ Types::CreateSkillGroupResponse

Creates a skill group with a specified name and description.

Examples:

Request syntax with placeholder values


resp = client.create_skill_group({
  skill_group_name: "SkillGroupName", # required
  description: "SkillGroupDescription",
  client_request_token: "ClientRequestToken",
})

Response structure


resp.skill_group_arn #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :skill_group_name (required, String)

    The name for the skill group.

  • :description (String)

    The description for the skill group.

  • :client_request_token (String)

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

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



501
502
503
504
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 501

def create_skill_group(params = {}, options = {})
  req = build_request(:create_skill_group, params)
  req.send_request(options)
end

#create_user(params = {}) ⇒ Types::CreateUserResponse

Creates a user.

Examples:

Request syntax with placeholder values


resp = client.create_user({
  user_id: "user_UserId", # required
  first_name: "user_FirstName",
  last_name: "user_LastName",
  email: "Email",
  client_request_token: "ClientRequestToken",
  tags: [
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
})

Response structure


resp.user_arn #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :user_id (required, String)

    The ARN for the user.

  • :first_name (String)

    The first name for the user.

  • :last_name (String)

    The last name for the user.

  • :email (String)

    The email address for the user.

  • :client_request_token (String)

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

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :tags (Array<Types::Tag>)

    The tags for the user.

Returns:

See Also:



558
559
560
561
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 558

def create_user(params = {}, options = {})
  req = build_request(:create_user, params)
  req.send_request(options)
end

#delete_address_book(params = {}) ⇒ Struct

Deletes an address book by the address book ARN.

Examples:

Request syntax with placeholder values


resp = client.delete_address_book({
  address_book_arn: "Arn", # required
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :address_book_arn (required, String)

    The ARN of the address book to delete.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



580
581
582
583
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 580

def delete_address_book(params = {}, options = {})
  req = build_request(:delete_address_book, params)
  req.send_request(options)
end

#delete_contact(params = {}) ⇒ Struct

Deletes a contact by the contact ARN.

Examples:

Request syntax with placeholder values


resp = client.delete_contact({
  contact_arn: "Arn", # required
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :contact_arn (required, String)

    The ARN of the contact to delete.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



602
603
604
605
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 602

def delete_contact(params = {}, options = {})
  req = build_request(:delete_contact, params)
  req.send_request(options)
end

#delete_profile(params = {}) ⇒ Struct

Deletes a room profile by the profile ARN.

Examples:

Request syntax with placeholder values


resp = client.delete_profile({
  profile_arn: "Arn",
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :profile_arn (String)

    The ARN of the room profile to delete. Required.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



624
625
626
627
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 624

def delete_profile(params = {}, options = {})
  req = build_request(:delete_profile, params)
  req.send_request(options)
end

#delete_room(params = {}) ⇒ Struct

Deletes a room by the room ARN.

Examples:

Request syntax with placeholder values


resp = client.delete_room({
  room_arn: "Arn",
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :room_arn (String)

    The ARN of the room to delete. Required.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



646
647
648
649
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 646

def delete_room(params = {}, options = {})
  req = build_request(:delete_room, params)
  req.send_request(options)
end

#delete_room_skill_parameter(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


resp = client.delete_room_skill_parameter({
  room_arn: "Arn",
  skill_id: "SkillId", # required
  parameter_key: "RoomSkillParameterKey", # required
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :room_arn (String)

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

  • :skill_id (required, String)

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

  • :parameter_key (required, String)

    The room skill parameter key for which to remove details.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



679
680
681
682
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 679

def delete_room_skill_parameter(params = {}, options = {})
  req = build_request(:delete_room_skill_parameter, params)
  req.send_request(options)
end

#delete_skill_group(params = {}) ⇒ Struct

Deletes a skill group by skill group ARN.

Examples:

Request syntax with placeholder values


resp = client.delete_skill_group({
  skill_group_arn: "Arn",
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :skill_group_arn (String)

    The ARN of the skill group to delete. Required.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



701
702
703
704
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 701

def delete_skill_group(params = {}, options = {})
  req = build_request(:delete_skill_group, params)
  req.send_request(options)
end

#delete_user(params = {}) ⇒ Struct

Deletes a specified user by user ARN and enrollment ARN.

Examples:

Request syntax with placeholder values


resp = client.delete_user({
  user_arn: "Arn",
  enrollment_id: "EnrollmentId", # required
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :user_arn (String)

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

  • :enrollment_id (required, String)

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

Returns:

  • (Struct)

    Returns an empty response.

See Also:



727
728
729
730
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 727

def delete_user(params = {}, options = {})
  req = build_request(:delete_user, params)
  req.send_request(options)
end

#disassociate_contact_from_address_book(params = {}) ⇒ Struct

Disassociates a contact from a given address book.

Examples:

Request syntax with placeholder values


resp = client.disassociate_contact_from_address_book({
  contact_arn: "Arn", # required
  address_book_arn: "Arn", # required
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :contact_arn (required, String)

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

  • :address_book_arn (required, String)

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

Returns:

  • (Struct)

    Returns an empty response.

See Also:



753
754
755
756
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 753

def disassociate_contact_from_address_book(params = {}, options = {})
  req = build_request(:disassociate_contact_from_address_book, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.disassociate_device_from_room({
  device_arn: "Arn",
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :device_arn (String)

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

Returns:

  • (Struct)

    Returns an empty response.

See Also:



777
778
779
780
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 777

def disassociate_device_from_room(params = {}, options = {})
  req = build_request(:disassociate_device_from_room, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.disassociate_skill_group_from_room({
  skill_group_arn: "Arn",
  room_arn: "Arn",
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :skill_group_arn (String)

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

  • :room_arn (String)

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

Returns:

  • (Struct)

    Returns an empty response.

See Also:



805
806
807
808
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 805

def disassociate_skill_group_from_room(params = {}, options = {})
  req = build_request(:disassociate_skill_group_from_room, params)
  req.send_request(options)
end

#get_address_book(params = {}) ⇒ Types::GetAddressBookResponse

Gets address the book details by the address book ARN.

Examples:

Request syntax with placeholder values


resp = client.get_address_book({
  address_book_arn: "Arn", # required
})

Response structure


resp.address_book.address_book_arn #=> String
resp.address_book.name #=> String
resp.address_book.description #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :address_book_arn (required, String)

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

Returns:

See Also:



835
836
837
838
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 835

def get_address_book(params = {}, options = {})
  req = build_request(:get_address_book, params)
  req.send_request(options)
end

#get_contact(params = {}) ⇒ Types::GetContactResponse

Gets the contact details by the contact ARN.

Examples:

Request syntax with placeholder values


resp = client.get_contact({
  contact_arn: "Arn", # required
})

Response structure


resp.contact.contact_arn #=> String
resp.contact.display_name #=> String
resp.contact.first_name #=> String
resp.contact.last_name #=> String
resp.contact.phone_number #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :contact_arn (required, String)

    The ARN of the contact for which to request details.

Returns:

See Also:



867
868
869
870
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 867

def get_contact(params = {}, options = {})
  req = build_request(:get_contact, params)
  req.send_request(options)
end

#get_device(params = {}) ⇒ Types::GetDeviceResponse

Gets the details of a device by device ARN.

Examples:

Request syntax with placeholder values


resp = client.get_device({
  device_arn: "Arn",
})

Response structure


resp.device.device_arn #=> String
resp.device.device_serial_number #=> String
resp.device.device_type #=> String
resp.device.device_name #=> String
resp.device.software_version #=> String
resp.device.mac_address #=> String
resp.device.room_arn #=> String
resp.device.device_status #=> String, one of "READY", "PENDING", "WAS_OFFLINE", "DEREGISTERED"
resp.device.device_status_info.device_status_details #=> Array
resp.device.device_status_info.device_status_details[0].code #=> String, one of "DEVICE_SOFTWARE_UPDATE_NEEDED", "DEVICE_WAS_OFFLINE"
resp.device.device_status_info.connection_status #=> String, one of "ONLINE", "OFFLINE"

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :device_arn (String)

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

Returns:

See Also:



905
906
907
908
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 905

def get_device(params = {}, options = {})
  req = build_request(:get_device, params)
  req.send_request(options)
end

#get_profile(params = {}) ⇒ Types::GetProfileResponse

Gets the details of a room profile by profile ARN.

Examples:

Request syntax with placeholder values


resp = client.get_profile({
  profile_arn: "Arn",
})

Response structure


resp.profile.profile_arn #=> String
resp.profile.profile_name #=> String
resp.profile.address #=> String
resp.profile.timezone #=> String
resp.profile.distance_unit #=> String, one of "METRIC", "IMPERIAL"
resp.profile.temperature_unit #=> String, one of "FAHRENHEIT", "CELSIUS"
resp.profile.wake_word #=> String, one of "ALEXA", "AMAZON", "ECHO", "COMPUTER"
resp.profile.setup_mode_disabled #=> Boolean
resp.profile.max_volume_limit #=> Integer
resp.profile.pstn_enabled #=> Boolean

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :profile_arn (String)

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

Returns:

See Also:



942
943
944
945
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 942

def get_profile(params = {}, options = {})
  req = build_request(:get_profile, params)
  req.send_request(options)
end

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

Gets room details by room ARN.

Examples:

Request syntax with placeholder values


resp = client.get_room({
  room_arn: "Arn",
})

Response structure


resp.room.room_arn #=> String
resp.room.room_name #=> String
resp.room.description #=> String
resp.room.provider_calendar_id #=> String
resp.room.profile_arn #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :room_arn (String)

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

Returns:

See Also:



974
975
976
977
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 974

def get_room(params = {}, options = {})
  req = build_request(:get_room, params)
  req.send_request(options)
end

#get_room_skill_parameter(params = {}) ⇒ Types::GetRoomSkillParameterResponse

Gets room skill parameter details by room, skill, and parameter key ARN.

Examples:

Request syntax with placeholder values


resp = client.get_room_skill_parameter({
  room_arn: "Arn",
  skill_id: "SkillId", # required
  parameter_key: "RoomSkillParameterKey", # required
})

Response structure


resp.room_skill_parameter.parameter_key #=> String
resp.room_skill_parameter.parameter_value #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :room_arn (String)

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

  • :skill_id (required, String)

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

  • :parameter_key (required, String)

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

Returns:

See Also:



1014
1015
1016
1017
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 1014

def get_room_skill_parameter(params = {}, options = {})
  req = build_request(:get_room_skill_parameter, params)
  req.send_request(options)
end

#get_skill_group(params = {}) ⇒ Types::GetSkillGroupResponse

Gets skill group details by skill group ARN.

Examples:

Request syntax with placeholder values


resp = client.get_skill_group({
  skill_group_arn: "Arn",
})

Response structure


resp.skill_group.skill_group_arn #=> String
resp.skill_group.skill_group_name #=> String
resp.skill_group.description #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :skill_group_arn (String)

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

Returns:

See Also:



1044
1045
1046
1047
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 1044

def get_skill_group(params = {}, options = {})
  req = build_request(:get_skill_group, params)
  req.send_request(options)
end

#list_device_events(params = {}) ⇒ Types::ListDeviceEventsResponse

Lists the Device Event history for up to 30 days. If EventType isn't specified in the request, this returns a list of all device events in reverse chronological order. If EventType is specified, this returns a list of device events for that EventType in reverse chronological order.

Examples:

Request syntax with placeholder values


resp = client.list_device_events({
  device_arn: "Arn", # required
  event_type: "CONNECTION_STATUS", # accepts CONNECTION_STATUS, DEVICE_STATUS
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.device_events #=> Array
resp.device_events[0].type #=> String, one of "CONNECTION_STATUS", "DEVICE_STATUS"
resp.device_events[0].value #=> String
resp.device_events[0].timestamp #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :device_arn (required, String)

    The ARN of a device.

  • :event_type (String)

    The event type to filter device events.

  • :next_token (String)

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

  • :max_results (Integer)

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

Returns:

See Also:



1099
1100
1101
1102
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 1099

def list_device_events(params = {}, options = {})
  req = build_request(:list_device_events, params)
  req.send_request(options)
end

#list_skills(params = {}) ⇒ Types::ListSkillsResponse

Lists all enabled skills in a specific skill group.

Examples:

Request syntax with placeholder values


resp = client.list_skills({
  skill_group_arn: "Arn",
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.skill_summaries #=> Array
resp.skill_summaries[0].skill_id #=> String
resp.skill_summaries[0].skill_name #=> String
resp.skill_summaries[0].supports_linking #=> Boolean
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :skill_group_arn (String)

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

  • :next_token (String)

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

  • :max_results (Integer)

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

Returns:

See Also:



1146
1147
1148
1149
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 1146

def list_skills(params = {}, options = {})
  req = build_request(:list_skills, params)
  req.send_request(options)
end

#list_tags(params = {}) ⇒ Types::ListTagsResponse

Lists all tags for a specific resource.

Examples:

Request syntax with placeholder values


resp = client.list_tags({
  arn: "Arn", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :arn (required, String)

    The ARN of the specific resource for which to list tags. Required.

  • :next_token (String)

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

  • :max_results (Integer)

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

Returns:

See Also:



1192
1193
1194
1195
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 1192

def list_tags(params = {}, options = {})
  req = build_request(:list_tags, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.put_room_skill_parameter({
  room_arn: "Arn",
  skill_id: "SkillId", # required
  room_skill_parameter: { # required
    parameter_key: "RoomSkillParameterKey", # required
    parameter_value: "RoomSkillParameterValue", # required
  },
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :room_arn (String)

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

  • :skill_id (required, String)

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

  • :room_skill_parameter (required, Types::RoomSkillParameter)

    The updated room skill parameter. Required.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1228
1229
1230
1231
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 1228

def put_room_skill_parameter(params = {}, options = {})
  req = build_request(:put_room_skill_parameter, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.resolve_room({
  user_id: "UserId", # required
  skill_id: "SkillId", # required
})

Response structure


resp.room_arn #=> String
resp.room_name #=> String
resp.room_skill_parameters #=> Array
resp.room_skill_parameters[0].parameter_key #=> String
resp.room_skill_parameters[0].parameter_value #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :user_id (required, String)

    The ARN of the user. Required.

  • :skill_id (required, String)

    The ARN of the skill that was requested. Required.

Returns:

See Also:



1267
1268
1269
1270
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 1267

def resolve_room(params = {}, options = {})
  req = build_request(:resolve_room, params)
  req.send_request(options)
end

#revoke_invitation(params = {}) ⇒ Struct

Revokes an invitation and invalidates the enrollment URL.

Examples:

Request syntax with placeholder values


resp = client.revoke_invitation({
  user_arn: "Arn",
  enrollment_id: "EnrollmentId",
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :user_arn (String)

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

  • :enrollment_id (String)

    The ARN of the enrollment invitation to revoke. Required.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1294
1295
1296
1297
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 1294

def revoke_invitation(params = {}, options = {})
  req = build_request(:revoke_invitation, params)
  req.send_request(options)
end

#search_address_books(params = {}) ⇒ Types::SearchAddressBooksResponse

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

Examples:

Request syntax with placeholder values


resp = client.search_address_books({
  filters: [
    {
      key: "FilterKey", # required
      values: ["FilterValue"], # required
    },
  ],
  sort_criteria: [
    {
      key: "SortKey", # required
      value: "ASC", # required, accepts ASC, DESC
    },
  ],
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.address_books #=> Array
resp.address_books[0].address_book_arn #=> String
resp.address_books[0].name #=> String
resp.address_books[0].description #=> String
resp.next_token #=> String
resp.total_count #=> Integer

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :filters (Array<Types::Filter>)

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

  • :sort_criteria (Array<Types::Sort>)

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

  • :next_token (String)

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

  • :max_results (Integer)

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

Returns:

See Also:



1359
1360
1361
1362
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 1359

def search_address_books(params = {}, options = {})
  req = build_request(:search_address_books, params)
  req.send_request(options)
end

#search_contacts(params = {}) ⇒ Types::SearchContactsResponse

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

Examples:

Request syntax with placeholder values


resp = client.search_contacts({
  filters: [
    {
      key: "FilterKey", # required
      values: ["FilterValue"], # required
    },
  ],
  sort_criteria: [
    {
      key: "SortKey", # required
      value: "ASC", # required, accepts ASC, DESC
    },
  ],
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.contacts #=> Array
resp.contacts[0].contact_arn #=> String
resp.contacts[0].display_name #=> String
resp.contacts[0].first_name #=> String
resp.contacts[0].last_name #=> String
resp.contacts[0].phone_number #=> String
resp.next_token #=> String
resp.total_count #=> Integer

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :filters (Array<Types::Filter>)

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

  • :sort_criteria (Array<Types::Sort>)

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

  • :next_token (String)

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

  • :max_results (Integer)

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

Returns:

See Also:



1427
1428
1429
1430
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 1427

def search_contacts(params = {}, options = {})
  req = build_request(:search_contacts, params)
  req.send_request(options)
end

#search_devices(params = {}) ⇒ Types::SearchDevicesResponse

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

Examples:

Request syntax with placeholder values


resp = client.search_devices({
  next_token: "NextToken",
  max_results: 1,
  filters: [
    {
      key: "FilterKey", # required
      values: ["FilterValue"], # required
    },
  ],
  sort_criteria: [
    {
      key: "SortKey", # required
      value: "ASC", # required, accepts ASC, DESC
    },
  ],
})

Response structure


resp.devices #=> Array
resp.devices[0].device_arn #=> String
resp.devices[0].device_serial_number #=> String
resp.devices[0].device_type #=> String
resp.devices[0].device_name #=> String
resp.devices[0].software_version #=> String
resp.devices[0].mac_address #=> String
resp.devices[0].device_status #=> String, one of "READY", "PENDING", "WAS_OFFLINE", "DEREGISTERED"
resp.devices[0].room_arn #=> String
resp.devices[0].room_name #=> String
resp.devices[0].device_status_info.device_status_details #=> Array
resp.devices[0].device_status_info.device_status_details[0].code #=> String, one of "DEVICE_SOFTWARE_UPDATE_NEEDED", "DEVICE_WAS_OFFLINE"
resp.devices[0].device_status_info.connection_status #=> String, one of "ONLINE", "OFFLINE"
resp.next_token #=> String
resp.total_count #=> Integer

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :next_token (String)

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

  • :max_results (Integer)

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

  • :filters (Array<Types::Filter>)

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

  • :sort_criteria (Array<Types::Sort>)

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

Returns:

See Also:



1505
1506
1507
1508
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 1505

def search_devices(params = {}, options = {})
  req = build_request(:search_devices, params)
  req.send_request(options)
end

#search_profiles(params = {}) ⇒ Types::SearchProfilesResponse

Searches room profiles and lists the ones that meet a set of filter criteria.

Examples:

Request syntax with placeholder values


resp = client.search_profiles({
  next_token: "NextToken",
  max_results: 1,
  filters: [
    {
      key: "FilterKey", # required
      values: ["FilterValue"], # required
    },
  ],
  sort_criteria: [
    {
      key: "SortKey", # required
      value: "ASC", # required, accepts ASC, DESC
    },
  ],
})

Response structure


resp.profiles #=> Array
resp.profiles[0].profile_arn #=> String
resp.profiles[0].profile_name #=> String
resp.profiles[0].address #=> String
resp.profiles[0].timezone #=> String
resp.profiles[0].distance_unit #=> String, one of "METRIC", "IMPERIAL"
resp.profiles[0].temperature_unit #=> String, one of "FAHRENHEIT", "CELSIUS"
resp.profiles[0].wake_word #=> String, one of "ALEXA", "AMAZON", "ECHO", "COMPUTER"
resp.next_token #=> String
resp.total_count #=> Integer

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :next_token (String)

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

  • :max_results (Integer)

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

  • :filters (Array<Types::Filter>)

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

  • :sort_criteria (Array<Types::Sort>)

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

Returns:

See Also:



1575
1576
1577
1578
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 1575

def search_profiles(params = {}, options = {})
  req = build_request(:search_profiles, params)
  req.send_request(options)
end

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

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

Examples:

Request syntax with placeholder values


resp = client.search_rooms({
  next_token: "NextToken",
  max_results: 1,
  filters: [
    {
      key: "FilterKey", # required
      values: ["FilterValue"], # required
    },
  ],
  sort_criteria: [
    {
      key: "SortKey", # required
      value: "ASC", # required, accepts ASC, DESC
    },
  ],
})

Response structure


resp.rooms #=> Array
resp.rooms[0].room_arn #=> String
resp.rooms[0].room_name #=> String
resp.rooms[0].description #=> String
resp.rooms[0].provider_calendar_id #=> String
resp.rooms[0].profile_arn #=> String
resp.rooms[0].profile_name #=> String
resp.next_token #=> String
resp.total_count #=> Integer

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :next_token (String)

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

  • :max_results (Integer)

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

  • :filters (Array<Types::Filter>)

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

  • :sort_criteria (Array<Types::Sort>)

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

Returns:

See Also:



1644
1645
1646
1647
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 1644

def search_rooms(params = {}, options = {})
  req = build_request(:search_rooms, params)
  req.send_request(options)
end

#search_skill_groups(params = {}) ⇒ Types::SearchSkillGroupsResponse

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

Examples:

Request syntax with placeholder values


resp = client.search_skill_groups({
  next_token: "NextToken",
  max_results: 1,
  filters: [
    {
      key: "FilterKey", # required
      values: ["FilterValue"], # required
    },
  ],
  sort_criteria: [
    {
      key: "SortKey", # required
      value: "ASC", # required, accepts ASC, DESC
    },
  ],
})

Response structure


resp.skill_groups #=> Array
resp.skill_groups[0].skill_group_arn #=> String
resp.skill_groups[0].skill_group_name #=> String
resp.skill_groups[0].description #=> String
resp.next_token #=> String
resp.total_count #=> Integer

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :next_token (String)

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

  • :max_results (Integer)

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

  • :filters (Array<Types::Filter>)

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

  • :sort_criteria (Array<Types::Sort>)

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

Returns:

See Also:



1710
1711
1712
1713
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 1710

def search_skill_groups(params = {}, options = {})
  req = build_request(:search_skill_groups, params)
  req.send_request(options)
end

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

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

Examples:

Request syntax with placeholder values


resp = client.search_users({
  next_token: "NextToken",
  max_results: 1,
  filters: [
    {
      key: "FilterKey", # required
      values: ["FilterValue"], # required
    },
  ],
  sort_criteria: [
    {
      key: "SortKey", # required
      value: "ASC", # required, accepts ASC, DESC
    },
  ],
})

Response structure


resp.users #=> Array
resp.users[0].user_arn #=> String
resp.users[0].first_name #=> String
resp.users[0].last_name #=> String
resp.users[0].email #=> String
resp.users[0].enrollment_status #=> String, one of "INITIALIZED", "PENDING", "REGISTERED", "DISASSOCIATING", "DEREGISTERING"
resp.users[0].enrollment_id #=> String
resp.next_token #=> String
resp.total_count #=> Integer

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :next_token (String)

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

  • :max_results (Integer)

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

  • :filters (Array<Types::Filter>)

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

  • :sort_criteria (Array<Types::Sort>)

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

Returns:

See Also:



1781
1782
1783
1784
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 1781

def search_users(params = {}, options = {})
  req = build_request(:search_users, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.send_invitation({
  user_arn: "Arn",
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :user_arn (String)

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

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1805
1806
1807
1808
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 1805

def send_invitation(params = {}, options = {})
  req = build_request(:send_invitation, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.start_device_sync({
  room_arn: "Arn",
  device_arn: "Arn",
  features: ["BLUETOOTH"], # required, accepts BLUETOOTH, VOLUME, NOTIFICATIONS, LISTS, SKILLS, ALL
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :room_arn (String)

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

  • :device_arn (String)

    The ARN of the device to sync. Required.

  • :features (required, Array<String>)

    Request structure to start the device sync. Required.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1837
1838
1839
1840
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 1837

def start_device_sync(params = {}, options = {})
  req = build_request(:start_device_sync, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ Struct

Adds metadata tags to a specified resource.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  arn: "Arn", # required
  tags: [ # required
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :arn (required, String)

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

  • :tags (required, Array<Types::Tag>)

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

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1869
1870
1871
1872
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 1869

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

Removes metadata tags from a specified resource.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  arn: "Arn", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :arn (required, String)

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

  • :tag_keys (required, Array<String>)

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

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1896
1897
1898
1899
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 1896

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_address_book(params = {}) ⇒ Struct

Updates address book details by the address book ARN.

Examples:

Request syntax with placeholder values


resp = client.update_address_book({
  address_book_arn: "Arn", # required
  name: "AddressBookName",
  description: "AddressBookDescription",
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :address_book_arn (required, String)

    The ARN of the room to update.

  • :name (String)

    The updated name of the room.

  • :description (String)

    The updated description of the room.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1926
1927
1928
1929
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 1926

def update_address_book(params = {}, options = {})
  req = build_request(:update_address_book, params)
  req.send_request(options)
end

#update_contact(params = {}) ⇒ Struct

Updates the contact details by the contact ARN.

Examples:

Request syntax with placeholder values


resp = client.update_contact({
  contact_arn: "Arn", # required
  display_name: "ContactName",
  first_name: "ContactName",
  last_name: "ContactName",
  phone_number: "E164PhoneNumber",
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :contact_arn (required, String)

    The ARN of the contact to update.

  • :display_name (String)

    The updated display name of the contact.

  • :first_name (String)

    The updated first name of the contact.

  • :last_name (String)

    The updated last name of the contact.

  • :phone_number (String)

    The updated phone number of the contact.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1964
1965
1966
1967
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 1964

def update_contact(params = {}, options = {})
  req = build_request(:update_contact, params)
  req.send_request(options)
end

#update_device(params = {}) ⇒ Struct

Updates the device name by device ARN.

Examples:

Request syntax with placeholder values


resp = client.update_device({
  device_arn: "Arn",
  device_name: "DeviceName",
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :device_arn (String)

    The ARN of the device to update. Required.

  • :device_name (String)

    The updated device name. Required.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1990
1991
1992
1993
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 1990

def update_device(params = {}, options = {})
  req = build_request(:update_device, params)
  req.send_request(options)
end

#update_profile(params = {}) ⇒ Struct

Updates an existing room profile by room profile ARN.

Examples:

Request syntax with placeholder values


resp = client.update_profile({
  profile_arn: "Arn",
  profile_name: "ProfileName",
  timezone: "Timezone",
  address: "Address",
  distance_unit: "METRIC", # accepts METRIC, IMPERIAL
  temperature_unit: "FAHRENHEIT", # accepts FAHRENHEIT, CELSIUS
  wake_word: "ALEXA", # accepts ALEXA, AMAZON, ECHO, COMPUTER
  setup_mode_disabled: false,
  max_volume_limit: 1,
  pstn_enabled: false,
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :profile_arn (String)

    The ARN of the room profile to update. Required.

  • :profile_name (String)

    The updated name for the room profile.

  • :timezone (String)

    The updated timezone for the room profile.

  • :address (String)

    The updated address for the room profile.

  • :distance_unit (String)

    The updated distance unit for the room profile.

  • :temperature_unit (String)

    The updated temperature unit for the room profile.

  • :wake_word (String)

    The updated wake word for the room profile.

  • :setup_mode_disabled (Boolean)

    Whether the setup mode of the profile is enabled.

  • :max_volume_limit (Integer)

    The updated maximum volume limit for the room profile.

  • :pstn_enabled (Boolean)

    Whether the PSTN setting of the room profile is enabled.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



2048
2049
2050
2051
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 2048

def update_profile(params = {}, options = {})
  req = build_request(:update_profile, params)
  req.send_request(options)
end

#update_room(params = {}) ⇒ Struct

Updates room details by room ARN.

Examples:

Request syntax with placeholder values


resp = client.update_room({
  room_arn: "Arn",
  room_name: "RoomName",
  description: "RoomDescription",
  provider_calendar_id: "ProviderCalendarId",
  profile_arn: "Arn",
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :room_arn (String)

    The ARN of the room to update.

  • :room_name (String)

    The updated name for the room.

  • :description (String)

    The updated description for the room.

  • :provider_calendar_id (String)

    The updated provider calendar ARN for the room.

  • :profile_arn (String)

    The updated profile ARN for the room.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



2086
2087
2088
2089
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 2086

def update_room(params = {}, options = {})
  req = build_request(:update_room, params)
  req.send_request(options)
end

#update_skill_group(params = {}) ⇒ Struct

Updates skill group details by skill group ARN.

Examples:

Request syntax with placeholder values


resp = client.update_skill_group({
  skill_group_arn: "Arn",
  skill_group_name: "SkillGroupName",
  description: "SkillGroupDescription",
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :skill_group_arn (String)

    The ARN of the skill group to update.

  • :skill_group_name (String)

    The updated name for the skill group.

  • :description (String)

    The updated description for the skill group.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



2116
2117
2118
2119
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 2116

def update_skill_group(params = {}, options = {})
  req = build_request(:update_skill_group, params)
  req.send_request(options)
end