Serialized Form

Package com.amazonaws.services.datapipeline.model

Class com.amazonaws.services.datapipeline.model.ActivatePipelineRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

pipelineId

String pipelineId

The ID of the pipeline.

Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

parameterValues

com.amazonaws.internal.ListWithAutoConstructFlag<T> parameterValues

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

startTimestamp

Date startTimestamp

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

Class com.amazonaws.services.datapipeline.model.ActivatePipelineResult extends Object implements Serializable

Class com.amazonaws.services.datapipeline.model.AddTagsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

pipelineId

String pipelineId

The ID of the pipeline.

Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

tags

com.amazonaws.internal.ListWithAutoConstructFlag<T> tags

The tags to add, as key/value pairs.

Constraints:
Length: 0 - 10

Class com.amazonaws.services.datapipeline.model.AddTagsResult extends Object implements Serializable

Class com.amazonaws.services.datapipeline.model.CreatePipelineRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

name

String name

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.

Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

uniqueId

String uniqueId

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.

Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

description

String description

The description for the pipeline.

Constraints:
Length: 0 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

tags

com.amazonaws.internal.ListWithAutoConstructFlag<T> tags

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.

Constraints:
Length: 0 - 10

Class com.amazonaws.services.datapipeline.model.CreatePipelineResult extends Object implements Serializable

Serialized Fields

pipelineId

String pipelineId

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

Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Class com.amazonaws.services.datapipeline.model.DeactivatePipelineRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

pipelineId

String pipelineId

The ID of the pipeline.

Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

cancelActive

Boolean cancelActive

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.

Class com.amazonaws.services.datapipeline.model.DeactivatePipelineResult extends Object implements Serializable

Class com.amazonaws.services.datapipeline.model.DeletePipelineRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

pipelineId

String pipelineId

The ID of the pipeline.

Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Class com.amazonaws.services.datapipeline.model.DescribeObjectsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

pipelineId

String pipelineId

The ID of the pipeline that contains the object definitions.

Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

objectIds

com.amazonaws.internal.ListWithAutoConstructFlag<T> objectIds

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.

evaluateExpressions

Boolean evaluateExpressions

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

marker

String marker

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.

Constraints:
Length: 0 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Class com.amazonaws.services.datapipeline.model.DescribeObjectsResult extends Object implements Serializable

Serialized Fields

pipelineObjects

com.amazonaws.internal.ListWithAutoConstructFlag<T> pipelineObjects

An array of object definitions.

marker

String marker

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.

Constraints:
Length: 0 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

hasMoreResults

Boolean hasMoreResults

Indicates whether there are more results to return.

Class com.amazonaws.services.datapipeline.model.DescribePipelinesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

pipelineIds

com.amazonaws.internal.ListWithAutoConstructFlag<T> pipelineIds

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.

Class com.amazonaws.services.datapipeline.model.DescribePipelinesResult extends Object implements Serializable

Serialized Fields

pipelineDescriptionList

com.amazonaws.internal.ListWithAutoConstructFlag<T> pipelineDescriptionList

An array of descriptions for the specified pipelines.

Class com.amazonaws.services.datapipeline.model.EvaluateExpressionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

pipelineId

String pipelineId

The ID of the pipeline.

Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

objectId

String objectId

The ID of the object.

Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

expression

String expression

The expression to evaluate.

Constraints:
Length: 0 - 20971520
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Class com.amazonaws.services.datapipeline.model.EvaluateExpressionResult extends Object implements Serializable

Serialized Fields

evaluatedExpression

String evaluatedExpression

The evaluated expression.

Constraints:
Length: 0 - 20971520
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Class com.amazonaws.services.datapipeline.model.Field extends Object implements Serializable

Serialized Fields

key

String key

The field identifier.

Constraints:
Length: 1 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

stringValue

String stringValue

The field value, expressed as a String.

Constraints:
Length: 0 - 10240
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

refValue

String refValue

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

Constraints:
Length: 1 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Class com.amazonaws.services.datapipeline.model.GetPipelineDefinitionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

pipelineId

String pipelineId

The ID of the pipeline.

Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

version

String version

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.

Constraints:
Length: 0 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Class com.amazonaws.services.datapipeline.model.GetPipelineDefinitionResult extends Object implements Serializable

Serialized Fields

pipelineObjects

com.amazonaws.internal.ListWithAutoConstructFlag<T> pipelineObjects

The objects defined in the pipeline.

parameterObjects

com.amazonaws.internal.ListWithAutoConstructFlag<T> parameterObjects

The parameter objects used in the pipeline definition.

parameterValues

com.amazonaws.internal.ListWithAutoConstructFlag<T> parameterValues

The parameter values used in the pipeline definition.

Class com.amazonaws.services.datapipeline.model.InstanceIdentity extends Object implements Serializable

Serialized Fields

document

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

Constraints:
Length: 0 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

signature

String signature

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

Constraints:
Length: 0 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Class com.amazonaws.services.datapipeline.model.InternalServiceErrorException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.datapipeline.model.InvalidRequestException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.datapipeline.model.ListPipelinesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

marker

String marker

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.

Constraints:
Length: 0 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Class com.amazonaws.services.datapipeline.model.ListPipelinesResult extends Object implements Serializable

Serialized Fields

pipelineIdList

com.amazonaws.internal.ListWithAutoConstructFlag<T> pipelineIdList

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

marker

String marker

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.

Constraints:
Length: 0 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

hasMoreResults

Boolean hasMoreResults

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

Class com.amazonaws.services.datapipeline.model.Operator extends Object implements Serializable

Serialized Fields

type

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

Constraints:
Allowed Values: EQ, REF_EQ, LE, GE, BETWEEN

values

com.amazonaws.internal.ListWithAutoConstructFlag<T> values

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

Class com.amazonaws.services.datapipeline.model.ParameterAttribute extends Object implements Serializable

Serialized Fields

key

String key

The field identifier.

Constraints:
Length: 1 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

stringValue

String stringValue

The field value, expressed as a String.

Constraints:
Length: 0 - 10240
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Class com.amazonaws.services.datapipeline.model.ParameterObject extends Object implements Serializable

Serialized Fields

id

String id

The ID of the parameter object.

Constraints:
Length: 1 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

attributes

com.amazonaws.internal.ListWithAutoConstructFlag<T> attributes

The attributes of the parameter object.

Class com.amazonaws.services.datapipeline.model.ParameterValue extends Object implements Serializable

Serialized Fields

id

String id

The ID of the parameter value.

Constraints:
Length: 1 - 256
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

stringValue

String stringValue

The field value, expressed as a String.

Constraints:
Length: 0 - 10240
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Class com.amazonaws.services.datapipeline.model.PipelineDeletedException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.datapipeline.model.PipelineDescription extends Object implements Serializable

Serialized Fields

pipelineId

String pipelineId

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

Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

name

String name

The name of the pipeline.

Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

fields

com.amazonaws.internal.ListWithAutoConstructFlag<T> fields

A list of read-only fields that contain metadata about the pipeline:

description

String description

Description of the pipeline.

Constraints:
Length: 0 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

tags

com.amazonaws.internal.ListWithAutoConstructFlag<T> 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.

Constraints:
Length: 0 - 10

Class com.amazonaws.services.datapipeline.model.PipelineIdName extends Object implements Serializable

Serialized Fields

id

String id

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

Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

name

String name

The name of the pipeline.

Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Class com.amazonaws.services.datapipeline.model.PipelineNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.datapipeline.model.PipelineObject extends Object implements Serializable

Serialized Fields

id

String id

The ID of the object.

Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

name

String name

The name of the object.

Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

fields

com.amazonaws.internal.ListWithAutoConstructFlag<T> fields

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

Class com.amazonaws.services.datapipeline.model.PollForTaskRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

workerGroup

String workerGroup

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.

Constraints:
Length: 0 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

hostname

String hostname

The public DNS name of the calling task runner.

Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

instanceIdentity

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

Class com.amazonaws.services.datapipeline.model.PollForTaskResult extends Object implements Serializable

Serialized Fields

taskObject

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

Class com.amazonaws.services.datapipeline.model.PutPipelineDefinitionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

pipelineId

String pipelineId

The ID of the pipeline.

Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

pipelineObjects

com.amazonaws.internal.ListWithAutoConstructFlag<T> pipelineObjects

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

parameterObjects

com.amazonaws.internal.ListWithAutoConstructFlag<T> parameterObjects

The parameter objects used with the pipeline.

parameterValues

com.amazonaws.internal.ListWithAutoConstructFlag<T> parameterValues

The parameter values used with the pipeline.

Class com.amazonaws.services.datapipeline.model.PutPipelineDefinitionResult extends Object implements Serializable

Serialized Fields

validationErrors

com.amazonaws.internal.ListWithAutoConstructFlag<T> validationErrors

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

validationWarnings

com.amazonaws.internal.ListWithAutoConstructFlag<T> validationWarnings

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

errored

Boolean errored

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.

Class com.amazonaws.services.datapipeline.model.Query extends Object implements Serializable

Serialized Fields

selectors

com.amazonaws.internal.ListWithAutoConstructFlag<T> selectors

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

Class com.amazonaws.services.datapipeline.model.QueryObjectsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

pipelineId

String pipelineId

The ID of the pipeline.

Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

query

Query 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

String sphere

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

Constraints:
Length: 0 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

marker

String marker

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.

Constraints:
Length: 0 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

limit

Integer limit

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

Class com.amazonaws.services.datapipeline.model.QueryObjectsResult extends Object implements Serializable

Serialized Fields

ids

com.amazonaws.internal.ListWithAutoConstructFlag<T> ids

The identifiers that match the query selectors.

marker

String marker

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.

Constraints:
Length: 0 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

hasMoreResults

Boolean hasMoreResults

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

Class com.amazonaws.services.datapipeline.model.RemoveTagsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

pipelineId

String pipelineId

The ID of the pipeline.

Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

tagKeys

com.amazonaws.internal.ListWithAutoConstructFlag<T> tagKeys

The keys of the tags to remove.

Class com.amazonaws.services.datapipeline.model.RemoveTagsResult extends Object implements Serializable

Class com.amazonaws.services.datapipeline.model.ReportTaskProgressRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

taskId

String taskId

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

Constraints:
Length: 1 - 2048
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

fields

com.amazonaws.internal.ListWithAutoConstructFlag<T> fields

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

Class com.amazonaws.services.datapipeline.model.ReportTaskProgressResult extends Object implements Serializable

Serialized Fields

canceled

Boolean canceled

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

Class com.amazonaws.services.datapipeline.model.ReportTaskRunnerHeartbeatRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

taskrunnerId

String taskrunnerId

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.

Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

workerGroup

String workerGroup

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.

Constraints:
Length: 0 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

hostname

String hostname

The public DNS name of the task runner.

Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Class com.amazonaws.services.datapipeline.model.ReportTaskRunnerHeartbeatResult extends Object implements Serializable

Serialized Fields

terminate

Boolean terminate

Indicates whether the calling task runner should terminate.

Class com.amazonaws.services.datapipeline.model.Selector extends Object implements Serializable

Serialized Fields

fieldName

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

Constraints:
Length: 0 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

operator

Operator operator

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

Class com.amazonaws.services.datapipeline.model.SetStatusRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

pipelineId

String pipelineId

The ID of the pipeline that contains the objects.

Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

objectIds

com.amazonaws.internal.ListWithAutoConstructFlag<T> objectIds

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

status

String status

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.

Constraints:
Length: 0 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Class com.amazonaws.services.datapipeline.model.SetTaskStatusRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

taskId

String taskId

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

Constraints:
Length: 1 - 2048
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

taskStatus

String taskStatus

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

Constraints:
Allowed Values: FINISHED, FAILED, FALSE

errorId

String errorId

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.

Constraints:
Length: 0 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

errorMessage

String errorMessage

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.

errorStackTrace

String errorStackTrace

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.

Constraints:
Length: 0 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Class com.amazonaws.services.datapipeline.model.SetTaskStatusResult extends Object implements Serializable

Class com.amazonaws.services.datapipeline.model.Tag extends Object implements Serializable

Serialized Fields

key

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

Constraints:
Length: 1 - 128

value

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

Constraints:
Length: 0 - 256

Class com.amazonaws.services.datapipeline.model.TaskNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.datapipeline.model.TaskObject extends Object implements Serializable

Serialized Fields

taskId

String taskId

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

Constraints:
Length: 1 - 2048
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

pipelineId

String pipelineId

The ID of the pipeline that provided the task.

Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

attemptId

String attemptId

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

Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

objects

Map<K,V> objects

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

Class com.amazonaws.services.datapipeline.model.ValidatePipelineDefinitionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

pipelineId

String pipelineId

The ID of the pipeline.

Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

pipelineObjects

com.amazonaws.internal.ListWithAutoConstructFlag<T> pipelineObjects

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

parameterObjects

com.amazonaws.internal.ListWithAutoConstructFlag<T> parameterObjects

The parameter objects used with the pipeline.

parameterValues

com.amazonaws.internal.ListWithAutoConstructFlag<T> parameterValues

The parameter values used with the pipeline.

Class com.amazonaws.services.datapipeline.model.ValidatePipelineDefinitionResult extends Object implements Serializable

Serialized Fields

validationErrors

com.amazonaws.internal.ListWithAutoConstructFlag<T> validationErrors

Any validation errors that were found.

validationWarnings

com.amazonaws.internal.ListWithAutoConstructFlag<T> validationWarnings

Any validation warnings that were found.

errored

Boolean errored

Indicates whether there were validation errors.

Class com.amazonaws.services.datapipeline.model.ValidationError extends Object implements Serializable

Serialized Fields

id

String id

The identifier of the object that contains the validation error.

Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

errors

com.amazonaws.internal.ListWithAutoConstructFlag<T> errors

A description of the validation error.

Class com.amazonaws.services.datapipeline.model.ValidationWarning extends Object implements Serializable

Serialized Fields

id

String id

The identifier of the object that contains the validation warning.

Constraints:
Length: 1 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

warnings

com.amazonaws.internal.ListWithAutoConstructFlag<T> warnings

A description of the validation warning.