Amazonka.PinpointEmail.CreateConfigurationSet

Create a configuration set. Configuration sets are groups of rules that you can apply to the emails you send using Amazon Pinpoint. 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.

Creating a Request

data CreateConfigurationSet

A request to create a configuration set.

See: newCreateConfigurationSet smart constructor.

Constructors

CreateConfigurationSet'

Fields

• deliveryOptions :: Maybe DeliveryOptions

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

• reputationOptions :: Maybe ReputationOptions

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

• sendingOptions :: Maybe SendingOptions

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

• tags :: Maybe [Tag]

  An array of objects that define the tags (keys and values) that you want to associate with the configuration set.

• trackingOptions :: Maybe TrackingOptions

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

• configurationSetName :: Text

  The name of the configuration set.

Instances

ToJSON CreateConfigurationSet

Defined in Amazonka.PinpointEmail.CreateConfigurationSet

Methods

toJSON :: CreateConfigurationSet -> Value

toEncoding :: CreateConfigurationSet -> Encoding

toJSONList :: [CreateConfigurationSet] -> Value

toEncodingList :: [CreateConfigurationSet] -> Encoding

ToHeaders CreateConfigurationSet

Defined in Amazonka.PinpointEmail.CreateConfigurationSet

Methods

toHeaders :: CreateConfigurationSet -> [Header]

ToPath CreateConfigurationSet

Defined in Amazonka.PinpointEmail.CreateConfigurationSet

Methods

toPath :: CreateConfigurationSet -> ByteString

ToQuery CreateConfigurationSet

Defined in Amazonka.PinpointEmail.CreateConfigurationSet

Methods

toQuery :: CreateConfigurationSet -> QueryString

AWSRequest CreateConfigurationSet

Defined in Amazonka.PinpointEmail.CreateConfigurationSet

Associated Types

type AWSResponse CreateConfigurationSet

Methods

request :: (Service -> Service) -> CreateConfigurationSet -> Request CreateConfigurationSet

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateConfigurationSet -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateConfigurationSet)))

Generic CreateConfigurationSet

Defined in Amazonka.PinpointEmail.CreateConfigurationSet

Associated Types

type Rep CreateConfigurationSet :: Type -> Type

Methods

from :: CreateConfigurationSet -> Rep CreateConfigurationSet x

to :: Rep CreateConfigurationSet x -> CreateConfigurationSet

Read CreateConfigurationSet

Defined in Amazonka.PinpointEmail.CreateConfigurationSet

Methods

readsPrec :: Int -> ReadS CreateConfigurationSet

readList :: ReadS [CreateConfigurationSet]

readPrec :: ReadPrec CreateConfigurationSet

readListPrec :: ReadPrec [CreateConfigurationSet]

Show CreateConfigurationSet

Defined in Amazonka.PinpointEmail.CreateConfigurationSet

Methods

showsPrec :: Int -> CreateConfigurationSet -> ShowS

show :: CreateConfigurationSet -> String

showList :: [CreateConfigurationSet] -> ShowS

NFData CreateConfigurationSet

Defined in Amazonka.PinpointEmail.CreateConfigurationSet

Methods

rnf :: CreateConfigurationSet -> ()

Eq CreateConfigurationSet

Defined in Amazonka.PinpointEmail.CreateConfigurationSet

Methods

(==) :: CreateConfigurationSet -> CreateConfigurationSet -> Bool

(/=) :: CreateConfigurationSet -> CreateConfigurationSet -> Bool

Hashable CreateConfigurationSet

Defined in Amazonka.PinpointEmail.CreateConfigurationSet

Methods

hashWithSalt :: Int -> CreateConfigurationSet -> Int

hash :: CreateConfigurationSet -> Int

type AWSResponse CreateConfigurationSet

Defined in Amazonka.PinpointEmail.CreateConfigurationSet

type AWSResponse CreateConfigurationSet = CreateConfigurationSetResponse

type Rep CreateConfigurationSet

Defined in Amazonka.PinpointEmail.CreateConfigurationSet

type Rep CreateConfigurationSet = D1 ('MetaData "CreateConfigurationSet" "Amazonka.PinpointEmail.CreateConfigurationSet" "amazonka-pinpoint-email-2.0-EgVsRBIHQXMGA9Xbyu2BvI" 'False) (C1 ('MetaCons "CreateConfigurationSet'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "deliveryOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DeliveryOptions)) :*: (S1 ('MetaSel ('Just "reputationOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ReputationOptions)) :*: S1 ('MetaSel ('Just "sendingOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SendingOptions)))) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: (S1 ('MetaSel ('Just "trackingOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TrackingOptions)) :*: S1 ('MetaSel ('Just "configurationSetName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreateConfigurationSet

Arguments

:: Text

$sel:configurationSetName:CreateConfigurationSet'

-> CreateConfigurationSet

Create a value of CreateConfigurationSet with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:deliveryOptions:CreateConfigurationSet', createConfigurationSet_deliveryOptions - An object that defines the dedicated IP pool that is used to send emails that you send using the configuration set.

$sel:reputationOptions:CreateConfigurationSet', createConfigurationSet_reputationOptions - An object that defines whether or not Amazon Pinpoint collects reputation metrics for the emails that you send that use the configuration set.

$sel:sendingOptions:CreateConfigurationSet', createConfigurationSet_sendingOptions - An object that defines whether or not Amazon Pinpoint can send email that you send using the configuration set.

$sel:tags:CreateConfigurationSet', createConfigurationSet_tags - An array of objects that define the tags (keys and values) that you want to associate with the configuration set.

$sel:trackingOptions:CreateConfigurationSet', createConfigurationSet_trackingOptions - An object that defines the open and click tracking options for emails that you send using the configuration set.

$sel:configurationSetName:CreateConfigurationSet', createConfigurationSet_configurationSetName - The name of the configuration set.

Request Lenses

createConfigurationSet_deliveryOptions :: Lens' CreateConfigurationSet (Maybe DeliveryOptions)

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

createConfigurationSet_reputationOptions :: Lens' CreateConfigurationSet (Maybe ReputationOptions)

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

createConfigurationSet_sendingOptions :: Lens' CreateConfigurationSet (Maybe SendingOptions)

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

createConfigurationSet_tags :: Lens' CreateConfigurationSet (Maybe [Tag])

An array of objects that define the tags (keys and values) that you want to associate with the configuration set.

createConfigurationSet_trackingOptions :: Lens' CreateConfigurationSet (Maybe TrackingOptions)

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

createConfigurationSet_configurationSetName :: Lens' CreateConfigurationSet Text

The name of the configuration set.

Destructuring the Response

data CreateConfigurationSetResponse

An HTTP 200 response if the request succeeds, or an error message if the request fails.

See: newCreateConfigurationSetResponse smart constructor.

Constructors

CreateConfigurationSetResponse'

Fields

• httpStatus :: Int

  The response's http status code.

Instances

Generic CreateConfigurationSetResponse

Defined in Amazonka.PinpointEmail.CreateConfigurationSet

Associated Types

type Rep CreateConfigurationSetResponse :: Type -> Type

Methods

from :: CreateConfigurationSetResponse -> Rep CreateConfigurationSetResponse x

to :: Rep CreateConfigurationSetResponse x -> CreateConfigurationSetResponse

Read CreateConfigurationSetResponse

Defined in Amazonka.PinpointEmail.CreateConfigurationSet

Methods

readsPrec :: Int -> ReadS CreateConfigurationSetResponse

readList :: ReadS [CreateConfigurationSetResponse]

readPrec :: ReadPrec CreateConfigurationSetResponse

readListPrec :: ReadPrec [CreateConfigurationSetResponse]

Show CreateConfigurationSetResponse

Defined in Amazonka.PinpointEmail.CreateConfigurationSet

Methods

showsPrec :: Int -> CreateConfigurationSetResponse -> ShowS

show :: CreateConfigurationSetResponse -> String

showList :: [CreateConfigurationSetResponse] -> ShowS

NFData CreateConfigurationSetResponse

Defined in Amazonka.PinpointEmail.CreateConfigurationSet

Methods

rnf :: CreateConfigurationSetResponse -> ()

Eq CreateConfigurationSetResponse

Defined in Amazonka.PinpointEmail.CreateConfigurationSet

Methods

(==) :: CreateConfigurationSetResponse -> CreateConfigurationSetResponse -> Bool

(/=) :: CreateConfigurationSetResponse -> CreateConfigurationSetResponse -> Bool

type Rep CreateConfigurationSetResponse

Defined in Amazonka.PinpointEmail.CreateConfigurationSet

type Rep CreateConfigurationSetResponse = D1 ('MetaData "CreateConfigurationSetResponse" "Amazonka.PinpointEmail.CreateConfigurationSet" "amazonka-pinpoint-email-2.0-EgVsRBIHQXMGA9Xbyu2BvI" 'False) (C1 ('MetaCons "CreateConfigurationSetResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateConfigurationSetResponse

Arguments

:: Int

$sel:httpStatus:CreateConfigurationSetResponse'

-> CreateConfigurationSetResponse

Create a value of CreateConfigurationSetResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:CreateConfigurationSetResponse', createConfigurationSetResponse_httpStatus - The response's http status code.

Response Lenses

createConfigurationSetResponse_httpStatus :: Lens' CreateConfigurationSetResponse Int

The response's http status code.