InspectorClient

Index > Inspector > InspectorClient

Auto-generated documentation for Inspector type annotations stubs module mypy-boto3-inspector.

InspectorClient

Type annotations and code completion for boto3.client("inspector"). boto3 documentation

# InspectorClient usage example

from boto3.session import Session
from mypy_boto3_inspector.client import InspectorClient

def get_inspector_client() -> InspectorClient:
    return Session().client("inspector")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("inspector").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("inspector")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.AgentsAlreadyRunningAssessmentException,
    client.exceptions.AssessmentRunInProgressException,
    client.exceptions.ClientError,
    client.exceptions.InternalException,
    client.exceptions.InvalidCrossAccountRoleException,
    client.exceptions.InvalidInputException,
    client.exceptions.LimitExceededException,
    client.exceptions.NoSuchEntityException,
    client.exceptions.PreviewGenerationInProgressException,
    client.exceptions.ServiceTemporarilyUnavailableException,
    client.exceptions.UnsupportedFeatureException,
) as e:
    print(e)

# Exceptions.exceptions type checking example

from mypy_boto3_inspector.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods

add_attributes_to_findings

Assigns attributes (key and value pairs) to the findings that are specified by the ARNs of the findings.

Type annotations and code completion for boto3.client("inspector").add_attributes_to_findings method. boto3 documentation

# add_attributes_to_findings method definition

def add_attributes_to_findings(
    self,
    *,
    findingArns: Sequence[str],
    attributes: Sequence[AttributeTypeDef],  # (1)
) -> AddAttributesToFindingsResponseTypeDef:  # (2)
    ...

1. See AttributeTypeDef
2. See AddAttributesToFindingsResponseTypeDef

# add_attributes_to_findings method usage example with argument unpacking

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

parent.add_attributes_to_findings(**kwargs)

1. See AddAttributesToFindingsRequestRequestTypeDef

can_paginate

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("inspector").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("inspector").close method. boto3 documentation

# close method definition

def close(
    self,
) -> None:
    ...

create_assessment_target

Creates a new assessment target using the ARN of the resource group that is generated by CreateResourceGroup.

Type annotations and code completion for boto3.client("inspector").create_assessment_target method. boto3 documentation

# create_assessment_target method definition

def create_assessment_target(
    self,
    *,
    assessmentTargetName: str,
    resourceGroupArn: str = ...,
) -> CreateAssessmentTargetResponseTypeDef:  # (1)
    ...

1. See CreateAssessmentTargetResponseTypeDef

# create_assessment_target method usage example with argument unpacking

kwargs: CreateAssessmentTargetRequestRequestTypeDef = {  # (1)
    "assessmentTargetName": ...,
}

parent.create_assessment_target(**kwargs)

1. See CreateAssessmentTargetRequestRequestTypeDef

create_assessment_template

Creates an assessment template for the assessment target that is specified by the ARN of the assessment target.

Type annotations and code completion for boto3.client("inspector").create_assessment_template method. boto3 documentation

# create_assessment_template method definition

def create_assessment_template(
    self,
    *,
    assessmentTargetArn: str,
    assessmentTemplateName: str,
    durationInSeconds: int,
    rulesPackageArns: Sequence[str],
    userAttributesForFindings: Sequence[AttributeTypeDef] = ...,  # (1)
) -> CreateAssessmentTemplateResponseTypeDef:  # (2)
    ...

1. See AttributeTypeDef
2. See CreateAssessmentTemplateResponseTypeDef

# create_assessment_template method usage example with argument unpacking

kwargs: CreateAssessmentTemplateRequestRequestTypeDef = {  # (1)
    "assessmentTargetArn": ...,
    "assessmentTemplateName": ...,
    "durationInSeconds": ...,
    "rulesPackageArns": ...,
}

parent.create_assessment_template(**kwargs)

1. See CreateAssessmentTemplateRequestRequestTypeDef

create_exclusions_preview

Starts the generation of an exclusions preview for the specified assessment template.

Type annotations and code completion for boto3.client("inspector").create_exclusions_preview method. boto3 documentation

# create_exclusions_preview method definition

def create_exclusions_preview(
    self,
    *,
    assessmentTemplateArn: str,
) -> CreateExclusionsPreviewResponseTypeDef:  # (1)
    ...

1. See CreateExclusionsPreviewResponseTypeDef

# create_exclusions_preview method usage example with argument unpacking

kwargs: CreateExclusionsPreviewRequestRequestTypeDef = {  # (1)
    "assessmentTemplateArn": ...,
}

parent.create_exclusions_preview(**kwargs)

1. See CreateExclusionsPreviewRequestRequestTypeDef

create_resource_group

Creates a resource group using the specified set of tags (key and value pairs) that are used to select the EC2 instances to be included in an Amazon Inspector assessment target.

Type annotations and code completion for boto3.client("inspector").create_resource_group method.