Smaws_Client_DataPipeline (smaws-clients.Smaws_Client

Types

module Types : sig ... end

Builders

val make_tag : value:Types.tag_value -> key:Types.tag_key -> unit -> Types.tag

val make_pipeline_id_name : 
  ?name:Types.id ->
  ?id:Types.id ->
  unit ->
  Types.pipeline_id_name

val make_field : 
  ?ref_value:Types.field_name_string ->
  ?string_value:Types.field_string_value ->
  key:Types.field_name_string ->
  unit ->
  Types.field

val make_validation_warning : 
  ?warnings:Types.validation_messages ->
  ?id:Types.id ->
  unit ->
  Types.validation_warning

val make_validation_error : 
  ?errors:Types.validation_messages ->
  ?id:Types.id ->
  unit ->
  Types.validation_error

val make_validate_pipeline_definition_output : 
  ?validation_warnings:Types.validation_warnings ->
  ?validation_errors:Types.validation_errors ->
  errored:Types.boolean_ ->
  unit ->
  Types.validate_pipeline_definition_output

val make_pipeline_object : 
  fields:Types.field_list ->
  name:Types.id ->
  id:Types.id ->
  unit ->
  Types.pipeline_object

val make_parameter_attribute : 
  string_value:Types.attribute_value_string ->
  key:Types.attribute_name_string ->
  unit ->
  Types.parameter_attribute

val make_parameter_object : 
  attributes:Types.parameter_attribute_list ->
  id:Types.field_name_string ->
  unit ->
  Types.parameter_object

val make_parameter_value : 
  string_value:Types.field_string_value ->
  id:Types.field_name_string ->
  unit ->
  Types.parameter_value

val make_validate_pipeline_definition_input : 
  ?parameter_values:Types.parameter_value_list ->
  ?parameter_objects:Types.parameter_object_list ->
  pipeline_objects:Types.pipeline_object_list ->
  pipeline_id:Types.id ->
  unit ->
  Types.validate_pipeline_definition_input

val make_task_object : 
  ?objects:Types.pipeline_object_map ->
  ?attempt_id:Types.id ->
  ?pipeline_id:Types.id ->
  ?task_id:Types.task_id ->
  unit ->
  Types.task_object

val make_set_task_status_output : unit -> unit

val make_set_task_status_input : 
  ?error_stack_trace:Types.string_ ->
  ?error_message:Types.error_message ->
  ?error_id:Types.string_ ->
  task_status:Types.task_status ->
  task_id:Types.task_id ->
  unit ->
  Types.set_task_status_input

val make_set_status_input : 
  status:Types.string_ ->
  object_ids:Types.id_list ->
  pipeline_id:Types.id ->
  unit ->
  Types.set_status_input

val make_operator : 
  ?values:Types.string_list ->
  ?type_:Types.operator_type ->
  unit ->
  Types.operator

val make_selector : 
  ?operator:Types.operator ->
  ?field_name:Types.string_ ->
  unit ->
  Types.selector

val make_report_task_runner_heartbeat_output : 
  terminate:Types.boolean_ ->
  unit ->
  Types.report_task_runner_heartbeat_output

val make_report_task_runner_heartbeat_input : 
  ?hostname:Types.id ->
  ?worker_group:Types.string_ ->
  taskrunner_id:Types.id ->
  unit ->
  Types.report_task_runner_heartbeat_input

val make_report_task_progress_output : 
  canceled:Types.boolean_ ->
  unit ->
  Types.report_task_progress_output

val make_report_task_progress_input : 
  ?fields:Types.field_list ->
  task_id:Types.task_id ->
  unit ->
  Types.report_task_progress_input

val make_remove_tags_output : unit -> unit

val make_remove_tags_input : 
  tag_keys:Types.string_list ->
  pipeline_id:Types.id ->
  unit ->
  Types.remove_tags_input

val make_query_objects_output : 
  ?has_more_results:Types.boolean_ ->
  ?marker:Types.string_ ->
  ?ids:Types.id_list ->
  unit ->
  Types.query_objects_output

val make_query : ?selectors:Types.selector_list -> unit -> Types.query

val make_query_objects_input : 
  ?limit:Types.int_ ->
  ?marker:Types.string_ ->
  ?query:Types.query ->
  sphere:Types.string_ ->
  pipeline_id:Types.id ->
  unit ->
  Types.query_objects_input

val make_put_pipeline_definition_output : 
  ?validation_warnings:Types.validation_warnings ->
  ?validation_errors:Types.validation_errors ->
  errored:Types.boolean_ ->
  unit ->
  Types.put_pipeline_definition_output

val make_put_pipeline_definition_input : 
  ?parameter_values:Types.parameter_value_list ->
  ?parameter_objects:Types.parameter_object_list ->
  pipeline_objects:Types.pipeline_object_list ->
  pipeline_id:Types.id ->
  unit ->
  Types.put_pipeline_definition_input

val make_poll_for_task_output : 
  ?task_object:Types.task_object ->
  unit ->
  Types.poll_for_task_output

val make_instance_identity : 
  ?signature:Types.string_ ->
  ?document:Types.string_ ->
  unit ->
  Types.instance_identity

val make_poll_for_task_input : 
  ?instance_identity:Types.instance_identity ->
  ?hostname:Types.id ->
  worker_group:Types.string_ ->
  unit ->
  Types.poll_for_task_input

val make_pipeline_description : 
  ?tags:Types.tag_list ->
  ?description:Types.string_ ->
  fields:Types.field_list ->
  name:Types.id ->
  pipeline_id:Types.id ->
  unit ->
  Types.pipeline_description

val make_list_pipelines_output : 
  ?has_more_results:Types.boolean_ ->
  ?marker:Types.string_ ->
  pipeline_id_list:Types.pipeline_list ->
  unit ->
  Types.list_pipelines_output

val make_list_pipelines_input : 
  ?marker:Types.string_ ->
  unit ->
  Types.list_pipelines_input

val make_get_pipeline_definition_output : 
  ?parameter_values:Types.parameter_value_list ->
  ?parameter_objects:Types.parameter_object_list ->
  ?pipeline_objects:Types.pipeline_object_list ->
  unit ->
  Types.get_pipeline_definition_output

val make_get_pipeline_definition_input : 
  ?version:Types.string_ ->
  pipeline_id:Types.id ->
  unit ->
  Types.get_pipeline_definition_input

val make_evaluate_expression_output : 
  evaluated_expression:Types.long_string ->
  unit ->
  Types.evaluate_expression_output

val make_evaluate_expression_input : 
  expression:Types.long_string ->
  object_id:Types.id ->
  pipeline_id:Types.id ->
  unit ->
  Types.evaluate_expression_input

val make_describe_pipelines_output : 
  pipeline_description_list:Types.pipeline_description_list ->
  unit ->
  Types.describe_pipelines_output

val make_describe_pipelines_input : 
  pipeline_ids:Types.id_list ->
  unit ->
  Types.describe_pipelines_input

val make_describe_objects_output : 
  ?has_more_results:Types.boolean_ ->
  ?marker:Types.string_ ->
  pipeline_objects:Types.pipeline_object_list ->
  unit ->
  Types.describe_objects_output

val make_describe_objects_input : 
  ?marker:Types.string_ ->
  ?evaluate_expressions:Types.boolean_ ->
  object_ids:Types.id_list ->
  pipeline_id:Types.id ->
  unit ->
  Types.describe_objects_input

val make_delete_pipeline_input : 
  pipeline_id:Types.id ->
  unit ->
  Types.delete_pipeline_input

val make_deactivate_pipeline_output : unit -> unit

val make_deactivate_pipeline_input : 
  ?cancel_active:Types.cancel_active ->
  pipeline_id:Types.id ->
  unit ->
  Types.deactivate_pipeline_input

val make_create_pipeline_output : 
  pipeline_id:Types.id ->
  unit ->
  Types.create_pipeline_output

val make_create_pipeline_input : 
  ?tags:Types.tag_list ->
  ?description:Types.string_ ->
  unique_id:Types.id ->
  name:Types.id ->
  unit ->
  Types.create_pipeline_input

val make_add_tags_output : unit -> unit

val make_add_tags_input : 
  tags:Types.tag_list ->
  pipeline_id:Types.id ->
  unit ->
  Types.add_tags_input

val make_activate_pipeline_output : unit -> unit

val make_activate_pipeline_input : 
  ?start_timestamp:Types.timestamp ->
  ?parameter_values:Types.parameter_value_list ->
  pipeline_id:Types.id ->
  unit ->
  Types.activate_pipeline_input

Operations

module ActivatePipeline : sig ... end

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

module AddTags : sig ... end

Adds or modifies tags for the specified pipeline.

module CreatePipeline : sig ... end

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

module DeactivatePipeline : sig ... end

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

module DeletePipeline : sig ... end

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.

module DescribeObjects : sig ... end

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.

module DescribePipelines : sig ... end

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.

module EvaluateExpression : sig ... end

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.

module GetPipelineDefinition : sig ... end

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

module ListPipelines : sig ... end

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

module PollForTask : sig ... end

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.

module PutPipelineDefinition : sig ... end

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

module QueryObjects : sig ... end

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

module RemoveTags : sig ... end

Removes existing tags from the specified pipeline.

module ReportTaskProgress : sig ... end

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.

module ReportTaskRunnerHeartbeat : sig ... end

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.

module SetStatus : sig ... end

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.

module SetTaskStatus : sig ... end

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.

module ValidatePipelineDefinition : sig ... end

module Json_serializers : sig ... end

module Json_deserializers : sig ... end