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

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

Overview

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:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#display_name ⇒ String

Screen name of the grantee.

Returns:

  • (String) 


9074
9075
9076
9077
9078
9079
9080
9081
9082
 
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 9074

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) 


9074
9075
9076
9077
9078
9079
9080
9081
9082
 
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 9074

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) 


9074
9075
9076
9077
9078
9079
9080
9081
9082
 
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 9074

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

#type ⇒ String

Type of grantee

Returns:

  • (String) 


9074
9075
9076
9077
9078
9079
9080
9081
9082
 
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 9074

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) 


9074
9075
9076
9077
9078
9079
9080
9081
9082
 
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 9074

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