Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.PinpointEmail.GetAccount

Contents

Creating a Request
Destructuring the Response
Response Lenses

Description

Obtain information about the email-sending status and capabilities of your Amazon Pinpoint account in the current AWS Region.

Creating a Request

data GetAccount Source #

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

See: newGetAccount smart constructor.

Constructors

GetAccount'

Instances

Instances details

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

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 Pinpoint account in the current AWS Region.

See: newGetAccountResponse smart constructor.

Constructors

GetAccountResponse'

Fields

enforcementStatus :: Maybe Text
The reputation status of your Amazon Pinpoint 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 some issues with your Amazon Pinpoint 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.
dedicatedIpAutoWarmupEnabled :: Maybe Bool
Indicates whether or not the automatic warm-up feature is enabled for dedicated IP addresses that are associated with your account.
sendQuota :: Maybe SendQuota
An object that contains information about the per-day and per-second sending limits for your Amazon Pinpoint account in the current AWS Region.
productionAccessEnabled :: Maybe Bool
Indicates whether or not your account has production access in the current AWS 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.
sendingEnabled :: Maybe Bool
Indicates whether or not email sending is enabled for your Amazon Pinpoint account in the current AWS Region.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq GetAccountResponse Source #
Instance details Defined in Amazonka.PinpointEmail.GetAccount Methods (==) :: GetAccountResponse -> GetAccountResponse -> Bool # (/=) :: GetAccountResponse -> GetAccountResponse -> Bool #
Read GetAccountResponse Source #
Instance details Defined in Amazonka.PinpointEmail.GetAccount Methods readsPrec :: Int -> ReadS GetAccountResponse # readList :: ReadS [GetAccountResponse] # readPrec :: ReadPrec GetAccountResponse # readListPrec :: ReadPrec [GetAccountResponse] #
Show GetAccountResponse Source #
Instance details Defined in Amazonka.PinpointEmail.GetAccount Methods showsPrec :: Int -> GetAccountResponse -> ShowS # show :: GetAccountResponse -> String # showList :: [GetAccountResponse] -> ShowS #
Generic GetAccountResponse Source #
Instance details Defined in Amazonka.PinpointEmail.GetAccount Associated Types type Rep GetAccountResponse :: Type -> Type # Methods from :: GetAccountResponse -> Rep GetAccountResponse x # to :: Rep GetAccountResponse x -> GetAccountResponse #
NFData GetAccountResponse Source #
Instance details Defined in Amazonka.PinpointEmail.GetAccount Methods rnf :: GetAccountResponse -> () #
type Rep GetAccountResponse Source #
Instance details Defined in Amazonka.PinpointEmail.GetAccount type Rep GetAccountResponse = D1 ('MetaData "GetAccountResponse" "Amazonka.PinpointEmail.GetAccount" "libZSservicesZSamazonka-pinpoint-emailZSamazonka-pinpoint-email" 'False) (C1 ('MetaCons "GetAccountResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "enforcementStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "dedicatedIpAutoWarmupEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "sendQuota") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SendQuota)))) :: (S1 ('MetaSel ('Just "productionAccessEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "sendingEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: 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:enforcementStatus:GetAccountResponse', getAccountResponse_enforcementStatus - The reputation status of your Amazon Pinpoint 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 some issues with your Amazon Pinpoint 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: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:sendQuota:GetAccountResponse', getAccountResponse_sendQuota - An object that contains information about the per-day and per-second sending limits for your Amazon Pinpoint account in the current AWS Region.

$sel:productionAccessEnabled:GetAccountResponse', getAccountResponse_productionAccessEnabled - Indicates whether or not your account has production access in the current AWS 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:sendingEnabled:GetAccountResponse', getAccountResponse_sendingEnabled - Indicates whether or not email sending is enabled for your Amazon Pinpoint account in the current AWS Region.

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

Response Lenses

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

The reputation status of your Amazon Pinpoint 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 some issues with your Amazon Pinpoint 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_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_sendQuota :: Lens' GetAccountResponse (Maybe SendQuota) Source #

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

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

Indicates whether or not your account has production access in the current AWS 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_sendingEnabled :: Lens' GetAccountResponse (Maybe Bool) Source #

Indicates whether or not email sending is enabled for your Amazon Pinpoint account in the current AWS Region.

getAccountResponse_httpStatus :: Lens' GetAccountResponse Int Source #

The response's http status code.