API version 2012-10-29 of the Amazon Data Pipeline SDK configuration.

An internal service error occurred.

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.

The specified pipeline has been deleted.

The specified pipeline was not found. Verify that you used the correct user and account identifiers.

The specified task was not found.

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.

See: newField smart constructor.

Create a value of Field with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:refValue:Field', field_refValue - The field value, expressed as the identifier of another object.

$sel:stringValue:Field', field_stringValue - The field value, expressed as a String.

$sel:key:Field', field_key - The field identifier.

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

The field value, expressed as a String.

The field identifier.

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.

See: newInstanceIdentity smart constructor.

Create a value of InstanceIdentity with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:document:InstanceIdentity', instanceIdentity_document - 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.

$sel:signature:InstanceIdentity', instanceIdentity_signature - A signature which can be used to verify the accuracy and authenticity of the information provided in the instance identity document.

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.

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

Contains a logical operation for comparing the value of a field with a specified value.

See: newOperator smart constructor.

Create a value of Operator with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:type':Operator', operator_type - 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".

$sel:values:Operator', operator_values - The value that the actual field value will be compared with.

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

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

The attributes allowed or specified with a parameter object.

See: newParameterAttribute smart constructor.

Create a value of ParameterAttribute with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:key:ParameterAttribute', parameterAttribute_key - The field identifier.

$sel:stringValue:ParameterAttribute', parameterAttribute_stringValue - The field value, expressed as a String.

The field identifier.

The field value, expressed as a String.

Contains information about a parameter object.

See: newParameterObject smart constructor.

Create a value of ParameterObject with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:id:ParameterObject', parameterObject_id - The ID of the parameter object.

$sel:attributes:ParameterObject', parameterObject_attributes - The attributes of the parameter object.

The ID of the parameter object.

The attributes of the parameter object.

A value or list of parameter values.

See: newParameterValue smart constructor.

Create a value of ParameterValue with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:id:ParameterValue', parameterValue_id - The ID of the parameter value.

$sel:stringValue:ParameterValue', parameterValue_stringValue - The field value, expressed as a String.

The ID of the parameter value.

The field value, expressed as a String.

Contains pipeline metadata.

See: newPipelineDescription smart constructor.

Create a value of PipelineDescription with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:description:PipelineDescription', pipelineDescription_description - Description of the pipeline.

$sel:tags:PipelineDescription', pipelineDescription_tags - 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.

$sel:pipelineId:PipelineDescription', pipelineDescription_pipelineId - The pipeline identifier that was assigned by AWS Data Pipeline. This is a string of the form df-297EG78HU43EEXAMPLE.

$sel:name:PipelineDescription', pipelineDescription_name - The name of the pipeline.

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

Description of the pipeline.

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.

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

The name of the pipeline.

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

Contains the name and identifier of a pipeline.

See: newPipelineIdName smart constructor.

Create a value of PipelineIdName with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:id:PipelineIdName', pipelineIdName_id - The ID of the pipeline that was assigned by AWS Data Pipeline. This is a string of the form df-297EG78HU43EEXAMPLE.

$sel:name:PipelineIdName', pipelineIdName_name - The name of the pipeline.

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

The name of the pipeline.

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.

See: newPipelineObject smart constructor.

Create a value of PipelineObject with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:id:PipelineObject', pipelineObject_id - The ID of the object.

$sel:name:PipelineObject', pipelineObject_name - The name of the object.

$sel:fields:PipelineObject', pipelineObject_fields - Key-value pairs that define the properties of the object.

The ID of the object.

The name of the object.

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

Defines the query to run against an object.

See: newQuery smart constructor.

Create a value of Query with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:selectors:Query', query_selectors - List of selectors that define the query. An object must satisfy all of the selectors to match the query.

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

A comparision that is used to determine whether a query should return this object.

See: newSelector smart constructor.

Create a value of Selector with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:fieldName:Selector', selector_fieldName - 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.

$sel:operator:Selector', selector_operator - Undocumented member.

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.

Undocumented member.

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.

See: newTag smart constructor.

Create a value of Tag with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:key:Tag', 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.

$sel:value:Tag', 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.

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.

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.

Contains information about a pipeline task that is assigned to a task runner.

See: newTaskObject smart constructor.

Create a value of TaskObject with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:attemptId:TaskObject', taskObject_attemptId - The ID of the pipeline task attempt object. AWS Data Pipeline uses this value to track how many times a task is attempted.

$sel:objects:TaskObject', taskObject_objects - Connection information for the location where the task runner will publish the output of the task.

$sel:pipelineId:TaskObject', taskObject_pipelineId - The ID of the pipeline that provided the task.

$sel:taskId:TaskObject', taskObject_taskId - An internal identifier for the task. This ID is passed to the SetTaskStatus and ReportTaskProgress actions.

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

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

The ID of the pipeline that provided the task.

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

Defines a validation error. Validation errors prevent pipeline activation. The set of validation errors that can be returned are defined by AWS Data Pipeline.

See: newValidationError smart constructor.

Create a value of ValidationError with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:errors:ValidationError', validationError_errors - A description of the validation error.

$sel:id:ValidationError', validationError_id - The identifier of the object that contains the validation error.

A description of the validation error.

The identifier of the object that contains the validation error.

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.

See: newValidationWarning smart constructor.

Create a value of ValidationWarning with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:id:ValidationWarning', validationWarning_id - The identifier of the object that contains the validation warning.

$sel:warnings:ValidationWarning', validationWarning_warnings - A description of the validation warning.

The identifier of the object that contains the validation warning.

A description of the validation warning.