CleanRoomsML / Paginator / ListCollaborationTrainedModelInferenceJobs

ListCollaborationTrainedModelInferenceJobs#

class CleanRoomsML.Paginator.ListCollaborationTrainedModelInferenceJobs#

paginator = client.get_paginator('list_collaboration_trained_model_inference_jobs')

paginate(**kwargs)#

Creates an iterator that will paginate through responses from CleanRoomsML.Client.list_collaboration_trained_model_inference_jobs().

Request Syntax

response_iterator = paginator.paginate(
    collaborationIdentifier='string',
    trainedModelArn='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

collaborationIdentifier (string) –
[REQUIRED]

The collaboration ID of the collaboration that contains the trained model inference jobs that you are interested in.
trainedModelArn (string) – The Amazon Resource Name (ARN) of the trained model that was used to create the trained model inference jobs that you are interested in.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
- MaxItems (integer) –
  
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- PageSize (integer) –
  
  The size of each page.
- StartingToken (string) –
  
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'collaborationTrainedModelInferenceJobs': [
        {
            'trainedModelInferenceJobArn': 'string',
            'configuredModelAlgorithmAssociationArn': 'string',
            'membershipIdentifier': 'string',
            'trainedModelArn': 'string',
            'collaborationIdentifier': 'string',
            'status': 'CREATE_PENDING'|'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'CANCEL_PENDING'|'CANCEL_IN_PROGRESS'|'CANCEL_FAILED'|'INACTIVE',
            'outputConfiguration': {
                'accept': 'string',
                'members': [
                    {
                        'accountId': 'string'
                    },
                ]
            },
            'name': 'string',
            'description': 'string',
            'metricsStatus': 'PUBLISH_SUCCEEDED'|'PUBLISH_FAILED',
            'metricsStatusDetails': 'string',
            'logsStatus': 'PUBLISH_SUCCEEDED'|'PUBLISH_FAILED',
            'logsStatusDetails': 'string',
            'createTime': datetime(2015, 1, 1),
            'updateTime': datetime(2015, 1, 1),
            'creatorAccountId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- collaborationTrainedModelInferenceJobs (list) –
  
  The trained model inference jobs that you are interested in.
  - (dict) –
    
    Provides summary information about a trained model inference job in a collaboration.
    - trainedModelInferenceJobArn (string) –
      
      The Amazon Resource Name (ARN) of the trained model inference job.
    - configuredModelAlgorithmAssociationArn (string) –
      
      The Amazon Resource Name (ARN) of the configured model algorithm association that is used for the trained model inference job.
    - membershipIdentifier (string) –
      
      The membership ID of the membership that contains the trained model inference job.
    - trainedModelArn (string) –
      
      The Amazon Resource Name (ARN) of the trained model that is used for the trained model inference job.
    - collaborationIdentifier (string) –
      
      The collaboration ID of the collaboration that contains the trained model inference job.
    - status (string) –
      
      The status of the trained model inference job.
    - outputConfiguration (dict) –
      
      Returns output configuration information for the trained model inference job.
      - accept (string) –
        
        The MIME type used to specify the output data.
      - members (list) –
        
        Defines the members that can receive inference output.
        
        (dict) –
        
        Defines who will receive inference results.
        
        accountId (string) –
        
        The account ID of the member that can receive inference results.
    - name (string) –
      
      The name of the trained model inference job.
    - description (string) –
      
      The description of the trained model inference job.
    - metricsStatus (string) –
      
      the trained model inference job metrics status.
    - metricsStatusDetails (string) –
      
      Details about the metrics status for trained model inference job.
    - logsStatus (string) –
      
      The trained model inference job logs status.
    - logsStatusDetails (string) –
      
      Details about the logs status for the trained model inference job.
    - createTime (datetime) –
      
      The time at which the trained model inference job was created.
    - updateTime (datetime) –
      
      The most recent time at which the trained model inference job was updated.
    - creatorAccountId (string) –
      
      The account ID that created the trained model inference job.
- NextToken (string) –
  
  A token to resume pagination.