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:

ToCopyableBuilder<PutIdentityPolicyRequest.Builder,PutIdentityPolicyRequest>

@Generated(value="software.amazon.awssdk:codegen")
public 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)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
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.
static Class<? extends PutIdentityPolicyRequest.Builder>	serializableBuilderClass()
PutIdentityPolicyRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

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

requestOverrideConfig

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

identity

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

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<PutIdentityPolicyRequest.Builder,PutIdentityPolicyRequest>

Specified by:

toBuilder in class SESRequest

Returns:

a builder for type T

builder

public static PutIdentityPolicyRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

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

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value