

# CreateFindingsReport
<a name="API_CreateFindingsReport"></a>

Creates a finding report. By default only `ACTIVE` findings are returned in the report. To see `SUPRESSED` or `CLOSED` findings you must specify a value for the `findingStatus` filter criteria. 

## Request Syntax
<a name="API_CreateFindingsReport_RequestSyntax"></a>

```
POST /reporting/create HTTP/1.1
Content-type: application/json

{
   "filterCriteria": { 
      "awsAccountId": [ 
         { 
            "comparison": "string",
            "value": "string"
         }
      ],
      "codeRepositoryProjectName": [ 
         { 
            "comparison": "string",
            "value": "string"
         }
      ],
      "codeRepositoryProviderType": [ 
         { 
            "comparison": "string",
            "value": "string"
         }
      ],
      "codeVulnerabilityDetectorName": [ 
         { 
            "comparison": "string",
            "value": "string"
         }
      ],
      "codeVulnerabilityDetectorTags": [ 
         { 
            "comparison": "string",
            "value": "string"
         }
      ],
      "codeVulnerabilityFilePath": [ 
         { 
            "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"
         }
      ],
      "ecrImageInUseCount": [ 
         { 
            "lowerInclusive": number,
            "upperInclusive": number
         }
      ],
      "ecrImageLastInUseAt": [ 
         { 
            "endInclusive": number,
            "startInclusive": number
         }
      ],
      "ecrImagePushedAt": [ 
         { 
            "endInclusive": number,
            "startInclusive": number
         }
      ],
      "ecrImageRegistry": [ 
         { 
            "comparison": "string",
            "value": "string"
         }
      ],
      "ecrImageRepositoryName": [ 
         { 
            "comparison": "string",
            "value": "string"
         }
      ],
      "ecrImageTags": [ 
         { 
            "comparison": "string",
            "value": "string"
         }
      ],
      "epssScore": [ 
         { 
            "lowerInclusive": number,
            "upperInclusive": number
         }
      ],
      "exploitAvailable": [ 
         { 
            "comparison": "string",
            "value": "string"
         }
      ],
      "findingArn": [ 
         { 
            "comparison": "string",
            "value": "string"
         }
      ],
      "findingStatus": [ 
         { 
            "comparison": "string",
            "value": "string"
         }
      ],
      "findingType": [ 
         { 
            "comparison": "string",
            "value": "string"
         }
      ],
      "firstObservedAt": [ 
         { 
            "endInclusive": number,
            "startInclusive": number
         }
      ],
      "fixAvailable": [ 
         { 
            "comparison": "string",
            "value": "string"
         }
      ],
      "inspectorScore": [ 
         { 
            "lowerInclusive": number,
            "upperInclusive": number
         }
      ],
      "lambdaFunctionExecutionRoleArn": [ 
         { 
            "comparison": "string",
            "value": "string"
         }
      ],
      "lambdaFunctionLastModifiedAt": [ 
         { 
            "endInclusive": number,
            "startInclusive": number
         }
      ],
      "lambdaFunctionLayers": [ 
         { 
            "comparison": "string",
            "value": "string"
         }
      ],
      "lambdaFunctionName": [ 
         { 
            "comparison": "string",
            "value": "string"
         }
      ],
      "lambdaFunctionRuntime": [ 
         { 
            "comparison": "string",
            "value": "string"
         }
      ],
      "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
            },
            "filePath": { 
               "comparison": "string",
               "value": "string"
            },
            "name": { 
               "comparison": "string",
               "value": "string"
            },
            "release": { 
               "comparison": "string",
               "value": "string"
            },
            "sourceLambdaLayerArn": { 
               "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
<a name="API_CreateFindingsReport_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_CreateFindingsReport_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [filterCriteria](#API_CreateFindingsReport_RequestSyntax) **   <a name="inspector2-CreateFindingsReport-request-filterCriteria"></a>
The filter criteria to apply to the results of the finding report.  
Type: [FilterCriteria](API_FilterCriteria.md) object  
Required: No

 ** [reportFormat](#API_CreateFindingsReport_RequestSyntax) **   <a name="inspector2-CreateFindingsReport-request-reportFormat"></a>
The format to generate the report in.  
Type: String  
Valid Values: `CSV | JSON`   
Required: Yes

 ** [s3Destination](#API_CreateFindingsReport_RequestSyntax) **   <a name="inspector2-CreateFindingsReport-request-s3Destination"></a>
The Amazon S3 export destination for the report.  
Type: [Destination](API_Destination.md) object  
Required: Yes

## Response Syntax
<a name="API_CreateFindingsReport_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "reportId": "string"
}
```

## Response Elements
<a name="API_CreateFindingsReport_ResponseElements"></a>

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](#API_CreateFindingsReport_ResponseSyntax) **   <a name="inspector2-CreateFindingsReport-response-reportId"></a>
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
<a name="API_CreateFindingsReport_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
 For `Enable`, you receive this error if you attempt to use a feature in an unsupported AWS Region.   
HTTP Status Code: 403

 ** InternalServerException **   
The request has failed due to an internal failure of the Amazon Inspector service.    
 ** retryAfterSeconds **   
The number of seconds to wait before retrying the request.
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.    
 ** retryAfterSeconds **   
The number of seconds to wait before retrying the request.
HTTP Status Code: 429

 ** ValidationException **   
The request has failed validation due to missing required fields or having invalid inputs.    
 ** fields **   
The fields that failed validation.  
 ** reason **   
The reason for the validation failure.
HTTP Status Code: 400

## See Also
<a name="API_CreateFindingsReport_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/inspector2-2020-06-08/CreateFindingsReport) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/inspector2-2020-06-08/CreateFindingsReport) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/inspector2-2020-06-08/CreateFindingsReport) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/inspector2-2020-06-08/CreateFindingsReport) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/inspector2-2020-06-08/CreateFindingsReport) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/inspector2-2020-06-08/CreateFindingsReport) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/inspector2-2020-06-08/CreateFindingsReport) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/inspector2-2020-06-08/CreateFindingsReport) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/inspector2-2020-06-08/CreateFindingsReport) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/inspector2-2020-06-08/CreateFindingsReport) 