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

GetCisScanReport

Retrieves a CIS scan report.

Request Syntax


POST /cis/scan/report/get HTTP/1.1
Content-type: application/json

{
   "reportFormat": "string",
   "scanArn": "string",
   "targetAccounts": [ "string" ]
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

reportFormat

The format of the report. Valid values are PDF and CSV. If no value is specified, the report format defaults to PDF.

Type: String

Valid Values: PDF | CSV

Required: No

scanArn

The scan ARN.

Type: String

Pattern: ^arn:aws(-us-gov|-cn)?:inspector2:[-.a-z0-9]{0,20}:\d{12}:owner/(\d{12}|o-[a-z0-9]{10,32})/cis-scan/[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Required: Yes

targetAccounts

The target accounts.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 1 item.

Length Constraints: Fixed length of 12.

Pattern: ^\d{12}$

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "status": "string",
   "url": "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.

status

The status.

Type: String

Valid Values: SUCCEEDED | FAILED | IN_PROGRESS

url

The URL where a PDF or CSV of the CIS scan report can be downloaded.

Type: String

Errors

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

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

The request has failed due to an internal failure of the Amazon Inspector service.

HTTP Status Code: 500

ResourceNotFoundException

The operation tried to access an invalid resource. Make sure the resource is specified correctly.

HTTP Status Code: 404

ThrottlingException

The limit on the number of requests per second was exceeded.

HTTP Status Code: 429

ValidationException

The request has failed validation due to missing required fields or having invalid inputs.

HTTP Status Code: 400