Table Of Contents

Feedback

User Guide

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

[ aws . alexaforbusiness ]

get-profile

Description

Gets the details of a room profile by profile ARN.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  get-profile
[--profile-arn <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--profile-arn (string)

The ARN of the room profile for which to request details. Required.

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

Profile -> (structure)

The details of the room profile requested. Required.

ProfileArn -> (string)

The ARN of a room profile.

ProfileName -> (string)

The name of a room profile.

IsDefault -> (boolean)

Retrieves if the profile is default or not.

Address -> (string)

The address of a room profile.

Timezone -> (string)

The time zone of a room profile.

DistanceUnit -> (string)

The distance unit of a room profile.

TemperatureUnit -> (string)

The temperature unit of a room profile.

WakeWord -> (string)

The wake word of a room profile.

SetupModeDisabled -> (boolean)

The setup mode of a room profile.

MaxVolumeLimit -> (integer)

The max volume limit of a room profile.

PSTNEnabled -> (boolean)

The PSTN setting of a room profile.

AddressBookArn -> (string)

The ARN of the address book.