CodeGuruSecurityClient#
Index > CodeGuruSecurity > CodeGuruSecurityClient
Auto-generated documentation for CodeGuruSecurity type annotations stubs module mypy-boto3-codeguru-security.
CodeGuruSecurityClient#
Type annotations and code completion for boto3.client("codeguru-security").
boto3 documentation
# CodeGuruSecurityClient usage example
from boto3.session import Session
from mypy_boto3_codeguru_security.client import CodeGuruSecurityClient
def get_codeguru-security_client() -> CodeGuruSecurityClient:
return Session().client("codeguru-security")Exceptions#
boto3 client exceptions are generated in runtime.
This class provides code completion for boto3.client("codeguru-security").exceptions structure.
# Exceptions.exceptions usage example
client = boto3.client("codeguru-security")
try:
do_something(client)
except (
client.exceptions.AccessDeniedException,
client.exceptions.ClientError,
client.exceptions.ConflictException,
client.exceptions.InternalServerException,
client.exceptions.ResourceNotFoundException,
client.exceptions.ThrottlingException,
client.exceptions.ValidationException,
) as e:
print(e)# Exceptions.exceptions type checking example
from mypy_boto3_codeguru_security.client import Exceptions
def handle_error(exc: Exceptions.AccessDeniedException) -> None:
...Methods#
batch_get_findings#
Returns a list of requested findings from standard scans.
Type annotations and code completion for boto3.client("codeguru-security").batch_get_findings method.
boto3 documentation
# batch_get_findings method definition
def batch_get_findings(
self,
*,
findingIdentifiers: Sequence[FindingIdentifierTypeDef], # (1)
) -> BatchGetFindingsResponseTypeDef: # (2)
...# batch_get_findings method usage example with argument unpacking
kwargs: BatchGetFindingsRequestRequestTypeDef = { # (1)
"findingIdentifiers": ...,
}
parent.batch_get_findings(**kwargs)can_paginate#
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("codeguru-security").can_paginate method.
boto3 documentation
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...close#
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("codeguru-security").close method.
boto3 documentation
# close method definition
def close(
self,
) -> None:
...create_scan#
Use to create a scan using code uploaded to an Amazon S3 bucket.
Type annotations and code completion for boto3.client("codeguru-security").create_scan method.
boto3 documentation
# create_scan method definition
def create_scan(
self,
*,
resourceId: ResourceIdTypeDef, # (1)
scanName: str,
analysisType: AnalysisTypeType = ..., # (2)
clientToken: str = ...,
scanType: ScanTypeType = ..., # (3)
tags: Mapping[str, str] = ...,
) -> CreateScanResponseTypeDef: # (4)
...- See ResourceIdTypeDef
- See AnalysisTypeType
- See ScanTypeType
- See CreateScanResponseTypeDef
# create_scan method usage example with argument unpacking
kwargs: CreateScanRequestRequestTypeDef = { # (1)
"resourceId": ...,
"scanName": ...,
}
parent.create_scan(**kwargs)create_upload_url#
Generates a pre-signed URL, request headers used to upload a code resource, and code artifact identifier for the uploaded resource.
Type annotations and code completion for boto3.client("codeguru-security").create_upload_url method.
boto3 documentation
# create_upload_url method definition
def create_upload_url(
self,
*,
scanName: str,
) -> CreateUploadUrlResponseTypeDef: # (1)
...# create_upload_url method usage example with argument unpacking
kwargs: CreateUploadUrlRequestRequestTypeDef = { # (1)
"scanName": ...,
}
parent.create_upload_url(**kwargs)generate_presigned_url#
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for boto3.client("codeguru-security").generate_presigned_url method.
boto3 documentation
# generate_presigned_url method definition
def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...get_account_configuration#
Use to get the encryption configuration for an account.
Type annotations and code completion for boto3.client("codeguru-security").get_account_configuration method.
boto3 documentation
# get_account_configuration method definition
def get_account_configuration(
self,
) -> GetAccountConfigurationResponseTypeDef: # (1)
...get_findings#
Returns a list of all findings generated by a particular scan.
Type annotations and code completion for boto3.client("codeguru-security").get_findings method.
boto3 documentation
# get_findings method definition
def get_findings(
self,
*,
scanName: str,
maxResults: int = ...,
nextToken: str = ...,
status: StatusType = ..., # (1)
) -> GetFindingsResponseTypeDef: # (2)
...- See StatusType
- See GetFindingsResponseTypeDef
# get_findings method usage example with argument unpacking
kwargs: GetFindingsRequestRequestTypeDef = { # (1)
"scanName": ...,
}
parent.get_findings(**kwargs)get_metrics_summary#
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.
Type annotations and code completion for boto3.client("codeguru-security").get_metrics_summary method.
boto3 documentation
# get_metrics_summary method definition
def get_metrics_summary(
self,
*,
date: Union[datetime, str],
) -> GetMetricsSummaryResponseTypeDef: # (1)
...# get_metrics_summary method usage example with argument unpacking
kwargs: GetMetricsSummaryRequestRequestTypeDef = { # (1)
"date": ...,
}
parent.get_metrics_summary(**kwargs)get_scan#
Returns details about a scan, including whether or not a scan has completed.
Type annotations and code completion for boto3.client("codeguru-security").get_scan method.