Inspector2Client#
Index > Inspector2 > Inspector2Client
Auto-generated documentation for Inspector2 type annotations stubs module mypy-boto3-inspector2.
Inspector2Client#
Type annotations and code completion for boto3.client("inspector2")
.
boto3 documentation
# Inspector2Client usage example
from boto3.session import Session
from mypy_boto3_inspector2.client import Inspector2Client
def get_inspector2_client() -> Inspector2Client:
return Session().client("inspector2")
Exceptions#
boto3
client exceptions are generated in runtime.
This class provides code completion for boto3.client("inspector2").exceptions
structure.
# Exceptions.exceptions usage example
client = boto3.client("inspector2")
try:
do_something(client)
except (
client.exceptions.AccessDeniedException,
client.exceptions.BadRequestException,
client.exceptions.ClientError,
client.exceptions.ConflictException,
client.exceptions.InternalServerException,
client.exceptions.ResourceNotFoundException,
client.exceptions.ServiceQuotaExceededException,
client.exceptions.ThrottlingException,
client.exceptions.ValidationException,
) as e:
print(e)
# Exceptions.exceptions type checking example
from mypy_boto3_inspector2.client import Exceptions
def handle_error(exc: Exceptions.AccessDeniedException) -> None:
...
Methods#
associate_member#
Associates an Amazon Web Services account with an Amazon Inspector delegated administrator.
Type annotations and code completion for boto3.client("inspector2").associate_member
method.
boto3 documentation
# associate_member method definition
def associate_member(
self,
*,
accountId: str,
) -> AssociateMemberResponseTypeDef: # (1)
...
# associate_member method usage example with argument unpacking
kwargs: AssociateMemberRequestRequestTypeDef = { # (1)
"accountId": ...,
}
parent.associate_member(**kwargs)
batch_get_account_status#
Retrieves the Amazon Inspector status of multiple Amazon Web Services accounts within your environment.
Type annotations and code completion for boto3.client("inspector2").batch_get_account_status
method.
boto3 documentation
# batch_get_account_status method definition
def batch_get_account_status(
self,
*,
accountIds: Sequence[str] = ...,
) -> BatchGetAccountStatusResponseTypeDef: # (1)
...
# batch_get_account_status method usage example with argument unpacking
kwargs: BatchGetAccountStatusRequestRequestTypeDef = { # (1)
"accountIds": ...,
}
parent.batch_get_account_status(**kwargs)
batch_get_code_snippet#
Retrieves code snippets from findings that Amazon Inspector detected code vulnerabilities in.
Type annotations and code completion for boto3.client("inspector2").batch_get_code_snippet
method.
boto3 documentation
# batch_get_code_snippet method definition
def batch_get_code_snippet(
self,
*,
findingArns: Sequence[str],
) -> BatchGetCodeSnippetResponseTypeDef: # (1)
...
# batch_get_code_snippet method usage example with argument unpacking
kwargs: BatchGetCodeSnippetRequestRequestTypeDef = { # (1)
"findingArns": ...,
}
parent.batch_get_code_snippet(**kwargs)
batch_get_finding_details#
Gets vulnerability details for findings.
Type annotations and code completion for boto3.client("inspector2").batch_get_finding_details
method.
boto3 documentation
# batch_get_finding_details method definition
def batch_get_finding_details(
self,
*,
findingArns: Sequence[str],
) -> BatchGetFindingDetailsResponseTypeDef: # (1)
...
# batch_get_finding_details method usage example with argument unpacking
kwargs: BatchGetFindingDetailsRequestRequestTypeDef = { # (1)
"findingArns": ...,
}
parent.batch_get_finding_details(**kwargs)
batch_get_free_trial_info#
Gets free trial status for multiple Amazon Web Services accounts.
Type annotations and code completion for boto3.client("inspector2").batch_get_free_trial_info
method.
boto3 documentation
# batch_get_free_trial_info method definition
def batch_get_free_trial_info(
self,
*,
accountIds: Sequence[str],
) -> BatchGetFreeTrialInfoResponseTypeDef: # (1)
...
# batch_get_free_trial_info method usage example with argument unpacking
kwargs: BatchGetFreeTrialInfoRequestRequestTypeDef = { # (1)
"accountIds": ...,
}
parent.batch_get_free_trial_info(**kwargs)
batch_get_member_ec2_deep_inspection_status#
Retrieves Amazon Inspector deep inspection activation status of multiple member accounts within your organization.
Type annotations and code completion for boto3.client("inspector2").batch_get_member_ec2_deep_inspection_status
method.
boto3 documentation
# batch_get_member_ec2_deep_inspection_status method definition
def batch_get_member_ec2_deep_inspection_status(
self,
*,
accountIds: Sequence[str] = ...,
) -> BatchGetMemberEc2DeepInspectionStatusResponseTypeDef: # (1)
...
# batch_get_member_ec2_deep_inspection_status method usage example with argument unpacking
kwargs: BatchGetMemberEc2DeepInspectionStatusRequestRequestTypeDef = { # (1)
"accountIds": ...,
}
parent.batch_get_member_ec2_deep_inspection_status(**kwargs)
batch_update_member_ec2_deep_inspection_status#
Activates or deactivates Amazon Inspector deep inspection for the provided member accounts in your organization.
Type annotations and code completion for boto3.client("inspector2").batch_update_member_ec2_deep_inspection_status
method.
boto3 documentation
# batch_update_member_ec2_deep_inspection_status method definition
def batch_update_member_ec2_deep_inspection_status(
self,
*,
accountIds: Sequence[MemberAccountEc2DeepInspectionStatusTypeDef], # (1)
) -> BatchUpdateMemberEc2DeepInspectionStatusResponseTypeDef: # (2)
...
- See MemberAccountEc2DeepInspectionStatusTypeDef
- See BatchUpdateMemberEc2DeepInspectionStatusResponseTypeDef
# batch_update_member_ec2_deep_inspection_status method usage example with argument unpacking
kwargs: BatchUpdateMemberEc2DeepInspectionStatusRequestRequestTypeDef = { # (1)
"accountIds": ...,
}
parent.batch_update_member_ec2_deep_inspection_status(**kwargs)
can_paginate#
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("inspector2").can_paginate
method.
boto3 documentation
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...
cancel_findings_report#
Cancels the given findings report.
Type annotations and code completion for boto3.client("inspector2").cancel_findings_report
method.
boto3 documentation
# cancel_findings_report method definition
def cancel_findings_report(
self,
*,
reportId: str,
) -> CancelFindingsReportResponseTypeDef: # (1)
...
# cancel_findings_report method usage example with argument unpacking
kwargs: CancelFindingsReportRequestRequestTypeDef = { # (1)
"reportId": ...,
}
parent.cancel_findings_report(**kwargs)
cancel_sbom_export#
Cancels a software bill of materials (SBOM) report.
Type annotations and code completion for boto3.client("inspector2").cancel_sbom_export
method.
boto3 documentation
# cancel_sbom_export method definition
def cancel_sbom_export(
self,
*,
reportId: str,
) -> CancelSbomExportResponseTypeDef: # (1)
...
# cancel_sbom_export method usage example with argument unpacking
kwargs: CancelSbomExportRequestRequestTypeDef = { # (1)
"reportId": ...,
}
parent.cancel_sbom_export(**kwargs)
close#
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("inspector2").close
method.
boto3 documentation
# close method definition
def close(
self,
) -> None:
...
create_cis_scan_configuration#
Creates a CIS scan configuration.
Type annotations and code completion for boto3.client("inspector2").create_cis_scan_configuration
method.
boto3 documentation
# create_cis_scan_configuration method definition
def create_cis_scan_configuration(
self,
*,
scanName: str,
schedule: ScheduleTypeDef, # (1)
securityLevel: CisSecurityLevelType, # (2)
targets: CreateCisTargetsTypeDef, # (3)
tags: Mapping[str, str] = ...,
) -> CreateCisScanConfigurationResponseTypeDef: # (4)
...
- See ScheduleTypeDef
- See CisSecurityLevelType
- See CreateCisTargetsTypeDef
- See CreateCisScanConfigurationResponseTypeDef
# create_cis_scan_configuration method usage example with argument unpacking
kwargs: CreateCisScanConfigurationRequestRequestTypeDef = { # (1)
"scanName": ...,
"schedule": ...,
"securityLevel": ...,
"targets": ...,
}
parent.create_cis_scan_configuration(**kwargs)
create_filter#
Creates a filter resource using specified filter criteria.
Type annotations and code completion for boto3.client("inspector2").create_filter
method.
boto3 documentation
# create_filter method definition
def create_filter(
self,
*,
action: FilterActionType, # (1)
filterCriteria: FilterCriteriaTypeDef, # (2)
name: str,
description: str = ...,
reason: str = ...,
tags: Mapping[str, str] = ...,
) -> CreateFilterResponseTypeDef: # (3)
...
# create_filter method usage example with argument unpacking
kwargs: CreateFilterRequestRequestTypeDef = { # (1)
"action": ...,
"filterCriteria": ...,
"name": ...,
}
parent.create_filter(**kwargs)
create_findings_report#
Creates a finding report.
Type annotations and code completion for boto3.client("inspector2").create_findings_report
method.
boto3 documentation
# create_findings_report method definition
def create_findings_report(
self,
*,
reportFormat: ReportFormatType, # (1)
s3Destination: DestinationTypeDef, # (2)
filterCriteria: FilterCriteriaTypeDef = ..., # (3)
) -> CreateFindingsReportResponseTypeDef: # (4)
...
- See ReportFormatType
- See DestinationTypeDef
- See FilterCriteriaTypeDef
- See CreateFindingsReportResponseTypeDef
# create_findings_report method usage example with argument unpacking
kwargs: CreateFindingsReportRequestRequestTypeDef = { # (1)
"reportFormat": ...,
"s3Destination": ...,
}
parent.create_findings_report(**kwargs)
create_sbom_export#
Creates a software bill of materials (SBOM) report.
Type annotations and code completion for boto3.client("inspector2").create_sbom_export
method.
boto3 documentation
# create_sbom_export method definition
def create_sbom_export(
self,
*,
reportFormat: SbomReportFormatType, # (1)
s3Destination: DestinationTypeDef, # (2)
resourceFilterCriteria: ResourceFilterCriteriaTypeDef = ..., # (3)
) -> CreateSbomExportResponseTypeDef: # (4)
...
- See SbomReportFormatType
- See DestinationTypeDef
- See ResourceFilterCriteriaTypeDef
- See CreateSbomExportResponseTypeDef
# create_sbom_export method usage example with argument unpacking
kwargs: CreateSbomExportRequestRequestTypeDef = { # (1)
"reportFormat": ...,
"s3Destination": ...,
}
parent.create_sbom_export(**kwargs)
delete_cis_scan_configuration#
Deletes a CIS scan configuration.
Type annotations and code completion for boto3.client("inspector2").delete_cis_scan_configuration
method.
boto3 documentation
# delete_cis_scan_configuration method definition
def delete_cis_scan_configuration(
self,
*,
scanConfigurationArn: str,
) -> DeleteCisScanConfigurationResponseTypeDef: # (1)
...
# delete_cis_scan_configuration method usage example with argument unpacking
kwargs: DeleteCisScanConfigurationRequestRequestTypeDef = { # (1)
"scanConfigurationArn": ...,
}
parent.delete_cis_scan_configuration(**kwargs)
delete_filter#
Deletes a filter resource.
Type annotations and code completion for boto3.client("inspector2").delete_filter
method.
boto3 documentation
# delete_filter method definition
def delete_filter(
self,
*,
arn: str,
) -> DeleteFilterResponseTypeDef: # (1)
...
# delete_filter method usage example with argument unpacking
kwargs: DeleteFilterRequestRequestTypeDef = { # (1)
"arn": ...,
}
parent.delete_filter(**kwargs)
describe_organization_configuration#
Describe Amazon Inspector configuration settings for an Amazon Web Services organization.
Type annotations and code completion for boto3.client("inspector2").describe_organization_configuration
method.
boto3 documentation
# describe_organization_configuration method definition
def describe_organization_configuration(
self,
) -> DescribeOrganizationConfigurationResponseTypeDef: # (1)
...
disable#
Disables Amazon Inspector scans for one or more Amazon Web Services accounts.
Type annotations and code completion for boto3.client("inspector2").disable
method.
boto3 documentation
# disable method definition
def disable(
self,
*,
accountIds: Sequence[str] = ...,
resourceTypes: Sequence[ResourceScanTypeType] = ..., # (1)
) -> DisableResponseTypeDef: # (2)
...
# disable method usage example with argument unpacking
kwargs: DisableRequestRequestTypeDef = { # (1)
"accountIds": ...,
}
parent.disable(**kwargs)
disable_delegated_admin_account#
Disables the Amazon Inspector delegated administrator for your organization.
Type annotations and code completion for boto3.client("inspector2").disable_delegated_admin_account
method.
boto3 documentation
# disable_delegated_admin_account method definition
def disable_delegated_admin_account(
self,
*,
delegatedAdminAccountId: str,
) -> DisableDelegatedAdminAccountResponseTypeDef: # (1)
...
# disable_delegated_admin_account method usage example with argument unpacking
kwargs: DisableDelegatedAdminAccountRequestRequestTypeDef = { # (1)
"delegatedAdminAccountId": ...,
}
parent.disable_delegated_admin_account(**kwargs)
disassociate_member#
Disassociates a member account from an Amazon Inspector delegated administrator.
Type annotations and code completion for boto3.client("inspector2").disassociate_member
method.
boto3 documentation
# disassociate_member method definition
def disassociate_member(
self,
*,
accountId: str,
) -> DisassociateMemberResponseTypeDef: # (1)
...
# disassociate_member method usage example with argument unpacking
kwargs: DisassociateMemberRequestRequestTypeDef = { # (1)
"accountId": ...,
}
parent.disassociate_member(**kwargs)
enable#
Enables Amazon Inspector scans for one or more Amazon Web Services accounts.
Type annotations and code completion for boto3.client("inspector2").enable
method.
boto3 documentation
# enable method definition
def enable(
self,
*,
resourceTypes: Sequence[ResourceScanTypeType], # (1)
accountIds: Sequence[str] = ...,
clientToken: str = ...,
) -> EnableResponseTypeDef: # (2)
...
# enable method usage example with argument unpacking
kwargs: EnableRequestRequestTypeDef = { # (1)
"resourceTypes": ...,
}
parent.enable(**kwargs)
enable_delegated_admin_account#
Enables the Amazon Inspector delegated administrator for your Organizations organization.
Type annotations and code completion for boto3.client("inspector2").enable_delegated_admin_account
method.
boto3 documentation
# enable_delegated_admin_account method definition
def enable_delegated_admin_account(
self,
*,
delegatedAdminAccountId: str,
clientToken: str = ...,
) -> EnableDelegatedAdminAccountResponseTypeDef: # (1)
...
# enable_delegated_admin_account method usage example with argument unpacking
kwargs: EnableDelegatedAdminAccountRequestRequestTypeDef = { # (1)
"delegatedAdminAccountId": ...,
}
parent.enable_delegated_admin_account(**kwargs)
generate_presigned_url#
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for boto3.client("inspector2").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_cis_scan_report#
Retrieves a CIS scan report.
Type annotations and code completion for boto3.client("inspector2").get_cis_scan_report
method.
boto3 documentation
# get_cis_scan_report method definition
def get_cis_scan_report(
self,
*,
scanArn: str,
reportFormat: CisReportFormatType = ..., # (1)
targetAccounts: Sequence[str] = ...,
) -> GetCisScanReportResponseTypeDef: # (2)
...
# get_cis_scan_report method usage example with argument unpacking
kwargs: GetCisScanReportRequestRequestTypeDef = { # (1)
"scanArn": ...,
}
parent.get_cis_scan_report(**kwargs)
get_cis_scan_result_details#
Retrieves CIS scan result details.
Type annotations and code completion for boto3.client("inspector2").get_cis_scan_result_details
method.
boto3 documentation
# get_cis_scan_result_details method definition
def get_cis_scan_result_details(
self,
*,
accountId: str,
scanArn: str,
targetResourceId: str,
filterCriteria: CisScanResultDetailsFilterCriteriaTypeDef = ..., # (1)
maxResults: int = ...,
nextToken: str = ...,
sortBy: CisScanResultDetailsSortByType = ..., # (2)
sortOrder: CisSortOrderType = ..., # (3)
) -> GetCisScanResultDetailsResponseTypeDef: # (4)
...
- See CisScanResultDetailsFilterCriteriaTypeDef
- See CisScanResultDetailsSortByType
- See CisSortOrderType
- See GetCisScanResultDetailsResponseTypeDef
# get_cis_scan_result_details method usage example with argument unpacking
kwargs: GetCisScanResultDetailsRequestRequestTypeDef = { # (1)
"accountId": ...,
"scanArn": ...,
"targetResourceId": ...,
}
parent.get_cis_scan_result_details(**kwargs)
get_configuration#
Retrieves setting configurations for Inspector scans.
Type annotations and code completion for boto3.client("inspector2").get_configuration
method.
boto3 documentation
# get_configuration method definition
def get_configuration(
self,
) -> GetConfigurationResponseTypeDef: # (1)
...
get_delegated_admin_account#
Retrieves information about the Amazon Inspector delegated administrator for your organization.
Type annotations and code completion for boto3.client("inspector2").get_delegated_admin_account
method.
boto3 documentation
# get_delegated_admin_account method definition
def get_delegated_admin_account(
self,
) -> GetDelegatedAdminAccountResponseTypeDef: # (1)
...
get_ec2_deep_inspection_configuration#
Retrieves the activation status of Amazon Inspector deep inspection and custom paths associated with your account.
Type annotations and code completion for boto3.client("inspector2").get_ec2_deep_inspection_configuration
method.
boto3 documentation
# get_ec2_deep_inspection_configuration method definition
def get_ec2_deep_inspection_configuration(
self,
) -> GetEc2DeepInspectionConfigurationResponseTypeDef: # (1)
...
get_encryption_key#
Gets an encryption key.
Type annotations and code completion for boto3.client("inspector2").get_encryption_key
method.
boto3 documentation
# get_encryption_key method definition
def get_encryption_key(
self,
*,
resourceType: ResourceTypeType, # (1)
scanType: ScanTypeType, # (2)
) -> GetEncryptionKeyResponseTypeDef: # (3)
...
# get_encryption_key method usage example with argument unpacking
kwargs: GetEncryptionKeyRequestRequestTypeDef = { # (1)
"resourceType": ...,
"scanType": ...,
}
parent.get_encryption_key(**kwargs)
get_findings_report_status#
Gets the status of a findings report.
Type annotations and code completion for boto3.client("inspector2").get_findings_report_status
method.
boto3 documentation
# get_findings_report_status method definition
def get_findings_report_status(
self,
*,
reportId: str = ...,
) -> GetFindingsReportStatusResponseTypeDef: # (1)
...
# get_findings_report_status method usage example with argument unpacking
kwargs: GetFindingsReportStatusRequestRequestTypeDef = { # (1)
"reportId": ...,
}
parent.get_findings_report_status(**kwargs)
get_member#
Gets member information for your organization.
Type annotations and code completion for boto3.client("inspector2").get_member
method.
boto3 documentation
# get_member method definition
def get_member(
self,
*,
accountId: str,
) -> GetMemberResponseTypeDef: # (1)
...
# get_member method usage example with argument unpacking
kwargs: GetMemberRequestRequestTypeDef = { # (1)
"accountId": ...,
}
parent.get_member(**kwargs)
get_sbom_export#
Gets details of a software bill of materials (SBOM) report.
Type annotations and code completion for boto3.client("inspector2").get_sbom_export
method.
boto3 documentation
# get_sbom_export method definition
def get_sbom_export(
self,
*,
reportId: str,
) -> GetSbomExportResponseTypeDef: # (1)
...
# get_sbom_export method usage example with argument unpacking
kwargs: GetSbomExportRequestRequestTypeDef = { # (1)
"reportId": ...,
}
parent.get_sbom_export(**kwargs)
list_account_permissions#
Lists the permissions an account has to configure Amazon Inspector.
Type annotations and code completion for boto3.client("inspector2").list_account_permissions
method.
boto3 documentation
# list_account_permissions method definition
def list_account_permissions(
self,
*,
maxResults: int = ...,
nextToken: str = ...,
service: ServiceType = ..., # (1)
) -> ListAccountPermissionsResponseTypeDef: # (2)
...
# list_account_permissions method usage example with argument unpacking
kwargs: ListAccountPermissionsRequestRequestTypeDef = { # (1)
"maxResults": ...,
}
parent.list_account_permissions(**kwargs)
list_cis_scan_configurations#
Lists CIS scan configurations.
Type annotations and code completion for boto3.client("inspector2").list_cis_scan_configurations
method.
boto3 documentation
# list_cis_scan_configurations method definition
def list_cis_scan_configurations(
self,
*,
filterCriteria: ListCisScanConfigurationsFilterCriteriaTypeDef = ..., # (1)
maxResults: int = ...,
nextToken: str = ...,
sortBy: CisScanConfigurationsSortByType = ..., # (2)
sortOrder: CisSortOrderType = ..., # (3)
) -> ListCisScanConfigurationsResponseTypeDef: # (4)
...
- See ListCisScanConfigurationsFilterCriteriaTypeDef
- See CisScanConfigurationsSortByType
- See CisSortOrderType
- See ListCisScanConfigurationsResponseTypeDef
# list_cis_scan_configurations method usage example with argument unpacking
kwargs: ListCisScanConfigurationsRequestRequestTypeDef = { # (1)
"filterCriteria": ...,
}
parent.list_cis_scan_configurations(**kwargs)
list_cis_scan_results_aggregated_by_checks#
Lists scan results aggregated by checks.
Type annotations and code completion for boto3.client("inspector2").list_cis_scan_results_aggregated_by_checks
method.
boto3 documentation
# list_cis_scan_results_aggregated_by_checks method definition
def list_cis_scan_results_aggregated_by_checks(
self,
*,
scanArn: str,
filterCriteria: CisScanResultsAggregatedByChecksFilterCriteriaTypeDef = ..., # (1)
maxResults: int = ...,
nextToken: str = ...,
sortBy: CisScanResultsAggregatedByChecksSortByType = ..., # (2)
sortOrder: CisSortOrderType = ..., # (3)
) -> ListCisScanResultsAggregatedByChecksResponseTypeDef: # (4)
...
- See CisScanResultsAggregatedByChecksFilterCriteriaTypeDef
- See CisScanResultsAggregatedByChecksSortByType
- See CisSortOrderType
- See ListCisScanResultsAggregatedByChecksResponseTypeDef
# list_cis_scan_results_aggregated_by_checks method usage example with argument unpacking
kwargs: ListCisScanResultsAggregatedByChecksRequestRequestTypeDef = { # (1)
"scanArn": ...,
}
parent.list_cis_scan_results_aggregated_by_checks(**kwargs)
list_cis_scan_results_aggregated_by_target_resource#
Lists scan results aggregated by a target resource.
Type annotations and code completion for boto3.client("inspector2").list_cis_scan_results_aggregated_by_target_resource
method.
boto3 documentation
# list_cis_scan_results_aggregated_by_target_resource method definition
def list_cis_scan_results_aggregated_by_target_resource(
self,
*,
scanArn: str,
filterCriteria: CisScanResultsAggregatedByTargetResourceFilterCriteriaTypeDef = ..., # (1)
maxResults: int = ...,
nextToken: str = ...,
sortBy: CisScanResultsAggregatedByTargetResourceSortByType = ..., # (2)
sortOrder: CisSortOrderType = ..., # (3)
) -> ListCisScanResultsAggregatedByTargetResourceResponseTypeDef: # (4)
...
- See CisScanResultsAggregatedByTargetResourceFilterCriteriaTypeDef
- See CisScanResultsAggregatedByTargetResourceSortByType
- See CisSortOrderType
- See ListCisScanResultsAggregatedByTargetResourceResponseTypeDef
# list_cis_scan_results_aggregated_by_target_resource method usage example with argument unpacking
kwargs: ListCisScanResultsAggregatedByTargetResourceRequestRequestTypeDef = { # (1)
"scanArn": ...,
}
parent.list_cis_scan_results_aggregated_by_target_resource(**kwargs)
list_cis_scans#
Returns a CIS scan list.
Type annotations and code completion for boto3.client("inspector2").list_cis_scans
method.
boto3 documentation
# list_cis_scans method definition
def list_cis_scans(
self,
*,
detailLevel: ListCisScansDetailLevelType = ..., # (1)
filterCriteria: ListCisScansFilterCriteriaTypeDef = ..., # (2)
maxResults: int = ...,
nextToken: str = ...,
sortBy: ListCisScansSortByType = ..., # (3)
sortOrder: CisSortOrderType = ..., # (4)
) -> ListCisScansResponseTypeDef: # (5)
...
- See ListCisScansDetailLevelType
- See ListCisScansFilterCriteriaTypeDef
- See ListCisScansSortByType
- See CisSortOrderType
- See ListCisScansResponseTypeDef
# list_cis_scans method usage example with argument unpacking
kwargs: ListCisScansRequestRequestTypeDef = { # (1)
"detailLevel": ...,
}
parent.list_cis_scans(**kwargs)
list_coverage#
Lists coverage details for your environment.
Type annotations and code completion for boto3.client("inspector2").list_coverage
method.
boto3 documentation
# list_coverage method definition
def list_coverage(
self,
*,
filterCriteria: CoverageFilterCriteriaTypeDef = ..., # (1)
maxResults: int = ...,
nextToken: str = ...,
) -> ListCoverageResponseTypeDef: # (2)
...
# list_coverage method usage example with argument unpacking
kwargs: ListCoverageRequestRequestTypeDef = { # (1)
"filterCriteria": ...,
}
parent.list_coverage(**kwargs)
list_coverage_statistics#
Lists Amazon Inspector coverage statistics for your environment.
Type annotations and code completion for boto3.client("inspector2").list_coverage_statistics
method.
boto3 documentation
# list_coverage_statistics method definition
def list_coverage_statistics(
self,
*,
filterCriteria: CoverageFilterCriteriaTypeDef = ..., # (1)
groupBy: GroupKeyType = ..., # (2)
nextToken: str = ...,
) -> ListCoverageStatisticsResponseTypeDef: # (3)
...
# list_coverage_statistics method usage example with argument unpacking
kwargs: ListCoverageStatisticsRequestRequestTypeDef = { # (1)
"filterCriteria": ...,
}
parent.list_coverage_statistics(**kwargs)
list_delegated_admin_accounts#
Lists information about the Amazon Inspector delegated administrator of your organization.
Type annotations and code completion for boto3.client("inspector2").list_delegated_admin_accounts
method.
boto3 documentation
# list_delegated_admin_accounts method definition
def list_delegated_admin_accounts(
self,
*,
maxResults: int = ...,
nextToken: str = ...,
) -> ListDelegatedAdminAccountsResponseTypeDef: # (1)
...
# list_delegated_admin_accounts method usage example with argument unpacking
kwargs: ListDelegatedAdminAccountsRequestRequestTypeDef = { # (1)
"maxResults": ...,
}
parent.list_delegated_admin_accounts(**kwargs)
list_filters#
Lists the filters associated with your account.
Type annotations and code completion for boto3.client("inspector2").list_filters
method.
boto3 documentation
# list_filters method definition
def list_filters(
self,
*,
action: FilterActionType = ..., # (1)
arns: Sequence[str] = ...,
maxResults: int = ...,
nextToken: str = ...,
) -> ListFiltersResponseTypeDef: # (2)
...
# list_filters method usage example with argument unpacking
kwargs: ListFiltersRequestRequestTypeDef = { # (1)
"action": ...,
}
parent.list_filters(**kwargs)
list_finding_aggregations#
Lists aggregated finding data for your environment based on specific criteria.
Type annotations and code completion for boto3.client("inspector2").list_finding_aggregations
method.
boto3 documentation
# list_finding_aggregations method definition
def list_finding_aggregations(
self,
*,
aggregationType: AggregationTypeType, # (1)
accountIds: Sequence[StringFilterTypeDef] = ..., # (2)
aggregationRequest: AggregationRequestTypeDef = ..., # (3)
maxResults: int = ...,
nextToken: str = ...,
) -> ListFindingAggregationsResponseTypeDef: # (4)
...
- See AggregationTypeType
- See StringFilterTypeDef
- See AggregationRequestTypeDef
- See ListFindingAggregationsResponseTypeDef
# list_finding_aggregations method usage example with argument unpacking
kwargs: ListFindingAggregationsRequestRequestTypeDef = { # (1)
"aggregationType": ...,
}
parent.list_finding_aggregations(**kwargs)
list_findings#
Lists findings for your environment.
Type annotations and code completion for boto3.client("inspector2").list_findings
method.
boto3 documentation
# list_findings method definition
def list_findings(
self,
*,
filterCriteria: FilterCriteriaTypeDef = ..., # (1)
maxResults: int = ...,
nextToken: str = ...,
sortCriteria: SortCriteriaTypeDef = ..., # (2)
) -> ListFindingsResponseTypeDef: # (3)
...
# list_findings method usage example with argument unpacking
kwargs: ListFindingsRequestRequestTypeDef = { # (1)
"filterCriteria": ...,
}
parent.list_findings(**kwargs)
list_members#
List members associated with the Amazon Inspector delegated administrator for your organization.
Type annotations and code completion for boto3.client("inspector2").list_members
method.
boto3 documentation
# list_members method definition
def list_members(
self,
*,
maxResults: int = ...,
nextToken: str = ...,
onlyAssociated: bool = ...,
) -> ListMembersResponseTypeDef: # (1)
...
# list_members method usage example with argument unpacking
kwargs: ListMembersRequestRequestTypeDef = { # (1)
"maxResults": ...,
}
parent.list_members(**kwargs)
list_tags_for_resource#
Lists all tags attached to a given resource.
Type annotations and code completion for boto3.client("inspector2").list_tags_for_resource
method.
boto3 documentation
# list_tags_for_resource method definition
def list_tags_for_resource(
self,
*,
resourceArn: str,
) -> ListTagsForResourceResponseTypeDef: # (1)
...
# list_tags_for_resource method usage example with argument unpacking
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)
list_usage_totals#
Lists the Amazon Inspector usage totals over the last 30 days.
Type annotations and code completion for boto3.client("inspector2").list_usage_totals
method.
boto3 documentation
# list_usage_totals method definition
def list_usage_totals(
self,
*,
accountIds: Sequence[str] = ...,
maxResults: int = ...,
nextToken: str = ...,
) -> ListUsageTotalsResponseTypeDef: # (1)
...
# list_usage_totals method usage example with argument unpacking
kwargs: ListUsageTotalsRequestRequestTypeDef = { # (1)
"accountIds": ...,
}
parent.list_usage_totals(**kwargs)
reset_encryption_key#
Resets an encryption key.
Type annotations and code completion for boto3.client("inspector2").reset_encryption_key
method.
boto3 documentation
# reset_encryption_key method definition
def reset_encryption_key(
self,
*,
resourceType: ResourceTypeType, # (1)
scanType: ScanTypeType, # (2)
) -> Dict[str, Any]:
...
- See ResourceTypeType
- See ScanTypeType
# reset_encryption_key method usage example with argument unpacking
kwargs: ResetEncryptionKeyRequestRequestTypeDef = { # (1)
"resourceType": ...,
"scanType": ...,
}
parent.reset_encryption_key(**kwargs)
search_vulnerabilities#
Lists Amazon Inspector coverage details for a specific vulnerability.
Type annotations and code completion for boto3.client("inspector2").search_vulnerabilities
method.
boto3 documentation
# search_vulnerabilities method definition
def search_vulnerabilities(
self,
*,
filterCriteria: SearchVulnerabilitiesFilterCriteriaTypeDef, # (1)
nextToken: str = ...,
) -> SearchVulnerabilitiesResponseTypeDef: # (2)
...
# search_vulnerabilities method usage example with argument unpacking
kwargs: SearchVulnerabilitiesRequestRequestTypeDef = { # (1)
"filterCriteria": ...,
}
parent.search_vulnerabilities(**kwargs)
send_cis_session_health#
Sends a CIS session health.
Type annotations and code completion for boto3.client("inspector2").send_cis_session_health
method.
boto3 documentation
# send_cis_session_health method definition
def send_cis_session_health(
self,
*,
scanJobId: str,
sessionToken: str,
) -> Dict[str, Any]:
...
# send_cis_session_health method usage example with argument unpacking
kwargs: SendCisSessionHealthRequestRequestTypeDef = { # (1)
"scanJobId": ...,
"sessionToken": ...,
}
parent.send_cis_session_health(**kwargs)
send_cis_session_telemetry#
Sends a CIS session telemetry.
Type annotations and code completion for boto3.client("inspector2").send_cis_session_telemetry
method.
boto3 documentation
# send_cis_session_telemetry method definition
def send_cis_session_telemetry(
self,
*,
messages: Sequence[CisSessionMessageTypeDef], # (1)
scanJobId: str,
sessionToken: str,
) -> Dict[str, Any]:
...
# send_cis_session_telemetry method usage example with argument unpacking
kwargs: SendCisSessionTelemetryRequestRequestTypeDef = { # (1)
"messages": ...,
"scanJobId": ...,
"sessionToken": ...,
}
parent.send_cis_session_telemetry(**kwargs)
start_cis_session#
Starts a CIS session.
Type annotations and code completion for boto3.client("inspector2").start_cis_session
method.
boto3 documentation
# start_cis_session method definition
def start_cis_session(
self,
*,
message: StartCisSessionMessageTypeDef, # (1)
scanJobId: str,
) -> Dict[str, Any]:
...
# start_cis_session method usage example with argument unpacking
kwargs: StartCisSessionRequestRequestTypeDef = { # (1)
"message": ...,
"scanJobId": ...,
}
parent.start_cis_session(**kwargs)
stop_cis_session#
Stops a CIS session.
Type annotations and code completion for boto3.client("inspector2").stop_cis_session
method.
boto3 documentation
# stop_cis_session method definition
def stop_cis_session(
self,
*,
message: StopCisSessionMessageTypeDef, # (1)
scanJobId: str,
sessionToken: str,
) -> Dict[str, Any]:
...
# stop_cis_session method usage example with argument unpacking
kwargs: StopCisSessionRequestRequestTypeDef = { # (1)
"message": ...,
"scanJobId": ...,
"sessionToken": ...,
}
parent.stop_cis_session(**kwargs)
tag_resource#
Adds tags to a resource.
Type annotations and code completion for boto3.client("inspector2").tag_resource
method.
boto3 documentation
# tag_resource method definition
def tag_resource(
self,
*,
resourceArn: str,
tags: Mapping[str, str],
) -> Dict[str, Any]:
...
# tag_resource method usage example with argument unpacking
kwargs: TagResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
"tags": ...,
}
parent.tag_resource(**kwargs)
untag_resource#
Removes tags from a resource.
Type annotations and code completion for boto3.client("inspector2").untag_resource
method.
boto3 documentation
# untag_resource method definition
def untag_resource(
self,
*,
resourceArn: str,
tagKeys: Sequence[str],
) -> Dict[str, Any]:
...
# untag_resource method usage example with argument unpacking
kwargs: UntagResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
"tagKeys": ...,
}
parent.untag_resource(**kwargs)
update_cis_scan_configuration#
Updates a CIS scan configuration.
Type annotations and code completion for boto3.client("inspector2").update_cis_scan_configuration
method.
boto3 documentation
# update_cis_scan_configuration method definition
def update_cis_scan_configuration(
self,
*,
scanConfigurationArn: str,
scanName: str = ...,
schedule: ScheduleTypeDef = ..., # (1)
securityLevel: CisSecurityLevelType = ..., # (2)
targets: UpdateCisTargetsTypeDef = ..., # (3)
) -> UpdateCisScanConfigurationResponseTypeDef: # (4)
...
- See ScheduleTypeDef
- See CisSecurityLevelType
- See UpdateCisTargetsTypeDef
- See UpdateCisScanConfigurationResponseTypeDef
# update_cis_scan_configuration method usage example with argument unpacking
kwargs: UpdateCisScanConfigurationRequestRequestTypeDef = { # (1)
"scanConfigurationArn": ...,
}
parent.update_cis_scan_configuration(**kwargs)
update_configuration#
Updates setting configurations for your Amazon Inspector account.
Type annotations and code completion for boto3.client("inspector2").update_configuration
method.
boto3 documentation
# update_configuration method definition
def update_configuration(
self,
*,
ec2Configuration: Ec2ConfigurationTypeDef = ..., # (1)
ecrConfiguration: EcrConfigurationTypeDef = ..., # (2)
) -> Dict[str, Any]:
...
# update_configuration method usage example with argument unpacking
kwargs: UpdateConfigurationRequestRequestTypeDef = { # (1)
"ec2Configuration": ...,
}
parent.update_configuration(**kwargs)
update_ec2_deep_inspection_configuration#
Activates, deactivates Amazon Inspector deep inspection, or updates custom paths for your account.
Type annotations and code completion for boto3.client("inspector2").update_ec2_deep_inspection_configuration
method.
boto3 documentation
# update_ec2_deep_inspection_configuration method definition
def update_ec2_deep_inspection_configuration(
self,
*,
activateDeepInspection: bool = ...,
packagePaths: Sequence[str] = ...,
) -> UpdateEc2DeepInspectionConfigurationResponseTypeDef: # (1)
...
# update_ec2_deep_inspection_configuration method usage example with argument unpacking
kwargs: UpdateEc2DeepInspectionConfigurationRequestRequestTypeDef = { # (1)
"activateDeepInspection": ...,
}
parent.update_ec2_deep_inspection_configuration(**kwargs)
update_encryption_key#
Updates an encryption key.
Type annotations and code completion for boto3.client("inspector2").update_encryption_key
method.
boto3 documentation
# update_encryption_key method definition
def update_encryption_key(
self,
*,
kmsKeyId: str,
resourceType: ResourceTypeType, # (1)
scanType: ScanTypeType, # (2)
) -> Dict[str, Any]:
...
- See ResourceTypeType
- See ScanTypeType
# update_encryption_key method usage example with argument unpacking
kwargs: UpdateEncryptionKeyRequestRequestTypeDef = { # (1)
"kmsKeyId": ...,
"resourceType": ...,
"scanType": ...,
}
parent.update_encryption_key(**kwargs)
update_filter#
Specifies the action that is to be applied to the findings that match the filter.
Type annotations and code completion for boto3.client("inspector2").update_filter
method.
boto3 documentation
# update_filter method definition
def update_filter(
self,
*,
filterArn: str,
action: FilterActionType = ..., # (1)
description: str = ...,
filterCriteria: FilterCriteriaTypeDef = ..., # (2)
name: str = ...,
reason: str = ...,
) -> UpdateFilterResponseTypeDef: # (3)
...
# update_filter method usage example with argument unpacking
kwargs: UpdateFilterRequestRequestTypeDef = { # (1)
"filterArn": ...,
}
parent.update_filter(**kwargs)
update_org_ec2_deep_inspection_configuration#
Updates the Amazon Inspector deep inspection custom paths for your organization.
Type annotations and code completion for boto3.client("inspector2").update_org_ec2_deep_inspection_configuration
method.
boto3 documentation
# update_org_ec2_deep_inspection_configuration method definition
def update_org_ec2_deep_inspection_configuration(
self,
*,
orgPackagePaths: Sequence[str],
) -> Dict[str, Any]:
...
# update_org_ec2_deep_inspection_configuration method usage example with argument unpacking
kwargs: UpdateOrgEc2DeepInspectionConfigurationRequestRequestTypeDef = { # (1)
"orgPackagePaths": ...,
}
parent.update_org_ec2_deep_inspection_configuration(**kwargs)
update_organization_configuration#
Updates the configurations for your Amazon Inspector organization.
Type annotations and code completion for boto3.client("inspector2").update_organization_configuration
method.
boto3 documentation
# update_organization_configuration method definition
def update_organization_configuration(
self,
*,
autoEnable: AutoEnableTypeDef, # (1)
) -> UpdateOrganizationConfigurationResponseTypeDef: # (2)
...
# update_organization_configuration method usage example with argument unpacking
kwargs: UpdateOrganizationConfigurationRequestRequestTypeDef = { # (1)
"autoEnable": ...,
}
parent.update_organization_configuration(**kwargs)
get_paginator#
Type annotations and code completion for boto3.client("inspector2").get_paginator
method with overloads.
client.get_paginator("get_cis_scan_result_details")
-> GetCisScanResultDetailsPaginatorclient.get_paginator("list_account_permissions")
-> ListAccountPermissionsPaginatorclient.get_paginator("list_cis_scan_configurations")
-> ListCisScanConfigurationsPaginatorclient.get_paginator("list_cis_scan_results_aggregated_by_checks")
-> ListCisScanResultsAggregatedByChecksPaginatorclient.get_paginator("list_cis_scan_results_aggregated_by_target_resource")
-> ListCisScanResultsAggregatedByTargetResourcePaginatorclient.get_paginator("list_cis_scans")
-> ListCisScansPaginatorclient.get_paginator("list_coverage")
-> ListCoveragePaginatorclient.get_paginator("list_coverage_statistics")
-> ListCoverageStatisticsPaginatorclient.get_paginator("list_delegated_admin_accounts")
-> ListDelegatedAdminAccountsPaginatorclient.get_paginator("list_filters")
-> ListFiltersPaginatorclient.get_paginator("list_finding_aggregations")
-> ListFindingAggregationsPaginatorclient.get_paginator("list_findings")
-> ListFindingsPaginatorclient.get_paginator("list_members")
-> ListMembersPaginatorclient.get_paginator("list_usage_totals")
-> ListUsageTotalsPaginatorclient.get_paginator("search_vulnerabilities")
-> SearchVulnerabilitiesPaginator