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

*************
ListArtifacts
*************



.. py:class:: SageMaker.Paginator.ListArtifacts

  ::

    
    paginator = client.get_paginator('list_artifacts')

  
  

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

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

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          SourceUri='string',
          ArtifactType='string',
          CreatedAfter=datetime(2015, 1, 1),
          CreatedBefore=datetime(2015, 1, 1),
          SortBy='CreationTime',
          SortOrder='Ascending'|'Descending',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type SourceUri: string
    :param SourceUri: 

      A filter that returns only artifacts with the specified source URI.

      

    
    :type ArtifactType: string
    :param ArtifactType: 

      A filter that returns only artifacts of the specified type.

      

    
    :type CreatedAfter: datetime
    :param CreatedAfter: 

      A filter that returns only artifacts created on or after the specified time.

      

    
    :type CreatedBefore: datetime
    :param CreatedBefore: 

      A filter that returns only artifacts created on or 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 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**

      
      ::

        {
            'ArtifactSummaries': [
                {
                    'ArtifactArn': 'string',
                    'ArtifactName': 'string',
                    'Source': {
                        'SourceUri': 'string',
                        'SourceTypes': [
                            {
                                'SourceIdType': 'MD5Hash'|'S3ETag'|'S3Version'|'Custom',
                                'Value': 'string'
                            },
                        ]
                    },
                    'ArtifactType': 'string',
                    'CreationTime': datetime(2015, 1, 1),
                    'LastModifiedTime': datetime(2015, 1, 1)
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **ArtifactSummaries** *(list) --* 

          A list of artifacts and their properties.

          
          

          - *(dict) --* 

            Lists a summary of the properties of an artifact. An artifact represents a URI addressable object or data. Some examples are a dataset and a model.

            
            

            - **ArtifactArn** *(string) --* 

              The Amazon Resource Name (ARN) of the artifact.

              
            

            - **ArtifactName** *(string) --* 

              The name of the artifact.

              
            

            - **Source** *(dict) --* 

              The source of the artifact.

              
              

              - **SourceUri** *(string) --* 

                The URI of the source.

                
              

              - **SourceTypes** *(list) --* 

                A list of source types.

                
                

                - *(dict) --* 

                  The ID and ID type of an artifact source.

                  
                  

                  - **SourceIdType** *(string) --* 

                    The type of ID.

                    
                  

                  - **Value** *(string) --* 

                    The ID.

                    
              
            
          
            

            - **ArtifactType** *(string) --* 

              The type of the artifact.

              
            

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

              When the artifact was created.

              
            

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

              When the artifact was last modified.

              
        
      
    