IoT / Client / list_audit_mitigation_actions_tasks

list_audit_mitigation_actions_tasks#

IoT.Client.list_audit_mitigation_actions_tasks(**kwargs)#

Gets a list of audit mitigation action tasks that match the specified filters.

Requires permission to access the ListAuditMitigationActionsTasks action.

See also: AWS API Documentation

Request Syntax

response = client.list_audit_mitigation_actions_tasks(
    auditTaskId='string',
    findingId='string',
    taskStatus='IN_PROGRESS'|'COMPLETED'|'FAILED'|'CANCELED',
    maxResults=123,
    nextToken='string',
    startTime=datetime(2015, 1, 1),
    endTime=datetime(2015, 1, 1)
)
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.

  • maxResults (integer) – The maximum number of results to return at one time. The default is 25.

  • nextToken (string) – The token for the next set of results.

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

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) –

      The token for the next set of results.

Exceptions

  • IoT.Client.exceptions.InvalidRequestException

  • IoT.Client.exceptions.ThrottlingException

  • IoT.Client.exceptions.InternalFailureException