ListAuditMitigationActionsTasks

class IoT.Paginator.ListAuditMitigationActionsTasks
paginator = client.get_paginator('list_audit_mitigation_actions_tasks')
paginate(**kwargs)

Creates an iterator that will paginate through responses from IoT.Client.list_audit_mitigation_actions_tasks().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    auditTaskId='string',
    findingId='string',
    taskStatus='IN_PROGRESS'|'COMPLETED'|'FAILED'|'CANCELED',
    startTime=datetime(2015, 1, 1),
    endTime=datetime(2015, 1, 1),
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • auditTaskId (string) -- Specify this filter to limit results to tasks that were applied to results for a specific audit.
  • findingId (string) -- Specify this filter to limit results to tasks that were applied to a specific audit finding.
  • taskStatus (string) -- Specify this filter to limit results to tasks that are in a specific state.
  • startTime (datetime) --

    [REQUIRED]

    Specify this filter to limit results to tasks that began on or after a specific date and time.

  • endTime (datetime) --

    [REQUIRED]

    Specify this filter to limit results to tasks that were completed or canceled on or before a specific date and time.

  • 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

{
    'tasks': [
        {
            'taskId': 'string',
            'startTime': datetime(2015, 1, 1),
            'taskStatus': 'IN_PROGRESS'|'COMPLETED'|'FAILED'|'CANCELED'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • tasks (list) --

      The collection of audit mitigation tasks that matched the filter criteria.

      • (dict) --

        Information about an audit mitigation actions task that is returned by ListAuditMitigationActionsTasks .

        • taskId (string) --

          The unique identifier for the task.

        • startTime (datetime) --

          The time at which the audit mitigation actions task was started.

        • taskStatus (string) --

          The current state of the audit mitigation actions task.

    • NextToken (string) --

      A token to resume pagination.