AmazonCodeGuruSecurity (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.795

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

com.amazonaws.services.codegurusecurity

Interface AmazonCodeGuruSecurity

All Known Subinterfaces:

AmazonCodeGuruSecurityAsync

All Known Implementing Classes:

AbstractAmazonCodeGuruSecurity, AbstractAmazonCodeGuruSecurityAsync, AmazonCodeGuruSecurityAsyncClient, AmazonCodeGuruSecurityClient
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonCodeGuruSecurity
```
Interface for accessing Amazon CodeGuru Security.
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.

Field Summary

Fields
Modifier and Type Field and Description

static String ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.

Fields
Modifier and Type	Field and Description
`static String`	`ENDPOINT_PREFIX` The region metadata service name for computing region endpoints.

Method Summary

All Methods
Modifier and Type	Method and Description
`BatchGetFindingsResult`	`batchGetFindings (BatchGetFindingsRequest batchGetFindingsRequest)` Returns a list of requested findings from standard scans.
`CreateScanResult`	`createScan (CreateScanRequest createScanRequest)` Use to create a scan using code uploaded to an Amazon S3 bucket.
`CreateUploadUrlResult`	`createUploadUrl (CreateUploadUrlRequest createUploadUrlRequest)` Generates a pre-signed URL, request headers used to upload a code resource, and code artifact identifier for the uploaded resource.
`GetAccountConfigurationResult`	`getAccountConfiguration (GetAccountConfigurationRequest getAccountConfigurationRequest)` Use to get the encryption configuration for an account.
`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 a summary of metrics for 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 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 the encryption configuration for an account.

- Field Detail
  - ENDPOINT_PREFIX
```
static final String ENDPOINT_PREFIX
```
    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 Also:
    
    RegionUtils.getRegionsForService(String), Constant Field Values
- Method Detail
  - batchGetFindings
```
BatchGetFindingsResult batchGetFindings(BatchGetFindingsRequest batchGetFindingsRequest)
```
    Returns a list of requested findings from standard scans.
    
    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
```
CreateScanResult createScan(CreateScanRequest createScanRequest)
```
    Use to create a scan using code uploaded to an Amazon S3 bucket.
    
    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
```
CreateUploadUrlResult createUploadUrl(CreateUploadUrlRequest createUploadUrlRequest)
```
    Generates a pre-signed URL, request headers used to upload a code resource, and code artifact identifier for the uploaded resource.
    
    You can upload your code resource to the URL with the request headers using any HTTP client.
    
    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
```
GetAccountConfigurationResult getAccountConfiguration(GetAccountConfigurationRequest getAccountConfigurationRequest)
```
    Use to get the encryption configuration for an account.
    
    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
```
GetFindingsResult getFindings(GetFindingsRequest getFindingsRequest)
```
    Returns a list of all findings generated by a particular scan.
    
    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
```
GetMetricsSummaryResult getMetricsSummary(GetMetricsSummaryRequest getMetricsSummaryRequest)
```
    Returns a summary of metrics for 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.
    
    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
```
GetScanResult getScan(GetScanRequest getScanRequest)
```
    Returns details about a scan, including whether or not a scan has completed.
    
    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.
    
    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
  - listFindingsMetrics
```
ListFindingsMetricsResult listFindingsMetrics(ListFindingsMetricsRequest listFindingsMetricsRequest)
```
    Returns metrics about all findings in an account within a specified time range.
    
    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
```
ListScansResult listScans(ListScansRequest listScansRequest)
```
    Returns a list of all scans in an account. Does not return EXPRESS scans.
    
    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
```
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
```
    Returns a list of all tags associated with a scan.
    
    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
```
TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
```
    Use to add one or more tags to an existing scan.
    
    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
```
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
```
    Use to remove one or more tags from an existing scan.
    
    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
```
UpdateAccountConfigurationResult updateAccountConfiguration(UpdateAccountConfigurationRequest updateAccountConfigurationRequest)
```
    Use to update the encryption configuration for an account.
    
    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
  - shutdown
```
void shutdown()
```
    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.
  - getCachedResponseMetadata
```
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 a request.
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

AWS SDK for Java 1.x API Reference - 1.12.795

Interface AmazonCodeGuruSecurity

Field Summary

Method Summary

Field Detail

ENDPOINT_PREFIX

Method Detail

batchGetFindings

createScan

createUploadUrl

getAccountConfiguration

getFindings

getMetricsSummary

getScan

listFindingsMetrics

listScans

listTagsForResource

tagResource

untagResource

updateAccountConfiguration

shutdown

getCachedResponseMetadata