ListConfigurationSetsCommand

Suggest an Edit

List all of the configuration sets associated with your Amazon Pinpoint account in the current region.

In Amazon Pinpoint, configuration sets are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.

Example Syntax

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

import { PinpointEmailClient, ListConfigurationSetsCommand } from "@aws-sdk/client-pinpoint-email"; // ES Modules import
// const { PinpointEmailClient, ListConfigurationSetsCommand } = require("@aws-sdk/client-pinpoint-email"); // CommonJS import
const client = new PinpointEmailClient(config);
const input = { // ListConfigurationSetsRequest
  NextToken: "STRING_VALUE",
  PageSize: Number("int"),
};
const command = new ListConfigurationSetsCommand(input);
const response = await client.send(command);
// { // ListConfigurationSetsResponse
//   ConfigurationSets: [ // ConfigurationSetNameList
//     "STRING_VALUE",
//   ],
//   NextToken: "STRING_VALUE",
// };

ListConfigurationSetsCommand Input

See ListConfigurationSetsCommandInput for more details

Parameter
Type
Description
NextToken
string | undefined

A token returned from a previous call to ListConfigurationSets to indicate the position in the list of configuration sets.

PageSize
number | undefined

The number of results to show in a single call to ListConfigurationSets. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results.

ListConfigurationSetsCommand Output

See ListConfigurationSetsCommandOutput for details

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

An array that contains all of the configuration sets in your Amazon Pinpoint account in the current AWS Region.

NextToken
string | undefined

A token that indicates that there are additional configuration sets to list. To view additional configuration sets, issue another request to ListConfigurationSets, and pass this token in the NextToken parameter.

Throws

Name
Fault
Details
BadRequestException
client

The input you provided is invalid.

TooManyRequestsException
client

Too many requests have been made to the operation.

PinpointEmailServiceException
Base exception class for all service exceptions from PinpointEmail service.