com.amazonaws.services.codegurusecurity

Class AmazonCodeGuruSecurityClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.codegurusecurity.AmazonCodeGuruSecurityClient

All Implemented Interfaces:

AmazonCodeGuruSecurity

Direct Known Subclasses:

AmazonCodeGuruSecurityAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonCodeGuruSecurityClient
extends AmazonWebServiceClient
implements AmazonCodeGuruSecurity

Client for accessing Amazon CodeGuru Security. All service calls made using this client are blocking, and will not return until the service call completes.

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.

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.codegurusecurity.AmazonCodeGuruSecurity

ENDPOINT_PREFIX

Method Summary

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.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

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

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static AmazonCodeGuruSecurityClientBuilder builder()

batchGetFindings

public BatchGetFindingsResult batchGetFindings(BatchGetFindingsRequest request)

Returns a list of all requested findings.

Specified by:

batchGetFindings in interface AmazonCodeGuruSecurity

Parameters:

batchGetFindingsRequest -

Returns:

Result of the BatchGetFindings operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

createScan

public CreateScanResult createScan(CreateScanRequest request)

Use to create a scan using code uploaded to an S3 bucket.

Specified by:

createScan in interface AmazonCodeGuruSecurity

Parameters:

createScanRequest -

Returns:

Result of the CreateScan operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

createUploadUrl

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.

Specified by:

createUploadUrl in interface AmazonCodeGuruSecurity

Parameters:

createUploadUrlRequest -

Returns:

Result of the CreateUploadUrl operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getAccountConfiguration

public GetAccountConfigurationResult getAccountConfiguration(GetAccountConfigurationRequest request)

Use to get account level configuration.

Specified by:

getAccountConfiguration in interface AmazonCodeGuruSecurity

Parameters:

getAccountConfigurationRequest -

Returns:

Result of the GetAccountConfiguration operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getFindings

public GetFindingsResult getFindings(GetFindingsRequest request)

Returns a list of all findings generated by a particular scan.

Specified by:

getFindings in interface AmazonCodeGuruSecurity

Parameters:

getFindingsRequest -

Returns:

Result of the GetFindings operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getMetricsSummary

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.

Specified by:

getMetricsSummary in interface AmazonCodeGuruSecurity

Parameters:

getMetricsSummaryRequest -

Returns:

Result of the GetMetricsSummary operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getScan

public GetScanResult getScan(GetScanRequest request)

Returns details about a scan, including whether or not a scan has completed.

Specified by:

getScan in interface AmazonCodeGuruSecurity

Parameters:

getScanRequest -

Returns:

Result of the GetScan operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listFindingsMetrics

public ListFindingsMetricsResult listFindingsMetrics(ListFindingsMetricsRequest request)

Returns metrics about all findings in an account within a specified time range.

Specified by:

listFindingsMetrics in interface AmazonCodeGuruSecurity

Parameters:

listFindingsMetricsRequest -

Returns:

Result of the ListFindingsMetrics operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listScans

public ListScansResult listScans(ListScansRequest request)

Returns a list of all the standard scans in an account. Does not return express scans.

Specified by:

listScans in interface AmazonCodeGuruSecurity

Parameters:

listScansRequest -

Returns:

Result of the ListScans operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listTagsForResource

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

Returns a list of all tags associated with a scan.

Specified by:

listTagsForResource in interface AmazonCodeGuruSecurity

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

tagResource

public TagResourceResult tagResource(TagResourceRequest request)

Use to add one or more tags to an existing scan.

Specified by:

tagResource in interface AmazonCodeGuruSecurity

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

untagResource

public UntagResourceResult untagResource(UntagResourceRequest request)

Use to remove one or more tags from an existing scan.

Specified by:

untagResource in interface AmazonCodeGuruSecurity

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

updateAccountConfiguration

public UpdateAccountConfigurationResult updateAccountConfiguration(UpdateAccountConfigurationRequest request)

Use to update account-level configuration with an encryption key.

Specified by:

updateAccountConfiguration in interface AmazonCodeGuruSecurity

Parameters:

updateAccountConfigurationRequest -

Returns:

Result of the UpdateAccountConfiguration operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getCachedResponseMetadata

public 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. 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 the request.

Specified by:

getCachedResponseMetadata in interface AmazonCodeGuruSecurity

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.

shutdown

public void shutdown()

Description copied from class: AmazonWebServiceClient

Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AmazonCodeGuruSecurity

Overrides:

shutdown in class AmazonWebServiceClient