Inspector2 / Client / start_on_demand_scan

start_on_demand_scan

Inspector2.Client.start_on_demand_scan(**kwargs)

Starts an on-demand scan of the specified resource, such as an Amazon Machine Image (AMI).

See also: AWS API Documentation

Request Syntax

response = client.start_on_demand_scan(
    resourceId='string',
    resourceType='AMI',
    clientToken='string'
)
Parameters:

  • resourceId (string) –

    [REQUIRED]

    The ID of the resource to scan on demand.

  • resourceType (string) –

    [REQUIRED]

    The type of the resource to scan on demand.

  • clientToken (string) –

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{
    'scanId': 'string'
}

Response Structure

  • (dict) –

    • scanId (string) –

      The unique identifier assigned to the on-demand scan that was started.

Exceptions