Class: Aws::AlexaForBusiness::Types::CreateProfileRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::AlexaForBusiness::Types::CreateProfileRequest
- Defined in:
- gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb
Overview
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
locale: "DeviceLocale",
client_request_token: "ClientRequestToken",
setup_mode_disabled: false,
max_volume_limit: 1,
pstn_enabled: false,
data_retention_opt_in: false,
meeting_room_configuration: {
room_utilization_metrics_enabled: false,
end_of_meeting_reminder: {
reminder_at_minutes: [1], # required
reminder_type: "ANNOUNCEMENT_TIME_CHECK", # required, accepts ANNOUNCEMENT_TIME_CHECK, ANNOUNCEMENT_VARIABLE_TIME_LEFT, CHIME, KNOCK
enabled: false, # required
},
instant_booking: {
duration_in_minutes: 1, # required
enabled: false, # required
},
require_check_in: {
release_after_minutes: 1, # required
enabled: false, # required
},
},
tags: [
{
key: "TagKey", # required
value: "TagValue", # required
},
],
}
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#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.
1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 |
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 1432 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.
1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 |
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 1432 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.
1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 |
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 1432 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.
1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 |
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 1432 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.)
1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 |
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 1432 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.
1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 |
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 1432 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.
1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 |
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 1432 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.
1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 |
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 1432 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.
1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 |
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 1432 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.
1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 |
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 1432 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.
1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 |
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 1432 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.
1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 |
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 1432 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.
1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 |
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 1432 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.
1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 |
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 1432 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 |