ListTrialComponents¶

class SageMaker.Paginator.ListTrialComponents¶

paginator = client.get_paginator('list_trial_components')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from SageMaker.Client.list_trial_components().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ExperimentName='string',
    TrialName='string',
    SourceArn='string',
    CreatedAfter=datetime(2015, 1, 1),
    CreatedBefore=datetime(2015, 1, 1),
    SortBy='Name'|'CreationTime',
    SortOrder='Ascending'|'Descending',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters

ExperimentName (string) -- A filter that returns only components that are part of the specified experiment. If you specify ExperimentName , you can't filter by SourceArn or TrialName .
TrialName (string) -- A filter that returns only components that are part of the specified trial. If you specify TrialName , you can't filter by ExperimentName or SourceArn .
SourceArn (string) -- A filter that returns only components that have the specified source Amazon Resource Name (ARN). If you specify SourceArn , you can't filter by ExperimentName or TrialName .
CreatedAfter (datetime) -- A filter that returns only components created after the specified time.
CreatedBefore (datetime) -- A filter that returns only components created before the specified time.
SortBy (string) -- The property used to sort results. The default value is CreationTime .
SortOrder (string) -- The sort order. The default value is Descending .
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

{
    'TrialComponentSummaries': [
        {
            'TrialComponentName': 'string',
            'TrialComponentArn': 'string',
            'DisplayName': 'string',
            'TrialComponentSource': {
                'SourceArn': 'string',
                'SourceType': 'string'
            },
            'Status': {
                'PrimaryStatus': 'InProgress'|'Completed'|'Failed'|'Stopping'|'Stopped',
                'Message': 'string'
            },
            'StartTime': datetime(2015, 1, 1),
            'EndTime': datetime(2015, 1, 1),
            'CreationTime': datetime(2015, 1, 1),
            'CreatedBy': {
                'UserProfileArn': 'string',
                'UserProfileName': 'string',
                'DomainId': 'string'
            },
            'LastModifiedTime': datetime(2015, 1, 1),
            'LastModifiedBy': {
                'UserProfileArn': 'string',
                'UserProfileName': 'string',
                'DomainId': 'string'
            }
        },
    ],

}

Response Structure

(dict) --
- TrialComponentSummaries (list) --
  
  A list of the summaries of your trial components.
  - (dict) --
    
    A summary of the properties of a trial component. To get all the properties, call the DescribeTrialComponent API and provide the TrialComponentName .
    - TrialComponentName (string) --
      
      The name of the trial component.
    - TrialComponentArn (string) --
      
      The Amazon Resource Name (ARN) of the trial component.
    - DisplayName (string) --
      
      The name of the component as displayed. If DisplayName isn't specified, TrialComponentName is displayed.
    - TrialComponentSource (dict) --
      
      The Amazon Resource Name (ARN) and job type of the source of a trial component.
      - SourceArn (string) --
        
        The source Amazon Resource Name (ARN).
      - SourceType (string) --
        
        The source job type.
    - Status (dict) --
      
      The status of the component. States include:
      - InProgress
      - Completed
      - Failed
      - PrimaryStatus (string) --
        
        The status of the trial component.
      - Message (string) --
        
        If the component failed, a message describing why.
    - StartTime (datetime) --
      
      When the component started.
    - EndTime (datetime) --
      
      When the component ended.
    - CreationTime (datetime) --
      
      When the component was created.
    - CreatedBy (dict) --
      
      Who created the trial component.
      - UserProfileArn (string) --
        
        The Amazon Resource Name (ARN) of the user's profile.
      - UserProfileName (string) --
        
        The name of the user's profile.
      - DomainId (string) --
        
        The domain associated with the user.
    - LastModifiedTime (datetime) --
      
      When the component was last modified.
    - LastModifiedBy (dict) --
      
      Who last modified the component.
      - UserProfileArn (string) --
        
        The Amazon Resource Name (ARN) of the user's profile.
      - UserProfileName (string) --
        
        The name of the user's profile.
      - DomainId (string) --
        
        The domain associated with the user.

Table Of Contents

ListTrialComponents¶