[ aws . alexaforbusiness ]

get-room

Description

Gets room details by room ARN.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-room
[--room-arn <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--room-arn (string)

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

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

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Output

Room -> (structure)

The details of the room requested.

RoomArn -> (string)

The ARN of a room.

RoomName -> (string)

The name of a room.

Description -> (string)

The description of a room.

ProviderCalendarId -> (string)

The provider calendar ARN of a room.

ProfileArn -> (string)

The profile ARN of a room.