Skip to content

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)
    ...
  1. See AssociateMemberResponseTypeDef
# associate_member method usage example with argument unpacking

kwargs: AssociateMemberRequestRequestTypeDef = {  # (1)
    "accountId": ...,
}

parent.associate_member(**kwargs)
  1. See AssociateMemberRequestRequestTypeDef

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)
    ...
  1. See BatchGetAccountStatusResponseTypeDef
# batch_get_account_status method usage example with argument unpacking

kwargs: BatchGetAccountStatusRequestRequestTypeDef = {  # (1)
    "accountIds": ...,
}

parent.batch_get_account_status(**kwargs)
  1. See BatchGetAccountStatusRequestRequestTypeDef

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)
    ...
  1. See BatchGetCodeSnippetResponseTypeDef
# batch_get_code_snippet method usage example with argument unpacking

kwargs: BatchGetCodeSnippetRequestRequestTypeDef = {  # (1)
    "findingArns": ...,
}

parent.batch_get_code_snippet(**kwargs)
  1. See BatchGetCodeSnippetRequestRequestTypeDef

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)
    ...
  1. See BatchGetFindingDetailsResponseTypeDef
# batch_get_finding_details method usage example with argument unpacking

kwargs: BatchGetFindingDetailsRequestRequestTypeDef = {  # (1)
    "findingArns": ...,
}

parent.batch_get_finding_details(**kwargs)
  1. See BatchGetFindingDetailsRequestRequestTypeDef

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)
    ...
  1. See BatchGetFreeTrialInfoResponseTypeDef
# batch_get_free_trial_info method usage example with argument unpacking

kwargs: BatchGetFreeTrialInfoRequestRequestTypeDef = {  # (1)
    "accountIds": ...,
}

parent.batch_get_free_trial_info(**kwargs)
  1. See BatchGetFreeTrialInfoRequestRequestTypeDef

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)
    ...
  1. See BatchGetMemberEc2DeepInspectionStatusResponseTypeDef
# 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)
  1. See BatchGetMemberEc2DeepInspectionStatusRequestRequestTypeDef

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)
    ...
  1. See MemberAccountEc2DeepInspectionStatusTypeDef
  2. 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)
  1. See BatchUpdateMemberEc2DeepInspectionStatusRequestRequestTypeDef

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)
    ...
  1. See CancelFindingsReportResponseTypeDef
# cancel_findings_report method usage example with argument unpacking

kwargs: CancelFindingsReportRequestRequestTypeDef = {  # (1)
    "reportId": ...,
}

parent.cancel_findings_report(**kwargs)
  1. See CancelFindingsReportRequestRequestTypeDef

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)
    ...
  1. See CancelSbomExportResponseTypeDef
# cancel_sbom_export method usage example with argument unpacking

kwargs: CancelSbomExportRequestRequestTypeDef = {  # (1)
    "reportId": ...,
}

parent.cancel_sbom_export(**kwargs)
  1. See CancelSbomExportRequestRequestTypeDef

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)
    ...
  1. See ScheduleTypeDef
  2. See CisSecurityLevelType
  3. See CreateCisTargetsTypeDef
  4. 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)
  1. See CreateCisScanConfigurationRequestRequestTypeDef

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)
    ...
  1. See FilterActionType
  2. See FilterCriteriaTypeDef
  3. See CreateFilterResponseTypeDef
# create_filter method usage example with argument unpacking

kwargs: CreateFilterRequestRequestTypeDef = {  # (1)
    "action": ...,
    "filterCriteria": ...,
    "name": ...,
}

parent.create_filter(**kwargs)
  1. See CreateFilterRequestRequestTypeDef

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)
    ...
  1. See ReportFormatType
  2. See DestinationTypeDef
  3. See FilterCriteriaTypeDef
  4. See CreateFindingsReportResponseTypeDef
# create_findings_report method usage example with argument unpacking

kwargs: CreateFindingsReportRequestRequestTypeDef = {  # (1)
    "reportFormat": ...,
    "s3Destination": ...,
}

parent.create_findings_report(**kwargs)
  1. See CreateFindingsReportRequestRequestTypeDef

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)
    ...
  1. See SbomReportFormatType
  2. See DestinationTypeDef
  3. See ResourceFilterCriteriaTypeDef
  4. See CreateSbomExportResponseTypeDef
# create_sbom_export method usage example with argument unpacking

kwargs: CreateSbomExportRequestRequestTypeDef = {  # (1)
    "reportFormat": ...,
    "s3Destination": ...,
}

parent.create_sbom_export(**kwargs)
  1. See CreateSbomExportRequestRequestTypeDef

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)
    ...
  1. See DeleteCisScanConfigurationResponseTypeDef
# delete_cis_scan_configuration method usage example with argument unpacking

kwargs: DeleteCisScanConfigurationRequestRequestTypeDef = {  # (1)
    "scanConfigurationArn": ...,
}

parent.delete_cis_scan_configuration(**kwargs)
  1. See DeleteCisScanConfigurationRequestRequestTypeDef

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)
    ...
  1. See DeleteFilterResponseTypeDef
# delete_filter method usage example with argument unpacking

kwargs: DeleteFilterRequestRequestTypeDef = {  # (1)
    "arn": ...,
}

parent.delete_filter(**kwargs)
  1. See DeleteFilterRequestRequestTypeDef

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)
    ...
  1. See DescribeOrganizationConfigurationResponseTypeDef

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)
    ...
  1. See ResourceScanTypeType
  2. See DisableResponseTypeDef
# disable method usage example with argument unpacking

kwargs: DisableRequestRequestTypeDef = {  # (1)
    "accountIds": ...,
}

parent.disable(**kwargs)
  1. See DisableRequestRequestTypeDef

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)
    ...
  1. See DisableDelegatedAdminAccountResponseTypeDef
# disable_delegated_admin_account method usage example with argument unpacking

kwargs: DisableDelegatedAdminAccountRequestRequestTypeDef = {  # (1)
    "delegatedAdminAccountId": ...,
}

parent.disable_delegated_admin_account(**kwargs)
  1. See DisableDelegatedAdminAccountRequestRequestTypeDef

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)
    ...
  1. See DisassociateMemberResponseTypeDef
# disassociate_member method usage example with argument unpacking

kwargs: DisassociateMemberRequestRequestTypeDef = {  # (1)
    "accountId": ...,
}

parent.disassociate_member(**kwargs)
  1. See DisassociateMemberRequestRequestTypeDef

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)
    ...
  1. See ResourceScanTypeType
  2. See EnableResponseTypeDef
# enable method usage example with argument unpacking

kwargs: EnableRequestRequestTypeDef = {  # (1)
    "resourceTypes": ...,
}

parent.enable(**kwargs)
  1. See EnableRequestRequestTypeDef

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)
    ...
  1. See EnableDelegatedAdminAccountResponseTypeDef
# enable_delegated_admin_account method usage example with argument unpacking

kwargs: EnableDelegatedAdminAccountRequestRequestTypeDef = {  # (1)
    "delegatedAdminAccountId": ...,
}

parent.enable_delegated_admin_account(**kwargs)
  1. See EnableDelegatedAdminAccountRequestRequestTypeDef

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)
    ...
  1. See CisReportFormatType
  2. See GetCisScanReportResponseTypeDef
# get_cis_scan_report method usage example with argument unpacking

kwargs: GetCisScanReportRequestRequestTypeDef = {  # (1)
    "scanArn": ...,
}

parent.get_cis_scan_report(**kwargs)
  1. See GetCisScanReportRequestRequestTypeDef

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)
    ...
  1. See CisScanResultDetailsFilterCriteriaTypeDef
  2. See CisScanResultDetailsSortByType
  3. See CisSortOrderType
  4. 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)
  1. See GetCisScanResultDetailsRequestRequestTypeDef

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)
    ...
  1. See GetConfigurationResponseTypeDef

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)
    ...
  1. See GetDelegatedAdminAccountResponseTypeDef

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)
    ...
  1. See GetEc2DeepInspectionConfigurationResponseTypeDef

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)
    ...
  1. See ResourceTypeType
  2. See ScanTypeType
  3. See GetEncryptionKeyResponseTypeDef
# get_encryption_key method usage example with argument unpacking

kwargs: GetEncryptionKeyRequestRequestTypeDef = {  # (1)
    "resourceType": ...,
    "scanType": ...,
}

parent.get_encryption_key(**kwargs)
  1. See GetEncryptionKeyRequestRequestTypeDef

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)
    ...
  1. See GetFindingsReportStatusResponseTypeDef
# get_findings_report_status method usage example with argument unpacking

kwargs: GetFindingsReportStatusRequestRequestTypeDef = {  # (1)
    "reportId": ...,
}

parent.get_findings_report_status(**kwargs)
  1. See GetFindingsReportStatusRequestRequestTypeDef

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)
    ...
  1. See GetMemberResponseTypeDef
# get_member method usage example with argument unpacking

kwargs: GetMemberRequestRequestTypeDef = {  # (1)
    "accountId": ...,
}

parent.get_member(**kwargs)
  1. See GetMemberRequestRequestTypeDef

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)
    ...
  1. See GetSbomExportResponseTypeDef
# get_sbom_export method usage example with argument unpacking

kwargs: GetSbomExportRequestRequestTypeDef = {  # (1)
    "reportId": ...,
}

parent.get_sbom_export(**kwargs)
  1. See GetSbomExportRequestRequestTypeDef

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)
    ...
  1. See ServiceType
  2. See ListAccountPermissionsResponseTypeDef
# list_account_permissions method usage example with argument unpacking

kwargs: ListAccountPermissionsRequestRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_account_permissions(**kwargs)
  1. See ListAccountPermissionsRequestRequestTypeDef

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)
    ...
  1. See ListCisScanConfigurationsFilterCriteriaTypeDef
  2. See CisScanConfigurationsSortByType
  3. See CisSortOrderType
  4. See ListCisScanConfigurationsResponseTypeDef
# list_cis_scan_configurations method usage example with argument unpacking

kwargs: ListCisScanConfigurationsRequestRequestTypeDef = {  # (1)
    "filterCriteria": ...,
}

parent.list_cis_scan_configurations(**kwargs)
  1. See ListCisScanConfigurationsRequestRequestTypeDef

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)
    ...
  1. See CisScanResultsAggregatedByChecksFilterCriteriaTypeDef
  2. See CisScanResultsAggregatedByChecksSortByType
  3. See CisSortOrderType
  4. 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)
  1. See ListCisScanResultsAggregatedByChecksRequestRequestTypeDef

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)
    ...
  1. See CisScanResultsAggregatedByTargetResourceFilterCriteriaTypeDef
  2. See CisScanResultsAggregatedByTargetResourceSortByType
  3. See CisSortOrderType
  4. 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)
  1. See ListCisScanResultsAggregatedByTargetResourceRequestRequestTypeDef

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)
    ...
  1. See ListCisScansDetailLevelType
  2. See ListCisScansFilterCriteriaTypeDef
  3. See ListCisScansSortByType
  4. See CisSortOrderType
  5. See ListCisScansResponseTypeDef
# list_cis_scans method usage example with argument unpacking

kwargs: ListCisScansRequestRequestTypeDef = {  # (1)
    "detailLevel": ...,
}

parent.list_cis_scans(**kwargs)
  1. See ListCisScansRequestRequestTypeDef

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)
    ...
  1. See CoverageFilterCriteriaTypeDef
  2. See ListCoverageResponseTypeDef
# list_coverage method usage example with argument unpacking

kwargs: ListCoverageRequestRequestTypeDef = {  # (1)
    "filterCriteria": ...,
}

parent.list_coverage(**kwargs)
  1. See ListCoverageRequestRequestTypeDef

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)
    ...
  1. See CoverageFilterCriteriaTypeDef
  2. See GroupKeyType
  3. See ListCoverageStatisticsResponseTypeDef
# list_coverage_statistics method usage example with argument unpacking

kwargs: ListCoverageStatisticsRequestRequestTypeDef = {  # (1)
    "filterCriteria": ...,
}

parent.list_coverage_statistics(**kwargs)
  1. See ListCoverageStatisticsRequestRequestTypeDef

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)
    ...
  1. See ListDelegatedAdminAccountsResponseTypeDef
# list_delegated_admin_accounts method usage example with argument unpacking

kwargs: ListDelegatedAdminAccountsRequestRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_delegated_admin_accounts(**kwargs)
  1. See ListDelegatedAdminAccountsRequestRequestTypeDef

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)
    ...
  1. See FilterActionType
  2. See ListFiltersResponseTypeDef
# list_filters method usage example with argument unpacking

kwargs: ListFiltersRequestRequestTypeDef = {  # (1)
    "action": ...,
}

parent.list_filters(**kwargs)
  1. See ListFiltersRequestRequestTypeDef

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)
    ...
  1. See AggregationTypeType
  2. See StringFilterTypeDef
  3. See AggregationRequestTypeDef
  4. See ListFindingAggregationsResponseTypeDef
# list_finding_aggregations method usage example with argument unpacking

kwargs: ListFindingAggregationsRequestRequestTypeDef = {  # (1)
    "aggregationType": ...,
}

parent.list_finding_aggregations(**kwargs)
  1. See ListFindingAggregationsRequestRequestTypeDef

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)
    ...
  1. See FilterCriteriaTypeDef
  2. See SortCriteriaTypeDef
  3. See ListFindingsResponseTypeDef
# list_findings method usage example with argument unpacking

kwargs: ListFindingsRequestRequestTypeDef = {  # (1)
    "filterCriteria": ...,
}

parent.list_findings(**kwargs)
  1. See ListFindingsRequestRequestTypeDef

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)
    ...
  1. See ListMembersResponseTypeDef
# list_members method usage example with argument unpacking

kwargs: ListMembersRequestRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_members(**kwargs)
  1. See ListMembersRequestRequestTypeDef

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)
    ...
  1. See ListTagsForResourceResponseTypeDef
# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceRequestRequestTypeDef

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)
    ...
  1. See ListUsageTotalsResponseTypeDef
# list_usage_totals method usage example with argument unpacking

kwargs: ListUsageTotalsRequestRequestTypeDef = {  # (1)
    "accountIds": ...,
}

parent.list_usage_totals(**kwargs)
  1. See ListUsageTotalsRequestRequestTypeDef

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]:
    ...
  1. See ResourceTypeType
  2. See ScanTypeType
# reset_encryption_key method usage example with argument unpacking

kwargs: ResetEncryptionKeyRequestRequestTypeDef = {  # (1)
    "resourceType": ...,
    "scanType": ...,
}

parent.reset_encryption_key(**kwargs)
  1. See ResetEncryptionKeyRequestRequestTypeDef

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)
    ...
  1. See SearchVulnerabilitiesFilterCriteriaTypeDef
  2. See SearchVulnerabilitiesResponseTypeDef
# search_vulnerabilities method usage example with argument unpacking

kwargs: SearchVulnerabilitiesRequestRequestTypeDef = {  # (1)
    "filterCriteria": ...,
}

parent.search_vulnerabilities(**kwargs)
  1. See SearchVulnerabilitiesRequestRequestTypeDef

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)
  1. See SendCisSessionHealthRequestRequestTypeDef

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]:
    ...
  1. See CisSessionMessageTypeDef
# send_cis_session_telemetry method usage example with argument unpacking

kwargs: SendCisSessionTelemetryRequestRequestTypeDef = {  # (1)
    "messages": ...,
    "scanJobId": ...,
    "sessionToken": ...,
}

parent.send_cis_session_telemetry(**kwargs)
  1. See SendCisSessionTelemetryRequestRequestTypeDef

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]:
    ...
  1. See StartCisSessionMessageTypeDef
# start_cis_session method usage example with argument unpacking

kwargs: StartCisSessionRequestRequestTypeDef = {  # (1)
    "message": ...,
    "scanJobId": ...,
}

parent.start_cis_session(**kwargs)
  1. See StartCisSessionRequestRequestTypeDef

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]:
    ...
  1. See StopCisSessionMessageTypeDef
# stop_cis_session method usage example with argument unpacking

kwargs: StopCisSessionRequestRequestTypeDef = {  # (1)
    "message": ...,
    "scanJobId": ...,
    "sessionToken": ...,
}

parent.stop_cis_session(**kwargs)
  1. See StopCisSessionRequestRequestTypeDef

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)
  1. See TagResourceRequestRequestTypeDef

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)
  1. See UntagResourceRequestRequestTypeDef

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)
    ...
  1. See ScheduleTypeDef
  2. See CisSecurityLevelType
  3. See UpdateCisTargetsTypeDef
  4. See UpdateCisScanConfigurationResponseTypeDef
# update_cis_scan_configuration method usage example with argument unpacking

kwargs: UpdateCisScanConfigurationRequestRequestTypeDef = {  # (1)
    "scanConfigurationArn": ...,
}

parent.update_cis_scan_configuration(**kwargs)
  1. See UpdateCisScanConfigurationRequestRequestTypeDef

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]:
    ...
  1. See Ec2ConfigurationTypeDef
  2. See EcrConfigurationTypeDef
# update_configuration method usage example with argument unpacking

kwargs: UpdateConfigurationRequestRequestTypeDef = {  # (1)
    "ec2Configuration": ...,
}

parent.update_configuration(**kwargs)
  1. See UpdateConfigurationRequestRequestTypeDef

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)
    ...
  1. See UpdateEc2DeepInspectionConfigurationResponseTypeDef
# update_ec2_deep_inspection_configuration method usage example with argument unpacking

kwargs: UpdateEc2DeepInspectionConfigurationRequestRequestTypeDef = {  # (1)
    "activateDeepInspection": ...,
}

parent.update_ec2_deep_inspection_configuration(**kwargs)
  1. See UpdateEc2DeepInspectionConfigurationRequestRequestTypeDef

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]:
    ...
  1. See ResourceTypeType
  2. See ScanTypeType
# update_encryption_key method usage example with argument unpacking

kwargs: UpdateEncryptionKeyRequestRequestTypeDef = {  # (1)
    "kmsKeyId": ...,
    "resourceType": ...,
    "scanType": ...,
}

parent.update_encryption_key(**kwargs)
  1. See UpdateEncryptionKeyRequestRequestTypeDef

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)
    ...
  1. See FilterActionType
  2. See FilterCriteriaTypeDef
  3. See UpdateFilterResponseTypeDef
# update_filter method usage example with argument unpacking

kwargs: UpdateFilterRequestRequestTypeDef = {  # (1)
    "filterArn": ...,
}

parent.update_filter(**kwargs)
  1. See UpdateFilterRequestRequestTypeDef

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)
  1. See UpdateOrgEc2DeepInspectionConfigurationRequestRequestTypeDef

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)
    ...
  1. See AutoEnableTypeDef
  2. See UpdateOrganizationConfigurationResponseTypeDef
# update_organization_configuration method usage example with argument unpacking

kwargs: UpdateOrganizationConfigurationRequestRequestTypeDef = {  # (1)
    "autoEnable": ...,
}

parent.update_organization_configuration(**kwargs)
  1. See UpdateOrganizationConfigurationRequestRequestTypeDef

get_paginator#

Type annotations and code completion for boto3.client("inspector2").get_paginator method with overloads.