* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from * {@link com.amazonaws.services.codegurusecurity.AbstractAmazonCodeGuruSecurity} instead. *
*
*
* Amazon CodeGuru Security is in preview release and is subject to change.
*
* This section provides documentation for the Amazon CodeGuru Security API operations. CodeGuru Security is a service * that uses program analysis and machine learning to detect security policy violations and vulnerabilities, and * recommends ways to address these security risks. *
** By proactively detecting and providing recommendations for addressing security risks, CodeGuru Security improves the * overall security of your application code. For more information about CodeGuru Security, see the Amazon CodeGuru * Security User Guide. *
*/ @Generated("com.amazonaws:aws-java-sdk-code-generator") public interface AmazonCodeGuruSecurity { /** * The region metadata service name for computing region endpoints. You can use this value to retrieve metadata * (such as supported regions) of the service. * * @see RegionUtils#getRegionsForService(String) */ String ENDPOINT_PREFIX = "codeguru-security"; /** ** Returns a list of all requested findings. *
* * @param batchGetFindingsRequest * @return Result of the BatchGetFindings operation returned by the service. * @throws InternalServerException * The server encountered an internal error and is unable to complete the request. * @throws ThrottlingException * The request was denied due to request throttling. * @throws ValidationException * The input fails to satisfy the specified constraints. * @throws AccessDeniedException * You do not have sufficient access to perform this action. * @sample AmazonCodeGuruSecurity.BatchGetFindings * @see AWS API Documentation */ BatchGetFindingsResult batchGetFindings(BatchGetFindingsRequest batchGetFindingsRequest); /** ** Use to create a scan using code uploaded to an S3 bucket. *
* * @param createScanRequest * @return Result of the CreateScan operation returned by the service. * @throws InternalServerException * The server encountered an internal error and is unable to complete the request. * @throws ConflictException * The requested operation would cause a conflict with the current state of a service resource associated * with the request. Resolve the conflict before retrying this request. * @throws ResourceNotFoundException * The resource specified in the request was not found. * @throws ThrottlingException * The request was denied due to request throttling. * @throws ValidationException * The input fails to satisfy the specified constraints. * @throws AccessDeniedException * You do not have sufficient access to perform this action. * @sample AmazonCodeGuruSecurity.CreateScan * @see AWS * API Documentation */ CreateScanResult createScan(CreateScanRequest createScanRequest); /** ** Generates a pre-signed URL and request headers used to upload a code resource. *
** You can upload your code resource to the URL and add the request headers using any HTTP client. *
* * @param createUploadUrlRequest * @return Result of the CreateUploadUrl operation returned by the service. * @throws InternalServerException * The server encountered an internal error and is unable to complete the request. * @throws ThrottlingException * The request was denied due to request throttling. * @throws ValidationException * The input fails to satisfy the specified constraints. * @throws AccessDeniedException * You do not have sufficient access to perform this action. * @sample AmazonCodeGuruSecurity.CreateUploadUrl * @see AWS API Documentation */ CreateUploadUrlResult createUploadUrl(CreateUploadUrlRequest createUploadUrlRequest); /** ** Use to get account level configuration. *
* * @param getAccountConfigurationRequest * @return Result of the GetAccountConfiguration operation returned by the service. * @throws InternalServerException * The server encountered an internal error and is unable to complete the request. * @throws ThrottlingException * The request was denied due to request throttling. * @throws ValidationException * The input fails to satisfy the specified constraints. * @throws AccessDeniedException * You do not have sufficient access to perform this action. * @sample AmazonCodeGuruSecurity.GetAccountConfiguration * @see AWS API Documentation */ GetAccountConfigurationResult getAccountConfiguration(GetAccountConfigurationRequest getAccountConfigurationRequest); /** ** Returns a list of all findings generated by a particular scan. *
* * @param getFindingsRequest * @return Result of the GetFindings operation returned by the service. * @throws InternalServerException * The server encountered an internal error and is unable to complete the request. * @throws ConflictException * The requested operation would cause a conflict with the current state of a service resource associated * with the request. Resolve the conflict before retrying this request. * @throws ResourceNotFoundException * The resource specified in the request was not found. * @throws ThrottlingException * The request was denied due to request throttling. * @throws ValidationException * The input fails to satisfy the specified constraints. * @throws AccessDeniedException * You do not have sufficient access to perform this action. * @sample AmazonCodeGuruSecurity.GetFindings * @see AWS * API Documentation */ GetFindingsResult getFindings(GetFindingsRequest getFindingsRequest); /** ** Returns top level metrics about an account from a specified date, including number of open findings, the * categories with most findings, the scans with most open findings, and scans with most open critical findings. *
* * @param getMetricsSummaryRequest * @return Result of the GetMetricsSummary operation returned by the service. * @throws InternalServerException * The server encountered an internal error and is unable to complete the request. * @throws ThrottlingException * The request was denied due to request throttling. * @throws ValidationException * The input fails to satisfy the specified constraints. * @throws AccessDeniedException * You do not have sufficient access to perform this action. * @sample AmazonCodeGuruSecurity.GetMetricsSummary * @see AWS API Documentation */ GetMetricsSummaryResult getMetricsSummary(GetMetricsSummaryRequest getMetricsSummaryRequest); /** ** Returns details about a scan, including whether or not a scan has completed. *
* * @param getScanRequest * @return Result of the GetScan operation returned by the service. * @throws InternalServerException * The server encountered an internal error and is unable to complete the request. * @throws ResourceNotFoundException * The resource specified in the request was not found. * @throws ThrottlingException * The request was denied due to request throttling. * @throws AccessDeniedException * You do not have sufficient access to perform this action. * @sample AmazonCodeGuruSecurity.GetScan * @see AWS API * Documentation */ GetScanResult getScan(GetScanRequest getScanRequest); /** ** Returns metrics about all findings in an account within a specified time range. *
* * @param listFindingsMetricsRequest * @return Result of the ListFindingsMetrics operation returned by the service. * @throws InternalServerException * The server encountered an internal error and is unable to complete the request. * @throws ThrottlingException * The request was denied due to request throttling. * @throws ValidationException * The input fails to satisfy the specified constraints. * @throws AccessDeniedException * You do not have sufficient access to perform this action. * @sample AmazonCodeGuruSecurity.ListFindingsMetrics * @see AWS API Documentation */ ListFindingsMetricsResult listFindingsMetrics(ListFindingsMetricsRequest listFindingsMetricsRequest); /** ** Returns a list of all the standard scans in an account. Does not return express scans. *
* * @param listScansRequest * @return Result of the ListScans operation returned by the service. * @throws InternalServerException * The server encountered an internal error and is unable to complete the request. * @throws ThrottlingException * The request was denied due to request throttling. * @throws ValidationException * The input fails to satisfy the specified constraints. * @throws AccessDeniedException * You do not have sufficient access to perform this action. * @sample AmazonCodeGuruSecurity.ListScans * @see AWS * API Documentation */ ListScansResult listScans(ListScansRequest listScansRequest); /** ** Returns a list of all tags associated with a scan. *
* * @param listTagsForResourceRequest * @return Result of the ListTagsForResource operation returned by the service. * @throws InternalServerException * The server encountered an internal error and is unable to complete the request. * @throws ConflictException * The requested operation would cause a conflict with the current state of a service resource associated * with the request. Resolve the conflict before retrying this request. * @throws ResourceNotFoundException * The resource specified in the request was not found. * @throws ThrottlingException * The request was denied due to request throttling. * @throws ValidationException * The input fails to satisfy the specified constraints. * @throws AccessDeniedException * You do not have sufficient access to perform this action. * @sample AmazonCodeGuruSecurity.ListTagsForResource * @see AWS API Documentation */ ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest); /** ** Use to add one or more tags to an existing scan. *
* * @param tagResourceRequest * @return Result of the TagResource operation returned by the service. * @throws InternalServerException * The server encountered an internal error and is unable to complete the request. * @throws ConflictException * The requested operation would cause a conflict with the current state of a service resource associated * with the request. Resolve the conflict before retrying this request. * @throws ResourceNotFoundException * The resource specified in the request was not found. * @throws ThrottlingException * The request was denied due to request throttling. * @throws ValidationException * The input fails to satisfy the specified constraints. * @throws AccessDeniedException * You do not have sufficient access to perform this action. * @sample AmazonCodeGuruSecurity.TagResource * @see AWS * API Documentation */ TagResourceResult tagResource(TagResourceRequest tagResourceRequest); /** ** Use to remove one or more tags from an existing scan. *
* * @param untagResourceRequest * @return Result of the UntagResource operation returned by the service. * @throws InternalServerException * The server encountered an internal error and is unable to complete the request. * @throws ConflictException * The requested operation would cause a conflict with the current state of a service resource associated * with the request. Resolve the conflict before retrying this request. * @throws ResourceNotFoundException * The resource specified in the request was not found. * @throws ThrottlingException * The request was denied due to request throttling. * @throws ValidationException * The input fails to satisfy the specified constraints. * @throws AccessDeniedException * You do not have sufficient access to perform this action. * @sample AmazonCodeGuruSecurity.UntagResource * @see AWS API Documentation */ UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest); /** ** Use to update account-level configuration with an encryption key. *
* * @param updateAccountConfigurationRequest * @return Result of the UpdateAccountConfiguration operation returned by the service. * @throws InternalServerException * The server encountered an internal error and is unable to complete the request. * @throws ResourceNotFoundException * The resource specified in the request was not found. * @throws ThrottlingException * The request was denied due to request throttling. * @throws ValidationException * The input fails to satisfy the specified constraints. * @throws AccessDeniedException * You do not have sufficient access to perform this action. * @sample AmazonCodeGuruSecurity.UpdateAccountConfiguration * @see AWS API Documentation */ UpdateAccountConfigurationResult updateAccountConfiguration(UpdateAccountConfigurationRequest updateAccountConfigurationRequest); /** * Shuts down this client object, releasing any resources that might be held open. This is an optional method, and * callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client * has been shutdown, it should not be used to make any more requests. */ void shutdown(); /** * Returns additional metadata for a previously executed successful request, typically used for debugging issues * where a service isn't acting as expected. This data isn't considered part of the result data returned by an * operation, so it's available through this separate, diagnostic interface. ** Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic * information for an executed request, you should use this method to retrieve it as soon as possible after * executing a request. * * @param request * The originally executed request. * * @return The response metadata for the specified request, or null if none is available. */ ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request); }