/AWS1/CL_DPI=>DESCRIBEOBJECTS()¶
About 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.
POST / HTTP/1.1 Content-Type: application/x-amz-json-1.1 X-Amz-Target: DataPipeline.DescribeObjects Content-Length: 98 Host: datapipeline.us-east-1.amazonaws.com X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT Authorization: AuthParams
{"pipelineId": "df-06372391ZG65EXAMPLE", "objectIds": ["Schedule"], "evaluateExpressions": true}
x-amzn-RequestId: 4c18ea5d-0777-11e2-8a14-21bb8a1f50ef Content-Type: application/x-amz-json-1.1 Content-Length: 1488 Date: Mon, 12 Nov 2012 17:50:53 GMT
{"hasMoreResults": false, "pipelineObjects": [ {"fields": [ {"key": "startDateTime", "stringValue": "2012-12-12T00:00:00"}, {"key": "parent", "refValue": "Default"}, {"key": "@sphere", "stringValue": "COMPONENT"}, {"key": "type", "stringValue": "Schedule"}, {"key": "period", "stringValue": "1 hour"}, {"key": "endDateTime", "stringValue": "2012-12-21T18:00:00"}, {"key": "@version", "stringValue": "1"}, {"key": "@status", "stringValue": "PENDING"}, {"key": "@pipelineId", "stringValue": "df-06372391ZG65EXAMPLE"} ], "id": "Schedule", "name": "Schedule"} ] }
Method Signature¶
IMPORTING¶
Required arguments:¶
IV_PIPELINEID TYPE /AWS1/DPIID /AWS1/DPIID¶
The ID of the pipeline that contains the object definitions.
IT_OBJECTIDS TYPE /AWS1/CL_DPIIDLIST_W=>TT_IDLIST TT_IDLIST¶
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.
Optional arguments:¶
IV_EVALUATEEXPRESSIONS TYPE /AWS1/DPIBOOLEAN /AWS1/DPIBOOLEAN¶
Indicates whether any expressions in the object should be evaluated when the object descriptions are returned.
IV_MARKER TYPE /AWS1/DPISTRING /AWS1/DPISTRING¶
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
DescribeObjectswith the marker value from the previous call to retrieve the next set of results.