update-profile¶

Description¶

Updates an existing room profile by room profile ARN.

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]
[--data-retention-opt-in | --no-data-retention-opt-in]
[--meeting-room-configuration <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

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.

--data-retention-opt-in | --no-data-retention-opt-in (boolean)

Whether data retention of the 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 | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

json
text
table
yaml
yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output¶

None

Table of Contents

Feedback

User Guide