CodeGuruSecurity module#
Index > CodeGuruSecurity
Auto-generated documentation for CodeGuruSecurity type annotations stubs module mypy-boto3-codeguru-security.
How to install#
VSCode extension#
Add AWS Boto3
extension to your VSCode and run AWS boto3: Quick Start
command.
Click Modify
and select boto3 common
and CodeGuruSecurity
.
From PyPI with pip#
Install boto3-stubs
for CodeGuruSecurity
service.
# install with boto3 type annotations
python -m pip install 'boto3-stubs[codeguru-security]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[codeguru-security]'
# standalone installation
python -m pip install mypy-boto3-codeguru-security
How to uninstall#
python -m pip uninstall -y mypy-boto3-codeguru-security
Usage#
Code samples can be found in Examples.
CodeGuruSecurityClient#
Type annotations and code completion for boto3.client("codeguru-security")
as CodeGuruSecurityClient
boto3 documentation
# CodeGuruSecurityClient usage example
from boto3.session import Session
from mypy_boto3_codeguru_security.client import CodeGuruSecurityClient
def get_client() -> CodeGuruSecurityClient:
return Session().client("codeguru-security")
Paginators#
Type annotations and code completion for paginators
from boto3.client("codeguru-security").get_paginator("...")
.
# GetFindingsPaginator usage example
from boto3.session import Session
from mypy_boto3_codeguru_security.paginator import GetFindingsPaginator
def get_get_findings_paginator() -> GetFindingsPaginator:
return Session().client("codeguru-security").get_paginator("get_findings"))
Literals#
Type annotations for literals used in methods and schema.
# AnalysisTypeType usage example
from mypy_boto3_codeguru_security.literals import AnalysisTypeType
def get_value() -> AnalysisTypeType:
return "All"
- AnalysisTypeType
- ErrorCodeType
- GetFindingsPaginatorName
- ListFindingsMetricsPaginatorName
- ListScansPaginatorName
- ScanStateType
- ScanTypeType
- SeverityType
- StatusType
- CodeGuruSecurityServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
Type definitions#
Type annotations for type definitions used in methods and schema.
- FindingMetricsValuePerSeverityTypeDef
- BatchGetFindingsErrorTypeDef
- FindingIdentifierTypeDef
- ResponseMetadataTypeDef
- CategoryWithFindingNumTypeDef
- CodeLineTypeDef
- ResourceIdTypeDef
- CreateUploadUrlRequestRequestTypeDef
- EncryptionConfigTypeDef
- ResourceTypeDef
- PaginatorConfigTypeDef
- GetFindingsRequestRequestTypeDef
- TimestampTypeDef
- GetScanRequestRequestTypeDef
- ListScansRequestRequestTypeDef
- ScanSummaryTypeDef
- ListTagsForResourceRequestRequestTypeDef
- ScanNameWithFindingNumTypeDef
- RecommendationTypeDef
- SuggestedFixTypeDef
- TagResourceRequestRequestTypeDef
- UntagResourceRequestRequestTypeDef
- AccountFindingsMetricTypeDef
- BatchGetFindingsRequestRequestTypeDef
- CreateUploadUrlResponseTypeDef
- GetScanResponseTypeDef
- ListTagsForResourceResponseTypeDef
- FilePathTypeDef
- CreateScanRequestRequestTypeDef
- CreateScanResponseTypeDef
- GetAccountConfigurationResponseTypeDef
- UpdateAccountConfigurationRequestRequestTypeDef
- UpdateAccountConfigurationResponseTypeDef
- GetFindingsRequestGetFindingsPaginateTypeDef
- ListScansRequestListScansPaginateTypeDef
- GetMetricsSummaryRequestRequestTypeDef
- ListFindingsMetricsRequestListFindingsMetricsPaginateTypeDef
- ListFindingsMetricsRequestRequestTypeDef
- ListScansResponseTypeDef
- MetricsSummaryTypeDef
- RemediationTypeDef
- ListFindingsMetricsResponseTypeDef
- VulnerabilityTypeDef
- GetMetricsSummaryResponseTypeDef
- FindingTypeDef
- BatchGetFindingsResponseTypeDef
- GetFindingsResponseTypeDef