@aws-sdk/client-inspector 3.775.0 → 3.782.0

package/dist-types/commands/AddAttributesToFindingsCommand.d.ts

@@ -85,31 +85,31 @@ declare const AddAttributesToFindingsCommand_base: {
  * @throws {@link InspectorServiceException}
  * <p>Base exception class for all service exceptions from Inspector service.</p>
  *
- * @public
+ *
  * @example Add attributes to findings
  * ```javascript
  * // Assigns attributes (key and value pairs) to the findings that are specified by the ARNs of the findings.
  * const input = {
- *   "attributes": [
+ *   attributes: [
  *     {
- *       "key": "Example",
- *       "value": "example"
+ *       key: "Example",
+ *       value: "example"
  *     }
  *   ],
- *   "findingArns": [
+ *   findingArns: [
  *     "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-8l1VIE0D/run/0-Z02cjjug/finding/0-T8yM9mEU"
  *   ]
  * };
  * const command = new AddAttributesToFindingsCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "failedItems": {}
+ *   failedItems:   { /* empty *\/ }
  * }
  * *\/
- * // example id: add-attributes-to-findings-1481063856401
  * ```
  *
+ * @public
  */
 export declare class AddAttributesToFindingsCommand extends AddAttributesToFindingsCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/CreateAssessmentTargetCommand.d.ts

@@ -87,24 +87,24 @@ declare const CreateAssessmentTargetCommand_base: {
  * @throws {@link InspectorServiceException}
  * <p>Base exception class for all service exceptions from Inspector service.</p>
  *
- * @public
+ *
  * @example Create assessment target
  * ```javascript
  * // 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.
  * const input = {
- *   "assessmentTargetName": "ExampleAssessmentTarget",
- *   "resourceGroupArn": "arn:aws:inspector:us-west-2:123456789012:resourcegroup/0-AB6DMKnv"
+ *   assessmentTargetName: "ExampleAssessmentTarget",
+ *   resourceGroupArn: "arn:aws:inspector:us-west-2:123456789012:resourcegroup/0-AB6DMKnv"
  * };
  * const command = new CreateAssessmentTargetCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "assessmentTargetArn": "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX"
+ *   assessmentTargetArn: "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX"
  * }
  * *\/
- * // example id: create-assessment-target-1481063953657
  * ```
  *
+ * @public
  */
 export declare class CreateAssessmentTargetCommand extends CreateAssessmentTargetCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/CreateAssessmentTemplateCommand.d.ts

@@ -89,34 +89,34 @@ declare const CreateAssessmentTemplateCommand_base: {
  * @throws {@link InspectorServiceException}
  * <p>Base exception class for all service exceptions from Inspector service.</p>
  *
- * @public
+ *
  * @example Create assessment template
  * ```javascript
  * // Creates an assessment template for the assessment target that is specified by the ARN of the assessment target.
  * const input = {
- *   "assessmentTargetArn": "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX",
- *   "assessmentTemplateName": "ExampleAssessmentTemplate",
- *   "durationInSeconds": 180,
- *   "rulesPackageArns": [
+ *   assessmentTargetArn: "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX",
+ *   assessmentTemplateName: "ExampleAssessmentTemplate",
+ *   durationInSeconds: 180,
+ *   rulesPackageArns: [
  *     "arn:aws:inspector:us-west-2:758058086616:rulespackage/0-11B9DBXp"
  *   ],
- *   "userAttributesForFindings": [
+ *   userAttributesForFindings: [
  *     {
- *       "key": "Example",
- *       "value": "example"
+ *       key: "Example",
+ *       value: "example"
  *     }
  *   ]
  * };
  * const command = new CreateAssessmentTemplateCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "assessmentTemplateArn": "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-it5r2S4T"
+ *   assessmentTemplateArn: "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-it5r2S4T"
  * }
  * *\/
- * // example id: create-assessment-template-1481064046719
  * ```
  *
+ * @public
  */
 export declare class CreateAssessmentTemplateCommand extends CreateAssessmentTemplateCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/CreateExclusionsPreviewCommand.d.ts

@@ -77,6 +77,7 @@ declare const CreateExclusionsPreviewCommand_base: {
  * @throws {@link InspectorServiceException}
  * <p>Base exception class for all service exceptions from Inspector service.</p>
  *
+ *
  * @public
  */
 export declare class CreateExclusionsPreviewCommand extends CreateExclusionsPreviewCommand_base {

package/dist-types/commands/CreateResourceGroupCommand.d.ts

@@ -79,28 +79,28 @@ declare const CreateResourceGroupCommand_base: {
  * @throws {@link InspectorServiceException}
  * <p>Base exception class for all service exceptions from Inspector service.</p>
  *
- * @public
+ *
  * @example Create resource group
  * ```javascript
  * // 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.
  * const input = {
- *   "resourceGroupTags": [
+ *   resourceGroupTags: [
  *     {
- *       "key": "Name",
- *       "value": "example"
+ *       key: "Name",
+ *       value: "example"
  *     }
  *   ]
  * };
  * const command = new CreateResourceGroupCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "resourceGroupArn": "arn:aws:inspector:us-west-2:123456789012:resourcegroup/0-AB6DMKnv"
+ *   resourceGroupArn: "arn:aws:inspector:us-west-2:123456789012:resourcegroup/0-AB6DMKnv"
  * }
  * *\/
- * // example id: create-resource-group-1481064169037
  * ```
  *
+ * @public
  */
 export declare class CreateResourceGroupCommand extends CreateResourceGroupCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/DeleteAssessmentRunCommand.d.ts

@@ -74,18 +74,21 @@ declare const DeleteAssessmentRunCommand_base: {
  * @throws {@link InspectorServiceException}
  * <p>Base exception class for all service exceptions from Inspector service.</p>
  *
- * @public
+ *
  * @example Delete assessment run
  * ```javascript
  * // Deletes the assessment run that is specified by the ARN of the assessment run.
  * const input = {
- *   "assessmentRunArn": "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-it5r2S4T/run/0-11LMTAVe"
+ *   assessmentRunArn: "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-it5r2S4T/run/0-11LMTAVe"
  * };
  * const command = new DeleteAssessmentRunCommand(input);
- * await client.send(command);
- * // example id: delete-assessment-run-1481064251629
+ * const response = await client.send(command);
+ * /* response is
+ * { /* metadata only *\/ }
+ * *\/
  * ```
  *
+ * @public
  */
 export declare class DeleteAssessmentRunCommand extends DeleteAssessmentRunCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/DeleteAssessmentTargetCommand.d.ts

@@ -74,18 +74,21 @@ declare const DeleteAssessmentTargetCommand_base: {
  * @throws {@link InspectorServiceException}
  * <p>Base exception class for all service exceptions from Inspector service.</p>
  *
- * @public
+ *
  * @example Delete assessment target
  * ```javascript
  * // Deletes the assessment target that is specified by the ARN of the assessment target.
  * const input = {
- *   "assessmentTargetArn": "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq"
+ *   assessmentTargetArn: "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq"
  * };
  * const command = new DeleteAssessmentTargetCommand(input);
- * await client.send(command);
- * // example id: delete-assessment-target-1481064309029
+ * const response = await client.send(command);
+ * /* response is
+ * { /* metadata only *\/ }
+ * *\/
  * ```
  *
+ * @public
  */
 export declare class DeleteAssessmentTargetCommand extends DeleteAssessmentTargetCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/DeleteAssessmentTemplateCommand.d.ts

@@ -74,18 +74,21 @@ declare const DeleteAssessmentTemplateCommand_base: {
  * @throws {@link InspectorServiceException}
  * <p>Base exception class for all service exceptions from Inspector service.</p>
  *
- * @public
+ *
  * @example Delete assessment template
  * ```javascript
  * // Deletes the assessment template that is specified by the ARN of the assessment template.
  * const input = {
- *   "assessmentTemplateArn": "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-it5r2S4T"
+ *   assessmentTemplateArn: "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-it5r2S4T"
  * };
  * const command = new DeleteAssessmentTemplateCommand(input);
- * await client.send(command);
- * // example id: delete-assessment-template-1481064364074
+ * const response = await client.send(command);
+ * /* response is
+ * { /* metadata only *\/ }
+ * *\/
  * ```
  *
+ * @public
  */
 export declare class DeleteAssessmentTemplateCommand extends DeleteAssessmentTemplateCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/DescribeAssessmentRunsCommand.d.ts

@@ -111,85 +111,8 @@ declare const DescribeAssessmentRunsCommand_base: {
  * @throws {@link InspectorServiceException}
  * <p>Base exception class for all service exceptions from Inspector service.</p>
  *
- * @public
- * @example Describte assessment runs
- * ```javascript
- * // Describes the assessment runs that are specified by the ARNs of the assessment runs.
- * const input = {
- *   "assessmentRunArns": [
- *     "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE"
- *   ]
- * };
- * const command = new DescribeAssessmentRunsCommand(input);
- * const response = await client.send(command);
- * /* response ==
- * {
- *   "assessmentRuns": [
- *     {
- *       "name": "Run 1 for ExampleAssessmentTemplate",
- *       "arn": "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE",
- *       "assessmentTemplateArn": "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw",
- *       "completedAt": "1458680301.4",
- *       "createdAt": "1458680170.035",
- *       "dataCollected": true,
- *       "durationInSeconds": 3600,
- *       "findingCounts": {
- *         "High": 14,
- *         "Informational": 0,
- *         "Low": 0,
- *         "Medium": 2,
- *         "Undefined": 0
- *       },
- *       "notifications": [],
- *       "rulesPackageArns": [
- *         "arn:aws:inspector:us-west-2:758058086616:rulespackage/0-X1KXtawP"
- *       ],
- *       "startedAt": "1458680170.161",
- *       "state": "COMPLETED",
- *       "stateChangedAt": "1458680301.4",
- *       "stateChanges": [
- *         {
- *           "state": "CREATED",
- *           "stateChangedAt": "1458680170.035"
- *         },
- *         {
- *           "state": "START_DATA_COLLECTION_PENDING",
- *           "stateChangedAt": "1458680170.065"
- *         },
- *         {
- *           "state": "START_DATA_COLLECTION_IN_PROGRESS",
- *           "stateChangedAt": "1458680170.096"
- *         },
- *         {
- *           "state": "COLLECTING_DATA",
- *           "stateChangedAt": "1458680170.161"
- *         },
- *         {
- *           "state": "STOP_DATA_COLLECTION_PENDING",
- *           "stateChangedAt": "1458680239.883"
- *         },
- *         {
- *           "state": "DATA_COLLECTED",
- *           "stateChangedAt": "1458680299.847"
- *         },
- *         {
- *           "state": "EVALUATING_RULES",
- *           "stateChangedAt": "1458680300.099"
- *         },
- *         {
- *           "state": "COMPLETED",
- *           "stateChangedAt": "1458680301.4"
- *         }
- *       ],
- *       "userAttributesForFindings": []
- *     }
- *   ],
- *   "failedItems": {}
- * }
- * *\/
- * // example id: describte-assessment-runs-1481064424352
- * ```
  *
+ * @public
  */
 export declare class DescribeAssessmentRunsCommand extends DescribeAssessmentRunsCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/DescribeAssessmentTargetsCommand.d.ts

@@ -78,34 +78,8 @@ declare const DescribeAssessmentTargetsCommand_base: {
  * @throws {@link InspectorServiceException}
  * <p>Base exception class for all service exceptions from Inspector service.</p>
  *
- * @public
- * @example Describte assessment targets
- * ```javascript
- * // Describes the assessment targets that are specified by the ARNs of the assessment targets.
- * const input = {
- *   "assessmentTargetArns": [
- *     "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq"
- *   ]
- * };
- * const command = new DescribeAssessmentTargetsCommand(input);
- * const response = await client.send(command);
- * /* response ==
- * {
- *   "assessmentTargets": [
- *     {
- *       "name": "ExampleAssessmentTarget",
- *       "arn": "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq",
- *       "createdAt": "1458074191.459",
- *       "resourceGroupArn": "arn:aws:inspector:us-west-2:123456789012:resourcegroup/0-PyGXopAI",
- *       "updatedAt": "1458074191.459"
- *     }
- *   ],
- *   "failedItems": {}
- * }
- * *\/
- * // example id: describte-assessment-targets-1481064527735
- * ```
  *
+ * @public
  */
 export declare class DescribeAssessmentTargetsCommand extends DescribeAssessmentTargetsCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/DescribeAssessmentTemplatesCommand.d.ts

@@ -89,39 +89,8 @@ declare const DescribeAssessmentTemplatesCommand_base: {
  * @throws {@link InspectorServiceException}
  * <p>Base exception class for all service exceptions from Inspector service.</p>
  *
- * @public
- * @example Describte assessment templates
- * ```javascript
- * // Describes the assessment templates that are specified by the ARNs of the assessment templates.
- * const input = {
- *   "assessmentTemplateArns": [
- *     "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw"
- *   ]
- * };
- * const command = new DescribeAssessmentTemplatesCommand(input);
- * const response = await client.send(command);
- * /* response ==
- * {
- *   "assessmentTemplates": [
- *     {
- *       "name": "ExampleAssessmentTemplate",
- *       "arn": "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw",
- *       "assessmentRunCount": 0,
- *       "assessmentTargetArn": "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq",
- *       "createdAt": "1458074191.844",
- *       "durationInSeconds": 3600,
- *       "rulesPackageArns": [
- *         "arn:aws:inspector:us-west-2:758058086616:rulespackage/0-X1KXtawP"
- *       ],
- *       "userAttributesForFindings": []
- *     }
- *   ],
- *   "failedItems": {}
- * }
- * *\/
- * // example id: describte-assessment-templates-1481064606829
- * ```
  *
+ * @public
  */
 export declare class DescribeAssessmentTemplatesCommand extends DescribeAssessmentTemplatesCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/DescribeCrossAccountAccessRoleCommand.d.ts

@@ -58,23 +58,8 @@ declare const DescribeCrossAccountAccessRoleCommand_base: {
  * @throws {@link InspectorServiceException}
  * <p>Base exception class for all service exceptions from Inspector service.</p>
  *
- * @public
- * @example Describte cross account access role
- * ```javascript
- * // Describes the IAM role that enables Amazon Inspector to access your AWS account.
- * const input = {};
- * const command = new DescribeCrossAccountAccessRoleCommand(input);
- * const response = await client.send(command);
- * /* response ==
- * {
- *   "registeredAt": "1458069182.826",
- *   "roleArn": "arn:aws:iam::123456789012:role/inspector",
- *   "valid": true
- * }
- * *\/
- * // example id: describte-cross-account-access-role-1481064682267
- * ```
  *
+ * @public
  */
 export declare class DescribeCrossAccountAccessRoleCommand extends DescribeCrossAccountAccessRoleCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/DescribeExclusionsCommand.d.ts

@@ -89,6 +89,7 @@ declare const DescribeExclusionsCommand_base: {
  * @throws {@link InspectorServiceException}
  * <p>Base exception class for all service exceptions from Inspector service.</p>
  *
+ *
  * @public
  */
 export declare class DescribeExclusionsCommand extends DescribeExclusionsCommand_base {

package/dist-types/commands/DescribeFindingsCommand.d.ts

@@ -146,53 +146,8 @@ declare const DescribeFindingsCommand_base: {
  * @throws {@link InspectorServiceException}
  * <p>Base exception class for all service exceptions from Inspector service.</p>
  *
- * @public
- * @example Describe findings
- * ```javascript
- * // Describes the findings that are specified by the ARNs of the findings.
- * const input = {
- *   "findingArns": [
- *     "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE/finding/0-HwPnsDm4"
- *   ]
- * };
- * const command = new DescribeFindingsCommand(input);
- * const response = await client.send(command);
- * /* response ==
- * {
- *   "failedItems": {},
- *   "findings": [
- *     {
- *       "arn": "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE/finding/0-HwPnsDm4",
- *       "assetAttributes": {
- *         "ipv4Addresses": [],
- *         "schemaVersion": 1
- *       },
- *       "assetType": "ec2-instance",
- *       "attributes": [],
- *       "confidence": 10,
- *       "createdAt": "1458680301.37",
- *       "description": "Amazon Inspector did not find any potential security issues during this assessment.",
- *       "indicatorOfCompromise": false,
- *       "numericSeverity": 0,
- *       "recommendation": "No remediation needed.",
- *       "schemaVersion": 1,
- *       "service": "Inspector",
- *       "serviceAttributes": {
- *         "assessmentRunArn": "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE",
- *         "rulesPackageArn": "arn:aws:inspector:us-west-2:758058086616:rulespackage/0-X1KXtawP",
- *         "schemaVersion": 1
- *       },
- *       "severity": "Informational",
- *       "title": "No potential security issues found",
- *       "updatedAt": "1458680301.37",
- *       "userAttributes": []
- *     }
- *   ]
- * }
- * *\/
- * // example id: describte-findings-1481064771803
- * ```
  *
+ * @public
  */
 export declare class DescribeFindingsCommand extends DescribeFindingsCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/DescribeResourceGroupsCommand.d.ts

@@ -81,37 +81,8 @@ declare const DescribeResourceGroupsCommand_base: {
  * @throws {@link InspectorServiceException}
  * <p>Base exception class for all service exceptions from Inspector service.</p>
  *
- * @public
- * @example Describe resource groups
- * ```javascript
- * // Describes the resource groups that are specified by the ARNs of the resource groups.
- * const input = {
- *   "resourceGroupArns": [
- *     "arn:aws:inspector:us-west-2:123456789012:resourcegroup/0-PyGXopAI"
- *   ]
- * };
- * const command = new DescribeResourceGroupsCommand(input);
- * const response = await client.send(command);
- * /* response ==
- * {
- *   "failedItems": {},
- *   "resourceGroups": [
- *     {
- *       "arn": "arn:aws:inspector:us-west-2:123456789012:resourcegroup/0-PyGXopAI",
- *       "createdAt": "1458074191.098",
- *       "tags": [
- *         {
- *           "key": "Name",
- *           "value": "example"
- *         }
- *       ]
- *     }
- *   ]
- * }
- * *\/
- * // example id: describe-resource-groups-1481065787743
- * ```
  *
+ * @public
  */
 export declare class DescribeResourceGroupsCommand extends DescribeResourceGroupsCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/DescribeRulesPackagesCommand.d.ts

@@ -79,34 +79,34 @@ declare const DescribeRulesPackagesCommand_base: {
  * @throws {@link InspectorServiceException}
  * <p>Base exception class for all service exceptions from Inspector service.</p>
  *
- * @public
+ *
  * @example Describe rules packages
  * ```javascript
  * // Describes the rules packages that are specified by the ARNs of the rules packages.
  * const input = {
- *   "rulesPackageArns": [
+ *   rulesPackageArns: [
  *     "arn:aws:inspector:us-west-2:758058086616:rulespackage/0-JJOtZiqQ"
  *   ]
  * };
  * const command = new DescribeRulesPackagesCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "failedItems": {},
- *   "rulesPackages": [
+ *   failedItems:   { /* empty *\/ },
+ *   rulesPackages: [
  *     {
- *       "version": "1.1",
- *       "name": "Security Best Practices",
- *       "arn": "arn:aws:inspector:us-west-2:758058086616:rulespackage/0-JJOtZiqQ",
- *       "description": "The rules in this package help determine whether your systems are configured securely.",
- *       "provider": "Amazon Web Services, Inc."
+ *       arn: "arn:aws:inspector:us-west-2:758058086616:rulespackage/0-JJOtZiqQ",
+ *       description: "The rules in this package help determine whether your systems are configured securely.",
+ *       name: "Security Best Practices",
+ *       provider: "Amazon Web Services, Inc.",
+ *       version: "1.1"
  *     }
  *   ]
  * }
  * *\/
- * // example id: describe-rules-packages-1481069641979
  * ```
  *
+ * @public
  */
 export declare class DescribeRulesPackagesCommand extends DescribeRulesPackagesCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/GetAssessmentReportCommand.d.ts

@@ -86,6 +86,7 @@ declare const GetAssessmentReportCommand_base: {
  * @throws {@link InspectorServiceException}
  * <p>Base exception class for all service exceptions from Inspector service.</p>
  *
+ *
  * @public
  */
 export declare class GetAssessmentReportCommand extends GetAssessmentReportCommand_base {

package/dist-types/commands/GetExclusionsPreviewCommand.d.ts

@@ -94,6 +94,7 @@ declare const GetExclusionsPreviewCommand_base: {
  * @throws {@link InspectorServiceException}
  * <p>Base exception class for all service exceptions from Inspector service.</p>
  *
+ *
  * @public
  */
 export declare class GetExclusionsPreviewCommand extends GetExclusionsPreviewCommand_base {