Codeguru Security
This page documents function available when using the Codeguru_Security module, created with @service Codeguru_Security.
Index
Main.Codeguru_Security.batch_get_findingsMain.Codeguru_Security.create_scanMain.Codeguru_Security.create_upload_urlMain.Codeguru_Security.get_account_configurationMain.Codeguru_Security.get_findingsMain.Codeguru_Security.get_metrics_summaryMain.Codeguru_Security.get_scanMain.Codeguru_Security.list_findings_metricsMain.Codeguru_Security.list_scansMain.Codeguru_Security.list_tags_for_resourceMain.Codeguru_Security.tag_resourceMain.Codeguru_Security.untag_resourceMain.Codeguru_Security.update_account_configuration
Documentation
Main.Codeguru_Security.batch_get_findings — Methodbatch_get_findings(finding_identifiers)
batch_get_findings(finding_identifiers, params::Dict{String,<:Any})Returns a list of requested findings from standard scans.
Arguments
finding_identifiers: A list of finding identifiers. Each identifier consists of a scanName and a findingId. You retrieve the findingId when you call GetFindings.
Main.Codeguru_Security.create_scan — Methodcreate_scan(resource_id, scan_name)
create_scan(resource_id, scan_name, params::Dict{String,<:Any})Use to create a scan using code uploaded to an Amazon S3 bucket.
Arguments
resource_id: The identifier for the resource object to be scanned.scan_name: The unique name that CodeGuru Security uses to track revisions across multiple scans of the same resource. Only allowed for a STANDARD scan type.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"analysisType": The type of analysis you want CodeGuru Security to perform in the scan, either Security or All. The Security type only generates findings related to security. The All type generates both security findings and quality findings. Defaults to Security type if missing."clientToken": The idempotency token for the request. Amazon CodeGuru Security uses this value to prevent the accidental creation of duplicate scans if there are failures and retries."scanType": The type of scan, either Standard or Express. Defaults to Standard type if missing. Express scans run on limited resources and use a limited set of detectors to analyze your code in near-real time. Standard scans have standard resource limits and use the full set of detectors to analyze your code."tags": An array of key-value pairs used to tag a scan. A tag is a custom attribute label with two parts: A tag key. For example, CostCenter, Environment, or Secret. Tag keys are case sensitive. An optional tag value field. For example, 111122223333, Production, or a team name. Omitting the tag value is the same as using an empty string. Tag values are case sensitive.
Main.Codeguru_Security.create_upload_url — Methodcreate_upload_url(scan_name)
create_upload_url(scan_name, params::Dict{String,<:Any})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.
Arguments
scan_name: The name of the scan that will use the uploaded resource. CodeGuru Security uses the unique scan name to track revisions across multiple scans of the same resource. Use this scanName when you call CreateScan on the code resource you upload to this URL.
Main.Codeguru_Security.get_account_configuration — Methodget_account_configuration()
get_account_configuration(params::Dict{String,<:Any})Use to get the encryption configuration for an account.
Main.Codeguru_Security.get_findings — Methodget_findings(scan_name)
get_findings(scan_name, params::Dict{String,<:Any})Returns a list of all findings generated by a particular scan.
Arguments
scan_name: The name of the scan you want to retrieve findings from.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"maxResults": The maximum number of results to return in the response. Use this parameter when paginating results. If additional results exist beyond the number you specify, the nextToken element is returned in the response. Use nextToken in a subsequent request to retrieve additional results. If not specified, returns 1000 results."nextToken": A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request to continue listing results after the first page."status": The status of the findings you want to get. Pass either Open, Closed, or All.
Main.Codeguru_Security.get_metrics_summary — Methodget_metrics_summary(date)
get_metrics_summary(date, params::Dict{String,<:Any})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.
Arguments
date: The date you want to retrieve summary metrics from, rounded to the nearest day. The date must be within the past two years.
Main.Codeguru_Security.get_scan — Methodget_scan(scan_name)
get_scan(scan_name, params::Dict{String,<:Any})Returns details about a scan, including whether or not a scan has completed.
Arguments
scan_name: The name of the scan you want to view details about.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"runId": UUID that identifies the individual scan run you want to view details about. You retrieve this when you call the CreateScan operation. Defaults to the latest scan run if missing.
Main.Codeguru_Security.list_findings_metrics — Methodlist_findings_metrics(end_date, start_date)
list_findings_metrics(end_date, start_date, params::Dict{String,<:Any})Returns metrics about all findings in an account within a specified time range.
Arguments
end_date: The end date of the interval which you want to retrieve metrics from. Round to the nearest day.start_date: The start date of the interval which you want to retrieve metrics from. Rounds to the nearest day.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"maxResults": The maximum number of results to return in the response. Use this parameter when paginating results. If additional results exist beyond the number you specify, the nextToken element is returned in the response. Use nextToken in a subsequent request to retrieve additional results. If not specified, returns 1000 results."nextToken": A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request to continue listing results after the first page.
Main.Codeguru_Security.list_scans — Methodlist_scans()
list_scans(params::Dict{String,<:Any})Returns a list of all scans in an account. Does not return EXPRESS scans.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"maxResults": The maximum number of results to return in the response. Use this parameter when paginating results. If additional results exist beyond the number you specify, the nextToken element is returned in the response. Use nextToken in a subsequent request to retrieve additional results. If not specified, returns 100 results."nextToken": A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request to continue listing results after the first page.
Main.Codeguru_Security.list_tags_for_resource — Methodlist_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})Returns a list of all tags associated with a scan.
Arguments
resource_arn: The ARN of the ScanName object. You can retrieve this ARN by calling CreateScan, ListScans, or GetScan.
Main.Codeguru_Security.tag_resource — Methodtag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})Use to add one or more tags to an existing scan.
Arguments
resource_arn: The ARN of the ScanName object. You can retrieve this ARN by calling CreateScan, ListScans, or GetScan.tags: An array of key-value pairs used to tag an existing scan. A tag is a custom attribute label with two parts: A tag key. For example, CostCenter, Environment, or Secret. Tag keys are case sensitive. An optional tag value field. For example, 111122223333, Production, or a team name. Omitting the tag value is the same as using an empty string. Tag values are case sensitive.
Main.Codeguru_Security.untag_resource — Methoduntag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})Use to remove one or more tags from an existing scan.
Arguments
resource_arn: The ARN of the ScanName object. You can retrieve this ARN by calling CreateScan, ListScans, or GetScan.tag_keys: A list of keys for each tag you want to remove from a scan.
Main.Codeguru_Security.update_account_configuration — Methodupdate_account_configuration(encryption_config)
update_account_configuration(encryption_config, params::Dict{String,<:Any})Use to update the encryption configuration for an account.
Arguments
encryption_config: The customer-managed KMS key ARN you want to use for encryption. If not specified, CodeGuru Security will use an AWS-managed key for encryption. If you previously specified a customer-managed KMS key and want CodeGuru Security to use an AWS-managed key for encryption instead, pass nothing.