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

Inherits:

Struct

• Object
• Struct
• Aws::AlexaForBusiness::Types::CreateProfileRequest

Includes:

Structure

Defined in:

lib/aws-sdk-alexaforbusiness/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #address ⇒ String

  The valid address for the room.

• #client_request_token ⇒ String

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

• #data_retention_opt_in ⇒ Boolean

  Whether data retention of the profile is enabled.

• #distance_unit ⇒ String

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

• #locale ⇒ String

  The locale of the room profile.

• #max_volume_limit ⇒ Integer

  The maximum volume limit for a room profile.

• #meeting_room_configuration ⇒ Types::CreateMeetingRoomConfiguration

  The meeting room settings of a room profile.

• #profile_name ⇒ String

  The name of a room profile.

• #pstn_enabled ⇒ Boolean

  Whether PSTN calling is enabled.

• #setup_mode_disabled ⇒ Boolean

  Whether room profile setup is enabled.

• #tags ⇒ Array<Types::Tag>

  The tags for the profile.

• #temperature_unit ⇒ String

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

• #timezone ⇒ String

  The time zone used by a room profile.

• #wake_word ⇒ String

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

Instance Attribute Details

#address ⇒ String

The valid address for the room.

Returns:

• (String)

# File 'lib/aws-sdk-alexaforbusiness/types.rb', line 1131

class CreateProfileRequest < Struct.new(
  :profile_name,
  :timezone,
  :address,
  :distance_unit,
  :temperature_unit,
  :wake_word,
  :locale,
  :client_request_token,
  :setup_mode_disabled,
  :max_volume_limit,
  :pstn_enabled,
  :data_retention_opt_in,
  :meeting_room_configuration,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

• (String)

# File 'lib/aws-sdk-alexaforbusiness/types.rb', line 1131

class CreateProfileRequest < Struct.new(
  :profile_name,
  :timezone,
  :address,
  :distance_unit,
  :temperature_unit,
  :wake_word,
  :locale,
  :client_request_token,
  :setup_mode_disabled,
  :max_volume_limit,
  :pstn_enabled,
  :data_retention_opt_in,
  :meeting_room_configuration,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#data_retention_opt_in ⇒ Boolean

Whether data retention of the profile is enabled.

Returns:

• (Boolean)

# File 'lib/aws-sdk-alexaforbusiness/types.rb', line 1131

class CreateProfileRequest < Struct.new(
  :profile_name,
  :timezone,
  :address,
  :distance_unit,
  :temperature_unit,
  :wake_word,
  :locale,
  :client_request_token,
  :setup_mode_disabled,
  :max_volume_limit,
  :pstn_enabled,
  :data_retention_opt_in,
  :meeting_room_configuration,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#distance_unit ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-alexaforbusiness/types.rb', line 1131

class CreateProfileRequest < Struct.new(
  :profile_name,
  :timezone,
  :address,
  :distance_unit,
  :temperature_unit,
  :wake_word,
  :locale,
  :client_request_token,
  :setup_mode_disabled,
  :max_volume_limit,
  :pstn_enabled,
  :data_retention_opt_in,
  :meeting_room_configuration,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#locale ⇒ String

The locale of the room profile. (This is currently only available to a limited preview audience.)

Returns:

• (String)

# File 'lib/aws-sdk-alexaforbusiness/types.rb', line 1131

class CreateProfileRequest < Struct.new(
  :profile_name,
  :timezone,
  :address,
  :distance_unit,
  :temperature_unit,
  :wake_word,
  :locale,
  :client_request_token,
  :setup_mode_disabled,
  :max_volume_limit,
  :pstn_enabled,
  :data_retention_opt_in,
  :meeting_room_configuration,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#max_volume_limit ⇒ Integer

The maximum volume limit for a room profile.

Returns:

• (Integer)

# File 'lib/aws-sdk-alexaforbusiness/types.rb', line 1131

class CreateProfileRequest < Struct.new(
  :profile_name,
  :timezone,
  :address,
  :distance_unit,
  :temperature_unit,
  :wake_word,
  :locale,
  :client_request_token,
  :setup_mode_disabled,
  :max_volume_limit,
  :pstn_enabled,
  :data_retention_opt_in,
  :meeting_room_configuration,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#meeting_room_configuration ⇒ Types::CreateMeetingRoomConfiguration

The meeting room settings of a room profile.

Returns:

• (Types::CreateMeetingRoomConfiguration)

# File 'lib/aws-sdk-alexaforbusiness/types.rb', line 1131

class CreateProfileRequest < Struct.new(
  :profile_name,
  :timezone,
  :address,
  :distance_unit,
  :temperature_unit,
  :wake_word,
  :locale,
  :client_request_token,
  :setup_mode_disabled,
  :max_volume_limit,
  :pstn_enabled,
  :data_retention_opt_in,
  :meeting_room_configuration,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#profile_name ⇒ String

The name of a room profile.

Returns:

• (String)

# File 'lib/aws-sdk-alexaforbusiness/types.rb', line 1131

class CreateProfileRequest < Struct.new(
  :profile_name,
  :timezone,
  :address,
  :distance_unit,
  :temperature_unit,
  :wake_word,
  :locale,
  :client_request_token,
  :setup_mode_disabled,
  :max_volume_limit,
  :pstn_enabled,
  :data_retention_opt_in,
  :meeting_room_configuration,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#pstn_enabled ⇒ Boolean

Whether PSTN calling is enabled.

Returns:

• (Boolean)

# File 'lib/aws-sdk-alexaforbusiness/types.rb', line 1131

class CreateProfileRequest < Struct.new(
  :profile_name,
  :timezone,
  :address,
  :distance_unit,
  :temperature_unit,
  :wake_word,
  :locale,
  :client_request_token,
  :setup_mode_disabled,
  :max_volume_limit,
  :pstn_enabled,
  :data_retention_opt_in,
  :meeting_room_configuration,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#setup_mode_disabled ⇒ Boolean

Whether room profile setup is enabled.

Returns:

• (Boolean)

# File 'lib/aws-sdk-alexaforbusiness/types.rb', line 1131

class CreateProfileRequest < Struct.new(
  :profile_name,
  :timezone,
  :address,
  :distance_unit,
  :temperature_unit,
  :wake_word,
  :locale,
  :client_request_token,
  :setup_mode_disabled,
  :max_volume_limit,
  :pstn_enabled,
  :data_retention_opt_in,
  :meeting_room_configuration,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

The tags for the profile.

Returns:

• (Array<Types::Tag>)

# File 'lib/aws-sdk-alexaforbusiness/types.rb', line 1131

class CreateProfileRequest < Struct.new(
  :profile_name,
  :timezone,
  :address,
  :distance_unit,
  :temperature_unit,
  :wake_word,
  :locale,
  :client_request_token,
  :setup_mode_disabled,
  :max_volume_limit,
  :pstn_enabled,
  :data_retention_opt_in,
  :meeting_room_configuration,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#temperature_unit ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-alexaforbusiness/types.rb', line 1131

class CreateProfileRequest < Struct.new(
  :profile_name,
  :timezone,
  :address,
  :distance_unit,
  :temperature_unit,
  :wake_word,
  :locale,
  :client_request_token,
  :setup_mode_disabled,
  :max_volume_limit,
  :pstn_enabled,
  :data_retention_opt_in,
  :meeting_room_configuration,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#timezone ⇒ String

The time zone used by a room profile.

Returns:

• (String)

# File 'lib/aws-sdk-alexaforbusiness/types.rb', line 1131

class CreateProfileRequest < Struct.new(
  :profile_name,
  :timezone,
  :address,
  :distance_unit,
  :temperature_unit,
  :wake_word,
  :locale,
  :client_request_token,
  :setup_mode_disabled,
  :max_volume_limit,
  :pstn_enabled,
  :data_retention_opt_in,
  :meeting_room_configuration,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#wake_word ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-alexaforbusiness/types.rb', line 1131

class CreateProfileRequest < Struct.new(
  :profile_name,
  :timezone,
  :address,
  :distance_unit,
  :temperature_unit,
  :wake_word,
  :locale,
  :client_request_token,
  :setup_mode_disabled,
  :max_volume_limit,
  :pstn_enabled,
  :data_retention_opt_in,
  :meeting_room_configuration,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end