You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::S3::Types::Grantee

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing Grantee as input to an Aws::Client method, you can use a vanilla Hash:

{
  display_name: "DisplayName",
  email_address: "EmailAddress",
  id: "ID",
  type: "CanonicalUser", # required, accepts CanonicalUser, AmazonCustomerByEmail, Group
  uri: "URI",
}

Container for the person being granted permissions.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#display_name ⇒ String

Screen name of the grantee.

Returns:

  • (String) —

    Screen name of the grantee.

#email_address ⇒ String

Email address of the grantee.

Using email addresses to specify a grantee is only supported in the following AWS 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 AWS General Reference.

Returns:

  • (String) —

    Email address of the grantee.

#id ⇒ String

The canonical user ID of the grantee.

Returns:

  • (String) —

    The canonical user ID of the grantee.

#type ⇒ String

Type of grantee

Possible values:

  • CanonicalUser
  • AmazonCustomerByEmail
  • Group

Returns:

  • (String) —

    Type of grantee.

#uri ⇒ String

URI of the grantee group.

Returns:

  • (String) —

    URI of the grantee group.