Menu
Alexa For Business
Alexa for Business API (API Version 2017-11-09)

CreateProfile

Creates a new room profile with the specified details.

Request Syntax

{
   "Address": "string",
   "ClientRequestToken": "string",
   "DistanceUnit": "string",
   "MaxVolumeLimit": number,
   "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 valid address for the room.

Type: String

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

Required: Yes

ClientRequestToken

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

Type: String

Length Constraints: Minimum length of 10. Maximum length of 150.

Pattern: [a-zA-Z0-9][a-zA-Z0-9_-]*

Required: No

DistanceUnit

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

Type: String

Valid Values: METRIC | IMPERIAL

Required: Yes

MaxVolumeLimit

The maximum volume limit for a room profile.

Type: Integer

Required: No

ProfileName

The name of a 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: Yes

PSTNEnabled

Whether PSTN calling is enabled.

Type: Boolean

Required: No

SetupModeDisabled

Whether room profile setup is enabled.

Type: Boolean

Required: No

TemperatureUnit

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

Type: String

Valid Values: FAHRENHEIT | CELSIUS

Required: Yes

Timezone

The time zone used by a room profile.

Type: String

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

Required: Yes

WakeWord

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

Type: String

Valid Values: ALEXA | AMAZON | ECHO | COMPUTER

Required: Yes

Response Syntax

{
   "ProfileArn": "string"
}

Response Elements

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

The following data is returned in JSON format by the service.

ProfileArn

The ARN of the newly created room profile in the response.

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}

Errors

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

AlreadyExistsException

The resource being created already exists. HTTP Status Code: 400

HTTP Status Code: 400

LimitExceededException

You are performing an action that would put you beyond your account's limits. HTTP Status Code: 400

HTTP Status Code: 400

See Also

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