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.SearchSystemInstances

Description

Searches for system instances in the user's account.

This operation returns paginated results.

Synopsis

Creating a Request

data SearchSystemInstances Source #

See: newSearchSystemInstances smart constructor.

Constructors

SearchSystemInstances' 

Fields

  • filters :: Maybe [SystemInstanceFilter]

    Optional filter to apply to the search. Valid filters are SYSTEM_TEMPLATE_ID, STATUS, and GREENGRASS_GROUP_NAME.

    Multiple filters function as OR criteria in the query. Multiple values passed inside the filter function as AND criteria.

  • 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 SearchSystemInstances Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.SearchSystemInstances

Methods

(==) :: SearchSystemInstances -> SearchSystemInstances -> Bool #

(/=) :: SearchSystemInstances -> SearchSystemInstances -> Bool #

Read SearchSystemInstances Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.SearchSystemInstances

Methods

readsPrec :: Int -> ReadS SearchSystemInstances #

readList :: ReadS [SearchSystemInstances] #

readPrec :: ReadPrec SearchSystemInstances #

readListPrec :: ReadPrec [SearchSystemInstances] #

Show SearchSystemInstances Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.SearchSystemInstances

Methods

showsPrec :: Int -> SearchSystemInstances -> ShowS #

show :: SearchSystemInstances -> String #

showList :: [SearchSystemInstances] -> ShowS #

Generic SearchSystemInstances Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.SearchSystemInstances

Associated Types

type Rep SearchSystemInstances :: Type -> Type #

Methods

from :: SearchSystemInstances -> Rep SearchSystemInstances x #

to :: Rep SearchSystemInstances x -> SearchSystemInstances #

NFData SearchSystemInstances Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.SearchSystemInstances

Methods

rnf :: SearchSystemInstances -> () #

Hashable SearchSystemInstances Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.SearchSystemInstances

Methods

hashWithSalt :: Int -> SearchSystemInstances -> Int #

hash :: SearchSystemInstances -> Int #

ToJSON SearchSystemInstances Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.SearchSystemInstances

Methods

toJSON :: SearchSystemInstances -> Value #

toEncoding :: SearchSystemInstances -> Encoding #

toJSONList :: [SearchSystemInstances] -> Value #

toEncodingList :: [SearchSystemInstances] -> Encoding #

AWSPager SearchSystemInstances Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.SearchSystemInstances

Methods

page :: SearchSystemInstances -> AWSResponse SearchSystemInstances -> Maybe SearchSystemInstances #

AWSRequest SearchSystemInstances Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.SearchSystemInstances

Associated Types

type AWSResponse SearchSystemInstances #

Methods

request :: SearchSystemInstances -> Request SearchSystemInstances #

response :: MonadResource m => Logger -> Service -> Proxy SearchSystemInstances -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse SearchSystemInstances))) #

ToHeaders SearchSystemInstances Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.SearchSystemInstances

Methods

toHeaders :: SearchSystemInstances -> [Header] #

ToPath SearchSystemInstances Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.SearchSystemInstances

Methods

toPath :: SearchSystemInstances -> ByteString #

ToQuery SearchSystemInstances Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.SearchSystemInstances

Methods

toQuery :: SearchSystemInstances -> QueryString #

type Rep SearchSystemInstances Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.SearchSystemInstances

type Rep SearchSystemInstances = D1 ('MetaData "SearchSystemInstances" "Amazonka.IoTThingsGraph.SearchSystemInstances" "libZSservicesZSamazonka-iotthingsgraphZSamazonka-iotthingsgraph" 'False) (C1 ('MetaCons "SearchSystemInstances'" 'PrefixI 'True) (S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SystemInstanceFilter])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))))
type AWSResponse SearchSystemInstances Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.SearchSystemInstances

type AWSResponse SearchSystemInstances = SearchSystemInstancesResponse

newSearchSystemInstances :: SearchSystemInstances Source #

Create a value of SearchSystemInstances 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:SearchSystemInstances', searchSystemInstances_filters - Optional filter to apply to the search. Valid filters are SYSTEM_TEMPLATE_ID, STATUS, and GREENGRASS_GROUP_NAME.

Multiple filters function as OR criteria in the query. Multiple values passed inside the filter function as AND criteria.

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

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

Request Lenses

searchSystemInstances_filters :: Lens' SearchSystemInstances (Maybe [SystemInstanceFilter]) Source #

Optional filter to apply to the search. Valid filters are SYSTEM_TEMPLATE_ID, STATUS, and GREENGRASS_GROUP_NAME.

Multiple filters function as OR criteria in the query. Multiple values passed inside the filter function as AND criteria.

searchSystemInstances_nextToken :: Lens' SearchSystemInstances (Maybe Text) Source #

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

searchSystemInstances_maxResults :: Lens' SearchSystemInstances (Maybe Natural) Source #

The maximum number of results to return in the response.

Destructuring the Response

data SearchSystemInstancesResponse Source #

See: newSearchSystemInstancesResponse smart constructor.

Constructors

SearchSystemInstancesResponse' 

Fields

Instances

Instances details
Eq SearchSystemInstancesResponse Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.SearchSystemInstances

Methods

(==) :: SearchSystemInstancesResponse -> SearchSystemInstancesResponse -> Bool #

(/=) :: SearchSystemInstancesResponse -> SearchSystemInstancesResponse -> Bool #

Read SearchSystemInstancesResponse Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.SearchSystemInstances

Methods

readsPrec :: Int -> ReadS SearchSystemInstancesResponse #

readList :: ReadS [SearchSystemInstancesResponse] #

readPrec :: ReadPrec SearchSystemInstancesResponse #

readListPrec :: ReadPrec [SearchSystemInstancesResponse] #

Show SearchSystemInstancesResponse Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.SearchSystemInstances

Methods

showsPrec :: Int -> SearchSystemInstancesResponse -> ShowS #

show :: SearchSystemInstancesResponse -> String #

showList :: [SearchSystemInstancesResponse] -> ShowS #

Generic SearchSystemInstancesResponse Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.SearchSystemInstances

Associated Types

type Rep SearchSystemInstancesResponse :: Type -> Type #

Methods

from :: SearchSystemInstancesResponse -> Rep SearchSystemInstancesResponse x #

to :: Rep SearchSystemInstancesResponse x -> SearchSystemInstancesResponse #

NFData SearchSystemInstancesResponse Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.SearchSystemInstances

Methods

rnf :: SearchSystemInstancesResponse -> () #

type Rep SearchSystemInstancesResponse Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.SearchSystemInstances

type Rep SearchSystemInstancesResponse = D1 ('MetaData "SearchSystemInstancesResponse" "Amazonka.IoTThingsGraph.SearchSystemInstances" "libZSservicesZSamazonka-iotthingsgraphZSamazonka-iotthingsgraph" 'False) (C1 ('MetaCons "SearchSystemInstancesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "summaries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SystemInstanceSummary])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newSearchSystemInstancesResponse Source #

Arguments

:: Int

$sel:httpStatus:SearchSystemInstancesResponse'

-> SearchSystemInstancesResponse 

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

$sel:summaries:SearchSystemInstancesResponse', searchSystemInstancesResponse_summaries - An array of objects that contain summary data abour the system instances in the result set.

$sel:httpStatus:SearchSystemInstancesResponse', searchSystemInstancesResponse_httpStatus - The response's http status code.

Response Lenses

searchSystemInstancesResponse_nextToken :: Lens' SearchSystemInstancesResponse (Maybe Text) Source #

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

searchSystemInstancesResponse_summaries :: Lens' SearchSystemInstancesResponse (Maybe [SystemInstanceSummary]) Source #

An array of objects that contain summary data abour the system instances in the result set.

searchSystemInstancesResponse_httpStatus :: Lens' SearchSystemInstancesResponse Int Source #

The response's http status code.