Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . alexaforbusiness ]

create-profile

Description

Creates a new room profile with the specified details.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  create-profile
--profile-name <value>
--timezone <value>
--address <value>
--distance-unit <value>
--temperature-unit <value>
--wake-word <value>
[--locale <value>]
[--client-request-token <value>]
[--setup-mode-disabled | --no-setup-mode-disabled]
[--max-volume-limit <value>]
[--pstn-enabled | --no-pstn-enabled]
[--meeting-room-configuration <value>]
[--tags <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--profile-name (string)

The name of a room profile.

--timezone (string)

The time zone used by a room profile.

--address (string)

The valid address for the room.

--distance-unit (string)

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

Possible values:

  • METRIC
  • IMPERIAL

--temperature-unit (string)

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

Possible values:

  • FAHRENHEIT
  • CELSIUS

--wake-word (string)

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

Possible values:

  • ALEXA
  • AMAZON
  • ECHO
  • COMPUTER

--locale (string)

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

--client-request-token (string)

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

--setup-mode-disabled | --no-setup-mode-disabled (boolean)

Whether room profile setup is enabled.

--max-volume-limit (integer)

The maximum volume limit for a room profile.

--pstn-enabled | --no-pstn-enabled (boolean)

Whether PSTN calling is enabled.

--meeting-room-configuration (structure)

The meeting room settings of a room profile.

RoomUtilizationMetricsEnabled -> (boolean)

Whether room utilization metrics are enabled or not.

EndOfMeetingReminder -> (structure)

Creates settings for the end of meeting reminder feature that are applied to a room profile. The end of meeting reminder enables Alexa to remind users when a meeting is ending.

ReminderAtMinutes -> (list)

A range of 3 to 15 minutes that determines when the reminder begins.

(integer)

ReminderType -> (string)

The type of sound that users hear during the end of meeting reminder.

Enabled -> (boolean)

Whether an end of meeting reminder is enabled or not.

InstantBooking -> (structure)

Settings to automatically book a room for a configured duration if it's free when joining a meeting with Alexa.

DurationInMinutes -> (integer)

Duration between 15 and 240 minutes at increments of 15 that determines how long to book an available room when a meeting is started with Alexa.

Enabled -> (boolean)

Whether instant booking is enabled or not.

RequireCheckIn -> (structure)

Settings for requiring a check in when a room is reserved. Alexa can cancel a room reservation if it's not checked into to make the room available for others. Users can check in by joining the meeting with Alexa or an AVS device, or by saying “Alexa, check in.”

ReleaseAfterMinutes -> (integer)

Duration between 5 and 20 minutes to determine when to release the room if it's not checked into.

Enabled -> (boolean)

Whether require check in is enabled or not.

Shorthand Syntax:

RoomUtilizationMetricsEnabled=boolean,EndOfMeetingReminder={ReminderAtMinutes=[integer,integer],ReminderType=string,Enabled=boolean},InstantBooking={DurationInMinutes=integer,Enabled=boolean},RequireCheckIn={ReleaseAfterMinutes=integer,Enabled=boolean}

JSON Syntax:

{
  "RoomUtilizationMetricsEnabled": true|false,
  "EndOfMeetingReminder": {
    "ReminderAtMinutes": [integer, ...],
    "ReminderType": "ANNOUNCEMENT_TIME_CHECK"|"ANNOUNCEMENT_VARIABLE_TIME_LEFT"|"CHIME"|"KNOCK",
    "Enabled": true|false
  },
  "InstantBooking": {
    "DurationInMinutes": integer,
    "Enabled": true|false
  },
  "RequireCheckIn": {
    "ReleaseAfterMinutes": integer,
    "Enabled": true|false
  }
}

--tags (list)

The tags for the profile.

(structure)

A key-value pair that can be associated with a resource.

Key -> (string)

The key of a tag. Tag keys are case-sensitive.

Value -> (string)

The value of a tag. Tag values are case sensitive and can be null.

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

ProfileArn -> (string)

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