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

Class: Aws::SES::Types::ListIdentitiesRequest

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

Overview

Note:

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

{
  identity_type: "EmailAddress", # accepts EmailAddress, Domain
  next_token: "NextToken",
  max_items: 1,
}

Represents a request to return a list of all identities (email addresses and domains) that you have attempted to verify under your AWS account, regardless of verification status.

Instance Attribute Summary collapse

Instance Attribute Details

#identity_typeString

The type of the identities to list. Possible values are "EmailAddress" and "Domain". If this parameter is omitted, then all identities will be listed.

Returns:

  • (String)


1972
1973
1974
1975
1976
1977
# File 'gems/aws-sdk-ses/lib/aws-sdk-ses/types.rb', line 1972

class ListIdentitiesRequest < Struct.new(
  :identity_type,
  :next_token,
  :max_items)
  include Aws::Structure
end

#max_itemsInteger

The maximum number of identities per page. Possible values are 1-1000 inclusive.

Returns:

  • (Integer)


1972
1973
1974
1975
1976
1977
# File 'gems/aws-sdk-ses/lib/aws-sdk-ses/types.rb', line 1972

class ListIdentitiesRequest < Struct.new(
  :identity_type,
  :next_token,
  :max_items)
  include Aws::Structure
end

#next_tokenString

The token to use for pagination.

Returns:

  • (String)


1972
1973
1974
1975
1976
1977
# File 'gems/aws-sdk-ses/lib/aws-sdk-ses/types.rb', line 1972

class ListIdentitiesRequest < Struct.new(
  :identity_type,
  :next_token,
  :max_items)
  include Aws::Structure
end