/* * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing * permissions and limitations under the License. */ /* * Do not modify this file. This file is generated from the datapipeline-2012-10-29.normal.json service model. */ using System; using System.Threading; using System.Threading.Tasks; using System.Collections.Generic; using Amazon.Runtime; using Amazon.DataPipeline.Model; namespace Amazon.DataPipeline { /// /// Interface for accessing DataPipeline /// /// 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. /// /// public partial interface IAmazonDataPipeline : IAmazonService, IDisposable { /// /// Paginators for the service /// IDataPipelinePaginatorFactory Paginators { get; } #region ActivatePipeline /// /// 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. /// /// /// Container for the necessary parameters to execute the ActivatePipeline service method. /// /// The response from the ActivatePipeline service method, as returned by DataPipeline. /// /// An internal service error occurred. /// /// /// The request was not valid. Verify that your request was properly formatted, that the /// signature was generated with the correct credentials, and that you haven't exceeded /// any of the service limits for your account. /// /// /// The specified pipeline has been deleted. /// /// /// The specified pipeline was not found. Verify that you used the correct user and account /// identifiers. /// /// REST API Reference for ActivatePipeline Operation ActivatePipelineResponse ActivatePipeline(ActivatePipelineRequest 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. /// /// /// Container for the necessary parameters to execute the ActivatePipeline service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ActivatePipeline service method, as returned by DataPipeline. /// /// An internal service error occurred. /// /// /// The request was not valid. Verify that your request was properly formatted, that the /// signature was generated with the correct credentials, and that you haven't exceeded /// any of the service limits for your account. /// /// /// The specified pipeline has been deleted. /// /// /// The specified pipeline was not found. Verify that you used the correct user and account /// identifiers. /// /// REST API Reference for ActivatePipeline Operation Task ActivatePipelineAsync(ActivatePipelineRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region AddTags /// /// Adds or modifies tags for the specified pipeline. /// /// The ID of the pipeline. /// The tags to add, as key/value pairs. /// /// The response from the AddTags service method, as returned by DataPipeline. /// /// An internal service error occurred. /// /// /// The request was not valid. Verify that your request was properly formatted, that the /// signature was generated with the correct credentials, and that you haven't exceeded /// any of the service limits for your account. /// /// /// The specified pipeline has been deleted. /// /// /// The specified pipeline was not found. Verify that you used the correct user and account /// identifiers. /// /// REST API Reference for AddTags Operation AddTagsResponse AddTags(string pipelineId, List tags); /// /// Adds or modifies tags for the specified pipeline. /// /// Container for the necessary parameters to execute the AddTags service method. /// /// The response from the AddTags service method, as returned by DataPipeline. /// /// An internal service error occurred. /// /// /// The request was not valid. Verify that your request was properly formatted, that the /// signature was generated with the correct credentials, and that you haven't exceeded /// any of the service limits for your account. /// /// /// The specified pipeline has been deleted. /// /// /// The specified pipeline was not found. Verify that you used the correct user and account /// identifiers. /// /// REST API Reference for AddTags Operation AddTagsResponse AddTags(AddTagsRequest request); /// /// Adds or modifies tags for the specified pipeline. /// /// The ID of the pipeline. /// The tags to add, as key/value pairs. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the AddTags service method, as returned by DataPipeline. /// /// An internal service error occurred. /// /// /// The request was not valid. Verify that your request was properly formatted, that the /// signature was generated with the correct credentials, and that you haven't exceeded /// any of the service limits for your account. /// /// /// The specified pipeline has been deleted. /// /// /// The specified pipeline was not found. Verify that you used the correct user and account /// identifiers. /// /// REST API Reference for AddTags Operation Task AddTagsAsync(string pipelineId, List tags, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); /// /// Adds or modifies tags for the specified pipeline. /// /// Container for the necessary parameters to execute the AddTags service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the AddTags service method, as returned by DataPipeline. /// /// An internal service error occurred. /// /// /// The request was not valid. Verify that your request was properly formatted, that the /// signature was generated with the correct credentials, and that you haven't exceeded /// any of the service limits for your account. /// /// /// The specified pipeline has been deleted. /// /// /// The specified pipeline was not found. Verify that you used the correct user and account /// identifiers. /// /// REST API Reference for AddTags Operation Task AddTagsAsync(AddTagsRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region CreatePipeline /// /// Creates a new, empty pipeline. Use PutPipelineDefinition to populate the pipeline. /// /// Container for the necessary parameters to execute the CreatePipeline service method. /// /// The response from the CreatePipeline service method, as returned by DataPipeline. /// /// An internal service error occurred. /// /// /// The request was not valid. Verify that your request was properly formatted, that the /// signature was generated with the correct credentials, and that you haven't exceeded /// any of the service limits for your account. /// /// REST API Reference for CreatePipeline Operation CreatePipelineResponse CreatePipeline(CreatePipelineRequest request); /// /// Creates a new, empty pipeline. Use PutPipelineDefinition to populate the pipeline. /// /// Container for the necessary parameters to execute the CreatePipeline service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the CreatePipeline service method, as returned by DataPipeline. /// /// An internal service error occurred. /// /// /// The request was not valid. Verify that your request was properly formatted, that the /// signature was generated with the correct credentials, and that you haven't exceeded /// any of the service limits for your account. /// /// REST API Reference for CreatePipeline Operation Task CreatePipelineAsync(CreatePipelineRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DeactivatePipeline /// /// 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. /// /// /// Container for the necessary parameters to execute the DeactivatePipeline service method. /// /// The response from the DeactivatePipeline service method, as returned by DataPipeline. /// /// An internal service error occurred. /// /// /// The request was not valid. Verify that your request was properly formatted, that the /// signature was generated with the correct credentials, and that you haven't exceeded /// any of the service limits for your account. /// /// /// The specified pipeline has been deleted. /// /// /// The specified pipeline was not found. Verify that you used the correct user and account /// identifiers. /// /// REST API Reference for DeactivatePipeline Operation DeactivatePipelineResponse DeactivatePipeline(DeactivatePipelineRequest 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. /// /// /// Container for the necessary parameters to execute the DeactivatePipeline service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DeactivatePipeline service method, as returned by DataPipeline. /// /// An internal service error occurred. /// /// /// The request was not valid. Verify that your request was properly formatted, that the /// signature was generated with the correct credentials, and that you haven't exceeded /// any of the service limits for your account. /// /// /// The specified pipeline has been deleted. /// /// /// The specified pipeline was not found. Verify that you used the correct user and account /// identifiers. /// /// REST API Reference for DeactivatePipeline Operation Task DeactivatePipelineAsync(DeactivatePipelineRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DeletePipeline /// /// 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. /// /// /// Container for the necessary parameters to execute the DeletePipeline service method. /// /// The response from the DeletePipeline service method, as returned by DataPipeline. /// /// An internal service error occurred. /// /// /// The request was not valid. Verify that your request was properly formatted, that the /// signature was generated with the correct credentials, and that you haven't exceeded /// any of the service limits for your account. /// /// /// The specified pipeline was not found. Verify that you used the correct user and account /// identifiers. /// /// REST API Reference for DeletePipeline Operation DeletePipelineResponse DeletePipeline(DeletePipelineRequest 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. /// /// /// Container for the necessary parameters to execute the DeletePipeline service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DeletePipeline service method, as returned by DataPipeline. /// /// An internal service error occurred. /// /// /// The request was not valid. Verify that your request was properly formatted, that the /// signature was generated with the correct credentials, and that you haven't exceeded /// any of the service limits for your account. /// /// /// The specified pipeline was not found. Verify that you used the correct user and account /// identifiers. /// /// REST API Reference for DeletePipeline Operation Task DeletePipelineAsync(DeletePipelineRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DescribeObjects /// /// Gets the object definitions for a set of objects associated with the pipeline. Object /// definitions are composed of a set of fields that define the properties of the object. /// /// Container for the necessary parameters to execute the DescribeObjects service method. /// /// The response from the DescribeObjects service method, as returned by DataPipeline. /// /// An internal service error occurred. /// /// /// The request was not valid. Verify that your request was properly formatted, that the /// signature was generated with the correct credentials, and that you haven't exceeded /// any of the service limits for your account. /// /// /// The specified pipeline has been deleted. /// /// /// The specified pipeline was not found. Verify that you used the correct user and account /// identifiers. /// /// REST API Reference for DescribeObjects Operation DescribeObjectsResponse DescribeObjects(DescribeObjectsRequest 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. /// /// Container for the necessary parameters to execute the DescribeObjects service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DescribeObjects service method, as returned by DataPipeline. /// /// An internal service error occurred. /// /// /// The request was not valid. Verify that your request was properly formatted, that the /// signature was generated with the correct credentials, and that you haven't exceeded /// any of the service limits for your account. /// /// /// The specified pipeline has been deleted. /// /// /// The specified pipeline was not found. Verify that you used the correct user and account /// identifiers. /// /// REST API Reference for DescribeObjects Operation Task DescribeObjectsAsync(DescribeObjectsRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DescribePipelines /// /// 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. /// /// /// 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. /// /// The response from the DescribePipelines service method, as returned by DataPipeline. /// /// An internal service error occurred. /// /// /// The request was not valid. Verify that your request was properly formatted, that the /// signature was generated with the correct credentials, and that you haven't exceeded /// any of the service limits for your account. /// /// /// The specified pipeline has been deleted. /// /// /// The specified pipeline was not found. Verify that you used the correct user and account /// identifiers. /// /// REST API Reference for DescribePipelines Operation DescribePipelinesResponse DescribePipelines(List pipelineIds); /// /// 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. /// /// /// Container for the necessary parameters to execute the DescribePipelines service method. /// /// The response from the DescribePipelines service method, as returned by DataPipeline. /// /// An internal service error occurred. /// /// /// The request was not valid. Verify that your request was properly formatted, that the /// signature was generated with the correct credentials, and that you haven't exceeded /// any of the service limits for your account. /// /// /// The specified pipeline has been deleted. /// /// /// The specified pipeline was not found. Verify that you used the correct user and account /// identifiers. /// /// REST API Reference for DescribePipelines Operation DescribePipelinesResponse DescribePipelines(DescribePipelinesRequest 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. /// /// /// 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. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DescribePipelines service method, as returned by DataPipeline. /// /// An internal service error occurred. /// /// /// The request was not valid. Verify that your request was properly formatted, that the /// signature was generated with the correct credentials, and that you haven't exceeded /// any of the service limits for your account. /// /// /// The specified pipeline has been deleted. /// /// /// The specified pipeline was not found. Verify that you used the correct user and account /// identifiers. /// /// REST API Reference for DescribePipelines Operation Task DescribePipelinesAsync(List pipelineIds, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); /// /// 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. /// /// /// Container for the necessary parameters to execute the DescribePipelines service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DescribePipelines service method, as returned by DataPipeline. /// /// An internal service error occurred. /// /// /// The request was not valid. Verify that your request was properly formatted, that the /// signature was generated with the correct credentials, and that you haven't exceeded /// any of the service limits for your account. /// /// /// The specified pipeline has been deleted. /// /// /// The specified pipeline was not found. Verify that you used the correct user and account /// identifiers. /// /// REST API Reference for DescribePipelines Operation Task DescribePipelinesAsync(DescribePipelinesRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region EvaluateExpression /// /// 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. /// /// Container for the necessary parameters to execute the EvaluateExpression service method. /// /// The response from the EvaluateExpression service method, as returned by DataPipeline. /// /// An internal service error occurred. /// /// /// The request was not valid. Verify that your request was properly formatted, that the /// signature was generated with the correct credentials, and that you haven't exceeded /// any of the service limits for your account. /// /// /// The specified pipeline has been deleted. /// /// /// The specified pipeline was not found. Verify that you used the correct user and account /// identifiers. /// /// /// The specified task was not found. /// /// REST API Reference for EvaluateExpression Operation EvaluateExpressionResponse EvaluateExpression(EvaluateExpressionRequest 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. /// /// Container for the necessary parameters to execute the EvaluateExpression service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the EvaluateExpression service method, as returned by DataPipeline. /// /// An internal service error occurred. /// /// /// The request was not valid. Verify that your request was properly formatted, that the /// signature was generated with the correct credentials, and that you haven't exceeded /// any of the service limits for your account. /// /// /// The specified pipeline has been deleted. /// /// /// The specified pipeline was not found. Verify that you used the correct user and account /// identifiers. /// /// /// The specified task was not found. /// /// REST API Reference for EvaluateExpression Operation Task EvaluateExpressionAsync(EvaluateExpressionRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region GetPipelineDefinition /// /// Gets the definition of the specified pipeline. You can call GetPipelineDefinition /// to retrieve the pipeline definition that you provided using PutPipelineDefinition. /// /// Container for the necessary parameters to execute the GetPipelineDefinition service method. /// /// The response from the GetPipelineDefinition service method, as returned by DataPipeline. /// /// An internal service error occurred. /// /// /// The request was not valid. Verify that your request was properly formatted, that the /// signature was generated with the correct credentials, and that you haven't exceeded /// any of the service limits for your account. /// /// /// The specified pipeline has been deleted. /// /// /// The specified pipeline was not found. Verify that you used the correct user and account /// identifiers. /// /// REST API Reference for GetPipelineDefinition Operation GetPipelineDefinitionResponse GetPipelineDefinition(GetPipelineDefinitionRequest request); /// /// Gets the definition of the specified pipeline. You can call GetPipelineDefinition /// to retrieve the pipeline definition that you provided using PutPipelineDefinition. /// /// Container for the necessary parameters to execute the GetPipelineDefinition service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the GetPipelineDefinition service method, as returned by DataPipeline. /// /// An internal service error occurred. /// /// /// The request was not valid. Verify that your request was properly formatted, that the /// signature was generated with the correct credentials, and that you haven't exceeded /// any of the service limits for your account. /// /// /// The specified pipeline has been deleted. /// /// /// The specified pipeline was not found. Verify that you used the correct user and account /// identifiers. /// /// REST API Reference for GetPipelineDefinition Operation Task GetPipelineDefinitionAsync(GetPipelineDefinitionRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ListPipelines /// /// Lists the pipeline identifiers for all active pipelines that you have permission to /// access. /// /// /// The response from the ListPipelines service method, as returned by DataPipeline. /// /// An internal service error occurred. /// /// /// The request was not valid. Verify that your request was properly formatted, that the /// signature was generated with the correct credentials, and that you haven't exceeded /// any of the service limits for your account. /// /// REST API Reference for ListPipelines Operation ListPipelinesResponse ListPipelines(); /// /// Lists the pipeline identifiers for all active pipelines that you have permission to /// access. /// /// Container for the necessary parameters to execute the ListPipelines service method. /// /// The response from the ListPipelines service method, as returned by DataPipeline. /// /// An internal service error occurred. /// /// /// The request was not valid. Verify that your request was properly formatted, that the /// signature was generated with the correct credentials, and that you haven't exceeded /// any of the service limits for your account. /// /// REST API Reference for ListPipelines Operation ListPipelinesResponse ListPipelines(ListPipelinesRequest request); /// /// Lists the pipeline identifiers for all active pipelines that you have permission to /// access. /// /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ListPipelines service method, as returned by DataPipeline. /// /// An internal service error occurred. /// /// /// The request was not valid. Verify that your request was properly formatted, that the /// signature was generated with the correct credentials, and that you haven't exceeded /// any of the service limits for your account. /// /// REST API Reference for ListPipelines Operation Task ListPipelinesAsync(System.Threading.CancellationToken cancellationToken = default(CancellationToken)); /// /// Lists the pipeline identifiers for all active pipelines that you have permission to /// access. /// /// Container for the necessary parameters to execute the ListPipelines service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ListPipelines service method, as returned by DataPipeline. /// /// An internal service error occurred. /// /// /// The request was not valid. Verify that your request was properly formatted, that the /// signature was generated with the correct credentials, and that you haven't exceeded /// any of the service limits for your account. /// /// REST API Reference for ListPipelines Operation Task ListPipelinesAsync(ListPipelinesRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region PollForTask /// /// 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. /// /// /// Container for the necessary parameters to execute the PollForTask service method. /// /// The response from the PollForTask service method, as returned by DataPipeline. /// /// An internal service error occurred. /// /// /// The request was not valid. Verify that your request was properly formatted, that the /// signature was generated with the correct credentials, and that you haven't exceeded /// any of the service limits for your account. /// /// /// The specified task was not found. /// /// REST API Reference for PollForTask Operation PollForTaskResponse PollForTask(PollForTaskRequest 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. /// /// /// Container for the necessary parameters to execute the PollForTask service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the PollForTask service method, as returned by DataPipeline. /// /// An internal service error occurred. /// /// /// The request was not valid. Verify that your request was properly formatted, that the /// signature was generated with the correct credentials, and that you haven't exceeded /// any of the service limits for your account. /// /// /// The specified task was not found. /// /// REST API Reference for PollForTask Operation Task PollForTaskAsync(PollForTaskRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region PutPipelineDefinition /// /// 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. /// /// /// Container for the necessary parameters to execute the PutPipelineDefinition service method. /// /// The response from the PutPipelineDefinition service method, as returned by DataPipeline. /// /// An internal service error occurred. /// /// /// The request was not valid. Verify that your request was properly formatted, that the /// signature was generated with the correct credentials, and that you haven't exceeded /// any of the service limits for your account. /// /// /// The specified pipeline has been deleted. /// /// /// The specified pipeline was not found. Verify that you used the correct user and account /// identifiers. /// /// REST API Reference for PutPipelineDefinition Operation PutPipelineDefinitionResponse PutPipelineDefinition(PutPipelineDefinitionRequest 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. /// /// /// Container for the necessary parameters to execute the PutPipelineDefinition service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the PutPipelineDefinition service method, as returned by DataPipeline. /// /// An internal service error occurred. /// /// /// The request was not valid. Verify that your request was properly formatted, that the /// signature was generated with the correct credentials, and that you haven't exceeded /// any of the service limits for your account. /// /// /// The specified pipeline has been deleted. /// /// /// The specified pipeline was not found. Verify that you used the correct user and account /// identifiers. /// /// REST API Reference for PutPipelineDefinition Operation Task PutPipelineDefinitionAsync(PutPipelineDefinitionRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region QueryObjects /// /// Queries the specified pipeline for the names of objects that match the specified set /// of conditions. /// /// Container for the necessary parameters to execute the QueryObjects service method. /// /// The response from the QueryObjects service method, as returned by DataPipeline. /// /// An internal service error occurred. /// /// /// The request was not valid. Verify that your request was properly formatted, that the /// signature was generated with the correct credentials, and that you haven't exceeded /// any of the service limits for your account. /// /// /// The specified pipeline has been deleted. /// /// /// The specified pipeline was not found. Verify that you used the correct user and account /// identifiers. /// /// REST API Reference for QueryObjects Operation QueryObjectsResponse QueryObjects(QueryObjectsRequest request); /// /// Queries the specified pipeline for the names of objects that match the specified set /// of conditions. /// /// Container for the necessary parameters to execute the QueryObjects service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the QueryObjects service method, as returned by DataPipeline. /// /// An internal service error occurred. /// /// /// The request was not valid. Verify that your request was properly formatted, that the /// signature was generated with the correct credentials, and that you haven't exceeded /// any of the service limits for your account. /// /// /// The specified pipeline has been deleted. /// /// /// The specified pipeline was not found. Verify that you used the correct user and account /// identifiers. /// /// REST API Reference for QueryObjects Operation Task QueryObjectsAsync(QueryObjectsRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region RemoveTags /// /// Removes existing tags from the specified pipeline. /// /// The ID of the pipeline. /// The keys of the tags to remove. /// /// The response from the RemoveTags service method, as returned by DataPipeline. /// /// An internal service error occurred. /// /// /// The request was not valid. Verify that your request was properly formatted, that the /// signature was generated with the correct credentials, and that you haven't exceeded /// any of the service limits for your account. /// /// /// The specified pipeline has been deleted. /// /// /// The specified pipeline was not found. Verify that you used the correct user and account /// identifiers. /// /// REST API Reference for RemoveTags Operation RemoveTagsResponse RemoveTags(string pipelineId, List tagKeys); /// /// Removes existing tags from the specified pipeline. /// /// Container for the necessary parameters to execute the RemoveTags service method. /// /// The response from the RemoveTags service method, as returned by DataPipeline. /// /// An internal service error occurred. /// /// /// The request was not valid. Verify that your request was properly formatted, that the /// signature was generated with the correct credentials, and that you haven't exceeded /// any of the service limits for your account. /// /// /// The specified pipeline has been deleted. /// /// /// The specified pipeline was not found. Verify that you used the correct user and account /// identifiers. /// /// REST API Reference for RemoveTags Operation RemoveTagsResponse RemoveTags(RemoveTagsRequest request); /// /// Removes existing tags from the specified pipeline. /// /// The ID of the pipeline. /// The keys of the tags to remove. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the RemoveTags service method, as returned by DataPipeline. /// /// An internal service error occurred. /// /// /// The request was not valid. Verify that your request was properly formatted, that the /// signature was generated with the correct credentials, and that you haven't exceeded /// any of the service limits for your account. /// /// /// The specified pipeline has been deleted. /// /// /// The specified pipeline was not found. Verify that you used the correct user and account /// identifiers. /// /// REST API Reference for RemoveTags Operation Task RemoveTagsAsync(string pipelineId, List tagKeys, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); /// /// Removes existing tags from the specified pipeline. /// /// Container for the necessary parameters to execute the RemoveTags service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the RemoveTags service method, as returned by DataPipeline. /// /// An internal service error occurred. /// /// /// The request was not valid. Verify that your request was properly formatted, that the /// signature was generated with the correct credentials, and that you haven't exceeded /// any of the service limits for your account. /// /// /// The specified pipeline has been deleted. /// /// /// The specified pipeline was not found. Verify that you used the correct user and account /// identifiers. /// /// REST API Reference for RemoveTags Operation Task RemoveTagsAsync(RemoveTagsRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ReportTaskProgress /// /// 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. /// /// /// Container for the necessary parameters to execute the ReportTaskProgress service method. /// /// The response from the ReportTaskProgress service method, as returned by DataPipeline. /// /// An internal service error occurred. /// /// /// The request was not valid. Verify that your request was properly formatted, that the /// signature was generated with the correct credentials, and that you haven't exceeded /// any of the service limits for your account. /// /// /// The specified pipeline has been deleted. /// /// /// The specified pipeline was not found. Verify that you used the correct user and account /// identifiers. /// /// /// The specified task was not found. /// /// REST API Reference for ReportTaskProgress Operation ReportTaskProgressResponse ReportTaskProgress(ReportTaskProgressRequest 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. /// /// /// Container for the necessary parameters to execute the ReportTaskProgress service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ReportTaskProgress service method, as returned by DataPipeline. /// /// An internal service error occurred. /// /// /// The request was not valid. Verify that your request was properly formatted, that the /// signature was generated with the correct credentials, and that you haven't exceeded /// any of the service limits for your account. /// /// /// The specified pipeline has been deleted. /// /// /// The specified pipeline was not found. Verify that you used the correct user and account /// identifiers. /// /// /// The specified task was not found. /// /// REST API Reference for ReportTaskProgress Operation Task ReportTaskProgressAsync(ReportTaskProgressRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ReportTaskRunnerHeartbeat /// /// 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. /// /// Container for the necessary parameters to execute the ReportTaskRunnerHeartbeat service method. /// /// The response from the ReportTaskRunnerHeartbeat service method, as returned by DataPipeline. /// /// An internal service error occurred. /// /// /// The request was not valid. Verify that your request was properly formatted, that the /// signature was generated with the correct credentials, and that you haven't exceeded /// any of the service limits for your account. /// /// REST API Reference for ReportTaskRunnerHeartbeat Operation ReportTaskRunnerHeartbeatResponse ReportTaskRunnerHeartbeat(ReportTaskRunnerHeartbeatRequest 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. /// /// Container for the necessary parameters to execute the ReportTaskRunnerHeartbeat service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ReportTaskRunnerHeartbeat service method, as returned by DataPipeline. /// /// An internal service error occurred. /// /// /// The request was not valid. Verify that your request was properly formatted, that the /// signature was generated with the correct credentials, and that you haven't exceeded /// any of the service limits for your account. /// /// REST API Reference for ReportTaskRunnerHeartbeat Operation Task ReportTaskRunnerHeartbeatAsync(ReportTaskRunnerHeartbeatRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region SetStatus /// /// 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. /// /// Container for the necessary parameters to execute the SetStatus service method. /// /// The response from the SetStatus service method, as returned by DataPipeline. /// /// An internal service error occurred. /// /// /// The request was not valid. Verify that your request was properly formatted, that the /// signature was generated with the correct credentials, and that you haven't exceeded /// any of the service limits for your account. /// /// /// The specified pipeline has been deleted. /// /// /// The specified pipeline was not found. Verify that you used the correct user and account /// identifiers. /// /// REST API Reference for SetStatus Operation SetStatusResponse SetStatus(SetStatusRequest 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. /// /// Container for the necessary parameters to execute the SetStatus service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the SetStatus service method, as returned by DataPipeline. /// /// An internal service error occurred. /// /// /// The request was not valid. Verify that your request was properly formatted, that the /// signature was generated with the correct credentials, and that you haven't exceeded /// any of the service limits for your account. /// /// /// The specified pipeline has been deleted. /// /// /// The specified pipeline was not found. Verify that you used the correct user and account /// identifiers. /// /// REST API Reference for SetStatus Operation Task SetStatusAsync(SetStatusRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region SetTaskStatus /// /// 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. /// /// Container for the necessary parameters to execute the SetTaskStatus service method. /// /// The response from the SetTaskStatus service method, as returned by DataPipeline. /// /// An internal service error occurred. /// /// /// The request was not valid. Verify that your request was properly formatted, that the /// signature was generated with the correct credentials, and that you haven't exceeded /// any of the service limits for your account. /// /// /// The specified pipeline has been deleted. /// /// /// The specified pipeline was not found. Verify that you used the correct user and account /// identifiers. /// /// /// The specified task was not found. /// /// REST API Reference for SetTaskStatus Operation SetTaskStatusResponse SetTaskStatus(SetTaskStatusRequest 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. /// /// Container for the necessary parameters to execute the SetTaskStatus service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the SetTaskStatus service method, as returned by DataPipeline. /// /// An internal service error occurred. /// /// /// The request was not valid. Verify that your request was properly formatted, that the /// signature was generated with the correct credentials, and that you haven't exceeded /// any of the service limits for your account. /// /// /// The specified pipeline has been deleted. /// /// /// The specified pipeline was not found. Verify that you used the correct user and account /// identifiers. /// /// /// The specified task was not found. /// /// REST API Reference for SetTaskStatus Operation Task SetTaskStatusAsync(SetTaskStatusRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ValidatePipelineDefinition /// /// Validates the specified pipeline definition to ensure that it is well formed and can /// be run without error. /// /// Container for the necessary parameters to execute the ValidatePipelineDefinition service method. /// /// The response from the ValidatePipelineDefinition service method, as returned by DataPipeline. /// /// An internal service error occurred. /// /// /// The request was not valid. Verify that your request was properly formatted, that the /// signature was generated with the correct credentials, and that you haven't exceeded /// any of the service limits for your account. /// /// /// The specified pipeline has been deleted. /// /// /// The specified pipeline was not found. Verify that you used the correct user and account /// identifiers. /// /// REST API Reference for ValidatePipelineDefinition Operation ValidatePipelineDefinitionResponse ValidatePipelineDefinition(ValidatePipelineDefinitionRequest request); /// /// Validates the specified pipeline definition to ensure that it is well formed and can /// be run without error. /// /// Container for the necessary parameters to execute the ValidatePipelineDefinition service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ValidatePipelineDefinition service method, as returned by DataPipeline. /// /// An internal service error occurred. /// /// /// The request was not valid. Verify that your request was properly formatted, that the /// signature was generated with the correct credentials, and that you haven't exceeded /// any of the service limits for your account. /// /// /// The specified pipeline has been deleted. /// /// /// The specified pipeline was not found. Verify that you used the correct user and account /// identifiers. /// /// REST API Reference for ValidatePipelineDefinition Operation Task ValidatePipelineDefinitionAsync(ValidatePipelineDefinitionRequest request, CancellationToken cancellationToken = default(CancellationToken)); #endregion } }