Copyright	(c) 2013-2018 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
Language	Haskell2010

Network.AWS.DataPipeline.QueryObjects

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Queries the specified pipeline for the names of objects that match the specified set of conditions.

This operation returns paginated results.

Synopsis

queryObjects :: Text -> Text -> QueryObjects
data QueryObjects
qoQuery :: Lens' QueryObjects (Maybe Query)
qoMarker :: Lens' QueryObjects (Maybe Text)
qoLimit :: Lens' QueryObjects (Maybe Int)
qoPipelineId :: Lens' QueryObjects Text
qoSphere :: Lens' QueryObjects Text
queryObjectsResponse :: Int -> QueryObjectsResponse
data QueryObjectsResponse
qorsHasMoreResults :: Lens' QueryObjectsResponse (Maybe Bool)
qorsIds :: Lens' QueryObjectsResponse [Text]
qorsMarker :: Lens' QueryObjectsResponse (Maybe Text)
qorsResponseStatus :: Lens' QueryObjectsResponse Int

Creating a Request

queryObjects #

Arguments

:: Text	`qoPipelineId`
-> Text	`qoSphere`
-> QueryObjects

Creates a value of QueryObjects with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

qoQuery - The query that defines the objects to be returned. The Query object can contain a maximum of ten selectors. The conditions in the query are limited to top-level String fields in the object. These filters can be applied to components, instances, and attempts.
qoMarker - The starting point for the results to be returned. For the first call, this value should be empty. As long as there are more results, continue to call QueryObjects with the marker value from the previous call to retrieve the next set of results.
qoLimit - The maximum number of object names that QueryObjects will return in a single call. The default value is 100.
qoPipelineId - The ID of the pipeline.
qoSphere - Indicates whether the query applies to components or instances. The possible values are: COMPONENT , INSTANCE , and ATTEMPT .

data QueryObjects #

Contains the parameters for QueryObjects.

See: queryObjects smart constructor.

Instances

Eq QueryObjects #
Instance details Defined in Network.AWS.DataPipeline.QueryObjects Methods (==) :: QueryObjects -> QueryObjects -> Bool # (/=) :: QueryObjects -> QueryObjects -> Bool #
Data QueryObjects #
Instance details Defined in Network.AWS.DataPipeline.QueryObjects Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> QueryObjects -> c QueryObjects # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c QueryObjects # toConstr :: QueryObjects -> Constr # dataTypeOf :: QueryObjects -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c QueryObjects) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c QueryObjects) # gmapT :: (forall b. Data b => b -> b) -> QueryObjects -> QueryObjects # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> QueryObjects -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> QueryObjects -> r # gmapQ :: (forall d. Data d => d -> u) -> QueryObjects -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> QueryObjects -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> QueryObjects -> m QueryObjects # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> QueryObjects -> m QueryObjects # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> QueryObjects -> m QueryObjects #
Read QueryObjects #
Instance details Defined in Network.AWS.DataPipeline.QueryObjects Methods readsPrec :: Int -> ReadS QueryObjects # readList :: ReadS [QueryObjects] # readPrec :: ReadPrec QueryObjects # readListPrec :: ReadPrec [QueryObjects] #
Show QueryObjects #
Instance details Defined in Network.AWS.DataPipeline.QueryObjects Methods showsPrec :: Int -> QueryObjects -> ShowS # show :: QueryObjects -> String # showList :: [QueryObjects] -> ShowS #
Generic QueryObjects #
Instance details Defined in Network.AWS.DataPipeline.QueryObjects Associated Types type Rep QueryObjects :: * -> * # Methods from :: QueryObjects -> Rep QueryObjects x # to :: Rep QueryObjects x -> QueryObjects #
Hashable QueryObjects #
Instance details Defined in Network.AWS.DataPipeline.QueryObjects Methods hashWithSalt :: Int -> QueryObjects -> Int # hash :: QueryObjects -> Int #
ToJSON QueryObjects #
Instance details Defined in Network.AWS.DataPipeline.QueryObjects Methods toJSON :: QueryObjects -> Value # toEncoding :: QueryObjects -> Encoding # toJSONList :: [QueryObjects] -> Value # toEncodingList :: [QueryObjects] -> Encoding #
AWSPager QueryObjects #
Instance details Defined in Network.AWS.DataPipeline.QueryObjects Methods page :: QueryObjects -> Rs QueryObjects -> Maybe QueryObjects #
AWSRequest QueryObjects #
Instance details Defined in Network.AWS.DataPipeline.QueryObjects Associated Types type Rs QueryObjects :: * # Methods request :: QueryObjects -> Request QueryObjects # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy QueryObjects -> ClientResponse -> m (Response QueryObjects) #
ToHeaders QueryObjects #
Instance details Defined in Network.AWS.DataPipeline.QueryObjects Methods toHeaders :: QueryObjects -> [Header] #
ToPath QueryObjects #
Instance details Defined in Network.AWS.DataPipeline.QueryObjects Methods toPath :: QueryObjects -> ByteString #
ToQuery QueryObjects #
Instance details Defined in Network.AWS.DataPipeline.QueryObjects Methods toQuery :: QueryObjects -> QueryString #
NFData QueryObjects #
Instance details Defined in Network.AWS.DataPipeline.QueryObjects Methods rnf :: QueryObjects -> () #
type Rep QueryObjects #
Instance details Defined in Network.AWS.DataPipeline.QueryObjects type Rep QueryObjects = D1 (MetaData "QueryObjects" "Network.AWS.DataPipeline.QueryObjects" "amazonka-datapipeline-1.6.0-Fz1lwoHlHnB5SoOWTNqZgv" False) (C1 (MetaCons "QueryObjects'" PrefixI True) ((S1 (MetaSel (Just "_qoQuery") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Query)) :: S1 (MetaSel (Just "_qoMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_qoLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int)) :: (S1 (MetaSel (Just "_qoPipelineId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :: S1 (MetaSel (Just "_qoSphere") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))
type Rs QueryObjects #
Instance details Defined in Network.AWS.DataPipeline.QueryObjects type Rs QueryObjects = QueryObjectsResponse

Request Lenses

qoQuery :: Lens' QueryObjects (Maybe Query) #

The query that defines the objects to be returned. The Query object can contain a maximum of ten selectors. The conditions in the query are limited to top-level String fields in the object. These filters can be applied to components, instances, and attempts.

qoMarker :: Lens' QueryObjects (Maybe Text) #

The starting point for the results to be returned. For the first call, this value should be empty. As long as there are more results, continue to call QueryObjects with the marker value from the previous call to retrieve the next set of results.

qoLimit :: Lens' QueryObjects (Maybe Int) #

The maximum number of object names that QueryObjects will return in a single call. The default value is 100.

qoPipelineId :: Lens' QueryObjects Text #

The ID of the pipeline.

qoSphere :: Lens' QueryObjects Text #

Indicates whether the query applies to components or instances. The possible values are: COMPONENT , INSTANCE , and ATTEMPT .

Destructuring the Response

queryObjectsResponse #

Arguments

:: Int	`qorsResponseStatus`
-> QueryObjectsResponse

Creates a value of QueryObjectsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

qorsHasMoreResults - Indicates whether there are more results that can be obtained by a subsequent call.
qorsIds - The identifiers that match the query selectors.
qorsMarker - The starting point for the next page of results. To view the next page of results, call QueryObjects again with this marker value. If the value is null, there are no more results.
qorsResponseStatus - -- | The response status code.

data QueryObjectsResponse #

Contains the output of QueryObjects.

See: queryObjectsResponse smart constructor.

Instances

Eq QueryObjectsResponse #
Instance details Defined in Network.AWS.DataPipeline.QueryObjects Methods (==) :: QueryObjectsResponse -> QueryObjectsResponse -> Bool # (/=) :: QueryObjectsResponse -> QueryObjectsResponse -> Bool #
Data QueryObjectsResponse #
Instance details Defined in Network.AWS.DataPipeline.QueryObjects Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> QueryObjectsResponse -> c QueryObjectsResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c QueryObjectsResponse # toConstr :: QueryObjectsResponse -> Constr # dataTypeOf :: QueryObjectsResponse -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c QueryObjectsResponse) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c QueryObjectsResponse) # gmapT :: (forall b. Data b => b -> b) -> QueryObjectsResponse -> QueryObjectsResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> QueryObjectsResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> QueryObjectsResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> QueryObjectsResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> QueryObjectsResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> QueryObjectsResponse -> m QueryObjectsResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> QueryObjectsResponse -> m QueryObjectsResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> QueryObjectsResponse -> m QueryObjectsResponse #
Read QueryObjectsResponse #
Instance details Defined in Network.AWS.DataPipeline.QueryObjects Methods readsPrec :: Int -> ReadS QueryObjectsResponse # readList :: ReadS [QueryObjectsResponse] # readPrec :: ReadPrec QueryObjectsResponse # readListPrec :: ReadPrec [QueryObjectsResponse] #
Show QueryObjectsResponse #
Instance details Defined in Network.AWS.DataPipeline.QueryObjects Methods showsPrec :: Int -> QueryObjectsResponse -> ShowS # show :: QueryObjectsResponse -> String # showList :: [QueryObjectsResponse] -> ShowS #
Generic QueryObjectsResponse #
Instance details Defined in Network.AWS.DataPipeline.QueryObjects Associated Types type Rep QueryObjectsResponse :: * -> * # Methods from :: QueryObjectsResponse -> Rep QueryObjectsResponse x # to :: Rep QueryObjectsResponse x -> QueryObjectsResponse #
NFData QueryObjectsResponse #
Instance details Defined in Network.AWS.DataPipeline.QueryObjects Methods rnf :: QueryObjectsResponse -> () #
type Rep QueryObjectsResponse #
Instance details Defined in Network.AWS.DataPipeline.QueryObjects type Rep QueryObjectsResponse = D1 (MetaData "QueryObjectsResponse" "Network.AWS.DataPipeline.QueryObjects" "amazonka-datapipeline-1.6.0-Fz1lwoHlHnB5SoOWTNqZgv" False) (C1 (MetaCons "QueryObjectsResponse'" PrefixI True) ((S1 (MetaSel (Just "_qorsHasMoreResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :: S1 (MetaSel (Just "_qorsIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) :: (S1 (MetaSel (Just "_qorsMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_qorsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

qorsHasMoreResults :: Lens' QueryObjectsResponse (Maybe Bool) #

Indicates whether there are more results that can be obtained by a subsequent call.

qorsIds :: Lens' QueryObjectsResponse [Text] #

The identifiers that match the query selectors.

qorsMarker :: Lens' QueryObjectsResponse (Maybe Text) #

The starting point for the next page of results. To view the next page of results, call QueryObjects again with this marker value. If the value is null, there are no more results.

qorsResponseStatus :: Lens' QueryObjectsResponse Int #

- | The response status code.