InspectorClient

Index > Inspector > InspectorClient

Auto-generated documentation for Inspector type annotations stubs module types-aiobotocore-inspector.

InspectorClient

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

Usage example

from aioboto3.session import Session
from types_aiobotocore_inspector.client import InspectorClient

session = Session()
async with session.client("inspector") as client:
    client: InspectorClient

Exceptions

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

Usage example

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

Type checking example

from types_aiobotocore_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 session.client("inspector").add_attributes_to_findings method. boto3 documentation

Method definition

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

1. See AttributeTypeDef
2. See AddAttributesToFindingsResponseTypeDef

Usage example with kwargs

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 session.client("inspector").can_paginate method. boto3 documentation

Method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close

Closes underlying endpoint connections.

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

Method definition

await 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 session.client("inspector").create_assessment_target method. boto3 documentation

Method definition

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

1. See CreateAssessmentTargetResponseTypeDef

Usage example with kwargs

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 session.client("inspector").create_assessment_template method. boto3 documentation

Method definition

await 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

Usage example with kwargs

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 session.client("inspector").create_exclusions_preview method. boto3 documentation

Method definition

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

1. See CreateExclusionsPreviewResponseTypeDef

Usage example with kwargs

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 session.client("inspector").create_resource_group method. boto3 documentation

Method definition

await def create_resource_group(
    self,
    *,
    resourceGroupTags: Sequence[ResourceGroupTagTypeDef],  # (1)
) -> CreateResourceGroupResponseTypeDef:  # (2)
    ...

1. See ResourceGroupTagTypeDef
2. See CreateResourceGroupResponseTypeDef

Usage example with kwargs

kwargs: CreateResourceGroupRequestRequestTypeDef = {  # (1)
    "resourceGroupTags": ...,
}

parent.create_resource_group(**kwargs)

1. See CreateResourceGroupRequestRequestTypeDef

delete_assessment_run

Deletes the assessment run that is specified by the ARN of the assessment run.

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

Method definition

await def delete_assessment_run(
    self,
    *,
    assessmentRunArn: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

kwargs: DeleteAssessmentRunRequestRequestTypeDef = {  # (1)
    "assessmentRunArn": ...,
}

parent.delete_assessment_run(**kwargs)

1. See DeleteAssessmentRunRequestRequestTypeDef

delete_assessment_target

Deletes the assessment target that is specified by the ARN of the assessment target.

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

Method definition

await def delete_assessment_target(
    self,
    *,
    assessmentTargetArn: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

kwargs: DeleteAssessmentTargetRequestRequestTypeDef = {  # (1)
    "assessmentTargetArn": ...,
}

parent.delete_assessment_target(**kwargs)

1. See DeleteAssessmentTargetRequestRequestTypeDef

delete_assessment_template

Deletes the assessment template that is specified by the ARN of the assessment template.

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

Method definition

await def delete_assessment_template(
    self,
    *,
    assessmentTemplateArn: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.delete_assessment_template(**kwargs)

1. See DeleteAssessmentTemplateRequestRequestTypeDef

describe_assessment_runs

Describes the assessment runs that are specified by the ARNs of the assessment runs.

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

Method definition

await def describe_assessment_runs(
    self,
    *,
    assessmentRunArns: Sequence[str],
) -> DescribeAssessmentRunsResponseTypeDef:  # (1)
    ...

1. See DescribeAssessmentRunsResponseTypeDef

Usage example with kwargs

kwargs: DescribeAssessmentRunsRequestRequestTypeDef = {  # (1)
    "assessmentRunArns": ...,
}

parent.describe_assessment_runs(**kwargs)

1. See DescribeAssessmentRunsRequestRequestTypeDef

describe_assessment_targets

Describes the assessment targets that are specified by the ARNs of the assessment targets.

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

Method definition

await def describe_assessment_targets(
    self,
    *,
    assessmentTargetArns: Sequence[str],
) -> DescribeAssessmentTargetsResponseTypeDef:  # (1)
    ...

1. See DescribeAssessmentTargetsResponseTypeDef

Usage example with kwargs

kwargs: DescribeAssessmentTargetsRequestRequestTypeDef = {  # (1)
    "assessmentTargetArns": ...,
}

parent.describe_assessment_targets(**kwargs)

1. See DescribeAssessmentTargetsRequestRequestTypeDef

describe_assessment_templates

Describes the assessment templates that are specified by the ARNs of the assessment templates.

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

Method definition

await def describe_assessment_templates(
    self,
    *,
    assessmentTemplateArns: Sequence[str],
) -> DescribeAssessmentTemplatesResponseTypeDef:  # (1)
    ...

1. See DescribeAssessmentTemplatesResponseTypeDef

Usage example with kwargs

kwargs: DescribeAssessmentTemplatesRequestRequestTypeDef = {  # (1)
    "assessmentTemplateArns": ...,
}

parent.describe_assessment_templates(**kwargs)

1. See DescribeAssessmentTemplatesRequestRequestTypeDef

describe_cross_account_access_role

Describes the IAM role that enables Amazon Inspector to access your AWS account.

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

Method definition

await def describe_cross_account_access_role(
    self,
) -> DescribeCrossAccountAccessRoleResponseTypeDef:  # (1)
    ...

1. See DescribeCrossAccountAccessRoleResponseTypeDef

describe_exclusions

Describes the exclusions that are specified by the exclusions' ARNs.

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

Method definition

await def describe_exclusions(
    self,
    *,
    exclusionArns: Sequence[str],
    locale: LocaleType = ...,  # (1)
) -> DescribeExclusionsResponseTypeDef:  # (2)
    ...

1. See LocaleType
2. See DescribeExclusionsResponseTypeDef

Usage example with kwargs

kwargs: DescribeExclusionsRequestRequestTypeDef = {  # (1)
    "exclusionArns": ...,
}

parent.describe_exclusions(**kwargs)

1. See DescribeExclusionsRequestRequestTypeDef

describe_findings

Describes the findings that are specified by the ARNs of the findings.

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

Method definition

await def describe_findings(
    self,
    *,
    findingArns: Sequence[str],
    locale: LocaleType = ...,  # (1)
) -> DescribeFindingsResponseTypeDef:  # (2)
    ...

1. See LocaleType
2. See DescribeFindingsResponseTypeDef

Usage example with kwargs

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

parent.describe_findings(**kwargs)

1. See DescribeFindingsRequestRequestTypeDef

describe_resource_groups

Describes the resource groups that are specified by the ARNs of the resource groups.

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

Method definition

await def describe_resource_groups(
    self,
    *,
    resourceGroupArns: Sequence[str],
) -> DescribeResourceGroupsResponseTypeDef:  # (1)
    ...

1. See DescribeResourceGroupsResponseTypeDef

Usage example with kwargs

kwargs: DescribeResourceGroupsRequestRequestTypeDef = {  # (1)
    "resourceGroupArns": ...,
}

parent.describe_resource_groups(**kwargs)

1. See DescribeResourceGroupsRequestRequestTypeDef

describe_rules_packages

Describes the rules packages that are specified by the ARNs of the rules packages.

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

Method definition

await def describe_rules_packages(
    self,
    *,
    rulesPackageArns: Sequence[str],
    locale: LocaleType = ...,  # (1)
) -> DescribeRulesPackagesResponseTypeDef:  # (2)
    ...

1. See LocaleType
2. See DescribeRulesPackagesResponseTypeDef

Usage example with kwargs

kwargs: DescribeRulesPackagesRequestRequestTypeDef = {  # (1)
    "rulesPackageArns": ...,
}

parent.describe_rules_packages(**kwargs)

1. See DescribeRulesPackagesRequestRequestTypeDef

generate_presigned_url

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

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

Method definition

await def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

get_assessment_report

Produces an assessment report that includes detailed and comprehensive results of a specified assessment run.

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

Method definition

await def get_assessment_report(
    self,
    *,
    assessmentRunArn: str,
    reportFileFormat: ReportFileFormatType,  # (1)
    reportType: ReportTypeType,  # (2)
) -> GetAssessmentReportResponseTypeDef:  # (3)
    ...

1. See ReportFileFormatType
2. See ReportTypeType
3. See GetAssessmentReportResponseTypeDef

Usage example with kwargs

kwargs: GetAssessmentReportRequestRequestTypeDef = {  # (1)
    "assessmentRunArn": ...,
    "reportFileFormat": ...,
    "reportType": ...,
}

parent.get_assessment_report(**kwargs)

1. See GetAssessmentReportRequestRequestTypeDef

get_exclusions_preview

Retrieves the exclusions preview (a list of ExclusionPreview objects) specified by the preview token.

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

Method definition

await def get_exclusions_preview(
    self,
    *,
    assessmentTemplateArn: str,
    previewToken: str,
    nextToken: str = ...,
    maxResults: int = ...,
    locale: LocaleType = ...,  # (1)
) -> GetExclusionsPreviewResponseTypeDef:  # (2)
    ...

1. See LocaleType
2. See GetExclusionsPreviewResponseTypeDef

Usage example with kwargs

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

parent.get_exclusions_preview(**kwargs)

1. See GetExclusionsPreviewRequestRequestTypeDef

get_telemetry_metadata

Information about the data that is collected for the specified assessment run.

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

Method definition

await def get_telemetry_metadata(
    self,
    *,
    assessmentRunArn: str,
) -> GetTelemetryMetadataResponseTypeDef:  # (1)
    ...

1. See GetTelemetryMetadataResponseTypeDef

Usage example with kwargs

kwargs: GetTelemetryMetadataRequestRequestTypeDef = {  # (1)
    "assessmentRunArn": ...,
}

parent.get_telemetry_metadata(**kwargs)

1. See GetTelemetryMetadataRequestRequestTypeDef

list_assessment_run_agents

Lists the agents of the assessment runs that are specified by the ARNs of the assessment runs.

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

Method definition

await def list_assessment_run_agents(
    self,
    *,
    assessmentRunArn: str,
    filter: AgentFilterTypeDef = ...,  # (1)
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListAssessmentRunAgentsResponseTypeDef:  # (2)
    ...

1. See AgentFilterTypeDef
2. See ListAssessmentRunAgentsResponseTypeDef

Usage example with kwargs

kwargs: ListAssessmentRunAgentsRequestRequestTypeDef = {  # (1)
    "assessmentRunArn": ...,
}

parent.list_assessment_run_agents(**kwargs)

1. See ListAssessmentRunAgentsRequestRequestTypeDef

list_assessment_runs

Lists the assessment runs that correspond to the assessment templates that are specified by the ARNs of the assessment templates.

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

Method definition

await def list_assessment_runs(
    self,
    *,
    assessmentTemplateArns: Sequence[str] = ...,
    filter: AssessmentRunFilterTypeDef = ...,  # (1)
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListAssessmentRunsResponseTypeDef:  # (2)
    ...

1. See AssessmentRunFilterTypeDef
2. See ListAssessmentRunsResponseTypeDef

Usage example with kwargs

kwargs: ListAssessmentRunsRequestRequestTypeDef = {  # (1)
    "assessmentTemplateArns": ...,
}

parent.list_assessment_runs(**kwargs)

1. See ListAssessmentRunsRequestRequestTypeDef

list_assessment_targets

Lists the ARNs of the assessment targets within this AWS account.

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

Method definition

await def list_assessment_targets(
    self,
    *,
    filter: AssessmentTargetFilterTypeDef = ...,  # (1)
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListAssessmentTargetsResponseTypeDef:  # (2)
    ...

1. See AssessmentTargetFilterTypeDef
2. See ListAssessmentTargetsResponseTypeDef

Usage example with kwargs

kwargs: ListAssessmentTargetsRequestRequestTypeDef = {  # (1)
    "filter": ...,
}

parent.list_assessment_targets(**kwargs)

1. See ListAssessmentTargetsRequestRequestTypeDef

list_assessment_templates

Lists the assessment templates that correspond to the assessment targets that are specified by the ARNs of the assessment targets.

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

Method definition

await def list_assessment_templates(
    self,
    *,
    assessmentTargetArns: Sequence[str] = ...,
    filter: AssessmentTemplateFilterTypeDef = ...,  # (1)
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListAssessmentTemplatesResponseTypeDef:  # (2)
    ...

1. See AssessmentTemplateFilterTypeDef
2. See ListAssessmentTemplatesResponseTypeDef

Usage example with kwargs

kwargs: ListAssessmentTemplatesRequestRequestTypeDef = {  # (1)
    "assessmentTargetArns": ...,
}

parent.list_assessment_templates(**kwargs)

1. See ListAssessmentTemplatesRequestRequestTypeDef

list_event_subscriptions

Lists all the event subscriptions for the assessment template that is specified by the ARN of the assessment template.

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

Method definition

await def list_event_subscriptions(
    self,
    *,
    resourceArn: str = ...,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListEventSubscriptionsResponseTypeDef:  # (1)
    ...

1. See ListEventSubscriptionsResponseTypeDef

Usage example with kwargs

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

parent.list_event_subscriptions(**kwargs)

1. See ListEventSubscriptionsRequestRequestTypeDef

list_exclusions

List exclusions that are generated by the assessment run.

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

Method definition

await def list_exclusions(
    self,
    *,
    assessmentRunArn: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListExclusionsResponseTypeDef:  # (1)
    ...

1. See ListExclusionsResponseTypeDef

Usage example with kwargs

kwargs: ListExclusionsRequestRequestTypeDef = {  # (1)
    "assessmentRunArn": ...,
}

parent.list_exclusions(**kwargs)

1. See ListExclusionsRequestRequestTypeDef

list_findings

Lists findings that are generated by the assessment runs that are specified by the ARNs of the assessment runs.

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

Method definition

await def list_findings(
    self,
    *,
    assessmentRunArns: Sequence[str] = ...,
    filter: FindingFilterTypeDef = ...,  # (1)
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListFindingsResponseTypeDef:  # (2)
    ...

1. See FindingFilterTypeDef
2. See ListFindingsResponseTypeDef

Usage example with kwargs

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

parent.list_findings(**kwargs)

1. See ListFindingsRequestRequestTypeDef

list_rules_packages

Lists all available Amazon Inspector rules packages.

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

Method definition

await def list_rules_packages(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListRulesPackagesResponseTypeDef:  # (1)
    ...

1. See ListRulesPackagesResponseTypeDef

Usage example with kwargs

kwargs: ListRulesPackagesRequestRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_rules_packages(**kwargs)

1. See ListRulesPackagesRequestRequestTypeDef

list_tags_for_resource

Lists all tags associated with an assessment template.

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

Method definition

await def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...

1. See ListTagsForResourceResponseTypeDef

Usage example with kwargs

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

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestRequestTypeDef

preview_agents

Previews the agents installed on the EC2 instances that are part of the specified assessment target.

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

Method definition

await def preview_agents(
    self,
    *,
    previewAgentsArn: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> PreviewAgentsResponseTypeDef:  # (1)
    ...

1. See PreviewAgentsResponseTypeDef

Usage example with kwargs

kwargs: PreviewAgentsRequestRequestTypeDef = {  # (1)
    "previewAgentsArn": ...,
}

parent.preview_agents(**kwargs)

1. See PreviewAgentsRequestRequestTypeDef

register_cross_account_access_role

Registers the IAM role that grants Amazon Inspector access to AWS Services needed to perform security assessments.

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

Method definition

await def register_cross_account_access_role(
    self,
    *,
    roleArn: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

kwargs: RegisterCrossAccountAccessRoleRequestRequestTypeDef = {  # (1)
    "roleArn": ...,
}

parent.register_cross_account_access_role(**kwargs)

1. See RegisterCrossAccountAccessRoleRequestRequestTypeDef

remove_attributes_from_findings

Removes entire attributes (key and value pairs) from the findings that are specified by the ARNs of the findings where an attribute with the specified key exists.

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

Method definition

await def remove_attributes_from_findings(
    self,
    *,
    findingArns: Sequence[str],
    attributeKeys: Sequence[str],
) -> RemoveAttributesFromFindingsResponseTypeDef:  # (1)
    ...

1. See RemoveAttributesFromFindingsResponseTypeDef

Usage example with kwargs

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

parent.remove_attributes_from_findings(**kwargs)

1. See RemoveAttributesFromFindingsRequestRequestTypeDef

set_tags_for_resource

Sets tags (key and value pairs) to the assessment template that is specified by the ARN of the assessment template.

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

Method definition

await def set_tags_for_resource(
    self,
    *,
    resourceArn: str,
    tags: Sequence[TagTypeDef] = ...,  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...

1. See TagTypeDef
2. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.set_tags_for_resource(**kwargs)

1. See SetTagsForResourceRequestRequestTypeDef

start_assessment_run

Starts the assessment run specified by the ARN of the assessment template.

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

Method definition

await def start_assessment_run(
    self,
    *,
    assessmentTemplateArn: str,
    assessmentRunName: str = ...,
) -> StartAssessmentRunResponseTypeDef:  # (1)
    ...

1. See StartAssessmentRunResponseTypeDef

Usage example with kwargs

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

parent.start_assessment_run(**kwargs)

1. See StartAssessmentRunRequestRequestTypeDef

stop_assessment_run

Stops the assessment run that is specified by the ARN of the assessment run.

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

Method definition

await def stop_assessment_run(
    self,
    *,
    assessmentRunArn: str,
    stopAction: StopActionType = ...,  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...

1. See StopActionType
2. See EmptyResponseMetadataTypeDef

Usage example with kwargs

kwargs: StopAssessmentRunRequestRequestTypeDef = {  # (1)
    "assessmentRunArn": ...,
}

parent.stop_assessment_run(**kwargs)

1. See StopAssessmentRunRequestRequestTypeDef

subscribe_to_event

Enables the process of sending Amazon Simple Notification Service (SNS) notifications about a specified event to a specified SNS topic.

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

Method definition

await def subscribe_to_event(
    self,
    *,
    resourceArn: str,
    event: InspectorEventType,  # (1)
    topicArn: str,
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...

1. See InspectorEventType
2. See EmptyResponseMetadataTypeDef

Usage example with kwargs

kwargs: SubscribeToEventRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "event": ...,
    "topicArn": ...,
}

parent.subscribe_to_event(**kwargs)

1. See SubscribeToEventRequestRequestTypeDef

unsubscribe_from_event

Disables the process of sending Amazon Simple Notification Service (SNS) notifications about a specified event to a specified SNS topic.

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

Method definition

await def unsubscribe_from_event(
    self,
    *,
    resourceArn: str,
    event: InspectorEventType,  # (1)
    topicArn: str,
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...

1. See InspectorEventType
2. See EmptyResponseMetadataTypeDef

Usage example with kwargs

kwargs: UnsubscribeFromEventRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "event": ...,
    "topicArn": ...,
}

parent.unsubscribe_from_event(**kwargs)

1. See UnsubscribeFromEventRequestRequestTypeDef

update_assessment_target

Updates the assessment target that is specified by the ARN of the assessment target.

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

Method definition

await def update_assessment_target(
    self,
    *,
    assessmentTargetArn: str,
    assessmentTargetName: str,
    resourceGroupArn: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.update_assessment_target(**kwargs)

1. See UpdateAssessmentTargetRequestRequestTypeDef

__aenter__

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

Method definition

await def __aenter__(
    self,
) -> InspectorClient:
    ...

__aexit__

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

Method definition

await def __aexit__(
    self,
    exc_type: Any,
    exc_val: Any,
    exc_tb: Any,
) -> Any:
    ...

get_paginator

Type annotations and code completion for session.client("inspector").get_paginator method with overloads.

• client.get_paginator("list_assessment_run_agents") -> ListAssessmentRunAgentsPaginator
• client.get_paginator("list_assessment_runs") -> ListAssessmentRunsPaginator
• client.get_paginator("list_assessment_targets") -> ListAssessmentTargetsPaginator
• client.get_paginator("list_assessment_templates") -> ListAssessmentTemplatesPaginator
• client.get_paginator("list_event_subscriptions") -> ListEventSubscriptionsPaginator
• client.get_paginator("list_exclusions") -> ListExclusionsPaginator
• client.get_paginator("list_findings") -> ListFindingsPaginator
• client.get_paginator("list_rules_packages") -> ListRulesPackagesPaginator
• client.get_paginator("preview_agents") -> PreviewAgentsPaginator