View Source AWS.CodeGuruSecurity (aws-elixir v1.0.4)

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.

Link to this section Summary

Functions

Returns a list of requested findings from standard scans.

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

Generates a pre-signed URL, request headers used to upload a code resource, and code artifact identifier for the uploaded resource.

Use to get the encryption configuration for an account.

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.

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

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

Returns a list of all tags associated with a scan.

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

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

Use to update the encryption configuration for an account.

Link to this section Functions

Link to this function

batch_get_findings(client, input, options \\ [])

View Source

Returns a list of requested findings from standard scans.

Link to this function

create_scan(client, input, options \\ [])

View Source

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

Link to this function

create_upload_url(client, input, options \\ [])

View Source

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.

Link to this function

get_account_configuration(client, options \\ [])

View Source

Use to get the encryption configuration for an account.

Link to this function

get_findings(client, scan_name, max_results \\ nil, next_token \\ nil, status \\ nil, options \\ [])

View Source

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

Link to this function

get_metrics_summary(client, date, options \\ [])

View Source

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.

Link to this function

get_scan(client, scan_name, run_id \\ nil, options \\ [])

View Source

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

Link to this function

list_findings_metrics(client, end_date, max_results \\ nil, next_token \\ nil, start_date, options \\ [])

View Source

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

Link to this function

list_scans(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Returns a list of all scans in an account.

Does not return EXPRESS scans.

Link to this function

list_tags_for_resource(client, resource_arn, options \\ [])

View Source

Returns a list of all tags associated with a scan.

Link to this function

tag_resource(client, resource_arn, input, options \\ [])

View Source

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

Link to this function

untag_resource(client, resource_arn, input, options \\ [])

View Source

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

Link to this function

update_account_configuration(client, input, options \\ [])

View Source

Use to update the encryption configuration for an account.