datapipeline.d.ts (43440B)
1 import {Request} from '../lib/request'; 2 import {Response} from '../lib/response'; 3 import {AWSError} from '../lib/error'; 4 import {Service} from '../lib/service'; 5 import {ServiceConfigurationOptions} from '../lib/service'; 6 import {ConfigBase as Config} from '../lib/config'; 7 interface Blob {} 8 declare class DataPipeline extends Service { 9 /** 10 * Constructs a service object. This object has one method for each API operation. 11 */ 12 constructor(options?: DataPipeline.Types.ClientConfiguration) 13 config: Config & DataPipeline.Types.ClientConfiguration; 14 /** 15 * Validates the specified pipeline and starts processing pipeline tasks. If the pipeline does not pass validation, activation fails. If you need to pause the pipeline to investigate an issue with a component, such as a data source or script, call DeactivatePipeline. To activate a finished pipeline, modify the end date for the pipeline and then activate it. 16 */ 17 activatePipeline(params: DataPipeline.Types.ActivatePipelineInput, callback?: (err: AWSError, data: DataPipeline.Types.ActivatePipelineOutput) => void): Request<DataPipeline.Types.ActivatePipelineOutput, AWSError>; 18 /** 19 * Validates the specified pipeline and starts processing pipeline tasks. If the pipeline does not pass validation, activation fails. If you need to pause the pipeline to investigate an issue with a component, such as a data source or script, call DeactivatePipeline. To activate a finished pipeline, modify the end date for the pipeline and then activate it. 20 */ 21 activatePipeline(callback?: (err: AWSError, data: DataPipeline.Types.ActivatePipelineOutput) => void): Request<DataPipeline.Types.ActivatePipelineOutput, AWSError>; 22 /** 23 * Adds or modifies tags for the specified pipeline. 24 */ 25 addTags(params: DataPipeline.Types.AddTagsInput, callback?: (err: AWSError, data: DataPipeline.Types.AddTagsOutput) => void): Request<DataPipeline.Types.AddTagsOutput, AWSError>; 26 /** 27 * Adds or modifies tags for the specified pipeline. 28 */ 29 addTags(callback?: (err: AWSError, data: DataPipeline.Types.AddTagsOutput) => void): Request<DataPipeline.Types.AddTagsOutput, AWSError>; 30 /** 31 * Creates a new, empty pipeline. Use PutPipelineDefinition to populate the pipeline. 32 */ 33 createPipeline(params: DataPipeline.Types.CreatePipelineInput, callback?: (err: AWSError, data: DataPipeline.Types.CreatePipelineOutput) => void): Request<DataPipeline.Types.CreatePipelineOutput, AWSError>; 34 /** 35 * Creates a new, empty pipeline. Use PutPipelineDefinition to populate the pipeline. 36 */ 37 createPipeline(callback?: (err: AWSError, data: DataPipeline.Types.CreatePipelineOutput) => void): Request<DataPipeline.Types.CreatePipelineOutput, AWSError>; 38 /** 39 * Deactivates the specified running pipeline. The pipeline is set to the DEACTIVATING state until the deactivation process completes. To resume a deactivated pipeline, use ActivatePipeline. By default, the pipeline resumes from the last completed execution. Optionally, you can specify the date and time to resume the pipeline. 40 */ 41 deactivatePipeline(params: DataPipeline.Types.DeactivatePipelineInput, callback?: (err: AWSError, data: DataPipeline.Types.DeactivatePipelineOutput) => void): Request<DataPipeline.Types.DeactivatePipelineOutput, AWSError>; 42 /** 43 * Deactivates the specified running pipeline. The pipeline is set to the DEACTIVATING state until the deactivation process completes. To resume a deactivated pipeline, use ActivatePipeline. By default, the pipeline resumes from the last completed execution. Optionally, you can specify the date and time to resume the pipeline. 44 */ 45 deactivatePipeline(callback?: (err: AWSError, data: DataPipeline.Types.DeactivatePipelineOutput) => void): Request<DataPipeline.Types.DeactivatePipelineOutput, AWSError>; 46 /** 47 * Deletes a pipeline, its pipeline definition, and its run history. AWS Data Pipeline attempts to cancel instances associated with the pipeline that are currently being processed by task runners. Deleting a pipeline cannot be undone. You cannot query or restore a deleted pipeline. To temporarily pause a pipeline instead of deleting it, call SetStatus with the status set to PAUSE on individual components. Components that are paused by SetStatus can be resumed. 48 */ 49 deletePipeline(params: DataPipeline.Types.DeletePipelineInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 50 /** 51 * Deletes a pipeline, its pipeline definition, and its run history. AWS Data Pipeline attempts to cancel instances associated with the pipeline that are currently being processed by task runners. Deleting a pipeline cannot be undone. You cannot query or restore a deleted pipeline. To temporarily pause a pipeline instead of deleting it, call SetStatus with the status set to PAUSE on individual components. Components that are paused by SetStatus can be resumed. 52 */ 53 deletePipeline(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 54 /** 55 * Gets the object definitions for a set of objects associated with the pipeline. Object definitions are composed of a set of fields that define the properties of the object. 56 */ 57 describeObjects(params: DataPipeline.Types.DescribeObjectsInput, callback?: (err: AWSError, data: DataPipeline.Types.DescribeObjectsOutput) => void): Request<DataPipeline.Types.DescribeObjectsOutput, AWSError>; 58 /** 59 * Gets the object definitions for a set of objects associated with the pipeline. Object definitions are composed of a set of fields that define the properties of the object. 60 */ 61 describeObjects(callback?: (err: AWSError, data: DataPipeline.Types.DescribeObjectsOutput) => void): Request<DataPipeline.Types.DescribeObjectsOutput, AWSError>; 62 /** 63 * Retrieves metadata about one or more pipelines. The information retrieved includes the name of the pipeline, the pipeline identifier, its current state, and the user account that owns the pipeline. Using account credentials, you can retrieve metadata about pipelines that you or your IAM users have created. If you are using an IAM user account, you can retrieve metadata about only those pipelines for which you have read permissions. To retrieve the full pipeline definition instead of metadata about the pipeline, call GetPipelineDefinition. 64 */ 65 describePipelines(params: DataPipeline.Types.DescribePipelinesInput, callback?: (err: AWSError, data: DataPipeline.Types.DescribePipelinesOutput) => void): Request<DataPipeline.Types.DescribePipelinesOutput, AWSError>; 66 /** 67 * Retrieves metadata about one or more pipelines. The information retrieved includes the name of the pipeline, the pipeline identifier, its current state, and the user account that owns the pipeline. Using account credentials, you can retrieve metadata about pipelines that you or your IAM users have created. If you are using an IAM user account, you can retrieve metadata about only those pipelines for which you have read permissions. To retrieve the full pipeline definition instead of metadata about the pipeline, call GetPipelineDefinition. 68 */ 69 describePipelines(callback?: (err: AWSError, data: DataPipeline.Types.DescribePipelinesOutput) => void): Request<DataPipeline.Types.DescribePipelinesOutput, AWSError>; 70 /** 71 * Task runners call EvaluateExpression to evaluate a string in the context of the specified object. For example, a task runner can evaluate SQL queries stored in Amazon S3. 72 */ 73 evaluateExpression(params: DataPipeline.Types.EvaluateExpressionInput, callback?: (err: AWSError, data: DataPipeline.Types.EvaluateExpressionOutput) => void): Request<DataPipeline.Types.EvaluateExpressionOutput, AWSError>; 74 /** 75 * Task runners call EvaluateExpression to evaluate a string in the context of the specified object. For example, a task runner can evaluate SQL queries stored in Amazon S3. 76 */ 77 evaluateExpression(callback?: (err: AWSError, data: DataPipeline.Types.EvaluateExpressionOutput) => void): Request<DataPipeline.Types.EvaluateExpressionOutput, AWSError>; 78 /** 79 * Gets the definition of the specified pipeline. You can call GetPipelineDefinition to retrieve the pipeline definition that you provided using PutPipelineDefinition. 80 */ 81 getPipelineDefinition(params: DataPipeline.Types.GetPipelineDefinitionInput, callback?: (err: AWSError, data: DataPipeline.Types.GetPipelineDefinitionOutput) => void): Request<DataPipeline.Types.GetPipelineDefinitionOutput, AWSError>; 82 /** 83 * Gets the definition of the specified pipeline. You can call GetPipelineDefinition to retrieve the pipeline definition that you provided using PutPipelineDefinition. 84 */ 85 getPipelineDefinition(callback?: (err: AWSError, data: DataPipeline.Types.GetPipelineDefinitionOutput) => void): Request<DataPipeline.Types.GetPipelineDefinitionOutput, AWSError>; 86 /** 87 * Lists the pipeline identifiers for all active pipelines that you have permission to access. 88 */ 89 listPipelines(params: DataPipeline.Types.ListPipelinesInput, callback?: (err: AWSError, data: DataPipeline.Types.ListPipelinesOutput) => void): Request<DataPipeline.Types.ListPipelinesOutput, AWSError>; 90 /** 91 * Lists the pipeline identifiers for all active pipelines that you have permission to access. 92 */ 93 listPipelines(callback?: (err: AWSError, data: DataPipeline.Types.ListPipelinesOutput) => void): Request<DataPipeline.Types.ListPipelinesOutput, AWSError>; 94 /** 95 * Task runners call PollForTask to receive a task to perform from AWS Data Pipeline. The task runner specifies which tasks it can perform by setting a value for the workerGroup parameter. The task returned can come from any of the pipelines that match the workerGroup value passed in by the task runner and that was launched using the IAM user credentials specified by the task runner. If tasks are ready in the work queue, PollForTask returns a response immediately. If no tasks are available in the queue, PollForTask uses long-polling and holds on to a poll connection for up to a 90 seconds, during which time the first newly scheduled task is handed to the task runner. To accomodate this, set the socket timeout in your task runner to 90 seconds. The task runner should not call PollForTask again on the same workerGroup until it receives a response, and this can take up to 90 seconds. 96 */ 97 pollForTask(params: DataPipeline.Types.PollForTaskInput, callback?: (err: AWSError, data: DataPipeline.Types.PollForTaskOutput) => void): Request<DataPipeline.Types.PollForTaskOutput, AWSError>; 98 /** 99 * Task runners call PollForTask to receive a task to perform from AWS Data Pipeline. The task runner specifies which tasks it can perform by setting a value for the workerGroup parameter. The task returned can come from any of the pipelines that match the workerGroup value passed in by the task runner and that was launched using the IAM user credentials specified by the task runner. If tasks are ready in the work queue, PollForTask returns a response immediately. If no tasks are available in the queue, PollForTask uses long-polling and holds on to a poll connection for up to a 90 seconds, during which time the first newly scheduled task is handed to the task runner. To accomodate this, set the socket timeout in your task runner to 90 seconds. The task runner should not call PollForTask again on the same workerGroup until it receives a response, and this can take up to 90 seconds. 100 */ 101 pollForTask(callback?: (err: AWSError, data: DataPipeline.Types.PollForTaskOutput) => void): Request<DataPipeline.Types.PollForTaskOutput, AWSError>; 102 /** 103 * Adds tasks, schedules, and preconditions to the specified pipeline. You can use PutPipelineDefinition to populate a new pipeline. PutPipelineDefinition also validates the configuration as it adds it to the pipeline. Changes to the pipeline are saved unless one of the following three validation errors exists in the pipeline. An object is missing a name or identifier field. A string or reference field is empty. The number of objects in the pipeline exceeds the maximum allowed objects. The pipeline is in a FINISHED state. Pipeline object definitions are passed to the PutPipelineDefinition action and returned by the GetPipelineDefinition action. 104 */ 105 putPipelineDefinition(params: DataPipeline.Types.PutPipelineDefinitionInput, callback?: (err: AWSError, data: DataPipeline.Types.PutPipelineDefinitionOutput) => void): Request<DataPipeline.Types.PutPipelineDefinitionOutput, AWSError>; 106 /** 107 * Adds tasks, schedules, and preconditions to the specified pipeline. You can use PutPipelineDefinition to populate a new pipeline. PutPipelineDefinition also validates the configuration as it adds it to the pipeline. Changes to the pipeline are saved unless one of the following three validation errors exists in the pipeline. An object is missing a name or identifier field. A string or reference field is empty. The number of objects in the pipeline exceeds the maximum allowed objects. The pipeline is in a FINISHED state. Pipeline object definitions are passed to the PutPipelineDefinition action and returned by the GetPipelineDefinition action. 108 */ 109 putPipelineDefinition(callback?: (err: AWSError, data: DataPipeline.Types.PutPipelineDefinitionOutput) => void): Request<DataPipeline.Types.PutPipelineDefinitionOutput, AWSError>; 110 /** 111 * Queries the specified pipeline for the names of objects that match the specified set of conditions. 112 */ 113 queryObjects(params: DataPipeline.Types.QueryObjectsInput, callback?: (err: AWSError, data: DataPipeline.Types.QueryObjectsOutput) => void): Request<DataPipeline.Types.QueryObjectsOutput, AWSError>; 114 /** 115 * Queries the specified pipeline for the names of objects that match the specified set of conditions. 116 */ 117 queryObjects(callback?: (err: AWSError, data: DataPipeline.Types.QueryObjectsOutput) => void): Request<DataPipeline.Types.QueryObjectsOutput, AWSError>; 118 /** 119 * Removes existing tags from the specified pipeline. 120 */ 121 removeTags(params: DataPipeline.Types.RemoveTagsInput, callback?: (err: AWSError, data: DataPipeline.Types.RemoveTagsOutput) => void): Request<DataPipeline.Types.RemoveTagsOutput, AWSError>; 122 /** 123 * Removes existing tags from the specified pipeline. 124 */ 125 removeTags(callback?: (err: AWSError, data: DataPipeline.Types.RemoveTagsOutput) => void): Request<DataPipeline.Types.RemoveTagsOutput, AWSError>; 126 /** 127 * Task runners call ReportTaskProgress when assigned a task to acknowledge that it has the task. If the web service does not receive this acknowledgement within 2 minutes, it assigns the task in a subsequent PollForTask call. After this initial acknowledgement, the task runner only needs to report progress every 15 minutes to maintain its ownership of the task. You can change this reporting time from 15 minutes by specifying a reportProgressTimeout field in your pipeline. If a task runner does not report its status after 5 minutes, AWS Data Pipeline assumes that the task runner is unable to process the task and reassigns the task in a subsequent response to PollForTask. Task runners should call ReportTaskProgress every 60 seconds. 128 */ 129 reportTaskProgress(params: DataPipeline.Types.ReportTaskProgressInput, callback?: (err: AWSError, data: DataPipeline.Types.ReportTaskProgressOutput) => void): Request<DataPipeline.Types.ReportTaskProgressOutput, AWSError>; 130 /** 131 * Task runners call ReportTaskProgress when assigned a task to acknowledge that it has the task. If the web service does not receive this acknowledgement within 2 minutes, it assigns the task in a subsequent PollForTask call. After this initial acknowledgement, the task runner only needs to report progress every 15 minutes to maintain its ownership of the task. You can change this reporting time from 15 minutes by specifying a reportProgressTimeout field in your pipeline. If a task runner does not report its status after 5 minutes, AWS Data Pipeline assumes that the task runner is unable to process the task and reassigns the task in a subsequent response to PollForTask. Task runners should call ReportTaskProgress every 60 seconds. 132 */ 133 reportTaskProgress(callback?: (err: AWSError, data: DataPipeline.Types.ReportTaskProgressOutput) => void): Request<DataPipeline.Types.ReportTaskProgressOutput, AWSError>; 134 /** 135 * Task runners call ReportTaskRunnerHeartbeat every 15 minutes to indicate that they are operational. If the AWS Data Pipeline Task Runner is launched on a resource managed by AWS Data Pipeline, the web service can use this call to detect when the task runner application has failed and restart a new instance. 136 */ 137 reportTaskRunnerHeartbeat(params: DataPipeline.Types.ReportTaskRunnerHeartbeatInput, callback?: (err: AWSError, data: DataPipeline.Types.ReportTaskRunnerHeartbeatOutput) => void): Request<DataPipeline.Types.ReportTaskRunnerHeartbeatOutput, AWSError>; 138 /** 139 * Task runners call ReportTaskRunnerHeartbeat every 15 minutes to indicate that they are operational. If the AWS Data Pipeline Task Runner is launched on a resource managed by AWS Data Pipeline, the web service can use this call to detect when the task runner application has failed and restart a new instance. 140 */ 141 reportTaskRunnerHeartbeat(callback?: (err: AWSError, data: DataPipeline.Types.ReportTaskRunnerHeartbeatOutput) => void): Request<DataPipeline.Types.ReportTaskRunnerHeartbeatOutput, AWSError>; 142 /** 143 * Requests that the status of the specified physical or logical pipeline objects be updated in the specified pipeline. This update might not occur immediately, but is eventually consistent. The status that can be set depends on the type of object (for example, DataNode or Activity). You cannot perform this operation on FINISHED pipelines and attempting to do so returns InvalidRequestException. 144 */ 145 setStatus(params: DataPipeline.Types.SetStatusInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 146 /** 147 * Requests that the status of the specified physical or logical pipeline objects be updated in the specified pipeline. This update might not occur immediately, but is eventually consistent. The status that can be set depends on the type of object (for example, DataNode or Activity). You cannot perform this operation on FINISHED pipelines and attempting to do so returns InvalidRequestException. 148 */ 149 setStatus(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 150 /** 151 * Task runners call SetTaskStatus to notify AWS Data Pipeline that a task is completed and provide information about the final status. A task runner makes this call regardless of whether the task was sucessful. A task runner does not need to call SetTaskStatus for tasks that are canceled by the web service during a call to ReportTaskProgress. 152 */ 153 setTaskStatus(params: DataPipeline.Types.SetTaskStatusInput, callback?: (err: AWSError, data: DataPipeline.Types.SetTaskStatusOutput) => void): Request<DataPipeline.Types.SetTaskStatusOutput, AWSError>; 154 /** 155 * Task runners call SetTaskStatus to notify AWS Data Pipeline that a task is completed and provide information about the final status. A task runner makes this call regardless of whether the task was sucessful. A task runner does not need to call SetTaskStatus for tasks that are canceled by the web service during a call to ReportTaskProgress. 156 */ 157 setTaskStatus(callback?: (err: AWSError, data: DataPipeline.Types.SetTaskStatusOutput) => void): Request<DataPipeline.Types.SetTaskStatusOutput, AWSError>; 158 /** 159 * Validates the specified pipeline definition to ensure that it is well formed and can be run without error. 160 */ 161 validatePipelineDefinition(params: DataPipeline.Types.ValidatePipelineDefinitionInput, callback?: (err: AWSError, data: DataPipeline.Types.ValidatePipelineDefinitionOutput) => void): Request<DataPipeline.Types.ValidatePipelineDefinitionOutput, AWSError>; 162 /** 163 * Validates the specified pipeline definition to ensure that it is well formed and can be run without error. 164 */ 165 validatePipelineDefinition(callback?: (err: AWSError, data: DataPipeline.Types.ValidatePipelineDefinitionOutput) => void): Request<DataPipeline.Types.ValidatePipelineDefinitionOutput, AWSError>; 166 } 167 declare namespace DataPipeline.Types { 168 export interface ActivatePipelineInput { 169 /** 170 * The ID of the pipeline. 171 */ 172 pipelineId: id; 173 /** 174 * A list of parameter values to pass to the pipeline at activation. 175 */ 176 parameterValues?: ParameterValueList; 177 /** 178 * The date and time to resume the pipeline. By default, the pipeline resumes from the last completed execution. 179 */ 180 startTimestamp?: timestamp; 181 } 182 export interface ActivatePipelineOutput { 183 } 184 export interface AddTagsInput { 185 /** 186 * The ID of the pipeline. 187 */ 188 pipelineId: id; 189 /** 190 * The tags to add, as key/value pairs. 191 */ 192 tags: tagList; 193 } 194 export interface AddTagsOutput { 195 } 196 export interface CreatePipelineInput { 197 /** 198 * 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. 199 */ 200 name: id; 201 /** 202 * 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. 203 */ 204 uniqueId: id; 205 /** 206 * The description for the pipeline. 207 */ 208 description?: string; 209 /** 210 * 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. 211 */ 212 tags?: tagList; 213 } 214 export interface CreatePipelineOutput { 215 /** 216 * The ID that AWS Data Pipeline assigns the newly created pipeline. For example, df-06372391ZG65EXAMPLE. 217 */ 218 pipelineId: id; 219 } 220 export interface DeactivatePipelineInput { 221 /** 222 * The ID of the pipeline. 223 */ 224 pipelineId: id; 225 /** 226 * 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. 227 */ 228 cancelActive?: cancelActive; 229 } 230 export interface DeactivatePipelineOutput { 231 } 232 export interface DeletePipelineInput { 233 /** 234 * The ID of the pipeline. 235 */ 236 pipelineId: id; 237 } 238 export interface DescribeObjectsInput { 239 /** 240 * The ID of the pipeline that contains the object definitions. 241 */ 242 pipelineId: id; 243 /** 244 * 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. 245 */ 246 objectIds: idList; 247 /** 248 * Indicates whether any expressions in the object should be evaluated when the object descriptions are returned. 249 */ 250 evaluateExpressions?: boolean; 251 /** 252 * 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. 253 */ 254 marker?: string; 255 } 256 export interface DescribeObjectsOutput { 257 /** 258 * An array of object definitions. 259 */ 260 pipelineObjects: PipelineObjectList; 261 /** 262 * 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. 263 */ 264 marker?: string; 265 /** 266 * Indicates whether there are more results to return. 267 */ 268 hasMoreResults?: boolean; 269 } 270 export interface DescribePipelinesInput { 271 /** 272 * 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. 273 */ 274 pipelineIds: idList; 275 } 276 export interface DescribePipelinesOutput { 277 /** 278 * An array of descriptions for the specified pipelines. 279 */ 280 pipelineDescriptionList: PipelineDescriptionList; 281 } 282 export interface EvaluateExpressionInput { 283 /** 284 * The ID of the pipeline. 285 */ 286 pipelineId: id; 287 /** 288 * The ID of the object. 289 */ 290 objectId: id; 291 /** 292 * The expression to evaluate. 293 */ 294 expression: longString; 295 } 296 export interface EvaluateExpressionOutput { 297 /** 298 * The evaluated expression. 299 */ 300 evaluatedExpression: longString; 301 } 302 export interface Field { 303 /** 304 * The field identifier. 305 */ 306 key: fieldNameString; 307 /** 308 * The field value, expressed as a String. 309 */ 310 stringValue?: fieldStringValue; 311 /** 312 * The field value, expressed as the identifier of another object. 313 */ 314 refValue?: fieldNameString; 315 } 316 export interface GetPipelineDefinitionInput { 317 /** 318 * The ID of the pipeline. 319 */ 320 pipelineId: id; 321 /** 322 * 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. 323 */ 324 version?: string; 325 } 326 export interface GetPipelineDefinitionOutput { 327 /** 328 * The objects defined in the pipeline. 329 */ 330 pipelineObjects?: PipelineObjectList; 331 /** 332 * The parameter objects used in the pipeline definition. 333 */ 334 parameterObjects?: ParameterObjectList; 335 /** 336 * The parameter values used in the pipeline definition. 337 */ 338 parameterValues?: ParameterValueList; 339 } 340 export interface InstanceIdentity { 341 /** 342 * 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. 343 */ 344 document?: string; 345 /** 346 * A signature which can be used to verify the accuracy and authenticity of the information provided in the instance identity document. 347 */ 348 signature?: string; 349 } 350 export interface ListPipelinesInput { 351 /** 352 * 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. 353 */ 354 marker?: string; 355 } 356 export interface ListPipelinesOutput { 357 /** 358 * The pipeline identifiers. If you require additional information about the pipelines, you can use these identifiers to call DescribePipelines and GetPipelineDefinition. 359 */ 360 pipelineIdList: pipelineList; 361 /** 362 * 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. 363 */ 364 marker?: string; 365 /** 366 * Indicates whether there are more results that can be obtained by a subsequent call. 367 */ 368 hasMoreResults?: boolean; 369 } 370 export interface Operator { 371 /** 372 * 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". 373 */ 374 type?: OperatorType; 375 /** 376 * The value that the actual field value will be compared with. 377 */ 378 values?: stringList; 379 } 380 export type OperatorType = "EQ"|"REF_EQ"|"LE"|"GE"|"BETWEEN"|string; 381 export interface ParameterAttribute { 382 /** 383 * The field identifier. 384 */ 385 key: attributeNameString; 386 /** 387 * The field value, expressed as a String. 388 */ 389 stringValue: attributeValueString; 390 } 391 export type ParameterAttributeList = ParameterAttribute[]; 392 export interface ParameterObject { 393 /** 394 * The ID of the parameter object. 395 */ 396 id: fieldNameString; 397 /** 398 * The attributes of the parameter object. 399 */ 400 attributes: ParameterAttributeList; 401 } 402 export type ParameterObjectList = ParameterObject[]; 403 export interface ParameterValue { 404 /** 405 * The ID of the parameter value. 406 */ 407 id: fieldNameString; 408 /** 409 * The field value, expressed as a String. 410 */ 411 stringValue: fieldStringValue; 412 } 413 export type ParameterValueList = ParameterValue[]; 414 export interface PipelineDescription { 415 /** 416 * The pipeline identifier that was assigned by AWS Data Pipeline. This is a string of the form df-297EG78HU43EEXAMPLE. 417 */ 418 pipelineId: id; 419 /** 420 * The name of the pipeline. 421 */ 422 name: id; 423 /** 424 * A list of read-only fields that contain metadata about the pipeline: @userId, @accountId, and @pipelineState. 425 */ 426 fields: fieldList; 427 /** 428 * Description of the pipeline. 429 */ 430 description?: string; 431 /** 432 * 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. 433 */ 434 tags?: tagList; 435 } 436 export type PipelineDescriptionList = PipelineDescription[]; 437 export interface PipelineIdName { 438 /** 439 * The ID of the pipeline that was assigned by AWS Data Pipeline. This is a string of the form df-297EG78HU43EEXAMPLE. 440 */ 441 id?: id; 442 /** 443 * The name of the pipeline. 444 */ 445 name?: id; 446 } 447 export interface PipelineObject { 448 /** 449 * The ID of the object. 450 */ 451 id: id; 452 /** 453 * The name of the object. 454 */ 455 name: id; 456 /** 457 * Key-value pairs that define the properties of the object. 458 */ 459 fields: fieldList; 460 } 461 export type PipelineObjectList = PipelineObject[]; 462 export type PipelineObjectMap = {[key: string]: PipelineObject}; 463 export interface PollForTaskInput { 464 /** 465 * 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. 466 */ 467 workerGroup: string; 468 /** 469 * The public DNS name of the calling task runner. 470 */ 471 hostname?: id; 472 /** 473 * 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. 474 */ 475 instanceIdentity?: InstanceIdentity; 476 } 477 export interface PollForTaskOutput { 478 /** 479 * 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. 480 */ 481 taskObject?: TaskObject; 482 } 483 export interface PutPipelineDefinitionInput { 484 /** 485 * The ID of the pipeline. 486 */ 487 pipelineId: id; 488 /** 489 * The objects that define the pipeline. These objects overwrite the existing pipeline definition. 490 */ 491 pipelineObjects: PipelineObjectList; 492 /** 493 * The parameter objects used with the pipeline. 494 */ 495 parameterObjects?: ParameterObjectList; 496 /** 497 * The parameter values used with the pipeline. 498 */ 499 parameterValues?: ParameterValueList; 500 } 501 export interface PutPipelineDefinitionOutput { 502 /** 503 * The validation errors that are associated with the objects defined in pipelineObjects. 504 */ 505 validationErrors?: ValidationErrors; 506 /** 507 * The validation warnings that are associated with the objects defined in pipelineObjects. 508 */ 509 validationWarnings?: ValidationWarnings; 510 /** 511 * 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. 512 */ 513 errored: boolean; 514 } 515 export interface Query { 516 /** 517 * List of selectors that define the query. An object must satisfy all of the selectors to match the query. 518 */ 519 selectors?: SelectorList; 520 } 521 export interface QueryObjectsInput { 522 /** 523 * The ID of the pipeline. 524 */ 525 pipelineId: id; 526 /** 527 * 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. 528 */ 529 query?: Query; 530 /** 531 * Indicates whether the query applies to components or instances. The possible values are: COMPONENT, INSTANCE, and ATTEMPT. 532 */ 533 sphere: string; 534 /** 535 * 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. 536 */ 537 marker?: string; 538 /** 539 * The maximum number of object names that QueryObjects will return in a single call. The default value is 100. 540 */ 541 limit?: int; 542 } 543 export interface QueryObjectsOutput { 544 /** 545 * The identifiers that match the query selectors. 546 */ 547 ids?: idList; 548 /** 549 * 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. 550 */ 551 marker?: string; 552 /** 553 * Indicates whether there are more results that can be obtained by a subsequent call. 554 */ 555 hasMoreResults?: boolean; 556 } 557 export interface RemoveTagsInput { 558 /** 559 * The ID of the pipeline. 560 */ 561 pipelineId: id; 562 /** 563 * The keys of the tags to remove. 564 */ 565 tagKeys: stringList; 566 } 567 export interface RemoveTagsOutput { 568 } 569 export interface ReportTaskProgressInput { 570 /** 571 * The ID of the task assigned to the task runner. This value is provided in the response for PollForTask. 572 */ 573 taskId: taskId; 574 /** 575 * Key-value pairs that define the properties of the ReportTaskProgressInput object. 576 */ 577 fields?: fieldList; 578 } 579 export interface ReportTaskProgressOutput { 580 /** 581 * If true, the calling task runner should cancel processing of the task. The task runner does not need to call SetTaskStatus for canceled tasks. 582 */ 583 canceled: boolean; 584 } 585 export interface ReportTaskRunnerHeartbeatInput { 586 /** 587 * 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. 588 */ 589 taskrunnerId: id; 590 /** 591 * 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. 592 */ 593 workerGroup?: string; 594 /** 595 * The public DNS name of the task runner. 596 */ 597 hostname?: id; 598 } 599 export interface ReportTaskRunnerHeartbeatOutput { 600 /** 601 * Indicates whether the calling task runner should terminate. 602 */ 603 terminate: boolean; 604 } 605 export interface Selector { 606 /** 607 * 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. 608 */ 609 fieldName?: string; 610 operator?: Operator; 611 } 612 export type SelectorList = Selector[]; 613 export interface SetStatusInput { 614 /** 615 * The ID of the pipeline that contains the objects. 616 */ 617 pipelineId: id; 618 /** 619 * The IDs of the objects. The corresponding objects can be either physical or components, but not a mix of both types. 620 */ 621 objectIds: idList; 622 /** 623 * 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. 624 */ 625 status: string; 626 } 627 export interface SetTaskStatusInput { 628 /** 629 * The ID of the task assigned to the task runner. This value is provided in the response for PollForTask. 630 */ 631 taskId: taskId; 632 /** 633 * If FINISHED, the task successfully completed. If FAILED, the task ended unsuccessfully. Preconditions use false. 634 */ 635 taskStatus: TaskStatus; 636 /** 637 * 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. 638 */ 639 errorId?: string; 640 /** 641 * 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. 642 */ 643 errorMessage?: errorMessage; 644 /** 645 * 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. 646 */ 647 errorStackTrace?: string; 648 } 649 export interface SetTaskStatusOutput { 650 } 651 export interface Tag { 652 /** 653 * 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. 654 */ 655 key: tagKey; 656 /** 657 * 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. 658 */ 659 value: tagValue; 660 } 661 export interface TaskObject { 662 /** 663 * An internal identifier for the task. This ID is passed to the SetTaskStatus and ReportTaskProgress actions. 664 */ 665 taskId?: taskId; 666 /** 667 * The ID of the pipeline that provided the task. 668 */ 669 pipelineId?: id; 670 /** 671 * The ID of the pipeline task attempt object. AWS Data Pipeline uses this value to track how many times a task is attempted. 672 */ 673 attemptId?: id; 674 /** 675 * Connection information for the location where the task runner will publish the output of the task. 676 */ 677 objects?: PipelineObjectMap; 678 } 679 export type TaskStatus = "FINISHED"|"FAILED"|"FALSE"|string; 680 export interface ValidatePipelineDefinitionInput { 681 /** 682 * The ID of the pipeline. 683 */ 684 pipelineId: id; 685 /** 686 * The objects that define the pipeline changes to validate against the pipeline. 687 */ 688 pipelineObjects: PipelineObjectList; 689 /** 690 * The parameter objects used with the pipeline. 691 */ 692 parameterObjects?: ParameterObjectList; 693 /** 694 * The parameter values used with the pipeline. 695 */ 696 parameterValues?: ParameterValueList; 697 } 698 export interface ValidatePipelineDefinitionOutput { 699 /** 700 * Any validation errors that were found. 701 */ 702 validationErrors?: ValidationErrors; 703 /** 704 * Any validation warnings that were found. 705 */ 706 validationWarnings?: ValidationWarnings; 707 /** 708 * Indicates whether there were validation errors. 709 */ 710 errored: boolean; 711 } 712 export interface ValidationError { 713 /** 714 * The identifier of the object that contains the validation error. 715 */ 716 id?: id; 717 /** 718 * A description of the validation error. 719 */ 720 errors?: validationMessages; 721 } 722 export type ValidationErrors = ValidationError[]; 723 export interface ValidationWarning { 724 /** 725 * The identifier of the object that contains the validation warning. 726 */ 727 id?: id; 728 /** 729 * A description of the validation warning. 730 */ 731 warnings?: validationMessages; 732 } 733 export type ValidationWarnings = ValidationWarning[]; 734 export type attributeNameString = string; 735 export type attributeValueString = string; 736 export type cancelActive = boolean; 737 export type errorMessage = string; 738 export type fieldList = Field[]; 739 export type fieldNameString = string; 740 export type fieldStringValue = string; 741 export type id = string; 742 export type idList = id[]; 743 export type int = number; 744 export type longString = string; 745 export type pipelineList = PipelineIdName[]; 746 export type stringList = string[]; 747 export type tagKey = string; 748 export type tagList = Tag[]; 749 export type tagValue = string; 750 export type taskId = string; 751 export type timestamp = Date; 752 export type validationMessage = string; 753 export type validationMessages = validationMessage[]; 754 /** 755 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. 756 */ 757 export type apiVersion = "2012-10-29"|"latest"|string; 758 export interface ClientApiVersions { 759 /** 760 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. 761 */ 762 apiVersion?: apiVersion; 763 } 764 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; 765 } 766 export = DataPipeline;