CleanRoomsService / Client / list_protected_jobs

list_protected_jobs#

CleanRoomsService.Client.list_protected_jobs(**kwargs)#

Lists protected jobs, sorted by most recent job.

See also: AWS API Documentation

Request Syntax

response = client.list_protected_jobs(
    membershipIdentifier='string',
    status='SUBMITTED'|'STARTED'|'CANCELLED'|'CANCELLING'|'FAILED'|'SUCCESS',
    nextToken='string',
    maxResults=123
)
Parameters:

  • membershipIdentifier (string) –

    [REQUIRED]

    The identifier for the membership in the collaboration.

  • status (string) – A filter on the status of the protected job.

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

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'protectedJobs': [
        {
            'id': 'string',
            'membershipId': 'string',
            'membershipArn': 'string',
            'createTime': datetime(2015, 1, 1),
            'status': 'SUBMITTED'|'STARTED'|'CANCELLED'|'CANCELLING'|'FAILED'|'SUCCESS',
            'receiverConfigurations': [
                {
                    'analysisType': 'DIRECT_ANALYSIS',
                    'configurationDetails': {
                        'directAnalysisConfigurationDetails': {
                            'receiverAccountIds': [
                                'string',
                            ]
                        }
                    }
                },
            ]
        },
    ]
}

Response Structure

  • (dict) –

    • nextToken (string) –

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

    • protectedJobs (list) –

      A list of protected job summaries.

      • (dict) –

        The protected job summary for the objects listed by the request.

        • id (string) –

          The ID of the protected job.

        • membershipId (string) –

          The unique ID for the membership that initiated the protected job.

        • membershipArn (string) –

          The unique ARN for the membership that initiated the protected job.

        • createTime (datetime) –

          The time the protected job was created.

        • status (string) –

          The status of the protected job.

        • receiverConfigurations (list) –

          The receiver configurations for the protected job.

          • (dict) –

            The protected job receiver configuration.

            • analysisType (string) –

              The analysis type for the protected job receiver configuration.

            • configurationDetails (dict) –

              The configuration details for the protected job receiver.

              Note

              This is a Tagged Union structure. Only one of the following top level keys will be set: directAnalysisConfigurationDetails. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

              'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

              • directAnalysisConfigurationDetails (dict) –

                The details needed to configure the direct analysis.

                • receiverAccountIds (list) –

                  The receiver account IDs.

                  • (string) –

Exceptions