:doc:`CodeGuruProfiler <../../codeguruprofiler>` / Client / list_profile_times

******************
list_profile_times
******************



.. py:method:: CodeGuruProfiler.Client.list_profile_times(**kwargs)

  

  Lists the start times of the available aggregated profiles of a profiling group for an aggregation period within the specified time range.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/codeguruprofiler-2019-07-18/ListProfileTimes>`_  


  **Request Syntax**
  ::

    response = client.list_profile_times(
        endTime=datetime(2015, 1, 1),
        maxResults=123,
        nextToken='string',
        orderBy='TimestampDescending'|'TimestampAscending',
        period='PT5M'|'PT1H'|'P1D',
        profilingGroupName='string',
        startTime=datetime(2015, 1, 1)
    )
    
  :type endTime: datetime
  :param endTime: **[REQUIRED]** 

    The end time of the time range from which to list the profiles.

    

  
  :type maxResults: integer
  :param maxResults: 

    The maximum number of profile time results returned by ``ListProfileTimes`` in paginated output. When this parameter is used, ``ListProfileTimes`` only returns ``maxResults`` results in a single page with a ``nextToken`` response element. The remaining results of the initial request can be seen by sending another ``ListProfileTimes`` request with the returned ``nextToken`` value.

    

  
  :type nextToken: string
  :param nextToken: 

    The ``nextToken`` value returned from a previous paginated ``ListProfileTimes`` request where ``maxResults`` was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the ``nextToken`` value.

     

    .. note::

      

      This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

      

    

  
  :type orderBy: string
  :param orderBy: 

    The order (ascending or descending by start time of the profile) to use when listing profiles. Defaults to ``TIMESTAMP_DESCENDING``.

    

  
  :type period: string
  :param period: **[REQUIRED]** 

    The aggregation period. This specifies the period during which an aggregation profile collects posted agent profiles for a profiling group. There are 3 valid values.

     

    
    * ``P1D`` — 1 day
     
    * ``PT1H`` — 1 hour
     
    * ``PT5M`` — 5 minutes
    

    

  
  :type profilingGroupName: string
  :param profilingGroupName: **[REQUIRED]** 

    The name of the profiling group.

    

  
  :type startTime: datetime
  :param startTime: **[REQUIRED]** 

    The start time of the time range from which to list the profiles.

    

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

    
    ::

      {
          'nextToken': 'string',
          'profileTimes': [
              {
                  'start': datetime(2015, 1, 1)
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 

      The structure representing the listProfileTimesResponse.

      
      

      - **nextToken** *(string) --* 

        The ``nextToken`` value to include in a future ``ListProfileTimes`` request. When the results of a ``ListProfileTimes`` request exceed ``maxResults``, this value can be used to retrieve the next page of results. This value is ``null`` when there are no more results to return.

        
      

      - **profileTimes** *(list) --* 

        The list of start times of the available profiles for the aggregation period in the specified time range.

        
        

        - *(dict) --* 

          Contains the start time of a profile.

          
          

          - **start** *(datetime) --* 

            The start time of a profile. It is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.

            
      
    
  
  **Exceptions**
  
  *   :py:class:`CodeGuruProfiler.Client.exceptions.InternalServerException`

  
  *   :py:class:`CodeGuruProfiler.Client.exceptions.ValidationException`

  
  *   :py:class:`CodeGuruProfiler.Client.exceptions.ThrottlingException`

  
  *   :py:class:`CodeGuruProfiler.Client.exceptions.ResourceNotFoundException`

  