AlexaForBusiness / Client / get_room

get_room#

AlexaForBusiness.Client.get_room(**kwargs)#

Gets room details by room ARN.

See also: AWS API Documentation

Request Syntax

response = client.get_room(
    RoomArn='string'
)
Parameters:

RoomArn (string) – The ARN of the room for which to request details. Required.

Return type:

dict

Returns:

Response Syntax

{
    'Room': {
        'RoomArn': 'string',
        'RoomName': 'string',
        'Description': 'string',
        'ProviderCalendarId': 'string',
        'ProfileArn': 'string'
    }
}

Response Structure

  • (dict) –

    • Room (dict) –

      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.

Exceptions

  • AlexaForBusiness.Client.exceptions.NotFoundException