| 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.SES.GetIdentityVerificationAttributes
Description
Given a list of identities (email addresses and/or domains), returns the verification status and (for domain identities) the verification token for each identity.
The verification status of an email address is "Pending" until the email address owner clicks the link within the verification email that Amazon SES sent to that address. If the email address owner clicks the link within 24 hours, the verification status of the email address changes to "Success". If the link is not clicked within 24 hours, the verification status changes to "Failed." In that case, if you still want to verify the email address, you must restart the verification process from the beginning.
For domain identities, the domain's verification status is "Pending" as Amazon SES searches for the required TXT record in the DNS settings of the domain. When Amazon SES detects the record, the domain's verification status changes to "Success". If Amazon SES is unable to detect the record within 72 hours, the domain's verification status changes to "Failed." In that case, if you still want to verify the domain, you must restart the verification process from the beginning.
This operation is throttled at one request per second and can only get verification attributes for up to 100 identities at a time.
Synopsis
- data GetIdentityVerificationAttributes = GetIdentityVerificationAttributes' {
- identities :: [Text]
- newGetIdentityVerificationAttributes :: GetIdentityVerificationAttributes
- getIdentityVerificationAttributes_identities :: Lens' GetIdentityVerificationAttributes [Text]
- data GetIdentityVerificationAttributesResponse = GetIdentityVerificationAttributesResponse' {}
- newGetIdentityVerificationAttributesResponse :: Int -> GetIdentityVerificationAttributesResponse
- getIdentityVerificationAttributesResponse_httpStatus :: Lens' GetIdentityVerificationAttributesResponse Int
- getIdentityVerificationAttributesResponse_verificationAttributes :: Lens' GetIdentityVerificationAttributesResponse (HashMap Text IdentityVerificationAttributes)
Creating a Request
data GetIdentityVerificationAttributes Source #
Represents a request to return the Amazon SES verification status of a list of identities. For domain identities, this request also returns the verification token. For information about verifying identities with Amazon SES, see the Amazon SES Developer Guide.
See: newGetIdentityVerificationAttributes smart constructor.
Constructors
| GetIdentityVerificationAttributes' | |
Fields
| |
Instances
newGetIdentityVerificationAttributes :: GetIdentityVerificationAttributes Source #
Create a value of GetIdentityVerificationAttributes 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:identities:GetIdentityVerificationAttributes', getIdentityVerificationAttributes_identities - A list of identities.
Request Lenses
getIdentityVerificationAttributes_identities :: Lens' GetIdentityVerificationAttributes [Text] Source #
A list of identities.
Destructuring the Response
data GetIdentityVerificationAttributesResponse Source #
The Amazon SES verification status of a list of identities. For domain identities, this response also contains the verification token.
See: newGetIdentityVerificationAttributesResponse smart constructor.
Constructors
| GetIdentityVerificationAttributesResponse' | |
Fields
| |
Instances
newGetIdentityVerificationAttributesResponse Source #
Arguments
| :: Int | |
| -> GetIdentityVerificationAttributesResponse |
Create a value of GetIdentityVerificationAttributesResponse 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:httpStatus:GetIdentityVerificationAttributesResponse', getIdentityVerificationAttributesResponse_httpStatus - The response's http status code.
$sel:verificationAttributes:GetIdentityVerificationAttributesResponse', getIdentityVerificationAttributesResponse_verificationAttributes - A map of Identities to IdentityVerificationAttributes objects.
Response Lenses
getIdentityVerificationAttributesResponse_httpStatus :: Lens' GetIdentityVerificationAttributesResponse Int Source #
The response's http status code.
getIdentityVerificationAttributesResponse_verificationAttributes :: Lens' GetIdentityVerificationAttributesResponse (HashMap Text IdentityVerificationAttributes) Source #
A map of Identities to IdentityVerificationAttributes objects.