CleanRoomsService / Client / list_members

list_members#

CleanRoomsService.Client.list_members(**kwargs)#

Lists all members within a collaboration.

See also: AWS API Documentation

Request Syntax

response = client.list_members(
    collaborationIdentifier='string',
    nextToken='string',
    maxResults=123
)
Parameters:

  • collaborationIdentifier (string) –

    [REQUIRED]

    The identifier of the collaboration in which the members are listed.

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

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'memberSummaries': [
        {
            'accountId': 'string',
            'status': 'INVITED'|'ACTIVE'|'LEFT'|'REMOVED',
            'displayName': 'string',
            'abilities': [
                'CAN_QUERY'|'CAN_RECEIVE_RESULTS',
            ],
            'createTime': datetime(2015, 1, 1),
            'updateTime': datetime(2015, 1, 1),
            'membershipId': 'string',
            'membershipArn': 'string',
            'paymentConfiguration': {
                'queryCompute': {
                    'isResponsible': True|False
                }
            }
        },
    ]
}

Response Structure

  • (dict) –

    • nextToken (string) –

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

    • memberSummaries (list) –

      The list of members returned by the ListMembers operation.

      • (dict) –

        The member object listed by the request.

        • accountId (string) –

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

        • status (string) –

          The status of the member.

        • displayName (string) –

          The member’s display name.

        • abilities (list) –

          The abilities granted to the collaboration member.

          • (string) –

        • createTime (datetime) –

          The time when the member was created.

        • updateTime (datetime) –

          The time the member metadata was last updated.

        • membershipId (string) –

          The unique ID for the member’s associated membership, if present.

        • membershipArn (string) –

          The unique ARN for the member’s associated membership, if present.

        • paymentConfiguration (dict) –

          The collaboration member’s payment responsibilities set by the collaboration creator.

          • queryCompute (dict) –

            The collaboration member’s payment responsibilities set by the collaboration creator for query compute costs.

            • isResponsible (boolean) –

              Indicates whether the collaboration creator has configured the collaboration member to pay for query compute costs ( TRUE) or has not configured the collaboration member to pay for query compute costs ( FALSE).

              Exactly one member can be configured to pay for query compute costs. An error is returned if the collaboration creator sets a TRUE value for more than one member in the collaboration.

              If the collaboration creator hasn’t specified anyone as the member paying for query compute costs, then the member who can query is the default payer. An error is returned if the collaboration creator sets a FALSE value for the member who can query.

Exceptions