Class: Aws::IdentityStore::Types::Photo

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

Overview

Contains information about a user's photo. Users can have up to 3 photos, with one designated as primary. Supports common image formats, including jpg, jpeg, png, and gif.

See Also:

Constant Summary collapse

SENSITIVE = 
[:value, :type, :display, :primary]

Instance Attribute Summary collapse

Instance Attribute Details

#display ⇒ String

A human-readable description of the photo for display purposes. This optional field provides context about the photo.

Returns:

  • (String) 


1532
1533
1534
1535
1536
1537
1538
1539
 
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 1532

class Photo < Struct.new(
  :value,
  :type,
  :display,
  :primary)
  SENSITIVE = [:value, :type, :display, :primary]
  include Aws::Structure
end

#primary ⇒ Boolean

Specifies whether this is the user's primary photo. Default value is false. Only one photo can be designated as primary per user.

Returns:

  • (Boolean) 


1532
1533
1534
1535
1536
1537
1538
1539
 
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 1532

class Photo < Struct.new(
  :value,
  :type,
  :display,
  :primary)
  SENSITIVE = [:value, :type, :display, :primary]
  include Aws::Structure
end

#type ⇒ String

The type of photo. This field is optional and can be used to categorize different types of photos.

Returns:

  • (String) 


1532
1533
1534
1535
1536
1537
1538
1539
 
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 1532

class Photo < Struct.new(
  :value,
  :type,
  :display,
  :primary)
  SENSITIVE = [:value, :type, :display, :primary]
  include Aws::Structure
end

#value ⇒ String

The photo data or URL. Supported formats include jpg, jpeg, png, and gif. This field is required for all photo entries.

Returns:

  • (String) 


1532
1533
1534
1535
1536
1537
1538
1539
 
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 1532

class Photo < Struct.new(
  :value,
  :type,
  :display,
  :primary)
  SENSITIVE = [:value, :type, :display, :primary]
  include Aws::Structure
end