Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.IoTThingsGraph.SearchSystemTemplates

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Searches for summary information about systems in the user's account. You can filter by the ID of a workflow to return only systems that use the specified workflow.

This operation returns paginated results.

Synopsis

Creating a Request

data SearchSystemTemplates Source #

See: newSearchSystemTemplates smart constructor.

Constructors

SearchSystemTemplates'
Fields filters :: Maybe [SystemTemplateFilter] An array of filters that limit the result set. The only valid filter is `FLOW_TEMPLATE_ID`. nextToken :: Maybe Text The string that specifies the next page of results. Use this when you're paginating results. maxResults :: Maybe Natural The maximum number of results to return in the response.

Instances

Instances details

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

newSearchSystemTemplates :: SearchSystemTemplates Source #

Create a value of SearchSystemTemplates 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:SearchSystemTemplates', searchSystemTemplates_filters - An array of filters that limit the result set. The only valid filter is FLOW_TEMPLATE_ID.

$sel:nextToken:SearchSystemTemplates', searchSystemTemplates_nextToken - The string that specifies the next page of results. Use this when you're paginating results.

$sel:maxResults:SearchSystemTemplates', searchSystemTemplates_maxResults - The maximum number of results to return in the response.

Request Lenses

searchSystemTemplates_filters :: Lens' SearchSystemTemplates (Maybe [SystemTemplateFilter]) Source #

An array of filters that limit the result set. The only valid filter is FLOW_TEMPLATE_ID.

searchSystemTemplates_nextToken :: Lens' SearchSystemTemplates (Maybe Text) Source #

The string that specifies the next page of results. Use this when you're paginating results.

searchSystemTemplates_maxResults :: Lens' SearchSystemTemplates (Maybe Natural) Source #

The maximum number of results to return in the response.

Destructuring the Response

data SearchSystemTemplatesResponse Source #

See: newSearchSystemTemplatesResponse smart constructor.

Constructors

SearchSystemTemplatesResponse'
Fields nextToken :: Maybe Text The string to specify as `nextToken` when you request the next page of results. summaries :: Maybe [SystemTemplateSummary] An array of objects that contain summary information about each system deployment in the result set. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq SearchSystemTemplatesResponse Source #
Instance details Defined in Amazonka.IoTThingsGraph.SearchSystemTemplates Methods (==) :: SearchSystemTemplatesResponse -> SearchSystemTemplatesResponse -> Bool # (/=) :: SearchSystemTemplatesResponse -> SearchSystemTemplatesResponse -> Bool #
Read SearchSystemTemplatesResponse Source #
Instance details Defined in Amazonka.IoTThingsGraph.SearchSystemTemplates Methods readsPrec :: Int -> ReadS SearchSystemTemplatesResponse # readList :: ReadS [SearchSystemTemplatesResponse] # readPrec :: ReadPrec SearchSystemTemplatesResponse # readListPrec :: ReadPrec [SearchSystemTemplatesResponse] #
Show SearchSystemTemplatesResponse Source #
Instance details Defined in Amazonka.IoTThingsGraph.SearchSystemTemplates Methods showsPrec :: Int -> SearchSystemTemplatesResponse -> ShowS # show :: SearchSystemTemplatesResponse -> String # showList :: [SearchSystemTemplatesResponse] -> ShowS #
Generic SearchSystemTemplatesResponse Source #
Instance details Defined in Amazonka.IoTThingsGraph.SearchSystemTemplates Associated Types type Rep SearchSystemTemplatesResponse :: Type -> Type # Methods from :: SearchSystemTemplatesResponse -> Rep SearchSystemTemplatesResponse x # to :: Rep SearchSystemTemplatesResponse x -> SearchSystemTemplatesResponse #
NFData SearchSystemTemplatesResponse Source #
Instance details Defined in Amazonka.IoTThingsGraph.SearchSystemTemplates Methods rnf :: SearchSystemTemplatesResponse -> () #
type Rep SearchSystemTemplatesResponse Source #
Instance details Defined in Amazonka.IoTThingsGraph.SearchSystemTemplates type Rep SearchSystemTemplatesResponse = D1 ('MetaData "SearchSystemTemplatesResponse" "Amazonka.IoTThingsGraph.SearchSystemTemplates" "libZSservicesZSamazonka-iotthingsgraphZSamazonka-iotthingsgraph" 'False) (C1 ('MetaCons "SearchSystemTemplatesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "summaries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SystemTemplateSummary])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newSearchSystemTemplatesResponse Source #

Arguments

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

Create a value of SearchSystemTemplatesResponse 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:nextToken:SearchSystemTemplates', searchSystemTemplatesResponse_nextToken - The string to specify as nextToken when you request the next page of results.

$sel:summaries:SearchSystemTemplatesResponse', searchSystemTemplatesResponse_summaries - An array of objects that contain summary information about each system deployment in the result set.

$sel:httpStatus:SearchSystemTemplatesResponse', searchSystemTemplatesResponse_httpStatus - The response's http status code.

Response Lenses

searchSystemTemplatesResponse_nextToken :: Lens' SearchSystemTemplatesResponse (Maybe Text) Source #

The string to specify as nextToken when you request the next page of results.

searchSystemTemplatesResponse_summaries :: Lens' SearchSystemTemplatesResponse (Maybe [SystemTemplateSummary]) Source #

An array of objects that contain summary information about each system deployment in the result set.

searchSystemTemplatesResponse_httpStatus :: Lens' SearchSystemTemplatesResponse Int Source #

The response's http status code.