Package software.amazon.awssdk.services.ses.model

Class GetIdentityPoliciesRequest

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.GetIdentityPoliciesRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetIdentityPoliciesRequest.Builder,GetIdentityPoliciesRequest>

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

Represents a request to return the requested sending authorization policies 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	Description
static interface	GetIdentityPoliciesRequest.Builder

Method Summary

Modifier and Type	Method	Description
static GetIdentityPoliciesRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasPolicyNames()	For responses, this returns true if the service returned a value for the PolicyNames property.
String	identity()	The identity for which the policies are retrieved.
List<String>	policyNames()	A list of the names of policies to be retrieved.
List<SdkField<?>>	sdkFields()
static Class<? extends GetIdentityPoliciesRequest.Builder>	serializableBuilderClass()
GetIdentityPoliciesRequest.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 for which the policies are 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 operation, you must own the identity.

Returns:

The identity for which the policies are 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 operation, you must own the identity.

hasPolicyNames

public final boolean hasPolicyNames()

For responses, this returns true if the service returned a value for the PolicyNames property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

policyNames

public final List<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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasPolicyNames() method.

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.

toBuilder

public GetIdentityPoliciesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetIdentityPoliciesRequest.Builder,GetIdentityPoliciesRequest>

Specified by:

toBuilder in class SesRequest

builder

public static GetIdentityPoliciesRequest.Builder builder()

serializableBuilderClass

public static Class<? extends GetIdentityPoliciesRequest.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