Class: AWS.DataPipeline

Inherits:
AWS.Service show all
Identifier:
datapipeline
API Version:
2012-10-29
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

AWS Data Pipeline configures and manages a data-driven workflow called a pipeline. AWS Data Pipeline handles the details of scheduling and ensuring that data dependencies are met so that your application can focus on processing the data.

AWS Data Pipeline provides a JAR implementation of a task runner called AWS Data Pipeline Task Runner. AWS Data Pipeline Task Runner provides logic for common data management scenarios, such as performing database queries and running data analysis using Amazon Elastic MapReduce (Amazon EMR). You can use AWS Data Pipeline Task Runner as your task runner, or you can write your own task runner to provide custom data management.

AWS Data Pipeline implements two main sets of functionality. Use the first set to create a pipeline and define data sources, schedules, dependencies, and the transforms to be performed on the data. Use the second set in your task runner application to receive the next task ready for processing. The logic for performing the task, such as querying the data, running data analysis, or converting the data from one format to another, is contained within the task runner. The task runner performs the task assigned to it by the web service, reporting progress to the web service as it does so. When the task is done, the task runner reports the final success or failure of the task to the web service.

Sending a Request Using DataPipeline

var datapipeline = new AWS.DataPipeline();
datapipeline.activatePipeline(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the DataPipeline object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var datapipeline = new AWS.DataPipeline({apiVersion: '2012-10-29'});

You can also set the API version globally in AWS.config.apiVersions using the datapipeline service identifier:

AWS.config.apiVersions = {
  datapipeline: '2012-10-29',
  // other service API versions
};

var datapipeline = new AWS.DataPipeline();

Version:

  • 2012-10-29

Constructor Summary

Property Summary

Properties inherited from AWS.Service

apiVersions

Method Summary

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.DataPipeline(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a DataPipeline object

var datapipeline = new AWS.DataPipeline({apiVersion: '2012-10-29'});

Options Hash (options):

  • params (map) —

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String) —

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com'.

  • accessKeyId (String) —

    your AWS access key ID.

  • secretAccessKey (String) —

    your AWS secret access key.

  • sessionToken (AWS.Credentials) —

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials) —

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain) —

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String) —

    the region to send service requests to. See AWS.DataPipeline.region for more information.

  • maxRetries (Integer) —

    the maximum amount of retries to attempt with a request. See AWS.DataPipeline.maxRetries for more information.

  • maxRedirects (Integer) —

    the maximum amount of redirects to follow with a request. See AWS.DataPipeline.maxRedirects for more information.

  • sslEnabled (Boolean) —

    whether to enable SSL for requests.

  • paramValidation (Boolean|map) —

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean) —

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean) —

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean) —

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean) —

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean) —

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean) —

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • retryDelayOptions (map) —

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and returns the amount of time to delay in milliseconds. The base option will be ignored if this option is supplied.
  • httpOptions (map) —

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date) —

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>) —

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log) —

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number) —

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String) —

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean) —

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean) —

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean) —

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean) —

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean) —

    whether to enable endpoint discovery for operations that allow optionally using an endpoint returned by the service. Defaults to 'false'

  • endpointCacheSize (Number) —

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean) —

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint) —

    an Endpoint object representing the endpoint URL for service requests.

Method Details

activatePipeline(params = {}, callback) ⇒ AWS.Request

Validates the specified pipeline and starts processing pipeline tasks. If the pipeline does not pass validation, activation fails.

If you need to pause the pipeline to investigate an issue with a component, such as a data source or script, call DeactivatePipeline.

To activate a finished pipeline, modify the end date for the pipeline and then activate it.

Service Reference:

Examples:

Calling the activatePipeline operation

var params = {
  pipelineId: 'STRING_VALUE', /* required */
  parameterValues: [
    {
      id: 'STRING_VALUE', /* required */
      stringValue: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  startTimestamp: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
};
datapipeline.activatePipeline(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.

    • parameterValues — (Array<map>)

      A list of parameter values to pass to the pipeline at activation.

      • id — required — (String)

        The ID of the parameter value.

      • stringValue — required — (String)

        The field value, expressed as a String.

    • startTimestamp — (Date)

      The date and time to resume the pipeline. By default, the pipeline resumes from the last completed execution.

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.

addTags(params = {}, callback) ⇒ AWS.Request

Adds or modifies tags for the specified pipeline.

Service Reference:

Examples:

Calling the addTags operation

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.

createPipeline(params = {}, callback) ⇒ AWS.Request

Creates a new, empty pipeline. Use PutPipelineDefinition to populate the pipeline.

Service Reference:

Examples:

Calling the createPipeline operation

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.

deactivatePipeline(params = {}, callback) ⇒ AWS.Request

Deactivates the specified running pipeline. The pipeline is set to the DEACTIVATING state until the deactivation process completes.

To resume a deactivated pipeline, use ActivatePipeline. By default, the pipeline resumes from the last completed execution. Optionally, you can specify the date and time to resume the pipeline.

Service Reference:

Examples:

Calling the deactivatePipeline operation

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.

deletePipeline(params = {}, callback) ⇒ AWS.Request

Deletes a pipeline, its pipeline definition, and its run history. AWS Data Pipeline attempts to cancel instances associated with the pipeline that are currently being processed by task runners.

Deleting a pipeline cannot be undone. You cannot query or restore a deleted pipeline. To temporarily pause a pipeline instead of deleting it, call SetStatus with the status set to PAUSE on individual components. Components that are paused by SetStatus can be resumed.

Service Reference:

Examples:

Calling the deletePipeline operation

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.

describeObjects(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the describeObjects operation

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.

describePipelines(params = {}, callback) ⇒ AWS.Request

Retrieves metadata about one or more pipelines. The information retrieved includes the name of the pipeline, the pipeline identifier, its current state, and the user account that owns the pipeline. Using account credentials, you can retrieve metadata about pipelines that you or your IAM users have created. If you are using an IAM user account, you can retrieve metadata about only those pipelines for which you have read permissions.

To retrieve the full pipeline definition instead of metadata about the pipeline, call GetPipelineDefinition.

Service Reference:

Examples:

Calling the describePipelines operation

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.

evaluateExpression(params = {}, callback) ⇒ AWS.Request

Task runners call EvaluateExpression to evaluate a string in the context of the specified object. For example, a task runner can evaluate SQL queries stored in Amazon S3.

Service Reference:

Examples:

Calling the evaluateExpression operation

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.

getPipelineDefinition(params = {}, callback) ⇒ AWS.Request

Gets the definition of the specified pipeline. You can call GetPipelineDefinition to retrieve the pipeline definition that you provided using PutPipelineDefinition.

Service Reference:

Examples:

Calling the getPipelineDefinition operation

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.

listPipelines(params = {}, callback) ⇒ AWS.Request

Lists the pipeline identifiers for all active pipelines that you have permission to access.

Service Reference:

Examples:

Calling the listPipelines operation

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.

pollForTask(params = {}, callback) ⇒ AWS.Request

Task runners call PollForTask to receive a task to perform from AWS Data Pipeline. The task runner specifies which tasks it can perform by setting a value for the workerGroup parameter. The task returned can come from any of the pipelines that match the workerGroup value passed in by the task runner and that was launched using the IAM user credentials specified by the task runner.

If tasks are ready in the work queue, PollForTask returns a response immediately. If no tasks are available in the queue, PollForTask uses long-polling and holds on to a poll connection for up to a 90 seconds, during which time the first newly scheduled task is handed to the task runner. To accomodate this, set the socket timeout in your task runner to 90 seconds. The task runner should not call PollForTask again on the same workerGroup until it receives a response, and this can take up to 90 seconds.

Service Reference:

Examples:

Calling the pollForTask operation

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.

putPipelineDefinition(params = {}, callback) ⇒ AWS.Request

Adds tasks, schedules, and preconditions to the specified pipeline. You can use PutPipelineDefinition to populate a new pipeline.

PutPipelineDefinition also validates the configuration as it adds it to the pipeline. Changes to the pipeline are saved unless one of the following three validation errors exists in the pipeline.

  1. An object is missing a name or identifier field.
  2. A string or reference field is empty.
  3. The number of objects in the pipeline exceeds the maximum allowed objects.
  4. The pipeline is in a FINISHED state.

Pipeline object definitions are passed to the PutPipelineDefinition action and returned by the GetPipelineDefinition action.

Service Reference:

Examples:

Calling the putPipelineDefinition operation

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.

queryObjects(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the queryObjects operation

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.

removeTags(params = {}, callback) ⇒ AWS.Request

Removes existing tags from the specified pipeline.

Service Reference:

Examples:

Calling the removeTags operation

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.

reportTaskProgress(params = {}, callback) ⇒ AWS.Request

Task runners call ReportTaskProgress when assigned a task to acknowledge that it has the task. If the web service does not receive this acknowledgement within 2 minutes, it assigns the task in a subsequent PollForTask call. After this initial acknowledgement, the task runner only needs to report progress every 15 minutes to maintain its ownership of the task. You can change this reporting time from 15 minutes by specifying a reportProgressTimeout field in your pipeline.

If a task runner does not report its status after 5 minutes, AWS Data Pipeline assumes that the task runner is unable to process the task and reassigns the task in a subsequent response to PollForTask. Task runners should call ReportTaskProgress every 60 seconds.

Service Reference:

Examples:

Calling the reportTaskProgress operation

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.

reportTaskRunnerHeartbeat(params = {}, callback) ⇒ AWS.Request

Task runners call ReportTaskRunnerHeartbeat every 15 minutes to indicate that they are operational. If the AWS Data Pipeline Task Runner is launched on a resource managed by AWS Data Pipeline, the web service can use this call to detect when the task runner application has failed and restart a new instance.

Service Reference:

Examples:

Calling the reportTaskRunnerHeartbeat operation

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.

setStatus(params = {}, callback) ⇒ AWS.Request

Requests that the status of the specified physical or logical pipeline objects be updated in the specified pipeline. This update might not occur immediately, but is eventually consistent. The status that can be set depends on the type of object (for example, DataNode or Activity). You cannot perform this operation on FINISHED pipelines and attempting to do so returns InvalidRequestException.

Service Reference:

Examples:

Calling the setStatus operation

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.

setTaskStatus(params = {}, callback) ⇒ AWS.Request

Task runners call SetTaskStatus to notify AWS Data Pipeline that a task is completed and provide information about the final status. A task runner makes this call regardless of whether the task was sucessful. A task runner does not need to call SetTaskStatus for tasks that are canceled by the web service during a call to ReportTaskProgress.

Service Reference:

Examples:

Calling the setTaskStatus operation

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.

validatePipelineDefinition(params = {}, callback) ⇒ AWS.Request

Validates the specified pipeline definition to ensure that it is well formed and can be run without error.

Service Reference:

Examples:

Calling the validatePipelineDefinition operation

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.