libZSservicesZSamazonka-pinpoint-emailZSamazonka-pinpoint-email
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.PinpointEmail.GetConfigurationSet

Description

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.

Synopsis

Creating a Request

data GetConfigurationSet Source #

A request to obtain information about a configuration set.

See: newGetConfigurationSet smart constructor.

Constructors

GetConfigurationSet' 

Fields

Instances

Instances details
Eq GetConfigurationSet Source # 
Instance details

Defined in Amazonka.PinpointEmail.GetConfigurationSet

Read GetConfigurationSet Source # 
Instance details

Defined in Amazonka.PinpointEmail.GetConfigurationSet

Show GetConfigurationSet Source # 
Instance details

Defined in Amazonka.PinpointEmail.GetConfigurationSet

Generic GetConfigurationSet Source # 
Instance details

Defined in Amazonka.PinpointEmail.GetConfigurationSet

Associated Types

type Rep GetConfigurationSet :: Type -> Type #

NFData GetConfigurationSet Source # 
Instance details

Defined in Amazonka.PinpointEmail.GetConfigurationSet

Methods

rnf :: GetConfigurationSet -> () #

Hashable GetConfigurationSet Source # 
Instance details

Defined in Amazonka.PinpointEmail.GetConfigurationSet

AWSRequest GetConfigurationSet Source # 
Instance details

Defined in Amazonka.PinpointEmail.GetConfigurationSet

Associated Types

type AWSResponse GetConfigurationSet #

ToHeaders GetConfigurationSet Source # 
Instance details

Defined in Amazonka.PinpointEmail.GetConfigurationSet

ToPath GetConfigurationSet Source # 
Instance details

Defined in Amazonka.PinpointEmail.GetConfigurationSet

ToQuery GetConfigurationSet Source # 
Instance details

Defined in Amazonka.PinpointEmail.GetConfigurationSet

type Rep GetConfigurationSet Source # 
Instance details

Defined in Amazonka.PinpointEmail.GetConfigurationSet

type Rep GetConfigurationSet = D1 ('MetaData "GetConfigurationSet" "Amazonka.PinpointEmail.GetConfigurationSet" "libZSservicesZSamazonka-pinpoint-emailZSamazonka-pinpoint-email" 'False) (C1 ('MetaCons "GetConfigurationSet'" 'PrefixI 'True) (S1 ('MetaSel ('Just "configurationSetName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse GetConfigurationSet Source # 
Instance details

Defined in Amazonka.PinpointEmail.GetConfigurationSet

newGetConfigurationSet Source #

Create a value of GetConfigurationSet 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:configurationSetName:GetConfigurationSet', getConfigurationSet_configurationSetName - The name of the configuration set that you want to obtain more information about.

Request Lenses

getConfigurationSet_configurationSetName :: Lens' GetConfigurationSet Text Source #

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

Destructuring the Response

data GetConfigurationSetResponse Source #

Information about a configuration set.

See: newGetConfigurationSetResponse smart constructor.

Constructors

GetConfigurationSetResponse' 

Fields

Instances

Instances details
Eq GetConfigurationSetResponse Source # 
Instance details

Defined in Amazonka.PinpointEmail.GetConfigurationSet

Read GetConfigurationSetResponse Source # 
Instance details

Defined in Amazonka.PinpointEmail.GetConfigurationSet

Show GetConfigurationSetResponse Source # 
Instance details

Defined in Amazonka.PinpointEmail.GetConfigurationSet

Generic GetConfigurationSetResponse Source # 
Instance details

Defined in Amazonka.PinpointEmail.GetConfigurationSet

Associated Types

type Rep GetConfigurationSetResponse :: Type -> Type #

NFData GetConfigurationSetResponse Source # 
Instance details

Defined in Amazonka.PinpointEmail.GetConfigurationSet

type Rep GetConfigurationSetResponse Source # 
Instance details

Defined in Amazonka.PinpointEmail.GetConfigurationSet

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

newGetConfigurationSetResponse Source #

Create a value of GetConfigurationSetResponse 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:sendingOptions:GetConfigurationSetResponse', getConfigurationSetResponse_sendingOptions - An object that defines whether or not Amazon Pinpoint can send email that you send using the configuration set.

$sel:configurationSetName:GetConfigurationSet', getConfigurationSetResponse_configurationSetName - The name of the configuration set.

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

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

$sel:reputationOptions:GetConfigurationSetResponse', getConfigurationSetResponse_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:tags:GetConfigurationSetResponse', getConfigurationSetResponse_tags - An array of objects that define the tags (keys and values) that are associated with the configuration set.

$sel:httpStatus:GetConfigurationSetResponse', getConfigurationSetResponse_httpStatus - The response's http status code.

Response Lenses

getConfigurationSetResponse_sendingOptions :: Lens' GetConfigurationSetResponse (Maybe SendingOptions) Source #

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

getConfigurationSetResponse_deliveryOptions :: Lens' GetConfigurationSetResponse (Maybe DeliveryOptions) Source #

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

getConfigurationSetResponse_trackingOptions :: Lens' GetConfigurationSetResponse (Maybe TrackingOptions) Source #

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

getConfigurationSetResponse_reputationOptions :: Lens' GetConfigurationSetResponse (Maybe ReputationOptions) Source #

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

getConfigurationSetResponse_tags :: Lens' GetConfigurationSetResponse (Maybe [Tag]) Source #

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