Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.PinpointSmsVoiceV2.DescribeOptedOutNumbers

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes the specified opted out destination numbers or all opted out destination numbers in an opt-out list.

If you specify opted out numbers, the output includes information for only the specified opted out numbers. If you specify filters, the output includes information for only those opted out numbers that meet the filter criteria. If you don't specify opted out numbers or filters, the output includes information for all opted out destination numbers in your opt-out list.

If you specify an opted out number that isn't valid, an Error is returned.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeOptedOutNumbers Source #

See: newDescribeOptedOutNumbers smart constructor.

Constructors

DescribeOptedOutNumbers'

Fields

filters :: Maybe [OptedOutFilter]
An array of OptedOutFilter objects to filter the results on.
maxResults :: Maybe Natural
The maximum number of results to return per each request.
nextToken :: Maybe Text
The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.
optedOutNumbers :: Maybe [Text]
An array of phone numbers to search for in the OptOutList.
optOutListName :: Text
The OptOutListName or OptOutListArn of the OptOutList. You can use DescribeOptOutLists to find the values for OptOutListName and OptOutListArn.

Instances

Instances details

ToJSON DescribeOptedOutNumbers Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.DescribeOptedOutNumbers Methods toJSON :: DescribeOptedOutNumbers -> Value # toEncoding :: DescribeOptedOutNumbers -> Encoding # toJSONList :: [DescribeOptedOutNumbers] -> Value # toEncodingList :: [DescribeOptedOutNumbers] -> Encoding #
ToHeaders DescribeOptedOutNumbers Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.DescribeOptedOutNumbers Methods toHeaders :: DescribeOptedOutNumbers -> [Header] #
ToPath DescribeOptedOutNumbers Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.DescribeOptedOutNumbers Methods toPath :: DescribeOptedOutNumbers -> ByteString #
ToQuery DescribeOptedOutNumbers Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.DescribeOptedOutNumbers Methods toQuery :: DescribeOptedOutNumbers -> QueryString #
AWSPager DescribeOptedOutNumbers Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.DescribeOptedOutNumbers Methods page :: DescribeOptedOutNumbers -> AWSResponse DescribeOptedOutNumbers -> Maybe DescribeOptedOutNumbers #
AWSRequest DescribeOptedOutNumbers Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.DescribeOptedOutNumbers Associated Types type AWSResponse DescribeOptedOutNumbers # Methods request :: (Service -> Service) -> DescribeOptedOutNumbers -> Request DescribeOptedOutNumbers # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeOptedOutNumbers -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeOptedOutNumbers))) #
Generic DescribeOptedOutNumbers Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.DescribeOptedOutNumbers Associated Types type Rep DescribeOptedOutNumbers :: Type -> Type # Methods from :: DescribeOptedOutNumbers -> Rep DescribeOptedOutNumbers x # to :: Rep DescribeOptedOutNumbers x -> DescribeOptedOutNumbers #
Read DescribeOptedOutNumbers Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.DescribeOptedOutNumbers Methods readsPrec :: Int -> ReadS DescribeOptedOutNumbers # readList :: ReadS [DescribeOptedOutNumbers] # readPrec :: ReadPrec DescribeOptedOutNumbers # readListPrec :: ReadPrec [DescribeOptedOutNumbers] #
Show DescribeOptedOutNumbers Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.DescribeOptedOutNumbers Methods showsPrec :: Int -> DescribeOptedOutNumbers -> ShowS # show :: DescribeOptedOutNumbers -> String # showList :: [DescribeOptedOutNumbers] -> ShowS #
NFData DescribeOptedOutNumbers Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.DescribeOptedOutNumbers Methods rnf :: DescribeOptedOutNumbers -> () #
Eq DescribeOptedOutNumbers Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.DescribeOptedOutNumbers Methods (==) :: DescribeOptedOutNumbers -> DescribeOptedOutNumbers -> Bool # (/=) :: DescribeOptedOutNumbers -> DescribeOptedOutNumbers -> Bool #
Hashable DescribeOptedOutNumbers Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.DescribeOptedOutNumbers Methods hashWithSalt :: Int -> DescribeOptedOutNumbers -> Int # hash :: DescribeOptedOutNumbers -> Int #
type AWSResponse DescribeOptedOutNumbers Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.DescribeOptedOutNumbers type AWSResponse DescribeOptedOutNumbers = DescribeOptedOutNumbersResponse
type Rep DescribeOptedOutNumbers Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.DescribeOptedOutNumbers type Rep DescribeOptedOutNumbers = D1 ('MetaData "DescribeOptedOutNumbers" "Amazonka.PinpointSmsVoiceV2.DescribeOptedOutNumbers" "amazonka-pinpoint-sms-voice-v2-2.0-HnPsQLyg04lAXcjcfRtbC7" 'False) (C1 ('MetaCons "DescribeOptedOutNumbers'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [OptedOutFilter])) :: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "optedOutNumbers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "optOutListName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newDescribeOptedOutNumbers Source #

Arguments

:: Text	`DescribeOptedOutNumbers`
-> DescribeOptedOutNumbers

Create a value of DescribeOptedOutNumbers 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:filters:DescribeOptedOutNumbers', describeOptedOutNumbers_filters - An array of OptedOutFilter objects to filter the results on.

$sel:maxResults:DescribeOptedOutNumbers', describeOptedOutNumbers_maxResults - The maximum number of results to return per each request.

DescribeOptedOutNumbers, describeOptedOutNumbers_nextToken - The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.

DescribeOptedOutNumbers, describeOptedOutNumbers_optedOutNumbers - An array of phone numbers to search for in the OptOutList.

DescribeOptedOutNumbers, describeOptedOutNumbers_optOutListName - The OptOutListName or OptOutListArn of the OptOutList. You can use DescribeOptOutLists to find the values for OptOutListName and OptOutListArn.

Request Lenses

describeOptedOutNumbers_filters :: Lens' DescribeOptedOutNumbers (Maybe [OptedOutFilter]) Source #

An array of OptedOutFilter objects to filter the results on.

describeOptedOutNumbers_maxResults :: Lens' DescribeOptedOutNumbers (Maybe Natural) Source #

The maximum number of results to return per each request.

describeOptedOutNumbers_nextToken :: Lens' DescribeOptedOutNumbers (Maybe Text) Source #

The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.

describeOptedOutNumbers_optedOutNumbers :: Lens' DescribeOptedOutNumbers (Maybe [Text]) Source #

An array of phone numbers to search for in the OptOutList.

describeOptedOutNumbers_optOutListName :: Lens' DescribeOptedOutNumbers Text Source #

The OptOutListName or OptOutListArn of the OptOutList. You can use DescribeOptOutLists to find the values for OptOutListName and OptOutListArn.

Destructuring the Response

data DescribeOptedOutNumbersResponse Source #

See: newDescribeOptedOutNumbersResponse smart constructor.

Constructors

DescribeOptedOutNumbersResponse'

Fields

nextToken :: Maybe Text
The token to be used for the next set of paginated results. If this field is empty then there are no more results.
optOutListArn :: Maybe Text
The Amazon Resource Name (ARN) of the OptOutList.
optOutListName :: Maybe Text
The name of the OptOutList.
optedOutNumbers :: Maybe [OptedOutNumberInformation]
An array of OptedOutNumbersInformation objects that provide information about the requested OptedOutNumbers.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic DescribeOptedOutNumbersResponse Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.DescribeOptedOutNumbers Associated Types type Rep DescribeOptedOutNumbersResponse :: Type -> Type # Methods from :: DescribeOptedOutNumbersResponse -> Rep DescribeOptedOutNumbersResponse x # to :: Rep DescribeOptedOutNumbersResponse x -> DescribeOptedOutNumbersResponse #
Read DescribeOptedOutNumbersResponse Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.DescribeOptedOutNumbers Methods readsPrec :: Int -> ReadS DescribeOptedOutNumbersResponse # readList :: ReadS [DescribeOptedOutNumbersResponse] # readPrec :: ReadPrec DescribeOptedOutNumbersResponse # readListPrec :: ReadPrec [DescribeOptedOutNumbersResponse] #
Show DescribeOptedOutNumbersResponse Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.DescribeOptedOutNumbers Methods showsPrec :: Int -> DescribeOptedOutNumbersResponse -> ShowS # show :: DescribeOptedOutNumbersResponse -> String # showList :: [DescribeOptedOutNumbersResponse] -> ShowS #
NFData DescribeOptedOutNumbersResponse Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.DescribeOptedOutNumbers Methods rnf :: DescribeOptedOutNumbersResponse -> () #
Eq DescribeOptedOutNumbersResponse Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.DescribeOptedOutNumbers Methods (==) :: DescribeOptedOutNumbersResponse -> DescribeOptedOutNumbersResponse -> Bool # (/=) :: DescribeOptedOutNumbersResponse -> DescribeOptedOutNumbersResponse -> Bool #
type Rep DescribeOptedOutNumbersResponse Source #
Instance details Defined in Amazonka.PinpointSmsVoiceV2.DescribeOptedOutNumbers type Rep DescribeOptedOutNumbersResponse = D1 ('MetaData "DescribeOptedOutNumbersResponse" "Amazonka.PinpointSmsVoiceV2.DescribeOptedOutNumbers" "amazonka-pinpoint-sms-voice-v2-2.0-HnPsQLyg04lAXcjcfRtbC7" 'False) (C1 ('MetaCons "DescribeOptedOutNumbersResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "optOutListArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "optOutListName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "optedOutNumbers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [OptedOutNumberInformation])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newDescribeOptedOutNumbersResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeOptedOutNumbersResponse'`
-> DescribeOptedOutNumbersResponse

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

DescribeOptedOutNumbers, describeOptedOutNumbersResponse_nextToken - The token to be used for the next set of paginated results. If this field is empty then there are no more results.

DescribeOptedOutNumbersResponse, describeOptedOutNumbersResponse_optOutListArn - The Amazon Resource Name (ARN) of the OptOutList.

DescribeOptedOutNumbers, describeOptedOutNumbersResponse_optOutListName - The name of the OptOutList.

DescribeOptedOutNumbers, describeOptedOutNumbersResponse_optedOutNumbers - An array of OptedOutNumbersInformation objects that provide information about the requested OptedOutNumbers.

$sel:httpStatus:DescribeOptedOutNumbersResponse', describeOptedOutNumbersResponse_httpStatus - The response's http status code.

Response Lenses

describeOptedOutNumbersResponse_nextToken :: Lens' DescribeOptedOutNumbersResponse (Maybe Text) Source #

The token to be used for the next set of paginated results. If this field is empty then there are no more results.

describeOptedOutNumbersResponse_optOutListArn :: Lens' DescribeOptedOutNumbersResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the OptOutList.

describeOptedOutNumbersResponse_optOutListName :: Lens' DescribeOptedOutNumbersResponse (Maybe Text) Source #

The name of the OptOutList.

describeOptedOutNumbersResponse_optedOutNumbers :: Lens' DescribeOptedOutNumbersResponse (Maybe [OptedOutNumberInformation]) Source #

An array of OptedOutNumbersInformation objects that provide information about the requested OptedOutNumbers.

describeOptedOutNumbersResponse_httpStatus :: Lens' DescribeOptedOutNumbersResponse Int Source #

The response's http status code.