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.DescribeSenderIds

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes the specified SenderIds or all SenderIds associated with your Amazon Web Services account.

If you specify SenderIds, the output includes information for only the specified SenderIds. If you specify filters, the output includes information for only those SenderIds that meet the filter criteria. If you don't specify SenderIds or filters, the output includes information for all SenderIds.

f you specify a sender ID that isn't valid, an Error is returned.

This operation returns paginated results.

Synopsis

data DescribeSenderIds = DescribeSenderIds' {
- filters :: Maybe [SenderIdFilter]
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- senderIds :: Maybe [SenderIdAndCountry]
}
newDescribeSenderIds :: DescribeSenderIds
describeSenderIds_filters :: Lens' DescribeSenderIds (Maybe [SenderIdFilter])
describeSenderIds_maxResults :: Lens' DescribeSenderIds (Maybe Natural)
describeSenderIds_nextToken :: Lens' DescribeSenderIds (Maybe Text)
describeSenderIds_senderIds :: Lens' DescribeSenderIds (Maybe [SenderIdAndCountry])
data DescribeSenderIdsResponse = DescribeSenderIdsResponse' {
- nextToken :: Maybe Text
- senderIds :: Maybe [SenderIdInformation]
- httpStatus :: Int
}
newDescribeSenderIdsResponse :: Int -> DescribeSenderIdsResponse
describeSenderIdsResponse_nextToken :: Lens' DescribeSenderIdsResponse (Maybe Text)
describeSenderIdsResponse_senderIds :: Lens' DescribeSenderIdsResponse (Maybe [SenderIdInformation])
describeSenderIdsResponse_httpStatus :: Lens' DescribeSenderIdsResponse Int

Creating a Request

data DescribeSenderIds Source #

See: newDescribeSenderIds smart constructor.

Constructors

DescribeSenderIds'

Fields

filters :: Maybe [SenderIdFilter]
An array of SenderIdFilter objects to filter the results.
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.
senderIds :: Maybe [SenderIdAndCountry]
An array of SenderIdAndCountry objects to search for.

Instances

Instances details

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

newDescribeSenderIds :: DescribeSenderIds Source #

Create a value of DescribeSenderIds 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:DescribeSenderIds', describeSenderIds_filters - An array of SenderIdFilter objects to filter the results.

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

DescribeSenderIds, describeSenderIds_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.

DescribeSenderIds, describeSenderIds_senderIds - An array of SenderIdAndCountry objects to search for.

Request Lenses

describeSenderIds_filters :: Lens' DescribeSenderIds (Maybe [SenderIdFilter]) Source #

An array of SenderIdFilter objects to filter the results.

describeSenderIds_maxResults :: Lens' DescribeSenderIds (Maybe Natural) Source #

The maximum number of results to return per each request.

describeSenderIds_nextToken :: Lens' DescribeSenderIds (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.

describeSenderIds_senderIds :: Lens' DescribeSenderIds (Maybe [SenderIdAndCountry]) Source #

An array of SenderIdAndCountry objects to search for.

Destructuring the Response

data DescribeSenderIdsResponse Source #

See: newDescribeSenderIdsResponse smart constructor.

Constructors

DescribeSenderIdsResponse'
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. senderIds :: Maybe [SenderIdInformation] An array of SernderIdInformation objects that contain the details for the requested SenderIds. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newDescribeSenderIdsResponse Source #

Arguments

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

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

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

DescribeSenderIds, describeSenderIdsResponse_senderIds - An array of SernderIdInformation objects that contain the details for the requested SenderIds.

$sel:httpStatus:DescribeSenderIdsResponse', describeSenderIdsResponse_httpStatus - The response's http status code.

Response Lenses

describeSenderIdsResponse_nextToken :: Lens' DescribeSenderIdsResponse (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.

describeSenderIdsResponse_senderIds :: Lens' DescribeSenderIdsResponse (Maybe [SenderIdInformation]) Source #

An array of SernderIdInformation objects that contain the details for the requested SenderIds.

describeSenderIdsResponse_httpStatus :: Lens' DescribeSenderIdsResponse Int Source #

The response's http status code.