| 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.GetIdentityDkimAttributes
Description
Returns the current status of Easy DKIM signing for an entity. For domain name identities, this operation also returns the DKIM tokens that are required for Easy DKIM signing, and whether Amazon SES has successfully verified that these tokens have been published.
This operation takes a list of identities as input and returns the following information for each:
- Whether Easy DKIM signing is enabled or disabled.
- A set of DKIM tokens that represent the identity. If the identity is an email address, the tokens represent the domain of that address.
- Whether Amazon SES has successfully verified the DKIM tokens published in the domain's DNS. This information is only returned for domain name identities, not for email addresses.
This operation is throttled at one request per second and can only get DKIM attributes for up to 100 identities at a time.
For more information about creating DNS records using DKIM tokens, go to the Amazon SES Developer Guide.
Synopsis
- data GetIdentityDkimAttributes = GetIdentityDkimAttributes' {
- identities :: [Text]
- newGetIdentityDkimAttributes :: GetIdentityDkimAttributes
- getIdentityDkimAttributes_identities :: Lens' GetIdentityDkimAttributes [Text]
- data GetIdentityDkimAttributesResponse = GetIdentityDkimAttributesResponse' {}
- newGetIdentityDkimAttributesResponse :: Int -> GetIdentityDkimAttributesResponse
- getIdentityDkimAttributesResponse_httpStatus :: Lens' GetIdentityDkimAttributesResponse Int
- getIdentityDkimAttributesResponse_dkimAttributes :: Lens' GetIdentityDkimAttributesResponse (HashMap Text IdentityDkimAttributes)
Creating a Request
data GetIdentityDkimAttributes Source #
Represents a request for the status of Amazon SES Easy DKIM signing for an identity. For domain identities, this request also returns the DKIM tokens that are required for Easy DKIM signing, and whether Amazon SES successfully verified that these tokens were published. For more information about Easy DKIM, see the Amazon SES Developer Guide.
See: newGetIdentityDkimAttributes smart constructor.
Constructors
| GetIdentityDkimAttributes' | |
Fields
| |
Instances
newGetIdentityDkimAttributes :: GetIdentityDkimAttributes Source #
Create a value of GetIdentityDkimAttributes 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:GetIdentityDkimAttributes', getIdentityDkimAttributes_identities - A list of one or more verified identities - email addresses, domains, or
both.
Request Lenses
getIdentityDkimAttributes_identities :: Lens' GetIdentityDkimAttributes [Text] Source #
A list of one or more verified identities - email addresses, domains, or both.
Destructuring the Response
data GetIdentityDkimAttributesResponse Source #
Represents the status of Amazon SES Easy DKIM signing for an identity. For domain identities, this response also contains the DKIM tokens that are required for Easy DKIM signing, and whether Amazon SES successfully verified that these tokens were published.
See: newGetIdentityDkimAttributesResponse smart constructor.
Constructors
| GetIdentityDkimAttributesResponse' | |
Fields
| |
Instances
newGetIdentityDkimAttributesResponse Source #
Arguments
| :: Int | |
| -> GetIdentityDkimAttributesResponse |
Create a value of GetIdentityDkimAttributesResponse 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:GetIdentityDkimAttributesResponse', getIdentityDkimAttributesResponse_httpStatus - The response's http status code.
$sel:dkimAttributes:GetIdentityDkimAttributesResponse', getIdentityDkimAttributesResponse_dkimAttributes - The DKIM attributes for an email address or a domain.
Response Lenses
getIdentityDkimAttributesResponse_httpStatus :: Lens' GetIdentityDkimAttributesResponse Int Source #
The response's http status code.
getIdentityDkimAttributesResponse_dkimAttributes :: Lens' GetIdentityDkimAttributesResponse (HashMap Text IdentityDkimAttributes) Source #
The DKIM attributes for an email address or a domain.