Package software.amazon.awssdk.services.s3.model

Class Grantee

java.lang.Object

software.amazon.awssdk.services.s3.model.Grantee

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Grantee.Builder,Grantee>

@Generated("software.amazon.awssdk:codegen")
public final class Grantee
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Grantee.Builder,Grantee>

End of support notice: Beginning November 21, 2025, Amazon S3 will stop returning DisplayName. Update your applications to use canonical IDs (unique identifier for Amazon Web Services accounts), Amazon Web Services account ID (12 digit identifier) or IAM ARNs (full resource naming) as a direct replacement of DisplayName.

This change affects the following Amazon Web Services Regions: US East (N. Virginia) Region, US West (N. California) Region, US West (Oregon) Region, Asia Pacific (Singapore) Region, Asia Pacific (Sydney) Region, Asia Pacific (Tokyo) Region, Europe (Ireland) Region, and South America (São Paulo) Region.

Container for the person being granted permissions.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Grantee.Builder

Method Summary

Modifier and Type	Method	Description
static Grantee.Builder	builder()
String	displayName()	Screen name of the grantee.
String	emailAddress()	Email address of the grantee.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	id()	The canonical user ID of the grantee.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends Grantee.Builder>	serializableBuilderClass()
Grantee.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Type	type()	Type of grantee
String	typeAsString()	Type of grantee
String	uri()	URI of the grantee group.

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

displayName

public final String displayName()

Screen name of the grantee.

Returns:

Screen name of the grantee.

emailAddress

public final String emailAddress()

Email address of the grantee.

Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

• US East (N. Virginia)

• US West (N. California)

• US West (Oregon)

• Asia Pacific (Singapore)

• Asia Pacific (Sydney)

• Asia Pacific (Tokyo)

• Europe (Ireland)

• South America (São Paulo)

For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

Returns:

Email address of the grantee.

Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

• US East (N. Virginia)

• US West (N. California)

• US West (Oregon)

• Asia Pacific (Singapore)

• Asia Pacific (Sydney)

• Asia Pacific (Tokyo)

• Europe (Ireland)

• South America (São Paulo)

For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

id

public final String id()

The canonical user ID of the grantee.

Returns:

The canonical user ID of the grantee.

type

public final Type type()

Type of grantee

If the service returns an enum value that is not available in the current SDK version, type will return Type.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

Type of grantee

See Also:

Type

typeAsString

public final String typeAsString()

Type of grantee

If the service returns an enum value that is not available in the current SDK version, type will return Type.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

Type of grantee

See Also:

Type

uri

public final String uri()

URI of the grantee group.

Returns:

URI of the grantee group.

toBuilder

public Grantee.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Grantee.Builder,Grantee>

builder

public static Grantee.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo