amazonka-datapipeline-1.5.0: Amazon Data Pipeline SDK.

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

Network.AWS.DataPipeline.QueryObjects

Contents

Description

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

This operation returns paginated results.

Synopsis

Creating a Request

queryObjects Source #

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 Source #

Contains the parameters for QueryObjects.

See: queryObjects smart constructor.

Instances

Eq QueryObjects Source # 
Data QueryObjects Source # 

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 Source # 
Show QueryObjects Source # 
Generic QueryObjects Source # 

Associated Types

type Rep QueryObjects :: * -> * #

Hashable QueryObjects Source # 
ToJSON QueryObjects Source # 
NFData QueryObjects Source # 

Methods

rnf :: QueryObjects -> () #

AWSPager QueryObjects Source # 
AWSRequest QueryObjects Source # 
ToQuery QueryObjects Source # 
ToPath QueryObjects Source # 
ToHeaders QueryObjects Source # 
type Rep QueryObjects Source # 
type Rep QueryObjects = D1 (MetaData "QueryObjects" "Network.AWS.DataPipeline.QueryObjects" "amazonka-datapipeline-1.5.0-1cvcRuECh7Cyyd6yqX05B" False) (C1 (MetaCons "QueryObjects'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_qoQuery") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Query))) (S1 (MetaSel (Just Symbol "_qoMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_qoLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int))) ((:*:) (S1 (MetaSel (Just Symbol "_qoPipelineId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_qoSphere") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))))
type Rs QueryObjects Source # 

Request Lenses

qoQuery :: Lens' QueryObjects (Maybe Query) Source #

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) Source #

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) Source #

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

qoPipelineId :: Lens' QueryObjects Text Source #

The ID of the pipeline.

qoSphere :: Lens' QueryObjects Text Source #

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

Destructuring the Response

queryObjectsResponse Source #

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 Source #

Contains the output of QueryObjects.

See: queryObjectsResponse smart constructor.

Instances

Eq QueryObjectsResponse Source # 
Data QueryObjectsResponse Source # 

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 Source # 
Show QueryObjectsResponse Source # 
Generic QueryObjectsResponse Source # 
NFData QueryObjectsResponse Source # 

Methods

rnf :: QueryObjectsResponse -> () #

type Rep QueryObjectsResponse Source # 
type Rep QueryObjectsResponse = D1 (MetaData "QueryObjectsResponse" "Network.AWS.DataPipeline.QueryObjects" "amazonka-datapipeline-1.5.0-1cvcRuECh7Cyyd6yqX05B" False) (C1 (MetaCons "QueryObjectsResponse'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_qorsHasMoreResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_qorsIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])))) ((:*:) (S1 (MetaSel (Just Symbol "_qorsMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_qorsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))))

Response Lenses

qorsHasMoreResults :: Lens' QueryObjectsResponse (Maybe Bool) Source #

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

qorsIds :: Lens' QueryObjectsResponse [Text] Source #

The identifiers that match the query selectors.

qorsMarker :: Lens' QueryObjectsResponse (Maybe Text) Source #

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 Source #

  • - | The response status code.