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.Chime.ListPhoneNumbers

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists the phone numbers for the specified Amazon Chime account, Amazon Chime user, Amazon Chime Voice Connector, or Amazon Chime Voice Connector group.

Synopsis

data ListPhoneNumbers = ListPhoneNumbers' {
- filterName :: Maybe PhoneNumberAssociationName
- filterValue :: Maybe Text
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- productType :: Maybe PhoneNumberProductType
- status :: Maybe PhoneNumberStatus
}
newListPhoneNumbers :: ListPhoneNumbers
listPhoneNumbers_filterName :: Lens' ListPhoneNumbers (Maybe PhoneNumberAssociationName)
listPhoneNumbers_filterValue :: Lens' ListPhoneNumbers (Maybe Text)
listPhoneNumbers_maxResults :: Lens' ListPhoneNumbers (Maybe Natural)
listPhoneNumbers_nextToken :: Lens' ListPhoneNumbers (Maybe Text)
listPhoneNumbers_productType :: Lens' ListPhoneNumbers (Maybe PhoneNumberProductType)
listPhoneNumbers_status :: Lens' ListPhoneNumbers (Maybe PhoneNumberStatus)
data ListPhoneNumbersResponse = ListPhoneNumbersResponse' {
- nextToken :: Maybe Text
- phoneNumbers :: Maybe [PhoneNumber]
- httpStatus :: Int
}
newListPhoneNumbersResponse :: Int -> ListPhoneNumbersResponse
listPhoneNumbersResponse_nextToken :: Lens' ListPhoneNumbersResponse (Maybe Text)
listPhoneNumbersResponse_phoneNumbers :: Lens' ListPhoneNumbersResponse (Maybe [PhoneNumber])
listPhoneNumbersResponse_httpStatus :: Lens' ListPhoneNumbersResponse Int

Creating a Request

data ListPhoneNumbers Source #

See: newListPhoneNumbers smart constructor.

Constructors

ListPhoneNumbers'

Fields

filterName :: Maybe PhoneNumberAssociationName
The filter to use to limit the number of results.
filterValue :: Maybe Text
The value to use for the filter.
maxResults :: Maybe Natural
The maximum number of results to return in a single call.
nextToken :: Maybe Text
The token to use to retrieve the next page of results.
productType :: Maybe PhoneNumberProductType
The phone number product type.
status :: Maybe PhoneNumberStatus
The phone number status.

Instances

Instances details

ToHeaders ListPhoneNumbers Source #
Instance details Defined in Amazonka.Chime.ListPhoneNumbers Methods toHeaders :: ListPhoneNumbers -> [Header] #
ToPath ListPhoneNumbers Source #
Instance details Defined in Amazonka.Chime.ListPhoneNumbers Methods toPath :: ListPhoneNumbers -> ByteString #
ToQuery ListPhoneNumbers Source #
Instance details Defined in Amazonka.Chime.ListPhoneNumbers Methods toQuery :: ListPhoneNumbers -> QueryString #
AWSRequest ListPhoneNumbers Source #
Instance details Defined in Amazonka.Chime.ListPhoneNumbers Associated Types type AWSResponse ListPhoneNumbers # Methods request :: (Service -> Service) -> ListPhoneNumbers -> Request ListPhoneNumbers # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListPhoneNumbers -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListPhoneNumbers))) #
Generic ListPhoneNumbers Source #
Instance details Defined in Amazonka.Chime.ListPhoneNumbers Associated Types type Rep ListPhoneNumbers :: Type -> Type # Methods from :: ListPhoneNumbers -> Rep ListPhoneNumbers x # to :: Rep ListPhoneNumbers x -> ListPhoneNumbers #
Read ListPhoneNumbers Source #
Instance details Defined in Amazonka.Chime.ListPhoneNumbers Methods readsPrec :: Int -> ReadS ListPhoneNumbers # readList :: ReadS [ListPhoneNumbers] # readPrec :: ReadPrec ListPhoneNumbers # readListPrec :: ReadPrec [ListPhoneNumbers] #
Show ListPhoneNumbers Source #
Instance details Defined in Amazonka.Chime.ListPhoneNumbers Methods showsPrec :: Int -> ListPhoneNumbers -> ShowS # show :: ListPhoneNumbers -> String # showList :: [ListPhoneNumbers] -> ShowS #
NFData ListPhoneNumbers Source #
Instance details Defined in Amazonka.Chime.ListPhoneNumbers Methods rnf :: ListPhoneNumbers -> () #
Eq ListPhoneNumbers Source #
Instance details Defined in Amazonka.Chime.ListPhoneNumbers Methods (==) :: ListPhoneNumbers -> ListPhoneNumbers -> Bool # (/=) :: ListPhoneNumbers -> ListPhoneNumbers -> Bool #
Hashable ListPhoneNumbers Source #
Instance details Defined in Amazonka.Chime.ListPhoneNumbers Methods hashWithSalt :: Int -> ListPhoneNumbers -> Int # hash :: ListPhoneNumbers -> Int #
type AWSResponse ListPhoneNumbers Source #
Instance details Defined in Amazonka.Chime.ListPhoneNumbers type AWSResponse ListPhoneNumbers = ListPhoneNumbersResponse
type Rep ListPhoneNumbers Source #
Instance details Defined in Amazonka.Chime.ListPhoneNumbers type Rep ListPhoneNumbers = D1 ('MetaData "ListPhoneNumbers" "Amazonka.Chime.ListPhoneNumbers" "amazonka-chime-2.0-AQIuSSkHccQ9VXokPBc5Nb" 'False) (C1 ('MetaCons "ListPhoneNumbers'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "filterName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PhoneNumberAssociationName)) :: (S1 ('MetaSel ('Just "filterValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "productType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PhoneNumberProductType)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PhoneNumberStatus))))))

newListPhoneNumbers :: ListPhoneNumbers Source #

Create a value of ListPhoneNumbers 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:filterName:ListPhoneNumbers', listPhoneNumbers_filterName - The filter to use to limit the number of results.

$sel:filterValue:ListPhoneNumbers', listPhoneNumbers_filterValue - The value to use for the filter.

$sel:maxResults:ListPhoneNumbers', listPhoneNumbers_maxResults - The maximum number of results to return in a single call.

ListPhoneNumbers, listPhoneNumbers_nextToken - The token to use to retrieve the next page of results.

ListPhoneNumbers, listPhoneNumbers_productType - The phone number product type.

ListPhoneNumbers, listPhoneNumbers_status - The phone number status.

Request Lenses

listPhoneNumbers_filterName :: Lens' ListPhoneNumbers (Maybe PhoneNumberAssociationName) Source #

The filter to use to limit the number of results.

listPhoneNumbers_filterValue :: Lens' ListPhoneNumbers (Maybe Text) Source #

The value to use for the filter.

listPhoneNumbers_maxResults :: Lens' ListPhoneNumbers (Maybe Natural) Source #

The maximum number of results to return in a single call.

listPhoneNumbers_nextToken :: Lens' ListPhoneNumbers (Maybe Text) Source #

The token to use to retrieve the next page of results.

listPhoneNumbers_productType :: Lens' ListPhoneNumbers (Maybe PhoneNumberProductType) Source #

The phone number product type.

listPhoneNumbers_status :: Lens' ListPhoneNumbers (Maybe PhoneNumberStatus) Source #

The phone number status.

Destructuring the Response

data ListPhoneNumbersResponse Source #

See: newListPhoneNumbersResponse smart constructor.

Constructors

ListPhoneNumbersResponse'
Fields nextToken :: Maybe Text The token to use to retrieve the next page of results. phoneNumbers :: Maybe [PhoneNumber] The phone number details. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic ListPhoneNumbersResponse Source #
Instance details Defined in Amazonka.Chime.ListPhoneNumbers Associated Types type Rep ListPhoneNumbersResponse :: Type -> Type # Methods from :: ListPhoneNumbersResponse -> Rep ListPhoneNumbersResponse x # to :: Rep ListPhoneNumbersResponse x -> ListPhoneNumbersResponse #
Show ListPhoneNumbersResponse Source #
Instance details Defined in Amazonka.Chime.ListPhoneNumbers Methods showsPrec :: Int -> ListPhoneNumbersResponse -> ShowS # show :: ListPhoneNumbersResponse -> String # showList :: [ListPhoneNumbersResponse] -> ShowS #
NFData ListPhoneNumbersResponse Source #
Instance details Defined in Amazonka.Chime.ListPhoneNumbers Methods rnf :: ListPhoneNumbersResponse -> () #
Eq ListPhoneNumbersResponse Source #
Instance details Defined in Amazonka.Chime.ListPhoneNumbers Methods (==) :: ListPhoneNumbersResponse -> ListPhoneNumbersResponse -> Bool # (/=) :: ListPhoneNumbersResponse -> ListPhoneNumbersResponse -> Bool #
type Rep ListPhoneNumbersResponse Source #
Instance details Defined in Amazonka.Chime.ListPhoneNumbers type Rep ListPhoneNumbersResponse = D1 ('MetaData "ListPhoneNumbersResponse" "Amazonka.Chime.ListPhoneNumbers" "amazonka-chime-2.0-AQIuSSkHccQ9VXokPBc5Nb" 'False) (C1 ('MetaCons "ListPhoneNumbersResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "phoneNumbers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PhoneNumber])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListPhoneNumbersResponse Source #

Arguments

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

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

ListPhoneNumbers, listPhoneNumbersResponse_nextToken - The token to use to retrieve the next page of results.

$sel:phoneNumbers:ListPhoneNumbersResponse', listPhoneNumbersResponse_phoneNumbers - The phone number details.

$sel:httpStatus:ListPhoneNumbersResponse', listPhoneNumbersResponse_httpStatus - The response's http status code.

Response Lenses

listPhoneNumbersResponse_nextToken :: Lens' ListPhoneNumbersResponse (Maybe Text) Source #

The token to use to retrieve the next page of results.

listPhoneNumbersResponse_phoneNumbers :: Lens' ListPhoneNumbersResponse (Maybe [PhoneNumber]) Source #

The phone number details.

listPhoneNumbersResponse_httpStatus :: Lens' ListPhoneNumbersResponse Int Source #

The response's http status code.