Sign In to the Console
Alexa For Business
Alexa for Business API (API Version 2017-11-09)

AWS Documentation » Alexa for Business » Alexa for Business API » Actions » UpdateProfile

UpdateProfile

Updates an existing room profile by room profile ARN.

Request Syntax

{
   "Address": "string",
   "DistanceUnit": "string",
   "IsDefault": boolean,
   "MaxVolumeLimit": number,
   "ProfileArn": "string",
   "ProfileName": "string",
   "PSTNEnabled": boolean,
   "SetupModeDisabled": boolean,
   "TemperatureUnit": "string",
   "Timezone": "string",
   "WakeWord": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Address

The updated address for the room profile.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 500.

Required: No

DistanceUnit

The updated distance unit for the room profile.

Type: String

Valid Values: METRIC | IMPERIAL

Required: No

IsDefault

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

Type: Boolean

Required: No

MaxVolumeLimit

The updated maximum volume limit for the room profile.

Type: Integer

Required: No

ProfileArn

The ARN of the room profile to update. Required.

Type: String

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

Required: No

ProfileName

The updated name for the room profile.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [\u0009\u000A\u000D\u0020-\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]*

Required: No

PSTNEnabled

Whether the PSTN setting of the room profile is enabled.

Type: Boolean

Required: No

SetupModeDisabled

Whether the setup mode of the profile is enabled.

Type: Boolean

Required: No

TemperatureUnit

The updated temperature unit for the room profile.

Type: String

Valid Values: FAHRENHEIT | CELSIUS

Required: No

Timezone

The updated timezone for the room profile.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Required: No

WakeWord

The updated wake word for the room profile.

Type: String

Valid Values: ALEXA | AMAZON | ECHO | COMPUTER

Required: No

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors.

ConcurrentModificationException

There is a concurrent modification of resources.

HTTP Status Code: 400

NameInUseException

The name sent in the request is already in use.

HTTP Status Code: 400

NotFoundException

The resource is not found.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: