libZSservicesZSamazonka-datapipelineZSamazonka-datapipeline
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.DataPipeline.Lens

Description

 
Synopsis

Operations

DescribePipelines

describePipelines_pipelineIds :: Lens' DescribePipelines [Text] Source #

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.

QueryObjects

queryObjects_query :: Lens' QueryObjects (Maybe Query) Source #

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.

queryObjects_marker :: Lens' QueryObjects (Maybe Text) Source #

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.

queryObjects_limit :: Lens' QueryObjects (Maybe Int) Source #

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

queryObjects_sphere :: Lens' QueryObjects Text Source #

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

queryObjectsResponse_hasMoreResults :: Lens' QueryObjectsResponse (Maybe Bool) Source #

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

queryObjectsResponse_ids :: Lens' QueryObjectsResponse (Maybe [Text]) Source #

The identifiers that match the query selectors.

queryObjectsResponse_marker :: Lens' QueryObjectsResponse (Maybe Text) Source #

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.

RemoveTags

removeTags_tagKeys :: Lens' RemoveTags [Text] Source #

The keys of the tags to remove.

DeletePipeline

ListPipelines

listPipelines_marker :: Lens' ListPipelines (Maybe Text) Source #

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.

listPipelinesResponse_hasMoreResults :: Lens' ListPipelinesResponse (Maybe Bool) Source #

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

listPipelinesResponse_marker :: Lens' ListPipelinesResponse (Maybe Text) Source #

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.

listPipelinesResponse_pipelineIdList :: Lens' ListPipelinesResponse [PipelineIdName] Source #

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

EvaluateExpression

GetPipelineDefinition

getPipelineDefinition_version :: Lens' GetPipelineDefinition (Maybe Text) Source #

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.

PollForTask

pollForTask_hostname :: Lens' PollForTask (Maybe Text) Source #

The public DNS name of the calling task runner.

pollForTask_instanceIdentity :: Lens' PollForTask (Maybe InstanceIdentity) Source #

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.

pollForTask_workerGroup :: Lens' PollForTask Text Source #

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.

pollForTaskResponse_taskObject :: Lens' PollForTaskResponse (Maybe TaskObject) Source #

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.

DeactivatePipeline

deactivatePipeline_cancelActive :: Lens' DeactivatePipeline (Maybe Bool) Source #

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.

AddTags

addTags_pipelineId :: Lens' AddTags Text Source #

The ID of the pipeline.

addTags_tags :: Lens' AddTags [Tag] Source #

The tags to add, as key/value pairs.

addTagsResponse_httpStatus :: Lens' AddTagsResponse Int Source #

The response's http status code.

DescribeObjects

describeObjects_evaluateExpressions :: Lens' DescribeObjects (Maybe Bool) Source #

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

describeObjects_marker :: Lens' DescribeObjects (Maybe Text) Source #

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.

describeObjects_pipelineId :: Lens' DescribeObjects Text Source #

The ID of the pipeline that contains the object definitions.

describeObjects_objectIds :: Lens' DescribeObjects [Text] Source #

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.

describeObjectsResponse_hasMoreResults :: Lens' DescribeObjectsResponse (Maybe Bool) Source #

Indicates whether there are more results to return.

describeObjectsResponse_marker :: Lens' DescribeObjectsResponse (Maybe Text) Source #

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.

ReportTaskRunnerHeartbeat

reportTaskRunnerHeartbeat_workerGroup :: Lens' ReportTaskRunnerHeartbeat (Maybe Text) Source #

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.

reportTaskRunnerHeartbeat_taskrunnerId :: Lens' ReportTaskRunnerHeartbeat Text Source #

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.

reportTaskRunnerHeartbeatResponse_terminate :: Lens' ReportTaskRunnerHeartbeatResponse Bool Source #

Indicates whether the calling task runner should terminate.

ActivatePipeline

activatePipeline_startTimestamp :: Lens' ActivatePipeline (Maybe UTCTime) Source #

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

activatePipeline_parameterValues :: Lens' ActivatePipeline (Maybe [ParameterValue]) Source #

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

SetTaskStatus

setTaskStatus_errorStackTrace :: Lens' SetTaskStatus (Maybe Text) Source #

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.

setTaskStatus_errorId :: Lens' SetTaskStatus (Maybe Text) Source #

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.

setTaskStatus_errorMessage :: Lens' SetTaskStatus (Maybe Text) Source #

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.

setTaskStatus_taskId :: Lens' SetTaskStatus Text Source #

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

setTaskStatus_taskStatus :: Lens' SetTaskStatus TaskStatus Source #

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

SetStatus

setStatus_pipelineId :: Lens' SetStatus Text Source #

The ID of the pipeline that contains the objects.

setStatus_objectIds :: Lens' SetStatus [Text] Source #

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

setStatus_status :: Lens' SetStatus Text Source #

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.

ReportTaskProgress

reportTaskProgress_fields :: Lens' ReportTaskProgress (Maybe [Field]) Source #

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

reportTaskProgress_taskId :: Lens' ReportTaskProgress Text Source #

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

reportTaskProgressResponse_canceled :: Lens' ReportTaskProgressResponse Bool Source #

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

CreatePipeline

createPipeline_description :: Lens' CreatePipeline (Maybe Text) Source #

The description for the pipeline.

createPipeline_tags :: Lens' CreatePipeline (Maybe [Tag]) Source #

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.

createPipeline_name :: Lens' CreatePipeline Text Source #

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.

createPipeline_uniqueId :: Lens' CreatePipeline Text Source #

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.

createPipelineResponse_pipelineId :: Lens' CreatePipelineResponse Text Source #

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

PutPipelineDefinition

putPipelineDefinition_pipelineObjects :: Lens' PutPipelineDefinition [PipelineObject] Source #

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

putPipelineDefinitionResponse_validationErrors :: Lens' PutPipelineDefinitionResponse (Maybe [ValidationError]) Source #

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

putPipelineDefinitionResponse_validationWarnings :: Lens' PutPipelineDefinitionResponse (Maybe [ValidationWarning]) Source #

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

putPipelineDefinitionResponse_errored :: Lens' PutPipelineDefinitionResponse Bool Source #

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.

ValidatePipelineDefinition

validatePipelineDefinition_pipelineObjects :: Lens' ValidatePipelineDefinition [PipelineObject] Source #

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

Types

Field

field_refValue :: Lens' Field (Maybe Text) Source #

The field value, expressed as the identifier of another object.

field_stringValue :: Lens' Field (Maybe Text) Source #

The field value, expressed as a String.

field_key :: Lens' Field Text Source #

The field identifier.

InstanceIdentity

instanceIdentity_signature :: Lens' InstanceIdentity (Maybe Text) Source #

A signature which can be used to verify the accuracy and authenticity of the information provided in the instance identity document.

instanceIdentity_document :: Lens' InstanceIdentity (Maybe Text) Source #

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.

Operator

operator_values :: Lens' Operator (Maybe [Text]) Source #

The value that the actual field value will be compared with.

operator_type :: Lens' Operator (Maybe OperatorType) Source #

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:

  • name
  • @sphere
  • parent
  • @componentParent
  • @instanceParent
  • @status
  • @scheduledStartTime
  • @scheduledEndTime
  • @actualStartTime
  • @actualEndTime

The comparison operators GE, LE, and BETWEEN act on the following fields:

  • @scheduledStartTime
  • @scheduledEndTime
  • @actualStartTime
  • @actualEndTime

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".

ParameterAttribute

parameterAttribute_stringValue :: Lens' ParameterAttribute Text Source #

The field value, expressed as a String.

ParameterObject

parameterObject_id :: Lens' ParameterObject Text Source #

The ID of the parameter object.

parameterObject_attributes :: Lens' ParameterObject [ParameterAttribute] Source #

The attributes of the parameter object.

ParameterValue

parameterValue_id :: Lens' ParameterValue Text Source #

The ID of the parameter value.

parameterValue_stringValue :: Lens' ParameterValue Text Source #

The field value, expressed as a String.

PipelineDescription

pipelineDescription_tags :: Lens' PipelineDescription (Maybe [Tag]) Source #

A list of tags to associated with a pipeline. Tags let you control access to pipelines. For more information, see Controlling User Access to Pipelines in the AWS Data Pipeline Developer Guide.

pipelineDescription_pipelineId :: Lens' PipelineDescription Text Source #

The pipeline identifier that was assigned by AWS Data Pipeline. This is a string of the form df-297EG78HU43EEXAMPLE.

pipelineDescription_fields :: Lens' PipelineDescription [Field] Source #

A list of read-only fields that contain metadata about the pipeline: @userId, @accountId, and @pipelineState.

PipelineIdName

pipelineIdName_name :: Lens' PipelineIdName (Maybe Text) Source #

The name of the pipeline.

pipelineIdName_id :: Lens' PipelineIdName (Maybe Text) Source #

The ID of the pipeline that was assigned by AWS Data Pipeline. This is a string of the form df-297EG78HU43EEXAMPLE.

PipelineObject

pipelineObject_fields :: Lens' PipelineObject [Field] Source #

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

Query

query_selectors :: Lens' Query (Maybe [Selector]) Source #

List of selectors that define the query. An object must satisfy all of the selectors to match the query.

Selector

selector_fieldName :: Lens' Selector (Maybe Text) Source #

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.

Tag

tag_key :: Lens' Tag Text Source #

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.

tag_value :: Lens' Tag Text Source #

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.

TaskObject

taskObject_pipelineId :: Lens' TaskObject (Maybe Text) Source #

The ID of the pipeline that provided the task.

taskObject_attemptId :: Lens' TaskObject (Maybe Text) Source #

The ID of the pipeline task attempt object. AWS Data Pipeline uses this value to track how many times a task is attempted.

taskObject_taskId :: Lens' TaskObject (Maybe Text) Source #

An internal identifier for the task. This ID is passed to the SetTaskStatus and ReportTaskProgress actions.

taskObject_objects :: Lens' TaskObject (Maybe (HashMap Text PipelineObject)) Source #

Connection information for the location where the task runner will publish the output of the task.

ValidationError

validationError_id :: Lens' ValidationError (Maybe Text) Source #

The identifier of the object that contains the validation error.

validationError_errors :: Lens' ValidationError (Maybe [Text]) Source #

A description of the validation error.

ValidationWarning

validationWarning_warnings :: Lens' ValidationWarning (Maybe [Text]) Source #

A description of the validation warning.

validationWarning_id :: Lens' ValidationWarning (Maybe Text) Source #

The identifier of the object that contains the validation warning.