Chime / Client / get_room

get_room#

Chime.Client.get_room(**kwargs)#

Retrieves room details, such as the room name, for a room in an Amazon Chime Enterprise account.

See also: AWS API Documentation

Request Syntax

response = client.get_room(
    AccountId='string',
    RoomId='string'
)
Parameters:
  • AccountId (string) –

    [REQUIRED]

    The Amazon Chime account ID.

  • RoomId (string) –

    [REQUIRED]

    The room ID.

Return type:

dict

Returns:

Response Syntax

{
    'Room': {
        'RoomId': 'string',
        'Name': 'string',
        'AccountId': 'string',
        'CreatedBy': 'string',
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) –

    • Room (dict) –

      The room details.

      • RoomId (string) –

        The room ID.

      • Name (string) –

        The room name.

      • AccountId (string) –

        The Amazon Chime account ID.

      • CreatedBy (string) –

        The identifier of the room creator.

      • CreatedTimestamp (datetime) –

        The room creation timestamp, in ISO 8601 format.

      • UpdatedTimestamp (datetime) –

        The room update timestamp, in ISO 8601 format.

Exceptions

  • Chime.Client.exceptions.BadRequestException

  • Chime.Client.exceptions.ForbiddenException

  • Chime.Client.exceptions.NotFoundException

  • Chime.Client.exceptions.UnauthorizedClientException

  • Chime.Client.exceptions.ThrottledClientException

  • Chime.Client.exceptions.ServiceUnavailableException

  • Chime.Client.exceptions.ServiceFailureException