Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListMalwareScans

Returns a list of malware scans. Each member account can view the malware scans for their own accounts. An administrator can view the malware scans for all of its members' accounts.

Request Syntax


POST /malware-scan?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
Content-type: application/json

{
   "filterCriteria": { 
      "filterCriterion": [ 
         { 
            "filterCondition": { 
               "equalsValue": "string",
               "greaterThan": number,
               "lessThan": number
            },
            "criterionKey": "string"
         }
      ]
   },
   "sortCriteria": { 
      "attributeName": "string",
      "orderBy": "string"
   }
}

URI Request Parameters

The request uses the following URI parameters.

MaxResults

You can use this parameter to indicate the maximum number of items that you want in the response. The default value is 50. The maximum value is 50.

Valid Range: Minimum value of 1. Maximum value of 50.

NextToken

You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action, fill nextToken in the request with the value of NextToken from the previous response to continue listing results.

Request Body

The request accepts the following data in JSON format.

filterCriteria

Represents the criteria used to filter the malware scan entries.

Type: ListMalwareScansFilterCriteria object

Required: No

sortCriteria

Represents the criteria used for sorting malware scan entries.

Type: SortCriteria object

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "scans": [ 
      { 
         "resourceArn": "string",
         "resourceType": "string",
         "scanCompletedAt": number,
         "scanId": "string",
         "scanResultStatus": "string",
         "scanStartedAt": number,
         "scanStatus": "string",
         "scanType": "string"
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

nextToken

The pagination parameter to be used on the next list operation to retrieve more scans.

Type: String

scans

The list of malware scans associated with the provided input parameters.

Type: Array of MalwareScan objects

Errors

For information about the errors that are common to all actions, see Common Errors.

BadRequestException

A bad request exception object.

Message: The error message.
Type: The error type.

HTTP Status Code: 400

InternalServerErrorException

An internal server error exception object.

Message: The error message.
Type: The error type.

HTTP Status Code: 500