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

#api_requests, #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(options) ⇒ Client

Returns a new instance of Client

Parameters:

  • options (Hash)

Options Hash (options):

  • :credentials (required, Aws::CredentialProvider)

    Your AWS credentials. This can be an instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::SharedCredentials - Used for loading credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, and :session_token options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • ~/.aws/credentials
    • ~/.aws/config
    • EC2 IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails to enable retries and extended timeouts.
  • :region (required, String)

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is search for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :active_endpoint_cache (Boolean) — default: false

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :client_side_monitoring (Boolean) — default: false

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: ""

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1"

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true

    When true, an attempt is made to coerce request parameters into the required types.

  • :disable_host_prefix_injection (Boolean) — default: false

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :endpoint (String)

    The client endpoint is normally constructed from the :region option. You should only configure an :endpoint when connecting to test endpoints. This should be avalid HTTP(S) URI.

  • :endpoint_cache_max_entries (Integer) — default: 1000

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false

    When set to true, endpoint discovery will be enabled for operations when available. Defaults to false.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default

    The log formatter.

  • :log_level (Symbol) — default: :info

    The log level to send messages to the :logger at.

  • :logger (Logger)

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :profile (String) — default: "default"

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :retry_base_delay (Float) — default: 0.3

    The base delay in seconds used by the default backoff function.

  • :retry_jitter (Symbol) — default: :none

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors and auth errors from expired credentials.

  • :retry_max_delay (Integer) — default: 0

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.

  • :secret_access_key (String)
  • :session_token (String)
  • :simple_json (Boolean) — default: false

    Disables request parameter conversion, validation, and formatting. Also disable response data type conversions. This option is useful when you want to ensure the highest level of performance by avoiding overhead of walking request parameters and response data structures.

    When :simple_json is enabled, the request parameters hash must be formatted exactly as the DynamoDB API expects.

  • :stub_responses (Boolean) — default: false

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :validate_params (Boolean) — default: true

    When true, request parameters are validated before sending the request.

  • :http_proxy (URI::HTTP, String)

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_open_timeout (Float) — default: 15

    The number of seconds to wait when opening a HTTP session before rasing a Timeout::Error.

  • :http_read_timeout (Integer) — default: 60

    The default number of seconds to wait for response data. This value can safely be set per-request on the session yeidled by #session_for.

  • :http_idle_timeout (Float) — default: 5

    The number of seconds a connection is allowed to sit idble before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_continue_timeout (Float) — default: 1

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session yeidled by #session_for.

  • :http_wire_trace (Boolean) — default: false

    When true, HTTP debug output will be sent to the :logger.

  • :ssl_verify_peer (Boolean) — default: true

    When true, SSL peer certificates are verified when establishing a connection.

  • :ssl_ca_bundle (String)

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String)

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.



261
262
263
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 261

def initialize(*args)
  super
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.

Examples:

Request syntax with placeholder values


resp = client.approve_skill({
  skill_id: "SkillId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :skill_id (required, String)

    The unique identifier of the skill.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



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

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

#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:



312
313
314
315
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 312

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_network_profile(params = {}) ⇒ Struct

Associates a device with the specified network profile.

Examples:

Request syntax with placeholder values


resp = client.associate_device_with_network_profile({
  device_arn: "Arn", # required
  network_profile_arn: "Arn", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :device_arn (required, String)

    The device ARN.

  • :network_profile_arn (required, String)

    The ARN of the network profile to associate with a device.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



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

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



367
368
369
370
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 367

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:



394
395
396
397
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 394

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

#associate_skill_with_skill_group(params = {}) ⇒ Struct

Associates a skill with a skill group.

Examples:

Request syntax with placeholder values


resp = client.associate_skill_with_skill_group({
  skill_group_arn: "Arn",
  skill_id: "SkillId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :skill_group_arn (String)

    The ARN of the skill group to associate the skill to. Required.

  • :skill_id (required, String)

    The unique identifier of the skill.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



420
421
422
423
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 420

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

#associate_skill_with_users(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


resp = client.associate_skill_with_users({
  skill_id: "SkillId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :skill_id (required, String)

    The private skill ID you want to make available to enrolled users.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



443
444
445
446
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 443

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



483
484
485
486
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 483

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

Examples:

Request syntax with placeholder values


resp = client.create_business_report_schedule({
  schedule_name: "BusinessReportScheduleName",
  s3_bucket_name: "CustomerS3BucketName",
  s3_key_prefix: "S3KeyPrefix",
  format: "CSV", # required, accepts CSV, CSV_ZIP
  content_range: { # required
    interval: "ONE_DAY", # accepts ONE_DAY, ONE_WEEK
  },
  recurrence: {
    start_date: "Date",
  },
  client_request_token: "ClientRequestToken",
})

Response structure


resp.schedule_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :schedule_name (String)

    The name identifier of the schedule.

  • :s3_bucket_name (String)

    The S3 bucket name of the output reports. If this isn't specified, the report can be retrieved from a download link by calling ListBusinessReportSchedule.

  • :s3_key_prefix (String)

    The S3 key where the report is delivered.

  • :format (required, String)

    The format of the generated report (individual CSV files or zipped files of individual files).

  • :content_range (required, Types::BusinessReportContentRange)

    The content range of the reports.

  • :recurrence (Types::BusinessReportRecurrence)

    The recurrence of the reports. If this isn't specified, the report will only be delivered one time when the API is called.

  • :client_request_token (String)

    The client request token.

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

Returns:

See Also:



547
548
549
550
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 547

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

#create_conference_provider(params = {}) ⇒ Types::CreateConferenceProviderResponse

Adds a new conference provider under the user's AWS account.

Examples:

Request syntax with placeholder values


resp = client.create_conference_provider({
  conference_provider_name: "ConferenceProviderName", # required
  conference_provider_type: "CHIME", # required, accepts CHIME, BLUEJEANS, FUZE, GOOGLE_HANGOUTS, POLYCOM, RINGCENTRAL, SKYPE_FOR_BUSINESS, WEBEX, ZOOM, CUSTOM
  ip_dial_in: {
    endpoint: "Endpoint", # required
    comms_protocol: "SIP", # required, accepts SIP, SIPS, H323
  },
  pstn_dial_in: {
    country_code: "CountryCode", # required
    phone_number: "OutboundPhoneNumber", # required
    one_click_id_delay: "OneClickIdDelay", # required
    one_click_pin_delay: "OneClickPinDelay", # required
  },
  meeting_setting: { # required
    require_pin: "YES", # required, accepts YES, NO, OPTIONAL
  },
  client_request_token: "ClientRequestToken",
})

Response structure


resp.conference_provider_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :conference_provider_name (required, String)

    The name of the conference provider.

  • :conference_provider_type (required, String)

    Represents a type within a list of predefined types.

  • :ip_dial_in (Types::IPDialIn)

    The IP endpoint and protocol for calling.

  • :pstn_dial_in (Types::PSTNDialIn)

    The information for PSTN conferencing.

  • :meeting_setting (required, Types::MeetingSetting)

    The meeting settings for the conference provider.

  • :client_request_token (String)

    The request token of the client.

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

Returns:

See Also:



608
609
610
611
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 608

def create_conference_provider(params = {}, options = {})
  req = build_request(:create_conference_provider, 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: "RawPhoneNumber",
  phone_numbers: [
    {
      number: "RawPhoneNumber", # required
      type: "MOBILE", # required, accepts MOBILE, WORK, HOME
    },
  ],
  sip_addresses: [
    {
      uri: "SipUri", # required
      type: "WORK", # required, accepts WORK
    },
  ],
  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 (String)

    The phone number of the contact in E.164 format. The phone number type defaults to WORK. You can specify PhoneNumber or PhoneNumbers. We recommend that you use PhoneNumbers, which lets you specify the phone number type and multiple numbers.

  • :phone_numbers (Array<Types::PhoneNumber>)

    The list of phone numbers for the contact.

  • :sip_addresses (Array<Types::SipAddress>)

    The list of SIP addresses for the contact.

  • :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:



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

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

#create_gateway_group(params = {}) ⇒ Types::CreateGatewayGroupResponse

Creates a gateway group with the specified details.

Examples:

Request syntax with placeholder values


resp = client.create_gateway_group({
  name: "GatewayGroupName", # required
  description: "GatewayGroupDescription",
  client_request_token: "ClientRequestToken", # required
})

Response structure


resp.gateway_group_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String)

    The name of the gateway group.

  • :description (String)

    The description of the gateway group.

  • :client_request_token (required, 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:



719
720
721
722
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 719

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

#create_network_profile(params = {}) ⇒ Types::CreateNetworkProfileResponse

Creates a network profile with the specified details.

Examples:

Request syntax with placeholder values


resp = client.create_network_profile({
  network_profile_name: "NetworkProfileName", # required
  description: "NetworkProfileDescription",
  ssid: "NetworkSsid", # required
  security_type: "OPEN", # required, accepts OPEN, WEP, WPA_PSK, WPA2_PSK, WPA2_ENTERPRISE
  eap_method: "EAP_TLS", # accepts EAP_TLS
  current_password: "CurrentWiFiPassword",
  next_password: "NextWiFiPassword",
  certificate_authority_arn: "Arn",
  trust_anchors: ["TrustAnchor"],
  client_request_token: "ClientRequestToken", # required
})

Response structure


resp.network_profile_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :network_profile_name (required, String)

    The name of the network profile associated with a device.

  • :description (String)

    Detailed information about a device's network profile.

  • :ssid (required, String)

    The SSID of the Wi-Fi network.

  • :security_type (required, String)

    The security type of the Wi-Fi network. This can be WPA2_ENTERPRISE, WPA2_PSK, WPA_PSK, WEP, or OPEN.

  • :eap_method (String)

    The authentication standard that is used in the EAP framework. Currently, EAP_TLS is supported.

  • :current_password (String)

    The current password of the Wi-Fi network.

  • :next_password (String)

    The next, or subsequent, password of the Wi-Fi network. This password is asynchronously transmitted to the device and is used when the password of the network changes to NextPassword.

  • :certificate_authority_arn (String)

    The ARN of the Private Certificate Authority (PCA) created in AWS Certificate Manager (ACM). This is used to issue certificates to the devices.

  • :trust_anchors (Array<String>)

    The root certificates of your authentication server that is installed on your devices and used to trust your authentication server during EAP negotiation.

  • :client_request_token (required, 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:



795
796
797
798
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 795

def create_network_profile(params = {}, options = {})
  req = build_request(:create_network_profile, 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
  locale: "DeviceLocale",
  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.

  • :locale (String)

    The locale of the room profile.

  • :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:



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

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", # required
      value: "TagValue", # required
    },
  ],
})

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:



924
925
926
927
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 924

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:



964
965
966
967
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 964

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", # required
      value: "TagValue", # required
    },
  ],
})

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:



1021
1022
1023
1024
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 1021

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:



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

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

#delete_business_report_schedule(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


resp = client.delete_business_report_schedule({
  schedule_arn: "Arn", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :schedule_arn (required, String)

    The ARN of the business report schedule.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1066
1067
1068
1069
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 1066

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

#delete_conference_provider(params = {}) ⇒ Struct

Deletes a conference provider.

Examples:

Request syntax with placeholder values


resp = client.delete_conference_provider({
  conference_provider_arn: "Arn", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :conference_provider_arn (required, String)

    The ARN of the conference provider.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1088
1089
1090
1091
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 1088

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



1110
1111
1112
1113
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 1110

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

#delete_device(params = {}) ⇒ Struct

Removes a device from Alexa For Business.

Examples:

Request syntax with placeholder values


resp = client.delete_device({
  device_arn: "Arn", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :device_arn (required, String)

    The ARN of the device for which to request details.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1132
1133
1134
1135
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 1132

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

#delete_device_usage_data(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


resp = client.delete_device_usage_data({
  device_arn: "Arn", # required
  device_usage_type: "VOICE", # required, accepts VOICE
})

Parameters:

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

    ({})

Options Hash (params):

  • :device_arn (required, String)

    The ARN of the device.

  • :device_usage_type (required, String)

    The type of usage data to delete.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1161
1162
1163
1164
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 1161

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

#delete_gateway_group(params = {}) ⇒ Struct

Deletes a gateway group.

Examples:

Request syntax with placeholder values


resp = client.delete_gateway_group({
  gateway_group_arn: "Arn", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :gateway_group_arn (required, String)

    The ARN of the gateway group to delete.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1183
1184
1185
1186
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 1183

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

#delete_network_profile(params = {}) ⇒ Struct

Deletes a network profile by the network profile ARN.

Examples:

Request syntax with placeholder values


resp = client.delete_network_profile({
  network_profile_arn: "Arn", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :network_profile_arn (required, String)

    The ARN of the network profile associated with a device.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1205
1206
1207
1208
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 1205

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



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

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:



1249
1250
1251
1252
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 1249

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:



1282
1283
1284
1285
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 1282

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

#delete_skill_authorization(params = {}) ⇒ Struct

Unlinks a third-party account from a skill.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :skill_id (required, String)

    The unique identifier of a skill.

  • :room_arn (String)

    The room that the skill is authorized for.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1308
1309
1310
1311
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 1308

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



1330
1331
1332
1333
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 1330

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:



1356
1357
1358
1359
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 1356

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:



1382
1383
1384
1385
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 1382

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:



1406
1407
1408
1409
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 1406

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

#disassociate_skill_from_skill_group(params = {}) ⇒ Struct

Disassociates a skill from a skill group.

Examples:

Request syntax with placeholder values


resp = client.disassociate_skill_from_skill_group({
  skill_group_arn: "Arn",
  skill_id: "SkillId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :skill_group_arn (String)

    The unique identifier of a skill. Required.

  • :skill_id (required, String)

    The ARN of a skill group to associate to a skill.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1432
1433
1434
1435
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 1432

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

#disassociate_skill_from_users(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


resp = client.disassociate_skill_from_users({
  skill_id: "SkillId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :skill_id (required, String)

    The private skill ID you want to make unavailable for enrolled users.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1455
1456
1457
1458
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 1455

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



1483
1484
1485
1486
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 1483

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

#forget_smart_home_appliances(params = {}) ⇒ Struct

Forgets smart home appliances associated to a room.

Examples:

Request syntax with placeholder values


resp = client.forget_smart_home_appliances({
  room_arn: "Arn", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :room_arn (required, String)

    The room that the appliances are associated with.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



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

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



1535
1536
1537
1538
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 1535

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

#get_conference_preference(params = {}) ⇒ Types::GetConferencePreferenceResponse

Retrieves the existing conference preferences.

Examples:

Response structure


resp.preference.default_conference_provider_arn #=> String

Parameters:

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

    ({})

Returns:

See Also:



1554
1555
1556
1557
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 1554

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

#get_conference_provider(params = {}) ⇒ Types::GetConferenceProviderResponse

Gets details about a specific conference provider.

Examples:

Request syntax with placeholder values


resp = client.get_conference_provider({
  conference_provider_arn: "Arn", # required
})

Response structure


resp.conference_provider.arn #=> String
resp.conference_provider.name #=> String
resp.conference_provider.type #=> String, one of "CHIME", "BLUEJEANS", "FUZE", "GOOGLE_HANGOUTS", "POLYCOM", "RINGCENTRAL", "SKYPE_FOR_BUSINESS", "WEBEX", "ZOOM", "CUSTOM"
resp.conference_provider.ip_dial_in.endpoint #=> String
resp.conference_provider.ip_dial_in.comms_protocol #=> String, one of "SIP", "SIPS", "H323"
resp.conference_provider.pstn_dial_in.country_code #=> String
resp.conference_provider.pstn_dial_in.phone_number #=> String
resp.conference_provider.pstn_dial_in.one_click_id_delay #=> String
resp.conference_provider.pstn_dial_in.one_click_pin_delay #=> String
resp.conference_provider.meeting_setting.require_pin #=> String, one of "YES", "NO", "OPTIONAL"

Parameters:

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

    ({})

Options Hash (params):

  • :conference_provider_arn (required, String)

    The ARN of the newly created conference provider.

Returns:

See Also:



1591
1592
1593
1594
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 1591

def get_conference_provider(params = {}, options = {})
  req = build_request(:get_conference_provider, 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
resp.contact.phone_numbers #=> Array
resp.contact.phone_numbers[0].number #=> String
resp.contact.phone_numbers[0].type #=> String, one of "MOBILE", "WORK", "HOME"
resp.contact.sip_addresses #=> Array
resp.contact.sip_addresses[0].uri #=> String
resp.contact.sip_addresses[0].type #=> String, one of "WORK"

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:



1629
1630
1631
1632
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 1629

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", "FAILED"
resp.device.device_status_info.device_status_details #=> Array
resp.device.device_status_info.device_status_details[0].feature #=> String, one of "BLUETOOTH", "VOLUME", "NOTIFICATIONS", "LISTS", "SKILLS", "NETWORK_PROFILE", "SETTINGS", "ALL"
resp.device.device_status_info.device_status_details[0].code #=> String, one of "DEVICE_SOFTWARE_UPDATE_NEEDED", "DEVICE_WAS_OFFLINE", "CREDENTIALS_ACCESS_FAILURE", "TLS_VERSION_MISMATCH", "ASSOCIATION_REJECTION", "AUTHENTICATION_FAILURE", "DHCP_FAILURE", "INTERNET_UNAVAILABLE", "DNS_FAILURE", "UNKNOWN_FAILURE", "CERTIFICATE_ISSUING_LIMIT_EXCEEDED", "INVALID_CERTIFICATE_AUTHORITY", "NETWORK_PROFILE_NOT_FOUND", "INVALID_PASSWORD_STATE", "PASSWORD_NOT_FOUND"
resp.device.device_status_info.connection_status #=> String, one of "ONLINE", "OFFLINE"
resp.device.network_profile_info.network_profile_arn #=> String
resp.device.network_profile_info.certificate_arn #=> String
resp.device.network_profile_info.certificate_expiration_time #=> Time

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:



1671
1672
1673
1674
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 1671

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

#get_gateway(params = {}) ⇒ Types::GetGatewayResponse

Retrieves the details of a gateway.

Examples:

Request syntax with placeholder values


resp = client.get_gateway({
  gateway_arn: "Arn", # required
})

Response structure


resp.gateway.arn #=> String
resp.gateway.name #=> String
resp.gateway.description #=> String
resp.gateway.gateway_group_arn #=> String
resp.gateway.software_version #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :gateway_arn (required, String)

    The ARN of the gateway to get.

Returns:

See Also:



1703
1704
1705
1706
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 1703

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

#get_gateway_group(params = {}) ⇒ Types::GetGatewayGroupResponse

Retrieves the details of a gateway group.

Examples:

Request syntax with placeholder values


resp = client.get_gateway_group({
  gateway_group_arn: "Arn", # required
})

Response structure


resp.gateway_group.arn #=> String
resp.gateway_group.name #=> String
resp.gateway_group.description #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :gateway_group_arn (required, String)

    The ARN of the gateway group to get.

Returns:

See Also:



1733
1734
1735
1736
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 1733

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

#get_invitation_configuration(params = {}) ⇒ Types::GetInvitationConfigurationResponse

Retrieves the configured values for the user enrollment invitation email template.

Examples:

Response structure


resp.organization_name #=> String
resp.contact_email #=> String
resp.private_skill_ids #=> Array
resp.private_skill_ids[0] #=> String

Parameters:

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

    ({})

Returns:

See Also:



1758
1759
1760
1761
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 1758

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

#get_network_profile(params = {}) ⇒ Types::GetNetworkProfileResponse

Gets the network profile details by the network profile ARN.

Examples:

Request syntax with placeholder values


resp = client.get_network_profile({
  network_profile_arn: "Arn", # required
})

Response structure


resp.network_profile.network_profile_arn #=> String
resp.network_profile.network_profile_name #=> String
resp.network_profile.description #=> String
resp.network_profile.ssid #=> String
resp.network_profile.security_type #=> String, one of "OPEN", "WEP", "WPA_PSK", "WPA2_PSK", "WPA2_ENTERPRISE"
resp.network_profile.eap_method #=> String, one of "EAP_TLS"
resp.network_profile.current_password #=> String
resp.network_profile.next_password #=> String
resp.network_profile.certificate_authority_arn #=> String
resp.network_profile.trust_anchors #=> Array
resp.network_profile.trust_anchors[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :network_profile_arn (required, String)

    The ARN of the network profile associated with a device.

Returns:

See Also:



1796
1797
1798
1799
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 1796

def get_network_profile(params = {}, options = {})
  req = build_request(:get_network_profile, 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.is_default #=> Boolean
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.locale #=> String
resp.profile.setup_mode_disabled #=> Boolean
resp.profile.max_volume_limit #=> Integer
resp.profile.pstn_enabled #=> Boolean
resp.profile.address_book_arn #=> String

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:



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

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:



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

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:



1908
1909
1910
1911
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 1908

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:



1938
1939
1940
1941
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 1938

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

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

Lists the details of the schedules that a user configured.

Examples:

Request syntax with placeholder values


resp = client.list_business_report_schedules({
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.business_report_schedules #=> Array
resp.business_report_schedules[0].schedule_arn #=> String
resp.business_report_schedules[0].schedule_name #=> String
resp.business_report_schedules[0].s3_bucket_name #=> String
resp.business_report_schedules[0].s3_key_prefix #=> String
resp.business_report_schedules[0].format #=> String, one of "CSV", "CSV_ZIP"
resp.business_report_schedules[0].content_range.interval #=> String, one of "ONE_DAY", "ONE_WEEK"
resp.business_report_schedules[0].recurrence.start_date #=> String
resp.business_report_schedules[0].last_business_report.status #=> String, one of "RUNNING", "SUCCEEDED", "FAILED"
resp.business_report_schedules[0].last_business_report.failure_code #=> String, one of "ACCESS_DENIED", "NO_SUCH_BUCKET", "INTERNAL_FAILURE"
resp.business_report_schedules[0].last_business_report.s3_location.path #=> String
resp.business_report_schedules[0].last_business_report.s3_location.bucket_name #=> String
resp.business_report_schedules[0].last_business_report.delivery_time #=> Time
resp.business_report_schedules[0].last_business_report.download_url #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String)

    The token used to list the remaining schedules from the previous API call.

  • :max_results (Integer)

    The maximum number of schedules listed in the call.

Returns:

See Also:



1986
1987
1988
1989
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 1986

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

#list_conference_providers(params = {}) ⇒ Types::ListConferenceProvidersResponse

Lists conference providers under a specific AWS account.

Examples:

Request syntax with placeholder values


resp = client.list_conference_providers({
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.conference_providers #=> Array
resp.conference_providers[0].arn #=> String
resp.conference_providers[0].name #=> String
resp.conference_providers[0].type #=> String, one of "CHIME", "BLUEJEANS", "FUZE", "GOOGLE_HANGOUTS", "POLYCOM", "RINGCENTRAL", "SKYPE_FOR_BUSINESS", "WEBEX", "ZOOM", "CUSTOM"
resp.conference_providers[0].ip_dial_in.endpoint #=> String
resp.conference_providers[0].ip_dial_in.comms_protocol #=> String, one of "SIP", "SIPS", "H323"
resp.conference_providers[0].pstn_dial_in.country_code #=> String
resp.conference_providers[0].pstn_dial_in.phone_number #=> String
resp.conference_providers[0].pstn_dial_in.one_click_id_delay #=> String
resp.conference_providers[0].pstn_dial_in.one_click_pin_delay #=> String
resp.conference_providers[0].meeting_setting.require_pin #=> String, one of "YES", "NO", "OPTIONAL"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String)

    The tokens used for pagination.

  • :max_results (Integer)

    The maximum number of conference providers to be returned, per paginated calls.

Returns:

See Also:



2031
2032
2033
2034
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 2031

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

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

Lists the device event history, including device connection status, for up to 30 days.

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. If EventType isn't specified, 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.

  • :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. When the end of results is reached, the response has a value of null.

  • :max_results (Integer)

    The maximum number of results to include in the response. The default value is 50. 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:



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

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

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

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

Examples:

Request syntax with placeholder values


resp = client.list_gateway_groups({
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.gateway_groups #=> Array
resp.gateway_groups[0].arn #=> String
resp.gateway_groups[0].name #=> String
resp.gateway_groups[0].description #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String)

    The token used to paginate though multiple pages of gateway group summaries.

  • :max_results (Integer)

    The maximum number of gateway group summaries to return. The default is 50.

Returns:

See Also:



2127
2128
2129
2130
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 2127

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.gateways #=> Array
resp.gateways[0].arn #=> String
resp.gateways[0].name #=> String
resp.gateways[0].description #=> String
resp.gateways[0].gateway_group_arn #=> String
resp.gateways[0].software_version #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :gateway_group_arn (String)

    The gateway group ARN for which to list gateways.

  • :next_token (String)

    The token used to paginate though multiple pages of gateway summaries.

  • :max_results (Integer)

    The maximum number of gateway summaries to return. The default is 50.

Returns:

See Also:



2173
2174
2175
2176
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 2173

def list_gateways(params = {}, options = {})
  req = build_request(:list_gateways, 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",
  enablement_type: "ENABLED", # accepts ENABLED, PENDING
  skill_type: "PUBLIC", # accepts PUBLIC, PRIVATE, ALL
  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.skill_summaries[0].enablement_type #=> String, one of "ENABLED", "PENDING"
resp.skill_summaries[0].skill_type #=> String, one of "PUBLIC", "PRIVATE"
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.

  • :enablement_type (String)

    Whether the skill is enabled under the user's account, or if it requires linking to be used.

  • :skill_type (String)

    Whether the skill is publicly available or is a private skill.

  • :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:



2231
2232
2233
2234
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 2231

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

#list_skills_store_categories(params = {}) ⇒ Types::ListSkillsStoreCategoriesResponse

Lists all categories in the Alexa skill store.

Examples:

Request syntax with placeholder values


resp = client.list_skills_store_categories({
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.category_list #=> Array
resp.category_list[0].category_id #=> Integer
resp.category_list[0].category_name #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String)

    The tokens used for pagination.

  • :max_results (Integer)

    The maximum number of categories returned, per paginated calls.

Returns:

See Also:



2267
2268
2269
2270
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 2267

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

#list_skills_store_skills_by_category(params = {}) ⇒ Types::ListSkillsStoreSkillsByCategoryResponse

Lists all skills in the Alexa skill store by category.

Examples:

Request syntax with placeholder values


resp = client.list_skills_store_skills_by_category({
  category_id: 1, # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.skills_store_skills #=> Array
resp.skills_store_skills[0].skill_id #=> String
resp.skills_store_skills[0].skill_name #=> String
resp.skills_store_skills[0].short_description #=> String
resp.skills_store_skills[0].icon_url #=> String
resp.skills_store_skills[0].sample_utterances #=> Array
resp.skills_store_skills[0].sample_utterances[0] #=> String
resp.skills_store_skills[0].skill_details.product_description #=> String
resp.skills_store_skills[0].skill_details.invocation_phrase #=> String
resp.skills_store_skills[0].skill_details.release_date #=> String
resp.skills_store_skills[0].skill_details.end_user_license_agreement #=> String
resp.skills_store_skills[0].skill_details.generic_keywords #=> Array
resp.skills_store_skills[0].skill_details.generic_keywords[0] #=> String
resp.skills_store_skills[0].skill_details.bullet_points #=> Array
resp.skills_store_skills[0].skill_details.bullet_points[0] #=> String
resp.skills_store_skills[0].skill_details.new_in_this_version_bullet_points #=> Array
resp.skills_store_skills[0].skill_details.new_in_this_version_bullet_points[0] #=> String
resp.skills_store_skills[0].skill_details.skill_types #=> Array
resp.skills_store_skills[0].skill_details.skill_types[0] #=> String
resp.skills_store_skills[0].skill_details.reviews #=> Hash
resp.skills_store_skills[0].skill_details.reviews["ReviewKey"] #=> String
resp.skills_store_skills[0].skill_details.developer_info.developer_name #=> String
resp.skills_store_skills[0].skill_details.developer_info.privacy_policy #=> String
resp.skills_store_skills[0].skill_details.developer_info.email #=> String
resp.skills_store_skills[0].skill_details.developer_info.url #=> String
resp.skills_store_skills[0].supports_linking #=> Boolean
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :category_id (required, Integer)

    The category ID for which the skills are being retrieved from the skill store.

  • :next_token (String)

    The tokens used for pagination.

  • :max_results (Integer)

    The maximum number of skills returned per paginated calls.

Returns:

See Also:



2331
2332
2333
2334
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 2331

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

#list_smart_home_appliances(params = {}) ⇒ Types::ListSmartHomeAppliancesResponse

Lists all of the smart home appliances associated with a room.

Examples:

Request syntax with placeholder values


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

Response structure


resp.smart_home_appliances #=> Array
resp.smart_home_appliances[0].friendly_name #=> String
resp.smart_home_appliances[0].description #=> String
resp.smart_home_appliances[0].manufacturer_name #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :room_arn (required, String)

    The room that the appliances are associated with.

  • :max_results (Integer)

    The maximum number of appliances to be returned, per paginated calls.

  • :next_token (String)

    The tokens used for pagination.

Returns:

See Also:



2372
2373
2374
2375
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 2372

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

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

Lists all tags for the specified 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 specified resource for which to list tags.

  • :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:



2418
2419
2420
2421
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 2418

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

#put_conference_preference(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


resp = client.put_conference_preference({
  conference_preference: { # required
    default_conference_provider_arn: "Arn",
  },
})

Parameters:

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

    ({})

Options Hash (params):

Returns:

  • (Struct)

    Returns an empty response.

See Also:



2443
2444
2445
2446
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 2443

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

#put_invitation_configuration(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


resp = client.put_invitation_configuration({
  organization_name: "OrganizationName", # required
  contact_email: "Email",
  private_skill_ids: ["SkillId"],
})

Parameters:

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

    ({})

Options Hash (params):

  • :organization_name (required, String)

    The name of the organization sending the enrollment invite to a user.

  • :contact_email (String)

    The email ID of the organization or individual contact that the enrolled user can use.

  • :private_skill_ids (Array<String>)

    The list of private skill IDs that you want to recommend to the user to enable in the invitation.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



2476
2477
2478
2479
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 2476

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



2512
2513
2514
2515
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 2512

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

Examples:

Request syntax with placeholder values


resp = client.put_skill_authorization({
  authorization_result: { # required
    "Key" => "Value",
  },
  skill_id: "SkillId", # required
  room_arn: "Arn",
})

Parameters:

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

    ({})

Options Hash (params):

  • :authorization_result (required, Hash<String,String>)

    The authorization result specific to OAUTH code grant output. "Code” must be populated in the AuthorizationResult map to establish the authorization.

  • :skill_id (required, String)

    The unique identifier of a skill.

  • :room_arn (String)

    The room that the skill is authorized for.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



2549
2550
2551
2552
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 2549

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

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

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

Examples:

Request syntax with placeholder values


resp = client.register_avs_device({
  client_id: "ClientId", # required
  user_code: "UserCode", # required
  product_id: "ProductId", # required
  device_serial_number: "DeviceSerialNumberForAVS", # required
  amazon_id: "AmazonId", # required
})

Response structure


resp.device_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :client_id (required, String)

    The client ID of the OEM used for code-based linking authorization on an AVS device.

  • :user_code (required, String)

    The code that is obtained after your AVS device has made a POST request to LWA as a part of the Device Authorization Request component of the OAuth code-based linking specification.

  • :product_id (required, String)

    The product ID used to identify your AVS device during authorization.

  • :device_serial_number (required, String)

    The key generated by the OEM that uniquely identifies a specified instance of your AVS device.

  • :amazon_id (required, String)

    The device type ID for your AVS device generated by Amazon when the OEM creates a new product on Amazon's Developer Console.

Returns:

See Also:



2599
2600
2601
2602
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 2599

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

Examples:

Request syntax with placeholder values


resp = client.reject_skill({
  skill_id: "SkillId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :skill_id (required, String)

    The unique identifier of the skill.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



2624
2625
2626
2627
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 2624

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



2663
2664
2665
2666
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 2663

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:



2690
2691
2692
2693
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 2690

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:



2755
2756
2757
2758
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 2755

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.contacts[0].phone_numbers #=> Array
resp.contacts[0].phone_numbers[0].number #=> String
resp.contacts[0].phone_numbers[0].type #=> String, one of "MOBILE", "WORK", "HOME"
resp.contacts[0].sip_addresses #=> Array
resp.contacts[0].sip_addresses[0].uri #=> String
resp.contacts[0].sip_addresses[0].type #=> String, one of "WORK"
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:



2829
2830
2831
2832
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 2829

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", "FAILED"
resp.devices[0].network_profile_arn #=> String
resp.devices[0].network_profile_name #=> String
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].feature #=> String, one of "BLUETOOTH", "VOLUME", "NOTIFICATIONS", "LISTS", "SKILLS", "NETWORK_PROFILE", "SETTINGS", "ALL"
resp.devices[0].device_status_info.device_status_details[0].code #=> String, one of "DEVICE_SOFTWARE_UPDATE_NEEDED", "DEVICE_WAS_OFFLINE", "CREDENTIALS_ACCESS_FAILURE", "TLS_VERSION_MISMATCH", "ASSOCIATION_REJECTION", "AUTHENTICATION_FAILURE", "DHCP_FAILURE", "INTERNET_UNAVAILABLE", "DNS_FAILURE", "UNKNOWN_FAILURE", "CERTIFICATE_ISSUING_LIMIT_EXCEEDED", "INVALID_CERTIFICATE_AUTHORITY", "NETWORK_PROFILE_NOT_FOUND", "INVALID_PASSWORD_STATE", "PASSWORD_NOT_FOUND"
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, ConnectionStatus (ONLINE and OFFLINE), NetworkProfileName, NetworkProfileArn, Feature, and FailureCode.

  • :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, ConnectionStatus, NetworkProfileName, NetworkProfileArn, Feature, and FailureCode.

Returns:

See Also:



2912
2913
2914
2915
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 2912

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

#search_network_profiles(params = {}) ⇒ Types::SearchNetworkProfilesResponse

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

Examples:

Request syntax with placeholder values


resp = client.search_network_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.network_profiles #=> Array
resp.network_profiles[0].network_profile_arn #=> String
resp.network_profiles[0].network_profile_name #=> String
resp.network_profiles[0].description #=> String
resp.network_profiles[0].ssid #=> String
resp.network_profiles[0].security_type #=> String, one of "OPEN", "WEP", "WPA_PSK", "WPA2_PSK", "WPA2_ENTERPRISE"
resp.network_profiles[0].eap_method #=> String, one of "EAP_TLS"
resp.network_profiles[0].certificate_authority_arn #=> 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 network profiles. Valid filters are NetworkProfileName, Ssid, and SecurityType.

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

    The sort order to use to list the specified set of network profiles. Valid sort criteria includes NetworkProfileName, Ssid, and SecurityType.

Returns:

See Also:



2982
2983
2984
2985
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 2982

def search_network_profiles(params = {}, options = {})
  req = build_request(:search_network_profiles, 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].is_default #=> Boolean
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.profiles[0].locale #=> 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 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:



3054
3055
3056
3057
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 3054

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:



3123
3124
3125
3126
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 3123

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:



3189
3190
3191
3192
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 3189

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:



3260
3261
3262
3263
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 3260

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

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

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

Examples:

Request syntax with placeholder values


resp = client.send_announcement({
  room_filters: [ # required
    {
      key: "FilterKey", # required
      values: ["FilterValue"], # required
    },
  ],
  content: { # required
    text_list: [
      {
        locale: "en-US", # required, accepts en-US
        value: "TextValue", # required
      },
    ],
    ssml_list: [
      {
        locale: "en-US", # required, accepts en-US
        value: "SsmlValue", # required
      },
    ],
    audio_list: [
      {
        locale: "en-US", # required, accepts en-US
        location: "AudioLocation", # required
      },
    ],
  },
  time_to_live_in_seconds: 1,
  client_request_token: "ClientRequestToken", # required
})

Response structure


resp.announcement_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :room_filters (required, Array<Types::Filter>)

    The filters to use to send an announcement to a specified list of rooms. The supported filter keys are RoomName, ProfileName, RoomArn, and ProfileArn. To send to all rooms, specify an empty RoomFilters list.

  • :content (required, Types::Content)

    The announcement content. This can contain only one of the three possible announcement types (text, SSML or audio).

  • :time_to_live_in_seconds (Integer)

    The time to live for an announcement. Default is 300. If delivery doesn't occur within this time, the announcement is not delivered.

  • :client_request_token (required, String)

    The 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:



3334
3335
3336
3337
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 3334

def send_announcement(params = {}, options = {})
  req = build_request(:send_announcement, 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 30 days 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:



3358
3359
3360
3361
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 3358

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. This clears all information and settings set by previous users in the following ways:

  • Bluetooth - This unpairs all bluetooth devices paired with your echo device.

  • Volume - This resets the echo device's volume to the default value.

  • Notifications - This clears all notifications from your echo device.

  • Lists - This clears all to-do items from your echo device.

  • Settings - This internally syncs the room's profile (if the device is assigned to a room), contacts, address books, delegation access for account linking, and communications (if enabled on the room profile).

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, NETWORK_PROFILE, SETTINGS, 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:



3405
3406
3407
3408
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 3405

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

#start_smart_home_appliance_discovery(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


resp = client.start_smart_home_appliance_discovery({
  room_arn: "Arn", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :room_arn (required, String)

    The room where smart home appliance discovery was initiated.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



3428
3429
3430
3431
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 3428

def start_smart_home_appliance_discovery(params = {}, options = {})
  req = build_request(:start_smart_home_appliance_discovery, 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", # required
      value: "TagValue", # required
    },
  ],
})

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:



3460
3461
3462
3463
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 3460

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:



3487
3488
3489
3490
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 3487

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:



3517
3518
3519
3520
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 3517

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

#update_business_report_schedule(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


resp = client.update_business_report_schedule({
  schedule_arn: "Arn", # required
  s3_bucket_name: "CustomerS3BucketName",
  s3_key_prefix: "S3KeyPrefix",
  format: "CSV", # accepts CSV, CSV_ZIP
  schedule_name: "BusinessReportScheduleName",
  recurrence: {
    start_date: "Date",
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :schedule_arn (required, String)

    The ARN of the business report schedule.

  • :s3_bucket_name (String)

    The S3 location of the output reports.

  • :s3_key_prefix (String)

    The S3 key where the report is delivered.

  • :format (String)

    The format of the generated report (individual CSV files or zipped files of individual files).

  • :schedule_name (String)

    The name identifier of the schedule.

  • :recurrence (Types::BusinessReportRecurrence)

    The recurrence of the reports.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



3563
3564
3565
3566
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 3563

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

#update_conference_provider(params = {}) ⇒ Struct

Updates an existing conference provider's settings.

Examples:

Request syntax with placeholder values


resp = client.update_conference_provider({
  conference_provider_arn: "Arn", # required
  conference_provider_type: "CHIME", # required, accepts CHIME, BLUEJEANS, FUZE, GOOGLE_HANGOUTS, POLYCOM, RINGCENTRAL, SKYPE_FOR_BUSINESS, WEBEX, ZOOM, CUSTOM
  ip_dial_in: {
    endpoint: "Endpoint", # required
    comms_protocol: "SIP", # required, accepts SIP, SIPS, H323
  },
  pstn_dial_in: {
    country_code: "CountryCode", # required
    phone_number: "OutboundPhoneNumber", # required
    one_click_id_delay: "OneClickIdDelay", # required
    one_click_pin_delay: "OneClickPinDelay", # required
  },
  meeting_setting: { # required
    require_pin: "YES", # required, accepts YES, NO, OPTIONAL
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :conference_provider_arn (required, String)

    The ARN of the conference provider.

  • :conference_provider_type (required, String)

    The type of the conference provider.

  • :ip_dial_in (Types::IPDialIn)

    The IP endpoint and protocol for calling.

  • :pstn_dial_in (Types::PSTNDialIn)

    The information for PSTN conferencing.

  • :meeting_setting (required, Types::MeetingSetting)

    The meeting settings for the conference provider.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



3611
3612
3613
3614
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 3611

def update_conference_provider(params = {}, options = {})
  req = build_request(:update_conference_provider, 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: "RawPhoneNumber",
  phone_numbers: [
    {
      number: "RawPhoneNumber", # required
      type: "MOBILE", # required, accepts MOBILE, WORK, HOME
    },
  ],
  sip_addresses: [
    {
      uri: "SipUri", # required
      type: "WORK", # required, accepts WORK
    },
  ],
})

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. The phone number type defaults to WORK. You can either specify PhoneNumber or PhoneNumbers. We recommend that you use PhoneNumbers, which lets you specify the phone number type and multiple numbers.

  • :phone_numbers (Array<Types::PhoneNumber>)

    The list of phone numbers for the contact.

  • :sip_addresses (Array<Types::SipAddress>)

    The list of SIP addresses for the contact.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



3670
3671
3672
3673
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 3670

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:



3696
3697
3698
3699
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 3696

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

#update_gateway(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


resp = client.update_gateway({
  gateway_arn: "Arn", # required
  name: "GatewayName",
  description: "GatewayDescription",
  software_version: "GatewayVersion",
})

Parameters:

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

    ({})

Options Hash (params):

  • :gateway_arn (required, String)

    The ARN of the gateway to update.

  • :name (String)

    The updated name of the gateway.

  • :description (String)

    The updated description of the gateway.

  • :software_version (String)

    The updated software version of the gateway. The gateway automatically updates its software version during normal operation.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



3732
3733
3734
3735
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 3732

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

#update_gateway_group(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


resp = client.update_gateway_group({
  gateway_group_arn: "Arn", # required
  name: "GatewayGroupName",
  description: "GatewayGroupDescription",
})

Parameters:

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

    ({})

Options Hash (params):

  • :gateway_group_arn (required, String)

    The ARN of the gateway group to update.

  • :name (String)

    The updated name of the gateway group.

  • :description (String)

    The updated description of the gateway group.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



3763
3764
3765
3766
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 3763

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

#update_network_profile(params = {}) ⇒ Struct

Updates a network profile by the network profile ARN.

Examples:

Request syntax with placeholder values


resp = client.update_network_profile({
  network_profile_arn: "Arn", # required
  network_profile_name: "NetworkProfileName",
  description: "NetworkProfileDescription",
  current_password: "CurrentWiFiPassword",
  next_password: "NextWiFiPassword",
  certificate_authority_arn: "Arn",
  trust_anchors: ["TrustAnchor"],
})

Parameters:

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

    ({})

Options Hash (params):

  • :network_profile_arn (required, String)

    The ARN of the network profile associated with a device.

  • :network_profile_name (String)

    The name of the network profile associated with a device.

  • :description (String)

    Detailed information about a device's network profile.

  • :current_password (String)

    The current password of the Wi-Fi network.

  • :next_password (String)

    The next, or subsequent, password of the Wi-Fi network. This password is asynchronously transmitted to the device and is used when the password of the network changes to NextPassword.

  • :certificate_authority_arn (String)

    The ARN of the Private Certificate Authority (PCA) created in AWS Certificate Manager (ACM). This is used to issue certificates to the devices.

  • :trust_anchors (Array<String>)

    The root certificate(s) of your authentication server that will be installed on your devices and used to trust your authentication server during EAP negotiation.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



3815
3816
3817
3818
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 3815

def update_network_profile(params = {}, options = {})
  req = build_request(:update_network_profile, 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",
  is_default: false,
  timezone: "Timezone",
  address: "Address",
  distance_unit: "METRIC", # accepts METRIC, IMPERIAL
  temperature_unit: "FAHRENHEIT", # accepts FAHRENHEIT, CELSIUS
  wake_word: "ALEXA", # accepts ALEXA, AMAZON, ECHO, COMPUTER
  locale: "DeviceLocale",
  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.

  • :is_default (Boolean)

    Sets the profile as default if selected. If this is missing, no update is done to the default status.

  • :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.

  • :locale (String)

    The updated locale 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:



3882
3883
3884
3885
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 3882

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:



3920
3921
3922
3923
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 3920

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:



3950
3951
3952
3953
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/client.rb', line 3950

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