Smaws_Client_DataPipeline.Typestype nonrec validation_messages = validation_message listtype nonrec tag = {value : tag_value;The optional value portion of a tag defined by a user. For more information, see Controlling User Access to Pipelines in the AWS Data Pipeline Developer Guide.
*)key : tag_key;The key name of a tag defined by a user. For more information, see Controlling User Access to Pipelines in the AWS Data Pipeline Developer Guide.
*)}Tags are key/value pairs defined by a user and associated with a pipeline to control access. AWS Data Pipeline allows you to associate ten tags per pipeline. For more information, see Controlling User Access to Pipelines in the AWS Data Pipeline Developer Guide.
type nonrec tag_list = tag listtype nonrec string_list = string_ listtype nonrec pipeline_id_name = {name : id option;The name of the pipeline.
*)id : id option;The ID of the pipeline that was assigned by AWS Data Pipeline. This is a string of the form df-297EG78HU43EEXAMPLE.
}Contains the name and identifier of a pipeline.
type nonrec pipeline_list = pipeline_id_name listtype nonrec id_list = id listtype nonrec field = {ref_value : field_name_string option;The field value, expressed as the identifier of another object.
*)string_value : field_string_value option;The field value, expressed as a String.
*)key : field_name_string;The field identifier.
*)}A key-value pair that describes a property of a pipeline object. The value is specified as either a string value (StringValue) or a reference to another object (RefValue) but not as both.
type nonrec field_list = field listtype nonrec validation_warning = {warnings : validation_messages option;A description of the validation warning.
*)id : id option;The identifier of the object that contains the validation warning.
*)}Defines a validation warning. Validation warnings do not prevent pipeline activation. The set of validation warnings that can be returned are defined by AWS Data Pipeline.
type nonrec validation_warnings = validation_warning listtype nonrec validation_error = {errors : validation_messages option;A description of the validation error.
*)id : id option;The identifier of the object that contains the validation error.
*)}Defines a validation error. Validation errors prevent pipeline activation. The set of validation errors that can be returned are defined by AWS Data Pipeline.
type nonrec validation_errors = validation_error listtype nonrec validate_pipeline_definition_output = {errored : boolean_;Indicates whether there were validation errors.
*)validation_warnings : validation_warnings option;Any validation warnings that were found.
*)validation_errors : validation_errors option;Any validation errors that were found.
*)}Contains the output of ValidatePipelineDefinition.
type nonrec pipeline_object = {fields : field_list;Key-value pairs that define the properties of the object.
*)name : id;The name of the object.
*)id : id;The ID of the object.
*)}Contains information about a pipeline object. This can be a logical, physical, or physical attempt pipeline object. The complete set of components of a pipeline defines the pipeline.
type nonrec pipeline_object_list = pipeline_object listtype nonrec parameter_attribute = {string_value : attribute_value_string;The field value, expressed as a String.
*)key : attribute_name_string;The field identifier.
*)}The attributes allowed or specified with a parameter object.
type nonrec parameter_attribute_list = parameter_attribute listtype nonrec parameter_object = {attributes : parameter_attribute_list;The attributes of the parameter object.
*)id : field_name_string;The ID of the parameter object.
*)}Contains information about a parameter object.
type nonrec parameter_object_list = parameter_object listtype nonrec parameter_value = {string_value : field_string_value;The field value, expressed as a String.
*)id : field_name_string;The ID of the parameter value.
*)}A value or list of parameter values.
type nonrec parameter_value_list = parameter_value listtype nonrec validate_pipeline_definition_input = {parameter_values : parameter_value_list option;The parameter values used with the pipeline.
*)parameter_objects : parameter_object_list option;The parameter objects used with the pipeline.
*)pipeline_objects : pipeline_object_list;The objects that define the pipeline changes to validate against the pipeline.
*)pipeline_id : id;The ID of the pipeline.
*)}Contains the parameters for ValidatePipelineDefinition.
type nonrec pipeline_not_found_exception = {message : error_message option;Description of the error message.
*)}The specified pipeline was not found. Verify that you used the correct user and account identifiers.
type nonrec pipeline_deleted_exception = {message : error_message option;Description of the error message.
*)}The specified pipeline has been deleted.
type nonrec invalid_request_exception = {message : error_message option;Description of the error message.
*)}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.
type nonrec internal_service_error = {message : error_message option;Description of the error message.
*)}An internal service error occurred.
type nonrec pipeline_object_map = (id * pipeline_object) listtype nonrec task_object = {objects : pipeline_object_map option;Connection information for the location where the task runner will publish the output of the task.
*)attempt_id : id option;The ID of the pipeline task attempt object. AWS Data Pipeline uses this value to track how many times a task is attempted.
*)pipeline_id : id option;The ID of the pipeline that provided the task.
*)task_id : task_id option;An internal identifier for the task. This ID is passed to the SetTaskStatus and ReportTaskProgress actions.
}Contains information about a pipeline task that is assigned to a task runner.
type nonrec task_not_found_exception = {message : error_message option;Description of the error message.
*)}The specified task was not found.
type nonrec set_task_status_input = {error_stack_trace : string_ option;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.
*)error_message : error_message option;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_id : string_ option;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.
*)task_status : task_status;If FINISHED, the task successfully completed. If FAILED, the task ended unsuccessfully. Preconditions use false.
task_id : task_id;The ID of the task assigned to the task runner. This value is provided in the response for PollForTask.
}Contains the parameters for SetTaskStatus.
type nonrec set_status_input = {status : string_;The status to be set on all the objects specified in objectIds. For components, use PAUSE or RESUME. For instances, use TRY_CANCEL, RERUN, or MARK_FINISHED.
object_ids : id_list;The IDs of the objects. The corresponding objects can be either physical or components, but not a mix of both types.
*)pipeline_id : id;The ID of the pipeline that contains the objects.
*)}Contains the parameters for SetStatus.
type nonrec operator = {values : string_list option;The value that the actual field value will be compared with.
*)type_ : operator_type option;The logical operation to be performed: equal (EQ), equal reference (REF_EQ), less than or equal (LE), greater than or equal (GE), or between (BETWEEN). Equal reference (REF_EQ) can be used only with reference fields. The other comparison types can be used only with String fields. The comparison types you can use apply only to certain object fields, as detailed below.
The comparison operators EQ and REF_EQ act on the following fields:
The comparison operators GE, LE, and BETWEEN act on the following fields:
Note that fields beginning with the at sign (@) are read-only and set by the web service. When you name fields, you should choose names containing only alpha-numeric values, as symbols may be reserved by AWS Data Pipeline. User-defined fields that you add to a pipeline should prefix their name with the string "my".
*)}Contains a logical operation for comparing the value of a field with a specified value.
type nonrec selector = {operator : operator option;field_name : string_ option;The name of the field that the operator will be applied to. The field name is the "key" portion of the field definition in the pipeline definition syntax that is used by the AWS Data Pipeline API. If the field is not set on the object, the condition fails.
*)}A comparision that is used to determine whether a query should return this object.
type nonrec selector_list = selector listtype nonrec report_task_runner_heartbeat_output = {terminate : boolean_;Indicates whether the calling task runner should terminate.
*)}Contains the output of ReportTaskRunnerHeartbeat.
type nonrec report_task_runner_heartbeat_input = {hostname : id option;The public DNS name of the task runner.
*)worker_group : string_ option;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.
taskrunner_id : id;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.
*)}Contains the parameters for ReportTaskRunnerHeartbeat.
type nonrec report_task_progress_output = {canceled : boolean_;If true, the calling task runner should cancel processing of the task. The task runner does not need to call SetTaskStatus for canceled tasks.
}Contains the output of ReportTaskProgress.
type nonrec report_task_progress_input = {fields : field_list option;Key-value pairs that define the properties of the ReportTaskProgressInput object.
*)task_id : task_id;The ID of the task assigned to the task runner. This value is provided in the response for PollForTask.
}Contains the parameters for ReportTaskProgress.
type nonrec query_objects_output = {has_more_results : boolean_ option;Indicates whether there are more results that can be obtained by a subsequent call.
*)marker : string_ option;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.
ids : id_list option;The identifiers that match the query selectors.
*)}Contains the output of QueryObjects.
type nonrec query = {selectors : selector_list option;List of selectors that define the query. An object must satisfy all of the selectors to match the query.
*)}Defines the query to run against an object.
type nonrec query_objects_input = {limit : int_ option;The maximum number of object names that QueryObjects will return in a single call. The default value is 100.
marker : string_ option;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.
sphere : string_;Indicates whether the query applies to components or instances. The possible values are: COMPONENT, INSTANCE, and ATTEMPT.
query : query option;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.
pipeline_id : id;The ID of the pipeline.
*)}Contains the parameters for QueryObjects.
type nonrec put_pipeline_definition_output = {errored : boolean_;Indicates whether there were validation errors, and the pipeline definition is stored but cannot be activated until you correct the pipeline and call PutPipelineDefinition to commit the corrected pipeline.
validation_warnings : validation_warnings option;The validation warnings that are associated with the objects defined in pipelineObjects.
validation_errors : validation_errors option;The validation errors that are associated with the objects defined in pipelineObjects.
}Contains the output of PutPipelineDefinition.
type nonrec put_pipeline_definition_input = {parameter_values : parameter_value_list option;The parameter values used with the pipeline.
*)parameter_objects : parameter_object_list option;The parameter objects used with the pipeline.
*)pipeline_objects : pipeline_object_list;The objects that define the pipeline. These objects overwrite the existing pipeline definition.
*)pipeline_id : id;The ID of the pipeline.
*)}Contains the parameters for PutPipelineDefinition.
type nonrec poll_for_task_output = {task_object : task_object option;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.
}Contains the output of PollForTask.
type nonrec instance_identity = {signature : string_ option;A signature which can be used to verify the accuracy and authenticity of the information provided in the instance identity document.
*)document : string_ option;A description of an EC2 instance that is generated when the instance is launched and exposed to the instance via the instance metadata service in the form of a JSON representation of an object.
*)}Identity information for the EC2 instance that is hosting the task runner. You can get this value by calling a metadata URI from the EC2 instance. 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.
type nonrec poll_for_task_input = {instance_identity : instance_identity option;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.
hostname : id option;The public DNS name of the calling task runner.
*)worker_group : 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.
}Contains the parameters for PollForTask.
type nonrec pipeline_description = {description : string_ option;Description of the pipeline.
*)fields : field_list;A list of read-only fields that contain metadata about the pipeline: @userId, @accountId, and @pipelineState.
*)name : id;The name of the pipeline.
*)pipeline_id : id;The pipeline identifier that was assigned by AWS Data Pipeline. This is a string of the form df-297EG78HU43EEXAMPLE.
}Contains pipeline metadata.
type nonrec pipeline_description_list = pipeline_description listtype nonrec list_pipelines_output = {has_more_results : boolean_ option;Indicates whether there are more results that can be obtained by a subsequent call.
*)marker : string_ option;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.
pipeline_id_list : pipeline_list;The pipeline identifiers. If you require additional information about the pipelines, you can use these identifiers to call DescribePipelines and GetPipelineDefinition.
}Contains the output of ListPipelines.
type nonrec list_pipelines_input = {marker : string_ option;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.
}Contains the parameters for ListPipelines.
type nonrec get_pipeline_definition_output = {parameter_values : parameter_value_list option;The parameter values used in the pipeline definition.
*)parameter_objects : parameter_object_list option;The parameter objects used in the pipeline definition.
*)pipeline_objects : pipeline_object_list option;The objects defined in the pipeline.
*)}Contains the output of GetPipelineDefinition.
type nonrec get_pipeline_definition_input = {version : string_ option;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.
pipeline_id : id;The ID of the pipeline.
*)}Contains the parameters for GetPipelineDefinition.
type nonrec evaluate_expression_output = {evaluated_expression : long_string;The evaluated expression.
*)}Contains the output of EvaluateExpression.
type nonrec evaluate_expression_input = {expression : long_string;The expression to evaluate.
*)object_id : id;The ID of the object.
*)pipeline_id : id;The ID of the pipeline.
*)}Contains the parameters for EvaluateExpression.
type nonrec describe_pipelines_output = {pipeline_description_list : pipeline_description_list;An array of descriptions for the specified pipelines.
*)}Contains the output of DescribePipelines.
type nonrec describe_pipelines_input = {pipeline_ids : id_list;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.
}Contains the parameters for DescribePipelines.
type nonrec describe_objects_output = {has_more_results : boolean_ option;Indicates whether there are more results to return.
*)marker : string_ option;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.
pipeline_objects : pipeline_object_list;An array of object definitions.
*)}Contains the output of DescribeObjects.
type nonrec describe_objects_input = {marker : string_ option;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.
evaluate_expressions : boolean_ option;Indicates whether any expressions in the object should be evaluated when the object descriptions are returned.
*)object_ids : id_list;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.
pipeline_id : id;The ID of the pipeline that contains the object definitions.
*)}Contains the parameters for DescribeObjects.
Contains the parameters for DeletePipeline.
type nonrec deactivate_pipeline_input = {cancel_active : cancel_active option;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.
pipeline_id : id;The ID of the pipeline.
*)}Contains the parameters for DeactivatePipeline.
type nonrec create_pipeline_output = {pipeline_id : id;The ID that AWS Data Pipeline assigns the newly created pipeline. For example, df-06372391ZG65EXAMPLE.
}Contains the output of CreatePipeline.
type nonrec create_pipeline_input = {description : string_ option;The description for the pipeline.
*)unique_id : id;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.
name : id;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.
*)}Contains the parameters for CreatePipeline.
type nonrec activate_pipeline_input = {start_timestamp : timestamp option;The date and time to resume the pipeline. By default, the pipeline resumes from the last completed execution.
*)parameter_values : parameter_value_list option;A list of parameter values to pass to the pipeline at activation.
*)pipeline_id : id;The ID of the pipeline.
*)}Contains the parameters for ActivatePipeline.