CodeGuruProfiler / Paginator / ListProfileTimes

ListProfileTimes

class CodeGuruProfiler.Paginator.ListProfileTimes

paginator = client.get_paginator('list_profile_times')

paginate(**kwargs)

Creates an iterator that will paginate through responses from CodeGuruProfiler.Client.list_profile_times().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    endTime=datetime(2015, 1, 1),
    orderBy='TimestampDescending'|'TimestampAscending',
    period='PT5M'|'PT1H'|'P1D',
    profilingGroupName='string',
    startTime=datetime(2015, 1, 1),
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• endTime (datetime) –

  [REQUIRED]

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

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

• period (string) –

  [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

• profilingGroupName (string) –

  [REQUIRED]

  The name of the profiling group.

• startTime (datetime) –

  [REQUIRED]

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

• PaginationConfig (dict) –

  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.

Return type:

dict

Returns:

Response Syntax

{
    'profileTimes': [
        {
            'start': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  The structure representing the listProfileTimesResponse.

  • 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.

  • NextToken (string) –

    A token to resume pagination.