@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonCodeGuruSecurityClient extends AmazonWebServiceClient implements AmazonCodeGuruSecurity
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.
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
BatchGetFindingsResult |
batchGetFindings(BatchGetFindingsRequest request)
Returns a list of all requested findings.
|
static AmazonCodeGuruSecurityClientBuilder |
builder() |
CreateScanResult |
createScan(CreateScanRequest request)
Use to create a scan using code uploaded to an S3 bucket.
|
CreateUploadUrlResult |
createUploadUrl(CreateUploadUrlRequest request)
Generates a pre-signed URL and request headers used to upload a code resource.
|
GetAccountConfigurationResult |
getAccountConfiguration(GetAccountConfigurationRequest request)
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 request)
Returns a list of all findings generated by a particular scan.
|
GetMetricsSummaryResult |
getMetricsSummary(GetMetricsSummaryRequest request)
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 request)
Returns details about a scan, including whether or not a scan has completed.
|
ListFindingsMetricsResult |
listFindingsMetrics(ListFindingsMetricsRequest request)
Returns metrics about all findings in an account within a specified time range.
|
ListScansResult |
listScans(ListScansRequest request)
Returns a list of all the standard scans in an account.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
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 request)
Use to add one or more tags to an existing scan.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Use to remove one or more tags from an existing scan.
|
UpdateAccountConfigurationResult |
updateAccountConfiguration(UpdateAccountConfigurationRequest request)
Use to update account-level configuration with an encryption key.
|
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset
public static AmazonCodeGuruSecurityClientBuilder builder()
public BatchGetFindingsResult batchGetFindings(BatchGetFindingsRequest request)
Returns a list of all requested findings.
batchGetFindings
in interface AmazonCodeGuruSecurity
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.public CreateScanResult createScan(CreateScanRequest request)
Use to create a scan using code uploaded to an S3 bucket.
createScan
in interface AmazonCodeGuruSecurity
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.public CreateUploadUrlResult createUploadUrl(CreateUploadUrlRequest request)
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.
createUploadUrl
in interface AmazonCodeGuruSecurity
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.public GetAccountConfigurationResult getAccountConfiguration(GetAccountConfigurationRequest request)
Use to get account level configuration.
getAccountConfiguration
in interface AmazonCodeGuruSecurity
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.public GetFindingsResult getFindings(GetFindingsRequest request)
Returns a list of all findings generated by a particular scan.
getFindings
in interface AmazonCodeGuruSecurity
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.public GetMetricsSummaryResult getMetricsSummary(GetMetricsSummaryRequest request)
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.
getMetricsSummary
in interface AmazonCodeGuruSecurity
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.public GetScanResult getScan(GetScanRequest request)
Returns details about a scan, including whether or not a scan has completed.
getScan
in interface AmazonCodeGuruSecurity
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.public ListFindingsMetricsResult listFindingsMetrics(ListFindingsMetricsRequest request)
Returns metrics about all findings in an account within a specified time range.
listFindingsMetrics
in interface AmazonCodeGuruSecurity
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.public ListScansResult listScans(ListScansRequest request)
Returns a list of all the standard scans in an account. Does not return express scans.
listScans
in interface AmazonCodeGuruSecurity
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.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
Returns a list of all tags associated with a scan.
listTagsForResource
in interface AmazonCodeGuruSecurity
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.public TagResourceResult tagResource(TagResourceRequest request)
Use to add one or more tags to an existing scan.
tagResource
in interface AmazonCodeGuruSecurity
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.public UntagResourceResult untagResource(UntagResourceRequest request)
Use to remove one or more tags from an existing scan.
untagResource
in interface AmazonCodeGuruSecurity
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.public UpdateAccountConfigurationResult updateAccountConfiguration(UpdateAccountConfigurationRequest request)
Use to update account-level configuration with an encryption key.
updateAccountConfiguration
in interface AmazonCodeGuruSecurity
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.public 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 the request.
getCachedResponseMetadata
in interface AmazonCodeGuruSecurity
request
- The originally executed requestpublic void shutdown()
AmazonWebServiceClient
shutdown
in interface AmazonCodeGuruSecurity
shutdown
in class AmazonWebServiceClient