Class: Aws::SESV2::Types::ListContactsRequest

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

Overview

Note:

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

{
  contact_list_name: "ContactListName", # required
  filter: {
    filtered_status: "OPT_IN", # accepts OPT_IN, OPT_OUT
    topic_filter: {
      topic_name: "TopicName",
      use_default_if_preference_unavailable: false,
    },
  },
  page_size: 1,
  next_token: "NextToken",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#contact_list_nameString

The name of the contact list.

Returns:

  • (String)


3928
3929
3930
3931
3932
3933
3934
3935
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb', line 3928

class ListContactsRequest < Struct.new(
  :contact_list_name,
  :filter,
  :page_size,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#filterTypes::ListContactsFilter

A filter that can be applied to a list of contacts.



3928
3929
3930
3931
3932
3933
3934
3935
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb', line 3928

class ListContactsRequest < Struct.new(
  :contact_list_name,
  :filter,
  :page_size,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

A string token indicating that there might be additional contacts available to be listed. Use the token provided in the Response to use in the subsequent call to ListContacts with the same parameters to retrieve the next page of contacts.

Returns:

  • (String)


3928
3929
3930
3931
3932
3933
3934
3935
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb', line 3928

class ListContactsRequest < Struct.new(
  :contact_list_name,
  :filter,
  :page_size,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#page_sizeInteger

The number of contacts that may be returned at once, which is dependent on if there are more or less contacts than the value of the PageSize. Use this parameter to paginate results. If additional contacts exist beyond the specified limit, the NextToken element is sent in the response. Use the NextToken value in subsequent requests to retrieve additional contacts.

Returns:

  • (Integer)


3928
3929
3930
3931
3932
3933
3934
3935
# File 'gems/aws-sdk-sesv2/lib/aws-sdk-sesv2/types.rb', line 3928

class ListContactsRequest < Struct.new(
  :contact_list_name,
  :filter,
  :page_size,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end