ListAutomatedDiscoveryAccountsCommand

Suggest an Edit

Retrieves the status of automated sensitive data discovery for one or more accounts.

Example Syntax

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

import { Macie2Client, ListAutomatedDiscoveryAccountsCommand } from "@aws-sdk/client-macie2"; // ES Modules import
// const { Macie2Client, ListAutomatedDiscoveryAccountsCommand } = require("@aws-sdk/client-macie2"); // CommonJS import
const client = new Macie2Client(config);
const input = { // ListAutomatedDiscoveryAccountsRequest
  accountIds: [ // __listOf__string
    "STRING_VALUE",
  ],
  maxResults: Number("int"),
  nextToken: "STRING_VALUE",
};
const command = new ListAutomatedDiscoveryAccountsCommand(input);
const response = await client.send(command);
// { // ListAutomatedDiscoveryAccountsResponse
//   items: [ // __listOfAutomatedDiscoveryAccount
//     { // AutomatedDiscoveryAccount
//       accountId: "STRING_VALUE",
//       status: "ENABLED" || "DISABLED",
//     },
//   ],
//   nextToken: "STRING_VALUE",
// };

ListAutomatedDiscoveryAccountsCommand Input

See ListAutomatedDiscoveryAccountsCommandInput for more details

Parameter
Type
Description
accountIds
string[] | undefined

The Amazon Web Services account ID for each account, for as many as 50 accounts. To retrieve the status for multiple accounts, append the accountIds parameter and argument for each account, separated by an ampersand (&). To retrieve the status for all the accounts in an organization, omit this parameter.

maxResults
number | undefined

The maximum number of items to include in each page of a paginated response.

nextToken
string | undefined

The nextToken string that specifies which page of results to return in a paginated response.

ListAutomatedDiscoveryAccountsCommand Output

See ListAutomatedDiscoveryAccountsCommandOutput for details

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

An array of objects, one for each account specified in the request. Each object specifies the Amazon Web Services account ID for an account and the current status of automated sensitive data discovery for that account.

nextToken
string | undefined

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

Throws

Name
Fault
Details
AccessDeniedException
client

Provides information about an error that occurred due to insufficient access to a specified resource.

InternalServerException
server

Provides information about an error that occurred due to an unknown internal server error, exception, or failure.

ResourceNotFoundException
client

Provides information about an error that occurred because a specified resource wasn't found.

ThrottlingException
client

Provides information about an error that occurred because too many requests were sent during a certain amount of time.

ValidationException
client

Provides information about an error that occurred due to a syntax error in a request.

Macie2ServiceException
Base exception class for all service exceptions from Macie2 service.