Chime / Client / update_room_membership

update_room_membership

Chime.Client.update_room_membership(**kwargs)

Updates room membership details, such as the member role, for a room in an Amazon Chime Enterprise account. The member role designates whether the member is a chat room administrator or a general chat room member. The member role can be updated only for user IDs.

See also: AWS API Documentation

Request Syntax

response = client.update_room_membership(
    AccountId='string',
    RoomId='string',
    MemberId='string',
    Role='Administrator'|'Member'
)

Parameters:

• AccountId (string) –

  [REQUIRED]

  The Amazon Chime account ID.

• RoomId (string) –

  [REQUIRED]

  The room ID.

• MemberId (string) –

  [REQUIRED]

  The member ID.

• Role (string) – The role of the member.

Return type:

dict

Returns:

Response Syntax

{
    'RoomMembership': {
        'RoomId': 'string',
        'Member': {
            'MemberId': 'string',
            'MemberType': 'User'|'Bot'|'Webhook',
            'Email': 'string',
            'FullName': 'string',
            'AccountId': 'string'
        },
        'Role': 'Administrator'|'Member',
        'InvitedBy': 'string',
        'UpdatedTimestamp': datetime(2015, 1, 1)
    }
}

Response Structure

• (dict) –

  • RoomMembership (dict) –

    The room membership details.

    • RoomId (string) –

      The room ID.

    • Member (dict) –

      The member details, such as email address, name, member ID, and member type.

      • MemberId (string) –

        The member ID (user ID or bot ID).

      • MemberType (string) –

        The member type.

      • Email (string) –

        The member email address.

      • FullName (string) –

        The member name.

      • AccountId (string) –

        The Amazon Chime account ID.

    • Role (string) –

      The membership role.

    • InvitedBy (string) –

      The identifier of the user that invited the room member.

    • UpdatedTimestamp (datetime) –

      The room membership update timestamp, in ISO 8601 format.

Exceptions

• Chime.Client.exceptions.UnauthorizedClientException

• Chime.Client.exceptions.NotFoundException

• Chime.Client.exceptions.BadRequestException

• Chime.Client.exceptions.ForbiddenException

• Chime.Client.exceptions.ThrottledClientException

• Chime.Client.exceptions.ServiceUnavailableException

• Chime.Client.exceptions.ServiceFailureException