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

Class: Aws::AlexaForBusiness::Types::UpdateProfileRequest

Inherits:

Struct

• Object
• Struct
• Aws::AlexaForBusiness::Types::UpdateProfileRequest

Defined in:

gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb

Overview

Note:

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

{
  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,
}

See Also:

• AWS API Documentation

Instance Attribute Summary

• #address ⇒ String

  The updated address for the room profile.

• #distance_unit ⇒ String

  The updated distance unit for the room profile.

• #is_default ⇒ Boolean

  Sets the profile as default if selected.

• #locale ⇒ String

  The updated locale for the room profile.

• #max_volume_limit ⇒ Integer

  The updated maximum volume limit for the room profile.

• #profile_arn ⇒ String

  The ARN of the room profile to update.

• #profile_name ⇒ String

  The updated name for the room profile.

• #pstn_enabled ⇒ Boolean

  Whether the PSTN setting of the room profile is enabled.

• #setup_mode_disabled ⇒ Boolean

  Whether the setup mode of the profile is enabled.

• #temperature_unit ⇒ String

  The updated temperature unit for the room profile.

• #timezone ⇒ String

  The updated timezone for the room profile.

• #wake_word ⇒ String

  The updated wake word for the room profile.

Instance Attribute Details

#address ⇒ String

The updated address for the room profile.

Returns:

• (String)

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

class UpdateProfileRequest < Struct.new(
  :profile_arn,
  :profile_name,
  :is_default,
  :timezone,
  :address,
  :distance_unit,
  :temperature_unit,
  :wake_word,
  :locale,
  :setup_mode_disabled,
  :max_volume_limit,
  :pstn_enabled)
  include Aws::Structure
end

#distance_unit ⇒ String

The updated distance unit for the room profile.

Returns:

• (String)

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

class UpdateProfileRequest < Struct.new(
  :profile_arn,
  :profile_name,
  :is_default,
  :timezone,
  :address,
  :distance_unit,
  :temperature_unit,
  :wake_word,
  :locale,
  :setup_mode_disabled,
  :max_volume_limit,
  :pstn_enabled)
  include Aws::Structure
end

#is_default ⇒ Boolean

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

Returns:

• (Boolean)

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

class UpdateProfileRequest < Struct.new(
  :profile_arn,
  :profile_name,
  :is_default,
  :timezone,
  :address,
  :distance_unit,
  :temperature_unit,
  :wake_word,
  :locale,
  :setup_mode_disabled,
  :max_volume_limit,
  :pstn_enabled)
  include Aws::Structure
end

#locale ⇒ String

The updated locale for the room profile.

Returns:

• (String)

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

class UpdateProfileRequest < Struct.new(
  :profile_arn,
  :profile_name,
  :is_default,
  :timezone,
  :address,
  :distance_unit,
  :temperature_unit,
  :wake_word,
  :locale,
  :setup_mode_disabled,
  :max_volume_limit,
  :pstn_enabled)
  include Aws::Structure
end

#max_volume_limit ⇒ Integer

The updated maximum volume limit for the room profile.

Returns:

• (Integer)

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

class UpdateProfileRequest < Struct.new(
  :profile_arn,
  :profile_name,
  :is_default,
  :timezone,
  :address,
  :distance_unit,
  :temperature_unit,
  :wake_word,
  :locale,
  :setup_mode_disabled,
  :max_volume_limit,
  :pstn_enabled)
  include Aws::Structure
end

#profile_arn ⇒ String

The ARN of the room profile to update. Required.

Returns:

• (String)

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

class UpdateProfileRequest < Struct.new(
  :profile_arn,
  :profile_name,
  :is_default,
  :timezone,
  :address,
  :distance_unit,
  :temperature_unit,
  :wake_word,
  :locale,
  :setup_mode_disabled,
  :max_volume_limit,
  :pstn_enabled)
  include Aws::Structure
end

#profile_name ⇒ String

The updated name for the room profile.

Returns:

• (String)

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

class UpdateProfileRequest < Struct.new(
  :profile_arn,
  :profile_name,
  :is_default,
  :timezone,
  :address,
  :distance_unit,
  :temperature_unit,
  :wake_word,
  :locale,
  :setup_mode_disabled,
  :max_volume_limit,
  :pstn_enabled)
  include Aws::Structure
end

#pstn_enabled ⇒ Boolean

Whether the PSTN setting of the room profile is enabled.

Returns:

• (Boolean)

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

class UpdateProfileRequest < Struct.new(
  :profile_arn,
  :profile_name,
  :is_default,
  :timezone,
  :address,
  :distance_unit,
  :temperature_unit,
  :wake_word,
  :locale,
  :setup_mode_disabled,
  :max_volume_limit,
  :pstn_enabled)
  include Aws::Structure
end

#setup_mode_disabled ⇒ Boolean

Whether the setup mode of the profile is enabled.

Returns:

• (Boolean)

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

class UpdateProfileRequest < Struct.new(
  :profile_arn,
  :profile_name,
  :is_default,
  :timezone,
  :address,
  :distance_unit,
  :temperature_unit,
  :wake_word,
  :locale,
  :setup_mode_disabled,
  :max_volume_limit,
  :pstn_enabled)
  include Aws::Structure
end

#temperature_unit ⇒ String

The updated temperature unit for the room profile.

Returns:

• (String)

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

class UpdateProfileRequest < Struct.new(
  :profile_arn,
  :profile_name,
  :is_default,
  :timezone,
  :address,
  :distance_unit,
  :temperature_unit,
  :wake_word,
  :locale,
  :setup_mode_disabled,
  :max_volume_limit,
  :pstn_enabled)
  include Aws::Structure
end

#timezone ⇒ String

The updated timezone for the room profile.

Returns:

• (String)

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

class UpdateProfileRequest < Struct.new(
  :profile_arn,
  :profile_name,
  :is_default,
  :timezone,
  :address,
  :distance_unit,
  :temperature_unit,
  :wake_word,
  :locale,
  :setup_mode_disabled,
  :max_volume_limit,
  :pstn_enabled)
  include Aws::Structure
end

#wake_word ⇒ String

The updated wake word for the room profile.

Returns:

• (String)

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

class UpdateProfileRequest < Struct.new(
  :profile_arn,
  :profile_name,
  :is_default,
  :timezone,
  :address,
  :distance_unit,
  :temperature_unit,
  :wake_word,
  :locale,
  :setup_mode_disabled,
  :max_volume_limit,
  :pstn_enabled)
  include Aws::Structure
end