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

*****************
ListTrainingPlans
*****************



.. py:class:: SageMaker.Paginator.ListTrainingPlans

  ::

    
    paginator = client.get_paginator('list_training_plans')

  
  

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

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

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          StartTimeAfter=datetime(2015, 1, 1),
          StartTimeBefore=datetime(2015, 1, 1),
          SortBy='TrainingPlanName'|'StartTime'|'Status',
          SortOrder='Ascending'|'Descending',
          Filters=[
              {
                  'Name': 'Status',
                  'Value': 'string'
              },
          ],
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type StartTimeAfter: datetime
    :param StartTimeAfter: 

      Filter to list only training plans with an actual start time after this date.

      

    
    :type StartTimeBefore: datetime
    :param StartTimeBefore: 

      Filter to list only training plans with an actual start time before this date.

      

    
    :type SortBy: string
    :param SortBy: 

      The training plan field to sort the results by (e.g., StartTime, Status).

      

    
    :type SortOrder: string
    :param SortOrder: 

      The order to sort the results (Ascending or Descending).

      

    
    :type Filters: list
    :param Filters: 

      Additional filters to apply to the list of training plans.

      

    
      - *(dict) --* 

        A filter to apply when listing or searching for training plans.

         

        For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see ``CreateTrainingPlan ``.

        

      
        - **Name** *(string) --* **[REQUIRED]** 

          The name of the filter field (e.g., Status, InstanceType).

          

        
        - **Value** *(string) --* **[REQUIRED]** 

          The value to filter by for the specified field.

          

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

      
      ::

        {
            'TrainingPlanSummaries': [
                {
                    'TrainingPlanArn': 'string',
                    'TrainingPlanName': 'string',
                    'Status': 'Pending'|'Active'|'Scheduled'|'Expired'|'Failed',
                    'StatusMessage': 'string',
                    'DurationHours': 123,
                    'DurationMinutes': 123,
                    'StartTime': datetime(2015, 1, 1),
                    'EndTime': datetime(2015, 1, 1),
                    'UpfrontFee': 'string',
                    'CurrencyCode': 'string',
                    'TotalInstanceCount': 123,
                    'AvailableInstanceCount': 123,
                    'InUseInstanceCount': 123,
                    'TotalUltraServerCount': 123,
                    'TargetResources': [
                        'training-job'|'hyperpod-cluster'|'endpoint',
                    ],
                    'ReservedCapacitySummaries': [
                        {
                            'ReservedCapacityArn': 'string',
                            'ReservedCapacityType': 'UltraServer'|'Instance',
                            'UltraServerType': 'string',
                            'UltraServerCount': 123,
                            'InstanceType': 'ml.p4d.24xlarge'|'ml.p5.48xlarge'|'ml.p5e.48xlarge'|'ml.p5en.48xlarge'|'ml.trn1.32xlarge'|'ml.trn2.48xlarge'|'ml.p6-b200.48xlarge'|'ml.p4de.24xlarge'|'ml.p6e-gb200.36xlarge'|'ml.p5.4xlarge'|'ml.p6-b300.48xlarge',
                            'TotalInstanceCount': 123,
                            'Status': 'Pending'|'Active'|'Scheduled'|'Expired'|'Failed',
                            'AvailabilityZone': 'string',
                            'DurationHours': 123,
                            'DurationMinutes': 123,
                            'StartTime': datetime(2015, 1, 1),
                            'EndTime': datetime(2015, 1, 1)
                        },
                    ]
                },
            ]
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **TrainingPlanSummaries** *(list) --* 

          A list of summary information for the training plans.

          
          

          - *(dict) --* 

            Details of the training plan.

             

            For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see ``CreateTrainingPlan ``.

            
            

            - **TrainingPlanArn** *(string) --* 

              The Amazon Resource Name (ARN); of the training plan.

              
            

            - **TrainingPlanName** *(string) --* 

              The name of the training plan.

              
            

            - **Status** *(string) --* 

              The current status of the training plan (e.g., Pending, Active, Expired). To see the complete list of status values available for a training plan, refer to the ``Status`` attribute within the ``TrainingPlanSummary`` object.

              
            

            - **StatusMessage** *(string) --* 

              A message providing additional information about the current status of the training plan.

              
            

            - **DurationHours** *(integer) --* 

              The number of whole hours in the total duration for this training plan.

              
            

            - **DurationMinutes** *(integer) --* 

              The additional minutes beyond whole hours in the total duration for this training plan.

              
            

            - **StartTime** *(datetime) --* 

              The start time of the training plan.

              
            

            - **EndTime** *(datetime) --* 

              The end time of the training plan.

              
            

            - **UpfrontFee** *(string) --* 

              The upfront fee for the training plan.

              
            

            - **CurrencyCode** *(string) --* 

              The currency code for the upfront fee (e.g., USD).

              
            

            - **TotalInstanceCount** *(integer) --* 

              The total number of instances reserved in this training plan.

              
            

            - **AvailableInstanceCount** *(integer) --* 

              The number of instances currently available for use in this training plan.

              
            

            - **InUseInstanceCount** *(integer) --* 

              The number of instances currently in use from this training plan.

              
            

            - **TotalUltraServerCount** *(integer) --* 

              The total number of UltraServers allocated to this training plan.

              
            

            - **TargetResources** *(list) --* 

              The target resources (e.g., training jobs, HyperPod clusters, Endpoints) that can use this training plan.

               

              Training plans are specific to their target resource.

               

              
              * A training plan designed for SageMaker training jobs can only be used to schedule and run training jobs.
               
              * A training plan for HyperPod clusters can be used exclusively to provide compute resources to a cluster's instance group.
               
              * A training plan for SageMaker endpoints can be used exclusively to provide compute resources to SageMaker endpoints for model deployment.
              

              
              

              - *(string) --* 
          
            

            - **ReservedCapacitySummaries** *(list) --* 

              A list of reserved capacities associated with this training plan, including details such as instance types, counts, and availability zones.

              
              

              - *(dict) --* 

                Details of a reserved capacity for the training plan.

                 

                For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see ``CreateTrainingPlan ``.

                
                

                - **ReservedCapacityArn** *(string) --* 

                  The Amazon Resource Name (ARN); of the reserved capacity.

                  
                

                - **ReservedCapacityType** *(string) --* 

                  The type of reserved capacity.

                  
                

                - **UltraServerType** *(string) --* 

                  The type of UltraServer included in this reserved capacity, such as ml.u-p6e-gb200x72.

                  
                

                - **UltraServerCount** *(integer) --* 

                  The number of UltraServers included in this reserved capacity.

                  
                

                - **InstanceType** *(string) --* 

                  The instance type for the reserved capacity.

                  
                

                - **TotalInstanceCount** *(integer) --* 

                  The total number of instances in the reserved capacity.

                  
                

                - **Status** *(string) --* 

                  The current status of the reserved capacity.

                  
                

                - **AvailabilityZone** *(string) --* 

                  The availability zone for the reserved capacity.

                  
                

                - **DurationHours** *(integer) --* 

                  The number of whole hours in the total duration for this reserved capacity.

                  
                

                - **DurationMinutes** *(integer) --* 

                  The additional minutes beyond whole hours in the total duration for this reserved capacity.

                  
                

                - **StartTime** *(datetime) --* 

                  The start time of the reserved capacity.

                  
                

                - **EndTime** *(datetime) --* 

                  The end time of the reserved capacity.

                  
            
          
        
      
    