Amazonka.SNS.CheckIfPhoneNumberIsOptedOut

Accepts a phone number and indicates whether the phone holder has opted out of receiving SMS messages from your Amazon Web Services account. You cannot send SMS messages to a number that is opted out.

To resume sending messages, you can opt in the number by using the OptInPhoneNumber action.

Creating a Request

data CheckIfPhoneNumberIsOptedOut

The input for the CheckIfPhoneNumberIsOptedOut action.

See: newCheckIfPhoneNumberIsOptedOut smart constructor.

Constructors

CheckIfPhoneNumberIsOptedOut'

Fields

• phoneNumber :: Text

  The phone number for which you want to check the opt out status.

Instances

ToHeaders CheckIfPhoneNumberIsOptedOut

Defined in Amazonka.SNS.CheckIfPhoneNumberIsOptedOut

Methods

toHeaders :: CheckIfPhoneNumberIsOptedOut -> [Header]

ToPath CheckIfPhoneNumberIsOptedOut

Defined in Amazonka.SNS.CheckIfPhoneNumberIsOptedOut

Methods

toPath :: CheckIfPhoneNumberIsOptedOut -> ByteString

ToQuery CheckIfPhoneNumberIsOptedOut

Defined in Amazonka.SNS.CheckIfPhoneNumberIsOptedOut

Methods

toQuery :: CheckIfPhoneNumberIsOptedOut -> QueryString

AWSRequest CheckIfPhoneNumberIsOptedOut

Defined in Amazonka.SNS.CheckIfPhoneNumberIsOptedOut

Associated Types

type AWSResponse CheckIfPhoneNumberIsOptedOut

Methods

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

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

Generic CheckIfPhoneNumberIsOptedOut

Defined in Amazonka.SNS.CheckIfPhoneNumberIsOptedOut

Associated Types

type Rep CheckIfPhoneNumberIsOptedOut :: Type -> Type

Methods

from :: CheckIfPhoneNumberIsOptedOut -> Rep CheckIfPhoneNumberIsOptedOut x

to :: Rep CheckIfPhoneNumberIsOptedOut x -> CheckIfPhoneNumberIsOptedOut

Read CheckIfPhoneNumberIsOptedOut

Defined in Amazonka.SNS.CheckIfPhoneNumberIsOptedOut

Methods

readsPrec :: Int -> ReadS CheckIfPhoneNumberIsOptedOut

readList :: ReadS [CheckIfPhoneNumberIsOptedOut]

readPrec :: ReadPrec CheckIfPhoneNumberIsOptedOut

readListPrec :: ReadPrec [CheckIfPhoneNumberIsOptedOut]

Show CheckIfPhoneNumberIsOptedOut

Defined in Amazonka.SNS.CheckIfPhoneNumberIsOptedOut

Methods

showsPrec :: Int -> CheckIfPhoneNumberIsOptedOut -> ShowS

show :: CheckIfPhoneNumberIsOptedOut -> String

showList :: [CheckIfPhoneNumberIsOptedOut] -> ShowS

NFData CheckIfPhoneNumberIsOptedOut

Defined in Amazonka.SNS.CheckIfPhoneNumberIsOptedOut

Methods

rnf :: CheckIfPhoneNumberIsOptedOut -> ()

Eq CheckIfPhoneNumberIsOptedOut

Defined in Amazonka.SNS.CheckIfPhoneNumberIsOptedOut

Methods

(==) :: CheckIfPhoneNumberIsOptedOut -> CheckIfPhoneNumberIsOptedOut -> Bool

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

Hashable CheckIfPhoneNumberIsOptedOut

Defined in Amazonka.SNS.CheckIfPhoneNumberIsOptedOut

Methods

hashWithSalt :: Int -> CheckIfPhoneNumberIsOptedOut -> Int

hash :: CheckIfPhoneNumberIsOptedOut -> Int

type AWSResponse CheckIfPhoneNumberIsOptedOut

Defined in Amazonka.SNS.CheckIfPhoneNumberIsOptedOut

type AWSResponse CheckIfPhoneNumberIsOptedOut = CheckIfPhoneNumberIsOptedOutResponse

type Rep CheckIfPhoneNumberIsOptedOut

Defined in Amazonka.SNS.CheckIfPhoneNumberIsOptedOut

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

newCheckIfPhoneNumberIsOptedOut

Arguments

:: Text

CheckIfPhoneNumberIsOptedOut

-> CheckIfPhoneNumberIsOptedOut

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

CheckIfPhoneNumberIsOptedOut, checkIfPhoneNumberIsOptedOut_phoneNumber - The phone number for which you want to check the opt out status.

Request Lenses

checkIfPhoneNumberIsOptedOut_phoneNumber :: Lens' CheckIfPhoneNumberIsOptedOut Text

The phone number for which you want to check the opt out status.

Destructuring the Response

data CheckIfPhoneNumberIsOptedOutResponse

The response from the CheckIfPhoneNumberIsOptedOut action.

See: newCheckIfPhoneNumberIsOptedOutResponse smart constructor.

Constructors

CheckIfPhoneNumberIsOptedOutResponse'

Fields

• isOptedOut :: Maybe Bool

  Indicates whether the phone number is opted out:

  • true – The phone number is opted out, meaning you cannot publish SMS messages to it.
  • false – The phone number is opted in, meaning you can publish SMS messages to it.
• httpStatus :: Int

  The response's http status code.

Instances

Generic CheckIfPhoneNumberIsOptedOutResponse

Defined in Amazonka.SNS.CheckIfPhoneNumberIsOptedOut

Associated Types

type Rep CheckIfPhoneNumberIsOptedOutResponse :: Type -> Type

Methods

from :: CheckIfPhoneNumberIsOptedOutResponse -> Rep CheckIfPhoneNumberIsOptedOutResponse x

to :: Rep CheckIfPhoneNumberIsOptedOutResponse x -> CheckIfPhoneNumberIsOptedOutResponse

Read CheckIfPhoneNumberIsOptedOutResponse

Defined in Amazonka.SNS.CheckIfPhoneNumberIsOptedOut

Methods

readsPrec :: Int -> ReadS CheckIfPhoneNumberIsOptedOutResponse

readList :: ReadS [CheckIfPhoneNumberIsOptedOutResponse]

readPrec :: ReadPrec CheckIfPhoneNumberIsOptedOutResponse

readListPrec :: ReadPrec [CheckIfPhoneNumberIsOptedOutResponse]

Show CheckIfPhoneNumberIsOptedOutResponse

Defined in Amazonka.SNS.CheckIfPhoneNumberIsOptedOut

Methods

showsPrec :: Int -> CheckIfPhoneNumberIsOptedOutResponse -> ShowS

show :: CheckIfPhoneNumberIsOptedOutResponse -> String

showList :: [CheckIfPhoneNumberIsOptedOutResponse] -> ShowS

NFData CheckIfPhoneNumberIsOptedOutResponse

Defined in Amazonka.SNS.CheckIfPhoneNumberIsOptedOut

Methods

rnf :: CheckIfPhoneNumberIsOptedOutResponse -> ()

Eq CheckIfPhoneNumberIsOptedOutResponse

Defined in Amazonka.SNS.CheckIfPhoneNumberIsOptedOut

Methods

(==) :: CheckIfPhoneNumberIsOptedOutResponse -> CheckIfPhoneNumberIsOptedOutResponse -> Bool

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

type Rep CheckIfPhoneNumberIsOptedOutResponse

Defined in Amazonka.SNS.CheckIfPhoneNumberIsOptedOut

type Rep CheckIfPhoneNumberIsOptedOutResponse = D1 ('MetaData "CheckIfPhoneNumberIsOptedOutResponse" "Amazonka.SNS.CheckIfPhoneNumberIsOptedOut" "amazonka-sns-2.0-4k7AiJI7DyqhOUy5o4qb9" 'False) (C1 ('MetaCons "CheckIfPhoneNumberIsOptedOutResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "isOptedOut") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCheckIfPhoneNumberIsOptedOutResponse

Arguments

:: Int

$sel:httpStatus:CheckIfPhoneNumberIsOptedOutResponse'

-> CheckIfPhoneNumberIsOptedOutResponse

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

$sel:isOptedOut:CheckIfPhoneNumberIsOptedOutResponse', checkIfPhoneNumberIsOptedOutResponse_isOptedOut - Indicates whether the phone number is opted out:

• true – The phone number is opted out, meaning you cannot publish SMS messages to it.
• false – The phone number is opted in, meaning you can publish SMS messages to it.

$sel:httpStatus:CheckIfPhoneNumberIsOptedOutResponse', checkIfPhoneNumberIsOptedOutResponse_httpStatus - The response's http status code.

Response Lenses

checkIfPhoneNumberIsOptedOutResponse_isOptedOut :: Lens' CheckIfPhoneNumberIsOptedOutResponse (Maybe Bool)

Indicates whether the phone number is opted out:

• true – The phone number is opted out, meaning you cannot publish SMS messages to it.
• false – The phone number is opted in, meaning you can publish SMS messages to it.

checkIfPhoneNumberIsOptedOutResponse_httpStatus :: Lens' CheckIfPhoneNumberIsOptedOutResponse Int

The response's http status code.