libZSservicesZSamazonka-iotthingsgraphZSamazonka-iotthingsgraph
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.IoTThingsGraph.SearchSystemTemplates

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

Instances

Instances details
Eq SearchSystemTemplates Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.SearchSystemTemplates

Read SearchSystemTemplates Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.SearchSystemTemplates

Show SearchSystemTemplates Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.SearchSystemTemplates

Generic SearchSystemTemplates Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.SearchSystemTemplates

Associated Types

type Rep SearchSystemTemplates :: Type -> Type #

NFData SearchSystemTemplates Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.SearchSystemTemplates

Methods

rnf :: SearchSystemTemplates -> () #

Hashable SearchSystemTemplates Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.SearchSystemTemplates

ToJSON SearchSystemTemplates Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.SearchSystemTemplates

AWSPager SearchSystemTemplates Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.SearchSystemTemplates

AWSRequest SearchSystemTemplates Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.SearchSystemTemplates

Associated Types

type AWSResponse SearchSystemTemplates #

ToHeaders SearchSystemTemplates Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.SearchSystemTemplates

ToPath SearchSystemTemplates Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.SearchSystemTemplates

ToQuery SearchSystemTemplates Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.SearchSystemTemplates

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

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

Instances

Instances details
Eq SearchSystemTemplatesResponse Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.SearchSystemTemplates

Read SearchSystemTemplatesResponse Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.SearchSystemTemplates

Show SearchSystemTemplatesResponse Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.SearchSystemTemplates

Generic SearchSystemTemplatesResponse Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.SearchSystemTemplates

Associated Types

type Rep SearchSystemTemplatesResponse :: Type -> Type #

NFData SearchSystemTemplatesResponse Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.SearchSystemTemplates

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 #

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.