CleanRoomsService / Client / list_memberships

list_memberships#

CleanRoomsService.Client.list_memberships(**kwargs)#

Lists all memberships resources within the caller’s account.

See also: AWS API Documentation

Request Syntax

response = client.list_memberships(
    nextToken='string',
    maxResults=123,
    status='ACTIVE'|'REMOVED'|'COLLABORATION_DELETED'
)
Parameters:

  • nextToken (string) – The pagination token that’s used to fetch the next set of results.

  • maxResults (integer) – The maximum number of results that are returned for an API request call. The service chooses a default number if you don’t set one. The service might return a nextToken even if the maxResults value has not been met.

  • status (string) – A filter which will return only memberships in the specified status.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'membershipSummaries': [
        {
            'id': 'string',
            'arn': 'string',
            'collaborationArn': 'string',
            'collaborationId': 'string',
            'collaborationCreatorAccountId': 'string',
            'collaborationCreatorDisplayName': 'string',
            'collaborationName': 'string',
            'createTime': datetime(2015, 1, 1),
            'updateTime': datetime(2015, 1, 1),
            'status': 'ACTIVE'|'REMOVED'|'COLLABORATION_DELETED',
            'memberAbilities': [
                'CAN_QUERY'|'CAN_RECEIVE_RESULTS',
            ],
            'mlMemberAbilities': {
                'customMLMemberAbilities': [
                    'CAN_RECEIVE_MODEL_OUTPUT'|'CAN_RECEIVE_INFERENCE_OUTPUT',
                ]
            },
            'paymentConfiguration': {
                'queryCompute': {
                    'isResponsible': True|False
                },
                'machineLearning': {
                    'modelTraining': {
                        'isResponsible': True|False
                    },
                    'modelInference': {
                        'isResponsible': True|False
                    }
                }
            }
        },
    ]
}

Response Structure

  • (dict) –

    • nextToken (string) –

      The pagination token that’s used to fetch the next set of results.

    • membershipSummaries (list) –

      The list of memberships returned from the ListMemberships operation.

      • (dict) –

        The membership object listed by the request.

        • id (string) –

          The unique ID for the membership’s collaboration.

        • arn (string) –

          The unique ARN for the membership.

        • collaborationArn (string) –

          The unique ARN for the membership’s associated collaboration.

        • collaborationId (string) –

          The unique ID for the membership’s collaboration.

        • collaborationCreatorAccountId (string) –

          The identifier of the Amazon Web Services principal that created the collaboration. Currently only supports Amazon Web Services account ID.

        • collaborationCreatorDisplayName (string) –

          The display name of the collaboration creator.

        • collaborationName (string) –

          The name for the membership’s collaboration.

        • createTime (datetime) –

          The time when the membership was created.

        • updateTime (datetime) –

          The time the membership metadata was last updated.

        • status (string) –

          The status of the membership.

        • memberAbilities (list) –

          The abilities granted to the collaboration member.

          • (string) –

        • mlMemberAbilities (dict) –

          Provides a summary of the ML abilities for the collaboration member.

          Custom ML modeling is in beta release and is subject to change. For beta terms and conditions, see Betas and Previews in the Amazon Web Services Service Terms.

          • customMLMemberAbilities (list) –

            The custom ML member abilities for a collaboration member. The inference feature is not available in the custom ML modeling beta.

            Custom ML modeling is in beta release and is subject to change. For beta terms and conditions, see Betas and Previews in the Amazon Web Services Service Terms.

            • (string) –

        • paymentConfiguration (dict) –

          The payment responsibilities accepted by the collaboration member.

          • queryCompute (dict) –

            The payment responsibilities accepted by the collaboration member for query compute costs.

            • isResponsible (boolean) –

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

              If the collaboration creator has not specified anyone to pay for query compute costs, then the member who can query is the default payer.

              An error message is returned for the following reasons:

              • If you set the value to FALSE but you are responsible to pay for query compute costs.

              • If you set the value to TRUE but you are not responsible to pay for query compute costs.

          • machineLearning (dict) –

            The payment responsibilities accepted by the collaboration member for machine learning costs.

            • modelTraining (dict) –

              The payment responsibilities accepted by the member for model training.

              • isResponsible (boolean) –

                Indicates whether the collaboration member has accepted to pay for model training costs ( TRUE) or has not accepted to pay for model training costs ( FALSE).

                If the collaboration creator has not specified anyone to pay for model training costs, then the member who can query is the default payer.

                An error message is returned for the following reasons:

                • If you set the value to FALSE but you are responsible to pay for model training costs.

                • If you set the value to TRUE but you are not responsible to pay for model training costs.

            • modelInference (dict) –

              The payment responsibilities accepted by the member for model inference.

              • isResponsible (boolean) –

                Indicates whether the collaboration member has accepted to pay for model inference costs ( TRUE) or has not accepted to pay for model inference costs ( FALSE).

                If the collaboration creator has not specified anyone to pay for model inference costs, then the member who can query is the default payer.

                An error message is returned for the following reasons:

                • If you set the value to FALSE but you are responsible to pay for model inference costs.

                • If you set the value to TRUE but you are not responsible to pay for model inference costs.

Exceptions