Struct rusoto_datapipeline::DataPipelineClient

pub struct DataPipelineClient { /* fields omitted */ }

A client for the AWS Data Pipeline API.

Implementations

impl DataPipelineClient

pub fn new(region: Region) -> DataPipelineClient

Creates a client backed by the default tokio event loop.

The client will use the default credentials provider and tls client.

pub fn new_with<P, D>(
    request_dispatcher: D,
    credentials_provider: P,
    region: Region
) -> DataPipelineClient where
    P: ProvideAwsCredentials + Send + Sync + 'static,
    D: DispatchSignedRequest + Send + Sync + 'static, 

pub fn new_with_client(client: Client, region: Region) -> DataPipelineClient

Trait Implementations

impl Clone for DataPipelineClient

pub fn clone(&self) -> DataPipelineClient

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl DataPipeline for DataPipelineClient

pub fn activate_pipeline<'life0, 'async_trait>(
    &'life0 self,
    input: ActivatePipelineInput
) -> Pin<Box<dyn Future<Output = Result<ActivatePipelineOutput, RusotoError<ActivatePipelineError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

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.

pub fn add_tags<'life0, 'async_trait>(
    &'life0 self,
    input: AddTagsInput
) -> Pin<Box<dyn Future<Output = Result<AddTagsOutput, RusotoError<AddTagsError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Adds or modifies tags for the specified pipeline.

pub fn create_pipeline<'life0, 'async_trait>(
    &'life0 self,
    input: CreatePipelineInput
) -> Pin<Box<dyn Future<Output = Result<CreatePipelineOutput, RusotoError<CreatePipelineError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

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

pub fn deactivate_pipeline<'life0, 'async_trait>(
    &'life0 self,
    input: DeactivatePipelineInput
) -> Pin<Box<dyn Future<Output = Result<DeactivatePipelineOutput, RusotoError<DeactivatePipelineError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

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.

pub fn delete_pipeline<'life0, 'async_trait>(
    &'life0 self,
    input: DeletePipelineInput
) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<DeletePipelineError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

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.

pub fn describe_objects<'life0, 'async_trait>(
    &'life0 self,
    input: DescribeObjectsInput
) -> Pin<Box<dyn Future<Output = Result<DescribeObjectsOutput, RusotoError<DescribeObjectsError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

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.

pub fn describe_pipelines<'life0, 'async_trait>(
    &'life0 self,
    input: DescribePipelinesInput
) -> Pin<Box<dyn Future<Output = Result<DescribePipelinesOutput, RusotoError<DescribePipelinesError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

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.

pub fn evaluate_expression<'life0, 'async_trait>(
    &'life0 self,
    input: EvaluateExpressionInput
) -> Pin<Box<dyn Future<Output = Result<EvaluateExpressionOutput, RusotoError<EvaluateExpressionError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

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.

pub fn get_pipeline_definition<'life0, 'async_trait>(
    &'life0 self,
    input: GetPipelineDefinitionInput
) -> Pin<Box<dyn Future<Output = Result<GetPipelineDefinitionOutput, RusotoError<GetPipelineDefinitionError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

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

pub fn list_pipelines<'life0, 'async_trait>(
    &'life0 self,
    input: ListPipelinesInput
) -> Pin<Box<dyn Future<Output = Result<ListPipelinesOutput, RusotoError<ListPipelinesError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

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

pub fn poll_for_task<'life0, 'async_trait>(
    &'life0 self,
    input: PollForTaskInput
) -> Pin<Box<dyn Future<Output = Result<PollForTaskOutput, RusotoError<PollForTaskError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

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.

pub fn put_pipeline_definition<'life0, 'async_trait>(
    &'life0 self,
    input: PutPipelineDefinitionInput
) -> Pin<Box<dyn Future<Output = Result<PutPipelineDefinitionOutput, RusotoError<PutPipelineDefinitionError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

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.

pub fn query_objects<'life0, 'async_trait>(
    &'life0 self,
    input: QueryObjectsInput
) -> Pin<Box<dyn Future<Output = Result<QueryObjectsOutput, RusotoError<QueryObjectsError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

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

pub fn remove_tags<'life0, 'async_trait>(
    &'life0 self,
    input: RemoveTagsInput
) -> Pin<Box<dyn Future<Output = Result<RemoveTagsOutput, RusotoError<RemoveTagsError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Removes existing tags from the specified pipeline.

pub fn report_task_progress<'life0, 'async_trait>(
    &'life0 self,
    input: ReportTaskProgressInput
) -> Pin<Box<dyn Future<Output = Result<ReportTaskProgressOutput, RusotoError<ReportTaskProgressError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

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.

pub fn report_task_runner_heartbeat<'life0, 'async_trait>(
    &'life0 self,
    input: ReportTaskRunnerHeartbeatInput
) -> Pin<Box<dyn Future<Output = Result<ReportTaskRunnerHeartbeatOutput, RusotoError<ReportTaskRunnerHeartbeatError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

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.

pub fn set_status<'life0, 'async_trait>(
    &'life0 self,
    input: SetStatusInput
) -> Pin<Box<dyn Future<Output = Result<(), RusotoError<SetStatusError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

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.

pub fn set_task_status<'life0, 'async_trait>(
    &'life0 self,
    input: SetTaskStatusInput
) -> Pin<Box<dyn Future<Output = Result<SetTaskStatusOutput, RusotoError<SetTaskStatusError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

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.

pub fn validate_pipeline_definition<'life0, 'async_trait>(
    &'life0 self,
    input: ValidatePipelineDefinitionInput
) -> Pin<Box<dyn Future<Output = Result<ValidatePipelineDefinitionOutput, RusotoError<ValidatePipelineDefinitionError>>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

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