:doc:`SageMaker <../../sagemaker>` / Client / list_trial_components

*********************
list_trial_components
*********************



.. py:method:: SageMaker.Client.list_trial_components(**kwargs)

  

  Lists the trial components in your account. You can sort the list by trial component name or creation time. You can filter the list to show only components that were created in a specific time range. You can also filter on one of the following:

   

  
  * ``ExperimentName``
   
  * ``SourceArn``
   
  * ``TrialName``
  

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/ListTrialComponents>`_  


  **Request Syntax**
  ::

    response = client.list_trial_components(
        ExperimentName='string',
        TrialName='string',
        SourceArn='string',
        CreatedAfter=datetime(2015, 1, 1),
        CreatedBefore=datetime(2015, 1, 1),
        SortBy='Name'|'CreationTime',
        SortOrder='Ascending'|'Descending',
        MaxResults=123,
        NextToken='string'
    )
    
  :type ExperimentName: string
  :param ExperimentName: 

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

    

  
  :type TrialName: string
  :param TrialName: 

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

    

  
  :type SourceArn: string
  :param SourceArn: 

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

    

  
  :type CreatedAfter: datetime
  :param CreatedAfter: 

    A filter that returns only components created after the specified time.

    

  
  :type CreatedBefore: datetime
  :param CreatedBefore: 

    A filter that returns only components created before the specified time.

    

  
  :type SortBy: string
  :param SortBy: 

    The property used to sort results. The default value is ``CreationTime``.

    

  
  :type SortOrder: string
  :param SortOrder: 

    The sort order. The default value is ``Descending``.

    

  
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of components to return in the response. The default value is 10.

    

  
  :type NextToken: string
  :param NextToken: 

    If the previous call to ``ListTrialComponents`` didn't return the full set of components, the call returns a token for getting the next set of components.

    

  
  
  :rtype: 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',
                      'IamIdentity': {
                          'Arn': 'string',
                          'PrincipalId': 'string',
                          'SourceIdentity': 'string'
                      }
                  },
                  'LastModifiedTime': datetime(2015, 1, 1),
                  'LastModifiedBy': {
                      'UserProfileArn': 'string',
                      'UserProfileName': 'string',
                      'DomainId': 'string',
                      'IamIdentity': {
                          'Arn': 'string',
                          'PrincipalId': 'string',
                          'SourceIdentity': 'string'
                      }
                  }
              },
          ],
          'NextToken': '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 <https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeTrialComponent.html>`__ 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.

              
            

            - **IamIdentity** *(dict) --* 

              The IAM Identity details associated with the user. These details are associated with model package groups, model packages, and project entities only.

              
              

              - **Arn** *(string) --* 

                The Amazon Resource Name (ARN) of the IAM identity.

                
              

              - **PrincipalId** *(string) --* 

                The ID of the principal that assumes the IAM identity.

                
              

              - **SourceIdentity** *(string) --* 

                The person or application which assumes the IAM identity.

                
          
        
          

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

              
            

            - **IamIdentity** *(dict) --* 

              The IAM Identity details associated with the user. These details are associated with model package groups, model packages, and project entities only.

              
              

              - **Arn** *(string) --* 

                The Amazon Resource Name (ARN) of the IAM identity.

                
              

              - **PrincipalId** *(string) --* 

                The ID of the principal that assumes the IAM identity.

                
              

              - **SourceIdentity** *(string) --* 

                The person or application which assumes the IAM identity.

                
          
        
      
    
      

      - **NextToken** *(string) --* 

        A token for getting the next set of components, if there are any.

        
  
  **Exceptions**
  
  *   :py:class:`SageMaker.Client.exceptions.ResourceNotFound`

  