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

Class: Aws::AlexaForBusiness::Types::CreateProfileRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb

Overview

Note:

When making an API call, you may pass CreateProfileRequest data as a hash:

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

Instance Attribute Summary collapse

Instance Attribute Details

#addressString

The valid address for the room.

Returns:

  • (String)


378
379
380
381
382
383
384
385
386
387
388
389
390
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 378

class CreateProfileRequest < Struct.new(
  :profile_name,
  :timezone,
  :address,
  :distance_unit,
  :temperature_unit,
  :wake_word,
  :client_request_token,
  :setup_mode_disabled,
  :max_volume_limit,
  :pstn_enabled)
  include Aws::Structure
end

#client_request_tokenString

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.

Returns:

  • (String)


378
379
380
381
382
383
384
385
386
387
388
389
390
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 378

class CreateProfileRequest < Struct.new(
  :profile_name,
  :timezone,
  :address,
  :distance_unit,
  :temperature_unit,
  :wake_word,
  :client_request_token,
  :setup_mode_disabled,
  :max_volume_limit,
  :pstn_enabled)
  include Aws::Structure
end

#distance_unitString

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

Returns:

  • (String)


378
379
380
381
382
383
384
385
386
387
388
389
390
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 378

class CreateProfileRequest < Struct.new(
  :profile_name,
  :timezone,
  :address,
  :distance_unit,
  :temperature_unit,
  :wake_word,
  :client_request_token,
  :setup_mode_disabled,
  :max_volume_limit,
  :pstn_enabled)
  include Aws::Structure
end

#max_volume_limitInteger

The maximum volume limit for a room profile.

Returns:

  • (Integer)


378
379
380
381
382
383
384
385
386
387
388
389
390
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 378

class CreateProfileRequest < Struct.new(
  :profile_name,
  :timezone,
  :address,
  :distance_unit,
  :temperature_unit,
  :wake_word,
  :client_request_token,
  :setup_mode_disabled,
  :max_volume_limit,
  :pstn_enabled)
  include Aws::Structure
end

#profile_nameString

The name of a room profile.

Returns:

  • (String)


378
379
380
381
382
383
384
385
386
387
388
389
390
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 378

class CreateProfileRequest < Struct.new(
  :profile_name,
  :timezone,
  :address,
  :distance_unit,
  :temperature_unit,
  :wake_word,
  :client_request_token,
  :setup_mode_disabled,
  :max_volume_limit,
  :pstn_enabled)
  include Aws::Structure
end

#pstn_enabledBoolean

Whether PSTN calling is enabled.

Returns:

  • (Boolean)


378
379
380
381
382
383
384
385
386
387
388
389
390
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 378

class CreateProfileRequest < Struct.new(
  :profile_name,
  :timezone,
  :address,
  :distance_unit,
  :temperature_unit,
  :wake_word,
  :client_request_token,
  :setup_mode_disabled,
  :max_volume_limit,
  :pstn_enabled)
  include Aws::Structure
end

#setup_mode_disabledBoolean

Whether room profile setup is enabled.

Returns:

  • (Boolean)


378
379
380
381
382
383
384
385
386
387
388
389
390
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 378

class CreateProfileRequest < Struct.new(
  :profile_name,
  :timezone,
  :address,
  :distance_unit,
  :temperature_unit,
  :wake_word,
  :client_request_token,
  :setup_mode_disabled,
  :max_volume_limit,
  :pstn_enabled)
  include Aws::Structure
end

#temperature_unitString

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

Returns:

  • (String)


378
379
380
381
382
383
384
385
386
387
388
389
390
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 378

class CreateProfileRequest < Struct.new(
  :profile_name,
  :timezone,
  :address,
  :distance_unit,
  :temperature_unit,
  :wake_word,
  :client_request_token,
  :setup_mode_disabled,
  :max_volume_limit,
  :pstn_enabled)
  include Aws::Structure
end

#timezoneString

The time zone used by a room profile.

Returns:

  • (String)


378
379
380
381
382
383
384
385
386
387
388
389
390
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 378

class CreateProfileRequest < Struct.new(
  :profile_name,
  :timezone,
  :address,
  :distance_unit,
  :temperature_unit,
  :wake_word,
  :client_request_token,
  :setup_mode_disabled,
  :max_volume_limit,
  :pstn_enabled)
  include Aws::Structure
end

#wake_wordString

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

Returns:

  • (String)


378
379
380
381
382
383
384
385
386
387
388
389
390
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 378

class CreateProfileRequest < Struct.new(
  :profile_name,
  :timezone,
  :address,
  :distance_unit,
  :temperature_unit,
  :wake_word,
  :client_request_token,
  :setup_mode_disabled,
  :max_volume_limit,
  :pstn_enabled)
  include Aws::Structure
end