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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets the object definitions for a set of objects associated with the pipeline. Object definitions are composed of a set of fields that define the properties of the object.

This operation returns paginated results.

Creating a Request

describeObjects #

Arguments

:: Text	`doPipelineId`
-> DescribeObjects

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

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

doEvaluateExpressions - Indicates whether any expressions in the object should be evaluated when the object descriptions are returned.
doMarker - 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 DescribeObjects with the marker value from the previous call to retrieve the next set of results.
doPipelineId - The ID of the pipeline that contains the object definitions.
doObjectIds - The IDs of the pipeline objects that contain the definitions to be described. You can pass as many as 25 identifiers in a single call to DescribeObjects .

data DescribeObjects #

Contains the parameters for DescribeObjects.

See: describeObjects smart constructor.

Instances

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

Request Lenses

doEvaluateExpressions :: Lens' DescribeObjects (Maybe Bool) #

Indicates whether any expressions in the object should be evaluated when the object descriptions are returned.

doMarker :: Lens' DescribeObjects (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 DescribeObjects with the marker value from the previous call to retrieve the next set of results.

doPipelineId :: Lens' DescribeObjects Text #

The ID of the pipeline that contains the object definitions.

doObjectIds :: Lens' DescribeObjects [Text] #

The IDs of the pipeline objects that contain the definitions to be described. You can pass as many as 25 identifiers in a single call to DescribeObjects .

Destructuring the Response

describeObjectsResponse #

Arguments

:: Int	`dorsResponseStatus`
-> DescribeObjectsResponse

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

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

dorsHasMoreResults - Indicates whether there are more results to return.
dorsMarker - The starting point for the next page of results. To view the next page of results, call DescribeObjects again with this marker value. If the value is null, there are no more results.
dorsResponseStatus - -- | The response status code.
dorsPipelineObjects - An array of object definitions.

data DescribeObjectsResponse #

Contains the output of DescribeObjects.

See: describeObjectsResponse smart constructor.

Instances

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

Response Lenses

dorsHasMoreResults :: Lens' DescribeObjectsResponse (Maybe Bool) #

Indicates whether there are more results to return.

dorsMarker :: Lens' DescribeObjectsResponse (Maybe Text) #

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

dorsResponseStatus :: Lens' DescribeObjectsResponse Int #

- | The response status code.

dorsPipelineObjects :: Lens' DescribeObjectsResponse [PipelineObject] #

An array of object definitions.