@aws-sdk/client-inspector 3.288.0 → 3.289.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 (33) hide show
  1. package/dist-types/commands/AddAttributesToFindingsCommand.d.ts +24 -0
  2. package/dist-types/commands/CreateAssessmentTargetCommand.d.ts +17 -0
  3. package/dist-types/commands/CreateAssessmentTemplateCommand.d.ts +27 -0
  4. package/dist-types/commands/CreateResourceGroupCommand.d.ts +21 -0
  5. package/dist-types/commands/DeleteAssessmentRunCommand.d.ts +11 -0
  6. package/dist-types/commands/DeleteAssessmentTargetCommand.d.ts +11 -0
  7. package/dist-types/commands/DeleteAssessmentTemplateCommand.d.ts +11 -0
  8. package/dist-types/commands/DescribeAssessmentRunsCommand.d.ts +78 -0
  9. package/dist-types/commands/DescribeAssessmentTargetsCommand.d.ts +27 -0
  10. package/dist-types/commands/DescribeAssessmentTemplatesCommand.d.ts +32 -0
  11. package/dist-types/commands/DescribeCrossAccountAccessRoleCommand.d.ts +16 -0
  12. package/dist-types/commands/DescribeFindingsCommand.d.ts +46 -0
  13. package/dist-types/commands/DescribeResourceGroupsCommand.d.ts +30 -0
  14. package/dist-types/commands/DescribeRulesPackagesCommand.d.ts +27 -0
  15. package/dist-types/commands/GetTelemetryMetadataCommand.d.ts +162 -0
  16. package/dist-types/commands/ListAssessmentRunAgentsCommand.d.ts +172 -0
  17. package/dist-types/commands/ListAssessmentRunsCommand.d.ts +23 -0
  18. package/dist-types/commands/ListAssessmentTargetsCommand.d.ts +19 -0
  19. package/dist-types/commands/ListAssessmentTemplatesCommand.d.ts +23 -0
  20. package/dist-types/commands/ListEventSubscriptionsCommand.d.ts +29 -0
  21. package/dist-types/commands/ListFindingsCommand.d.ts +23 -0
  22. package/dist-types/commands/ListRulesPackagesCommand.d.ts +22 -0
  23. package/dist-types/commands/ListTagsForResourceCommand.d.ts +21 -0
  24. package/dist-types/commands/PreviewAgentsCommand.d.ts +22 -0
  25. package/dist-types/commands/RegisterCrossAccountAccessRoleCommand.d.ts +11 -0
  26. package/dist-types/commands/RemoveAttributesFromFindingsCommand.d.ts +21 -0
  27. package/dist-types/commands/SetTagsForResourceCommand.d.ts +17 -0
  28. package/dist-types/commands/StartAssessmentRunCommand.d.ts +17 -0
  29. package/dist-types/commands/StopAssessmentRunCommand.d.ts +11 -0
  30. package/dist-types/commands/SubscribeToEventCommand.d.ts +13 -0
  31. package/dist-types/commands/UnsubscribeFromEventCommand.d.ts +13 -0
  32. package/dist-types/commands/UpdateAssessmentTargetCommand.d.ts +13 -0
  33. package/package.json +29 -29
@@ -30,6 +30,30 @@ 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
+ * @example Add attributes to findings
34
+ * ```javascript
35
+ * // Assigns attributes (key and value pairs) to the findings that are specified by the ARNs of the findings.
36
+ * const input = {
37
+ * "attributes": [
38
+ * {
39
+ * "key": "Example",
40
+ * "value": "example"
41
+ * }
42
+ * ],
43
+ * "findingArns": [
44
+ * "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-8l1VIE0D/run/0-Z02cjjug/finding/0-T8yM9mEU"
45
+ * ]
46
+ * };
47
+ * const command = new AddAttributesToFindingsCommand(input);
48
+ * const response = await client.send(command);
49
+ * /* response ==
50
+ * {
51
+ * "failedItems": {}
52
+ * }
53
+ * *\/
54
+ * // example id: add-attributes-to-findings-1481063856401
55
+ * ```
56
+ *
33
57
  */
34
58
  export declare class AddAttributesToFindingsCommand extends $Command<AddAttributesToFindingsCommandInput, AddAttributesToFindingsCommandOutput, InspectorClientResolvedConfig> {
35
59
  readonly input: AddAttributesToFindingsCommandInput;
@@ -36,6 +36,23 @@ 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
+ * @example Create assessment target
40
+ * ```javascript
41
+ * // 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.
42
+ * const input = {
43
+ * "assessmentTargetName": "ExampleAssessmentTarget",
44
+ * "resourceGroupArn": "arn:aws:inspector:us-west-2:123456789012:resourcegroup/0-AB6DMKnv"
45
+ * };
46
+ * const command = new CreateAssessmentTargetCommand(input);
47
+ * const response = await client.send(command);
48
+ * /* response ==
49
+ * {
50
+ * "assessmentTargetArn": "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX"
51
+ * }
52
+ * *\/
53
+ * // example id: create-assessment-target-1481063953657
54
+ * ```
55
+ *
39
56
  */
40
57
  export declare class CreateAssessmentTargetCommand extends $Command<CreateAssessmentTargetCommandInput, CreateAssessmentTargetCommandOutput, InspectorClientResolvedConfig> {
41
58
  readonly input: CreateAssessmentTargetCommandInput;
@@ -32,6 +32,33 @@ 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
+ * @example Create assessment template
36
+ * ```javascript
37
+ * // Creates an assessment template for the assessment target that is specified by the ARN of the assessment target.
38
+ * const input = {
39
+ * "assessmentTargetArn": "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX",
40
+ * "assessmentTemplateName": "ExampleAssessmentTemplate",
41
+ * "durationInSeconds": 180,
42
+ * "rulesPackageArns": [
43
+ * "arn:aws:inspector:us-west-2:758058086616:rulespackage/0-11B9DBXp"
44
+ * ],
45
+ * "userAttributesForFindings": [
46
+ * {
47
+ * "key": "Example",
48
+ * "value": "example"
49
+ * }
50
+ * ]
51
+ * };
52
+ * const command = new CreateAssessmentTemplateCommand(input);
53
+ * const response = await client.send(command);
54
+ * /* response ==
55
+ * {
56
+ * "assessmentTemplateArn": "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-it5r2S4T"
57
+ * }
58
+ * *\/
59
+ * // example id: create-assessment-template-1481064046719
60
+ * ```
61
+ *
35
62
  */
36
63
  export declare class CreateAssessmentTemplateCommand extends $Command<CreateAssessmentTemplateCommandInput, CreateAssessmentTemplateCommandOutput, InspectorClientResolvedConfig> {
37
64
  readonly input: CreateAssessmentTemplateCommandInput;
@@ -32,6 +32,27 @@ 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
+ * @example Create resource group
36
+ * ```javascript
37
+ * // 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.
38
+ * const input = {
39
+ * "resourceGroupTags": [
40
+ * {
41
+ * "key": "Name",
42
+ * "value": "example"
43
+ * }
44
+ * ]
45
+ * };
46
+ * const command = new CreateResourceGroupCommand(input);
47
+ * const response = await client.send(command);
48
+ * /* response ==
49
+ * {
50
+ * "resourceGroupArn": "arn:aws:inspector:us-west-2:123456789012:resourcegroup/0-AB6DMKnv"
51
+ * }
52
+ * *\/
53
+ * // example id: create-resource-group-1481064169037
54
+ * ```
55
+ *
35
56
  */
36
57
  export declare class CreateResourceGroupCommand extends $Command<CreateResourceGroupCommandInput, CreateResourceGroupCommandOutput, InspectorClientResolvedConfig> {
37
58
  readonly input: CreateResourceGroupCommandInput;
@@ -30,6 +30,17 @@ 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
+ * @example Delete assessment run
34
+ * ```javascript
35
+ * // Deletes the assessment run that is specified by the ARN of the assessment run.
36
+ * const input = {
37
+ * "assessmentRunArn": "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-it5r2S4T/run/0-11LMTAVe"
38
+ * };
39
+ * const command = new DeleteAssessmentRunCommand(input);
40
+ * await client.send(command);
41
+ * // example id: delete-assessment-run-1481064251629
42
+ * ```
43
+ *
33
44
  */
34
45
  export declare class DeleteAssessmentRunCommand extends $Command<DeleteAssessmentRunCommandInput, DeleteAssessmentRunCommandOutput, InspectorClientResolvedConfig> {
35
46
  readonly input: DeleteAssessmentRunCommandInput;
@@ -30,6 +30,17 @@ 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
+ * @example Delete assessment target
34
+ * ```javascript
35
+ * // Deletes the assessment target that is specified by the ARN of the assessment target.
36
+ * const input = {
37
+ * "assessmentTargetArn": "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq"
38
+ * };
39
+ * const command = new DeleteAssessmentTargetCommand(input);
40
+ * await client.send(command);
41
+ * // example id: delete-assessment-target-1481064309029
42
+ * ```
43
+ *
33
44
  */
34
45
  export declare class DeleteAssessmentTargetCommand extends $Command<DeleteAssessmentTargetCommandInput, DeleteAssessmentTargetCommandOutput, InspectorClientResolvedConfig> {
35
46
  readonly input: DeleteAssessmentTargetCommandInput;
@@ -30,6 +30,17 @@ 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
+ * @example Delete assessment template
34
+ * ```javascript
35
+ * // Deletes the assessment template that is specified by the ARN of the assessment template.
36
+ * const input = {
37
+ * "assessmentTemplateArn": "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-it5r2S4T"
38
+ * };
39
+ * const command = new DeleteAssessmentTemplateCommand(input);
40
+ * await client.send(command);
41
+ * // example id: delete-assessment-template-1481064364074
42
+ * ```
43
+ *
33
44
  */
34
45
  export declare class DeleteAssessmentTemplateCommand extends $Command<DeleteAssessmentTemplateCommandInput, DeleteAssessmentTemplateCommandOutput, InspectorClientResolvedConfig> {
35
46
  readonly input: DeleteAssessmentTemplateCommandInput;
@@ -30,6 +30,84 @@ 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
+ * @example Describte assessment runs
34
+ * ```javascript
35
+ * // Describes the assessment runs that are specified by the ARNs of the assessment runs.
36
+ * const input = {
37
+ * "assessmentRunArns": [
38
+ * "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE"
39
+ * ]
40
+ * };
41
+ * const command = new DescribeAssessmentRunsCommand(input);
42
+ * const response = await client.send(command);
43
+ * /* response ==
44
+ * {
45
+ * "assessmentRuns": [
46
+ * {
47
+ * "name": "Run 1 for ExampleAssessmentTemplate",
48
+ * "arn": "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE",
49
+ * "assessmentTemplateArn": "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw",
50
+ * "completedAt": "1458680301.4",
51
+ * "createdAt": "1458680170.035",
52
+ * "dataCollected": true,
53
+ * "durationInSeconds": 3600,
54
+ * "findingCounts": {
55
+ * "High": 14,
56
+ * "Informational": 0,
57
+ * "Low": 0,
58
+ * "Medium": 2,
59
+ * "Undefined": 0
60
+ * },
61
+ * "notifications": [],
62
+ * "rulesPackageArns": [
63
+ * "arn:aws:inspector:us-west-2:758058086616:rulespackage/0-X1KXtawP"
64
+ * ],
65
+ * "startedAt": "1458680170.161",
66
+ * "state": "COMPLETED",
67
+ * "stateChangedAt": "1458680301.4",
68
+ * "stateChanges": [
69
+ * {
70
+ * "state": "CREATED",
71
+ * "stateChangedAt": "1458680170.035"
72
+ * },
73
+ * {
74
+ * "state": "START_DATA_COLLECTION_PENDING",
75
+ * "stateChangedAt": "1458680170.065"
76
+ * },
77
+ * {
78
+ * "state": "START_DATA_COLLECTION_IN_PROGRESS",
79
+ * "stateChangedAt": "1458680170.096"
80
+ * },
81
+ * {
82
+ * "state": "COLLECTING_DATA",
83
+ * "stateChangedAt": "1458680170.161"
84
+ * },
85
+ * {
86
+ * "state": "STOP_DATA_COLLECTION_PENDING",
87
+ * "stateChangedAt": "1458680239.883"
88
+ * },
89
+ * {
90
+ * "state": "DATA_COLLECTED",
91
+ * "stateChangedAt": "1458680299.847"
92
+ * },
93
+ * {
94
+ * "state": "EVALUATING_RULES",
95
+ * "stateChangedAt": "1458680300.099"
96
+ * },
97
+ * {
98
+ * "state": "COMPLETED",
99
+ * "stateChangedAt": "1458680301.4"
100
+ * }
101
+ * ],
102
+ * "userAttributesForFindings": []
103
+ * }
104
+ * ],
105
+ * "failedItems": {}
106
+ * }
107
+ * *\/
108
+ * // example id: describte-assessment-runs-1481064424352
109
+ * ```
110
+ *
33
111
  */
34
112
  export declare class DescribeAssessmentRunsCommand extends $Command<DescribeAssessmentRunsCommandInput, DescribeAssessmentRunsCommandOutput, InspectorClientResolvedConfig> {
35
113
  readonly input: DescribeAssessmentRunsCommandInput;
@@ -30,6 +30,33 @@ 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
+ * @example Describte assessment targets
34
+ * ```javascript
35
+ * // Describes the assessment targets that are specified by the ARNs of the assessment targets.
36
+ * const input = {
37
+ * "assessmentTargetArns": [
38
+ * "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq"
39
+ * ]
40
+ * };
41
+ * const command = new DescribeAssessmentTargetsCommand(input);
42
+ * const response = await client.send(command);
43
+ * /* response ==
44
+ * {
45
+ * "assessmentTargets": [
46
+ * {
47
+ * "name": "ExampleAssessmentTarget",
48
+ * "arn": "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq",
49
+ * "createdAt": "1458074191.459",
50
+ * "resourceGroupArn": "arn:aws:inspector:us-west-2:123456789012:resourcegroup/0-PyGXopAI",
51
+ * "updatedAt": "1458074191.459"
52
+ * }
53
+ * ],
54
+ * "failedItems": {}
55
+ * }
56
+ * *\/
57
+ * // example id: describte-assessment-targets-1481064527735
58
+ * ```
59
+ *
33
60
  */
34
61
  export declare class DescribeAssessmentTargetsCommand extends $Command<DescribeAssessmentTargetsCommandInput, DescribeAssessmentTargetsCommandOutput, InspectorClientResolvedConfig> {
35
62
  readonly input: DescribeAssessmentTargetsCommandInput;
@@ -30,6 +30,38 @@ 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
+ * @example Describte assessment templates
34
+ * ```javascript
35
+ * // Describes the assessment templates that are specified by the ARNs of the assessment templates.
36
+ * const input = {
37
+ * "assessmentTemplateArns": [
38
+ * "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw"
39
+ * ]
40
+ * };
41
+ * const command = new DescribeAssessmentTemplatesCommand(input);
42
+ * const response = await client.send(command);
43
+ * /* response ==
44
+ * {
45
+ * "assessmentTemplates": [
46
+ * {
47
+ * "name": "ExampleAssessmentTemplate",
48
+ * "arn": "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw",
49
+ * "assessmentRunCount": 0,
50
+ * "assessmentTargetArn": "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq",
51
+ * "createdAt": "1458074191.844",
52
+ * "durationInSeconds": 3600,
53
+ * "rulesPackageArns": [
54
+ * "arn:aws:inspector:us-west-2:758058086616:rulespackage/0-X1KXtawP"
55
+ * ],
56
+ * "userAttributesForFindings": []
57
+ * }
58
+ * ],
59
+ * "failedItems": {}
60
+ * }
61
+ * *\/
62
+ * // example id: describte-assessment-templates-1481064606829
63
+ * ```
64
+ *
33
65
  */
34
66
  export declare class DescribeAssessmentTemplatesCommand extends $Command<DescribeAssessmentTemplatesCommandInput, DescribeAssessmentTemplatesCommandOutput, InspectorClientResolvedConfig> {
35
67
  readonly input: DescribeAssessmentTemplatesCommandInput;
@@ -30,6 +30,22 @@ 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
+ * @example Describte cross account access role
34
+ * ```javascript
35
+ * // Describes the IAM role that enables Amazon Inspector to access your AWS account.
36
+ * const input = undefined;
37
+ * const command = new DescribeCrossAccountAccessRoleCommand(input);
38
+ * const response = await client.send(command);
39
+ * /* response ==
40
+ * {
41
+ * "registeredAt": "1458069182.826",
42
+ * "roleArn": "arn:aws:iam::123456789012:role/inspector",
43
+ * "valid": true
44
+ * }
45
+ * *\/
46
+ * // example id: describte-cross-account-access-role-1481064682267
47
+ * ```
48
+ *
33
49
  */
34
50
  export declare class DescribeCrossAccountAccessRoleCommand extends $Command<DescribeCrossAccountAccessRoleCommandInput, DescribeCrossAccountAccessRoleCommandOutput, InspectorClientResolvedConfig> {
35
51
  readonly input: DescribeCrossAccountAccessRoleCommandInput;
@@ -29,6 +29,52 @@ 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
+ * @example Describe findings
33
+ * ```javascript
34
+ * // Describes the findings that are specified by the ARNs of the findings.
35
+ * const input = {
36
+ * "findingArns": [
37
+ * "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE/finding/0-HwPnsDm4"
38
+ * ]
39
+ * };
40
+ * const command = new DescribeFindingsCommand(input);
41
+ * const response = await client.send(command);
42
+ * /* response ==
43
+ * {
44
+ * "failedItems": {},
45
+ * "findings": [
46
+ * {
47
+ * "arn": "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE/finding/0-HwPnsDm4",
48
+ * "assetAttributes": {
49
+ * "ipv4Addresses": [],
50
+ * "schemaVersion": 1
51
+ * },
52
+ * "assetType": "ec2-instance",
53
+ * "attributes": [],
54
+ * "confidence": 10,
55
+ * "createdAt": "1458680301.37",
56
+ * "description": "Amazon Inspector did not find any potential security issues during this assessment.",
57
+ * "indicatorOfCompromise": false,
58
+ * "numericSeverity": 0,
59
+ * "recommendation": "No remediation needed.",
60
+ * "schemaVersion": 1,
61
+ * "service": "Inspector",
62
+ * "serviceAttributes": {
63
+ * "assessmentRunArn": "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE",
64
+ * "rulesPackageArn": "arn:aws:inspector:us-west-2:758058086616:rulespackage/0-X1KXtawP",
65
+ * "schemaVersion": 1
66
+ * },
67
+ * "severity": "Informational",
68
+ * "title": "No potential security issues found",
69
+ * "updatedAt": "1458680301.37",
70
+ * "userAttributes": []
71
+ * }
72
+ * ]
73
+ * }
74
+ * *\/
75
+ * // example id: describte-findings-1481064771803
76
+ * ```
77
+ *
32
78
  */
33
79
  export declare class DescribeFindingsCommand extends $Command<DescribeFindingsCommandInput, DescribeFindingsCommandOutput, InspectorClientResolvedConfig> {
34
80
  readonly input: DescribeFindingsCommandInput;
@@ -30,6 +30,36 @@ export interface DescribeResourceGroupsCommandOutput extends DescribeResourceGro
30
30
  * @see {@link DescribeResourceGroupsCommandOutput} for command's `response` shape.
31
31
  * @see {@link InspectorClientResolvedConfig | config} for InspectorClient's `config` shape.
32
32
  *
33
+ * @example Describe resource groups
34
+ * ```javascript
35
+ * // Describes the resource groups that are specified by the ARNs of the resource groups.
36
+ * const input = {
37
+ * "resourceGroupArns": [
38
+ * "arn:aws:inspector:us-west-2:123456789012:resourcegroup/0-PyGXopAI"
39
+ * ]
40
+ * };
41
+ * const command = new DescribeResourceGroupsCommand(input);
42
+ * const response = await client.send(command);
43
+ * /* response ==
44
+ * {
45
+ * "failedItems": {},
46
+ * "resourceGroups": [
47
+ * {
48
+ * "arn": "arn:aws:inspector:us-west-2:123456789012:resourcegroup/0-PyGXopAI",
49
+ * "createdAt": "1458074191.098",
50
+ * "tags": [
51
+ * {
52
+ * "key": "Name",
53
+ * "value": "example"
54
+ * }
55
+ * ]
56
+ * }
57
+ * ]
58
+ * }
59
+ * *\/
60
+ * // example id: describe-resource-groups-1481065787743
61
+ * ```
62
+ *
33
63
  */
34
64
  export declare class DescribeResourceGroupsCommand extends $Command<DescribeResourceGroupsCommandInput, DescribeResourceGroupsCommandOutput, InspectorClientResolvedConfig> {
35
65
  readonly input: DescribeResourceGroupsCommandInput;
@@ -30,6 +30,33 @@ export interface DescribeRulesPackagesCommandOutput extends DescribeRulesPackage
30
30
  * @see {@link DescribeRulesPackagesCommandOutput} for command's `response` shape.
31
31
  * @see {@link InspectorClientResolvedConfig | config} for InspectorClient's `config` shape.
32
32
  *
33
+ * @example Describe rules packages
34
+ * ```javascript
35
+ * // Describes the rules packages that are specified by the ARNs of the rules packages.
36
+ * const input = {
37
+ * "rulesPackageArns": [
38
+ * "arn:aws:inspector:us-west-2:758058086616:rulespackage/0-JJOtZiqQ"
39
+ * ]
40
+ * };
41
+ * const command = new DescribeRulesPackagesCommand(input);
42
+ * const response = await client.send(command);
43
+ * /* response ==
44
+ * {
45
+ * "failedItems": {},
46
+ * "rulesPackages": [
47
+ * {
48
+ * "version": "1.1",
49
+ * "name": "Security Best Practices",
50
+ * "arn": "arn:aws:inspector:us-west-2:758058086616:rulespackage/0-JJOtZiqQ",
51
+ * "description": "The rules in this package help determine whether your systems are configured securely.",
52
+ * "provider": "Amazon Web Services, Inc."
53
+ * }
54
+ * ]
55
+ * }
56
+ * *\/
57
+ * // example id: describe-rules-packages-1481069641979
58
+ * ```
59
+ *
33
60
  */
34
61
  export declare class DescribeRulesPackagesCommand extends $Command<DescribeRulesPackagesCommandInput, DescribeRulesPackagesCommandOutput, InspectorClientResolvedConfig> {
35
62
  readonly input: DescribeRulesPackagesCommandInput;
@@ -30,6 +30,168 @@ export interface GetTelemetryMetadataCommandOutput extends GetTelemetryMetadataR
30
30
  * @see {@link GetTelemetryMetadataCommandOutput} for command's `response` shape.
31
31
  * @see {@link InspectorClientResolvedConfig | config} for InspectorClient's `config` shape.
32
32
  *
33
+ * @example Get telemetry metadata
34
+ * ```javascript
35
+ * // Information about the data that is collected for the specified assessment run.
36
+ * const input = {
37
+ * "assessmentRunArn": "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE"
38
+ * };
39
+ * const command = new GetTelemetryMetadataCommand(input);
40
+ * const response = await client.send(command);
41
+ * /* response ==
42
+ * {
43
+ * "telemetryMetadata": [
44
+ * {
45
+ * "count": 2,
46
+ * "dataSize": 345,
47
+ * "messageType": "InspectorDuplicateProcess"
48
+ * },
49
+ * {
50
+ * "count": 3,
51
+ * "dataSize": 255,
52
+ * "messageType": "InspectorTimeEventMsg"
53
+ * },
54
+ * {
55
+ * "count": 4,
56
+ * "dataSize": 1082,
57
+ * "messageType": "InspectorNetworkInterface"
58
+ * },
59
+ * {
60
+ * "count": 2,
61
+ * "dataSize": 349,
62
+ * "messageType": "InspectorDnsEntry"
63
+ * },
64
+ * {
65
+ * "count": 11,
66
+ * "dataSize": 2514,
67
+ * "messageType": "InspectorDirectoryInfoMsg"
68
+ * },
69
+ * {
70
+ * "count": 1,
71
+ * "dataSize": 179,
72
+ * "messageType": "InspectorTcpV6ListeningPort"
73
+ * },
74
+ * {
75
+ * "count": 101,
76
+ * "dataSize": 10949,
77
+ * "messageType": "InspectorTerminal"
78
+ * },
79
+ * {
80
+ * "count": 26,
81
+ * "dataSize": 5916,
82
+ * "messageType": "InspectorUser"
83
+ * },
84
+ * {
85
+ * "count": 282,
86
+ * "dataSize": 32148,
87
+ * "messageType": "InspectorDynamicallyLoadedCodeModule"
88
+ * },
89
+ * {
90
+ * "count": 18,
91
+ * "dataSize": 10172,
92
+ * "messageType": "InspectorCreateProcess"
93
+ * },
94
+ * {
95
+ * "count": 3,
96
+ * "dataSize": 8001,
97
+ * "messageType": "InspectorProcessPerformance"
98
+ * },
99
+ * {
100
+ * "count": 1,
101
+ * "dataSize": 360,
102
+ * "messageType": "InspectorOperatingSystem"
103
+ * },
104
+ * {
105
+ * "count": 6,
106
+ * "dataSize": 546,
107
+ * "messageType": "InspectorStopProcess"
108
+ * },
109
+ * {
110
+ * "count": 1,
111
+ * "dataSize": 1553,
112
+ * "messageType": "InspectorInstanceMetaData"
113
+ * },
114
+ * {
115
+ * "count": 2,
116
+ * "dataSize": 434,
117
+ * "messageType": "InspectorTcpV4Connection"
118
+ * },
119
+ * {
120
+ * "count": 474,
121
+ * "dataSize": 2960322,
122
+ * "messageType": "InspectorPackageInfo"
123
+ * },
124
+ * {
125
+ * "count": 3,
126
+ * "dataSize": 2235,
127
+ * "messageType": "InspectorSystemPerformance"
128
+ * },
129
+ * {
130
+ * "count": 105,
131
+ * "dataSize": 46048,
132
+ * "messageType": "InspectorCodeModule"
133
+ * },
134
+ * {
135
+ * "count": 1,
136
+ * "dataSize": 182,
137
+ * "messageType": "InspectorUdpV6ListeningPort"
138
+ * },
139
+ * {
140
+ * "count": 2,
141
+ * "dataSize": 371,
142
+ * "messageType": "InspectorUdpV4ListeningPort"
143
+ * },
144
+ * {
145
+ * "count": 18,
146
+ * "dataSize": 8362,
147
+ * "messageType": "InspectorKernelModule"
148
+ * },
149
+ * {
150
+ * "count": 29,
151
+ * "dataSize": 48788,
152
+ * "messageType": "InspectorConfigurationInfo"
153
+ * },
154
+ * {
155
+ * "count": 1,
156
+ * "dataSize": 79,
157
+ * "messageType": "InspectorMonitoringStart"
158
+ * },
159
+ * {
160
+ * "count": 5,
161
+ * "dataSize": 0,
162
+ * "messageType": "InspectorSplitMsgBegin"
163
+ * },
164
+ * {
165
+ * "count": 51,
166
+ * "dataSize": 4593,
167
+ * "messageType": "InspectorGroup"
168
+ * },
169
+ * {
170
+ * "count": 1,
171
+ * "dataSize": 184,
172
+ * "messageType": "InspectorTcpV4ListeningPort"
173
+ * },
174
+ * {
175
+ * "count": 1159,
176
+ * "dataSize": 3146579,
177
+ * "messageType": "Total"
178
+ * },
179
+ * {
180
+ * "count": 5,
181
+ * "dataSize": 0,
182
+ * "messageType": "InspectorSplitMsgEnd"
183
+ * },
184
+ * {
185
+ * "count": 1,
186
+ * "dataSize": 612,
187
+ * "messageType": "InspectorLoadImageInProcess"
188
+ * }
189
+ * ]
190
+ * }
191
+ * *\/
192
+ * // example id: get-telemetry-metadata-1481066021297
193
+ * ```
194
+ *
33
195
  */
34
196
  export declare class GetTelemetryMetadataCommand extends $Command<GetTelemetryMetadataCommandInput, GetTelemetryMetadataCommandOutput, InspectorClientResolvedConfig> {
35
197
  readonly input: GetTelemetryMetadataCommandInput;