Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.SESV2.GetAccount

Contents

Creating a Request
Destructuring the Response
Response Lenses

Description

Obtain information about the email-sending status and capabilities of your Amazon SES account in the current Amazon Web Services Region.

Synopsis

data GetAccount = GetAccount' {
}
newGetAccount :: GetAccount
data GetAccountResponse = GetAccountResponse' {
- dedicatedIpAutoWarmupEnabled :: Maybe Bool
- details :: Maybe AccountDetails
- enforcementStatus :: Maybe Text
- productionAccessEnabled :: Maybe Bool
- sendQuota :: Maybe SendQuota
- sendingEnabled :: Maybe Bool
- suppressionAttributes :: Maybe SuppressionAttributes
- vdmAttributes :: Maybe VdmAttributes
- httpStatus :: Int
}
newGetAccountResponse :: Int -> GetAccountResponse
getAccountResponse_dedicatedIpAutoWarmupEnabled :: Lens' GetAccountResponse (Maybe Bool)
getAccountResponse_details :: Lens' GetAccountResponse (Maybe AccountDetails)
getAccountResponse_enforcementStatus :: Lens' GetAccountResponse (Maybe Text)
getAccountResponse_productionAccessEnabled :: Lens' GetAccountResponse (Maybe Bool)
getAccountResponse_sendQuota :: Lens' GetAccountResponse (Maybe SendQuota)
getAccountResponse_sendingEnabled :: Lens' GetAccountResponse (Maybe Bool)
getAccountResponse_suppressionAttributes :: Lens' GetAccountResponse (Maybe SuppressionAttributes)
getAccountResponse_vdmAttributes :: Lens' GetAccountResponse (Maybe VdmAttributes)
getAccountResponse_httpStatus :: Lens' GetAccountResponse Int

Creating a Request

data GetAccount Source #

A request to obtain information about the email-sending capabilities of your Amazon SES account.

See: newGetAccount smart constructor.

Constructors

GetAccount'

Instances

Instances details

ToHeaders GetAccount Source #
Instance details Defined in Amazonka.SESV2.GetAccount Methods toHeaders :: GetAccount -> [Header] #
ToPath GetAccount Source #
Instance details Defined in Amazonka.SESV2.GetAccount Methods toPath :: GetAccount -> ByteString #
ToQuery GetAccount Source #
Instance details Defined in Amazonka.SESV2.GetAccount Methods toQuery :: GetAccount -> QueryString #
AWSRequest GetAccount Source #
Instance details Defined in Amazonka.SESV2.GetAccount Associated Types type AWSResponse GetAccount # Methods request :: (Service -> Service) -> GetAccount -> Request GetAccount # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetAccount -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetAccount))) #
Generic GetAccount Source #
Instance details Defined in Amazonka.SESV2.GetAccount Associated Types type Rep GetAccount :: Type -> Type # Methods from :: GetAccount -> Rep GetAccount x # to :: Rep GetAccount x -> GetAccount #
Read GetAccount Source #
Instance details Defined in Amazonka.SESV2.GetAccount Methods readsPrec :: Int -> ReadS GetAccount # readList :: ReadS [GetAccount] # readPrec :: ReadPrec GetAccount # readListPrec :: ReadPrec [GetAccount] #
Show GetAccount Source #
Instance details Defined in Amazonka.SESV2.GetAccount Methods showsPrec :: Int -> GetAccount -> ShowS # show :: GetAccount -> String # showList :: [GetAccount] -> ShowS #
NFData GetAccount Source #
Instance details Defined in Amazonka.SESV2.GetAccount Methods rnf :: GetAccount -> () #
Eq GetAccount Source #
Instance details Defined in Amazonka.SESV2.GetAccount Methods (==) :: GetAccount -> GetAccount -> Bool # (/=) :: GetAccount -> GetAccount -> Bool #
Hashable GetAccount Source #
Instance details Defined in Amazonka.SESV2.GetAccount Methods hashWithSalt :: Int -> GetAccount -> Int # hash :: GetAccount -> Int #
type AWSResponse GetAccount Source #
Instance details Defined in Amazonka.SESV2.GetAccount type AWSResponse GetAccount = GetAccountResponse
type Rep GetAccount Source #
Instance details Defined in Amazonka.SESV2.GetAccount type Rep GetAccount = D1 ('MetaData "GetAccount" "Amazonka.SESV2.GetAccount" "amazonka-sesv2-2.0-KPRo1S1CRfP4bs5VKSgHvB" 'False) (C1 ('MetaCons "GetAccount'" 'PrefixI 'False) (U1 :: Type -> Type))

newGetAccount :: GetAccount Source #

Create a value of GetAccount with all optional fields omitted.

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

Destructuring the Response

data GetAccountResponse Source #

A list of details about the email-sending capabilities of your Amazon SES account in the current Amazon Web Services Region.

See: newGetAccountResponse smart constructor.

Constructors

GetAccountResponse'

Fields

dedicatedIpAutoWarmupEnabled :: Maybe Bool
Indicates whether or not the automatic warm-up feature is enabled for dedicated IP addresses that are associated with your account.
details :: Maybe AccountDetails
An object that defines your account details.
enforcementStatus :: Maybe Text
The reputation status of your Amazon SES account. The status can be one of the following:
- HEALTHY – There are no reputation-related issues that currently impact your account.
- PROBATION – We've identified potential issues with your Amazon SES account. We're placing your account under review while you work on correcting these issues.
- SHUTDOWN – Your account's ability to send email is currently paused because of an issue with the email sent from your account. When you correct the issue, you can contact us and request that your account's ability to send email is resumed.
productionAccessEnabled :: Maybe Bool
Indicates whether or not your account has production access in the current Amazon Web Services Region.
If the value is false, then your account is in the sandbox. When your account is in the sandbox, you can only send email to verified identities. Additionally, the maximum number of emails you can send in a 24-hour period (your sending quota) is 200, and the maximum number of emails you can send per second (your maximum sending rate) is 1.
If the value is true, then your account has production access. When your account has production access, you can send email to any address. The sending quota and maximum sending rate for your account vary based on your specific use case.
sendQuota :: Maybe SendQuota
An object that contains information about the per-day and per-second sending limits for your Amazon SES account in the current Amazon Web Services Region.
sendingEnabled :: Maybe Bool
Indicates whether or not email sending is enabled for your Amazon SES account in the current Amazon Web Services Region.
suppressionAttributes :: Maybe SuppressionAttributes
An object that contains information about the email address suppression preferences for your account in the current Amazon Web Services Region.
vdmAttributes :: Maybe VdmAttributes
The VDM attributes that apply to your Amazon SES account.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic GetAccountResponse Source #
Instance details Defined in Amazonka.SESV2.GetAccount Associated Types type Rep GetAccountResponse :: Type -> Type # Methods from :: GetAccountResponse -> Rep GetAccountResponse x # to :: Rep GetAccountResponse x -> GetAccountResponse #
Show GetAccountResponse Source #
Instance details Defined in Amazonka.SESV2.GetAccount Methods showsPrec :: Int -> GetAccountResponse -> ShowS # show :: GetAccountResponse -> String # showList :: [GetAccountResponse] -> ShowS #
NFData GetAccountResponse Source #
Instance details Defined in Amazonka.SESV2.GetAccount Methods rnf :: GetAccountResponse -> () #
Eq GetAccountResponse Source #
Instance details Defined in Amazonka.SESV2.GetAccount Methods (==) :: GetAccountResponse -> GetAccountResponse -> Bool # (/=) :: GetAccountResponse -> GetAccountResponse -> Bool #
type Rep GetAccountResponse Source #
Instance details Defined in Amazonka.SESV2.GetAccount type Rep GetAccountResponse = D1 ('MetaData "GetAccountResponse" "Amazonka.SESV2.GetAccount" "amazonka-sesv2-2.0-KPRo1S1CRfP4bs5VKSgHvB" 'False) (C1 ('MetaCons "GetAccountResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "dedicatedIpAutoWarmupEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "details") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AccountDetails))) :: (S1 ('MetaSel ('Just "enforcementStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "productionAccessEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :: ((S1 ('MetaSel ('Just "sendQuota") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SendQuota)) :: S1 ('MetaSel ('Just "sendingEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "suppressionAttributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SuppressionAttributes)) :: (S1 ('MetaSel ('Just "vdmAttributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VdmAttributes)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newGetAccountResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetAccountResponse'`
-> GetAccountResponse

Create a value of GetAccountResponse 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:dedicatedIpAutoWarmupEnabled:GetAccountResponse', getAccountResponse_dedicatedIpAutoWarmupEnabled - Indicates whether or not the automatic warm-up feature is enabled for dedicated IP addresses that are associated with your account.

$sel:details:GetAccountResponse', getAccountResponse_details - An object that defines your account details.

$sel:enforcementStatus:GetAccountResponse', getAccountResponse_enforcementStatus - The reputation status of your Amazon SES account. The status can be one of the following:

HEALTHY – There are no reputation-related issues that currently impact your account.
PROBATION – We've identified potential issues with your Amazon SES account. We're placing your account under review while you work on correcting these issues.
SHUTDOWN – Your account's ability to send email is currently paused because of an issue with the email sent from your account. When you correct the issue, you can contact us and request that your account's ability to send email is resumed.

$sel:productionAccessEnabled:GetAccountResponse', getAccountResponse_productionAccessEnabled - Indicates whether or not your account has production access in the current Amazon Web Services Region.

If the value is false, then your account is in the sandbox. When your account is in the sandbox, you can only send email to verified identities. Additionally, the maximum number of emails you can send in a 24-hour period (your sending quota) is 200, and the maximum number of emails you can send per second (your maximum sending rate) is 1.

If the value is true, then your account has production access. When your account has production access, you can send email to any address. The sending quota and maximum sending rate for your account vary based on your specific use case.

$sel:sendQuota:GetAccountResponse', getAccountResponse_sendQuota - An object that contains information about the per-day and per-second sending limits for your Amazon SES account in the current Amazon Web Services Region.

GetAccountResponse, getAccountResponse_sendingEnabled - Indicates whether or not email sending is enabled for your Amazon SES account in the current Amazon Web Services Region.

$sel:suppressionAttributes:GetAccountResponse', getAccountResponse_suppressionAttributes - An object that contains information about the email address suppression preferences for your account in the current Amazon Web Services Region.

$sel:vdmAttributes:GetAccountResponse', getAccountResponse_vdmAttributes - The VDM attributes that apply to your Amazon SES account.

$sel:httpStatus:GetAccountResponse', getAccountResponse_httpStatus - The response's http status code.

Response Lenses

getAccountResponse_dedicatedIpAutoWarmupEnabled :: Lens' GetAccountResponse (Maybe Bool) Source #

Indicates whether or not the automatic warm-up feature is enabled for dedicated IP addresses that are associated with your account.

getAccountResponse_details :: Lens' GetAccountResponse (Maybe AccountDetails) Source #

An object that defines your account details.

getAccountResponse_enforcementStatus :: Lens' GetAccountResponse (Maybe Text) Source #

The reputation status of your Amazon SES account. The status can be one of the following:

HEALTHY – There are no reputation-related issues that currently impact your account.
PROBATION – We've identified potential issues with your Amazon SES account. We're placing your account under review while you work on correcting these issues.
SHUTDOWN – Your account's ability to send email is currently paused because of an issue with the email sent from your account. When you correct the issue, you can contact us and request that your account's ability to send email is resumed.

getAccountResponse_productionAccessEnabled :: Lens' GetAccountResponse (Maybe Bool) Source #

Indicates whether or not your account has production access in the current Amazon Web Services Region.

If the value is false, then your account is in the sandbox. When your account is in the sandbox, you can only send email to verified identities. Additionally, the maximum number of emails you can send in a 24-hour period (your sending quota) is 200, and the maximum number of emails you can send per second (your maximum sending rate) is 1.

If the value is true, then your account has production access. When your account has production access, you can send email to any address. The sending quota and maximum sending rate for your account vary based on your specific use case.

getAccountResponse_sendQuota :: Lens' GetAccountResponse (Maybe SendQuota) Source #

An object that contains information about the per-day and per-second sending limits for your Amazon SES account in the current Amazon Web Services Region.

getAccountResponse_sendingEnabled :: Lens' GetAccountResponse (Maybe Bool) Source #

Indicates whether or not email sending is enabled for your Amazon SES account in the current Amazon Web Services Region.

getAccountResponse_suppressionAttributes :: Lens' GetAccountResponse (Maybe SuppressionAttributes) Source #

An object that contains information about the email address suppression preferences for your account in the current Amazon Web Services Region.

getAccountResponse_vdmAttributes :: Lens' GetAccountResponse (Maybe VdmAttributes) Source #

The VDM attributes that apply to your Amazon SES account.

getAccountResponse_httpStatus :: Lens' GetAccountResponse Int Source #

The response's http status code.