IoT / Paginator / ListAuditMitigationActionsExecutions

ListAuditMitigationActionsExecutions

class IoT.Paginator.ListAuditMitigationActionsExecutions

paginator = client.get_paginator('list_audit_mitigation_actions_executions')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    taskId='string',
    actionStatus='IN_PROGRESS'|'COMPLETED'|'FAILED'|'CANCELED'|'SKIPPED'|'PENDING',
    findingId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• taskId (string) –

  [REQUIRED]

  Specify this filter to limit results to actions for a specific audit mitigation actions task.

• actionStatus (string) – Specify this filter to limit results to those with a specific status.

• findingId (string) –

  [REQUIRED]

  Specify this filter to limit results to those that were applied to a specific audit finding.

• 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

{
    'actionsExecutions': [
        {
            'taskId': 'string',
            'findingId': 'string',
            'actionName': 'string',
            'actionId': 'string',
            'status': 'IN_PROGRESS'|'COMPLETED'|'FAILED'|'CANCELED'|'SKIPPED'|'PENDING',
            'startTime': datetime(2015, 1, 1),
            'endTime': datetime(2015, 1, 1),
            'errorCode': 'string',
            'message': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • actionsExecutions (list) –

    A set of task execution results based on the input parameters. Details include the mitigation action applied, start time, and task status.

    • (dict) –

      Returned by ListAuditMitigationActionsTask, this object contains information that describes a mitigation action that has been started.

      • taskId (string) –

        The unique identifier for the task that applies the mitigation action.

      • findingId (string) –

        The unique identifier for the findings to which the task and associated mitigation action are applied.

      • actionName (string) –

        The friendly name of the mitigation action being applied by the task.

      • actionId (string) –

        The unique identifier for the mitigation action being applied by the task.

      • status (string) –

        The current status of the task being executed.

      • startTime (datetime) –

        The date and time when the task was started.

      • endTime (datetime) –

        The date and time when the task was completed or canceled. Blank if the task is still running.

      • errorCode (string) –

        If an error occurred, the code that indicates which type of error occurred.

      • message (string) –

        If an error occurred, a message that describes the error.

  • NextToken (string) –

    A token to resume pagination.