Network.AWS.DataPipeline.DescribeObjects

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

http://docs.aws.amazon.com/datapipeline/latest/APIReference/API_DescribeObjects.html

Request

data DescribeObjects

Instances

Eq DescribeObjects

Ord DescribeObjects

Show DescribeObjects

ToJSON DescribeObjects

AWSRequest DescribeObjects

AWSPager DescribeObjects

ToQuery DescribeObjects

ToHeaders DescribeObjects

ToPath DescribeObjects

type Rs DescribeObjects = DescribeObjectsResponse

type Sv DescribeObjects = DataPipeline

Request constructor

describeObjects

Arguments

:: Text

doPipelineId

-> DescribeObjects

DescribeObjects constructor.

The fields accessible through corresponding lenses are:

• doEvaluateExpressions :: Maybe Bool
• doMarker :: Maybe Text
• doObjectIds :: [Text]
• doPipelineId :: Text

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. The first time you call DescribeObjects, this value should be empty. As long as the action returns HasMoreResults as True, you can call DescribeObjects again and pass the marker value from the response to retrieve the next set of results.

doObjectIds :: Lens' DescribeObjects [Text]

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

doPipelineId :: Lens' DescribeObjects Text

Identifier of the pipeline that contains the object definitions.

Response

data DescribeObjectsResponse

Instances

Eq DescribeObjectsResponse

Show DescribeObjectsResponse

FromJSON DescribeObjectsResponse

Response constructor

describeObjectsResponse :: DescribeObjectsResponse

DescribeObjectsResponse constructor.

The fields accessible through corresponding lenses are:

• dorHasMoreResults :: Maybe Bool
• dorMarker :: Maybe Text
• dorPipelineObjects :: [PipelineObject]

Response lenses

dorHasMoreResults :: Lens' DescribeObjectsResponse (Maybe Bool)

If True, there are more pages of results to return.

dorMarker :: 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.

dorPipelineObjects :: Lens' DescribeObjectsResponse [PipelineObject]

An array of object definitions that are returned by the call to DescribeObjects.