Inspector
public struct Inspector
Client object for interacting with AWS Inspector service.
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.
-
Undocumented
Declaration
Swift
public let client: AWSClient
-
Initialize the Inspector client
Declaration
Swift
public init(accessKeyId: String? = nil, secretAccessKey: String? = nil, sessionToken: String? = nil, region: AWSSDKSwiftCore.Region? = nil, endpoint: String? = nil, middlewares: [AWSServiceMiddleware] = [], eventLoopGroupProvider: AWSClient.EventLoopGroupProvider = .useAWSClientShared)
Parameters
accessKeyId
Public access key provided by AWS
secretAccessKey
Private access key provided by AWS
sessionToken
Token provided by STS.AssumeRole() which allows access to another AWS account
region
Region of server you want to communicate with
endpoint
Custom endpoint URL to use instead of standard AWS servers
middlewares
Array of middlewares to apply to requests and responses
eventLoopGroupProvider
EventLoopGroup to use. Use
useAWSClientShared
if the client shall manage its own EventLoopGroup.
-
Assigns attributes (key and value pairs) to the findings that are specified by the ARNs of the findings.
Declaration
Swift
public func addAttributesToFindings(_ input: AddAttributesToFindingsRequest) -> EventLoopFuture<AddAttributesToFindingsResponse>
-
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.
Declaration
Swift
public func createAssessmentTarget(_ input: CreateAssessmentTargetRequest) -> EventLoopFuture<CreateAssessmentTargetResponse>
-
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.
Declaration
Swift
public func createAssessmentTemplate(_ input: CreateAssessmentTemplateRequest) -> EventLoopFuture<CreateAssessmentTemplateResponse>
-
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.
Declaration
Swift
public func createExclusionsPreview(_ input: CreateExclusionsPreviewRequest) -> EventLoopFuture<CreateExclusionsPreviewResponse>
-
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.
Declaration
Swift
public func createResourceGroup(_ input: CreateResourceGroupRequest) -> EventLoopFuture<CreateResourceGroupResponse>
-
Deletes the assessment run that is specified by the ARN of the assessment run.
Declaration
Swift
@discardableResult public func deleteAssessmentRun(_ input: DeleteAssessmentRunRequest) -> EventLoopFuture<Void>
-
Deletes the assessment target that is specified by the ARN of the assessment target.
Declaration
Swift
@discardableResult public func deleteAssessmentTarget(_ input: DeleteAssessmentTargetRequest) -> EventLoopFuture<Void>
-
Deletes the assessment template that is specified by the ARN of the assessment template.
Declaration
Swift
@discardableResult public func deleteAssessmentTemplate(_ input: DeleteAssessmentTemplateRequest) -> EventLoopFuture<Void>
-
Describes the assessment runs that are specified by the ARNs of the assessment runs.
Declaration
Swift
public func describeAssessmentRuns(_ input: DescribeAssessmentRunsRequest) -> EventLoopFuture<DescribeAssessmentRunsResponse>
-
Describes the assessment targets that are specified by the ARNs of the assessment targets.
Declaration
Swift
public func describeAssessmentTargets(_ input: DescribeAssessmentTargetsRequest) -> EventLoopFuture<DescribeAssessmentTargetsResponse>
-
Describes the assessment templates that are specified by the ARNs of the assessment templates.
Declaration
Swift
public func describeAssessmentTemplates(_ input: DescribeAssessmentTemplatesRequest) -> EventLoopFuture<DescribeAssessmentTemplatesResponse>
-
Describes the IAM role that enables Amazon Inspector to access your AWS account.
Declaration
Swift
public func describeCrossAccountAccessRole() -> EventLoopFuture<DescribeCrossAccountAccessRoleResponse>
-
Describes the exclusions that are specified by the exclusions’ ARNs.
Declaration
Swift
public func describeExclusions(_ input: DescribeExclusionsRequest) -> EventLoopFuture<DescribeExclusionsResponse>
-
Describes the findings that are specified by the ARNs of the findings.
Declaration
Swift
public func describeFindings(_ input: DescribeFindingsRequest) -> EventLoopFuture<DescribeFindingsResponse>
-
Describes the resource groups that are specified by the ARNs of the resource groups.
Declaration
Swift
public func describeResourceGroups(_ input: DescribeResourceGroupsRequest) -> EventLoopFuture<DescribeResourceGroupsResponse>
-
Describes the rules packages that are specified by the ARNs of the rules packages.
Declaration
Swift
public func describeRulesPackages(_ input: DescribeRulesPackagesRequest) -> EventLoopFuture<DescribeRulesPackagesResponse>
-
Produces an assessment report that includes detailed and comprehensive results of a specified assessment run.
Declaration
Swift
public func getAssessmentReport(_ input: GetAssessmentReportRequest) -> EventLoopFuture<GetAssessmentReportResponse>
-
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.
Declaration
Swift
public func getExclusionsPreview(_ input: GetExclusionsPreviewRequest) -> EventLoopFuture<GetExclusionsPreviewResponse>
-
Information about the data that is collected for the specified assessment run.
Declaration
Swift
public func getTelemetryMetadata(_ input: GetTelemetryMetadataRequest) -> EventLoopFuture<GetTelemetryMetadataResponse>
-
Lists the agents of the assessment runs that are specified by the ARNs of the assessment runs.
Declaration
Swift
public func listAssessmentRunAgents(_ input: ListAssessmentRunAgentsRequest) -> EventLoopFuture<ListAssessmentRunAgentsResponse>
-
Lists the assessment runs that correspond to the assessment templates that are specified by the ARNs of the assessment templates.
Declaration
Swift
public func listAssessmentRuns(_ input: ListAssessmentRunsRequest) -> EventLoopFuture<ListAssessmentRunsResponse>
-
Lists the ARNs of the assessment targets within this AWS account. For more information about assessment targets, see Amazon Inspector Assessment Targets.
Declaration
Swift
public func listAssessmentTargets(_ input: ListAssessmentTargetsRequest) -> EventLoopFuture<ListAssessmentTargetsResponse>
-
Lists the assessment templates that correspond to the assessment targets that are specified by the ARNs of the assessment targets.
Declaration
Swift
public func listAssessmentTemplates(_ input: ListAssessmentTemplatesRequest) -> EventLoopFuture<ListAssessmentTemplatesResponse>
-
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.
Declaration
Swift
public func listEventSubscriptions(_ input: ListEventSubscriptionsRequest) -> EventLoopFuture<ListEventSubscriptionsResponse>
-
List exclusions that are generated by the assessment run.
Declaration
Swift
public func listExclusions(_ input: ListExclusionsRequest) -> EventLoopFuture<ListExclusionsResponse>
-
Lists findings that are generated by the assessment runs that are specified by the ARNs of the assessment runs.
Declaration
Swift
public func listFindings(_ input: ListFindingsRequest) -> EventLoopFuture<ListFindingsResponse>
-
Lists all available Amazon Inspector rules packages.
Declaration
Swift
public func listRulesPackages(_ input: ListRulesPackagesRequest) -> EventLoopFuture<ListRulesPackagesResponse>
-
Lists all tags associated with an assessment template.
Declaration
Swift
public func listTagsForResource(_ input: ListTagsForResourceRequest) -> EventLoopFuture<ListTagsForResourceResponse>
-
Previews the agents installed on the EC2 instances that are part of the specified assessment target.
Declaration
Swift
public func previewAgents(_ input: PreviewAgentsRequest) -> EventLoopFuture<PreviewAgentsResponse>
-
Registers the IAM role that grants Amazon Inspector access to AWS Services needed to perform security assessments.
Declaration
Swift
@discardableResult public func registerCrossAccountAccessRole(_ input: RegisterCrossAccountAccessRoleRequest) -> EventLoopFuture<Void>
-
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.
Declaration
Swift
public func removeAttributesFromFindings(_ input: RemoveAttributesFromFindingsRequest) -> EventLoopFuture<RemoveAttributesFromFindingsResponse>
-
Sets tags (key and value pairs) to the assessment template that is specified by the ARN of the assessment template.
Declaration
Swift
@discardableResult public func setTagsForResource(_ input: SetTagsForResourceRequest) -> EventLoopFuture<Void>
-
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.
Declaration
Swift
public func startAssessmentRun(_ input: StartAssessmentRunRequest) -> EventLoopFuture<StartAssessmentRunResponse>
-
Stops the assessment run that is specified by the ARN of the assessment run.
Declaration
Swift
@discardableResult public func stopAssessmentRun(_ input: StopAssessmentRunRequest) -> EventLoopFuture<Void>
-
Enables the process of sending Amazon Simple Notification Service (SNS) notifications about a specified event to a specified SNS topic.
Declaration
Swift
@discardableResult public func subscribeToEvent(_ input: SubscribeToEventRequest) -> EventLoopFuture<Void>
-
Disables the process of sending Amazon Simple Notification Service (SNS) notifications about a specified event to a specified SNS topic.
Declaration
Swift
@discardableResult public func unsubscribeFromEvent(_ input: UnsubscribeFromEventRequest) -> EventLoopFuture<Void>
-
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.
Declaration
Swift
@discardableResult public func updateAssessmentTarget(_ input: UpdateAssessmentTargetRequest) -> EventLoopFuture<Void>
-
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.
Declaration
Swift
public func getExclusionsPreviewPaginator(_ input: GetExclusionsPreviewRequest, onPage: @escaping (GetExclusionsPreviewResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Lists the agents of the assessment runs that are specified by the ARNs of the assessment runs.
Declaration
Swift
public func listAssessmentRunAgentsPaginator(_ input: ListAssessmentRunAgentsRequest, onPage: @escaping (ListAssessmentRunAgentsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Lists the assessment runs that correspond to the assessment templates that are specified by the ARNs of the assessment templates.
Declaration
Swift
public func listAssessmentRunsPaginator(_ input: ListAssessmentRunsRequest, onPage: @escaping (ListAssessmentRunsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Lists the ARNs of the assessment targets within this AWS account. For more information about assessment targets, see Amazon Inspector Assessment Targets.
Declaration
Swift
public func listAssessmentTargetsPaginator(_ input: ListAssessmentTargetsRequest, onPage: @escaping (ListAssessmentTargetsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Lists the assessment templates that correspond to the assessment targets that are specified by the ARNs of the assessment targets.
Declaration
Swift
public func listAssessmentTemplatesPaginator(_ input: ListAssessmentTemplatesRequest, onPage: @escaping (ListAssessmentTemplatesResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
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.
Declaration
Swift
public func listEventSubscriptionsPaginator(_ input: ListEventSubscriptionsRequest, onPage: @escaping (ListEventSubscriptionsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
List exclusions that are generated by the assessment run.
Declaration
Swift
public func listExclusionsPaginator(_ input: ListExclusionsRequest, onPage: @escaping (ListExclusionsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Lists findings that are generated by the assessment runs that are specified by the ARNs of the assessment runs.
Declaration
Swift
public func listFindingsPaginator(_ input: ListFindingsRequest, onPage: @escaping (ListFindingsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Lists all available Amazon Inspector rules packages.
Declaration
Swift
public func listRulesPackagesPaginator(_ input: ListRulesPackagesRequest, onPage: @escaping (ListRulesPackagesResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Previews the agents installed on the EC2 instances that are part of the specified assessment target.
Declaration
Swift
public func previewAgentsPaginator(_ input: PreviewAgentsRequest, onPage: @escaping (PreviewAgentsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Undocumented
See moreDeclaration
Swift
public struct GetExclusionsPreviewRequest : AWSShape
extension Inspector.GetExclusionsPreviewRequest: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public struct ListAssessmentRunAgentsRequest : AWSShape
extension Inspector.ListAssessmentRunAgentsRequest: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public struct ListAssessmentRunsRequest : AWSShape
extension Inspector.ListAssessmentRunsRequest: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public struct ListAssessmentTargetsRequest : AWSShape
extension Inspector.ListAssessmentTargetsRequest: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public struct ListAssessmentTemplatesRequest : AWSShape
extension Inspector.ListAssessmentTemplatesRequest: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public struct ListEventSubscriptionsRequest : AWSShape
extension Inspector.ListEventSubscriptionsRequest: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public struct ListExclusionsRequest : AWSShape
extension Inspector.ListExclusionsRequest: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public struct ListFindingsRequest : AWSShape
extension Inspector.ListFindingsRequest: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public struct ListRulesPackagesRequest : AWSShape
extension Inspector.ListRulesPackagesRequest: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public struct PreviewAgentsRequest : AWSShape
extension Inspector.PreviewAgentsRequest: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public enum AgentHealth : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum AgentHealthCode : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum AssessmentRunNotificationSnsStatusCode : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum AssessmentRunState : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum AssetType : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum FailedItemErrorCode : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum InspectorEvent : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum Locale : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum PreviewStatus : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum ReportFileFormat : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum ReportStatus : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum ReportType : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum ScopeType : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum Severity : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum StopAction : String, CustomStringConvertible, Codable