| 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.SESV2.UpdateEmailIdentityPolicy
Description
Updates the specified sending authorization policy for the given identity (an email address or a domain). This API returns successfully even if a policy with the specified name does not exist.
This API is for the identity owner only. If you have not verified the identity, this API will return an error.
Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide.
You can execute this operation no more than once per second.
Synopsis
- data UpdateEmailIdentityPolicy = UpdateEmailIdentityPolicy' {
- emailIdentity :: Text
- policyName :: Text
- policy :: Text
- newUpdateEmailIdentityPolicy :: Text -> Text -> Text -> UpdateEmailIdentityPolicy
- updateEmailIdentityPolicy_emailIdentity :: Lens' UpdateEmailIdentityPolicy Text
- updateEmailIdentityPolicy_policyName :: Lens' UpdateEmailIdentityPolicy Text
- updateEmailIdentityPolicy_policy :: Lens' UpdateEmailIdentityPolicy Text
- data UpdateEmailIdentityPolicyResponse = UpdateEmailIdentityPolicyResponse' {
- httpStatus :: Int
- newUpdateEmailIdentityPolicyResponse :: Int -> UpdateEmailIdentityPolicyResponse
- updateEmailIdentityPolicyResponse_httpStatus :: Lens' UpdateEmailIdentityPolicyResponse Int
Creating a Request
data UpdateEmailIdentityPolicy Source #
Represents a request to update a sending authorization policy for an identity. Sending authorization is an Amazon SES feature that enables you to authorize other senders to use your identities. For information, see the Amazon SES Developer Guide.
See: newUpdateEmailIdentityPolicy smart constructor.
Constructors
| UpdateEmailIdentityPolicy' | |
Fields
| |
Instances
newUpdateEmailIdentityPolicy Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> UpdateEmailIdentityPolicy |
Create a value of UpdateEmailIdentityPolicy 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:emailIdentity:UpdateEmailIdentityPolicy', updateEmailIdentityPolicy_emailIdentity - The email identity.
$sel:policyName:UpdateEmailIdentityPolicy', updateEmailIdentityPolicy_policyName - The name of the policy.
The policy name cannot exceed 64 characters and can only include alphanumeric characters, dashes, and underscores.
$sel:policy:UpdateEmailIdentityPolicy', updateEmailIdentityPolicy_policy - The text of the policy in JSON format. The policy cannot exceed 4 KB.
For information about the syntax of sending authorization policies, see the Amazon SES Developer Guide.
Request Lenses
updateEmailIdentityPolicy_emailIdentity :: Lens' UpdateEmailIdentityPolicy Text Source #
The email identity.
updateEmailIdentityPolicy_policyName :: Lens' UpdateEmailIdentityPolicy Text Source #
The name of the policy.
The policy name cannot exceed 64 characters and can only include alphanumeric characters, dashes, and underscores.
updateEmailIdentityPolicy_policy :: Lens' UpdateEmailIdentityPolicy Text Source #
The text of the policy in JSON format. The policy cannot exceed 4 KB.
For information about the syntax of sending authorization policies, see the Amazon SES Developer Guide.
Destructuring the Response
data UpdateEmailIdentityPolicyResponse Source #
An HTTP 200 response if the request succeeds, or an error message if the request fails.
See: newUpdateEmailIdentityPolicyResponse smart constructor.
Constructors
| UpdateEmailIdentityPolicyResponse' | |
Fields
| |
Instances
newUpdateEmailIdentityPolicyResponse Source #
Arguments
| :: Int | |
| -> UpdateEmailIdentityPolicyResponse |
Create a value of UpdateEmailIdentityPolicyResponse 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:UpdateEmailIdentityPolicyResponse', updateEmailIdentityPolicyResponse_httpStatus - The response's http status code.
Response Lenses
updateEmailIdentityPolicyResponse_httpStatus :: Lens' UpdateEmailIdentityPolicyResponse Int Source #
The response's http status code.