DisableCommand

Suggest an Edit

Disables Amazon Inspector scans for one or more Amazon Web Services accounts. Disabling all scan types in an account disables the Amazon Inspector service.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { Inspector2Client, DisableCommand } from "@aws-sdk/client-inspector2"; // ES Modules import
// const { Inspector2Client, DisableCommand } = require("@aws-sdk/client-inspector2"); // CommonJS import
const client = new Inspector2Client(config);
const input = { // DisableRequest
  accountIds: [ // AccountIdSet
    "STRING_VALUE",
  ],
  resourceTypes: [ // DisableResourceTypeList
    "STRING_VALUE",
  ],
};
const command = new DisableCommand(input);
const response = await client.send(command);
// { // DisableResponse
//   accounts: [ // AccountList // required
//     { // Account
//       accountId: "STRING_VALUE", // required
//       status: "STRING_VALUE", // required
//       resourceStatus: { // ResourceStatus
//         ec2: "STRING_VALUE", // required
//         ecr: "STRING_VALUE", // required
//         lambda: "STRING_VALUE",
//         lambdaCode: "STRING_VALUE",
//       },
//     },
//   ],
//   failedAccounts: [ // FailedAccountList
//     { // FailedAccount
//       accountId: "STRING_VALUE", // required
//       status: "STRING_VALUE",
//       resourceStatus: {
//         ec2: "STRING_VALUE", // required
//         ecr: "STRING_VALUE", // required
//         lambda: "STRING_VALUE",
//         lambdaCode: "STRING_VALUE",
//       },
//       errorCode: "STRING_VALUE", // required
//       errorMessage: "STRING_VALUE", // required
//     },
//   ],
// };

DisableCommand Input

See DisableCommandInput for more details

Parameter
Type
Description
accountIds
string[] | undefined

An array of account IDs you want to disable Amazon Inspector scans for.

resourceTypes
ResourceScanType[] | undefined

The resource scan types you want to disable.

DisableCommand Output

See DisableCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
accounts
Required
Account[] | undefined

Information on the accounts that have had Amazon Inspector scans successfully disabled. Details are provided for each account.

failedAccounts
FailedAccount[] | undefined

Information on any accounts for which Amazon Inspector scans could not be disabled. Details are provided for each account.

Throws

Name
Fault
Details
AccessDeniedException
client

You do not have sufficient access to perform this action.

InternalServerException
server

The request has failed due to an internal failure of the Amazon Inspector service.

ResourceNotFoundException
client

The operation tried to access an invalid resource. Make sure the resource is specified correctly.

ThrottlingException
client

The limit on the number of requests per second was exceeded.

ValidationException
client

The request has failed validation due to missing required fields or having invalid inputs.

Inspector2ServiceException
Base exception class for all service exceptions from Inspector2 service.