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.



    
        
    

             

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.



    
        
    

             

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.



    
        
    

             

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.

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)

Initiates the asynchronous execution of the AddAttributesToFindings operation.

Public Method CreateAssessmentTarget(CreateAssessmentTargetRequest)

Creates a new assessment target using the ARN of the resource group that is generated by CreateResourceGroup. 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)

Initiates the asynchronous execution of the CreateAssessmentTarget operation.

Public Method CreateAssessmentTemplate(CreateAssessmentTemplateRequest)

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

Public Method CreateAssessmentTemplateAsync(CreateAssessmentTemplateRequest, CancellationToken)

Initiates the asynchronous execution of the CreateAssessmentTemplate operation.

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)

Initiates the asynchronous execution of the CreateResourceGroup operation.

Public Method DeleteAssessmentRun(DeleteAssessmentRunRequest)

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

Public Method DeleteAssessmentRunAsync(DeleteAssessmentRunRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteAssessmentRun operation.

Public Method DeleteAssessmentTarget(DeleteAssessmentTargetRequest)

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

Public Method DeleteAssessmentTargetAsync(DeleteAssessmentTargetRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteAssessmentTarget operation.

Public Method DeleteAssessmentTemplate(DeleteAssessmentTemplateRequest)

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

Public Method DeleteAssessmentTemplateAsync(DeleteAssessmentTemplateRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteAssessmentTemplate operation.

Public Method DescribeAssessmentRuns(DescribeAssessmentRunsRequest)

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

Public Method DescribeAssessmentRunsAsync(DescribeAssessmentRunsRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeAssessmentRuns operation.

Public Method DescribeAssessmentTargets(DescribeAssessmentTargetsRequest)

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

Public Method DescribeAssessmentTargetsAsync(DescribeAssessmentTargetsRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeAssessmentTargets operation.

Public Method DescribeAssessmentTemplates(DescribeAssessmentTemplatesRequest)

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

Public Method DescribeAssessmentTemplatesAsync(DescribeAssessmentTemplatesRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeAssessmentTemplates operation.

Public Method DescribeCrossAccountAccessRole(DescribeCrossAccountAccessRoleRequest)

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

Public Method DescribeCrossAccountAccessRoleAsync(DescribeCrossAccountAccessRoleRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeCrossAccountAccessRole operation.

Public Method DescribeFindings(DescribeFindingsRequest)

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

Public Method DescribeFindingsAsync(DescribeFindingsRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeFindings operation.

Public Method DescribeResourceGroups(DescribeResourceGroupsRequest)

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

Public Method DescribeResourceGroupsAsync(DescribeResourceGroupsRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeResourceGroups operation.

Public Method DescribeRulesPackages(DescribeRulesPackagesRequest)

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

Public Method DescribeRulesPackagesAsync(DescribeRulesPackagesRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeRulesPackages operation.

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)

Initiates the asynchronous execution of the GetAssessmentReport operation.

Public Method GetTelemetryMetadata(GetTelemetryMetadataRequest)

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

Public Method GetTelemetryMetadataAsync(GetTelemetryMetadataRequest, CancellationToken)

Initiates the asynchronous execution of the GetTelemetryMetadata operation.

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)

Initiates the asynchronous execution of the ListAssessmentRunAgents operation.

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)

Initiates the asynchronous execution of the ListAssessmentRuns operation.

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)

Initiates the asynchronous execution of the ListAssessmentTargets operation.

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)

Initiates the asynchronous execution of the ListAssessmentTemplates operation.

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)

Initiates the asynchronous execution of the ListEventSubscriptions operation.

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)

Initiates the asynchronous execution of the ListFindings operation.

Public Method ListRulesPackages(ListRulesPackagesRequest)

Lists all available Amazon Inspector rules packages.

Public Method ListRulesPackagesAsync(ListRulesPackagesRequest, CancellationToken)

Initiates the asynchronous execution of the ListRulesPackages operation.

Public Method ListTagsForResource(ListTagsForResourceRequest)

Lists all tags associated with an assessment template.

Public Method ListTagsForResourceAsync(ListTagsForResourceRequest, CancellationToken)

Initiates the asynchronous execution of the ListTagsForResource operation.

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)

Initiates the asynchronous execution of the PreviewAgents operation.

Public Method RegisterCrossAccountAccessRole(RegisterCrossAccountAccessRoleRequest)

Registers the IAM role that Amazon Inspector uses to list your EC2 instances at the start of the assessment run or when you call the PreviewAgents action.

Public Method RegisterCrossAccountAccessRoleAsync(RegisterCrossAccountAccessRoleRequest, CancellationToken)

Initiates the asynchronous execution of the RegisterCrossAccountAccessRole operation.

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)

Initiates the asynchronous execution of the RemoveAttributesFromFindings operation.

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)

Initiates the asynchronous execution of the SetTagsForResource operation.

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)

Initiates the asynchronous execution of the StartAssessmentRun operation.

Public Method StopAssessmentRun(StopAssessmentRunRequest)

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

Public Method StopAssessmentRunAsync(StopAssessmentRunRequest, CancellationToken)

Initiates the asynchronous execution of the StopAssessmentRun operation.

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)

Initiates the asynchronous execution of the SubscribeToEvent operation.

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)

Initiates the asynchronous execution of the UnsubscribeFromEvent operation.

Public Method UpdateAssessmentTarget(UpdateAssessmentTargetRequest)

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

Public Method UpdateAssessmentTargetAsync(UpdateAssessmentTargetRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateAssessmentTarget operation.

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 Standard:
Supported in: 1.3

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

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms