IoT / Paginator / ListDetectMitigationActionsExecutions

ListDetectMitigationActionsExecutions

class IoT.Paginator.ListDetectMitigationActionsExecutions

paginator = client.get_paginator('list_detect_mitigation_actions_executions')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    taskId='string',
    violationId='string',
    thingName='string',
    startTime=datetime(2015, 1, 1),
    endTime=datetime(2015, 1, 1),
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• taskId (string) – The unique identifier of the task.

• violationId (string) – The unique identifier of the violation.

• thingName (string) – The name of the thing whose mitigation actions are listed.

• startTime (datetime) – A filter to limit results to those found after the specified time. You must specify either the startTime and endTime or the taskId, but not both.

• endTime (datetime) – The end of the time period for which ML Detect mitigation actions executions are returned.

• 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',
            'violationId': 'string',
            'actionName': 'string',
            'thingName': 'string',
            'executionStartDate': datetime(2015, 1, 1),
            'executionEndDate': datetime(2015, 1, 1),
            'status': 'IN_PROGRESS'|'SUCCESSFUL'|'FAILED'|'SKIPPED',
            'errorCode': 'string',
            'message': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • actionsExecutions (list) –

    List of actions executions.

    • (dict) –

      Describes which mitigation actions should be executed.

      • taskId (string) –

        The unique identifier of the task.

      • violationId (string) –

        The unique identifier of the violation.

      • actionName (string) –

        The friendly name that uniquely identifies the mitigation action.

      • thingName (string) –

        The name of the thing.

      • executionStartDate (datetime) –

        The date a mitigation action was started.

      • executionEndDate (datetime) –

        The date a mitigation action ended.

      • status (string) –

        The status of a mitigation action.

      • errorCode (string) –

        The error code of a mitigation action.

      • message (string) –

        The message of a mitigation action.

  • NextToken (string) –

    A token to resume pagination.