Struct aws_sdk_datapipeline::Client

pub struct Client { /* private fields */ }

Client for AWS Data Pipeline

Client for invoking operations on AWS Data Pipeline. Each operation on AWS Data Pipeline is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_datapipeline::Client::new(&config);

Occasionally, SDKs may have additional service-specific that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Config struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = aws_config::load_from_env().await;
let config = aws_sdk_datapipeline::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the ActivatePipeline operation has a Client::activate_pipeline, function which returns a builder for that operation. The fluent builder ultimately has a call() function that returns an async future that returns a result, as illustrated below:

let result = client.activate_pipeline()
    .pipeline_id("example")
    .call()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Implementations

impl Client

pub fn activate_pipeline(&self) -> ActivatePipelineFluentBuilder

Constructs a fluent builder for the ActivatePipeline operation.

• The fluent builder is configurable:
  • pipeline_id(impl Into<String>) / set_pipeline_id(Option<String>):

    The ID of the pipeline.

  • parameter_values(Vec<ParameterValue>) / set_parameter_values(Option<Vec<ParameterValue>>):

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

  • start_timestamp(DateTime) / set_start_timestamp(Option<DateTime>):

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

• On success, responds with ActivatePipelineOutput
• On failure, responds with SdkError<ActivatePipelineError>

impl Client

pub fn add_tags(&self) -> AddTagsFluentBuilder

Constructs a fluent builder for the AddTags operation.

• The fluent builder is configurable:
  • pipeline_id(impl Into<String>) / set_pipeline_id(Option<String>):

    The ID of the pipeline.

  • tags(Vec<Tag>) / set_tags(Option<Vec<Tag>>):

    The tags to add, as key/value pairs.

• On success, responds with AddTagsOutput
• On failure, responds with SdkError<AddTagsError>

impl Client

pub fn create_pipeline(&self) -> CreatePipelineFluentBuilder

Constructs a fluent builder for the CreatePipeline operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<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.

  • unique_id(impl Into<String>) / set_unique_id(Option<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(impl Into<String>) / set_description(Option<String>):

    The description for the pipeline.

  • tags(Vec<Tag>) / set_tags(Option<Vec<Tag>>):

    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.

• On success, responds with CreatePipelineOutput with field(s):
  • pipeline_id(Option<String>):

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

• On failure, responds with SdkError<CreatePipelineError>

impl Client

pub fn deactivate_pipeline(&self) -> DeactivatePipelineFluentBuilder

Constructs a fluent builder for the DeactivatePipeline operation.

• The fluent builder is configurable:
  • pipeline_id(impl Into<String>) / set_pipeline_id(Option<String>):

    The ID of the pipeline.

  • cancel_active(bool) / set_cancel_active(Option<bool>):

    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.

• On success, responds with DeactivatePipelineOutput
• On failure, responds with SdkError<DeactivatePipelineError>

impl Client

pub fn delete_pipeline(&self) -> DeletePipelineFluentBuilder

Constructs a fluent builder for the DeletePipeline operation.

• The fluent builder is configurable:
  • pipeline_id(impl Into<String>) / set_pipeline_id(Option<String>):

    The ID of the pipeline.

• On success, responds with DeletePipelineOutput
• On failure, responds with SdkError<DeletePipelineError>

impl Client

pub fn describe_objects(&self) -> DescribeObjectsFluentBuilder

Constructs a fluent builder for the DescribeObjects operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • pipeline_id(impl Into<String>) / set_pipeline_id(Option<String>):

    The ID of the pipeline that contains the object definitions.

  • object_ids(Vec<String>) / set_object_ids(Option<Vec<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.

  • evaluate_expressions(bool) / set_evaluate_expressions(bool):

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

  • marker(impl Into<String>) / set_marker(Option<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.

• On success, responds with DescribeObjectsOutput with field(s):
  • pipeline_objects(Option<Vec<PipelineObject>>):

    An array of object definitions.

  • marker(Option<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.

  • has_more_results(bool):

    Indicates whether there are more results to return.

• On failure, responds with SdkError<DescribeObjectsError>

impl Client

pub fn describe_pipelines(&self) -> DescribePipelinesFluentBuilder

Constructs a fluent builder for the DescribePipelines operation.

• The fluent builder is configurable:
  • pipeline_ids(Vec<String>) / set_pipeline_ids(Option<Vec<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.

• On success, responds with DescribePipelinesOutput with field(s):
  • pipeline_description_list(Option<Vec<PipelineDescription>>):

    An array of descriptions for the specified pipelines.

• On failure, responds with SdkError<DescribePipelinesError>

impl Client

pub fn evaluate_expression(&self) -> EvaluateExpressionFluentBuilder

Constructs a fluent builder for the EvaluateExpression operation.

• The fluent builder is configurable:
  • pipeline_id(impl Into<String>) / set_pipeline_id(Option<String>):

    The ID of the pipeline.

  • object_id(impl Into<String>) / set_object_id(Option<String>):

    The ID of the object.

  • expression(impl Into<String>) / set_expression(Option<String>):

    The expression to evaluate.

• On success, responds with EvaluateExpressionOutput with field(s):
  • evaluated_expression(Option<String>):

    The evaluated expression.

• On failure, responds with SdkError<EvaluateExpressionError>

impl Client

pub fn get_pipeline_definition(&self) -> GetPipelineDefinitionFluentBuilder

Constructs a fluent builder for the GetPipelineDefinition operation.

• The fluent builder is configurable:
  • pipeline_id(impl Into<String>) / set_pipeline_id(Option<String>):

    The ID of the pipeline.

  • version(impl Into<String>) / set_version(Option<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.

• On success, responds with GetPipelineDefinitionOutput with field(s):
  • pipeline_objects(Option<Vec<PipelineObject>>):

    The objects defined in the pipeline.

  • parameter_objects(Option<Vec<ParameterObject>>):

    The parameter objects used in the pipeline definition.

  • parameter_values(Option<Vec<ParameterValue>>):

    The parameter values used in the pipeline definition.

• On failure, responds with SdkError<GetPipelineDefinitionError>

impl Client

pub fn list_pipelines(&self) -> ListPipelinesFluentBuilder

Constructs a fluent builder for the ListPipelines operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • marker(impl Into<String>) / set_marker(Option<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.

• On success, responds with ListPipelinesOutput with field(s):
  • pipeline_id_list(Option<Vec<PipelineIdName>>):

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

  • marker(Option<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.

  • has_more_results(bool):

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

• On failure, responds with SdkError<ListPipelinesError>

impl Client

pub fn poll_for_task(&self) -> PollForTaskFluentBuilder

Constructs a fluent builder for the PollForTask operation.

• The fluent builder is configurable:
  • worker_group(impl Into<String>) / set_worker_group(Option<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(impl Into<String>) / set_hostname(Option<String>):

    The public DNS name of the calling task runner.

  • instance_identity(InstanceIdentity) / set_instance_identity(Option<InstanceIdentity>):

    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.

• On success, responds with PollForTaskOutput with field(s):
  • task_object(Option<TaskObject>):

    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.

• On failure, responds with SdkError<PollForTaskError>

impl Client

pub fn put_pipeline_definition(&self) -> PutPipelineDefinitionFluentBuilder

Constructs a fluent builder for the PutPipelineDefinition operation.

• The fluent builder is configurable:
  • pipeline_id(impl Into<String>) / set_pipeline_id(Option<String>):

    The ID of the pipeline.

  • pipeline_objects(Vec<PipelineObject>) / set_pipeline_objects(Option<Vec<PipelineObject>>):

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

  • parameter_objects(Vec<ParameterObject>) / set_parameter_objects(Option<Vec<ParameterObject>>):

    The parameter objects used with the pipeline.

  • parameter_values(Vec<ParameterValue>) / set_parameter_values(Option<Vec<ParameterValue>>):

    The parameter values used with the pipeline.

• On success, responds with PutPipelineDefinitionOutput with field(s):
  • validation_errors(Option<Vec<ValidationError>>):

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

  • validation_warnings(Option<Vec<ValidationWarning>>):

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

  • errored(bool):

    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.

• On failure, responds with SdkError<PutPipelineDefinitionError>

impl Client

pub fn query_objects(&self) -> QueryObjectsFluentBuilder

Constructs a fluent builder for the QueryObjects operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • pipeline_id(impl Into<String>) / set_pipeline_id(Option<String>):

    The ID of the pipeline.

  • query(Query) / set_query(Option<Query>):

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

  • sphere(impl Into<String>) / set_sphere(Option<String>):

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

  • marker(impl Into<String>) / set_marker(Option<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(i32) / set_limit(Option<i32>):

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

• On success, responds with QueryObjectsOutput with field(s):
  • ids(Option<Vec<String>>):

    The identifiers that match the query selectors.

  • marker(Option<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.

  • has_more_results(bool):

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

• On failure, responds with SdkError<QueryObjectsError>

impl Client

pub fn remove_tags(&self) -> RemoveTagsFluentBuilder

Constructs a fluent builder for the RemoveTags operation.

• The fluent builder is configurable:
  • pipeline_id(impl Into<String>) / set_pipeline_id(Option<String>):

    The ID of the pipeline.

  • tag_keys(Vec<String>) / set_tag_keys(Option<Vec<String>>):

    The keys of the tags to remove.

• On success, responds with RemoveTagsOutput
• On failure, responds with SdkError<RemoveTagsError>

impl Client

pub fn report_task_progress(&self) -> ReportTaskProgressFluentBuilder

Constructs a fluent builder for the ReportTaskProgress operation.

• The fluent builder is configurable:
  • task_id(impl Into<String>) / set_task_id(Option<String>):

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

  • fields(Vec<Field>) / set_fields(Option<Vec<Field>>):

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

• On success, responds with ReportTaskProgressOutput with field(s):
  • canceled(bool):

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

• On failure, responds with SdkError<ReportTaskProgressError>

impl Client

pub fn report_task_runner_heartbeat( &self ) -> ReportTaskRunnerHeartbeatFluentBuilder

Constructs a fluent builder for the ReportTaskRunnerHeartbeat operation.

• The fluent builder is configurable:
  • taskrunner_id(impl Into<String>) / set_taskrunner_id(Option<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.

  • worker_group(impl Into<String>) / set_worker_group(Option<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(impl Into<String>) / set_hostname(Option<String>):

    The public DNS name of the task runner.

• On success, responds with ReportTaskRunnerHeartbeatOutput with field(s):
  • terminate(bool):

    Indicates whether the calling task runner should terminate.

• On failure, responds with SdkError<ReportTaskRunnerHeartbeatError>

impl Client

pub fn set_status(&self) -> SetStatusFluentBuilder

Constructs a fluent builder for the SetStatus operation.

• The fluent builder is configurable:
  • pipeline_id(impl Into<String>) / set_pipeline_id(Option<String>):

    The ID of the pipeline that contains the objects.

  • object_ids(Vec<String>) / set_object_ids(Option<Vec<String>>):

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

  • status(impl Into<String>) / set_status(Option<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.

• On success, responds with SetStatusOutput
• On failure, responds with SdkError<SetStatusError>

impl Client

pub fn set_task_status(&self) -> SetTaskStatusFluentBuilder

Constructs a fluent builder for the SetTaskStatus operation.

• The fluent builder is configurable:
  • task_id(impl Into<String>) / set_task_id(Option<String>):

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

  • task_status(TaskStatus) / set_task_status(Option<TaskStatus>):

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

  • error_id(impl Into<String>) / set_error_id(Option<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.

  • error_message(impl Into<String>) / set_error_message(Option<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.

  • error_stack_trace(impl Into<String>) / set_error_stack_trace(Option<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.

• On success, responds with SetTaskStatusOutput
• On failure, responds with SdkError<SetTaskStatusError>

impl Client

pub fn validate_pipeline_definition( &self ) -> ValidatePipelineDefinitionFluentBuilder

Constructs a fluent builder for the ValidatePipelineDefinition operation.

• The fluent builder is configurable:
  • pipeline_id(impl Into<String>) / set_pipeline_id(Option<String>):

    The ID of the pipeline.

  • pipeline_objects(Vec<PipelineObject>) / set_pipeline_objects(Option<Vec<PipelineObject>>):

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

  • parameter_objects(Vec<ParameterObject>) / set_parameter_objects(Option<Vec<ParameterObject>>):

    The parameter objects used with the pipeline.

  • parameter_values(Vec<ParameterValue>) / set_parameter_values(Option<Vec<ParameterValue>>):

    The parameter values used with the pipeline.

• On success, responds with ValidatePipelineDefinitionOutput with field(s):
  • validation_errors(Option<Vec<ValidationError>>):

    Any validation errors that were found.

  • validation_warnings(Option<Vec<ValidationWarning>>):

    Any validation warnings that were found.

  • errored(bool):

    Indicates whether there were validation errors.

• On failure, responds with SdkError<ValidatePipelineDefinitionError>

impl Client

pub fn with_config( client: Client<DynConnector, DynMiddleware<DynConnector>>, conf: Config ) -> Self

Creates a client with the given service configuration.

pub fn conf(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

• This method will panic if the conf is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the conf is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<Client<DynConnector, DynMiddleware<DynConnector>, Standard>> for Client

fn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self

Converts to this type from the input type.