Network.AWS.AlexaBusiness.SearchAddressBooks

Searches address books and lists the ones that meet a set of filter and sort criteria.

Creating a Request

searchAddressBooks :: SearchAddressBooks

Creates a value of SearchAddressBooks with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• sabFilters - The filters to use to list a specified set of address books. The supported filter key is AddressBookName.
• sabSortCriteria - The sort order to use in listing the specified set of address books. The supported sort key is AddressBookName.
• sabNextToken - An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response only includes results beyond the token, up to the value specified by MaxResults.
• sabMaxResults - The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

data SearchAddressBooks

See: searchAddressBooks smart constructor.

Instances

Eq SearchAddressBooks

Methods

(==) :: SearchAddressBooks -> SearchAddressBooks -> Bool

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

Data SearchAddressBooks

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SearchAddressBooks -> c SearchAddressBooks

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SearchAddressBooks

toConstr :: SearchAddressBooks -> Constr

dataTypeOf :: SearchAddressBooks -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c SearchAddressBooks)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SearchAddressBooks)

gmapT :: (forall b. Data b => b -> b) -> SearchAddressBooks -> SearchAddressBooks

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SearchAddressBooks -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SearchAddressBooks -> r

gmapQ :: (forall d. Data d => d -> u) -> SearchAddressBooks -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> SearchAddressBooks -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SearchAddressBooks -> m SearchAddressBooks

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SearchAddressBooks -> m SearchAddressBooks

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SearchAddressBooks -> m SearchAddressBooks

Read SearchAddressBooks

Methods

readsPrec :: Int -> ReadS SearchAddressBooks

readList :: ReadS [SearchAddressBooks]

readPrec :: ReadPrec SearchAddressBooks

readListPrec :: ReadPrec [SearchAddressBooks]

Show SearchAddressBooks

Methods

showsPrec :: Int -> SearchAddressBooks -> ShowS

show :: SearchAddressBooks -> String

showList :: [SearchAddressBooks] -> ShowS

Generic SearchAddressBooks

Associated Types

type Rep SearchAddressBooks :: * -> *

Methods

from :: SearchAddressBooks -> Rep SearchAddressBooks x

to :: Rep SearchAddressBooks x -> SearchAddressBooks

Hashable SearchAddressBooks

Methods

hashWithSalt :: Int -> SearchAddressBooks -> Int

hash :: SearchAddressBooks -> Int

ToJSON SearchAddressBooks

Methods

toJSON :: SearchAddressBooks -> Value

toEncoding :: SearchAddressBooks -> Encoding

toJSONList :: [SearchAddressBooks] -> Value

toEncodingList :: [SearchAddressBooks] -> Encoding

NFData SearchAddressBooks

Methods

rnf :: SearchAddressBooks -> ()

AWSRequest SearchAddressBooks

Associated Types

type Rs SearchAddressBooks :: *

Methods

request :: SearchAddressBooks -> Request SearchAddressBooks

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * SearchAddressBooks -> ClientResponse -> m (Response SearchAddressBooks)

ToHeaders SearchAddressBooks

Methods

toHeaders :: SearchAddressBooks -> [Header]

ToPath SearchAddressBooks

Methods

toPath :: SearchAddressBooks -> ByteString

ToQuery SearchAddressBooks

Methods

toQuery :: SearchAddressBooks -> QueryString

type Rep SearchAddressBooks

type Rep SearchAddressBooks = D1 * (MetaData "SearchAddressBooks" "Network.AWS.AlexaBusiness.SearchAddressBooks" "amazonka-alexa-business-1.6.0-DI5T43QkJWfD1hlGpmjsnd" False) (C1 * (MetaCons "SearchAddressBooks'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_sabFilters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Filter]))) (S1 * (MetaSel (Just Symbol "_sabSortCriteria") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Sort])))) ((:*:) * (S1 * (MetaSel (Just Symbol "_sabNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_sabMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Nat))))))

type Rs SearchAddressBooks

type Rs SearchAddressBooks = SearchAddressBooksResponse

Request Lenses

sabFilters :: Lens' SearchAddressBooks [Filter]

The filters to use to list a specified set of address books. The supported filter key is AddressBookName.

sabSortCriteria :: Lens' SearchAddressBooks [Sort]

The sort order to use in listing the specified set of address books. The supported sort key is AddressBookName.

sabNextToken :: Lens' SearchAddressBooks (Maybe Text)

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response only includes results beyond the token, up to the value specified by MaxResults.

sabMaxResults :: Lens' SearchAddressBooks (Maybe Natural)

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

Destructuring the Response

searchAddressBooksResponse

Arguments

:: Int

sabrsResponseStatus

-> SearchAddressBooksResponse

Creates a value of SearchAddressBooksResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• sabrsNextToken - The token returned to indicate that there is more data available.
• sabrsAddressBooks - The address books that meet the specified set of filter criteria, in sort order.
• sabrsTotalCount - The total number of address books returned.
• sabrsResponseStatus - -- | The response status code.

data SearchAddressBooksResponse

See: searchAddressBooksResponse smart constructor.

Instances

Eq SearchAddressBooksResponse

Methods

(==) :: SearchAddressBooksResponse -> SearchAddressBooksResponse -> Bool

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

Data SearchAddressBooksResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SearchAddressBooksResponse -> c SearchAddressBooksResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SearchAddressBooksResponse

toConstr :: SearchAddressBooksResponse -> Constr

dataTypeOf :: SearchAddressBooksResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c SearchAddressBooksResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SearchAddressBooksResponse)

gmapT :: (forall b. Data b => b -> b) -> SearchAddressBooksResponse -> SearchAddressBooksResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SearchAddressBooksResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SearchAddressBooksResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> SearchAddressBooksResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> SearchAddressBooksResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SearchAddressBooksResponse -> m SearchAddressBooksResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SearchAddressBooksResponse -> m SearchAddressBooksResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SearchAddressBooksResponse -> m SearchAddressBooksResponse

Read SearchAddressBooksResponse

Methods

readsPrec :: Int -> ReadS SearchAddressBooksResponse

readList :: ReadS [SearchAddressBooksResponse]

readPrec :: ReadPrec SearchAddressBooksResponse

readListPrec :: ReadPrec [SearchAddressBooksResponse]

Show SearchAddressBooksResponse

Methods

showsPrec :: Int -> SearchAddressBooksResponse -> ShowS

show :: SearchAddressBooksResponse -> String

showList :: [SearchAddressBooksResponse] -> ShowS

Generic SearchAddressBooksResponse

Associated Types

type Rep SearchAddressBooksResponse :: * -> *

Methods

from :: SearchAddressBooksResponse -> Rep SearchAddressBooksResponse x

to :: Rep SearchAddressBooksResponse x -> SearchAddressBooksResponse

NFData SearchAddressBooksResponse

Methods

rnf :: SearchAddressBooksResponse -> ()

type Rep SearchAddressBooksResponse

type Rep SearchAddressBooksResponse = D1 * (MetaData "SearchAddressBooksResponse" "Network.AWS.AlexaBusiness.SearchAddressBooks" "amazonka-alexa-business-1.6.0-DI5T43QkJWfD1hlGpmjsnd" False) (C1 * (MetaCons "SearchAddressBooksResponse'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_sabrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_sabrsAddressBooks") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [AddressBookData])))) ((:*:) * (S1 * (MetaSel (Just Symbol "_sabrsTotalCount") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int))) (S1 * (MetaSel (Just Symbol "_sabrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))

Response Lenses

sabrsNextToken :: Lens' SearchAddressBooksResponse (Maybe Text)

The token returned to indicate that there is more data available.

sabrsAddressBooks :: Lens' SearchAddressBooksResponse [AddressBookData]

The address books that meet the specified set of filter criteria, in sort order.

sabrsTotalCount :: Lens' SearchAddressBooksResponse (Maybe Int)

The total number of address books returned.

sabrsResponseStatus :: Lens' SearchAddressBooksResponse Int

• - | The response status code.