NAME

Paws::SESv2::ListContacts - Arguments for method ListContacts on Paws::SESv2

DESCRIPTION

This class represents the parameters used for calling the method ListContacts on the Amazon Simple Email Service service. Use the attributes of this class as arguments to method ListContacts.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListContacts.

SYNOPSIS

    my $email = Paws->service('SESv2');
    my $ListContactsResponse = $email->ListContacts(
      ContactListName => 'MyContactListName',
      Filter          => {
        FilteredStatus => 'OPT_IN',    # values: OPT_IN, OPT_OUT; OPTIONAL
        TopicFilter    => {
          TopicName                         => 'MyTopicName',    # OPTIONAL
          UseDefaultIfPreferenceUnavailable => 1,                # OPTIONAL
        },    # OPTIONAL
      },    # OPTIONAL
      NextToken => 'MyNextToken',    # OPTIONAL
      PageSize  => 1,                # OPTIONAL
    );

    # Results:
    my $Contacts  = $ListContactsResponse->Contacts;
    my $NextToken = $ListContactsResponse->NextToken;

    # Returns a L<Paws::SESv2::ListContactsResponse> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/email/ListContacts

ATTRIBUTES

REQUIRED ContactListName => Str

The name of the contact list.

Filter => Paws::SESv2::ListContactsFilter

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

NextToken => Str

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.

PageSize => Int

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.

SEE ALSO

This class forms part of Paws, documenting arguments for method ListContacts in Paws::SESv2

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues