You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::WorkMail::Types::ListAliasesRequest

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

Overview

Note:

When making an API call, you may pass ListAliasesRequest data as a hash:

{
  organization_id: "OrganizationId", # required
  entity_id: "WorkMailIdentifier", # required
  next_token: "NextToken",
  max_results: 1,
}

Instance Attribute Summary collapse

Instance Attribute Details

#entity_idString

The identifier for the entity for which to list the aliases.

Returns:

  • (String)


904
905
906
907
908
909
910
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 904

class ListAliasesRequest < Struct.new(
  :organization_id,
  :entity_id,
  :next_token,
  :max_results)
  include Aws::Structure
end

#max_resultsInteger

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

Returns:

  • (Integer)


904
905
906
907
908
909
910
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 904

class ListAliasesRequest < Struct.new(
  :organization_id,
  :entity_id,
  :next_token,
  :max_results)
  include Aws::Structure
end

#next_tokenString

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

Returns:

  • (String)


904
905
906
907
908
909
910
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 904

class ListAliasesRequest < Struct.new(
  :organization_id,
  :entity_id,
  :next_token,
  :max_results)
  include Aws::Structure
end

#organization_idString

The identifier for the organization under which the entity exists.

Returns:

  • (String)


904
905
906
907
908
909
910
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 904

class ListAliasesRequest < Struct.new(
  :organization_id,
  :entity_id,
  :next_token,
  :max_results)
  include Aws::Structure
end