@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonCodeGuruSecurity
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
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.
Modifier and Type | Field and Description |
---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
Modifier and Type | Method and Description |
---|---|
BatchGetFindingsResult |
batchGetFindings(BatchGetFindingsRequest batchGetFindingsRequest)
Returns a list of all requested findings.
|
CreateScanResult |
createScan(CreateScanRequest createScanRequest)
Use to create a scan using code uploaded to an S3 bucket.
|
CreateUploadUrlResult |
createUploadUrl(CreateUploadUrlRequest createUploadUrlRequest)
Generates a pre-signed URL and request headers used to upload a code resource.
|
GetAccountConfigurationResult |
getAccountConfiguration(GetAccountConfigurationRequest getAccountConfigurationRequest)
Use to get account level configuration.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetFindingsResult |
getFindings(GetFindingsRequest getFindingsRequest)
Returns a list of all findings generated by a particular scan.
|
GetMetricsSummaryResult |
getMetricsSummary(GetMetricsSummaryRequest getMetricsSummaryRequest)
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.
|
GetScanResult |
getScan(GetScanRequest getScanRequest)
Returns details about a scan, including whether or not a scan has completed.
|
ListFindingsMetricsResult |
listFindingsMetrics(ListFindingsMetricsRequest listFindingsMetricsRequest)
Returns metrics about all findings in an account within a specified time range.
|
ListScansResult |
listScans(ListScansRequest listScansRequest)
Returns a list of all the standard scans in an account.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Returns a list of all tags associated with a scan.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
TagResourceResult |
tagResource(TagResourceRequest tagResourceRequest)
Use to add one or more tags to an existing scan.
|
UntagResourceResult |
untagResource(UntagResourceRequest untagResourceRequest)
Use to remove one or more tags from an existing scan.
|
UpdateAccountConfigurationResult |
updateAccountConfiguration(UpdateAccountConfigurationRequest updateAccountConfigurationRequest)
Use to update account-level configuration with an encryption key.
|
static final String ENDPOINT_PREFIX
BatchGetFindingsResult batchGetFindings(BatchGetFindingsRequest batchGetFindingsRequest)
Returns a list of all requested findings.
batchGetFindingsRequest
- InternalServerException
- The server encountered an internal error and is unable to complete the request.ThrottlingException
- The request was denied due to request throttling.ValidationException
- The input fails to satisfy the specified constraints.AccessDeniedException
- You do not have sufficient access to perform this action.CreateScanResult createScan(CreateScanRequest createScanRequest)
Use to create a scan using code uploaded to an S3 bucket.
createScanRequest
- InternalServerException
- The server encountered an internal error and is unable to complete the request.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.ResourceNotFoundException
- The resource specified in the request was not found.ThrottlingException
- The request was denied due to request throttling.ValidationException
- The input fails to satisfy the specified constraints.AccessDeniedException
- You do not have sufficient access to perform this action.CreateUploadUrlResult createUploadUrl(CreateUploadUrlRequest createUploadUrlRequest)
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.
createUploadUrlRequest
- InternalServerException
- The server encountered an internal error and is unable to complete the request.ThrottlingException
- The request was denied due to request throttling.ValidationException
- The input fails to satisfy the specified constraints.AccessDeniedException
- You do not have sufficient access to perform this action.GetAccountConfigurationResult getAccountConfiguration(GetAccountConfigurationRequest getAccountConfigurationRequest)
Use to get account level configuration.
getAccountConfigurationRequest
- InternalServerException
- The server encountered an internal error and is unable to complete the request.ThrottlingException
- The request was denied due to request throttling.ValidationException
- The input fails to satisfy the specified constraints.AccessDeniedException
- You do not have sufficient access to perform this action.GetFindingsResult getFindings(GetFindingsRequest getFindingsRequest)
Returns a list of all findings generated by a particular scan.
getFindingsRequest
- InternalServerException
- The server encountered an internal error and is unable to complete the request.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.ResourceNotFoundException
- The resource specified in the request was not found.ThrottlingException
- The request was denied due to request throttling.ValidationException
- The input fails to satisfy the specified constraints.AccessDeniedException
- You do not have sufficient access to perform this action.GetMetricsSummaryResult getMetricsSummary(GetMetricsSummaryRequest getMetricsSummaryRequest)
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.
getMetricsSummaryRequest
- InternalServerException
- The server encountered an internal error and is unable to complete the request.ThrottlingException
- The request was denied due to request throttling.ValidationException
- The input fails to satisfy the specified constraints.AccessDeniedException
- You do not have sufficient access to perform this action.GetScanResult getScan(GetScanRequest getScanRequest)
Returns details about a scan, including whether or not a scan has completed.
getScanRequest
- InternalServerException
- The server encountered an internal error and is unable to complete the request.ResourceNotFoundException
- The resource specified in the request was not found.ThrottlingException
- The request was denied due to request throttling.AccessDeniedException
- You do not have sufficient access to perform this action.ListFindingsMetricsResult listFindingsMetrics(ListFindingsMetricsRequest listFindingsMetricsRequest)
Returns metrics about all findings in an account within a specified time range.
listFindingsMetricsRequest
- InternalServerException
- The server encountered an internal error and is unable to complete the request.ThrottlingException
- The request was denied due to request throttling.ValidationException
- The input fails to satisfy the specified constraints.AccessDeniedException
- You do not have sufficient access to perform this action.ListScansResult listScans(ListScansRequest listScansRequest)
Returns a list of all the standard scans in an account. Does not return express scans.
listScansRequest
- InternalServerException
- The server encountered an internal error and is unable to complete the request.ThrottlingException
- The request was denied due to request throttling.ValidationException
- The input fails to satisfy the specified constraints.AccessDeniedException
- You do not have sufficient access to perform this action.ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Returns a list of all tags associated with a scan.
listTagsForResourceRequest
- InternalServerException
- The server encountered an internal error and is unable to complete the request.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.ResourceNotFoundException
- The resource specified in the request was not found.ThrottlingException
- The request was denied due to request throttling.ValidationException
- The input fails to satisfy the specified constraints.AccessDeniedException
- You do not have sufficient access to perform this action.TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
Use to add one or more tags to an existing scan.
tagResourceRequest
- InternalServerException
- The server encountered an internal error and is unable to complete the request.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.ResourceNotFoundException
- The resource specified in the request was not found.ThrottlingException
- The request was denied due to request throttling.ValidationException
- The input fails to satisfy the specified constraints.AccessDeniedException
- You do not have sufficient access to perform this action.UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
Use to remove one or more tags from an existing scan.
untagResourceRequest
- InternalServerException
- The server encountered an internal error and is unable to complete the request.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.ResourceNotFoundException
- The resource specified in the request was not found.ThrottlingException
- The request was denied due to request throttling.ValidationException
- The input fails to satisfy the specified constraints.AccessDeniedException
- You do not have sufficient access to perform this action.UpdateAccountConfigurationResult updateAccountConfiguration(UpdateAccountConfigurationRequest updateAccountConfigurationRequest)
Use to update account-level configuration with an encryption key.
updateAccountConfigurationRequest
- InternalServerException
- The server encountered an internal error and is unable to complete the request.ResourceNotFoundException
- The resource specified in the request was not found.ThrottlingException
- The request was denied due to request throttling.ValidationException
- The input fails to satisfy the specified constraints.AccessDeniedException
- You do not have sufficient access to perform this action.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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.
request
- The originally executed request.