Skip to content

/AWS1/CL_S3_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.

CONSTRUCTOR

IMPORTING

Required arguments:

iv_type TYPE /AWS1/S3_TYPE /AWS1/S3_TYPE

Type of grantee

Optional arguments:

iv_displayname TYPE /AWS1/S3_DISPLAYNAME /AWS1/S3_DISPLAYNAME

Screen name of the grantee.

iv_emailaddress TYPE /AWS1/S3_EMAILADDRESS /AWS1/S3_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.

iv_id TYPE /AWS1/S3_ID /AWS1/S3_ID

The canonical user ID of the grantee.

iv_uri TYPE /AWS1/S3_URI /AWS1/S3_URI

URI of the grantee group.

Queryable Attributes

DisplayName

Screen name of the grantee.

Accessible with the following methods

Method Description
GET_DISPLAYNAME() Getter for DISPLAYNAME, with configurable default
ASK_DISPLAYNAME() Getter for DISPLAYNAME w/ exceptions if field has no value
HAS_DISPLAYNAME() Determine if DISPLAYNAME has a value

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.

Accessible with the following methods

Method Description
GET_EMAILADDRESS() Getter for EMAILADDRESS, with configurable default
ASK_EMAILADDRESS() Getter for EMAILADDRESS w/ exceptions if field has no value
HAS_EMAILADDRESS() Determine if EMAILADDRESS has a value

ID

The canonical user ID of the grantee.

Accessible with the following methods

Method Description
GET_ID() Getter for ID, with configurable default
ASK_ID() Getter for ID w/ exceptions if field has no value
HAS_ID() Determine if ID has a value

URI

URI of the grantee group.

Accessible with the following methods

Method Description
GET_URI() Getter for URI, with configurable default
ASK_URI() Getter for URI w/ exceptions if field has no value
HAS_URI() Determine if URI has a value

Type

Type of grantee

Accessible with the following methods

Method Description
GET_TYPE() Getter for TYPE, with configurable default
ASK_TYPE() Getter for TYPE w/ exceptions if field has no value
HAS_TYPE() Determine if TYPE has a value