Obtain information about the email-sending status and capabilities of your Amazon Pinpoint account in the current AWS Region.
Request Syntax
GET /v1/email/account HTTP/1.1
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"DedicatedIpAutoWarmupEnabled": boolean,
"EnforcementStatus": "string",
"ProductionAccessEnabled": boolean,
"SendingEnabled": boolean,
"SendQuota": {
"Max24HourSend": number,
"MaxSendRate": number,
"SentLast24Hours": number
}
}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.
- DedicatedIpAutoWarmupEnabled
-
Indicates whether or not the automatic warm-up feature is enabled for dedicated IP addresses that are associated with your account.
Type: Boolean
- 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.
Type: String
-
- 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.Type: Boolean
- SendingEnabled
-
Indicates whether or not email sending is enabled for your Amazon Pinpoint account in the current AWS Region.
Type: Boolean
- 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.
Type: SendQuota 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
- TooManyRequestsException
-
Too many requests have been made to the operation.
HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
