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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateProfileRequest as input to an Aws::Client method, you can use a vanilla 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,
  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
    },
  ],
}

Instance Attribute Summary collapse

Instance Attribute Details

#addressString

The valid address for the room.

Returns:

  • (String)

    The valid address for the room.

#client_request_tokenString

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

Returns:

  • (String)

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

#distance_unitString

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

Possible values:

  • METRIC
  • IMPERIAL

Returns:

  • (String)

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

#localeString

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

Returns:

  • (String)

    The locale of the room profile.

#max_volume_limitInteger

The maximum volume limit for a room profile.

Returns:

  • (Integer)

    The maximum volume limit for a room profile.

#meeting_room_configurationTypes::CreateMeetingRoomConfiguration

The meeting room settings of a room profile.

Returns:

#profile_nameString

The name of a room profile.

Returns:

  • (String)

    The name of a room profile.

#pstn_enabledBoolean

Whether PSTN calling is enabled.

Returns:

  • (Boolean)

    Whether PSTN calling is enabled.

#setup_mode_disabledBoolean

Whether room profile setup is enabled.

Returns:

  • (Boolean)

    Whether room profile setup is enabled.

#tagsArray<Types::Tag>

The tags for the profile.

Returns:

  • (Array<Types::Tag>)

    The tags for the profile.

#temperature_unitString

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

Possible values:

  • FAHRENHEIT
  • CELSIUS

Returns:

  • (String)

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

#timezoneString

The time zone used by a room profile.

Returns:

  • (String)

    The time zone used by a room profile.

#wake_wordString

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

Possible values:

  • ALEXA
  • AMAZON
  • ECHO
  • COMPUTER

Returns:

  • (String)

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