@aws-sdk/client-inspector 3.288.0 → 3.290.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (38) hide show
  1. package/dist-types/commands/AddAttributesToFindingsCommand.d.ts +42 -0
  2. package/dist-types/commands/CreateAssessmentTargetCommand.d.ts +43 -0
  3. package/dist-types/commands/CreateAssessmentTemplateCommand.d.ts +49 -0
  4. package/dist-types/commands/CreateExclusionsPreviewCommand.d.ts +22 -0
  5. package/dist-types/commands/CreateResourceGroupCommand.d.ts +39 -0
  6. package/dist-types/commands/DeleteAssessmentRunCommand.d.ts +33 -0
  7. package/dist-types/commands/DeleteAssessmentTargetCommand.d.ts +33 -0
  8. package/dist-types/commands/DeleteAssessmentTemplateCommand.d.ts +33 -0
  9. package/dist-types/commands/DescribeAssessmentRunsCommand.d.ts +86 -0
  10. package/dist-types/commands/DescribeAssessmentTargetsCommand.d.ts +35 -0
  11. package/dist-types/commands/DescribeAssessmentTemplatesCommand.d.ts +40 -0
  12. package/dist-types/commands/DescribeCrossAccountAccessRoleCommand.d.ts +20 -0
  13. package/dist-types/commands/DescribeExclusionsCommand.d.ts +8 -0
  14. package/dist-types/commands/DescribeFindingsCommand.d.ts +54 -0
  15. package/dist-types/commands/DescribeResourceGroupsCommand.d.ts +38 -0
  16. package/dist-types/commands/DescribeRulesPackagesCommand.d.ts +35 -0
  17. package/dist-types/commands/GetAssessmentReportCommand.d.ts +29 -0
  18. package/dist-types/commands/GetExclusionsPreviewCommand.d.ts +15 -0
  19. package/dist-types/commands/GetTelemetryMetadataCommand.d.ts +177 -0
  20. package/dist-types/commands/ListAssessmentRunAgentsCommand.d.ts +187 -0
  21. package/dist-types/commands/ListAssessmentRunsCommand.d.ts +38 -0
  22. package/dist-types/commands/ListAssessmentTargetsCommand.d.ts +30 -0
  23. package/dist-types/commands/ListAssessmentTemplatesCommand.d.ts +38 -0
  24. package/dist-types/commands/ListEventSubscriptionsCommand.d.ts +44 -0
  25. package/dist-types/commands/ListExclusionsCommand.d.ts +15 -0
  26. package/dist-types/commands/ListFindingsCommand.d.ts +38 -0
  27. package/dist-types/commands/ListRulesPackagesCommand.d.ts +33 -0
  28. package/dist-types/commands/ListTagsForResourceCommand.d.ts +36 -0
  29. package/dist-types/commands/PreviewAgentsCommand.d.ts +41 -0
  30. package/dist-types/commands/RegisterCrossAccountAccessRoleCommand.d.ts +29 -0
  31. package/dist-types/commands/RemoveAttributesFromFindingsCommand.d.ts +39 -0
  32. package/dist-types/commands/SetTagsForResourceCommand.d.ts +35 -0
  33. package/dist-types/commands/StartAssessmentRunCommand.d.ts +47 -0
  34. package/dist-types/commands/StopAssessmentRunCommand.d.ts +29 -0
  35. package/dist-types/commands/SubscribeToEventCommand.d.ts +35 -0
  36. package/dist-types/commands/UnsubscribeFromEventCommand.d.ts +31 -0
  37. package/dist-types/commands/UpdateAssessmentTargetCommand.d.ts +31 -0
  38. package/package.json +29 -29
@@ -30,6 +30,48 @@ export interface AddAttributesToFindingsCommandOutput extends AddAttributesToFin
30
30
  * @see {@link AddAttributesToFindingsCommandOutput} for command's `response` shape.
31
31
  * @see {@link InspectorClientResolvedConfig | config} for InspectorClient's `config` shape.
32
32
  *
33
+ * @throws {@link AccessDeniedException} (client fault)
34
+ * <p>You do not have required permissions to access the requested resource.</p>
35
+ *
36
+ * @throws {@link InternalException} (server fault)
37
+ * <p>Internal server error.</p>
38
+ *
39
+ * @throws {@link InvalidInputException} (client fault)
40
+ * <p>The request was rejected because an invalid or out-of-range value was supplied for an
41
+ * input parameter.</p>
42
+ *
43
+ * @throws {@link NoSuchEntityException} (client fault)
44
+ * <p>The request was rejected because it referenced an entity that does not exist. The
45
+ * error code describes the entity.</p>
46
+ *
47
+ * @throws {@link ServiceTemporarilyUnavailableException} (server fault)
48
+ * <p>The serice is temporary unavailable.</p>
49
+ *
50
+ *
51
+ * @example Add attributes to findings
52
+ * ```javascript
53
+ * // Assigns attributes (key and value pairs) to the findings that are specified by the ARNs of the findings.
54
+ * const input = {
55
+ * "attributes": [
56
+ * {
57
+ * "key": "Example",
58
+ * "value": "example"
59
+ * }
60
+ * ],
61
+ * "findingArns": [
62
+ * "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-8l1VIE0D/run/0-Z02cjjug/finding/0-T8yM9mEU"
63
+ * ]
64
+ * };
65
+ * const command = new AddAttributesToFindingsCommand(input);
66
+ * const response = await client.send(command);
67
+ * /* response ==
68
+ * {
69
+ * "failedItems": {}
70
+ * }
71
+ * *\/
72
+ * // example id: add-attributes-to-findings-1481063856401
73
+ * ```
74
+ *
33
75
  */
34
76
  export declare class AddAttributesToFindingsCommand extends $Command<AddAttributesToFindingsCommandInput, AddAttributesToFindingsCommandOutput, InspectorClientResolvedConfig> {
35
77
  readonly input: AddAttributesToFindingsCommandInput;
@@ -36,6 +36,49 @@ export interface CreateAssessmentTargetCommandOutput extends CreateAssessmentTar
36
36
  * @see {@link CreateAssessmentTargetCommandOutput} for command's `response` shape.
37
37
  * @see {@link InspectorClientResolvedConfig | config} for InspectorClient's `config` shape.
38
38
  *
39
+ * @throws {@link AccessDeniedException} (client fault)
40
+ * <p>You do not have required permissions to access the requested resource.</p>
41
+ *
42
+ * @throws {@link InternalException} (server fault)
43
+ * <p>Internal server error.</p>
44
+ *
45
+ * @throws {@link InvalidCrossAccountRoleException} (client fault)
46
+ * <p>Amazon Inspector cannot assume the cross-account role that it needs to list your EC2
47
+ * instances during the assessment run.</p>
48
+ *
49
+ * @throws {@link InvalidInputException} (client fault)
50
+ * <p>The request was rejected because an invalid or out-of-range value was supplied for an
51
+ * input parameter.</p>
52
+ *
53
+ * @throws {@link LimitExceededException} (client fault)
54
+ * <p>The request was rejected because it attempted to create resources beyond the current
55
+ * AWS account limits. The error code describes the limit exceeded.</p>
56
+ *
57
+ * @throws {@link NoSuchEntityException} (client fault)
58
+ * <p>The request was rejected because it referenced an entity that does not exist. The
59
+ * error code describes the entity.</p>
60
+ *
61
+ * @throws {@link ServiceTemporarilyUnavailableException} (server fault)
62
+ * <p>The serice is temporary unavailable.</p>
63
+ *
64
+ *
65
+ * @example Create assessment target
66
+ * ```javascript
67
+ * // 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.
68
+ * const input = {
69
+ * "assessmentTargetName": "ExampleAssessmentTarget",
70
+ * "resourceGroupArn": "arn:aws:inspector:us-west-2:123456789012:resourcegroup/0-AB6DMKnv"
71
+ * };
72
+ * const command = new CreateAssessmentTargetCommand(input);
73
+ * const response = await client.send(command);
74
+ * /* response ==
75
+ * {
76
+ * "assessmentTargetArn": "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX"
77
+ * }
78
+ * *\/
79
+ * // example id: create-assessment-target-1481063953657
80
+ * ```
81
+ *
39
82
  */
40
83
  export declare class CreateAssessmentTargetCommand extends $Command<CreateAssessmentTargetCommandInput, CreateAssessmentTargetCommandOutput, InspectorClientResolvedConfig> {
41
84
  readonly input: CreateAssessmentTargetCommandInput;
@@ -32,6 +32,55 @@ export interface CreateAssessmentTemplateCommandOutput extends CreateAssessmentT
32
32
  * @see {@link CreateAssessmentTemplateCommandOutput} for command's `response` shape.
33
33
  * @see {@link InspectorClientResolvedConfig | config} for InspectorClient's `config` shape.
34
34
  *
35
+ * @throws {@link AccessDeniedException} (client fault)
36
+ * <p>You do not have required permissions to access the requested resource.</p>
37
+ *
38
+ * @throws {@link InternalException} (server fault)
39
+ * <p>Internal server error.</p>
40
+ *
41
+ * @throws {@link InvalidInputException} (client fault)
42
+ * <p>The request was rejected because an invalid or out-of-range value was supplied for an
43
+ * input parameter.</p>
44
+ *
45
+ * @throws {@link LimitExceededException} (client fault)
46
+ * <p>The request was rejected because it attempted to create resources beyond the current
47
+ * AWS account limits. The error code describes the limit exceeded.</p>
48
+ *
49
+ * @throws {@link NoSuchEntityException} (client fault)
50
+ * <p>The request was rejected because it referenced an entity that does not exist. The
51
+ * error code describes the entity.</p>
52
+ *
53
+ * @throws {@link ServiceTemporarilyUnavailableException} (server fault)
54
+ * <p>The serice is temporary unavailable.</p>
55
+ *
56
+ *
57
+ * @example Create assessment template
58
+ * ```javascript
59
+ * // Creates an assessment template for the assessment target that is specified by the ARN of the assessment target.
60
+ * const input = {
61
+ * "assessmentTargetArn": "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX",
62
+ * "assessmentTemplateName": "ExampleAssessmentTemplate",
63
+ * "durationInSeconds": 180,
64
+ * "rulesPackageArns": [
65
+ * "arn:aws:inspector:us-west-2:758058086616:rulespackage/0-11B9DBXp"
66
+ * ],
67
+ * "userAttributesForFindings": [
68
+ * {
69
+ * "key": "Example",
70
+ * "value": "example"
71
+ * }
72
+ * ]
73
+ * };
74
+ * const command = new CreateAssessmentTemplateCommand(input);
75
+ * const response = await client.send(command);
76
+ * /* response ==
77
+ * {
78
+ * "assessmentTemplateArn": "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-it5r2S4T"
79
+ * }
80
+ * *\/
81
+ * // example id: create-assessment-template-1481064046719
82
+ * ```
83
+ *
35
84
  */
36
85
  export declare class CreateAssessmentTemplateCommand extends $Command<CreateAssessmentTemplateCommandInput, CreateAssessmentTemplateCommandOutput, InspectorClientResolvedConfig> {
37
86
  readonly input: CreateAssessmentTemplateCommandInput;
@@ -31,6 +31,28 @@ export interface CreateExclusionsPreviewCommandOutput extends CreateExclusionsPr
31
31
  * @see {@link CreateExclusionsPreviewCommandOutput} for command's `response` shape.
32
32
  * @see {@link InspectorClientResolvedConfig | config} for InspectorClient's `config` shape.
33
33
  *
34
+ * @throws {@link AccessDeniedException} (client fault)
35
+ * <p>You do not have required permissions to access the requested resource.</p>
36
+ *
37
+ * @throws {@link InternalException} (server fault)
38
+ * <p>Internal server error.</p>
39
+ *
40
+ * @throws {@link InvalidInputException} (client fault)
41
+ * <p>The request was rejected because an invalid or out-of-range value was supplied for an
42
+ * input parameter.</p>
43
+ *
44
+ * @throws {@link NoSuchEntityException} (client fault)
45
+ * <p>The request was rejected because it referenced an entity that does not exist. The
46
+ * error code describes the entity.</p>
47
+ *
48
+ * @throws {@link PreviewGenerationInProgressException} (client fault)
49
+ * <p>The request is rejected. The specified assessment template is currently generating an
50
+ * exclusions preview.</p>
51
+ *
52
+ * @throws {@link ServiceTemporarilyUnavailableException} (server fault)
53
+ * <p>The serice is temporary unavailable.</p>
54
+ *
55
+ *
34
56
  */
35
57
  export declare class CreateExclusionsPreviewCommand extends $Command<CreateExclusionsPreviewCommandInput, CreateExclusionsPreviewCommandOutput, InspectorClientResolvedConfig> {
36
58
  readonly input: CreateExclusionsPreviewCommandInput;
@@ -32,6 +32,45 @@ export interface CreateResourceGroupCommandOutput extends CreateResourceGroupRes
32
32
  * @see {@link CreateResourceGroupCommandOutput} for command's `response` shape.
33
33
  * @see {@link InspectorClientResolvedConfig | config} for InspectorClient's `config` shape.
34
34
  *
35
+ * @throws {@link AccessDeniedException} (client fault)
36
+ * <p>You do not have required permissions to access the requested resource.</p>
37
+ *
38
+ * @throws {@link InternalException} (server fault)
39
+ * <p>Internal server error.</p>
40
+ *
41
+ * @throws {@link InvalidInputException} (client fault)
42
+ * <p>The request was rejected because an invalid or out-of-range value was supplied for an
43
+ * input parameter.</p>
44
+ *
45
+ * @throws {@link LimitExceededException} (client fault)
46
+ * <p>The request was rejected because it attempted to create resources beyond the current
47
+ * AWS account limits. The error code describes the limit exceeded.</p>
48
+ *
49
+ * @throws {@link ServiceTemporarilyUnavailableException} (server fault)
50
+ * <p>The serice is temporary unavailable.</p>
51
+ *
52
+ *
53
+ * @example Create resource group
54
+ * ```javascript
55
+ * // 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.
56
+ * const input = {
57
+ * "resourceGroupTags": [
58
+ * {
59
+ * "key": "Name",
60
+ * "value": "example"
61
+ * }
62
+ * ]
63
+ * };
64
+ * const command = new CreateResourceGroupCommand(input);
65
+ * const response = await client.send(command);
66
+ * /* response ==
67
+ * {
68
+ * "resourceGroupArn": "arn:aws:inspector:us-west-2:123456789012:resourcegroup/0-AB6DMKnv"
69
+ * }
70
+ * *\/
71
+ * // example id: create-resource-group-1481064169037
72
+ * ```
73
+ *
35
74
  */
36
75
  export declare class CreateResourceGroupCommand extends $Command<CreateResourceGroupCommandInput, CreateResourceGroupCommandOutput, InspectorClientResolvedConfig> {
37
76
  readonly input: CreateResourceGroupCommandInput;
@@ -30,6 +30,39 @@ export interface DeleteAssessmentRunCommandOutput extends __MetadataBearer {
30
30
  * @see {@link DeleteAssessmentRunCommandOutput} for command's `response` shape.
31
31
  * @see {@link InspectorClientResolvedConfig | config} for InspectorClient's `config` shape.
32
32
  *
33
+ * @throws {@link AccessDeniedException} (client fault)
34
+ * <p>You do not have required permissions to access the requested resource.</p>
35
+ *
36
+ * @throws {@link AssessmentRunInProgressException} (client fault)
37
+ * <p>You cannot perform a specified action if an assessment run is currently in
38
+ * progress.</p>
39
+ *
40
+ * @throws {@link InternalException} (server fault)
41
+ * <p>Internal server error.</p>
42
+ *
43
+ * @throws {@link InvalidInputException} (client fault)
44
+ * <p>The request was rejected because an invalid or out-of-range value was supplied for an
45
+ * input parameter.</p>
46
+ *
47
+ * @throws {@link NoSuchEntityException} (client fault)
48
+ * <p>The request was rejected because it referenced an entity that does not exist. The
49
+ * error code describes the entity.</p>
50
+ *
51
+ * @throws {@link ServiceTemporarilyUnavailableException} (server fault)
52
+ * <p>The serice is temporary unavailable.</p>
53
+ *
54
+ *
55
+ * @example Delete assessment run
56
+ * ```javascript
57
+ * // Deletes the assessment run that is specified by the ARN of the assessment run.
58
+ * const input = {
59
+ * "assessmentRunArn": "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-it5r2S4T/run/0-11LMTAVe"
60
+ * };
61
+ * const command = new DeleteAssessmentRunCommand(input);
62
+ * await client.send(command);
63
+ * // example id: delete-assessment-run-1481064251629
64
+ * ```
65
+ *
33
66
  */
34
67
  export declare class DeleteAssessmentRunCommand extends $Command<DeleteAssessmentRunCommandInput, DeleteAssessmentRunCommandOutput, InspectorClientResolvedConfig> {
35
68
  readonly input: DeleteAssessmentRunCommandInput;
@@ -30,6 +30,39 @@ export interface DeleteAssessmentTargetCommandOutput extends __MetadataBearer {
30
30
  * @see {@link DeleteAssessmentTargetCommandOutput} for command's `response` shape.
31
31
  * @see {@link InspectorClientResolvedConfig | config} for InspectorClient's `config` shape.
32
32
  *
33
+ * @throws {@link AccessDeniedException} (client fault)
34
+ * <p>You do not have required permissions to access the requested resource.</p>
35
+ *
36
+ * @throws {@link AssessmentRunInProgressException} (client fault)
37
+ * <p>You cannot perform a specified action if an assessment run is currently in
38
+ * progress.</p>
39
+ *
40
+ * @throws {@link InternalException} (server fault)
41
+ * <p>Internal server error.</p>
42
+ *
43
+ * @throws {@link InvalidInputException} (client fault)
44
+ * <p>The request was rejected because an invalid or out-of-range value was supplied for an
45
+ * input parameter.</p>
46
+ *
47
+ * @throws {@link NoSuchEntityException} (client fault)
48
+ * <p>The request was rejected because it referenced an entity that does not exist. The
49
+ * error code describes the entity.</p>
50
+ *
51
+ * @throws {@link ServiceTemporarilyUnavailableException} (server fault)
52
+ * <p>The serice is temporary unavailable.</p>
53
+ *
54
+ *
55
+ * @example Delete assessment target
56
+ * ```javascript
57
+ * // Deletes the assessment target that is specified by the ARN of the assessment target.
58
+ * const input = {
59
+ * "assessmentTargetArn": "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq"
60
+ * };
61
+ * const command = new DeleteAssessmentTargetCommand(input);
62
+ * await client.send(command);
63
+ * // example id: delete-assessment-target-1481064309029
64
+ * ```
65
+ *
33
66
  */
34
67
  export declare class DeleteAssessmentTargetCommand extends $Command<DeleteAssessmentTargetCommandInput, DeleteAssessmentTargetCommandOutput, InspectorClientResolvedConfig> {
35
68
  readonly input: DeleteAssessmentTargetCommandInput;
@@ -30,6 +30,39 @@ export interface DeleteAssessmentTemplateCommandOutput extends __MetadataBearer
30
30
  * @see {@link DeleteAssessmentTemplateCommandOutput} for command's `response` shape.
31
31
  * @see {@link InspectorClientResolvedConfig | config} for InspectorClient's `config` shape.
32
32
  *
33
+ * @throws {@link AccessDeniedException} (client fault)
34
+ * <p>You do not have required permissions to access the requested resource.</p>
35
+ *
36
+ * @throws {@link AssessmentRunInProgressException} (client fault)
37
+ * <p>You cannot perform a specified action if an assessment run is currently in
38
+ * progress.</p>
39
+ *
40
+ * @throws {@link InternalException} (server fault)
41
+ * <p>Internal server error.</p>
42
+ *
43
+ * @throws {@link InvalidInputException} (client fault)
44
+ * <p>The request was rejected because an invalid or out-of-range value was supplied for an
45
+ * input parameter.</p>
46
+ *
47
+ * @throws {@link NoSuchEntityException} (client fault)
48
+ * <p>The request was rejected because it referenced an entity that does not exist. The
49
+ * error code describes the entity.</p>
50
+ *
51
+ * @throws {@link ServiceTemporarilyUnavailableException} (server fault)
52
+ * <p>The serice is temporary unavailable.</p>
53
+ *
54
+ *
55
+ * @example Delete assessment template
56
+ * ```javascript
57
+ * // Deletes the assessment template that is specified by the ARN of the assessment template.
58
+ * const input = {
59
+ * "assessmentTemplateArn": "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-it5r2S4T"
60
+ * };
61
+ * const command = new DeleteAssessmentTemplateCommand(input);
62
+ * await client.send(command);
63
+ * // example id: delete-assessment-template-1481064364074
64
+ * ```
65
+ *
33
66
  */
34
67
  export declare class DeleteAssessmentTemplateCommand extends $Command<DeleteAssessmentTemplateCommandInput, DeleteAssessmentTemplateCommandOutput, InspectorClientResolvedConfig> {
35
68
  readonly input: DeleteAssessmentTemplateCommandInput;
@@ -30,6 +30,92 @@ export interface DescribeAssessmentRunsCommandOutput extends DescribeAssessmentR
30
30
  * @see {@link DescribeAssessmentRunsCommandOutput} for command's `response` shape.
31
31
  * @see {@link InspectorClientResolvedConfig | config} for InspectorClient's `config` shape.
32
32
  *
33
+ * @throws {@link InternalException} (server fault)
34
+ * <p>Internal server error.</p>
35
+ *
36
+ * @throws {@link InvalidInputException} (client fault)
37
+ * <p>The request was rejected because an invalid or out-of-range value was supplied for an
38
+ * input parameter.</p>
39
+ *
40
+ *
41
+ * @example Describte assessment runs
42
+ * ```javascript
43
+ * // Describes the assessment runs that are specified by the ARNs of the assessment runs.
44
+ * const input = {
45
+ * "assessmentRunArns": [
46
+ * "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE"
47
+ * ]
48
+ * };
49
+ * const command = new DescribeAssessmentRunsCommand(input);
50
+ * const response = await client.send(command);
51
+ * /* response ==
52
+ * {
53
+ * "assessmentRuns": [
54
+ * {
55
+ * "name": "Run 1 for ExampleAssessmentTemplate",
56
+ * "arn": "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE",
57
+ * "assessmentTemplateArn": "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw",
58
+ * "completedAt": "1458680301.4",
59
+ * "createdAt": "1458680170.035",
60
+ * "dataCollected": true,
61
+ * "durationInSeconds": 3600,
62
+ * "findingCounts": {
63
+ * "High": 14,
64
+ * "Informational": 0,
65
+ * "Low": 0,
66
+ * "Medium": 2,
67
+ * "Undefined": 0
68
+ * },
69
+ * "notifications": [],
70
+ * "rulesPackageArns": [
71
+ * "arn:aws:inspector:us-west-2:758058086616:rulespackage/0-X1KXtawP"
72
+ * ],
73
+ * "startedAt": "1458680170.161",
74
+ * "state": "COMPLETED",
75
+ * "stateChangedAt": "1458680301.4",
76
+ * "stateChanges": [
77
+ * {
78
+ * "state": "CREATED",
79
+ * "stateChangedAt": "1458680170.035"
80
+ * },
81
+ * {
82
+ * "state": "START_DATA_COLLECTION_PENDING",
83
+ * "stateChangedAt": "1458680170.065"
84
+ * },
85
+ * {
86
+ * "state": "START_DATA_COLLECTION_IN_PROGRESS",
87
+ * "stateChangedAt": "1458680170.096"
88
+ * },
89
+ * {
90
+ * "state": "COLLECTING_DATA",
91
+ * "stateChangedAt": "1458680170.161"
92
+ * },
93
+ * {
94
+ * "state": "STOP_DATA_COLLECTION_PENDING",
95
+ * "stateChangedAt": "1458680239.883"
96
+ * },
97
+ * {
98
+ * "state": "DATA_COLLECTED",
99
+ * "stateChangedAt": "1458680299.847"
100
+ * },
101
+ * {
102
+ * "state": "EVALUATING_RULES",
103
+ * "stateChangedAt": "1458680300.099"
104
+ * },
105
+ * {
106
+ * "state": "COMPLETED",
107
+ * "stateChangedAt": "1458680301.4"
108
+ * }
109
+ * ],
110
+ * "userAttributesForFindings": []
111
+ * }
112
+ * ],
113
+ * "failedItems": {}
114
+ * }
115
+ * *\/
116
+ * // example id: describte-assessment-runs-1481064424352
117
+ * ```
118
+ *
33
119
  */
34
120
  export declare class DescribeAssessmentRunsCommand extends $Command<DescribeAssessmentRunsCommandInput, DescribeAssessmentRunsCommandOutput, InspectorClientResolvedConfig> {
35
121
  readonly input: DescribeAssessmentRunsCommandInput;
@@ -30,6 +30,41 @@ export interface DescribeAssessmentTargetsCommandOutput extends DescribeAssessme
30
30
  * @see {@link DescribeAssessmentTargetsCommandOutput} for command's `response` shape.
31
31
  * @see {@link InspectorClientResolvedConfig | config} for InspectorClient's `config` shape.
32
32
  *
33
+ * @throws {@link InternalException} (server fault)
34
+ * <p>Internal server error.</p>
35
+ *
36
+ * @throws {@link InvalidInputException} (client fault)
37
+ * <p>The request was rejected because an invalid or out-of-range value was supplied for an
38
+ * input parameter.</p>
39
+ *
40
+ *
41
+ * @example Describte assessment targets
42
+ * ```javascript
43
+ * // Describes the assessment targets that are specified by the ARNs of the assessment targets.
44
+ * const input = {
45
+ * "assessmentTargetArns": [
46
+ * "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq"
47
+ * ]
48
+ * };
49
+ * const command = new DescribeAssessmentTargetsCommand(input);
50
+ * const response = await client.send(command);
51
+ * /* response ==
52
+ * {
53
+ * "assessmentTargets": [
54
+ * {
55
+ * "name": "ExampleAssessmentTarget",
56
+ * "arn": "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq",
57
+ * "createdAt": "1458074191.459",
58
+ * "resourceGroupArn": "arn:aws:inspector:us-west-2:123456789012:resourcegroup/0-PyGXopAI",
59
+ * "updatedAt": "1458074191.459"
60
+ * }
61
+ * ],
62
+ * "failedItems": {}
63
+ * }
64
+ * *\/
65
+ * // example id: describte-assessment-targets-1481064527735
66
+ * ```
67
+ *
33
68
  */
34
69
  export declare class DescribeAssessmentTargetsCommand extends $Command<DescribeAssessmentTargetsCommandInput, DescribeAssessmentTargetsCommandOutput, InspectorClientResolvedConfig> {
35
70
  readonly input: DescribeAssessmentTargetsCommandInput;
@@ -30,6 +30,46 @@ export interface DescribeAssessmentTemplatesCommandOutput extends DescribeAssess
30
30
  * @see {@link DescribeAssessmentTemplatesCommandOutput} for command's `response` shape.
31
31
  * @see {@link InspectorClientResolvedConfig | config} for InspectorClient's `config` shape.
32
32
  *
33
+ * @throws {@link InternalException} (server fault)
34
+ * <p>Internal server error.</p>
35
+ *
36
+ * @throws {@link InvalidInputException} (client fault)
37
+ * <p>The request was rejected because an invalid or out-of-range value was supplied for an
38
+ * input parameter.</p>
39
+ *
40
+ *
41
+ * @example Describte assessment templates
42
+ * ```javascript
43
+ * // Describes the assessment templates that are specified by the ARNs of the assessment templates.
44
+ * const input = {
45
+ * "assessmentTemplateArns": [
46
+ * "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw"
47
+ * ]
48
+ * };
49
+ * const command = new DescribeAssessmentTemplatesCommand(input);
50
+ * const response = await client.send(command);
51
+ * /* response ==
52
+ * {
53
+ * "assessmentTemplates": [
54
+ * {
55
+ * "name": "ExampleAssessmentTemplate",
56
+ * "arn": "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw",
57
+ * "assessmentRunCount": 0,
58
+ * "assessmentTargetArn": "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq",
59
+ * "createdAt": "1458074191.844",
60
+ * "durationInSeconds": 3600,
61
+ * "rulesPackageArns": [
62
+ * "arn:aws:inspector:us-west-2:758058086616:rulespackage/0-X1KXtawP"
63
+ * ],
64
+ * "userAttributesForFindings": []
65
+ * }
66
+ * ],
67
+ * "failedItems": {}
68
+ * }
69
+ * *\/
70
+ * // example id: describte-assessment-templates-1481064606829
71
+ * ```
72
+ *
33
73
  */
34
74
  export declare class DescribeAssessmentTemplatesCommand extends $Command<DescribeAssessmentTemplatesCommandInput, DescribeAssessmentTemplatesCommandOutput, InspectorClientResolvedConfig> {
35
75
  readonly input: DescribeAssessmentTemplatesCommandInput;
@@ -30,6 +30,26 @@ export interface DescribeCrossAccountAccessRoleCommandOutput extends DescribeCro
30
30
  * @see {@link DescribeCrossAccountAccessRoleCommandOutput} for command's `response` shape.
31
31
  * @see {@link InspectorClientResolvedConfig | config} for InspectorClient's `config` shape.
32
32
  *
33
+ * @throws {@link InternalException} (server fault)
34
+ * <p>Internal server error.</p>
35
+ *
36
+ *
37
+ * @example Describte cross account access role
38
+ * ```javascript
39
+ * // Describes the IAM role that enables Amazon Inspector to access your AWS account.
40
+ * const input = undefined;
41
+ * const command = new DescribeCrossAccountAccessRoleCommand(input);
42
+ * const response = await client.send(command);
43
+ * /* response ==
44
+ * {
45
+ * "registeredAt": "1458069182.826",
46
+ * "roleArn": "arn:aws:iam::123456789012:role/inspector",
47
+ * "valid": true
48
+ * }
49
+ * *\/
50
+ * // example id: describte-cross-account-access-role-1481064682267
51
+ * ```
52
+ *
33
53
  */
34
54
  export declare class DescribeCrossAccountAccessRoleCommand extends $Command<DescribeCrossAccountAccessRoleCommandInput, DescribeCrossAccountAccessRoleCommandOutput, InspectorClientResolvedConfig> {
35
55
  readonly input: DescribeCrossAccountAccessRoleCommandInput;
@@ -29,6 +29,14 @@ export interface DescribeExclusionsCommandOutput extends DescribeExclusionsRespo
29
29
  * @see {@link DescribeExclusionsCommandOutput} for command's `response` shape.
30
30
  * @see {@link InspectorClientResolvedConfig | config} for InspectorClient's `config` shape.
31
31
  *
32
+ * @throws {@link InternalException} (server fault)
33
+ * <p>Internal server error.</p>
34
+ *
35
+ * @throws {@link InvalidInputException} (client fault)
36
+ * <p>The request was rejected because an invalid or out-of-range value was supplied for an
37
+ * input parameter.</p>
38
+ *
39
+ *
32
40
  */
33
41
  export declare class DescribeExclusionsCommand extends $Command<DescribeExclusionsCommandInput, DescribeExclusionsCommandOutput, InspectorClientResolvedConfig> {
34
42
  readonly input: DescribeExclusionsCommandInput;
@@ -29,6 +29,60 @@ export interface DescribeFindingsCommandOutput extends DescribeFindingsResponse,
29
29
  * @see {@link DescribeFindingsCommandOutput} for command's `response` shape.
30
30
  * @see {@link InspectorClientResolvedConfig | config} for InspectorClient's `config` shape.
31
31
  *
32
+ * @throws {@link InternalException} (server fault)
33
+ * <p>Internal server error.</p>
34
+ *
35
+ * @throws {@link InvalidInputException} (client fault)
36
+ * <p>The request was rejected because an invalid or out-of-range value was supplied for an
37
+ * input parameter.</p>
38
+ *
39
+ *
40
+ * @example Describe findings
41
+ * ```javascript
42
+ * // Describes the findings that are specified by the ARNs of the findings.
43
+ * const input = {
44
+ * "findingArns": [
45
+ * "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE/finding/0-HwPnsDm4"
46
+ * ]
47
+ * };
48
+ * const command = new DescribeFindingsCommand(input);
49
+ * const response = await client.send(command);
50
+ * /* response ==
51
+ * {
52
+ * "failedItems": {},
53
+ * "findings": [
54
+ * {
55
+ * "arn": "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE/finding/0-HwPnsDm4",
56
+ * "assetAttributes": {
57
+ * "ipv4Addresses": [],
58
+ * "schemaVersion": 1
59
+ * },
60
+ * "assetType": "ec2-instance",
61
+ * "attributes": [],
62
+ * "confidence": 10,
63
+ * "createdAt": "1458680301.37",
64
+ * "description": "Amazon Inspector did not find any potential security issues during this assessment.",
65
+ * "indicatorOfCompromise": false,
66
+ * "numericSeverity": 0,
67
+ * "recommendation": "No remediation needed.",
68
+ * "schemaVersion": 1,
69
+ * "service": "Inspector",
70
+ * "serviceAttributes": {
71
+ * "assessmentRunArn": "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE",
72
+ * "rulesPackageArn": "arn:aws:inspector:us-west-2:758058086616:rulespackage/0-X1KXtawP",
73
+ * "schemaVersion": 1
74
+ * },
75
+ * "severity": "Informational",
76
+ * "title": "No potential security issues found",
77
+ * "updatedAt": "1458680301.37",
78
+ * "userAttributes": []
79
+ * }
80
+ * ]
81
+ * }
82
+ * *\/
83
+ * // example id: describte-findings-1481064771803
84
+ * ```
85
+ *
32
86
  */
33
87
  export declare class DescribeFindingsCommand extends $Command<DescribeFindingsCommandInput, DescribeFindingsCommandOutput, InspectorClientResolvedConfig> {
34
88
  readonly input: DescribeFindingsCommandInput;