:doc:`SageMaker <../../sagemaker>` / Paginator / ListCompilationJobs

*******************
ListCompilationJobs
*******************



.. py:class:: SageMaker.Paginator.ListCompilationJobs

  ::

    
    paginator = client.get_paginator('list_compilation_jobs')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`SageMaker.Client.list_compilation_jobs`.

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          CreationTimeAfter=datetime(2015, 1, 1),
          CreationTimeBefore=datetime(2015, 1, 1),
          LastModifiedTimeAfter=datetime(2015, 1, 1),
          LastModifiedTimeBefore=datetime(2015, 1, 1),
          NameContains='string',
          StatusEquals='INPROGRESS'|'COMPLETED'|'FAILED'|'STARTING'|'STOPPING'|'STOPPED',
          SortBy='Name'|'CreationTime'|'Status',
          SortOrder='Ascending'|'Descending',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type CreationTimeAfter: datetime
    :param CreationTimeAfter: 

      A filter that returns the model compilation jobs that were created after a specified time.

      

    
    :type CreationTimeBefore: datetime
    :param CreationTimeBefore: 

      A filter that returns the model compilation jobs that were created before a specified time.

      

    
    :type LastModifiedTimeAfter: datetime
    :param LastModifiedTimeAfter: 

      A filter that returns the model compilation jobs that were modified after a specified time.

      

    
    :type LastModifiedTimeBefore: datetime
    :param LastModifiedTimeBefore: 

      A filter that returns the model compilation jobs that were modified before a specified time.

      

    
    :type NameContains: string
    :param NameContains: 

      A filter that returns the model compilation jobs whose name contains a specified string.

      

    
    :type StatusEquals: string
    :param StatusEquals: 

      A filter that retrieves model compilation jobs with a specific ``CompilationJobStatus`` status.

      

    
    :type SortBy: string
    :param SortBy: 

      The field by which to sort results. The default is ``CreationTime``.

      

    
    :type SortOrder: string
    :param SortOrder: 

      The sort order for results. The default is ``Ascending``.

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      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.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax**

      
      ::

        {
            'CompilationJobSummaries': [
                {
                    'CompilationJobName': 'string',
                    'CompilationJobArn': 'string',
                    'CreationTime': datetime(2015, 1, 1),
                    'CompilationStartTime': datetime(2015, 1, 1),
                    'CompilationEndTime': datetime(2015, 1, 1),
                    'CompilationTargetDevice': 'lambda'|'ml_m4'|'ml_m5'|'ml_m6g'|'ml_c4'|'ml_c5'|'ml_c6g'|'ml_p2'|'ml_p3'|'ml_g4dn'|'ml_inf1'|'ml_inf2'|'ml_trn1'|'ml_eia2'|'jetson_tx1'|'jetson_tx2'|'jetson_nano'|'jetson_xavier'|'rasp3b'|'rasp4b'|'imx8qm'|'deeplens'|'rk3399'|'rk3288'|'aisage'|'sbe_c'|'qcs605'|'qcs603'|'sitara_am57x'|'amba_cv2'|'amba_cv22'|'amba_cv25'|'x86_win32'|'x86_win64'|'coreml'|'jacinto_tda4vm'|'imx8mplus',
                    'CompilationTargetPlatformOs': 'ANDROID'|'LINUX',
                    'CompilationTargetPlatformArch': 'X86_64'|'X86'|'ARM64'|'ARM_EABI'|'ARM_EABIHF',
                    'CompilationTargetPlatformAccelerator': 'INTEL_GRAPHICS'|'MALI'|'NVIDIA'|'NNA',
                    'LastModifiedTime': datetime(2015, 1, 1),
                    'CompilationJobStatus': 'INPROGRESS'|'COMPLETED'|'FAILED'|'STARTING'|'STOPPING'|'STOPPED'
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **CompilationJobSummaries** *(list) --* 

          An array of `CompilationJobSummary <https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CompilationJobSummary.html>`__ objects, each describing a model compilation job.

          
          

          - *(dict) --* 

            A summary of a model compilation job.

            
            

            - **CompilationJobName** *(string) --* 

              The name of the model compilation job that you want a summary for.

              
            

            - **CompilationJobArn** *(string) --* 

              The Amazon Resource Name (ARN) of the model compilation job.

              
            

            - **CreationTime** *(datetime) --* 

              The time when the model compilation job was created.

              
            

            - **CompilationStartTime** *(datetime) --* 

              The time when the model compilation job started.

              
            

            - **CompilationEndTime** *(datetime) --* 

              The time when the model compilation job completed.

              
            

            - **CompilationTargetDevice** *(string) --* 

              The type of device that the model will run on after the compilation job has completed.

              
            

            - **CompilationTargetPlatformOs** *(string) --* 

              The type of OS that the model will run on after the compilation job has completed.

              
            

            - **CompilationTargetPlatformArch** *(string) --* 

              The type of architecture that the model will run on after the compilation job has completed.

              
            

            - **CompilationTargetPlatformAccelerator** *(string) --* 

              The type of accelerator that the model will run on after the compilation job has completed.

              
            

            - **LastModifiedTime** *(datetime) --* 

              The time when the model compilation job was last modified.

              
            

            - **CompilationJobStatus** *(string) --* 

              The status of the model compilation job.

              
        
      
    