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("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.

  • Method Details

    • identity

      public final String identity()

      The identity to which that the policy applies. 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 operation, you must own the identity.

      Returns:
      The identity to which that the policy applies. 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 operation, 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()
      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 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      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

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.