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 ]

update-profile

Description

Updates an existing room profile by room profile ARN.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  update-profile
[--profile-arn <value>]
[--profile-name <value>]
[--is-default | --no-is-default]
[--timezone <value>]
[--address <value>]
[--distance-unit <value>]
[--temperature-unit <value>]
[--wake-word <value>]
[--locale <value>]
[--setup-mode-disabled | --no-setup-mode-disabled]
[--max-volume-limit <value>]
[--pstn-enabled | --no-pstn-enabled]
[--meeting-room-configuration <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--profile-arn (string)

The ARN of the room profile to update. Required.

--profile-name (string)

The updated name for the room profile.

--is-default | --no-is-default (boolean)

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

--timezone (string)

The updated timezone for the room profile.

--address (string)

The updated address for the room profile.

--distance-unit (string)

The updated distance unit for the room profile.

Possible values:

  • METRIC
  • IMPERIAL

--temperature-unit (string)

The updated temperature unit for the room profile.

Possible values:

  • FAHRENHEIT
  • CELSIUS

--wake-word (string)

The updated wake word for the room profile.

Possible values:

  • ALEXA
  • AMAZON
  • ECHO
  • COMPUTER

--locale (string)

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

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

Whether the setup mode of the profile is enabled.

--max-volume-limit (integer)

The updated maximum volume limit for the room profile.

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

Whether the PSTN setting of the room profile is enabled.

--meeting-room-configuration (structure)

The updated meeting room settings of a room profile.

RoomUtilizationMetricsEnabled -> (boolean)

Whether room utilization metrics are enabled or not.

EndOfMeetingReminder -> (structure)

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)

Updates 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.

(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 an available room available for a configured duration 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
  }
}

--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

None