Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

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.

Request Syntax


{
   "evaluateExpressions": boolean,
   "marker": "string",
   "objectIds": [ "string" ],
   "pipelineId": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

evaluateExpressions

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

Type: Boolean

Required: No

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.

Type: String

Required: No

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.

Type: Array of strings

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\n\t]*

Required: Yes

pipelineId

The ID of the pipeline that contains the object definitions.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\n\t]*

Required: Yes

Response Syntax


{
   "hasMoreResults": boolean,
   "marker": "string",
   "pipelineObjects": [ 
      { 
         "fields": [ 
            { 
               "key": "string",
               "refValue": "string",
               "stringValue": "string"
            }
         ],
         "id": "string",
         "name": "string"
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

hasMoreResults

Indicates whether there are more results to return.

Type: Boolean

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.

Type: String

pipelineObjects

An array of object definitions.

Type: Array of PipelineObject objects

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServiceError

An internal service error occurred.

HTTP Status Code: 500

InvalidRequestException

The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

HTTP Status Code: 400

PipelineDeletedException

The specified pipeline has been deleted.

HTTP Status Code: 400

PipelineNotFoundException

The specified pipeline was not found. Verify that you used the correct user and account identifiers.

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of DescribeObjects.

Sample Request




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}

Sample Response




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"}
  ]
}