Skip to content

inspectorscanClient#

Index > inspectorscan > inspectorscanClient

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

inspectorscanClient#

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

# inspectorscanClient usage example

from boto3.session import Session
from mypy_boto3_inspector_scan.client import inspectorscanClient

def get_inspector-scan_client() -> inspectorscanClient:
    return Session().client("inspector-scan")

Exceptions#

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

# Exceptions.exceptions usage example

client = boto3.client("inspector-scan")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.InternalServerException,
    client.exceptions.ThrottlingException,
    client.exceptions.ValidationException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_inspector_scan.client import Exceptions

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

Methods#

can_paginate#

Check if an operation can be paginated.

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

# close method definition

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

generate_presigned_url#

Generate a presigned url given a client, its method, and arguments.

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

scan_sbom#

Scans a provided CycloneDX 1.5 SBOM and reports on any vulnerabilities discovered in that SBOM.

Type annotations and code completion for boto3.client("inspector-scan").scan_sbom method. boto3 documentation

# scan_sbom method definition

def scan_sbom(
    self,
    *,
    sbom: Mapping[str, Any],
    outputFormat: OutputFormatType = ...,  # (1)
) -> ScanSbomResponseTypeDef:  # (2)
    ...
  1. See OutputFormatType
  2. See ScanSbomResponseTypeDef
# scan_sbom method usage example with argument unpacking

kwargs: ScanSbomRequestRequestTypeDef = {  # (1)
    "sbom": ...,
}

parent.scan_sbom(**kwargs)
  1. See ScanSbomRequestRequestTypeDef