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

***********************
ListInferenceComponents
***********************



.. py:class:: SageMaker.Paginator.ListInferenceComponents

  ::

    
    paginator = client.get_paginator('list_inference_components')

  
  

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

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

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          SortBy='Name'|'CreationTime'|'Status',
          SortOrder='Ascending'|'Descending',
          NameContains='string',
          CreationTimeBefore=datetime(2015, 1, 1),
          CreationTimeAfter=datetime(2015, 1, 1),
          LastModifiedTimeBefore=datetime(2015, 1, 1),
          LastModifiedTimeAfter=datetime(2015, 1, 1),
          StatusEquals='InService'|'Creating'|'Updating'|'Failed'|'Deleting',
          EndpointNameEquals='string',
          VariantNameEquals='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type SortBy: string
    :param SortBy: 

      The field by which to sort the inference components in the response. The default is ``CreationTime``.

      

    
    :type SortOrder: string
    :param SortOrder: 

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

      

    
    :type NameContains: string
    :param NameContains: 

      Filters the results to only those inference components with a name that contains the specified string.

      

    
    :type CreationTimeBefore: datetime
    :param CreationTimeBefore: 

      Filters the results to only those inference components that were created before the specified time.

      

    
    :type CreationTimeAfter: datetime
    :param CreationTimeAfter: 

      Filters the results to only those inference components that were created after the specified time.

      

    
    :type LastModifiedTimeBefore: datetime
    :param LastModifiedTimeBefore: 

      Filters the results to only those inference components that were updated before the specified time.

      

    
    :type LastModifiedTimeAfter: datetime
    :param LastModifiedTimeAfter: 

      Filters the results to only those inference components that were updated after the specified time.

      

    
    :type StatusEquals: string
    :param StatusEquals: 

      Filters the results to only those inference components with the specified status.

      

    
    :type EndpointNameEquals: string
    :param EndpointNameEquals: 

      An endpoint name to filter the listed inference components. The response includes only those inference components that are hosted at the specified endpoint.

      

    
    :type VariantNameEquals: string
    :param VariantNameEquals: 

      A production variant name to filter the listed inference components. The response includes only those inference components that are hosted at the specified variant.

      

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

      
      ::

        {
            'InferenceComponents': [
                {
                    'CreationTime': datetime(2015, 1, 1),
                    'InferenceComponentArn': 'string',
                    'InferenceComponentName': 'string',
                    'EndpointArn': 'string',
                    'EndpointName': 'string',
                    'VariantName': 'string',
                    'InferenceComponentStatus': 'InService'|'Creating'|'Updating'|'Failed'|'Deleting',
                    'LastModifiedTime': datetime(2015, 1, 1)
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **InferenceComponents** *(list) --* 

          A list of inference components and their properties that matches any of the filters you specified in the request.

          
          

          - *(dict) --* 

            A summary of the properties of an inference component.

            
            

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

              The time when the inference component was created.

              
            

            - **InferenceComponentArn** *(string) --* 

              The Amazon Resource Name (ARN) of the inference component.

              
            

            - **InferenceComponentName** *(string) --* 

              The name of the inference component.

              
            

            - **EndpointArn** *(string) --* 

              The Amazon Resource Name (ARN) of the endpoint that hosts the inference component.

              
            

            - **EndpointName** *(string) --* 

              The name of the endpoint that hosts the inference component.

              
            

            - **VariantName** *(string) --* 

              The name of the production variant that hosts the inference component.

              
            

            - **InferenceComponentStatus** *(string) --* 

              The status of the inference component.

              
            

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

              The time when the inference component was last updated.

              
        
      
    