Navigation Guide
You are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.

ListFindingAggregatorsCommand

If cross-Region aggregation is enabled, then ListFindingAggregators returns the Amazon Resource Name (ARN) of the finding aggregator. You can run this operation from any Amazon Web Services Region.

Example Syntax

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

import { SecurityHubClient, ListFindingAggregatorsCommand } from "@aws-sdk/client-securityhub"; // ES Modules import
// const { SecurityHubClient, ListFindingAggregatorsCommand } = require("@aws-sdk/client-securityhub"); // CommonJS import
const client = new SecurityHubClient(config);
const input = { // ListFindingAggregatorsRequest
  NextToken: "STRING_VALUE",
  MaxResults: Number("int"),
};
const command = new ListFindingAggregatorsCommand(input);
const response = await client.send(command);
// { // ListFindingAggregatorsResponse
//   FindingAggregators: [ // FindingAggregatorList
//     { // FindingAggregator
//       FindingAggregatorArn: "STRING_VALUE",
//     },
//   ],
//   NextToken: "STRING_VALUE",
// };

Example Usage

Loading code editor

ListFindingAggregatorsCommand Input

See ListFindingAggregatorsCommandInput for more details

Parameter	Type	Description
`MaxResults`	`number \| undefined`	The maximum number of results to return. This operation currently only returns a single result.
`NextToken`	`string \| undefined`	The token returned with the previous set of results. Identifies the next set of results to return.

ListFindingAggregatorsCommand Output

See ListFindingAggregatorsCommandOutput for details

Parameter	Type	Description
`$metadata` Required	`ResponseMetadata`	Metadata pertaining to this request.
`FindingAggregators`	`FindingAggregator[] \| undefined`	The list of finding aggregators. This operation currently only returns a single result.
`NextToken`	`string \| undefined`	If there are more results, this is the token to provide in the next call to `ListFindingAggregators`. This operation currently only returns a single result.

Throws

Name	Fault	Details
AccessDeniedException	client	You don't have permission to perform the action specified in the request.
InternalException	server	Internal server error.
InvalidAccessException	client	The account doesn't have permission to perform this action.
InvalidInputException	client	The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
LimitExceededException	client	The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
SecurityHubServiceException		Base exception class for all service exceptions from SecurityHub service.

Getting Started

References