Amazonka.SNS.ListPhoneNumbersOptedOut

Returns a list of phone numbers that are opted out, meaning you cannot send SMS messages to them.

The results for ListPhoneNumbersOptedOut are paginated, and each page returns up to 100 phone numbers. If additional phone numbers are available after the first page of results, then a NextToken string will be returned. To receive the next page, you call ListPhoneNumbersOptedOut again using the NextToken string received from the previous call. When there are no more records to return, NextToken will be null.

This operation returns paginated results.

Creating a Request

data ListPhoneNumbersOptedOut

The input for the ListPhoneNumbersOptedOut action.

See: newListPhoneNumbersOptedOut smart constructor.

Constructors

ListPhoneNumbersOptedOut'

Fields

• nextToken :: Maybe Text

  A NextToken string is used when you call the ListPhoneNumbersOptedOut action to retrieve additional records that are available after the first page of results.

Instances

ToHeaders ListPhoneNumbersOptedOut

Defined in Amazonka.SNS.ListPhoneNumbersOptedOut

Methods

toHeaders :: ListPhoneNumbersOptedOut -> [Header]

ToPath ListPhoneNumbersOptedOut

Defined in Amazonka.SNS.ListPhoneNumbersOptedOut

Methods

toPath :: ListPhoneNumbersOptedOut -> ByteString

ToQuery ListPhoneNumbersOptedOut

Defined in Amazonka.SNS.ListPhoneNumbersOptedOut

Methods

toQuery :: ListPhoneNumbersOptedOut -> QueryString

AWSPager ListPhoneNumbersOptedOut

Defined in Amazonka.SNS.ListPhoneNumbersOptedOut

Methods

page :: ListPhoneNumbersOptedOut -> AWSResponse ListPhoneNumbersOptedOut -> Maybe ListPhoneNumbersOptedOut

AWSRequest ListPhoneNumbersOptedOut

Defined in Amazonka.SNS.ListPhoneNumbersOptedOut

Associated Types

type AWSResponse ListPhoneNumbersOptedOut

Methods

request :: (Service -> Service) -> ListPhoneNumbersOptedOut -> Request ListPhoneNumbersOptedOut

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

Generic ListPhoneNumbersOptedOut

Defined in Amazonka.SNS.ListPhoneNumbersOptedOut

Associated Types

type Rep ListPhoneNumbersOptedOut :: Type -> Type

Methods

from :: ListPhoneNumbersOptedOut -> Rep ListPhoneNumbersOptedOut x

to :: Rep ListPhoneNumbersOptedOut x -> ListPhoneNumbersOptedOut

Read ListPhoneNumbersOptedOut

Defined in Amazonka.SNS.ListPhoneNumbersOptedOut

Methods

readsPrec :: Int -> ReadS ListPhoneNumbersOptedOut

readList :: ReadS [ListPhoneNumbersOptedOut]

readPrec :: ReadPrec ListPhoneNumbersOptedOut

readListPrec :: ReadPrec [ListPhoneNumbersOptedOut]

Show ListPhoneNumbersOptedOut

Defined in Amazonka.SNS.ListPhoneNumbersOptedOut

Methods

showsPrec :: Int -> ListPhoneNumbersOptedOut -> ShowS

show :: ListPhoneNumbersOptedOut -> String

showList :: [ListPhoneNumbersOptedOut] -> ShowS

NFData ListPhoneNumbersOptedOut

Defined in Amazonka.SNS.ListPhoneNumbersOptedOut

Methods

rnf :: ListPhoneNumbersOptedOut -> ()

Eq ListPhoneNumbersOptedOut

Defined in Amazonka.SNS.ListPhoneNumbersOptedOut

Methods

(==) :: ListPhoneNumbersOptedOut -> ListPhoneNumbersOptedOut -> Bool

(/=) :: ListPhoneNumbersOptedOut -> ListPhoneNumbersOptedOut -> Bool

Hashable ListPhoneNumbersOptedOut

Defined in Amazonka.SNS.ListPhoneNumbersOptedOut

Methods

hashWithSalt :: Int -> ListPhoneNumbersOptedOut -> Int

hash :: ListPhoneNumbersOptedOut -> Int

type AWSResponse ListPhoneNumbersOptedOut

Defined in Amazonka.SNS.ListPhoneNumbersOptedOut

type AWSResponse ListPhoneNumbersOptedOut = ListPhoneNumbersOptedOutResponse

type Rep ListPhoneNumbersOptedOut

Defined in Amazonka.SNS.ListPhoneNumbersOptedOut

type Rep ListPhoneNumbersOptedOut = D1 ('MetaData "ListPhoneNumbersOptedOut" "Amazonka.SNS.ListPhoneNumbersOptedOut" "amazonka-sns-2.0-4k7AiJI7DyqhOUy5o4qb9" 'False) (C1 ('MetaCons "ListPhoneNumbersOptedOut'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newListPhoneNumbersOptedOut :: ListPhoneNumbersOptedOut

Create a value of ListPhoneNumbersOptedOut 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:

ListPhoneNumbersOptedOut, listPhoneNumbersOptedOut_nextToken - A NextToken string is used when you call the ListPhoneNumbersOptedOut action to retrieve additional records that are available after the first page of results.

Request Lenses

listPhoneNumbersOptedOut_nextToken :: Lens' ListPhoneNumbersOptedOut (Maybe Text)

A NextToken string is used when you call the ListPhoneNumbersOptedOut action to retrieve additional records that are available after the first page of results.

Destructuring the Response

data ListPhoneNumbersOptedOutResponse

The response from the ListPhoneNumbersOptedOut action.

See: newListPhoneNumbersOptedOutResponse smart constructor.

Constructors

ListPhoneNumbersOptedOutResponse'

Fields

• nextToken :: Maybe Text

  A NextToken string is returned when you call the ListPhoneNumbersOptedOut action if additional records are available after the first page of results.

• phoneNumbers :: Maybe [Text]

  A list of phone numbers that are opted out of receiving SMS messages. The list is paginated, and each page can contain up to 100 phone numbers.

• httpStatus :: Int

  The response's http status code.

Instances

Generic ListPhoneNumbersOptedOutResponse

Defined in Amazonka.SNS.ListPhoneNumbersOptedOut

Associated Types

type Rep ListPhoneNumbersOptedOutResponse :: Type -> Type

Methods

from :: ListPhoneNumbersOptedOutResponse -> Rep ListPhoneNumbersOptedOutResponse x

to :: Rep ListPhoneNumbersOptedOutResponse x -> ListPhoneNumbersOptedOutResponse

Read ListPhoneNumbersOptedOutResponse

Defined in Amazonka.SNS.ListPhoneNumbersOptedOut

Methods

readsPrec :: Int -> ReadS ListPhoneNumbersOptedOutResponse

readList :: ReadS [ListPhoneNumbersOptedOutResponse]

readPrec :: ReadPrec ListPhoneNumbersOptedOutResponse

readListPrec :: ReadPrec [ListPhoneNumbersOptedOutResponse]

Show ListPhoneNumbersOptedOutResponse

Defined in Amazonka.SNS.ListPhoneNumbersOptedOut

Methods

showsPrec :: Int -> ListPhoneNumbersOptedOutResponse -> ShowS

show :: ListPhoneNumbersOptedOutResponse -> String

showList :: [ListPhoneNumbersOptedOutResponse] -> ShowS

NFData ListPhoneNumbersOptedOutResponse

Defined in Amazonka.SNS.ListPhoneNumbersOptedOut

Methods

rnf :: ListPhoneNumbersOptedOutResponse -> ()

Eq ListPhoneNumbersOptedOutResponse

Defined in Amazonka.SNS.ListPhoneNumbersOptedOut

Methods

(==) :: ListPhoneNumbersOptedOutResponse -> ListPhoneNumbersOptedOutResponse -> Bool

(/=) :: ListPhoneNumbersOptedOutResponse -> ListPhoneNumbersOptedOutResponse -> Bool

type Rep ListPhoneNumbersOptedOutResponse

Defined in Amazonka.SNS.ListPhoneNumbersOptedOut

type Rep ListPhoneNumbersOptedOutResponse = D1 ('MetaData "ListPhoneNumbersOptedOutResponse" "Amazonka.SNS.ListPhoneNumbersOptedOut" "amazonka-sns-2.0-4k7AiJI7DyqhOUy5o4qb9" 'False) (C1 ('MetaCons "ListPhoneNumbersOptedOutResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "phoneNumbers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListPhoneNumbersOptedOutResponse

Arguments

:: Int

$sel:httpStatus:ListPhoneNumbersOptedOutResponse'

-> ListPhoneNumbersOptedOutResponse

Create a value of ListPhoneNumbersOptedOutResponse 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:

ListPhoneNumbersOptedOut, listPhoneNumbersOptedOutResponse_nextToken - A NextToken string is returned when you call the ListPhoneNumbersOptedOut action if additional records are available after the first page of results.

$sel:phoneNumbers:ListPhoneNumbersOptedOutResponse', listPhoneNumbersOptedOutResponse_phoneNumbers - A list of phone numbers that are opted out of receiving SMS messages. The list is paginated, and each page can contain up to 100 phone numbers.

$sel:httpStatus:ListPhoneNumbersOptedOutResponse', listPhoneNumbersOptedOutResponse_httpStatus - The response's http status code.

Response Lenses

listPhoneNumbersOptedOutResponse_nextToken :: Lens' ListPhoneNumbersOptedOutResponse (Maybe Text)

A NextToken string is returned when you call the ListPhoneNumbersOptedOut action if additional records are available after the first page of results.

listPhoneNumbersOptedOutResponse_phoneNumbers :: Lens' ListPhoneNumbersOptedOutResponse (Maybe [Text])

A list of phone numbers that are opted out of receiving SMS messages. The list is paginated, and each page can contain up to 100 phone numbers.

listPhoneNumbersOptedOutResponse_httpStatus :: Lens' ListPhoneNumbersOptedOutResponse Int

The response's http status code.