inspector.d.ts (67850B)
1 import {Request} from '../lib/request'; 2 import {Response} from '../lib/response'; 3 import {AWSError} from '../lib/error'; 4 import {Service} from '../lib/service'; 5 import {ServiceConfigurationOptions} from '../lib/service'; 6 import {ConfigBase as Config} from '../lib/config'; 7 interface Blob {} 8 declare class Inspector extends Service { 9 /** 10 * Constructs a service object. This object has one method for each API operation. 11 */ 12 constructor(options?: Inspector.Types.ClientConfiguration) 13 config: Config & Inspector.Types.ClientConfiguration; 14 /** 15 * Assigns attributes (key and value pairs) to the findings that are specified by the ARNs of the findings. 16 */ 17 addAttributesToFindings(params: Inspector.Types.AddAttributesToFindingsRequest, callback?: (err: AWSError, data: Inspector.Types.AddAttributesToFindingsResponse) => void): Request<Inspector.Types.AddAttributesToFindingsResponse, AWSError>; 18 /** 19 * Assigns attributes (key and value pairs) to the findings that are specified by the ARNs of the findings. 20 */ 21 addAttributesToFindings(callback?: (err: AWSError, data: Inspector.Types.AddAttributesToFindingsResponse) => void): Request<Inspector.Types.AddAttributesToFindingsResponse, AWSError>; 22 /** 23 * 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. 24 */ 25 createAssessmentTarget(params: Inspector.Types.CreateAssessmentTargetRequest, callback?: (err: AWSError, data: Inspector.Types.CreateAssessmentTargetResponse) => void): Request<Inspector.Types.CreateAssessmentTargetResponse, AWSError>; 26 /** 27 * 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. 28 */ 29 createAssessmentTarget(callback?: (err: AWSError, data: Inspector.Types.CreateAssessmentTargetResponse) => void): Request<Inspector.Types.CreateAssessmentTargetResponse, AWSError>; 30 /** 31 * Creates an assessment template for the assessment target that is specified by the ARN of the assessment target. 32 */ 33 createAssessmentTemplate(params: Inspector.Types.CreateAssessmentTemplateRequest, callback?: (err: AWSError, data: Inspector.Types.CreateAssessmentTemplateResponse) => void): Request<Inspector.Types.CreateAssessmentTemplateResponse, AWSError>; 34 /** 35 * Creates an assessment template for the assessment target that is specified by the ARN of the assessment target. 36 */ 37 createAssessmentTemplate(callback?: (err: AWSError, data: Inspector.Types.CreateAssessmentTemplateResponse) => void): Request<Inspector.Types.CreateAssessmentTemplateResponse, AWSError>; 38 /** 39 * 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. 40 */ 41 createResourceGroup(params: Inspector.Types.CreateResourceGroupRequest, callback?: (err: AWSError, data: Inspector.Types.CreateResourceGroupResponse) => void): Request<Inspector.Types.CreateResourceGroupResponse, AWSError>; 42 /** 43 * 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. 44 */ 45 createResourceGroup(callback?: (err: AWSError, data: Inspector.Types.CreateResourceGroupResponse) => void): Request<Inspector.Types.CreateResourceGroupResponse, AWSError>; 46 /** 47 * Deletes the assessment run that is specified by the ARN of the assessment run. 48 */ 49 deleteAssessmentRun(params: Inspector.Types.DeleteAssessmentRunRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 50 /** 51 * Deletes the assessment run that is specified by the ARN of the assessment run. 52 */ 53 deleteAssessmentRun(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 54 /** 55 * Deletes the assessment target that is specified by the ARN of the assessment target. 56 */ 57 deleteAssessmentTarget(params: Inspector.Types.DeleteAssessmentTargetRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 58 /** 59 * Deletes the assessment target that is specified by the ARN of the assessment target. 60 */ 61 deleteAssessmentTarget(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 62 /** 63 * Deletes the assessment template that is specified by the ARN of the assessment template. 64 */ 65 deleteAssessmentTemplate(params: Inspector.Types.DeleteAssessmentTemplateRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 66 /** 67 * Deletes the assessment template that is specified by the ARN of the assessment template. 68 */ 69 deleteAssessmentTemplate(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 70 /** 71 * Describes the assessment runs that are specified by the ARNs of the assessment runs. 72 */ 73 describeAssessmentRuns(params: Inspector.Types.DescribeAssessmentRunsRequest, callback?: (err: AWSError, data: Inspector.Types.DescribeAssessmentRunsResponse) => void): Request<Inspector.Types.DescribeAssessmentRunsResponse, AWSError>; 74 /** 75 * Describes the assessment runs that are specified by the ARNs of the assessment runs. 76 */ 77 describeAssessmentRuns(callback?: (err: AWSError, data: Inspector.Types.DescribeAssessmentRunsResponse) => void): Request<Inspector.Types.DescribeAssessmentRunsResponse, AWSError>; 78 /** 79 * Describes the assessment targets that are specified by the ARNs of the assessment targets. 80 */ 81 describeAssessmentTargets(params: Inspector.Types.DescribeAssessmentTargetsRequest, callback?: (err: AWSError, data: Inspector.Types.DescribeAssessmentTargetsResponse) => void): Request<Inspector.Types.DescribeAssessmentTargetsResponse, AWSError>; 82 /** 83 * Describes the assessment targets that are specified by the ARNs of the assessment targets. 84 */ 85 describeAssessmentTargets(callback?: (err: AWSError, data: Inspector.Types.DescribeAssessmentTargetsResponse) => void): Request<Inspector.Types.DescribeAssessmentTargetsResponse, AWSError>; 86 /** 87 * Describes the assessment templates that are specified by the ARNs of the assessment templates. 88 */ 89 describeAssessmentTemplates(params: Inspector.Types.DescribeAssessmentTemplatesRequest, callback?: (err: AWSError, data: Inspector.Types.DescribeAssessmentTemplatesResponse) => void): Request<Inspector.Types.DescribeAssessmentTemplatesResponse, AWSError>; 90 /** 91 * Describes the assessment templates that are specified by the ARNs of the assessment templates. 92 */ 93 describeAssessmentTemplates(callback?: (err: AWSError, data: Inspector.Types.DescribeAssessmentTemplatesResponse) => void): Request<Inspector.Types.DescribeAssessmentTemplatesResponse, AWSError>; 94 /** 95 * Describes the IAM role that enables Amazon Inspector to access your AWS account. 96 */ 97 describeCrossAccountAccessRole(callback?: (err: AWSError, data: Inspector.Types.DescribeCrossAccountAccessRoleResponse) => void): Request<Inspector.Types.DescribeCrossAccountAccessRoleResponse, AWSError>; 98 /** 99 * Describes the findings that are specified by the ARNs of the findings. 100 */ 101 describeFindings(params: Inspector.Types.DescribeFindingsRequest, callback?: (err: AWSError, data: Inspector.Types.DescribeFindingsResponse) => void): Request<Inspector.Types.DescribeFindingsResponse, AWSError>; 102 /** 103 * Describes the findings that are specified by the ARNs of the findings. 104 */ 105 describeFindings(callback?: (err: AWSError, data: Inspector.Types.DescribeFindingsResponse) => void): Request<Inspector.Types.DescribeFindingsResponse, AWSError>; 106 /** 107 * Describes the resource groups that are specified by the ARNs of the resource groups. 108 */ 109 describeResourceGroups(params: Inspector.Types.DescribeResourceGroupsRequest, callback?: (err: AWSError, data: Inspector.Types.DescribeResourceGroupsResponse) => void): Request<Inspector.Types.DescribeResourceGroupsResponse, AWSError>; 110 /** 111 * Describes the resource groups that are specified by the ARNs of the resource groups. 112 */ 113 describeResourceGroups(callback?: (err: AWSError, data: Inspector.Types.DescribeResourceGroupsResponse) => void): Request<Inspector.Types.DescribeResourceGroupsResponse, AWSError>; 114 /** 115 * Describes the rules packages that are specified by the ARNs of the rules packages. 116 */ 117 describeRulesPackages(params: Inspector.Types.DescribeRulesPackagesRequest, callback?: (err: AWSError, data: Inspector.Types.DescribeRulesPackagesResponse) => void): Request<Inspector.Types.DescribeRulesPackagesResponse, AWSError>; 118 /** 119 * Describes the rules packages that are specified by the ARNs of the rules packages. 120 */ 121 describeRulesPackages(callback?: (err: AWSError, data: Inspector.Types.DescribeRulesPackagesResponse) => void): Request<Inspector.Types.DescribeRulesPackagesResponse, AWSError>; 122 /** 123 * Information about the data that is collected for the specified assessment run. 124 */ 125 getTelemetryMetadata(params: Inspector.Types.GetTelemetryMetadataRequest, callback?: (err: AWSError, data: Inspector.Types.GetTelemetryMetadataResponse) => void): Request<Inspector.Types.GetTelemetryMetadataResponse, AWSError>; 126 /** 127 * Information about the data that is collected for the specified assessment run. 128 */ 129 getTelemetryMetadata(callback?: (err: AWSError, data: Inspector.Types.GetTelemetryMetadataResponse) => void): Request<Inspector.Types.GetTelemetryMetadataResponse, AWSError>; 130 /** 131 * Lists the agents of the assessment runs that are specified by the ARNs of the assessment runs. 132 */ 133 listAssessmentRunAgents(params: Inspector.Types.ListAssessmentRunAgentsRequest, callback?: (err: AWSError, data: Inspector.Types.ListAssessmentRunAgentsResponse) => void): Request<Inspector.Types.ListAssessmentRunAgentsResponse, AWSError>; 134 /** 135 * Lists the agents of the assessment runs that are specified by the ARNs of the assessment runs. 136 */ 137 listAssessmentRunAgents(callback?: (err: AWSError, data: Inspector.Types.ListAssessmentRunAgentsResponse) => void): Request<Inspector.Types.ListAssessmentRunAgentsResponse, AWSError>; 138 /** 139 * Lists the assessment runs that correspond to the assessment templates that are specified by the ARNs of the assessment templates. 140 */ 141 listAssessmentRuns(params: Inspector.Types.ListAssessmentRunsRequest, callback?: (err: AWSError, data: Inspector.Types.ListAssessmentRunsResponse) => void): Request<Inspector.Types.ListAssessmentRunsResponse, AWSError>; 142 /** 143 * Lists the assessment runs that correspond to the assessment templates that are specified by the ARNs of the assessment templates. 144 */ 145 listAssessmentRuns(callback?: (err: AWSError, data: Inspector.Types.ListAssessmentRunsResponse) => void): Request<Inspector.Types.ListAssessmentRunsResponse, AWSError>; 146 /** 147 * Lists the ARNs of the assessment targets within this AWS account. For more information about assessment targets, see Amazon Inspector Assessment Targets. 148 */ 149 listAssessmentTargets(params: Inspector.Types.ListAssessmentTargetsRequest, callback?: (err: AWSError, data: Inspector.Types.ListAssessmentTargetsResponse) => void): Request<Inspector.Types.ListAssessmentTargetsResponse, AWSError>; 150 /** 151 * Lists the ARNs of the assessment targets within this AWS account. For more information about assessment targets, see Amazon Inspector Assessment Targets. 152 */ 153 listAssessmentTargets(callback?: (err: AWSError, data: Inspector.Types.ListAssessmentTargetsResponse) => void): Request<Inspector.Types.ListAssessmentTargetsResponse, AWSError>; 154 /** 155 * Lists the assessment templates that correspond to the assessment targets that are specified by the ARNs of the assessment targets. 156 */ 157 listAssessmentTemplates(params: Inspector.Types.ListAssessmentTemplatesRequest, callback?: (err: AWSError, data: Inspector.Types.ListAssessmentTemplatesResponse) => void): Request<Inspector.Types.ListAssessmentTemplatesResponse, AWSError>; 158 /** 159 * Lists the assessment templates that correspond to the assessment targets that are specified by the ARNs of the assessment targets. 160 */ 161 listAssessmentTemplates(callback?: (err: AWSError, data: Inspector.Types.ListAssessmentTemplatesResponse) => void): Request<Inspector.Types.ListAssessmentTemplatesResponse, AWSError>; 162 /** 163 * 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. 164 */ 165 listEventSubscriptions(params: Inspector.Types.ListEventSubscriptionsRequest, callback?: (err: AWSError, data: Inspector.Types.ListEventSubscriptionsResponse) => void): Request<Inspector.Types.ListEventSubscriptionsResponse, AWSError>; 166 /** 167 * 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. 168 */ 169 listEventSubscriptions(callback?: (err: AWSError, data: Inspector.Types.ListEventSubscriptionsResponse) => void): Request<Inspector.Types.ListEventSubscriptionsResponse, AWSError>; 170 /** 171 * Lists findings that are generated by the assessment runs that are specified by the ARNs of the assessment runs. 172 */ 173 listFindings(params: Inspector.Types.ListFindingsRequest, callback?: (err: AWSError, data: Inspector.Types.ListFindingsResponse) => void): Request<Inspector.Types.ListFindingsResponse, AWSError>; 174 /** 175 * Lists findings that are generated by the assessment runs that are specified by the ARNs of the assessment runs. 176 */ 177 listFindings(callback?: (err: AWSError, data: Inspector.Types.ListFindingsResponse) => void): Request<Inspector.Types.ListFindingsResponse, AWSError>; 178 /** 179 * Lists all available Amazon Inspector rules packages. 180 */ 181 listRulesPackages(params: Inspector.Types.ListRulesPackagesRequest, callback?: (err: AWSError, data: Inspector.Types.ListRulesPackagesResponse) => void): Request<Inspector.Types.ListRulesPackagesResponse, AWSError>; 182 /** 183 * Lists all available Amazon Inspector rules packages. 184 */ 185 listRulesPackages(callback?: (err: AWSError, data: Inspector.Types.ListRulesPackagesResponse) => void): Request<Inspector.Types.ListRulesPackagesResponse, AWSError>; 186 /** 187 * Lists all tags associated with an assessment template. 188 */ 189 listTagsForResource(params: Inspector.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: Inspector.Types.ListTagsForResourceResponse) => void): Request<Inspector.Types.ListTagsForResourceResponse, AWSError>; 190 /** 191 * Lists all tags associated with an assessment template. 192 */ 193 listTagsForResource(callback?: (err: AWSError, data: Inspector.Types.ListTagsForResourceResponse) => void): Request<Inspector.Types.ListTagsForResourceResponse, AWSError>; 194 /** 195 * Previews the agents installed on the EC2 instances that are part of the specified assessment target. 196 */ 197 previewAgents(params: Inspector.Types.PreviewAgentsRequest, callback?: (err: AWSError, data: Inspector.Types.PreviewAgentsResponse) => void): Request<Inspector.Types.PreviewAgentsResponse, AWSError>; 198 /** 199 * Previews the agents installed on the EC2 instances that are part of the specified assessment target. 200 */ 201 previewAgents(callback?: (err: AWSError, data: Inspector.Types.PreviewAgentsResponse) => void): Request<Inspector.Types.PreviewAgentsResponse, AWSError>; 202 /** 203 * 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. 204 */ 205 registerCrossAccountAccessRole(params: Inspector.Types.RegisterCrossAccountAccessRoleRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 206 /** 207 * 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. 208 */ 209 registerCrossAccountAccessRole(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 210 /** 211 * 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. 212 */ 213 removeAttributesFromFindings(params: Inspector.Types.RemoveAttributesFromFindingsRequest, callback?: (err: AWSError, data: Inspector.Types.RemoveAttributesFromFindingsResponse) => void): Request<Inspector.Types.RemoveAttributesFromFindingsResponse, AWSError>; 214 /** 215 * 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. 216 */ 217 removeAttributesFromFindings(callback?: (err: AWSError, data: Inspector.Types.RemoveAttributesFromFindingsResponse) => void): Request<Inspector.Types.RemoveAttributesFromFindingsResponse, AWSError>; 218 /** 219 * Sets tags (key and value pairs) to the assessment template that is specified by the ARN of the assessment template. 220 */ 221 setTagsForResource(params: Inspector.Types.SetTagsForResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 222 /** 223 * Sets tags (key and value pairs) to the assessment template that is specified by the ARN of the assessment template. 224 */ 225 setTagsForResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 226 /** 227 * 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. 228 */ 229 startAssessmentRun(params: Inspector.Types.StartAssessmentRunRequest, callback?: (err: AWSError, data: Inspector.Types.StartAssessmentRunResponse) => void): Request<Inspector.Types.StartAssessmentRunResponse, AWSError>; 230 /** 231 * 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. 232 */ 233 startAssessmentRun(callback?: (err: AWSError, data: Inspector.Types.StartAssessmentRunResponse) => void): Request<Inspector.Types.StartAssessmentRunResponse, AWSError>; 234 /** 235 * Stops the assessment run that is specified by the ARN of the assessment run. 236 */ 237 stopAssessmentRun(params: Inspector.Types.StopAssessmentRunRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 238 /** 239 * Stops the assessment run that is specified by the ARN of the assessment run. 240 */ 241 stopAssessmentRun(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 242 /** 243 * Enables the process of sending Amazon Simple Notification Service (SNS) notifications about a specified event to a specified SNS topic. 244 */ 245 subscribeToEvent(params: Inspector.Types.SubscribeToEventRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 246 /** 247 * Enables the process of sending Amazon Simple Notification Service (SNS) notifications about a specified event to a specified SNS topic. 248 */ 249 subscribeToEvent(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 250 /** 251 * Disables the process of sending Amazon Simple Notification Service (SNS) notifications about a specified event to a specified SNS topic. 252 */ 253 unsubscribeFromEvent(params: Inspector.Types.UnsubscribeFromEventRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 254 /** 255 * Disables the process of sending Amazon Simple Notification Service (SNS) notifications about a specified event to a specified SNS topic. 256 */ 257 unsubscribeFromEvent(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 258 /** 259 * Updates the assessment target that is specified by the ARN of the assessment target. 260 */ 261 updateAssessmentTarget(params: Inspector.Types.UpdateAssessmentTargetRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 262 /** 263 * Updates the assessment target that is specified by the ARN of the assessment target. 264 */ 265 updateAssessmentTarget(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 266 } 267 declare namespace Inspector.Types { 268 export type AccessDeniedErrorCode = "ACCESS_DENIED_TO_ASSESSMENT_TARGET"|"ACCESS_DENIED_TO_ASSESSMENT_TEMPLATE"|"ACCESS_DENIED_TO_ASSESSMENT_RUN"|"ACCESS_DENIED_TO_FINDING"|"ACCESS_DENIED_TO_RESOURCE_GROUP"|"ACCESS_DENIED_TO_RULES_PACKAGE"|"ACCESS_DENIED_TO_SNS_TOPIC"|"ACCESS_DENIED_TO_IAM_ROLE"|string; 269 export interface AddAttributesToFindingsRequest { 270 /** 271 * The ARNs that specify the findings that you want to assign attributes to. 272 */ 273 findingArns: AddRemoveAttributesFindingArnList; 274 /** 275 * The array of attributes that you want to assign to specified findings. 276 */ 277 attributes: UserAttributeList; 278 } 279 export interface AddAttributesToFindingsResponse { 280 /** 281 * Attribute details that cannot be described. An error code is provided for each failed item. 282 */ 283 failedItems: FailedItems; 284 } 285 export type AddRemoveAttributesFindingArnList = Arn[]; 286 export interface AgentAlreadyRunningAssessment { 287 /** 288 * ID of the agent that is running on an EC2 instance that is already participating in another started assessment run. 289 */ 290 agentId: AgentId; 291 /** 292 * The ARN of the assessment run that has already been started. 293 */ 294 assessmentRunArn: Arn; 295 } 296 export type AgentAlreadyRunningAssessmentList = AgentAlreadyRunningAssessment[]; 297 export interface AgentFilter { 298 /** 299 * The current health state of the agent. Values can be set to HEALTHY or UNHEALTHY. 300 */ 301 agentHealths: AgentHealthList; 302 /** 303 * The detailed health state of the agent. Values can be set to IDLE, RUNNING, SHUTDOWN, UNHEALTHY, THROTTLED, and UNKNOWN. 304 */ 305 agentHealthCodes: AgentHealthCodeList; 306 } 307 export type AgentHealth = "HEALTHY"|"UNHEALTHY"|string; 308 export type AgentHealthCode = "IDLE"|"RUNNING"|"SHUTDOWN"|"UNHEALTHY"|"THROTTLED"|"UNKNOWN"|string; 309 export type AgentHealthCodeList = AgentHealthCode[]; 310 export type AgentHealthList = AgentHealth[]; 311 export type AgentId = string; 312 export type AgentIdList = AgentId[]; 313 export interface AgentPreview { 314 /** 315 * The ID of the EC2 instance where the agent is installed. 316 */ 317 agentId: AgentId; 318 /** 319 * The Auto Scaling group for the EC2 instance where the agent is installed. 320 */ 321 autoScalingGroup?: AutoScalingGroup; 322 } 323 export type AgentPreviewList = AgentPreview[]; 324 export type AmiId = string; 325 export type Arn = string; 326 export type AssessmentRulesPackageArnList = Arn[]; 327 export interface AssessmentRun { 328 /** 329 * The ARN of the assessment run. 330 */ 331 arn: Arn; 332 /** 333 * The auto-generated name for the assessment run. 334 */ 335 name: AssessmentRunName; 336 /** 337 * The ARN of the assessment template that is associated with the assessment run. 338 */ 339 assessmentTemplateArn: Arn; 340 /** 341 * The state of the assessment run. 342 */ 343 state: AssessmentRunState; 344 /** 345 * The duration of the assessment run. 346 */ 347 durationInSeconds: AssessmentRunDuration; 348 /** 349 * The rules packages selected for the assessment run. 350 */ 351 rulesPackageArns: AssessmentRulesPackageArnList; 352 /** 353 * The user-defined attributes that are assigned to every generated finding. 354 */ 355 userAttributesForFindings: UserAttributeList; 356 /** 357 * The time when StartAssessmentRun was called. 358 */ 359 createdAt: Timestamp; 360 /** 361 * The time when StartAssessmentRun was called. 362 */ 363 startedAt?: Timestamp; 364 /** 365 * The assessment run completion time that corresponds to the rules packages evaluation completion time or failure. 366 */ 367 completedAt?: Timestamp; 368 /** 369 * The last time when the assessment run's state changed. 370 */ 371 stateChangedAt: Timestamp; 372 /** 373 * A Boolean value (true or false) that specifies whether the process of collecting data from the agents is completed. 374 */ 375 dataCollected: Bool; 376 /** 377 * A list of the assessment run state changes. 378 */ 379 stateChanges: AssessmentRunStateChangeList; 380 /** 381 * A list of notifications for the event subscriptions. A notification about a particular generated finding is added to this list only once. 382 */ 383 notifications: AssessmentRunNotificationList; 384 } 385 export interface AssessmentRunAgent { 386 /** 387 * The AWS account of the EC2 instance where the agent is installed. 388 */ 389 agentId: AgentId; 390 /** 391 * The ARN of the assessment run that is associated with the agent. 392 */ 393 assessmentRunArn: Arn; 394 /** 395 * The current health state of the agent. 396 */ 397 agentHealth: AgentHealth; 398 /** 399 * The detailed health state of the agent. 400 */ 401 agentHealthCode: AgentHealthCode; 402 /** 403 * The description for the agent health code. 404 */ 405 agentHealthDetails?: Message; 406 /** 407 * The Auto Scaling group of the EC2 instance that is specified by the agent ID. 408 */ 409 autoScalingGroup?: AutoScalingGroup; 410 /** 411 * The Amazon Inspector application data metrics that are collected by the agent. 412 */ 413 telemetryMetadata: TelemetryMetadataList; 414 } 415 export type AssessmentRunAgentList = AssessmentRunAgent[]; 416 export type AssessmentRunDuration = number; 417 export interface AssessmentRunFilter { 418 /** 419 * For a record to match a filter, an explicit value or a string containing a wildcard that is specified for this data type property must match the value of the assessmentRunName property of the AssessmentRun data type. 420 */ 421 namePattern?: NamePattern; 422 /** 423 * For a record to match a filter, one of the values specified for this data type property must be the exact match of the value of the assessmentRunState property of the AssessmentRun data type. 424 */ 425 states?: AssessmentRunStateList; 426 /** 427 * For a record to match a filter, the value that is specified for this data type property must inclusively match any value between the specified minimum and maximum values of the durationInSeconds property of the AssessmentRun data type. 428 */ 429 durationRange?: DurationRange; 430 /** 431 * For a record to match a filter, the value that is specified for this data type property must be contained in the list of values of the rulesPackages property of the AssessmentRun data type. 432 */ 433 rulesPackageArns?: FilterRulesPackageArnList; 434 /** 435 * For a record to match a filter, the value that is specified for this data type property must inclusively match any value between the specified minimum and maximum values of the startTime property of the AssessmentRun data type. 436 */ 437 startTimeRange?: TimestampRange; 438 /** 439 * For a record to match a filter, the value that is specified for this data type property must inclusively match any value between the specified minimum and maximum values of the completedAt property of the AssessmentRun data type. 440 */ 441 completionTimeRange?: TimestampRange; 442 /** 443 * For a record to match a filter, the value that is specified for this data type property must match the stateChangedAt property of the AssessmentRun data type. 444 */ 445 stateChangeTimeRange?: TimestampRange; 446 } 447 export type AssessmentRunInProgressArnList = Arn[]; 448 export type AssessmentRunList = AssessmentRun[]; 449 export type AssessmentRunName = string; 450 export interface AssessmentRunNotification { 451 /** 452 * The date of the notification. 453 */ 454 date: Timestamp; 455 /** 456 * The event for which a notification is sent. 457 */ 458 event: InspectorEvent; 459 message?: Message; 460 /** 461 * The Boolean value that specifies whether the notification represents an error. 462 */ 463 error: Bool; 464 /** 465 * The SNS topic to which the SNS notification is sent. 466 */ 467 snsTopicArn?: Arn; 468 /** 469 * The status code of the SNS notification. 470 */ 471 snsPublishStatusCode?: AssessmentRunNotificationSnsStatusCode; 472 } 473 export type AssessmentRunNotificationList = AssessmentRunNotification[]; 474 export type AssessmentRunNotificationSnsStatusCode = "SUCCESS"|"TOPIC_DOES_NOT_EXIST"|"ACCESS_DENIED"|"INTERNAL_ERROR"|string; 475 export type AssessmentRunState = "CREATED"|"START_DATA_COLLECTION_PENDING"|"START_DATA_COLLECTION_IN_PROGRESS"|"COLLECTING_DATA"|"STOP_DATA_COLLECTION_PENDING"|"DATA_COLLECTED"|"EVALUATING_RULES"|"FAILED"|"COMPLETED"|"COMPLETED_WITH_ERRORS"|string; 476 export interface AssessmentRunStateChange { 477 /** 478 * The last time the assessment run state changed. 479 */ 480 stateChangedAt: Timestamp; 481 /** 482 * The assessment run state. 483 */ 484 state: AssessmentRunState; 485 } 486 export type AssessmentRunStateChangeList = AssessmentRunStateChange[]; 487 export type AssessmentRunStateList = AssessmentRunState[]; 488 export interface AssessmentTarget { 489 /** 490 * The ARN that specifies the Amazon Inspector assessment target. 491 */ 492 arn: Arn; 493 /** 494 * The name of the Amazon Inspector assessment target. 495 */ 496 name: AssessmentTargetName; 497 /** 498 * The ARN that specifies the resource group that is associated with the assessment target. 499 */ 500 resourceGroupArn: Arn; 501 /** 502 * The time at which the assessment target is created. 503 */ 504 createdAt: Timestamp; 505 /** 506 * The time at which UpdateAssessmentTarget is called. 507 */ 508 updatedAt: Timestamp; 509 } 510 export interface AssessmentTargetFilter { 511 /** 512 * For a record to match a filter, an explicit value or a string that contains a wildcard that is specified for this data type property must match the value of the assessmentTargetName property of the AssessmentTarget data type. 513 */ 514 assessmentTargetNamePattern?: NamePattern; 515 } 516 export type AssessmentTargetList = AssessmentTarget[]; 517 export type AssessmentTargetName = string; 518 export interface AssessmentTemplate { 519 /** 520 * The ARN of the assessment template. 521 */ 522 arn: Arn; 523 /** 524 * The name of the assessment template. 525 */ 526 name: AssessmentTemplateName; 527 /** 528 * The ARN of the assessment target that corresponds to this assessment template. 529 */ 530 assessmentTargetArn: Arn; 531 /** 532 * The duration in seconds specified for this assessment tempate. The default value is 3600 seconds (one hour). The maximum value is 86400 seconds (one day). 533 */ 534 durationInSeconds: AssessmentRunDuration; 535 /** 536 * The rules packages that are specified for this assessment template. 537 */ 538 rulesPackageArns: AssessmentTemplateRulesPackageArnList; 539 /** 540 * The user-defined attributes that are assigned to every generated finding from the assessment run that uses this assessment template. 541 */ 542 userAttributesForFindings: UserAttributeList; 543 /** 544 * The time at which the assessment template is created. 545 */ 546 createdAt: Timestamp; 547 } 548 export interface AssessmentTemplateFilter { 549 /** 550 * For a record to match a filter, an explicit value or a string that contains a wildcard that is specified for this data type property must match the value of the assessmentTemplateName property of the AssessmentTemplate data type. 551 */ 552 namePattern?: NamePattern; 553 /** 554 * For a record to match a filter, the value specified for this data type property must inclusively match any value between the specified minimum and maximum values of the durationInSeconds property of the AssessmentTemplate data type. 555 */ 556 durationRange?: DurationRange; 557 /** 558 * For a record to match a filter, the values that are specified for this data type property must be contained in the list of values of the rulesPackageArns property of the AssessmentTemplate data type. 559 */ 560 rulesPackageArns?: FilterRulesPackageArnList; 561 } 562 export type AssessmentTemplateList = AssessmentTemplate[]; 563 export type AssessmentTemplateName = string; 564 export type AssessmentTemplateRulesPackageArnList = Arn[]; 565 export interface AssetAttributes { 566 /** 567 * The schema version of this data type. 568 */ 569 schemaVersion: NumericVersion; 570 /** 571 * The ID of the agent that is installed on the EC2 instance where the finding is generated. 572 */ 573 agentId?: AgentId; 574 /** 575 * The Auto Scaling group of the EC2 instance where the finding is generated. 576 */ 577 autoScalingGroup?: AutoScalingGroup; 578 /** 579 * The ID of the Amazon Machine Image (AMI) that is installed on the EC2 instance where the finding is generated. 580 */ 581 amiId?: AmiId; 582 /** 583 * The hostname of the EC2 instance where the finding is generated. 584 */ 585 hostname?: Hostname; 586 /** 587 * The list of IP v4 addresses of the EC2 instance where the finding is generated. 588 */ 589 ipv4Addresses?: Ipv4AddressList; 590 } 591 export type AssetType = "ec2-instance"|string; 592 export interface Attribute { 593 /** 594 * The attribute key. 595 */ 596 key: AttributeKey; 597 /** 598 * The value assigned to the attribute key. 599 */ 600 value?: AttributeValue; 601 } 602 export type AttributeKey = string; 603 export type AttributeList = Attribute[]; 604 export type AttributeValue = string; 605 export type AutoScalingGroup = string; 606 export type AutoScalingGroupList = AutoScalingGroup[]; 607 export type BatchDescribeArnList = Arn[]; 608 export type Bool = boolean; 609 export interface CreateAssessmentTargetRequest { 610 /** 611 * The user-defined name that identifies the assessment target that you want to create. The name must be unique within the AWS account. 612 */ 613 assessmentTargetName: AssessmentTargetName; 614 /** 615 * The ARN that specifies the resource group that is used to create the assessment target. 616 */ 617 resourceGroupArn: Arn; 618 } 619 export interface CreateAssessmentTargetResponse { 620 /** 621 * The ARN that specifies the assessment target that is created. 622 */ 623 assessmentTargetArn: Arn; 624 } 625 export interface CreateAssessmentTemplateRequest { 626 /** 627 * The ARN that specifies the assessment target for which you want to create the assessment template. 628 */ 629 assessmentTargetArn: Arn; 630 /** 631 * The user-defined name that identifies the assessment template that you want to create. You can create several assessment templates for an assessment target. The names of the assessment templates that correspond to a particular assessment target must be unique. 632 */ 633 assessmentTemplateName: AssessmentTemplateName; 634 /** 635 * The duration of the assessment run in seconds. The default value is 3600 seconds (one hour). 636 */ 637 durationInSeconds: AssessmentRunDuration; 638 /** 639 * The ARNs that specify the rules packages that you want to attach to the assessment template. 640 */ 641 rulesPackageArns: AssessmentTemplateRulesPackageArnList; 642 /** 643 * The user-defined attributes that are assigned to every finding that is generated by the assessment run that uses this assessment template. 644 */ 645 userAttributesForFindings?: UserAttributeList; 646 } 647 export interface CreateAssessmentTemplateResponse { 648 /** 649 * The ARN that specifies the assessment template that is created. 650 */ 651 assessmentTemplateArn: Arn; 652 } 653 export interface CreateResourceGroupRequest { 654 /** 655 * A collection of keys and an array of possible values, '[{"key":"key1","values":["Value1","Value2"]},{"key":"Key2","values":["Value3"]}]'. For example,'[{"key":"Name","values":["TestEC2Instance"]}]'. 656 */ 657 resourceGroupTags: ResourceGroupTags; 658 } 659 export interface CreateResourceGroupResponse { 660 /** 661 * The ARN that specifies the resource group that is created. 662 */ 663 resourceGroupArn: Arn; 664 } 665 export interface DeleteAssessmentRunRequest { 666 /** 667 * The ARN that specifies the assessment run that you want to delete. 668 */ 669 assessmentRunArn: Arn; 670 } 671 export interface DeleteAssessmentTargetRequest { 672 /** 673 * The ARN that specifies the assessment target that you want to delete. 674 */ 675 assessmentTargetArn: Arn; 676 } 677 export interface DeleteAssessmentTemplateRequest { 678 /** 679 * The ARN that specifies the assessment template that you want to delete. 680 */ 681 assessmentTemplateArn: Arn; 682 } 683 export interface DescribeAssessmentRunsRequest { 684 /** 685 * The ARN that specifies the assessment run that you want to describe. 686 */ 687 assessmentRunArns: BatchDescribeArnList; 688 } 689 export interface DescribeAssessmentRunsResponse { 690 /** 691 * Information about the assessment run. 692 */ 693 assessmentRuns: AssessmentRunList; 694 /** 695 * Assessment run details that cannot be described. An error code is provided for each failed item. 696 */ 697 failedItems: FailedItems; 698 } 699 export interface DescribeAssessmentTargetsRequest { 700 /** 701 * The ARNs that specifies the assessment targets that you want to describe. 702 */ 703 assessmentTargetArns: BatchDescribeArnList; 704 } 705 export interface DescribeAssessmentTargetsResponse { 706 /** 707 * Information about the assessment targets. 708 */ 709 assessmentTargets: AssessmentTargetList; 710 /** 711 * Assessment target details that cannot be described. An error code is provided for each failed item. 712 */ 713 failedItems: FailedItems; 714 } 715 export interface DescribeAssessmentTemplatesRequest { 716 /** 717 * The ARN that specifiesthe assessment templates that you want to describe. 718 */ 719 assessmentTemplateArns: BatchDescribeArnList; 720 } 721 export interface DescribeAssessmentTemplatesResponse { 722 /** 723 * Information about the assessment templates. 724 */ 725 assessmentTemplates: AssessmentTemplateList; 726 /** 727 * Assessment template details that cannot be described. An error code is provided for each failed item. 728 */ 729 failedItems: FailedItems; 730 } 731 export interface DescribeCrossAccountAccessRoleResponse { 732 /** 733 * The ARN that specifies the IAM role that Amazon Inspector uses to access your AWS account. 734 */ 735 roleArn: Arn; 736 /** 737 * A Boolean value that specifies whether the IAM role has the necessary policies attached to enable Amazon Inspector to access your AWS account. 738 */ 739 valid: Bool; 740 /** 741 * The date when the cross-account access role was registered. 742 */ 743 registeredAt: Timestamp; 744 } 745 export interface DescribeFindingsRequest { 746 /** 747 * The ARN that specifies the finding that you want to describe. 748 */ 749 findingArns: BatchDescribeArnList; 750 /** 751 * The locale into which you want to translate a finding description, recommendation, and the short description that identifies the finding. 752 */ 753 locale?: Locale; 754 } 755 export interface DescribeFindingsResponse { 756 /** 757 * Information about the finding. 758 */ 759 findings: FindingList; 760 /** 761 * Finding details that cannot be described. An error code is provided for each failed item. 762 */ 763 failedItems: FailedItems; 764 } 765 export interface DescribeResourceGroupsRequest { 766 /** 767 * The ARN that specifies the resource group that you want to describe. 768 */ 769 resourceGroupArns: BatchDescribeArnList; 770 } 771 export interface DescribeResourceGroupsResponse { 772 /** 773 * Information about a resource group. 774 */ 775 resourceGroups: ResourceGroupList; 776 /** 777 * Resource group details that cannot be described. An error code is provided for each failed item. 778 */ 779 failedItems: FailedItems; 780 } 781 export interface DescribeRulesPackagesRequest { 782 /** 783 * The ARN that specifies the rules package that you want to describe. 784 */ 785 rulesPackageArns: BatchDescribeArnList; 786 /** 787 * The locale that you want to translate a rules package description into. 788 */ 789 locale?: Locale; 790 } 791 export interface DescribeRulesPackagesResponse { 792 /** 793 * Information about the rules package. 794 */ 795 rulesPackages: RulesPackageList; 796 /** 797 * Rules package details that cannot be described. An error code is provided for each failed item. 798 */ 799 failedItems: FailedItems; 800 } 801 export interface DurationRange { 802 /** 803 * The minimum value of the duration range. Must be greater than zero. 804 */ 805 minSeconds?: AssessmentRunDuration; 806 /** 807 * The maximum value of the duration range. Must be less than or equal to 604800 seconds (1 week). 808 */ 809 maxSeconds?: AssessmentRunDuration; 810 } 811 export type ErrorMessage = string; 812 export interface EventSubscription { 813 /** 814 * The event for which Amazon Simple Notification Service (SNS) notifications are sent. 815 */ 816 event: InspectorEvent; 817 /** 818 * The time at which SubscribeToEvent is called. 819 */ 820 subscribedAt: Timestamp; 821 } 822 export type EventSubscriptionList = EventSubscription[]; 823 export interface FailedItemDetails { 824 /** 825 * The status code of a failed item. 826 */ 827 failureCode: FailedItemErrorCode; 828 /** 829 * Indicates whether you can immediately retry a request for this item for a specified resource. 830 */ 831 retryable: Bool; 832 } 833 export type FailedItemErrorCode = "INVALID_ARN"|"DUPLICATE_ARN"|"ITEM_DOES_NOT_EXIST"|"ACCESS_DENIED"|"LIMIT_EXCEEDED"|"INTERNAL_ERROR"|string; 834 export type FailedItems = {[key: string]: FailedItemDetails}; 835 export type FilterRulesPackageArnList = Arn[]; 836 export interface Finding { 837 /** 838 * The ARN that specifies the finding. 839 */ 840 arn: Arn; 841 /** 842 * The schema version of this data type. 843 */ 844 schemaVersion?: NumericVersion; 845 /** 846 * The data element is set to "Inspector". 847 */ 848 service?: ServiceName; 849 serviceAttributes?: InspectorServiceAttributes; 850 /** 851 * The type of the host from which the finding is generated. 852 */ 853 assetType?: AssetType; 854 /** 855 * A collection of attributes of the host from which the finding is generated. 856 */ 857 assetAttributes?: AssetAttributes; 858 /** 859 * The ID of the finding. 860 */ 861 id?: FindingId; 862 /** 863 * The name of the finding. 864 */ 865 title?: Text; 866 /** 867 * The description of the finding. 868 */ 869 description?: Text; 870 /** 871 * The recommendation for the finding. 872 */ 873 recommendation?: Text; 874 /** 875 * The finding severity. Values can be set to High, Medium, Low, and Informational. 876 */ 877 severity?: Severity; 878 /** 879 * The numeric value of the finding severity. 880 */ 881 numericSeverity?: NumericSeverity; 882 /** 883 * This data element is currently not used. 884 */ 885 confidence?: IocConfidence; 886 /** 887 * This data element is currently not used. 888 */ 889 indicatorOfCompromise?: Bool; 890 /** 891 * The system-defined attributes for the finding. 892 */ 893 attributes: AttributeList; 894 /** 895 * The user-defined attributes that are assigned to the finding. 896 */ 897 userAttributes: UserAttributeList; 898 /** 899 * The time when the finding was generated. 900 */ 901 createdAt: Timestamp; 902 /** 903 * The time when AddAttributesToFindings is called. 904 */ 905 updatedAt: Timestamp; 906 } 907 export interface FindingFilter { 908 /** 909 * For a record to match a filter, one of the values that is specified for this data type property must be the exact match of the value of the agentId property of the Finding data type. 910 */ 911 agentIds?: AgentIdList; 912 /** 913 * For a record to match a filter, one of the values that is specified for this data type property must be the exact match of the value of the autoScalingGroup property of the Finding data type. 914 */ 915 autoScalingGroups?: AutoScalingGroupList; 916 /** 917 * For a record to match a filter, one of the values that is specified for this data type property must be the exact match of the value of the ruleName property of the Finding data type. 918 */ 919 ruleNames?: RuleNameList; 920 /** 921 * For a record to match a filter, one of the values that is specified for this data type property must be the exact match of the value of the severity property of the Finding data type. 922 */ 923 severities?: SeverityList; 924 /** 925 * For a record to match a filter, one of the values that is specified for this data type property must be the exact match of the value of the rulesPackageArn property of the Finding data type. 926 */ 927 rulesPackageArns?: FilterRulesPackageArnList; 928 /** 929 * For a record to match a filter, the list of values that are specified for this data type property must be contained in the list of values of the attributes property of the Finding data type. 930 */ 931 attributes?: AttributeList; 932 /** 933 * For a record to match a filter, the value that is specified for this data type property must be contained in the list of values of the userAttributes property of the Finding data type. 934 */ 935 userAttributes?: AttributeList; 936 /** 937 * The time range during which the finding is generated. 938 */ 939 creationTimeRange?: TimestampRange; 940 } 941 export type FindingId = string; 942 export type FindingList = Finding[]; 943 export interface GetTelemetryMetadataRequest { 944 /** 945 * The ARN that specifies the assessment run that has the telemetry data that you want to obtain. 946 */ 947 assessmentRunArn: Arn; 948 } 949 export interface GetTelemetryMetadataResponse { 950 /** 951 * Telemetry details. 952 */ 953 telemetryMetadata: TelemetryMetadataList; 954 } 955 export type Hostname = string; 956 export type InspectorEvent = "ASSESSMENT_RUN_STARTED"|"ASSESSMENT_RUN_COMPLETED"|"ASSESSMENT_RUN_STATE_CHANGED"|"FINDING_REPORTED"|"OTHER"|string; 957 export interface InspectorServiceAttributes { 958 /** 959 * The schema version of this data type. 960 */ 961 schemaVersion: NumericVersion; 962 /** 963 * The ARN of the assessment run during which the finding is generated. 964 */ 965 assessmentRunArn?: Arn; 966 /** 967 * The ARN of the rules package that is used to generate the finding. 968 */ 969 rulesPackageArn?: Arn; 970 } 971 export type InvalidCrossAccountRoleErrorCode = "ROLE_DOES_NOT_EXIST_OR_INVALID_TRUST_RELATIONSHIP"|"ROLE_DOES_NOT_HAVE_CORRECT_POLICY"|string; 972 export type InvalidInputErrorCode = "INVALID_ASSESSMENT_TARGET_ARN"|"INVALID_ASSESSMENT_TEMPLATE_ARN"|"INVALID_ASSESSMENT_RUN_ARN"|"INVALID_FINDING_ARN"|"INVALID_RESOURCE_GROUP_ARN"|"INVALID_RULES_PACKAGE_ARN"|"INVALID_RESOURCE_ARN"|"INVALID_SNS_TOPIC_ARN"|"INVALID_IAM_ROLE_ARN"|"INVALID_ASSESSMENT_TARGET_NAME"|"INVALID_ASSESSMENT_TARGET_NAME_PATTERN"|"INVALID_ASSESSMENT_TEMPLATE_NAME"|"INVALID_ASSESSMENT_TEMPLATE_NAME_PATTERN"|"INVALID_ASSESSMENT_TEMPLATE_DURATION"|"INVALID_ASSESSMENT_TEMPLATE_DURATION_RANGE"|"INVALID_ASSESSMENT_RUN_DURATION_RANGE"|"INVALID_ASSESSMENT_RUN_START_TIME_RANGE"|"INVALID_ASSESSMENT_RUN_COMPLETION_TIME_RANGE"|"INVALID_ASSESSMENT_RUN_STATE_CHANGE_TIME_RANGE"|"INVALID_ASSESSMENT_RUN_STATE"|"INVALID_TAG"|"INVALID_TAG_KEY"|"INVALID_TAG_VALUE"|"INVALID_RESOURCE_GROUP_TAG_KEY"|"INVALID_RESOURCE_GROUP_TAG_VALUE"|"INVALID_ATTRIBUTE"|"INVALID_USER_ATTRIBUTE"|"INVALID_USER_ATTRIBUTE_KEY"|"INVALID_USER_ATTRIBUTE_VALUE"|"INVALID_PAGINATION_TOKEN"|"INVALID_MAX_RESULTS"|"INVALID_AGENT_ID"|"INVALID_AUTO_SCALING_GROUP"|"INVALID_RULE_NAME"|"INVALID_SEVERITY"|"INVALID_LOCALE"|"INVALID_EVENT"|"ASSESSMENT_TARGET_NAME_ALREADY_TAKEN"|"ASSESSMENT_TEMPLATE_NAME_ALREADY_TAKEN"|"INVALID_NUMBER_OF_ASSESSMENT_TARGET_ARNS"|"INVALID_NUMBER_OF_ASSESSMENT_TEMPLATE_ARNS"|"INVALID_NUMBER_OF_ASSESSMENT_RUN_ARNS"|"INVALID_NUMBER_OF_FINDING_ARNS"|"INVALID_NUMBER_OF_RESOURCE_GROUP_ARNS"|"INVALID_NUMBER_OF_RULES_PACKAGE_ARNS"|"INVALID_NUMBER_OF_ASSESSMENT_RUN_STATES"|"INVALID_NUMBER_OF_TAGS"|"INVALID_NUMBER_OF_RESOURCE_GROUP_TAGS"|"INVALID_NUMBER_OF_ATTRIBUTES"|"INVALID_NUMBER_OF_USER_ATTRIBUTES"|"INVALID_NUMBER_OF_AGENT_IDS"|"INVALID_NUMBER_OF_AUTO_SCALING_GROUPS"|"INVALID_NUMBER_OF_RULE_NAMES"|"INVALID_NUMBER_OF_SEVERITIES"|string; 973 export type IocConfidence = number; 974 export type Ipv4Address = string; 975 export type Ipv4AddressList = Ipv4Address[]; 976 export type LimitExceededErrorCode = "ASSESSMENT_TARGET_LIMIT_EXCEEDED"|"ASSESSMENT_TEMPLATE_LIMIT_EXCEEDED"|"ASSESSMENT_RUN_LIMIT_EXCEEDED"|"RESOURCE_GROUP_LIMIT_EXCEEDED"|"EVENT_SUBSCRIPTION_LIMIT_EXCEEDED"|string; 977 export interface ListAssessmentRunAgentsRequest { 978 /** 979 * The ARN that specifies the assessment run whose agents you want to list. 980 */ 981 assessmentRunArn: Arn; 982 /** 983 * You can use this parameter to specify a subset of data to be included in the action's response. For a record to match a filter, all specified filter attributes must match. When multiple values are specified for a filter attribute, any of the values can match. 984 */ 985 filter?: AgentFilter; 986 /** 987 * You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the ListAssessmentRunAgents action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data. 988 */ 989 nextToken?: PaginationToken; 990 /** 991 * You can use this parameter to indicate the maximum number of items that you want in the response. The default value is 10. The maximum value is 500. 992 */ 993 maxResults?: ListMaxResults; 994 } 995 export interface ListAssessmentRunAgentsResponse { 996 /** 997 * A list of ARNs that specifies the agents returned by the action. 998 */ 999 assessmentRunAgents: AssessmentRunAgentList; 1000 /** 1001 * When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to null. 1002 */ 1003 nextToken?: PaginationToken; 1004 } 1005 export interface ListAssessmentRunsRequest { 1006 /** 1007 * The ARNs that specify the assessment templates whose assessment runs you want to list. 1008 */ 1009 assessmentTemplateArns?: ListParentArnList; 1010 /** 1011 * You can use this parameter to specify a subset of data to be included in the action's response. For a record to match a filter, all specified filter attributes must match. When multiple values are specified for a filter attribute, any of the values can match. 1012 */ 1013 filter?: AssessmentRunFilter; 1014 /** 1015 * You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the ListAssessmentRuns action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data. 1016 */ 1017 nextToken?: PaginationToken; 1018 /** 1019 * You can use this parameter to indicate the maximum number of items that you want in the response. The default value is 10. The maximum value is 500. 1020 */ 1021 maxResults?: ListMaxResults; 1022 } 1023 export interface ListAssessmentRunsResponse { 1024 /** 1025 * A list of ARNs that specifies the assessment runs that are returned by the action. 1026 */ 1027 assessmentRunArns: ListReturnedArnList; 1028 /** 1029 * When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to null. 1030 */ 1031 nextToken?: PaginationToken; 1032 } 1033 export interface ListAssessmentTargetsRequest { 1034 /** 1035 * You can use this parameter to specify a subset of data to be included in the action's response. For a record to match a filter, all specified filter attributes must match. When multiple values are specified for a filter attribute, any of the values can match. 1036 */ 1037 filter?: AssessmentTargetFilter; 1038 /** 1039 * You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the ListAssessmentTargets action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data. 1040 */ 1041 nextToken?: PaginationToken; 1042 /** 1043 * You can use this parameter to indicate the maximum number of items you want in the response. The default value is 10. The maximum value is 500. 1044 */ 1045 maxResults?: ListMaxResults; 1046 } 1047 export interface ListAssessmentTargetsResponse { 1048 /** 1049 * A list of ARNs that specifies the assessment targets that are returned by the action. 1050 */ 1051 assessmentTargetArns: ListReturnedArnList; 1052 /** 1053 * When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to null. 1054 */ 1055 nextToken?: PaginationToken; 1056 } 1057 export interface ListAssessmentTemplatesRequest { 1058 /** 1059 * A list of ARNs that specifies the assessment targets whose assessment templates you want to list. 1060 */ 1061 assessmentTargetArns?: ListParentArnList; 1062 /** 1063 * You can use this parameter to specify a subset of data to be included in the action's response. For a record to match a filter, all specified filter attributes must match. When multiple values are specified for a filter attribute, any of the values can match. 1064 */ 1065 filter?: AssessmentTemplateFilter; 1066 /** 1067 * You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the ListAssessmentTemplates action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data. 1068 */ 1069 nextToken?: PaginationToken; 1070 /** 1071 * You can use this parameter to indicate the maximum number of items you want in the response. The default value is 10. The maximum value is 500. 1072 */ 1073 maxResults?: ListMaxResults; 1074 } 1075 export interface ListAssessmentTemplatesResponse { 1076 /** 1077 * A list of ARNs that specifies the assessment templates returned by the action. 1078 */ 1079 assessmentTemplateArns: ListReturnedArnList; 1080 /** 1081 * When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to null. 1082 */ 1083 nextToken?: PaginationToken; 1084 } 1085 export type ListEventSubscriptionsMaxResults = number; 1086 export interface ListEventSubscriptionsRequest { 1087 /** 1088 * The ARN of the assessment template for which you want to list the existing event subscriptions. 1089 */ 1090 resourceArn?: Arn; 1091 /** 1092 * You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the ListEventSubscriptions action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data. 1093 */ 1094 nextToken?: PaginationToken; 1095 /** 1096 * You can use this parameter to indicate the maximum number of items you want in the response. The default value is 10. The maximum value is 500. 1097 */ 1098 maxResults?: ListEventSubscriptionsMaxResults; 1099 } 1100 export interface ListEventSubscriptionsResponse { 1101 /** 1102 * Details of the returned event subscriptions. 1103 */ 1104 subscriptions: SubscriptionList; 1105 /** 1106 * When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to null. 1107 */ 1108 nextToken?: PaginationToken; 1109 } 1110 export interface ListFindingsRequest { 1111 /** 1112 * The ARNs of the assessment runs that generate the findings that you want to list. 1113 */ 1114 assessmentRunArns?: ListParentArnList; 1115 /** 1116 * You can use this parameter to specify a subset of data to be included in the action's response. For a record to match a filter, all specified filter attributes must match. When multiple values are specified for a filter attribute, any of the values can match. 1117 */ 1118 filter?: FindingFilter; 1119 /** 1120 * You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the ListFindings action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data. 1121 */ 1122 nextToken?: PaginationToken; 1123 /** 1124 * You can use this parameter to indicate the maximum number of items you want in the response. The default value is 10. The maximum value is 500. 1125 */ 1126 maxResults?: ListMaxResults; 1127 } 1128 export interface ListFindingsResponse { 1129 /** 1130 * A list of ARNs that specifies the findings returned by the action. 1131 */ 1132 findingArns: ListReturnedArnList; 1133 /** 1134 * When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to null. 1135 */ 1136 nextToken?: PaginationToken; 1137 } 1138 export type ListMaxResults = number; 1139 export type ListParentArnList = Arn[]; 1140 export type ListReturnedArnList = Arn[]; 1141 export interface ListRulesPackagesRequest { 1142 /** 1143 * You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the ListRulesPackages action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data. 1144 */ 1145 nextToken?: PaginationToken; 1146 /** 1147 * You can use this parameter to indicate the maximum number of items you want in the response. The default value is 10. The maximum value is 500. 1148 */ 1149 maxResults?: ListMaxResults; 1150 } 1151 export interface ListRulesPackagesResponse { 1152 /** 1153 * The list of ARNs that specifies the rules packages returned by the action. 1154 */ 1155 rulesPackageArns: ListReturnedArnList; 1156 /** 1157 * When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to null. 1158 */ 1159 nextToken?: PaginationToken; 1160 } 1161 export interface ListTagsForResourceRequest { 1162 /** 1163 * The ARN that specifies the assessment template whose tags you want to list. 1164 */ 1165 resourceArn: Arn; 1166 } 1167 export interface ListTagsForResourceResponse { 1168 /** 1169 * A collection of key and value pairs. 1170 */ 1171 tags: TagList; 1172 } 1173 export type Locale = "EN_US"|string; 1174 export type Long = number; 1175 export type Message = string; 1176 export type MessageType = string; 1177 export type NamePattern = string; 1178 export type NoSuchEntityErrorCode = "ASSESSMENT_TARGET_DOES_NOT_EXIST"|"ASSESSMENT_TEMPLATE_DOES_NOT_EXIST"|"ASSESSMENT_RUN_DOES_NOT_EXIST"|"FINDING_DOES_NOT_EXIST"|"RESOURCE_GROUP_DOES_NOT_EXIST"|"RULES_PACKAGE_DOES_NOT_EXIST"|"SNS_TOPIC_DOES_NOT_EXIST"|"IAM_ROLE_DOES_NOT_EXIST"|string; 1179 export type NumericSeverity = number; 1180 export type NumericVersion = number; 1181 export type PaginationToken = string; 1182 export type PreviewAgentsMaxResults = number; 1183 export interface PreviewAgentsRequest { 1184 /** 1185 * The ARN of the assessment target whose agents you want to preview. 1186 */ 1187 previewAgentsArn: Arn; 1188 /** 1189 * You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the PreviewAgents action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data. 1190 */ 1191 nextToken?: PaginationToken; 1192 /** 1193 * You can use this parameter to indicate the maximum number of items you want in the response. The default value is 10. The maximum value is 500. 1194 */ 1195 maxResults?: PreviewAgentsMaxResults; 1196 } 1197 export interface PreviewAgentsResponse { 1198 /** 1199 * The resulting list of agents. 1200 */ 1201 agentPreviews: AgentPreviewList; 1202 /** 1203 * When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to null. 1204 */ 1205 nextToken?: PaginationToken; 1206 } 1207 export type ProviderName = string; 1208 export interface RegisterCrossAccountAccessRoleRequest { 1209 /** 1210 * The ARN of the IAM role that Amazon Inspector uses to list your EC2 instances during the assessment run or when you call the PreviewAgents action. 1211 */ 1212 roleArn: Arn; 1213 } 1214 export interface RemoveAttributesFromFindingsRequest { 1215 /** 1216 * The ARNs that specify the findings that you want to remove attributes from. 1217 */ 1218 findingArns: AddRemoveAttributesFindingArnList; 1219 /** 1220 * The array of attribute keys that you want to remove from specified findings. 1221 */ 1222 attributeKeys: UserAttributeKeyList; 1223 } 1224 export interface RemoveAttributesFromFindingsResponse { 1225 /** 1226 * Attributes details that cannot be described. An error code is provided for each failed item. 1227 */ 1228 failedItems: FailedItems; 1229 } 1230 export interface ResourceGroup { 1231 /** 1232 * The ARN of the resource group. 1233 */ 1234 arn: Arn; 1235 /** 1236 * The tags (key and value pairs) of the resource group. This data type property is used in the CreateResourceGroup action. 1237 */ 1238 tags: ResourceGroupTags; 1239 /** 1240 * The time at which resource group is created. 1241 */ 1242 createdAt: Timestamp; 1243 } 1244 export type ResourceGroupList = ResourceGroup[]; 1245 export interface ResourceGroupTag { 1246 /** 1247 * A tag key. 1248 */ 1249 key: TagKey; 1250 /** 1251 * The value assigned to a tag key. 1252 */ 1253 value?: TagValue; 1254 } 1255 export type ResourceGroupTags = ResourceGroupTag[]; 1256 export type RuleName = string; 1257 export type RuleNameList = RuleName[]; 1258 export interface RulesPackage { 1259 /** 1260 * The ARN of the rules package. 1261 */ 1262 arn: Arn; 1263 /** 1264 * The name of the rules package. 1265 */ 1266 name: RulesPackageName; 1267 /** 1268 * The version ID of the rules package. 1269 */ 1270 version: Version; 1271 /** 1272 * The provider of the rules package. 1273 */ 1274 provider: ProviderName; 1275 /** 1276 * The description of the rules package. 1277 */ 1278 description?: Text; 1279 } 1280 export type RulesPackageList = RulesPackage[]; 1281 export type RulesPackageName = string; 1282 export type ServiceName = string; 1283 export interface SetTagsForResourceRequest { 1284 /** 1285 * The ARN of the assessment template that you want to set tags to. 1286 */ 1287 resourceArn: Arn; 1288 /** 1289 * A collection of key and value pairs that you want to set to the assessment template. 1290 */ 1291 tags?: TagList; 1292 } 1293 export type Severity = "Low"|"Medium"|"High"|"Informational"|"Undefined"|string; 1294 export type SeverityList = Severity[]; 1295 export interface StartAssessmentRunRequest { 1296 /** 1297 * The ARN of the assessment template of the assessment run that you want to start. 1298 */ 1299 assessmentTemplateArn: Arn; 1300 /** 1301 * You can specify the name for the assessment run, or you can use the auto-generated name that is based on the assessment template name. The name must be unique for the assessment template. 1302 */ 1303 assessmentRunName?: AssessmentRunName; 1304 } 1305 export interface StartAssessmentRunResponse { 1306 /** 1307 * The ARN of the assessment run that has been started. 1308 */ 1309 assessmentRunArn: Arn; 1310 } 1311 export interface StopAssessmentRunRequest { 1312 /** 1313 * The ARN of the assessment run that you want to stop. 1314 */ 1315 assessmentRunArn: Arn; 1316 } 1317 export interface SubscribeToEventRequest { 1318 /** 1319 * The ARN of the assessment template that is used during the event for which you want to receive SNS notifications. 1320 */ 1321 resourceArn: Arn; 1322 /** 1323 * The event for which you want to receive SNS notifications. 1324 */ 1325 event: InspectorEvent; 1326 /** 1327 * The ARN of the SNS topic to which the SNS notifications are sent. 1328 */ 1329 topicArn: Arn; 1330 } 1331 export interface Subscription { 1332 /** 1333 * The ARN of the assessment template that is used during the event for which the SNS notification is sent. 1334 */ 1335 resourceArn: Arn; 1336 /** 1337 * The ARN of the Amazon Simple Notification Service (SNS) topic to which the SNS notifications are sent. 1338 */ 1339 topicArn: Arn; 1340 /** 1341 * The list of existing event subscriptions. 1342 */ 1343 eventSubscriptions: EventSubscriptionList; 1344 } 1345 export type SubscriptionList = Subscription[]; 1346 export interface Tag { 1347 /** 1348 * A tag key. 1349 */ 1350 key: TagKey; 1351 /** 1352 * A value assigned to a tag key. 1353 */ 1354 value?: TagValue; 1355 } 1356 export type TagKey = string; 1357 export type TagList = Tag[]; 1358 export type TagValue = string; 1359 export interface TelemetryMetadata { 1360 /** 1361 * A specific type of behavioral data that is collected by the agent. 1362 */ 1363 messageType: MessageType; 1364 /** 1365 * The count of messages that the agent sends to the Amazon Inspector service. 1366 */ 1367 count: Long; 1368 /** 1369 * The data size of messages that the agent sends to the Amazon Inspector service. 1370 */ 1371 dataSize?: Long; 1372 } 1373 export type TelemetryMetadataList = TelemetryMetadata[]; 1374 export type Text = string; 1375 export type Timestamp = Date; 1376 export interface TimestampRange { 1377 /** 1378 * The minimum value of the timestamp range. 1379 */ 1380 beginDate?: Timestamp; 1381 /** 1382 * The maximum value of the timestamp range. 1383 */ 1384 endDate?: Timestamp; 1385 } 1386 export interface UnsubscribeFromEventRequest { 1387 /** 1388 * The ARN of the assessment template that is used during the event for which you want to stop receiving SNS notifications. 1389 */ 1390 resourceArn: Arn; 1391 /** 1392 * The event for which you want to stop receiving SNS notifications. 1393 */ 1394 event: InspectorEvent; 1395 /** 1396 * The ARN of the SNS topic to which SNS notifications are sent. 1397 */ 1398 topicArn: Arn; 1399 } 1400 export interface UpdateAssessmentTargetRequest { 1401 /** 1402 * The ARN of the assessment target that you want to update. 1403 */ 1404 assessmentTargetArn: Arn; 1405 /** 1406 * The name of the assessment target that you want to update. 1407 */ 1408 assessmentTargetName: AssessmentTargetName; 1409 /** 1410 * The ARN of the resource group that is used to specify the new resource group to associate with the assessment target. 1411 */ 1412 resourceGroupArn: Arn; 1413 } 1414 export type UserAttributeKeyList = AttributeKey[]; 1415 export type UserAttributeList = Attribute[]; 1416 export type Version = string; 1417 /** 1418 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. 1419 */ 1420 export type apiVersion = "2015-08-18"|"2016-02-16"|"latest"|string; 1421 export interface ClientApiVersions { 1422 /** 1423 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. 1424 */ 1425 apiVersion?: apiVersion; 1426 } 1427 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; 1428 } 1429 export = Inspector;