Class: AWS.DataPipeline

var params = {
  pipelineId: 'STRING_VALUE', /* required */
  tags: [ /* required */
    {
      key: 'STRING_VALUE', /* required */
      value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
datapipeline.addTags(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • pipelineId — (String)

    The ID of the pipeline.

  • tags — (Array<map>)

    The tags to add, as key/value pairs.

    • key — required — (String)

      The key name of a tag defined by a user. For more information, see Controlling User Access to Pipelines in the AWS Data Pipeline Developer Guide.

    • value — required — (String)

      The optional value portion of a tag defined by a user. For more information, see Controlling User Access to Pipelines in the AWS Data Pipeline Developer Guide.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  name: 'STRING_VALUE', /* required */
  uniqueId: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE',
  tags: [
    {
      key: 'STRING_VALUE', /* required */
      value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
datapipeline.createPipeline(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • name — (String)

    The name for the pipeline. You can use the same name for multiple pipelines associated with your AWS account, because AWS Data Pipeline assigns each pipeline a unique pipeline identifier.

  • uniqueId — (String)

    A unique identifier. This identifier is not the same as the pipeline identifier assigned by AWS Data Pipeline. You are responsible for defining the format and ensuring the uniqueness of this identifier. You use this parameter to ensure idempotency during repeated calls to CreatePipeline. For example, if the first call to CreatePipeline does not succeed, you can pass in the same unique identifier and pipeline name combination on a subsequent call to CreatePipeline. CreatePipeline ensures that if a pipeline already exists with the same name and unique identifier, a new pipeline is not created. Instead, you'll receive the pipeline identifier from the previous attempt. The uniqueness of the name and unique identifier combination is scoped to the AWS account or IAM user credentials.

  • description — (String)

    The description for the pipeline.

  • tags — (Array<map>)

    A list of tags to associate with the pipeline at creation. Tags let you control access to pipelines. For more information, see Controlling User Access to Pipelines in the AWS Data Pipeline Developer Guide.

    • key — required — (String)

      The key name of a tag defined by a user. For more information, see Controlling User Access to Pipelines in the AWS Data Pipeline Developer Guide.

    • value — required — (String)

      The optional value portion of a tag defined by a user. For more information, see Controlling User Access to Pipelines in the AWS Data Pipeline Developer Guide.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • pipelineId — (String)

      The ID that AWS Data Pipeline assigns the newly created pipeline. For example, df-06372391ZG65EXAMPLE.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  pipelineId: 'STRING_VALUE', /* required */
  cancelActive: true || false
};
datapipeline.deactivatePipeline(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • pipelineId — (String)

    The ID of the pipeline.

  • cancelActive — (Boolean)

    Indicates whether to cancel any running objects. The default is true, which sets the state of any running objects to CANCELED. If this value is false, the pipeline is deactivated after all running objects finish.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  pipelineId: 'STRING_VALUE' /* required */
};
datapipeline.deletePipeline(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • pipelineId — (String)

    The ID of the pipeline.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  objectIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  pipelineId: 'STRING_VALUE', /* required */
  evaluateExpressions: true || false,
  marker: 'STRING_VALUE'
};
datapipeline.describeObjects(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • pipelineId — (String)

    The ID of the pipeline that contains the object definitions.

  • objectIds — (Array<String>)

    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.

  • evaluateExpressions — (Boolean)

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

  • marker — (String)

    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.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • pipelineObjects — (Array<map>)

      An array of object definitions.

      • id — required — (String)

        The ID of the object.

      • name — required — (String)

        The name of the object.

      • fields — required — (Array<map>)

        Key-value pairs that define the properties of the object.

        • key — required — (String)

          The field identifier.

        • stringValue — (String)

          The field value, expressed as a String.

        • refValue — (String)

          The field value, expressed as the identifier of another object.

    • marker — (String)

      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.

    • hasMoreResults — (Boolean)

      Indicates whether there are more results to return.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  pipelineIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
datapipeline.describePipelines(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • pipelineIds — (Array<String>)

    The IDs of the pipelines to describe. You can pass as many as 25 identifiers in a single call. To obtain pipeline IDs, call ListPipelines.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • pipelineDescriptionList — (Array<map>)

      An array of descriptions for the specified pipelines.

      • pipelineId — required — (String)

        The pipeline identifier that was assigned by AWS Data Pipeline. This is a string of the form df-297EG78HU43EEXAMPLE.

      • name — required — (String)

        The name of the pipeline.

      • fields — required — (Array<map>)

        A list of read-only fields that contain metadata about the pipeline: @userId, @accountId, and @pipelineState.

        • key — required — (String)

          The field identifier.

        • stringValue — (String)

          The field value, expressed as a String.

        • refValue — (String)

          The field value, expressed as the identifier of another object.

      • description — (String)

        Description of the pipeline.

      • tags — (Array<map>)

        A list of tags to associated with a pipeline. Tags let you control access to pipelines. For more information, see Controlling User Access to Pipelines in the AWS Data Pipeline Developer Guide.

        • key — required — (String)

          The key name of a tag defined by a user. For more information, see Controlling User Access to Pipelines in the AWS Data Pipeline Developer Guide.

        • value — required — (String)

          The optional value portion of a tag defined by a user. For more information, see Controlling User Access to Pipelines in the AWS Data Pipeline Developer Guide.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  expression: 'STRING_VALUE', /* required */
  objectId: 'STRING_VALUE', /* required */
  pipelineId: 'STRING_VALUE' /* required */
};
datapipeline.evaluateExpression(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • pipelineId — (String)

    The ID of the pipeline.

  • objectId — (String)

    The ID of the object.

  • expression — (String)

    The expression to evaluate.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • evaluatedExpression — (String)

      The evaluated expression.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  pipelineId: 'STRING_VALUE', /* required */
  version: 'STRING_VALUE'
};
datapipeline.getPipelineDefinition(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • pipelineId — (String)

    The ID of the pipeline.

  • version — (String)

    The version of the pipeline definition to retrieve. Set this parameter to latest (default) to use the last definition saved to the pipeline or active to use the last definition that was activated.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • pipelineObjects — (Array<map>)

      The objects defined in the pipeline.

      • id — required — (String)

        The ID of the object.

      • name — required — (String)

        The name of the object.

      • fields — required — (Array<map>)

        Key-value pairs that define the properties of the object.

        • key — required — (String)

          The field identifier.

        • stringValue — (String)

          The field value, expressed as a String.

        • refValue — (String)

          The field value, expressed as the identifier of another object.

    • parameterObjects — (Array<map>)

      The parameter objects used in the pipeline definition.

      • id — required — (String)

        The ID of the parameter object.

      • attributes — required — (Array<map>)

        The attributes of the parameter object.

        • key — required — (String)

          The field identifier.

        • stringValue — required — (String)

          The field value, expressed as a String.

    • parameterValues — (Array<map>)

      The parameter values used in the pipeline definition.

      • id — required — (String)

        The ID of the parameter value.

      • stringValue — required — (String)

        The field value, expressed as a String.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  marker: 'STRING_VALUE'
};
datapipeline.listPipelines(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • marker — (String)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • pipelineIdList — (Array<map>)

      The pipeline identifiers. If you require additional information about the pipelines, you can use these identifiers to call DescribePipelines and GetPipelineDefinition.

      • id — (String)

        The ID of the pipeline that was assigned by AWS Data Pipeline. This is a string of the form df-297EG78HU43EEXAMPLE.

      • name — (String)

        The name of the pipeline.

    • marker — (String)

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

    • hasMoreResults — (Boolean)

      Indicates whether there are more results that can be obtained by a subsequent call.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  workerGroup: 'STRING_VALUE', /* required */
  hostname: 'STRING_VALUE',
  instanceIdentity: {
    document: 'STRING_VALUE',
    signature: 'STRING_VALUE'
  }
};
datapipeline.pollForTask(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • workerGroup — (String)

    The type of task the task runner is configured to accept and process. The worker group is set as a field on objects in the pipeline when they are created. You can only specify a single value for workerGroup in the call to PollForTask. There are no wildcard values permitted in workerGroup; the string must be an exact, case-sensitive, match.

  • hostname — (String)

    The public DNS name of the calling task runner.

  • instanceIdentity — (map)

    Identity information for the EC2 instance that is hosting the task runner. You can get this value from the instance using http://169.254.169.254/latest/meta-data/instance-id. For more information, see Instance Metadata in the Amazon Elastic Compute Cloud User Guide. Passing in this value proves that your task runner is running on an EC2 instance, and ensures the proper AWS Data Pipeline service charges are applied to your pipeline.

    • document — (String)

      A description of an EC2 instance that is generated when the instance is launched and exposed to the instance via the instance metadata service in the form of a JSON representation of an object.

    • signature — (String)

      A signature which can be used to verify the accuracy and authenticity of the information provided in the instance identity document.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • taskObject — (map)

      The information needed to complete the task that is being assigned to the task runner. One of the fields returned in this object is taskId, which contains an identifier for the task being assigned. The calling task runner uses taskId in subsequent calls to ReportTaskProgress and SetTaskStatus.

      • taskId — (String)

        An internal identifier for the task. This ID is passed to the SetTaskStatus and ReportTaskProgress actions.

      • pipelineId — (String)

        The ID of the pipeline that provided the task.

      • attemptId — (String)

        The ID of the pipeline task attempt object. AWS Data Pipeline uses this value to track how many times a task is attempted.

      • objects — (map<map>)

        Connection information for the location where the task runner will publish the output of the task.

        • id — required — (String)

          The ID of the object.

        • name — required — (String)

          The name of the object.

        • fields — required — (Array<map>)

          Key-value pairs that define the properties of the object.

          • key — required — (String)

            The field identifier.

          • stringValue — (String)

            The field value, expressed as a String.

          • refValue — (String)

            The field value, expressed as the identifier of another object.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  pipelineId: 'STRING_VALUE', /* required */
  pipelineObjects: [ /* required */
    {
      fields: [ /* required */
        {
          key: 'STRING_VALUE', /* required */
          refValue: 'STRING_VALUE',
          stringValue: 'STRING_VALUE'
        },
        /* more items */
      ],
      id: 'STRING_VALUE', /* required */
      name: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  parameterObjects: [
    {
      attributes: [ /* required */
        {
          key: 'STRING_VALUE', /* required */
          stringValue: 'STRING_VALUE' /* required */
        },
        /* more items */
      ],
      id: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  parameterValues: [
    {
      id: 'STRING_VALUE', /* required */
      stringValue: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
datapipeline.putPipelineDefinition(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • pipelineId — (String)

    The ID of the pipeline.

  • pipelineObjects — (Array<map>)

    The objects that define the pipeline. These objects overwrite the existing pipeline definition.

    • id — required — (String)

      The ID of the object.

    • name — required — (String)

      The name of the object.

    • fields — required — (Array<map>)

      Key-value pairs that define the properties of the object.

      • key — required — (String)

        The field identifier.

      • stringValue — (String)

        The field value, expressed as a String.

      • refValue — (String)

        The field value, expressed as the identifier of another object.

  • parameterObjects — (Array<map>)

    The parameter objects used with the pipeline.

    • id — required — (String)

      The ID of the parameter object.

    • attributes — required — (Array<map>)

      The attributes of the parameter object.

      • key — required — (String)

        The field identifier.

      • stringValue — required — (String)

        The field value, expressed as a String.

  • parameterValues — (Array<map>)

    The parameter values used with the pipeline.

    • id — required — (String)

      The ID of the parameter value.

    • stringValue — required — (String)

      The field value, expressed as a String.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • validationErrors — (Array<map>)

      The validation errors that are associated with the objects defined in pipelineObjects.

      • id — (String)

        The identifier of the object that contains the validation error.

      • errors — (Array<String>)

        A description of the validation error.

    • validationWarnings — (Array<map>)

      The validation warnings that are associated with the objects defined in pipelineObjects.

      • id — (String)

        The identifier of the object that contains the validation warning.

      • warnings — (Array<String>)

        A description of the validation warning.

    • errored — (Boolean)

      Indicates whether there were validation errors, and the pipeline definition is stored but cannot be activated until you correct the pipeline and call PutPipelineDefinition to commit the corrected pipeline.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  pipelineId: 'STRING_VALUE', /* required */
  sphere: 'STRING_VALUE', /* required */
  limit: 'NUMBER_VALUE',
  marker: 'STRING_VALUE',
  query: {
    selectors: [
      {
        fieldName: 'STRING_VALUE',
        operator: {
          type: EQ | REF_EQ | LE | GE | BETWEEN,
          values: [
            'STRING_VALUE',
            /* more items */
          ]
        }
      },
      /* more items */
    ]
  }
};
datapipeline.queryObjects(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • pipelineId — (String)

    The ID of the pipeline.

  • query — (map)

    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.

    • selectors — (Array<map>)

      List of selectors that define the query. An object must satisfy all of the selectors to match the query.

      • fieldName — (String)

        The name of the field that the operator will be applied to. The field name is the "key" portion of the field definition in the pipeline definition syntax that is used by the AWS Data Pipeline API. If the field is not set on the object, the condition fails.

      • operator — (map)

        Contains a logical operation for comparing the value of a field with a specified value.

        • type — (String)

          The logical operation to be performed: equal (EQ), equal reference (REF_EQ), less than or equal (LE), greater than or equal (GE), or between (BETWEEN). Equal reference (REF_EQ) can be used only with reference fields. The other comparison types can be used only with String fields. The comparison types you can use apply only to certain object fields, as detailed below.

          The comparison operators EQ and REF_EQ act on the following fields:

          • name
          • @sphere
          • parent
          • @componentParent
          • @instanceParent
          • @status
          • @scheduledStartTime
          • @scheduledEndTime
          • @actualStartTime
          • @actualEndTime

          The comparison operators GE, LE, and BETWEEN act on the following fields:

          • @scheduledStartTime
          • @scheduledEndTime
          • @actualStartTime
          • @actualEndTime

          Note that fields beginning with the at sign (@) are read-only and set by the web service. When you name fields, you should choose names containing only alpha-numeric values, as symbols may be reserved by AWS Data Pipeline. User-defined fields that you add to a pipeline should prefix their name with the string "my".

          Possible values include:
          • "EQ"
          • "REF_EQ"
          • "LE"
          • "GE"
          • "BETWEEN"
        • values — (Array<String>)

          The value that the actual field value will be compared with.

  • sphere — (String)

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

  • marker — (String)

    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.

  • limit — (Integer)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • ids — (Array<String>)

      The identifiers that match the query selectors.

    • marker — (String)

      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.

    • hasMoreResults — (Boolean)

      Indicates whether there are more results that can be obtained by a subsequent call.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  pipelineId: 'STRING_VALUE', /* required */
  tagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
datapipeline.removeTags(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • pipelineId — (String)

    The ID of the pipeline.

  • tagKeys — (Array<String>)

    The keys of the tags to remove.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  taskId: 'STRING_VALUE', /* required */
  fields: [
    {
      key: 'STRING_VALUE', /* required */
      refValue: 'STRING_VALUE',
      stringValue: 'STRING_VALUE'
    },
    /* more items */
  ]
};
datapipeline.reportTaskProgress(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • taskId — (String)

    The ID of the task assigned to the task runner. This value is provided in the response for PollForTask.

  • fields — (Array<map>)

    Key-value pairs that define the properties of the ReportTaskProgressInput object.

    • key — required — (String)

      The field identifier.

    • stringValue — (String)

      The field value, expressed as a String.

    • refValue — (String)

      The field value, expressed as the identifier of another object.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • canceled — (Boolean)

      If true, the calling task runner should cancel processing of the task. The task runner does not need to call SetTaskStatus for canceled tasks.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  taskrunnerId: 'STRING_VALUE', /* required */
  hostname: 'STRING_VALUE',
  workerGroup: 'STRING_VALUE'
};
datapipeline.reportTaskRunnerHeartbeat(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • taskrunnerId — (String)

    The ID of the task runner. This value should be unique across your AWS account. In the case of AWS Data Pipeline Task Runner launched on a resource managed by AWS Data Pipeline, the web service provides a unique identifier when it launches the application. If you have written a custom task runner, you should assign a unique identifier for the task runner.

  • workerGroup — (String)

    The type of task the task runner is configured to accept and process. The worker group is set as a field on objects in the pipeline when they are created. You can only specify a single value for workerGroup. There are no wildcard values permitted in workerGroup; the string must be an exact, case-sensitive, match.

  • hostname — (String)

    The public DNS name of the task runner.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • terminate — (Boolean)

      Indicates whether the calling task runner should terminate.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  objectIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  pipelineId: 'STRING_VALUE', /* required */
  status: 'STRING_VALUE' /* required */
};
datapipeline.setStatus(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • pipelineId — (String)

    The ID of the pipeline that contains the objects.

  • objectIds — (Array<String>)

    The IDs of the objects. The corresponding objects can be either physical or components, but not a mix of both types.

  • status — (String)

    The status to be set on all the objects specified in objectIds. For components, use PAUSE or RESUME. For instances, use TRY_CANCEL, RERUN, or MARK_FINISHED.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  taskId: 'STRING_VALUE', /* required */
  taskStatus: FINISHED | FAILED | FALSE, /* required */
  errorId: 'STRING_VALUE',
  errorMessage: 'STRING_VALUE',
  errorStackTrace: 'STRING_VALUE'
};
datapipeline.setTaskStatus(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • taskId — (String)

    The ID of the task assigned to the task runner. This value is provided in the response for PollForTask.

  • taskStatus — (String)

    If FINISHED, the task successfully completed. If FAILED, the task ended unsuccessfully. Preconditions use false.

    Possible values include:
    • "FINISHED"
    • "FAILED"
    • "FALSE"
  • errorId — (String)

    If an error occurred during the task, this value specifies the error code. This value is set on the physical attempt object. It is used to display error information to the user. It should not start with string "Service_" which is reserved by the system.

  • errorMessage — (String)

    If an error occurred during the task, this value specifies a text description of the error. This value is set on the physical attempt object. It is used to display error information to the user. The web service does not parse this value.

  • errorStackTrace — (String)

    If an error occurred during the task, this value specifies the stack trace associated with the error. This value is set on the physical attempt object. It is used to display error information to the user. The web service does not parse this value.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  pipelineId: 'STRING_VALUE', /* required */
  pipelineObjects: [ /* required */
    {
      fields: [ /* required */
        {
          key: 'STRING_VALUE', /* required */
          refValue: 'STRING_VALUE',
          stringValue: 'STRING_VALUE'
        },
        /* more items */
      ],
      id: 'STRING_VALUE', /* required */
      name: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  parameterObjects: [
    {
      attributes: [ /* required */
        {
          key: 'STRING_VALUE', /* required */
          stringValue: 'STRING_VALUE' /* required */
        },
        /* more items */
      ],
      id: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  parameterValues: [
    {
      id: 'STRING_VALUE', /* required */
      stringValue: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
datapipeline.validatePipelineDefinition(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • pipelineId — (String)

    The ID of the pipeline.

  • pipelineObjects — (Array<map>)

    The objects that define the pipeline changes to validate against the pipeline.

    • id — required — (String)

      The ID of the object.

    • name — required — (String)

      The name of the object.

    • fields — required — (Array<map>)

      Key-value pairs that define the properties of the object.

      • key — required — (String)

        The field identifier.

      • stringValue — (String)

        The field value, expressed as a String.

      • refValue — (String)

        The field value, expressed as the identifier of another object.

  • parameterObjects — (Array<map>)

    The parameter objects used with the pipeline.

    • id — required — (String)

      The ID of the parameter object.

    • attributes — required — (Array<map>)

      The attributes of the parameter object.

      • key — required — (String)

        The field identifier.

      • stringValue — required — (String)

        The field value, expressed as a String.

  • parameterValues — (Array<map>)

    The parameter values used with the pipeline.

    • id — required — (String)

      The ID of the parameter value.

    • stringValue — required — (String)

      The field value, expressed as a String.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • validationErrors — (Array<map>)

      Any validation errors that were found.

      • id — (String)

        The identifier of the object that contains the validation error.

      • errors — (Array<String>)

        A description of the validation error.

    • validationWarnings — (Array<map>)

      Any validation warnings that were found.

      • id — (String)

        The identifier of the object that contains the validation warning.

      • warnings — (Array<String>)

        A description of the validation warning.

    • errored — (Boolean)

      Indicates whether there were validation errors.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.