amazonka-pinpoint-sms-voice-v2-2.0: Amazon Pinpoint SMS Voice V2 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.PinpointSmsVoiceV2.DescribePools

Description

Retrieves the specified pools or all pools associated with your Amazon Web Services account.

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

If you specify a pool ID that isn't valid, an Error is returned.

A pool is a collection of phone numbers and SenderIds. A pool can include one or more phone numbers and SenderIds that are associated with your Amazon Web Services account.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribePools Source #

See: newDescribePools smart constructor.

Constructors

DescribePools' 

Fields

  • filters :: Maybe [PoolFilter]

    An array of PoolFilter 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.

  • poolIds :: Maybe [Text]

    The unique identifier of pools to find. This is an array of strings that can be either the PoolId or PoolArn.

Instances

Instances details
ToJSON DescribePools Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.DescribePools

Methods

toJSON :: DescribePools -> Value #

toEncoding :: DescribePools -> Encoding #

toJSONList :: [DescribePools] -> Value #

toEncodingList :: [DescribePools] -> Encoding #

ToHeaders DescribePools Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.DescribePools

Methods

toHeaders :: DescribePools -> [Header] #

ToPath DescribePools Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.DescribePools

Methods

toPath :: DescribePools -> ByteString #

ToQuery DescribePools Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.DescribePools

Methods

toQuery :: DescribePools -> QueryString #

AWSPager DescribePools Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.DescribePools

Methods

page :: DescribePools -> AWSResponse DescribePools -> Maybe DescribePools #

AWSRequest DescribePools Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.DescribePools

Associated Types

type AWSResponse DescribePools #

Methods

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

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

Generic DescribePools Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.DescribePools

Associated Types

type Rep DescribePools :: Type -> Type #

Methods

from :: DescribePools -> Rep DescribePools x #

to :: Rep DescribePools x -> DescribePools #

Read DescribePools Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.DescribePools

Methods

readsPrec :: Int -> ReadS DescribePools #

readList :: ReadS [DescribePools] #

readPrec :: ReadPrec DescribePools #

readListPrec :: ReadPrec [DescribePools] #

Show DescribePools Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.DescribePools

Methods

showsPrec :: Int -> DescribePools -> ShowS #

show :: DescribePools -> String #

showList :: [DescribePools] -> ShowS #

NFData DescribePools Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.DescribePools

Methods

rnf :: DescribePools -> () #

Eq DescribePools Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.DescribePools

Methods

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

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

Hashable DescribePools Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.DescribePools

Methods

hashWithSalt :: Int -> DescribePools -> Int #

hash :: DescribePools -> Int #

type AWSResponse DescribePools Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.DescribePools

type AWSResponse DescribePools = DescribePoolsResponse
type Rep DescribePools Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.DescribePools

type Rep DescribePools = D1 ('MetaData "DescribePools" "Amazonka.PinpointSmsVoiceV2.DescribePools" "amazonka-pinpoint-sms-voice-v2-2.0-HnPsQLyg04lAXcjcfRtbC7" 'False) (C1 ('MetaCons "DescribePools'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PoolFilter])) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "poolIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))))

newDescribePools :: DescribePools Source #

Create a value of DescribePools 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:DescribePools', describePools_filters - An array of PoolFilter objects to filter the results.

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

DescribePools, describePools_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.

$sel:poolIds:DescribePools', describePools_poolIds - The unique identifier of pools to find. This is an array of strings that can be either the PoolId or PoolArn.

Request Lenses

describePools_filters :: Lens' DescribePools (Maybe [PoolFilter]) Source #

An array of PoolFilter objects to filter the results.

describePools_maxResults :: Lens' DescribePools (Maybe Natural) Source #

The maximum number of results to return per each request.

describePools_nextToken :: Lens' DescribePools (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.

describePools_poolIds :: Lens' DescribePools (Maybe [Text]) Source #

The unique identifier of pools to find. This is an array of strings that can be either the PoolId or PoolArn.

Destructuring the Response

data DescribePoolsResponse Source #

See: newDescribePoolsResponse smart constructor.

Constructors

DescribePoolsResponse' 

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.

  • pools :: Maybe [PoolInformation]

    An array of PoolInformation objects that contain the details for the requested pools.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic DescribePoolsResponse Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.DescribePools

Associated Types

type Rep DescribePoolsResponse :: Type -> Type #

Methods

from :: DescribePoolsResponse -> Rep DescribePoolsResponse x #

to :: Rep DescribePoolsResponse x -> DescribePoolsResponse #

Read DescribePoolsResponse Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.DescribePools

Methods

readsPrec :: Int -> ReadS DescribePoolsResponse #

readList :: ReadS [DescribePoolsResponse] #

readPrec :: ReadPrec DescribePoolsResponse #

readListPrec :: ReadPrec [DescribePoolsResponse] #

Show DescribePoolsResponse Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.DescribePools

Methods

showsPrec :: Int -> DescribePoolsResponse -> ShowS #

show :: DescribePoolsResponse -> String #

showList :: [DescribePoolsResponse] -> ShowS #

NFData DescribePoolsResponse Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.DescribePools

Methods

rnf :: DescribePoolsResponse -> () #

Eq DescribePoolsResponse Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.DescribePools

Methods

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

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

type Rep DescribePoolsResponse Source # 
Instance details

Defined in Amazonka.PinpointSmsVoiceV2.DescribePools

type Rep DescribePoolsResponse = D1 ('MetaData "DescribePoolsResponse" "Amazonka.PinpointSmsVoiceV2.DescribePools" "amazonka-pinpoint-sms-voice-v2-2.0-HnPsQLyg04lAXcjcfRtbC7" 'False) (C1 ('MetaCons "DescribePoolsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "pools") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PoolInformation])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribePoolsResponse Source #

Arguments

:: Int

$sel:httpStatus:DescribePoolsResponse'

-> DescribePoolsResponse 

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

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

$sel:pools:DescribePoolsResponse', describePoolsResponse_pools - An array of PoolInformation objects that contain the details for the requested pools.

$sel:httpStatus:DescribePoolsResponse', describePoolsResponse_httpStatus - The response's http status code.

Response Lenses

describePoolsResponse_nextToken :: Lens' DescribePoolsResponse (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.

describePoolsResponse_pools :: Lens' DescribePoolsResponse (Maybe [PoolInformation]) Source #

An array of PoolInformation objects that contain the details for the requested pools.

describePoolsResponse_httpStatus :: Lens' DescribePoolsResponse Int Source #

The response's http status code.