Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetConfigurationSet

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.

Request Syntax


GET /v1/email/configuration-sets/ConfigurationSetName HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

ConfigurationSetName

The name of the configuration set that you want to obtain more information about.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "ConfigurationSetName": "string",
   "DeliveryOptions": { 
      "SendingPoolName": "string",
      "TlsPolicy": "string"
   },
   "ReputationOptions": { 
      "LastFreshStart": number,
      "ReputationMetricsEnabled": boolean
   },
   "SendingOptions": { 
      "SendingEnabled": boolean
   },
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "TrackingOptions": { 
      "CustomRedirectDomain": "string"
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ConfigurationSetName

The name of the configuration set.

Type: String

DeliveryOptions

An object that defines the dedicated IP pool that is used to send emails that you send using the configuration set.

Type: DeliveryOptions object

ReputationOptions

An object that defines whether or not Amazon Pinpoint collects reputation metrics for the emails that you send that use the configuration set.

Type: ReputationOptions object

SendingOptions

An object that defines whether or not Amazon Pinpoint can send email that you send using the configuration set.

Type: SendingOptions object

Tags

An array of objects that define the tags (keys and values) that are associated with the configuration set.

Type: Array of Tag objects

TrackingOptions

An object that defines the open and click tracking options for emails that you send using the configuration set.

Type: TrackingOptions object

Errors

For information about the errors that are common to all actions, see Common Errors.

BadRequestException

The input you provided is invalid.

HTTP Status Code: 400

NotFoundException

The resource you attempted to access doesn't exist.

HTTP Status Code: 404

TooManyRequestsException

Too many requests have been made to the operation.

HTTP Status Code: 429