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.AlexaBusiness.SearchNetworkProfiles

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Searches network profiles and lists the ones that meet a set of filter and sort criteria.

Synopsis

data SearchNetworkProfiles = SearchNetworkProfiles' {
- filters :: Maybe [Filter]
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- sortCriteria :: Maybe [Sort]
}
newSearchNetworkProfiles :: SearchNetworkProfiles
searchNetworkProfiles_filters :: Lens' SearchNetworkProfiles (Maybe [Filter])
searchNetworkProfiles_maxResults :: Lens' SearchNetworkProfiles (Maybe Natural)
searchNetworkProfiles_nextToken :: Lens' SearchNetworkProfiles (Maybe Text)
searchNetworkProfiles_sortCriteria :: Lens' SearchNetworkProfiles (Maybe [Sort])
data SearchNetworkProfilesResponse = SearchNetworkProfilesResponse' {
- networkProfiles :: Maybe [NetworkProfileData]
- nextToken :: Maybe Text
- totalCount :: Maybe Int
- httpStatus :: Int
}
newSearchNetworkProfilesResponse :: Int -> SearchNetworkProfilesResponse
searchNetworkProfilesResponse_networkProfiles :: Lens' SearchNetworkProfilesResponse (Maybe [NetworkProfileData])
searchNetworkProfilesResponse_nextToken :: Lens' SearchNetworkProfilesResponse (Maybe Text)
searchNetworkProfilesResponse_totalCount :: Lens' SearchNetworkProfilesResponse (Maybe Int)
searchNetworkProfilesResponse_httpStatus :: Lens' SearchNetworkProfilesResponse Int

Creating a Request

data SearchNetworkProfiles Source #

See: newSearchNetworkProfiles smart constructor.

Constructors

SearchNetworkProfiles'

Fields

filters :: Maybe [Filter]
The filters to use to list a specified set of network profiles. Valid filters are NetworkProfileName, Ssid, and SecurityType.
maxResults :: 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.
nextToken :: 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.
sortCriteria :: Maybe [Sort]
The sort order to use to list the specified set of network profiles. Valid sort criteria includes NetworkProfileName, Ssid, and SecurityType.

Instances

Instances details

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

newSearchNetworkProfiles :: SearchNetworkProfiles Source #

Create a value of SearchNetworkProfiles 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:SearchNetworkProfiles', searchNetworkProfiles_filters - The filters to use to list a specified set of network profiles. Valid filters are NetworkProfileName, Ssid, and SecurityType.

$sel:maxResults:SearchNetworkProfiles', searchNetworkProfiles_maxResults - 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.

SearchNetworkProfiles, searchNetworkProfiles_nextToken - 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.

$sel:sortCriteria:SearchNetworkProfiles', searchNetworkProfiles_sortCriteria - The sort order to use to list the specified set of network profiles. Valid sort criteria includes NetworkProfileName, Ssid, and SecurityType.

Request Lenses

searchNetworkProfiles_filters :: Lens' SearchNetworkProfiles (Maybe [Filter]) Source #

The filters to use to list a specified set of network profiles. Valid filters are NetworkProfileName, Ssid, and SecurityType.

searchNetworkProfiles_maxResults :: Lens' SearchNetworkProfiles (Maybe Natural) Source #

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.

searchNetworkProfiles_nextToken :: Lens' SearchNetworkProfiles (Maybe Text) Source #

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.

searchNetworkProfiles_sortCriteria :: Lens' SearchNetworkProfiles (Maybe [Sort]) Source #

The sort order to use to list the specified set of network profiles. Valid sort criteria includes NetworkProfileName, Ssid, and SecurityType.

Destructuring the Response

data SearchNetworkProfilesResponse Source #

See: newSearchNetworkProfilesResponse smart constructor.

Constructors

SearchNetworkProfilesResponse'

Fields

networkProfiles :: Maybe [NetworkProfileData]
The network profiles that meet the specified set of filter criteria, in sort order. It is a list of NetworkProfileData objects.
nextToken :: 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.
totalCount :: Maybe Int
The total number of network profiles returned.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic SearchNetworkProfilesResponse Source #
Instance details Defined in Amazonka.AlexaBusiness.SearchNetworkProfiles Associated Types type Rep SearchNetworkProfilesResponse :: Type -> Type # Methods from :: SearchNetworkProfilesResponse -> Rep SearchNetworkProfilesResponse x # to :: Rep SearchNetworkProfilesResponse x -> SearchNetworkProfilesResponse #
Read SearchNetworkProfilesResponse Source #
Instance details Defined in Amazonka.AlexaBusiness.SearchNetworkProfiles Methods readsPrec :: Int -> ReadS SearchNetworkProfilesResponse # readList :: ReadS [SearchNetworkProfilesResponse] # readPrec :: ReadPrec SearchNetworkProfilesResponse # readListPrec :: ReadPrec [SearchNetworkProfilesResponse] #
Show SearchNetworkProfilesResponse Source #
Instance details Defined in Amazonka.AlexaBusiness.SearchNetworkProfiles Methods showsPrec :: Int -> SearchNetworkProfilesResponse -> ShowS # show :: SearchNetworkProfilesResponse -> String # showList :: [SearchNetworkProfilesResponse] -> ShowS #
NFData SearchNetworkProfilesResponse Source #
Instance details Defined in Amazonka.AlexaBusiness.SearchNetworkProfiles Methods rnf :: SearchNetworkProfilesResponse -> () #
Eq SearchNetworkProfilesResponse Source #
Instance details Defined in Amazonka.AlexaBusiness.SearchNetworkProfiles Methods (==) :: SearchNetworkProfilesResponse -> SearchNetworkProfilesResponse -> Bool # (/=) :: SearchNetworkProfilesResponse -> SearchNetworkProfilesResponse -> Bool #
type Rep SearchNetworkProfilesResponse Source #
Instance details Defined in Amazonka.AlexaBusiness.SearchNetworkProfiles type Rep SearchNetworkProfilesResponse = D1 ('MetaData "SearchNetworkProfilesResponse" "Amazonka.AlexaBusiness.SearchNetworkProfiles" "amazonka-alexa-business-2.0-BWvKfxFukoyBarGovAkdOS" 'False) (C1 ('MetaCons "SearchNetworkProfilesResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "networkProfiles") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [NetworkProfileData])) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "totalCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newSearchNetworkProfilesResponse Source #

Arguments

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

Create a value of SearchNetworkProfilesResponse 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:networkProfiles:SearchNetworkProfilesResponse', searchNetworkProfilesResponse_networkProfiles - The network profiles that meet the specified set of filter criteria, in sort order. It is a list of NetworkProfileData objects.

SearchNetworkProfiles, searchNetworkProfilesResponse_nextToken - 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.

$sel:totalCount:SearchNetworkProfilesResponse', searchNetworkProfilesResponse_totalCount - The total number of network profiles returned.

$sel:httpStatus:SearchNetworkProfilesResponse', searchNetworkProfilesResponse_httpStatus - The response's http status code.

Response Lenses

searchNetworkProfilesResponse_networkProfiles :: Lens' SearchNetworkProfilesResponse (Maybe [NetworkProfileData]) Source #

The network profiles that meet the specified set of filter criteria, in sort order. It is a list of NetworkProfileData objects.

searchNetworkProfilesResponse_nextToken :: Lens' SearchNetworkProfilesResponse (Maybe Text) Source #

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.

searchNetworkProfilesResponse_totalCount :: Lens' SearchNetworkProfilesResponse (Maybe Int) Source #

The total number of network profiles returned.

searchNetworkProfilesResponse_httpStatus :: Lens' SearchNetworkProfilesResponse Int Source #

The response's http status code.