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

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
lib/aws-sdk-s3/types.rb

Overview

Note:

When making an API call, you may pass Grantee data as a 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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#display_nameString

Screen name of the grantee.

Returns:

  • (String)

6166
6167
6168
6169
6170
6171
6172
6173
6174
# File 'lib/aws-sdk-s3/types.rb', line 6166

class Grantee < Struct.new(
  :display_name,
  :email_address,
  :id,
  :type,
  :uri)
  SENSITIVE = []
  include Aws::Structure
end

#email_addressString

Email address of the grantee.

<note markdown=“1”> 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][1

in the Amazon Web Services General

Reference.

</note>

[1]: docs.aws.amazon.com/general/latest/gr/rande.html#s3_region

Returns:

  • (String)

6166
6167
6168
6169
6170
6171
6172
6173
6174
# File 'lib/aws-sdk-s3/types.rb', line 6166

class Grantee < Struct.new(
  :display_name,
  :email_address,
  :id,
  :type,
  :uri)
  SENSITIVE = []
  include Aws::Structure
end

#idString

The canonical user ID of the grantee.

Returns:

  • (String)

6166
6167
6168
6169
6170
6171
6172
6173
6174
# File 'lib/aws-sdk-s3/types.rb', line 6166

class Grantee < Struct.new(
  :display_name,
  :email_address,
  :id,
  :type,
  :uri)
  SENSITIVE = []
  include Aws::Structure
end

#typeString

Type of grantee

Returns:

  • (String)

6166
6167
6168
6169
6170
6171
6172
6173
6174
# File 'lib/aws-sdk-s3/types.rb', line 6166

class Grantee < Struct.new(
  :display_name,
  :email_address,
  :id,
  :type,
  :uri)
  SENSITIVE = []
  include Aws::Structure
end

#uriString

URI of the grantee group.

Returns:

  • (String)

6166
6167
6168
6169
6170
6171
6172
6173
6174
# File 'lib/aws-sdk-s3/types.rb', line 6166

class Grantee < Struct.new(
  :display_name,
  :email_address,
  :id,
  :type,
  :uri)
  SENSITIVE = []
  include Aws::Structure
end