NovaActService / Paginator / ListActs

ListActs

class NovaActService.Paginator.ListActs

paginator = client.get_paginator('list_acts')

paginate(**kwargs)

Creates an iterator that will paginate through responses from NovaActService.Client.list_acts().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    workflowDefinitionName='string',
    workflowRunId='string',
    sessionId='string',
    sortOrder='Ascending'|'Descending',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• workflowDefinitionName (string) –

  [REQUIRED]

  The name of the workflow definition containing the session.

• workflowRunId (string) – The unique identifier of the workflow run containing the session.

• sessionId (string) – The unique identifier of the session to list acts for.

• sortOrder (string) – The sort order for the returned acts (ascending or descending).

• 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

{
    'actSummaries': [
        {
            'workflowRunId': 'string',
            'sessionId': 'string',
            'actId': 'string',
            'status': 'RUNNING'|'PENDING_CLIENT_ACTION'|'PENDING_HUMAN_ACTION'|'SUCCEEDED'|'FAILED'|'TIMED_OUT',
            'startedAt': datetime(2015, 1, 1),
            'endedAt': datetime(2015, 1, 1),
            'traceLocation': {
                'locationType': 'S3',
                'location': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • actSummaries (list) –

    A list of summary information for acts in the session.

    • (dict) –

      Summary information about an act, including its status and execution timing.

      • workflowRunId (string) –

        The unique identifier of the workflow run containing this act.

      • sessionId (string) –

        The unique identifier of the session containing this act.

      • actId (string) –

        The unique identifier of the act.

      • status (string) –

        The current execution status of the act.

      • startedAt (datetime) –

        The timestamp when the act started execution.

      • endedAt (datetime) –

        The timestamp when the act completed execution, if applicable.

      • traceLocation (dict) –

        The location where trace information for this act is stored.

        • locationType (string) –

          The type of storage location for the trace data.

        • location (string) –

          The specific location where the trace data is stored.

  • NextToken (string) –

    A token to resume pagination.