amazonka-sesv2-2.0: Amazon Simple Email Service SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.SESV2.ListSuppressedDestinations

Description

Retrieves a list of email addresses that are on the suppression list for your account.

Synopsis

Creating a Request

data ListSuppressedDestinations Source #

A request to obtain a list of email destinations that are on the suppression list for your account.

See: newListSuppressedDestinations smart constructor.

Constructors

ListSuppressedDestinations' 

Fields

  • endDate :: Maybe POSIX

    Used to filter the list of suppressed email destinations so that it only includes addresses that were added to the list before a specific date.

  • nextToken :: Maybe Text

    A token returned from a previous call to ListSuppressedDestinations to indicate the position in the list of suppressed email addresses.

  • pageSize :: Maybe Int

    The number of results to show in a single call to ListSuppressedDestinations. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results.

  • reasons :: Maybe [SuppressionListReason]

    The factors that caused the email address to be added to .

  • startDate :: Maybe POSIX

    Used to filter the list of suppressed email destinations so that it only includes addresses that were added to the list after a specific date.

Instances

Instances details
ToHeaders ListSuppressedDestinations Source # 
Instance details

Defined in Amazonka.SESV2.ListSuppressedDestinations

Methods

toHeaders :: ListSuppressedDestinations -> [Header] #

ToPath ListSuppressedDestinations Source # 
Instance details

Defined in Amazonka.SESV2.ListSuppressedDestinations

Methods

toPath :: ListSuppressedDestinations -> ByteString #

ToQuery ListSuppressedDestinations Source # 
Instance details

Defined in Amazonka.SESV2.ListSuppressedDestinations

Methods

toQuery :: ListSuppressedDestinations -> QueryString #

AWSRequest ListSuppressedDestinations Source # 
Instance details

Defined in Amazonka.SESV2.ListSuppressedDestinations

Associated Types

type AWSResponse ListSuppressedDestinations #

Methods

request :: (Service -> Service) -> ListSuppressedDestinations -> Request ListSuppressedDestinations #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListSuppressedDestinations -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListSuppressedDestinations))) #

Generic ListSuppressedDestinations Source # 
Instance details

Defined in Amazonka.SESV2.ListSuppressedDestinations

Associated Types

type Rep ListSuppressedDestinations :: Type -> Type #

Methods

from :: ListSuppressedDestinations -> Rep ListSuppressedDestinations x #

to :: Rep ListSuppressedDestinations x -> ListSuppressedDestinations #

Read ListSuppressedDestinations Source # 
Instance details

Defined in Amazonka.SESV2.ListSuppressedDestinations

Methods

readsPrec :: Int -> ReadS ListSuppressedDestinations #

readList :: ReadS [ListSuppressedDestinations] #

readPrec :: ReadPrec ListSuppressedDestinations #

readListPrec :: ReadPrec [ListSuppressedDestinations] #

Show ListSuppressedDestinations Source # 
Instance details

Defined in Amazonka.SESV2.ListSuppressedDestinations

Methods

showsPrec :: Int -> ListSuppressedDestinations -> ShowS #

show :: ListSuppressedDestinations -> String #

showList :: [ListSuppressedDestinations] -> ShowS #

NFData ListSuppressedDestinations Source # 
Instance details

Defined in Amazonka.SESV2.ListSuppressedDestinations

Methods

rnf :: ListSuppressedDestinations -> () #

Eq ListSuppressedDestinations Source # 
Instance details

Defined in Amazonka.SESV2.ListSuppressedDestinations

Methods

(==) :: ListSuppressedDestinations -> ListSuppressedDestinations -> Bool #

(/=) :: ListSuppressedDestinations -> ListSuppressedDestinations -> Bool #

Hashable ListSuppressedDestinations Source # 
Instance details

Defined in Amazonka.SESV2.ListSuppressedDestinations

Methods

hashWithSalt :: Int -> ListSuppressedDestinations -> Int #

hash :: ListSuppressedDestinations -> Int #

type AWSResponse ListSuppressedDestinations Source # 
Instance details

Defined in Amazonka.SESV2.ListSuppressedDestinations

type AWSResponse ListSuppressedDestinations = ListSuppressedDestinationsResponse
type Rep ListSuppressedDestinations Source # 
Instance details

Defined in Amazonka.SESV2.ListSuppressedDestinations

type Rep ListSuppressedDestinations = D1 ('MetaData "ListSuppressedDestinations" "Amazonka.SESV2.ListSuppressedDestinations" "amazonka-sesv2-2.0-KPRo1S1CRfP4bs5VKSgHvB" 'False) (C1 ('MetaCons "ListSuppressedDestinations'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "endDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "pageSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "reasons") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SuppressionListReason])) :*: S1 ('MetaSel ('Just "startDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))))))

newListSuppressedDestinations :: ListSuppressedDestinations Source #

Create a value of ListSuppressedDestinations with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

ListSuppressedDestinations, listSuppressedDestinations_endDate - Used to filter the list of suppressed email destinations so that it only includes addresses that were added to the list before a specific date.

ListSuppressedDestinations, listSuppressedDestinations_nextToken - A token returned from a previous call to ListSuppressedDestinations to indicate the position in the list of suppressed email addresses.

$sel:pageSize:ListSuppressedDestinations', listSuppressedDestinations_pageSize - The number of results to show in a single call to ListSuppressedDestinations. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results.

$sel:reasons:ListSuppressedDestinations', listSuppressedDestinations_reasons - The factors that caused the email address to be added to .

ListSuppressedDestinations, listSuppressedDestinations_startDate - Used to filter the list of suppressed email destinations so that it only includes addresses that were added to the list after a specific date.

Request Lenses

listSuppressedDestinations_endDate :: Lens' ListSuppressedDestinations (Maybe UTCTime) Source #

Used to filter the list of suppressed email destinations so that it only includes addresses that were added to the list before a specific date.

listSuppressedDestinations_nextToken :: Lens' ListSuppressedDestinations (Maybe Text) Source #

A token returned from a previous call to ListSuppressedDestinations to indicate the position in the list of suppressed email addresses.

listSuppressedDestinations_pageSize :: Lens' ListSuppressedDestinations (Maybe Int) Source #

The number of results to show in a single call to ListSuppressedDestinations. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results.

listSuppressedDestinations_reasons :: Lens' ListSuppressedDestinations (Maybe [SuppressionListReason]) Source #

The factors that caused the email address to be added to .

listSuppressedDestinations_startDate :: Lens' ListSuppressedDestinations (Maybe UTCTime) Source #

Used to filter the list of suppressed email destinations so that it only includes addresses that were added to the list after a specific date.

Destructuring the Response

data ListSuppressedDestinationsResponse Source #

A list of suppressed email addresses.

See: newListSuppressedDestinationsResponse smart constructor.

Constructors

ListSuppressedDestinationsResponse' 

Fields

  • nextToken :: Maybe Text

    A token that indicates that there are additional email addresses on the suppression list for your account. To view additional suppressed addresses, issue another request to ListSuppressedDestinations, and pass this token in the NextToken parameter.

  • suppressedDestinationSummaries :: Maybe [SuppressedDestinationSummary]

    A list of summaries, each containing a summary for a suppressed email destination.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic ListSuppressedDestinationsResponse Source # 
Instance details

Defined in Amazonka.SESV2.ListSuppressedDestinations

Associated Types

type Rep ListSuppressedDestinationsResponse :: Type -> Type #

Methods

from :: ListSuppressedDestinationsResponse -> Rep ListSuppressedDestinationsResponse x #

to :: Rep ListSuppressedDestinationsResponse x -> ListSuppressedDestinationsResponse #

Read ListSuppressedDestinationsResponse Source # 
Instance details

Defined in Amazonka.SESV2.ListSuppressedDestinations

Methods

readsPrec :: Int -> ReadS ListSuppressedDestinationsResponse #

readList :: ReadS [ListSuppressedDestinationsResponse] #

readPrec :: ReadPrec ListSuppressedDestinationsResponse #

readListPrec :: ReadPrec [ListSuppressedDestinationsResponse] #

Show ListSuppressedDestinationsResponse Source # 
Instance details

Defined in Amazonka.SESV2.ListSuppressedDestinations

Methods

showsPrec :: Int -> ListSuppressedDestinationsResponse -> ShowS #

show :: ListSuppressedDestinationsResponse -> String #

showList :: [ListSuppressedDestinationsResponse] -> ShowS #

NFData ListSuppressedDestinationsResponse Source # 
Instance details

Defined in Amazonka.SESV2.ListSuppressedDestinations

Methods

rnf :: ListSuppressedDestinationsResponse -> () #

Eq ListSuppressedDestinationsResponse Source # 
Instance details

Defined in Amazonka.SESV2.ListSuppressedDestinations

Methods

(==) :: ListSuppressedDestinationsResponse -> ListSuppressedDestinationsResponse -> Bool #

(/=) :: ListSuppressedDestinationsResponse -> ListSuppressedDestinationsResponse -> Bool #

type Rep ListSuppressedDestinationsResponse Source # 
Instance details

Defined in Amazonka.SESV2.ListSuppressedDestinations

type Rep ListSuppressedDestinationsResponse = D1 ('MetaData "ListSuppressedDestinationsResponse" "Amazonka.SESV2.ListSuppressedDestinations" "amazonka-sesv2-2.0-KPRo1S1CRfP4bs5VKSgHvB" 'False) (C1 ('MetaCons "ListSuppressedDestinationsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "suppressedDestinationSummaries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SuppressedDestinationSummary])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListSuppressedDestinationsResponse Source #

Arguments

:: Int

$sel:httpStatus:ListSuppressedDestinationsResponse'

-> ListSuppressedDestinationsResponse 

Create a value of ListSuppressedDestinationsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

ListSuppressedDestinations, listSuppressedDestinationsResponse_nextToken - A token that indicates that there are additional email addresses on the suppression list for your account. To view additional suppressed addresses, issue another request to ListSuppressedDestinations, and pass this token in the NextToken parameter.

$sel:suppressedDestinationSummaries:ListSuppressedDestinationsResponse', listSuppressedDestinationsResponse_suppressedDestinationSummaries - A list of summaries, each containing a summary for a suppressed email destination.

$sel:httpStatus:ListSuppressedDestinationsResponse', listSuppressedDestinationsResponse_httpStatus - The response's http status code.

Response Lenses

listSuppressedDestinationsResponse_nextToken :: Lens' ListSuppressedDestinationsResponse (Maybe Text) Source #

A token that indicates that there are additional email addresses on the suppression list for your account. To view additional suppressed addresses, issue another request to ListSuppressedDestinations, and pass this token in the NextToken parameter.

listSuppressedDestinationsResponse_suppressedDestinationSummaries :: Lens' ListSuppressedDestinationsResponse (Maybe [SuppressedDestinationSummary]) Source #

A list of summaries, each containing a summary for a suppressed email destination.

listSuppressedDestinationsResponse_httpStatus :: Lens' ListSuppressedDestinationsResponse Int Source #

The response's http status code.