Class GetConfigurationSetCommandProtected

Get information about an existing configuration set, including the dedicated IP pool that it's associated with, whether or not it's enabled for sending email, and more.

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

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

import { PinpointEmailClient, GetConfigurationSetCommand } from "@aws-sdk/client-pinpoint-email"; // ES Modules import
// const { PinpointEmailClient, GetConfigurationSetCommand } = require("@aws-sdk/client-pinpoint-email"); // CommonJS import
const client = new PinpointEmailClient(config);
const input = { // GetConfigurationSetRequest
  ConfigurationSetName: "STRING_VALUE", // required
};
const command = new GetConfigurationSetCommand(input);
const response = await client.send(command);
// { // GetConfigurationSetResponse
//   ConfigurationSetName: "STRING_VALUE",
//   TrackingOptions: { // TrackingOptions
//     CustomRedirectDomain: "STRING_VALUE", // required
//   },
//   DeliveryOptions: { // DeliveryOptions
//     TlsPolicy: "STRING_VALUE",
//     SendingPoolName: "STRING_VALUE",
//   },
//   ReputationOptions: { // ReputationOptions
//     ReputationMetricsEnabled: true || false,
//     LastFreshStart: new Date("TIMESTAMP"),
//   },
//   SendingOptions: { // SendingOptions
//     SendingEnabled: true || false,
//   },
//   Tags: [ // TagList
//     { // Tag
//       Key: "STRING_VALUE", // required
//       Value: "STRING_VALUE", // required
//     },
//   ],
// };

Param

GetConfigurationSetCommandInput

Returns

GetConfigurationSetCommandOutput

See

• GetConfigurationSetCommandInput for command's input shape.
• GetConfigurationSetCommandOutput for command's response shape.
• config for PinpointEmailClient's config shape.

Throws

BadRequestException (client fault)

The input you provided is invalid.

Throws

NotFoundException (client fault)

The resource you attempted to access doesn't exist.

Throws

TooManyRequestsException (client fault)

Too many requests have been made to the operation.

Throws

PinpointEmailServiceException

Base exception class for all service exceptions from PinpointEmail service.