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
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.
client = boto3.client("inspector")
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)
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
def add_attributes_to_findings(
self,
*,
findingArns: Sequence[str],
attributes: Sequence[AttributeTypeDef], # (1)
) -> AddAttributesToFindingsResponseTypeDef: # (2)
...
kwargs: AddAttributesToFindingsRequestRequestTypeDef = { # (1)
"findingArns": ...,
"attributes": ...,
}
parent.add_attributes_to_findings(**kwargs)
can_paginate
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("inspector").can_paginate
method.
boto3 documentation
close
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("inspector").close
method.
boto3 documentation
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
def create_assessment_target(
self,
*,
assessmentTargetName: str,
resourceGroupArn: str = ...,
) -> CreateAssessmentTargetResponseTypeDef: # (1)
...
kwargs: CreateAssessmentTargetRequestRequestTypeDef = { # (1)
"assessmentTargetName": ...,
}
parent.create_assessment_target(**kwargs)
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
def create_assessment_template(
self,
*,
assessmentTargetArn: str,
assessmentTemplateName: str,
durationInSeconds: int,
rulesPackageArns: Sequence[str],
userAttributesForFindings: Sequence[AttributeTypeDef] = ..., # (1)
) -> CreateAssessmentTemplateResponseTypeDef: # (2)
...
kwargs: CreateAssessmentTemplateRequestRequestTypeDef = { # (1)
"assessmentTargetArn": ...,
"assessmentTemplateName": ...,
"durationInSeconds": ...,
"rulesPackageArns": ...,
}
parent.create_assessment_template(**kwargs)
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
def create_exclusions_preview(
self,
*,
assessmentTemplateArn: str,
) -> CreateExclusionsPreviewResponseTypeDef: # (1)
...
kwargs: CreateExclusionsPreviewRequestRequestTypeDef = { # (1)
"assessmentTemplateArn": ...,
}
parent.create_exclusions_preview(**kwargs)
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.
boto3 documentation
def create_resource_group(
self,
*,
resourceGroupTags: Sequence[ResourceGroupTagTypeDef], # (1)
) -> CreateResourceGroupResponseTypeDef: # (2)
...
kwargs: CreateResourceGroupRequestRequestTypeDef = { # (1)
"resourceGroupTags": ...,
}
parent.create_resource_group(**kwargs)
delete_assessment_run
Deletes the assessment run that is specified by the ARN of the assessment run.
Type annotations and code completion for boto3.client("inspector").delete_assessment_run
method.
boto3 documentation
def delete_assessment_run(
self,
*,
assessmentRunArn: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteAssessmentRunRequestRequestTypeDef = { # (1)
"assessmentRunArn": ...,
}
parent.delete_assessment_run(**kwargs)
delete_assessment_target
Deletes the assessment target that is specified by the ARN of the assessment target.
Type annotations and code completion for boto3.client("inspector").delete_assessment_target
method.
boto3 documentation
def delete_assessment_target(
self,
*,
assessmentTargetArn: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteAssessmentTargetRequestRequestTypeDef = { # (1)
"assessmentTargetArn": ...,
}
parent.delete_assessment_target(**kwargs)
delete_assessment_template
Deletes the assessment template that is specified by the ARN of the assessment template.
Type annotations and code completion for boto3.client("inspector").delete_assessment_template
method.
boto3 documentation
def delete_assessment_template(
self,
*,
assessmentTemplateArn: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteAssessmentTemplateRequestRequestTypeDef = { # (1)
"assessmentTemplateArn": ...,
}
parent.delete_assessment_template(**kwargs)
describe_assessment_runs
Describes the assessment runs that are specified by the ARNs of the assessment runs.
Type annotations and code completion for boto3.client("inspector").describe_assessment_runs
method.
boto3 documentation
def describe_assessment_runs(
self,
*,
assessmentRunArns: Sequence[str],
) -> DescribeAssessmentRunsResponseTypeDef: # (1)
...
kwargs: DescribeAssessmentRunsRequestRequestTypeDef = { # (1)
"assessmentRunArns": ...,
}
parent.describe_assessment_runs(**kwargs)
describe_assessment_targets
Describes the assessment targets that are specified by the ARNs of the assessment targets.
Type annotations and code completion for boto3.client("inspector").describe_assessment_targets
method.
boto3 documentation
def describe_assessment_targets(
self,
*,
assessmentTargetArns: Sequence[str],
) -> DescribeAssessmentTargetsResponseTypeDef: # (1)
...
kwargs: DescribeAssessmentTargetsRequestRequestTypeDef = { # (1)
"assessmentTargetArns": ...,
}
parent.describe_assessment_targets(**kwargs)
describe_assessment_templates
Describes the assessment templates that are specified by the ARNs of the assessment templates.
Type annotations and code completion for boto3.client("inspector").describe_assessment_templates
method.
boto3 documentation
def describe_assessment_templates(
self,
*,
assessmentTemplateArns: Sequence[str],
) -> DescribeAssessmentTemplatesResponseTypeDef: # (1)
...
kwargs: DescribeAssessmentTemplatesRequestRequestTypeDef = { # (1)
"assessmentTemplateArns": ...,
}
parent.describe_assessment_templates(**kwargs)
describe_cross_account_access_role
Describes the IAM role that enables Amazon Inspector to access your AWS account.
Type annotations and code completion for boto3.client("inspector").describe_cross_account_access_role
method.
boto3 documentation
def describe_cross_account_access_role(
self,
) -> DescribeCrossAccountAccessRoleResponseTypeDef: # (1)
...
describe_exclusions
Describes the exclusions that are specified by the exclusions' ARNs.
Type annotations and code completion for boto3.client("inspector").describe_exclusions
method.
boto3 documentation
def describe_exclusions(
self,
*,
exclusionArns: Sequence[str],
locale: LocaleType = ..., # (1)
) -> DescribeExclusionsResponseTypeDef: # (2)
...
kwargs: DescribeExclusionsRequestRequestTypeDef = { # (1)
"exclusionArns": ...,
}
parent.describe_exclusions(**kwargs)
describe_findings
Describes the findings that are specified by the ARNs of the findings.
Type annotations and code completion for boto3.client("inspector").describe_findings
method.
boto3 documentation
def describe_findings(
self,
*,
findingArns: Sequence[str],
locale: LocaleType = ..., # (1)
) -> DescribeFindingsResponseTypeDef: # (2)
...
kwargs: DescribeFindingsRequestRequestTypeDef = { # (1)
"findingArns": ...,
}
parent.describe_findings(**kwargs)
describe_resource_groups
Describes the resource groups that are specified by the ARNs of the resource groups.
Type annotations and code completion for boto3.client("inspector").describe_resource_groups
method.
boto3 documentation
def describe_resource_groups(
self,
*,
resourceGroupArns: Sequence[str],
) -> DescribeResourceGroupsResponseTypeDef: # (1)
...
kwargs: DescribeResourceGroupsRequestRequestTypeDef = { # (1)
"resourceGroupArns": ...,
}
parent.describe_resource_groups(**kwargs)
describe_rules_packages
Describes the rules packages that are specified by the ARNs of the rules packages.
Type annotations and code completion for boto3.client("inspector").describe_rules_packages
method.
boto3 documentation
def describe_rules_packages(
self,
*,
rulesPackageArns: Sequence[str],
locale: LocaleType = ..., # (1)
) -> DescribeRulesPackagesResponseTypeDef: # (2)
...
kwargs: DescribeRulesPackagesRequestRequestTypeDef = { # (1)
"rulesPackageArns": ...,
}
parent.describe_rules_packages(**kwargs)
generate_presigned_url
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for boto3.client("inspector").generate_presigned_url
method.
boto3 documentation
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 boto3.client("inspector").get_assessment_report
method.
boto3 documentation
def get_assessment_report(
self,
*,
assessmentRunArn: str,
reportFileFormat: ReportFileFormatType, # (1)
reportType: ReportTypeType, # (2)
) -> GetAssessmentReportResponseTypeDef: # (3)
...
kwargs: GetAssessmentReportRequestRequestTypeDef = { # (1)
"assessmentRunArn": ...,
"reportFileFormat": ...,
"reportType": ...,
}
parent.get_assessment_report(**kwargs)
get_exclusions_preview
Retrieves the exclusions preview (a list of ExclusionPreview objects) specified by the preview token.
Type annotations and code completion for boto3.client("inspector").get_exclusions_preview
method.
boto3 documentation
def get_exclusions_preview(
self,
*,
assessmentTemplateArn: str,
previewToken: str,
nextToken: str = ...,
maxResults: int = ...,
locale: LocaleType = ..., # (1)
) -> GetExclusionsPreviewResponseTypeDef: # (2)
...
kwargs: GetExclusionsPreviewRequestRequestTypeDef = { # (1)
"assessmentTemplateArn": ...,
"previewToken": ...,
}
parent.get_exclusions_preview(**kwargs)
get_telemetry_metadata
Information about the data that is collected for the specified assessment run.
Type annotations and code completion for boto3.client("inspector").get_telemetry_metadata
method.
boto3 documentation
def get_telemetry_metadata(
self,
*,
assessmentRunArn: str,
) -> GetTelemetryMetadataResponseTypeDef: # (1)
...
kwargs: GetTelemetryMetadataRequestRequestTypeDef = { # (1)
"assessmentRunArn": ...,
}
parent.get_telemetry_metadata(**kwargs)
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 boto3.client("inspector").list_assessment_run_agents
method.
boto3 documentation
def list_assessment_run_agents(
self,
*,
assessmentRunArn: str,
filter: AgentFilterTypeDef = ..., # (1)
nextToken: str = ...,
maxResults: int = ...,
) -> ListAssessmentRunAgentsResponseTypeDef: # (2)
...
kwargs: ListAssessmentRunAgentsRequestRequestTypeDef = { # (1)
"assessmentRunArn": ...,
}
parent.list_assessment_run_agents(**kwargs)
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 boto3.client("inspector").list_assessment_runs
method.
boto3 documentation
def list_assessment_runs(
self,
*,
assessmentTemplateArns: Sequence[str] = ...,
filter: AssessmentRunFilterTypeDef = ..., # (1)
nextToken: str = ...,
maxResults: int = ...,
) -> ListAssessmentRunsResponseTypeDef: # (2)
...
kwargs: ListAssessmentRunsRequestRequestTypeDef = { # (1)
"assessmentTemplateArns": ...,
}
parent.list_assessment_runs(**kwargs)
list_assessment_targets
Lists the ARNs of the assessment targets within this AWS account.
Type annotations and code completion for boto3.client("inspector").list_assessment_targets
method.
boto3 documentation
def list_assessment_targets(
self,
*,
filter: AssessmentTargetFilterTypeDef = ..., # (1)
nextToken: str = ...,
maxResults: int = ...,
) -> ListAssessmentTargetsResponseTypeDef: # (2)
...
kwargs: ListAssessmentTargetsRequestRequestTypeDef = { # (1)
"filter": ...,
}
parent.list_assessment_targets(**kwargs)
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 boto3.client("inspector").list_assessment_templates
method.
boto3 documentation
def list_assessment_templates(
self,
*,
assessmentTargetArns: Sequence[str] = ...,
filter: AssessmentTemplateFilterTypeDef = ..., # (1)
nextToken: str = ...,
maxResults: int = ...,
) -> ListAssessmentTemplatesResponseTypeDef: # (2)
...
kwargs: ListAssessmentTemplatesRequestRequestTypeDef = { # (1)
"assessmentTargetArns": ...,
}
parent.list_assessment_templates(**kwargs)
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 boto3.client("inspector").list_event_subscriptions
method.
boto3 documentation
def list_event_subscriptions(
self,
*,
resourceArn: str = ...,
nextToken: str = ...,
maxResults: int = ...,
) -> ListEventSubscriptionsResponseTypeDef: # (1)
...
kwargs: ListEventSubscriptionsRequestRequestTypeDef = { # (1)
"resourceArn": ...,
}
parent.list_event_subscriptions(**kwargs)
list_exclusions
List exclusions that are generated by the assessment run.
Type annotations and code completion for boto3.client("inspector").list_exclusions
method.
boto3 documentation
def list_exclusions(
self,
*,
assessmentRunArn: str,
nextToken: str = ...,
maxResults: int = ...,
) -> ListExclusionsResponseTypeDef: # (1)
...
kwargs: ListExclusionsRequestRequestTypeDef = { # (1)
"assessmentRunArn": ...,
}
parent.list_exclusions(**kwargs)
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 boto3.client("inspector").list_findings
method.
boto3 documentation
def list_findings(
self,
*,
assessmentRunArns: Sequence[str] = ...,
filter: FindingFilterTypeDef = ..., # (1)
nextToken: str = ...,
maxResults: int = ...,
) -> ListFindingsResponseTypeDef: # (2)
...
kwargs: ListFindingsRequestRequestTypeDef = { # (1)
"assessmentRunArns": ...,
}
parent.list_findings(**kwargs)
list_rules_packages
Lists all available Amazon Inspector rules packages.
Type annotations and code completion for boto3.client("inspector").list_rules_packages
method.
boto3 documentation
def list_rules_packages(
self,
*,
nextToken: str = ...,
maxResults: int = ...,
) -> ListRulesPackagesResponseTypeDef: # (1)
...
kwargs: ListRulesPackagesRequestRequestTypeDef = { # (1)
"nextToken": ...,
}
parent.list_rules_packages(**kwargs)
list_tags_for_resource
Lists all tags associated with an assessment template.
Type annotations and code completion for boto3.client("inspector").list_tags_for_resource
method.
boto3 documentation
def list_tags_for_resource(
self,
*,
resourceArn: str,
) -> ListTagsForResourceResponseTypeDef: # (1)
...
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)
preview_agents
Previews the agents installed on the EC2 instances that are part of the specified assessment target.
Type annotations and code completion for boto3.client("inspector").preview_agents
method.
boto3 documentation
def preview_agents(
self,
*,
previewAgentsArn: str,
nextToken: str = ...,
maxResults: int = ...,
) -> PreviewAgentsResponseTypeDef: # (1)
...
kwargs: PreviewAgentsRequestRequestTypeDef = { # (1)
"previewAgentsArn": ...,
}
parent.preview_agents(**kwargs)
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 boto3.client("inspector").register_cross_account_access_role
method.
boto3 documentation
def register_cross_account_access_role(
self,
*,
roleArn: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: RegisterCrossAccountAccessRoleRequestRequestTypeDef = { # (1)
"roleArn": ...,
}
parent.register_cross_account_access_role(**kwargs)
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 boto3.client("inspector").remove_attributes_from_findings
method.
boto3 documentation
def remove_attributes_from_findings(
self,
*,
findingArns: Sequence[str],
attributeKeys: Sequence[str],
) -> RemoveAttributesFromFindingsResponseTypeDef: # (1)
...
kwargs: RemoveAttributesFromFindingsRequestRequestTypeDef = { # (1)
"findingArns": ...,
"attributeKeys": ...,
}
parent.remove_attributes_from_findings(**kwargs)
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 boto3.client("inspector").set_tags_for_resource
method.
boto3 documentation
def set_tags_for_resource(
self,
*,
resourceArn: str,
tags: Sequence[TagTypeDef] = ..., # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...
kwargs: SetTagsForResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
}
parent.set_tags_for_resource(**kwargs)
start_assessment_run
Starts the assessment run specified by the ARN of the assessment template.
Type annotations and code completion for boto3.client("inspector").start_assessment_run
method.
boto3 documentation
def start_assessment_run(
self,
*,
assessmentTemplateArn: str,
assessmentRunName: str = ...,
) -> StartAssessmentRunResponseTypeDef: # (1)
...
kwargs: StartAssessmentRunRequestRequestTypeDef = { # (1)
"assessmentTemplateArn": ...,
}
parent.start_assessment_run(**kwargs)
stop_assessment_run
Stops the assessment run that is specified by the ARN of the assessment run.
Type annotations and code completion for boto3.client("inspector").stop_assessment_run
method.
boto3 documentation
def stop_assessment_run(
self,
*,
assessmentRunArn: str,
stopAction: StopActionType = ..., # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...
kwargs: StopAssessmentRunRequestRequestTypeDef = { # (1)
"assessmentRunArn": ...,
}
parent.stop_assessment_run(**kwargs)
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 boto3.client("inspector").subscribe_to_event
method.
boto3 documentation
def subscribe_to_event(
self,
*,
resourceArn: str,
event: InspectorEventType, # (1)
topicArn: str,
) -> EmptyResponseMetadataTypeDef: # (2)
...
kwargs: SubscribeToEventRequestRequestTypeDef = { # (1)
"resourceArn": ...,
"event": ...,
"topicArn": ...,
}
parent.subscribe_to_event(**kwargs)
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 boto3.client("inspector").unsubscribe_from_event
method.
boto3 documentation
def unsubscribe_from_event(
self,
*,
resourceArn: str,
event: InspectorEventType, # (1)
topicArn: str,
) -> EmptyResponseMetadataTypeDef: # (2)
...
kwargs: UnsubscribeFromEventRequestRequestTypeDef = { # (1)
"resourceArn": ...,
"event": ...,
"topicArn": ...,
}
parent.unsubscribe_from_event(**kwargs)
update_assessment_target
Updates the assessment target that is specified by the ARN of the assessment target.
Type annotations and code completion for boto3.client("inspector").update_assessment_target
method.
boto3 documentation
def update_assessment_target(
self,
*,
assessmentTargetArn: str,
assessmentTargetName: str,
resourceGroupArn: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: UpdateAssessmentTargetRequestRequestTypeDef = { # (1)
"assessmentTargetArn": ...,
"assessmentTargetName": ...,
}
parent.update_assessment_target(**kwargs)
get_paginator
Type annotations and code completion for boto3.client("inspector").get_paginator
method with overloads.
client.get_paginator("list_assessment_run_agents")
-> ListAssessmentRunAgentsPaginatorclient.get_paginator("list_assessment_runs")
-> ListAssessmentRunsPaginatorclient.get_paginator("list_assessment_targets")
-> ListAssessmentTargetsPaginatorclient.get_paginator("list_assessment_templates")
-> ListAssessmentTemplatesPaginatorclient.get_paginator("list_event_subscriptions")
-> ListEventSubscriptionsPaginatorclient.get_paginator("list_exclusions")
-> ListExclusionsPaginatorclient.get_paginator("list_findings")
-> ListFindingsPaginatorclient.get_paginator("list_rules_packages")
-> ListRulesPackagesPaginatorclient.get_paginator("preview_agents")
-> PreviewAgentsPaginator