get_account¶

PinpointEmail.Client.get_account()¶

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

See also: AWS API Documentation

Request Syntax

response = client.get_account()

Return type

dict

Returns

Response Syntax

{
    'SendQuota': {
        'Max24HourSend': 123.0,
        'MaxSendRate': 123.0,
        'SentLast24Hours': 123.0
    },
    'SendingEnabled': True|False,
    'DedicatedIpAutoWarmupEnabled': True|False,
    'EnforcementStatus': 'string',
    'ProductionAccessEnabled': True|False
}

Response Structure

(dict) --
A list of details about the email-sending capabilities of your Amazon Pinpoint account in the current AWS Region.
- SendQuota (dict) --
  An object that contains information about the per-day and per-second sending limits for your Amazon Pinpoint account in the current AWS Region.
  - Max24HourSend (float) --
    The maximum number of emails that you can send in the current AWS Region over a 24-hour period. This value is also called your sending quota .
  - MaxSendRate (float) --
    The maximum number of emails that you can send per second in the current AWS Region. This value is also called your maximum sending rate or your maximum TPS (transactions per second) rate .
  - SentLast24Hours (float) --
    The number of emails sent from your Amazon Pinpoint account in the current AWS Region over the past 24 hours.
- SendingEnabled (boolean) --
  Indicates whether or not email sending is enabled for your Amazon Pinpoint account in the current AWS Region.
- DedicatedIpAutoWarmupEnabled (boolean) --
  Indicates whether or not the automatic warm-up feature is enabled for dedicated IP addresses that are associated with your account.
- EnforcementStatus (string) --
  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.
- ProductionAccessEnabled (boolean) --
  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.

Exceptions

PinpointEmail.Client.exceptions.TooManyRequestsException
PinpointEmail.Client.exceptions.BadRequestException

Table Of Contents

get_account¶