Inspector2 / Client / get_on_demand_scan_status

get_on_demand_scan_status

Inspector2.Client.get_on_demand_scan_status(**kwargs)

Retrieves the status of a specific on-demand scan for a resource.

See also: AWS API Documentation

Request Syntax

response = client.get_on_demand_scan_status(
    resourceId='string',
    scanId='string',
    resourceType='AMI'
)
Parameters:

  • resourceId (string) –

    [REQUIRED]

    The ID of the resource whose on-demand scan status is being requested.

  • scanId (string) –

    [REQUIRED]

    The unique identifier of the on-demand scan whose status is being requested.

  • resourceType (string) –

    [REQUIRED]

    The type of the resource whose on-demand scan status is being requested.

Return type:

dict

Returns:

Response Syntax

{
    'scanId': 'string',
    'resourceId': 'string',
    'resourceType': 'AMI',
    'scanStatus': 'IN_PROGRESS'|'SUCCESSFUL'|'FAILED',
    'scanStatusReason': 'ACCESS_DENIED'|'INTERNAL_ERROR'|'STORAGE_LIMIT_EXCEEDED'|'EXTRACTION_COLLECTION_TIME_LIMIT_EXCEEDED'|'UNSUPPORTED_OS'|'RESOURCE_TERMINATED',
    'startedAt': datetime(2015, 1, 1),
    'completedAt': datetime(2015, 1, 1)
}

Response Structure

  • (dict) –

    • scanId (string) –

      The unique identifier of the on-demand scan.

    • resourceId (string) –

      The ID of the resource that was scanned.

    • resourceType (string) –

      The type of the resource that was scanned.

    • scanStatus (string) –

      The current status of the on-demand scan.

    • scanStatusReason (string) –

      The reason associated with the current on-demand scan status.

    • startedAt (datetime) –

      The date and time, in ISO 8601 format, when the on-demand scan started.

    • completedAt (datetime) –

      The date and time, in ISO 8601 format, when the on-demand scan completed. This field is absent if the scan has not completed.

Exceptions