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

QueryObjects

Queries the specified pipeline for the names of objects that match the specified set of conditions.

Request Syntax


{
   "limit": number,
   "marker": "string",
   "pipelineId": "string",
   "query": { 
      "selectors": [ 
         { 
            "fieldName": "string",
            "operator": { 
               "type": "string",
               "values": [ "string" ]
            }
         }
      ]
   },
   "sphere": "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.

limit

The maximum number of object names that QueryObjects will return in a single call. The default value is 100.

Type: Integer

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 QueryObjects with the marker value from the previous call to retrieve the next set of results.

Type: String

Required: No

pipelineId

The ID of the pipeline.

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

query

The query that defines the objects to be returned. The Query object can contain a maximum of ten selectors. The conditions in the query are limited to top-level String fields in the object. These filters can be applied to components, instances, and attempts.

Type: Query object

Required: No

sphere

Indicates whether the query applies to components or instances. The possible values are: COMPONENT, INSTANCE, and ATTEMPT.

Type: String

Required: Yes

Response Syntax


{
   "hasMoreResults": boolean,
   "ids": [ "string" ],
   "marker": "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 that can be obtained by a subsequent call.

Type: Boolean

ids

The identifiers that match the query selectors.

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]*

marker

The starting point for the next page of results. To view the next page of results, call QueryObjects again with this marker value. If the value is null, there are no more results.

Type: String

Errors

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

InternalServiceError

An internal service error occurred.

message: Description of the error message.

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.

message: Description of the error message.

HTTP Status Code: 400

PipelineDeletedException

The specified pipeline has been deleted.

message: Description of the error message.

HTTP Status Code: 400

PipelineNotFoundException

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

message: Description of the error message.

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of QueryObjects.

Sample Request




POST / HTTP/1.1
Content-Type: application/x-amz-json-1.1
X-Amz-Target: DataPipeline.QueryObjects
Content-Length: 123
Host: datapipeline.us-east-1.amazonaws.com
X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT
Authorization: AuthParams

{"pipelineId": "df-06372391ZG65EXAMPLE",
 "query": 
  {"selectors": 
    [
    ]
  },
 "sphere": "INSTANCE",
 "marker": "",
 "limit": 10}

Sample Response




x-amzn-RequestId: 14d704c1-0775-11e2-af6f-6bc7a6be60d9
Content-Type: application/x-amz-json-1.1
Content-Length: 72
Date: Mon, 12 Nov 2012 17:50:53 GMT

{"hasMoreResults": false, 
 "ids": 
  ["@SayHello_1_2012-09-25T17:00:00"]
}