Network.AWS.AlexaBusiness.SearchSkillGroups

Searches skill groups and lists the ones that meet a set of filter and sort criteria.

This operation returns paginated results.

Creating a Request

searchSkillGroups :: SearchSkillGroups

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

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

• ssgFilters - The filters to use to list a specified set of skill groups. The supported filter key is SkillGroupName.
• ssgSortCriteria - The sort order to use in listing the specified set of skill groups. The supported sort key is SkillGroupName.
• ssgNextToken - 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 includes only results beyond the token, up to the value specified by MaxResults . Required.
• ssgMaxResults - 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 SearchSkillGroups

See: searchSkillGroups smart constructor.

Instances

Eq SearchSkillGroups

Methods

(==) :: SearchSkillGroups -> SearchSkillGroups -> Bool

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

Data SearchSkillGroups

Methods

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

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

toConstr :: SearchSkillGroups -> Constr

dataTypeOf :: SearchSkillGroups -> DataType

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

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

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

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

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

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

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

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

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

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

Read SearchSkillGroups

Methods

readsPrec :: Int -> ReadS SearchSkillGroups

readList :: ReadS [SearchSkillGroups]

readPrec :: ReadPrec SearchSkillGroups

readListPrec :: ReadPrec [SearchSkillGroups]

Show SearchSkillGroups

Methods

showsPrec :: Int -> SearchSkillGroups -> ShowS

show :: SearchSkillGroups -> String

showList :: [SearchSkillGroups] -> ShowS

Generic SearchSkillGroups

Associated Types

type Rep SearchSkillGroups :: * -> *

Methods

from :: SearchSkillGroups -> Rep SearchSkillGroups x

to :: Rep SearchSkillGroups x -> SearchSkillGroups

Hashable SearchSkillGroups

Methods

hashWithSalt :: Int -> SearchSkillGroups -> Int

hash :: SearchSkillGroups -> Int

ToJSON SearchSkillGroups

Methods

toJSON :: SearchSkillGroups -> Value

toEncoding :: SearchSkillGroups -> Encoding

toJSONList :: [SearchSkillGroups] -> Value

toEncodingList :: [SearchSkillGroups] -> Encoding

NFData SearchSkillGroups

Methods

rnf :: SearchSkillGroups -> ()

AWSPager SearchSkillGroups

Methods

page :: SearchSkillGroups -> Rs SearchSkillGroups -> Maybe SearchSkillGroups

AWSRequest SearchSkillGroups

Associated Types

type Rs SearchSkillGroups :: *

Methods

request :: SearchSkillGroups -> Request SearchSkillGroups

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

ToHeaders SearchSkillGroups

Methods

toHeaders :: SearchSkillGroups -> [Header]

ToPath SearchSkillGroups

Methods

toPath :: SearchSkillGroups -> ByteString

ToQuery SearchSkillGroups

Methods

toQuery :: SearchSkillGroups -> QueryString

type Rep SearchSkillGroups

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

type Rs SearchSkillGroups

type Rs SearchSkillGroups = SearchSkillGroupsResponse

Request Lenses

ssgFilters :: Lens' SearchSkillGroups [Filter]

The filters to use to list a specified set of skill groups. The supported filter key is SkillGroupName.

ssgSortCriteria :: Lens' SearchSkillGroups [Sort]

The sort order to use in listing the specified set of skill groups. The supported sort key is SkillGroupName.

ssgNextToken :: Lens' SearchSkillGroups (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 includes only results beyond the token, up to the value specified by MaxResults . Required.

ssgMaxResults :: Lens' SearchSkillGroups (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

searchSkillGroupsResponse

Arguments

:: Int

ssgrsResponseStatus

-> SearchSkillGroupsResponse

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

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

• ssgrsNextToken - The token returned to indicate that there is more data available.
• ssgrsSkillGroups - The skill groups that meet the filter criteria, in sort order.
• ssgrsTotalCount - The total number of skill groups returned.
• ssgrsResponseStatus - -- | The response status code.

data SearchSkillGroupsResponse

See: searchSkillGroupsResponse smart constructor.

Instances

Eq SearchSkillGroupsResponse

Methods

(==) :: SearchSkillGroupsResponse -> SearchSkillGroupsResponse -> Bool

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

Data SearchSkillGroupsResponse

Methods

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

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

toConstr :: SearchSkillGroupsResponse -> Constr

dataTypeOf :: SearchSkillGroupsResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Read SearchSkillGroupsResponse

Methods

readsPrec :: Int -> ReadS SearchSkillGroupsResponse

readList :: ReadS [SearchSkillGroupsResponse]

readPrec :: ReadPrec SearchSkillGroupsResponse

readListPrec :: ReadPrec [SearchSkillGroupsResponse]

Show SearchSkillGroupsResponse

Methods

showsPrec :: Int -> SearchSkillGroupsResponse -> ShowS

show :: SearchSkillGroupsResponse -> String

showList :: [SearchSkillGroupsResponse] -> ShowS

Generic SearchSkillGroupsResponse

Associated Types

type Rep SearchSkillGroupsResponse :: * -> *

Methods

from :: SearchSkillGroupsResponse -> Rep SearchSkillGroupsResponse x

to :: Rep SearchSkillGroupsResponse x -> SearchSkillGroupsResponse

NFData SearchSkillGroupsResponse

Methods

rnf :: SearchSkillGroupsResponse -> ()

type Rep SearchSkillGroupsResponse

type Rep SearchSkillGroupsResponse = D1 * (MetaData "SearchSkillGroupsResponse" "Network.AWS.AlexaBusiness.SearchSkillGroups" "amazonka-alexa-business-1.6.0-DI5T43QkJWfD1hlGpmjsnd" False) (C1 * (MetaCons "SearchSkillGroupsResponse'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_ssgrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_ssgrsSkillGroups") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [SkillGroupData])))) ((:*:) * (S1 * (MetaSel (Just Symbol "_ssgrsTotalCount") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int))) (S1 * (MetaSel (Just Symbol "_ssgrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))

Response Lenses

ssgrsNextToken :: Lens' SearchSkillGroupsResponse (Maybe Text)

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

ssgrsSkillGroups :: Lens' SearchSkillGroupsResponse [SkillGroupData]

The skill groups that meet the filter criteria, in sort order.

ssgrsTotalCount :: Lens' SearchSkillGroupsResponse (Maybe Int)

The total number of skill groups returned.

ssgrsResponseStatus :: Lens' SearchSkillGroupsResponse Int

• - | The response status code.