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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Searches for AWS IoT Things Graph workflow execution instances.

This operation returns paginated results.

Synopsis

data SearchFlowExecutions = SearchFlowExecutions' {
- startTime :: Maybe POSIX
- flowExecutionId :: Maybe Text
- nextToken :: Maybe Text
- endTime :: Maybe POSIX
- maxResults :: Maybe Natural
- systemInstanceId :: Text
}
newSearchFlowExecutions :: Text -> SearchFlowExecutions
searchFlowExecutions_startTime :: Lens' SearchFlowExecutions (Maybe UTCTime)
searchFlowExecutions_flowExecutionId :: Lens' SearchFlowExecutions (Maybe Text)
searchFlowExecutions_nextToken :: Lens' SearchFlowExecutions (Maybe Text)
searchFlowExecutions_endTime :: Lens' SearchFlowExecutions (Maybe UTCTime)
searchFlowExecutions_maxResults :: Lens' SearchFlowExecutions (Maybe Natural)
searchFlowExecutions_systemInstanceId :: Lens' SearchFlowExecutions Text
data SearchFlowExecutionsResponse = SearchFlowExecutionsResponse' {
- nextToken :: Maybe Text
- summaries :: Maybe [FlowExecutionSummary]
- httpStatus :: Int
}
newSearchFlowExecutionsResponse :: Int -> SearchFlowExecutionsResponse
searchFlowExecutionsResponse_nextToken :: Lens' SearchFlowExecutionsResponse (Maybe Text)
searchFlowExecutionsResponse_summaries :: Lens' SearchFlowExecutionsResponse (Maybe [FlowExecutionSummary])
searchFlowExecutionsResponse_httpStatus :: Lens' SearchFlowExecutionsResponse Int

Creating a Request

data SearchFlowExecutions Source #

See: newSearchFlowExecutions smart constructor.

Constructors

SearchFlowExecutions'

Fields

startTime :: Maybe POSIX
The date and time of the earliest flow execution to return.
flowExecutionId :: Maybe Text
The ID of a flow execution.
nextToken :: Maybe Text
The string that specifies the next page of results. Use this when you're paginating results.
endTime :: Maybe POSIX
The date and time of the latest flow execution to return.
maxResults :: Maybe Natural
The maximum number of results to return in the response.
systemInstanceId :: Text
The ID of the system instance that contains the flow.

Instances

Instances details

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

newSearchFlowExecutions Source #

Arguments

:: Text	`$sel:systemInstanceId:SearchFlowExecutions'`
-> SearchFlowExecutions

Create a value of SearchFlowExecutions 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:startTime:SearchFlowExecutions', searchFlowExecutions_startTime - The date and time of the earliest flow execution to return.

$sel:flowExecutionId:SearchFlowExecutions', searchFlowExecutions_flowExecutionId - The ID of a flow execution.

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

$sel:endTime:SearchFlowExecutions', searchFlowExecutions_endTime - The date and time of the latest flow execution to return.

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

$sel:systemInstanceId:SearchFlowExecutions', searchFlowExecutions_systemInstanceId - The ID of the system instance that contains the flow.

Request Lenses

searchFlowExecutions_startTime :: Lens' SearchFlowExecutions (Maybe UTCTime) Source #

The date and time of the earliest flow execution to return.

searchFlowExecutions_flowExecutionId :: Lens' SearchFlowExecutions (Maybe Text) Source #

The ID of a flow execution.

searchFlowExecutions_nextToken :: Lens' SearchFlowExecutions (Maybe Text) Source #

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

searchFlowExecutions_endTime :: Lens' SearchFlowExecutions (Maybe UTCTime) Source #

The date and time of the latest flow execution to return.

searchFlowExecutions_maxResults :: Lens' SearchFlowExecutions (Maybe Natural) Source #

The maximum number of results to return in the response.

searchFlowExecutions_systemInstanceId :: Lens' SearchFlowExecutions Text Source #

The ID of the system instance that contains the flow.

Destructuring the Response

data SearchFlowExecutionsResponse Source #

See: newSearchFlowExecutionsResponse smart constructor.

Constructors

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

Instances

Instances details

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

newSearchFlowExecutionsResponse Source #

Arguments

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

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

$sel:summaries:SearchFlowExecutionsResponse', searchFlowExecutionsResponse_summaries - An array of objects that contain summary information about each workflow execution in the result set.

$sel:httpStatus:SearchFlowExecutionsResponse', searchFlowExecutionsResponse_httpStatus - The response's http status code.

Response Lenses

searchFlowExecutionsResponse_nextToken :: Lens' SearchFlowExecutionsResponse (Maybe Text) Source #

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

searchFlowExecutionsResponse_summaries :: Lens' SearchFlowExecutionsResponse (Maybe [FlowExecutionSummary]) Source #

An array of objects that contain summary information about each workflow execution in the result set.

searchFlowExecutionsResponse_httpStatus :: Lens' SearchFlowExecutionsResponse Int Source #

The response's http status code.