CleanRoomsService / Client / list_collaborations



Lists collaborations the caller owns, is active in, or has been invited to.

See also: AWS API Documentation

Request Syntax

response = client.list_collaborations(
  • nextToken (string) – The token value retrieved from a previous call to access the next page of results.

  • maxResults (integer) – The maximum size of the results that is returned per call. Service chooses a default if it has not been set. Service may return a nextToken even if the maximum results has not been met.

  • memberStatus (string) – The caller’s status in a collaboration.

Return type:



Response Syntax

    'nextToken': 'string',
    'collaborationList': [
            'id': 'string',
            'arn': 'string',
            'name': 'string',
            'creatorAccountId': 'string',
            'creatorDisplayName': 'string',
            'createTime': datetime(2015, 1, 1),
            'updateTime': datetime(2015, 1, 1),
            'memberStatus': 'INVITED'|'ACTIVE'|'LEFT'|'REMOVED',
            'membershipId': 'string',
            'membershipArn': 'string'

Response Structure

  • (dict) –

    • nextToken (string) –

      The token value retrieved from a previous call to access the next page of results.

    • collaborationList (list) –

      The list of collaborations.

      • (dict) –

        The metadata of the collaboration.

        • id (string) –

          The identifier for the collaboration.

        • arn (string) –

          The ARN of the collaboration.

        • name (string) –

          A human-readable identifier provided by the collaboration owner. Display names are not unique.

        • creatorAccountId (string) –

          The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.

        • creatorDisplayName (string) –

          The display name of the collaboration creator.

        • createTime (datetime) –

          The time when the collaboration was created.

        • updateTime (datetime) –

          The time the collaboration metadata was last updated.

        • memberStatus (string) –

          The status of a member in a collaboration.

        • membershipId (string) –

          The identifier of a member in a collaboration.

        • membershipArn (string) –

          The ARN of a member in a collaboration.


  • CleanRoomsService.Client.exceptions.InternalServerException

  • CleanRoomsService.Client.exceptions.ValidationException

  • CleanRoomsService.Client.exceptions.ThrottlingException

  • CleanRoomsService.Client.exceptions.AccessDeniedException