| Copyright | (c) 2013-2021 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 |
Amazonka.DataPipeline.DescribeObjects
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.
Synopsis
- data DescribeObjects = DescribeObjects' {
- evaluateExpressions :: Maybe Bool
- marker :: Maybe Text
- pipelineId :: Text
- objectIds :: [Text]
- newDescribeObjects :: Text -> DescribeObjects
- describeObjects_evaluateExpressions :: Lens' DescribeObjects (Maybe Bool)
- describeObjects_marker :: Lens' DescribeObjects (Maybe Text)
- describeObjects_pipelineId :: Lens' DescribeObjects Text
- describeObjects_objectIds :: Lens' DescribeObjects [Text]
- data DescribeObjectsResponse = DescribeObjectsResponse' {
- hasMoreResults :: Maybe Bool
- marker :: Maybe Text
- httpStatus :: Int
- pipelineObjects :: [PipelineObject]
- newDescribeObjectsResponse :: Int -> DescribeObjectsResponse
- describeObjectsResponse_hasMoreResults :: Lens' DescribeObjectsResponse (Maybe Bool)
- describeObjectsResponse_marker :: Lens' DescribeObjectsResponse (Maybe Text)
- describeObjectsResponse_httpStatus :: Lens' DescribeObjectsResponse Int
- describeObjectsResponse_pipelineObjects :: Lens' DescribeObjectsResponse [PipelineObject]
Creating a Request
data DescribeObjects Source #
Contains the parameters for DescribeObjects.
See: newDescribeObjects smart constructor.
Constructors
| DescribeObjects' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> DescribeObjects |
Create a value of DescribeObjects with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:evaluateExpressions:DescribeObjects', describeObjects_evaluateExpressions - Indicates whether any expressions in the object should be evaluated when
the object descriptions are returned.
$sel:marker:DescribeObjects', describeObjects_marker - 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.
$sel:pipelineId:DescribeObjects', describeObjects_pipelineId - The ID of the pipeline that contains the object definitions.
$sel:objectIds:DescribeObjects', describeObjects_objectIds - 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.
Request Lenses
describeObjects_evaluateExpressions :: Lens' DescribeObjects (Maybe Bool) Source #
Indicates whether any expressions in the object should be evaluated when the object descriptions are returned.
describeObjects_marker :: Lens' DescribeObjects (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 DescribeObjects with the marker value from the previous call
to retrieve the next set of results.
describeObjects_pipelineId :: Lens' DescribeObjects Text Source #
The ID of the pipeline that contains the object definitions.
describeObjects_objectIds :: Lens' DescribeObjects [Text] Source #
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
data DescribeObjectsResponse Source #
Contains the output of DescribeObjects.
See: newDescribeObjectsResponse smart constructor.
Constructors
| DescribeObjectsResponse' | |
Fields
| |
Instances
newDescribeObjectsResponse Source #
Create a value of DescribeObjectsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:hasMoreResults:DescribeObjectsResponse', describeObjectsResponse_hasMoreResults - Indicates whether there are more results to return.
$sel:marker:DescribeObjects', describeObjectsResponse_marker - 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.
$sel:httpStatus:DescribeObjectsResponse', describeObjectsResponse_httpStatus - The response's http status code.
$sel:pipelineObjects:DescribeObjectsResponse', describeObjectsResponse_pipelineObjects - An array of object definitions.
Response Lenses
describeObjectsResponse_hasMoreResults :: Lens' DescribeObjectsResponse (Maybe Bool) Source #
Indicates whether there are more results to return.
describeObjectsResponse_marker :: Lens' DescribeObjectsResponse (Maybe Text) Source #
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.
describeObjectsResponse_httpStatus :: Lens' DescribeObjectsResponse Int Source #
The response's http status code.
describeObjectsResponse_pipelineObjects :: Lens' DescribeObjectsResponse [PipelineObject] Source #
An array of object definitions.