AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Implementation for accessing Inspector

Amazon Inspector

Amazon Inspector enables you to analyze the behavior of your AWS resources and to identify potential security issues. For more information, see Amazon Inspector User Guide.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonServiceClient
    Amazon.Inspector.AmazonInspectorClient

Namespace: Amazon.Inspector
Assembly: AWSSDK.Inspector.dll
Version: 3.x.y.z

Syntax

C#
public class AmazonInspectorClient : AmazonServiceClient
         IAmazonInspector, IAmazonService, IDisposable

The AmazonInspectorClient type exposes the following members

Constructors

NameDescription
Public Method AmazonInspectorClient()

Constructs AmazonInspectorClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>
             

Public Method AmazonInspectorClient(RegionEndpoint)

Constructs AmazonInspectorClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>
             

Public Method AmazonInspectorClient(AmazonInspectorConfig)

Constructs AmazonInspectorClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>
             

Public Method AmazonInspectorClient(AWSCredentials)

Constructs AmazonInspectorClient with AWS Credentials

Public Method AmazonInspectorClient(AWSCredentials, RegionEndpoint)

Constructs AmazonInspectorClient with AWS Credentials

Public Method AmazonInspectorClient(AWSCredentials, AmazonInspectorConfig)

Constructs AmazonInspectorClient with AWS Credentials and an AmazonInspectorClient Configuration object.

Public Method AmazonInspectorClient(string, string)

Constructs AmazonInspectorClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonInspectorClient(string, string, RegionEndpoint)

Constructs AmazonInspectorClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonInspectorClient(string, string, AmazonInspectorConfig)

Constructs AmazonInspectorClient with AWS Access Key ID, AWS Secret Key and an AmazonInspectorClient Configuration object.

Public Method AmazonInspectorClient(string, string, string)

Constructs AmazonInspectorClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonInspectorClient(string, string, string, RegionEndpoint)

Constructs AmazonInspectorClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonInspectorClient(string, string, string, AmazonInspectorConfig)

Constructs AmazonInspectorClient with AWS Access Key ID, AWS Secret Key and an AmazonInspectorClient Configuration object.

Properties

NameTypeDescription
Public Property Config Amazon.Runtime.IClientConfig Inherited from Amazon.Runtime.AmazonServiceClient.
Public Property Paginators Amazon.Inspector.Model.IInspectorPaginatorFactory

Paginators for the service

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method AddAttributesToFindings(AddAttributesToFindingsRequest)

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

Public Method AddAttributesToFindingsAsync(AddAttributesToFindingsRequest, CancellationToken)

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

Public Method CreateAssessmentTarget(CreateAssessmentTargetRequest)

Creates a new assessment target using the ARN of the resource group that is generated by CreateResourceGroup. If resourceGroupArn is not specified, all EC2 instances in the current AWS account and region are included in the assessment target. If the service-linked role isn’t already registered, this action also creates and registers a service-linked role to grant Amazon Inspector access to AWS Services needed to perform security assessments. You can create up to 50 assessment targets per AWS account. You can run up to 500 concurrent agents per AWS account. For more information, see Amazon Inspector Assessment Targets.

Public Method CreateAssessmentTargetAsync(CreateAssessmentTargetRequest, CancellationToken)

Creates a new assessment target using the ARN of the resource group that is generated by CreateResourceGroup. If resourceGroupArn is not specified, all EC2 instances in the current AWS account and region are included in the assessment target. If the service-linked role isn’t already registered, this action also creates and registers a service-linked role to grant Amazon Inspector access to AWS Services needed to perform security assessments. You can create up to 50 assessment targets per AWS account. You can run up to 500 concurrent agents per AWS account. For more information, see Amazon Inspector Assessment Targets.

Public Method CreateAssessmentTemplate(CreateAssessmentTemplateRequest)

Creates an assessment template for the assessment target that is specified by the ARN of the assessment target. If the service-linked role isn’t already registered, this action also creates and registers a service-linked role to grant Amazon Inspector access to AWS Services needed to perform security assessments.

Public Method CreateAssessmentTemplateAsync(CreateAssessmentTemplateRequest, CancellationToken)

Creates an assessment template for the assessment target that is specified by the ARN of the assessment target. If the service-linked role isn’t already registered, this action also creates and registers a service-linked role to grant Amazon Inspector access to AWS Services needed to perform security assessments.

Public Method CreateExclusionsPreview(CreateExclusionsPreviewRequest)

Starts the generation of an exclusions preview for the specified assessment template. The exclusions preview lists the potential exclusions (ExclusionPreview) that Inspector can detect before it runs the assessment.

Public Method CreateExclusionsPreviewAsync(CreateExclusionsPreviewRequest, CancellationToken)

Starts the generation of an exclusions preview for the specified assessment template. The exclusions preview lists the potential exclusions (ExclusionPreview) that Inspector can detect before it runs the assessment.

Public Method CreateResourceGroup(CreateResourceGroupRequest)

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. The created resource group is then used to create an Amazon Inspector assessment target. For more information, see CreateAssessmentTarget.

Public Method CreateResourceGroupAsync(CreateResourceGroupRequest, CancellationToken)

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. The created resource group is then used to create an Amazon Inspector assessment target. For more information, see CreateAssessmentTarget.

Public Method DeleteAssessmentRun(DeleteAssessmentRunRequest)

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

Public Method DeleteAssessmentRunAsync(DeleteAssessmentRunRequest, CancellationToken)

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

Public Method DeleteAssessmentTarget(DeleteAssessmentTargetRequest)

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

Public Method DeleteAssessmentTargetAsync(DeleteAssessmentTargetRequest, CancellationToken)

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

Public Method DeleteAssessmentTemplate(DeleteAssessmentTemplateRequest)

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

Public Method DeleteAssessmentTemplateAsync(DeleteAssessmentTemplateRequest, CancellationToken)

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

Public Method DescribeAssessmentRuns(DescribeAssessmentRunsRequest)

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

Public Method DescribeAssessmentRunsAsync(DescribeAssessmentRunsRequest, CancellationToken)

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

Public Method DescribeAssessmentTargets(DescribeAssessmentTargetsRequest)

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

Public Method DescribeAssessmentTargetsAsync(DescribeAssessmentTargetsRequest, CancellationToken)

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

Public Method DescribeAssessmentTemplates(DescribeAssessmentTemplatesRequest)

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

Public Method DescribeAssessmentTemplatesAsync(DescribeAssessmentTemplatesRequest, CancellationToken)

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

Public Method DescribeCrossAccountAccessRole(DescribeCrossAccountAccessRoleRequest)

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

Public Method DescribeCrossAccountAccessRoleAsync(DescribeCrossAccountAccessRoleRequest, CancellationToken)

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

Public Method DescribeExclusions(DescribeExclusionsRequest)

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

Public Method DescribeExclusionsAsync(DescribeExclusionsRequest, CancellationToken)

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

Public Method DescribeFindings(DescribeFindingsRequest)

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

Public Method DescribeFindingsAsync(DescribeFindingsRequest, CancellationToken)

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

Public Method DescribeResourceGroups(DescribeResourceGroupsRequest)

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

Public Method DescribeResourceGroupsAsync(DescribeResourceGroupsRequest, CancellationToken)

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

Public Method DescribeRulesPackages(DescribeRulesPackagesRequest)

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

Public Method DescribeRulesPackagesAsync(DescribeRulesPackagesRequest, CancellationToken)

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

Public Method DetermineServiceOperationEndpoint(AmazonWebServiceRequest)

Returns the endpoint that will be used for a particular request.

Public Method Dispose() Inherited from Amazon.Runtime.AmazonServiceClient.
Public Method GetAssessmentReport(GetAssessmentReportRequest)

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

Public Method GetAssessmentReportAsync(GetAssessmentReportRequest, CancellationToken)

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

Public Method GetExclusionsPreview(GetExclusionsPreviewRequest)

Retrieves the exclusions preview (a list of ExclusionPreview objects) specified by the preview token. You can obtain the preview token by running the CreateExclusionsPreview API.

Public Method GetExclusionsPreviewAsync(GetExclusionsPreviewRequest, CancellationToken)

Retrieves the exclusions preview (a list of ExclusionPreview objects) specified by the preview token. You can obtain the preview token by running the CreateExclusionsPreview API.

Public Method GetTelemetryMetadata(GetTelemetryMetadataRequest)

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

Public Method GetTelemetryMetadataAsync(GetTelemetryMetadataRequest, CancellationToken)

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

Public Method ListAssessmentRunAgents(ListAssessmentRunAgentsRequest)

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

Public Method ListAssessmentRunAgentsAsync(ListAssessmentRunAgentsRequest, CancellationToken)

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

Public Method ListAssessmentRuns(ListAssessmentRunsRequest)

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

Public Method ListAssessmentRunsAsync(ListAssessmentRunsRequest, CancellationToken)

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

Public Method ListAssessmentTargets(ListAssessmentTargetsRequest)

Lists the ARNs of the assessment targets within this AWS account. For more information about assessment targets, see Amazon Inspector Assessment Targets.

Public Method ListAssessmentTargetsAsync(ListAssessmentTargetsRequest, CancellationToken)

Lists the ARNs of the assessment targets within this AWS account. For more information about assessment targets, see Amazon Inspector Assessment Targets.

Public Method ListAssessmentTemplates(ListAssessmentTemplatesRequest)

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

Public Method ListAssessmentTemplatesAsync(ListAssessmentTemplatesRequest, CancellationToken)

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

Public Method ListEventSubscriptions(ListEventSubscriptionsRequest)

Lists all the event subscriptions for the assessment template that is specified by the ARN of the assessment template. For more information, see SubscribeToEvent and UnsubscribeFromEvent.

Public Method ListEventSubscriptionsAsync(ListEventSubscriptionsRequest, CancellationToken)

Lists all the event subscriptions for the assessment template that is specified by the ARN of the assessment template. For more information, see SubscribeToEvent and UnsubscribeFromEvent.

Public Method ListExclusions(ListExclusionsRequest)

List exclusions that are generated by the assessment run.

Public Method ListExclusionsAsync(ListExclusionsRequest, CancellationToken)

List exclusions that are generated by the assessment run.

Public Method ListFindings(ListFindingsRequest)

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

Public Method ListFindingsAsync(ListFindingsRequest, CancellationToken)

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

Public Method ListRulesPackages(ListRulesPackagesRequest)

Lists all available Amazon Inspector rules packages.

Public Method ListRulesPackagesAsync(ListRulesPackagesRequest, CancellationToken)

Lists all available Amazon Inspector rules packages.

Public Method ListTagsForResource(ListTagsForResourceRequest)

Lists all tags associated with an assessment template.

Public Method ListTagsForResourceAsync(ListTagsForResourceRequest, CancellationToken)

Lists all tags associated with an assessment template.

Public Method PreviewAgents(PreviewAgentsRequest)

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

Public Method PreviewAgentsAsync(PreviewAgentsRequest, CancellationToken)

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

Public Method RegisterCrossAccountAccessRole(RegisterCrossAccountAccessRoleRequest)

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

Public Method RegisterCrossAccountAccessRoleAsync(RegisterCrossAccountAccessRoleRequest, CancellationToken)

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

Public Method RemoveAttributesFromFindings(RemoveAttributesFromFindingsRequest)

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.

Public Method RemoveAttributesFromFindingsAsync(RemoveAttributesFromFindingsRequest, CancellationToken)

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.

Public Method SetTagsForResource(SetTagsForResourceRequest)

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

Public Method SetTagsForResourceAsync(SetTagsForResourceRequest, CancellationToken)

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

Public Method StartAssessmentRun(StartAssessmentRunRequest)

Starts the assessment run specified by the ARN of the assessment template. For this API to function properly, you must not exceed the limit of running up to 500 concurrent agents per AWS account.

Public Method StartAssessmentRunAsync(StartAssessmentRunRequest, CancellationToken)

Starts the assessment run specified by the ARN of the assessment template. For this API to function properly, you must not exceed the limit of running up to 500 concurrent agents per AWS account.

Public Method StopAssessmentRun(StopAssessmentRunRequest)

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

Public Method StopAssessmentRunAsync(StopAssessmentRunRequest, CancellationToken)

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

Public Method SubscribeToEvent(SubscribeToEventRequest)

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

Public Method SubscribeToEventAsync(SubscribeToEventRequest, CancellationToken)

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

Public Method UnsubscribeFromEvent(UnsubscribeFromEventRequest)

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

Public Method UnsubscribeFromEventAsync(UnsubscribeFromEventRequest, CancellationToken)

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

Public Method UpdateAssessmentTarget(UpdateAssessmentTargetRequest)

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

If resourceGroupArn is not specified, all EC2 instances in the current AWS account and region are included in the assessment target.

Public Method UpdateAssessmentTargetAsync(UpdateAssessmentTargetRequest, CancellationToken)

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

If resourceGroupArn is not specified, all EC2 instances in the current AWS account and region are included in the assessment target.

Events

NameDescription
Event AfterResponseEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event BeforeRequestEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event ExceptionEvent Inherited from Amazon.Runtime.AmazonServiceClient.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5