Class: Aws::WorkMail::Types::ListGroupsForEntityRequest

Inherits:

Struct

• Object
• Struct
• Aws::WorkMail::Types::ListGroupsForEntityRequest

Defined in:

gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #entity_id ⇒ String

  The identifier for the entity.

• #filters ⇒ Types::ListGroupsForEntityFilters

  Limit the search results based on the filter criteria.

• #max_results ⇒ Integer

  The maximum number of results to return in a single call.

• #next_token ⇒ String

  The token to use to retrieve the next page of results.

• #organization_id ⇒ String

  The identifier for the organization under which the entity exists.

Instance Attribute Details

#entity_id ⇒ String

The identifier for the entity.

The entity ID can accept UserId or GroupID, Username or Groupname, or email.

• Entity ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234

• Email address: entity@domain.tld

• Entity name: entity

Returns:

• (String)

# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 2974

class ListGroupsForEntityRequest < Struct.new(
  :organization_id,
  :entity_id,
  :filters,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#filters ⇒ Types::ListGroupsForEntityFilters

Limit the search results based on the filter criteria.

Returns:

• (Types::ListGroupsForEntityFilters)

# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 2974

class ListGroupsForEntityRequest < Struct.new(
  :organization_id,
  :entity_id,
  :filters,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

The maximum number of results to return in a single call.

Returns:

• (Integer)

# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 2974

class ListGroupsForEntityRequest < Struct.new(
  :organization_id,
  :entity_id,
  :filters,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

The token to use to retrieve the next page of results. The first call does not contain any tokens.

Returns:

• (String)

# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 2974

class ListGroupsForEntityRequest < Struct.new(
  :organization_id,
  :entity_id,
  :filters,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#organization_id ⇒ String

The identifier for the organization under which the entity exists.

Returns:

• (String)

# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 2974

class ListGroupsForEntityRequest < Struct.new(
  :organization_id,
  :entity_id,
  :filters,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end