Network.AWS.DataPipeline.DescribeObjects

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.

See: AWS API Reference for DescribeObjects.

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
• doMarker
• doPipelineId
• doObjectIds

data DescribeObjects

Contains the parameters for DescribeObjects.

See: describeObjects smart constructor.

Instances

Eq DescribeObjects

Data DescribeObjects

Read DescribeObjects

Show DescribeObjects

Generic DescribeObjects

ToJSON DescribeObjects

AWSPager DescribeObjects

AWSRequest DescribeObjects

ToPath DescribeObjects

ToHeaders DescribeObjects

ToQuery DescribeObjects

type Rep 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
• dorsMarker
• dorsResponseStatus
• dorsPipelineObjects

data DescribeObjectsResponse

Contains the output of DescribeObjects.

See: describeObjectsResponse smart constructor.

Instances

Eq DescribeObjectsResponse

Data DescribeObjectsResponse

Read DescribeObjectsResponse

Show DescribeObjectsResponse

Generic DescribeObjectsResponse

type Rep DescribeObjectsResponse

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.