Class: Aws::IdentityStore::Types::DescribeGroupResponse

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

Overview

Constant Summary collapse

SENSITIVE =
[:display_name, :description]

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

A string containing a description of the group.

Returns:

  • (String)


525
526
527
528
529
530
531
532
533
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 525

class DescribeGroupResponse < Struct.new(
  :group_id,
  :display_name,
  :external_ids,
  :description,
  :identity_store_id)
  SENSITIVE = [:display_name, :description]
  include Aws::Structure
end

#display_nameString

The group’s display name value. The length limit is 1,024 characters. This value can consist of letters, accented characters, symbols, numbers, punctuation, tab, new line, carriage return, space, and nonbreaking space in this attribute. This value is specified at the time that the group is created and stored as an attribute of the group object in the identity store.

Returns:

  • (String)


525
526
527
528
529
530
531
532
533
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 525

class DescribeGroupResponse < Struct.new(
  :group_id,
  :display_name,
  :external_ids,
  :description,
  :identity_store_id)
  SENSITIVE = [:display_name, :description]
  include Aws::Structure
end

#external_idsArray<Types::ExternalId>

A list of ExternalId objects that contains the identifiers issued to this resource by an external identity provider.

Returns:



525
526
527
528
529
530
531
532
533
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 525

class DescribeGroupResponse < Struct.new(
  :group_id,
  :display_name,
  :external_ids,
  :description,
  :identity_store_id)
  SENSITIVE = [:display_name, :description]
  include Aws::Structure
end

#group_idString

The identifier for a group in the identity store.

Returns:

  • (String)


525
526
527
528
529
530
531
532
533
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 525

class DescribeGroupResponse < Struct.new(
  :group_id,
  :display_name,
  :external_ids,
  :description,
  :identity_store_id)
  SENSITIVE = [:display_name, :description]
  include Aws::Structure
end

#identity_store_idString

The globally unique identifier for the identity store.

Returns:

  • (String)


525
526
527
528
529
530
531
532
533
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 525

class DescribeGroupResponse < Struct.new(
  :group_id,
  :display_name,
  :external_ids,
  :description,
  :identity_store_id)
  SENSITIVE = [:display_name, :description]
  include Aws::Structure
end