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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-s3/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.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#display_name ⇒ String

Screen name of the grantee.

Returns:

  • (String) 


6204
6205
6206
6207
6208
6209
6210
6211
6212
 
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 6204

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

#email_address ⇒ String

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:

  • (String) 


6204
6205
6206
6207
6208
6209
6210
6211
6212
 
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 6204

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

#id ⇒ String

The canonical user ID of the grantee.

Returns:

  • (String) 


6204
6205
6206
6207
6208
6209
6210
6211
6212
 
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 6204

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

#type ⇒ String

Type of grantee

Returns:

  • (String) 


6204
6205
6206
6207
6208
6209
6210
6211
6212
 
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 6204

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

#uri ⇒ String

URI of the grantee group.

Returns:

  • (String) 


6204
6205
6206
6207
6208
6209
6210
6211
6212
 
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 6204

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