CreateFindingsReport - Inspector

CreateFindingsReport

Creates a finding report.

Request Syntax

POST /reporting/create HTTP/1.1 Content-type: application/json { "filterCriteria": { "awsAccountId": [ { "comparison": "string", "value": "string" } ], "componentId": [ { "comparison": "string", "value": "string" } ], "componentType": [ { "comparison": "string", "value": "string" } ], "ec2InstanceImageId": [ { "comparison": "string", "value": "string" } ], "ec2InstanceSubnetId": [ { "comparison": "string", "value": "string" } ], "ec2InstanceVpcId": [ { "comparison": "string", "value": "string" } ], "ecrImageArchitecture": [ { "comparison": "string", "value": "string" } ], "ecrImageHash": [ { "comparison": "string", "value": "string" } ], "ecrImagePushedAt": [ { "endInclusive": number, "startInclusive": number } ], "ecrImageRegistry": [ { "comparison": "string", "value": "string" } ], "ecrImageRepositoryName": [ { "comparison": "string", "value": "string" } ], "ecrImageTags": [ { "comparison": "string", "value": "string" } ], "findingArn": [ { "comparison": "string", "value": "string" } ], "findingStatus": [ { "comparison": "string", "value": "string" } ], "findingType": [ { "comparison": "string", "value": "string" } ], "firstObservedAt": [ { "endInclusive": number, "startInclusive": number } ], "inspectorScore": [ { "lowerInclusive": number, "upperInclusive": number } ], "lastObservedAt": [ { "endInclusive": number, "startInclusive": number } ], "networkProtocol": [ { "comparison": "string", "value": "string" } ], "portRange": [ { "beginInclusive": number, "endInclusive": number } ], "relatedVulnerabilities": [ { "comparison": "string", "value": "string" } ], "resourceId": [ { "comparison": "string", "value": "string" } ], "resourceTags": [ { "comparison": "string", "key": "string", "value": "string" } ], "resourceType": [ { "comparison": "string", "value": "string" } ], "severity": [ { "comparison": "string", "value": "string" } ], "title": [ { "comparison": "string", "value": "string" } ], "updatedAt": [ { "endInclusive": number, "startInclusive": number } ], "vendorSeverity": [ { "comparison": "string", "value": "string" } ], "vulnerabilityId": [ { "comparison": "string", "value": "string" } ], "vulnerabilitySource": [ { "comparison": "string", "value": "string" } ], "vulnerablePackages": [ { "architecture": { "comparison": "string", "value": "string" }, "epoch": { "lowerInclusive": number, "upperInclusive": number }, "name": { "comparison": "string", "value": "string" }, "release": { "comparison": "string", "value": "string" }, "sourceLayerHash": { "comparison": "string", "value": "string" }, "version": { "comparison": "string", "value": "string" } } ] }, "reportFormat": "string", "s3Destination": { "bucketName": "string", "keyPrefix": "string", "kmsKeyArn": "string" } }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

filterCriteria

The filter criteria to apply to the results of the finding report.

Type: FilterCriteria object

Required: No

reportFormat

The format to generate the report in.

Type: String

Valid Values: CSV | JSON

Required: Yes

s3Destination

The Amazon S3 export destination for the report.

Type: Destination object

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "reportId": "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.

reportId

The ID of the report.

Type: String

Pattern: \b[a-f0-9]{8}\b-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-\b[a-f0-9]{12}\b

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

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: