software.amazon.awssdk.services.ses.model

Class PutIdentityPolicyRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.ses.model.SesRequest

software.amazon.awssdk.services.ses.model.PutIdentityPolicyRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<PutIdentityPolicyRequest.Builder,PutIdentityPolicyRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class PutIdentityPolicyRequest
extends SesRequest
implements ToCopyableBuilder<PutIdentityPolicyRequest.Builder,PutIdentityPolicyRequest>

Represents a request to add or 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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PutIdentityPolicyRequest.Builder

Method Summary

Modifier and Type	Method and Description
static PutIdentityPolicyRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	identity() The identity that the policy will apply to.
String	policy() The text of the policy in JSON format.
String	policyName() The name of the policy.
List<SdkField<?>>	sdkFields()
static Class<? extends PutIdentityPolicyRequest.Builder>	serializableBuilderClass()
PutIdentityPolicyRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

identity

public final String identity()

The identity that the policy will apply to. 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:

The identity that the policy will apply to. 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.

policyName

public final String policyName()

The name of the policy.

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

Returns:

The name of the policy.

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

policy

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

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.

toBuilder

public PutIdentityPolicyRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PutIdentityPolicyRequest.Builder,PutIdentityPolicyRequest>

Specified by:

toBuilder in class SesRequest

builder

public static PutIdentityPolicyRequest.Builder builder()

serializableBuilderClass

public static Class<? extends PutIdentityPolicyRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo