String pipelineId
The ID of the pipeline.
SdkInternalList<T> parameterValues
A list of parameter values to pass to the pipeline at activation.
Date startTimestamp
The date and time to resume the pipeline. By default, the pipeline resumes from the last completed execution.
String pipelineId
The ID of the pipeline.
SdkInternalList<T> tags
The tags to add, as key/value pairs.
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.
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.
String description
The description for the pipeline.
SdkInternalList<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.
String pipelineId
The ID that AWS Data Pipeline assigns the newly created pipeline. For example,
df-06372391ZG65EXAMPLE
.
String pipelineId
The ID of the pipeline.
String pipelineId
The ID of the pipeline that contains the object definitions.
SdkInternalList<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
.
Boolean evaluateExpressions
Indicates whether any expressions in the object should be evaluated when the object descriptions are returned.
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.
SdkInternalList<T> pipelineObjects
An array of object definitions.
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.
Boolean hasMoreResults
Indicates whether there are more results to return.
SdkInternalList<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.
SdkInternalList<T> pipelineDescriptionList
An array of descriptions for the specified pipelines.
String evaluatedExpression
The evaluated expression.
SdkInternalList<T> pipelineObjects
The objects defined in the pipeline.
SdkInternalList<T> parameterObjects
The parameter objects used in the pipeline definition.
SdkInternalList<T> parameterValues
The parameter values used in the pipeline definition.
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.
String signature
A signature which can be used to verify the accuracy and authenticity of the information provided in the instance identity document.
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.
SdkInternalList<T> pipelineIdList
The pipeline identifiers. If you require additional information about the pipelines, you can use these identifiers to call DescribePipelines and GetPipelineDefinition.
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.
Boolean hasMoreResults
Indicates whether there are more results that can be obtained by a subsequent call.
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:
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".
SdkInternalList<T> values
The value that the actual field value will be compared with.
String id
The ID of the parameter object.
SdkInternalList<T> attributes
The attributes of the parameter object.
String pipelineId
The pipeline identifier that was assigned by AWS Data Pipeline. This is a string of the form
df-297EG78HU43EEXAMPLE
.
String name
The name of the pipeline.
SdkInternalList<T> fields
A list of read-only fields that contain metadata about the pipeline: @userId, @accountId, and @pipelineState.
String description
Description of the pipeline.
SdkInternalList<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.
String id
The ID of the object.
String name
The name of the object.
SdkInternalList<T> fields
Key-value pairs that define the properties of the object.
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.
String hostname
The public DNS name of the calling task runner.
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.
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.
String pipelineId
The ID of the pipeline.
SdkInternalList<T> pipelineObjects
The objects that define the pipeline. These objects overwrite the existing pipeline definition.
SdkInternalList<T> parameterObjects
The parameter objects used with the pipeline.
SdkInternalList<T> parameterValues
The parameter values used with the pipeline.
SdkInternalList<T> validationErrors
The validation errors that are associated with the objects defined in pipelineObjects
.
SdkInternalList<T> validationWarnings
The validation warnings that are associated with the objects defined in pipelineObjects
.
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.
SdkInternalList<T> selectors
List of selectors that define the query. An object must satisfy all of the selectors to match the query.
String pipelineId
The ID of the pipeline.
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.
String sphere
Indicates whether the query applies to components or instances. The possible values are: COMPONENT
,
INSTANCE
, and ATTEMPT
.
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.
Integer limit
The maximum number of object names that QueryObjects
will return in a single call. The default value
is 100.
SdkInternalList<T> ids
The identifiers that match the query selectors.
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.
Boolean hasMoreResults
Indicates whether there are more results that can be obtained by a subsequent call.
String pipelineId
The ID of the pipeline.
SdkInternalList<T> tagKeys
The keys of the tags to remove.
String taskId
The ID of the task assigned to the task runner. This value is provided in the response for PollForTask.
SdkInternalList<T> fields
Key-value pairs that define the properties of the ReportTaskProgressInput object.
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.
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.
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.
String hostname
The public DNS name of the task runner.
Boolean terminate
Indicates whether the calling task runner should terminate.
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.
Operator operator
String pipelineId
The ID of the pipeline that contains the objects.
SdkInternalList<T> objectIds
The IDs of the objects. The corresponding objects can be either physical or components, but not a mix of both types.
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
.
String taskId
The ID of the task assigned to the task runner. This value is provided in the response for PollForTask.
String taskStatus
If FINISHED
, the task successfully completed. If FAILED
, the task ended unsuccessfully.
Preconditions use false.
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.
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.
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.
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.
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.
String taskId
An internal identifier for the task. This ID is passed to the SetTaskStatus and ReportTaskProgress actions.
String pipelineId
The ID of the pipeline that provided the task.
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.
Map<K,V> objects
Connection information for the location where the task runner will publish the output of the task.
String pipelineId
The ID of the pipeline.
SdkInternalList<T> pipelineObjects
The objects that define the pipeline changes to validate against the pipeline.
SdkInternalList<T> parameterObjects
The parameter objects used with the pipeline.
SdkInternalList<T> parameterValues
The parameter values used with the pipeline.
SdkInternalList<T> validationErrors
Any validation errors that were found.
SdkInternalList<T> validationWarnings
Any validation warnings that were found.
Boolean errored
Indicates whether there were validation errors.
String id
The identifier of the object that contains the validation error.
SdkInternalList<T> errors
A description of the validation error.
String id
The identifier of the object that contains the validation warning.
SdkInternalList<T> warnings
A description of the validation warning.
Copyright © 2019. All rights reserved.