public class PutIdentityPolicyRequest extends AmazonWebServiceRequest implements java.io.Serializable
Adds or updates a sending authorization policy for the specified identity (an email address or a 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.
Constructor and Description |
---|
PutIdentityPolicyRequest() |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getIdentity()
The identity to which the policy will apply.
|
java.lang.String |
getPolicy()
The text of the policy in JSON format.
|
java.lang.String |
getPolicyName()
The name of the policy.
|
int |
hashCode() |
void |
setIdentity(java.lang.String identity)
The identity to which the policy will apply.
|
void |
setPolicy(java.lang.String policy)
The text of the policy in JSON format.
|
void |
setPolicyName(java.lang.String policyName)
The name of the policy.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
PutIdentityPolicyRequest |
withIdentity(java.lang.String identity)
The identity to which the policy will apply.
|
PutIdentityPolicyRequest |
withPolicy(java.lang.String policy)
The text of the policy in JSON format.
|
PutIdentityPolicyRequest |
withPolicyName(java.lang.String policyName)
The name of the policy.
|
clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector
public java.lang.String getIdentity()
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.
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.
public void setIdentity(java.lang.String identity)
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.
identity
-
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.
public PutIdentityPolicyRequest withIdentity(java.lang.String identity)
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.
Returns a reference to this object so that method calls can be chained together.
identity
-
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.
public java.lang.String getPolicyName()
The name of the policy.
The policy name cannot exceed 64 characters and can only include alphanumeric characters, dashes, and underscores.
Constraints:
Length: 1 - 64
The name of the policy.
The policy name cannot exceed 64 characters and can only include alphanumeric characters, dashes, and underscores.
public void setPolicyName(java.lang.String policyName)
The name of the policy.
The policy name cannot exceed 64 characters and can only include alphanumeric characters, dashes, and underscores.
Constraints:
Length: 1 - 64
policyName
- The name of the policy.
The policy name cannot exceed 64 characters and can only include alphanumeric characters, dashes, and underscores.
public PutIdentityPolicyRequest withPolicyName(java.lang.String policyName)
The name of the policy.
The policy name cannot exceed 64 characters and can only include alphanumeric characters, dashes, and underscores.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 64
policyName
- The name of the policy.
The policy name cannot exceed 64 characters and can only include alphanumeric characters, dashes, and underscores.
public java.lang.String getPolicy()
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.
Constraints:
Length: 1 -
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.
public void setPolicy(java.lang.String 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.
Constraints:
Length: 1 -
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.
public PutIdentityPolicyRequest withPolicy(java.lang.String 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.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 -
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.
public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
Copyright © 2010 Amazon Web Services, Inc. All Rights Reserved.