com.amazonaws.services.simpleemail.model

Class GetIdentityPoliciesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.simpleemail.model.GetIdentityPoliciesRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class GetIdentityPoliciesRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the GetIdentityPolicies operation.

Returns the requested sending authorization policies for the given identity (email address or domain). The policies are returned as a map of policy names to policy contents. You can retrieve a maximum of 20 policies at a time.

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.getIdentityPolicies(GetIdentityPoliciesRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
GetIdentityPoliciesRequest()

Method Summary

Methods

Modifier and Type	Method and Description
GetIdentityPoliciesRequest	clone()
boolean	equals(Object obj)
String	getIdentity() The identity for which the policies will be retrieved.
List<String>	getPolicyNames() A list of the names of policies to be retrieved.
int	hashCode()
void	setIdentity(String identity) The identity for which the policies will be retrieved.
void	setPolicyNames(Collection<String> policyNames) A list of the names of policies to be retrieved.
String	toString() Returns a string representation of this object; useful for testing and debugging.
GetIdentityPoliciesRequest	withIdentity(String identity) The identity for which the policies will be retrieved.
GetIdentityPoliciesRequest	withPolicyNames(Collection<String> policyNames) A list of the names of policies to be retrieved.
GetIdentityPoliciesRequest	withPolicyNames(String... policyNames) A list of the names of policies to be retrieved.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

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

Methods inherited from class java.lang.Object

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

Constructor Detail

GetIdentityPoliciesRequest

public GetIdentityPoliciesRequest()

Method Detail

getIdentity

public String getIdentity()

The identity for which the policies will be retrieved. 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 for which the policies will be retrieved. 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 for which the policies will be retrieved. 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 for which the policies will be retrieved. 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 GetIdentityPoliciesRequest withIdentity(String identity)

The identity for which the policies will be retrieved. 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 for which the policies will be retrieved. 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.

getPolicyNames

public List<String> getPolicyNames()

A list of the names of policies to be retrieved. You can retrieve a maximum of 20 policies at a time. If you do not know the names of the policies that are attached to the identity, you can use ListIdentityPolicies.

Returns:

A list of the names of policies to be retrieved. You can retrieve a maximum of 20 policies at a time. If you do not know the names of the policies that are attached to the identity, you can use ListIdentityPolicies.

setPolicyNames

public void setPolicyNames(Collection<String> policyNames)

A list of the names of policies to be retrieved. You can retrieve a maximum of 20 policies at a time. If you do not know the names of the policies that are attached to the identity, you can use ListIdentityPolicies.

Parameters:

policyNames - A list of the names of policies to be retrieved. You can retrieve a maximum of 20 policies at a time. If you do not know the names of the policies that are attached to the identity, you can use ListIdentityPolicies.

withPolicyNames

public GetIdentityPoliciesRequest withPolicyNames(String... policyNames)

A list of the names of policies to be retrieved. You can retrieve a maximum of 20 policies at a time. If you do not know the names of the policies that are attached to the identity, you can use ListIdentityPolicies.

NOTE: This method appends the values to the existing list (if any). Use setPolicyNames(java.util.Collection) or withPolicyNames(java.util.Collection) if you want to override the existing values.

Returns a reference to this object so that method calls can be chained together.

Parameters:

policyNames - A list of the names of policies to be retrieved. You can retrieve a maximum of 20 policies at a time. If you do not know the names of the policies that are attached to the identity, you can use ListIdentityPolicies.

Returns:

A reference to this updated object so that method calls can be chained together.

withPolicyNames

public GetIdentityPoliciesRequest withPolicyNames(Collection<String> policyNames)

A list of the names of policies to be retrieved. You can retrieve a maximum of 20 policies at a time. If you do not know the names of the policies that are attached to the identity, you can use ListIdentityPolicies.

Returns a reference to this object so that method calls can be chained together.

Parameters:

policyNames - A list of the names of policies to be retrieved. You can retrieve a maximum of 20 policies at a time. If you do not know the names of the policies that are attached to the identity, you can use ListIdentityPolicies.

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 GetIdentityPoliciesRequest clone()

Overrides:

clone in class AmazonWebServiceRequest