Copyright | (c) 2013-2015 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Adds or updates a sending authorization policy for the specified identity (email address or domain).
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.
This action is throttled at one request per second.
See: AWS API Reference for PutIdentityPolicy.
- putIdentityPolicy :: Text -> Text -> Text -> PutIdentityPolicy
- data PutIdentityPolicy
- pipIdentity :: Lens' PutIdentityPolicy Text
- pipPolicyName :: Lens' PutIdentityPolicy Text
- pipPolicy :: Lens' PutIdentityPolicy Text
- putIdentityPolicyResponse :: Int -> PutIdentityPolicyResponse
- data PutIdentityPolicyResponse
- piprsResponseStatus :: Lens' PutIdentityPolicyResponse Int
Creating a Request
Creates a value of PutIdentityPolicy
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data PutIdentityPolicy Source
Represents a request instructing the service to apply an authorization policy to an identity.
See: putIdentityPolicy
smart constructor.
Request Lenses
pipIdentity :: Lens' PutIdentityPolicy Text Source
The identity to which the policy will apply. You can specify an identity by using its name or by using its Amazon Resource Name (ARN). Examples: 'user\'example.com', 'example.com', 'arn:aws:ses:us-east-1:123456789012:identity\/example.com'.
To successfully call this API, you must own the identity.
pipPolicyName :: Lens' PutIdentityPolicy Text Source
The name of the policy.
The policy name cannot exceed 64 characters and can only include alphanumeric characters, dashes, and underscores.
pipPolicy :: Lens' PutIdentityPolicy 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
putIdentityPolicyResponse Source
Creates a value of PutIdentityPolicyResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data PutIdentityPolicyResponse Source
An empty element. Receiving this element indicates that the request completed successfully.
See: putIdentityPolicyResponse
smart constructor.
Response Lenses
piprsResponseStatus :: Lens' PutIdentityPolicyResponse Int Source
The response status code.