com.amazonaws.services.simpleemail.model

Class PutIdentityPolicyRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.simpleemail.model.PutIdentityPolicyRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class PutIdentityPolicyRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the PutIdentityPolicy operation.

Adds or updates a sending authorization policy for the specified identity (email address or domain).

NOTE: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 Also:

AmazonSimpleEmailService.putIdentityPolicy(PutIdentityPolicyRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
PutIdentityPolicyRequest()

Method Summary

Methods

Modifier and Type	Method and Description
PutIdentityPolicyRequest	clone()
boolean	equals(Object obj)
String	getIdentity() The identity to which the policy will apply.
String	getPolicy() The text of the policy in JSON format.
String	getPolicyName() The name of the policy.
int	hashCode()
void	setIdentity(String identity) The identity to which the policy will apply.
void	setPolicy(String policy) The text of the policy in JSON format.
void	setPolicyName(String policyName) The name of the policy.
String	toString() Returns a string representation of this object; useful for testing and debugging.
PutIdentityPolicyRequest	withIdentity(String identity) The identity to which the policy will apply.
PutIdentityPolicyRequest	withPolicy(String policy) The text of the policy in JSON format.
PutIdentityPolicyRequest	withPolicyName(String policyName) The name of the policy.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PutIdentityPolicyRequest

public PutIdentityPolicyRequest()

Method Detail

getIdentity

public 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: [email protected], example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com.

To successfully call this API, you must own the identity.

Returns:

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: [email protected], example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com.

To successfully call this API, you must own the identity.

setIdentity

public void setIdentity(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: [email protected], example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com.

To successfully call this API, you must own the identity.

Parameters:

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: [email protected], example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com.

To successfully call this API, you must own the identity.

withIdentity

public PutIdentityPolicyRequest withIdentity(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: [email protected], 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.

Parameters:

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: [email protected], 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 updated object so that method calls can be chained together.

getPolicyName

public 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
Pattern: [^\\/\?\*\s]+

Returns:

The name of the policy.

The policy name cannot exceed 64 characters and can only include alphanumeric characters, dashes, and underscores.

setPolicyName

public void setPolicyName(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
Pattern: [^\\/\?\*\s]+

Parameters:

policyName - The name of the policy.

The policy name cannot exceed 64 characters and can only include alphanumeric characters, dashes, and underscores.

withPolicyName

public PutIdentityPolicyRequest withPolicyName(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
Pattern: [^\\/\?\*\s]+

Parameters:

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 updated object so that method calls can be chained together.

getPolicy

public 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 -

Returns:

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.

setPolicy

public void setPolicy(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 -

Parameters:

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.

withPolicy

public PutIdentityPolicyRequest withPolicy(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 -

Parameters:

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 updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public PutIdentityPolicyRequest clone()

Overrides:

clone in class AmazonWebServiceRequest