@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api AWS Data Pipeline
@version 2012-10-29
@auth AWS SigV4
@endpoints 19
@toc root(19)

@endpoint POST /
@required {pipelineId: str}
@optional {parameterValues: [ParameterValue], startTimestamp: str(timestamp)}

@endpoint POST /
@required {pipelineId: str, tags: [Tag]}

@endpoint POST /
@required {name: str, uniqueId: str}
@optional {description: str, tags: [Tag]}
@returns(200) {pipelineId: str}

@endpoint POST /
@required {pipelineId: str}
@optional {cancelActive: bool}

@endpoint POST /
@required {pipelineId: str}

@endpoint POST /
@required {pipelineId: str, objectIds: [str]}
@optional {evaluateExpressions: bool, marker: str}
@returns(200) {pipelineObjects: [PipelineObject], marker: str?, hasMoreResults: bool?}

@endpoint POST /
@required {pipelineIds: [str]}
@returns(200) {pipelineDescriptionList: [PipelineDescription]}

@endpoint POST /
@required {pipelineId: str, objectId: str, expression: str}
@returns(200) {evaluatedExpression: str}

@endpoint POST /
@required {pipelineId: str}
@optional {version: str}
@returns(200) {pipelineObjects: [PipelineObject]?, parameterObjects: [ParameterObject]?, parameterValues: [ParameterValue]?}

@endpoint POST /
@optional {marker: str}
@returns(200) {pipelineIdList: [PipelineIdName], marker: str?, hasMoreResults: bool?}

@endpoint POST /
@required {workerGroup: str}
@optional {hostname: str, instanceIdentity: InstanceIdentity}
@returns(200) {taskObject: TaskObject?{taskId: str?, pipelineId: str?, attemptId: str?, objects: map<str,PipelineObject>?}}

@endpoint POST /
@required {pipelineId: str, pipelineObjects: [PipelineObject]}
@optional {parameterObjects: [ParameterObject], parameterValues: [ParameterValue]}
@returns(200) {validationErrors: [ValidationError]?, validationWarnings: [ValidationWarning]?, errored: bool}

@endpoint POST /
@required {pipelineId: str, sphere: str}
@optional {query: Query, marker: str, limit: int}
@returns(200) {ids: [str]?, marker: str?, hasMoreResults: bool?}

@endpoint POST /
@required {pipelineId: str, tagKeys: [str]}

@endpoint POST /
@required {taskId: str}
@optional {fields: [Field]}
@returns(200) {canceled: bool}

@endpoint POST /
@required {taskrunnerId: str}
@optional {workerGroup: str, hostname: str}
@returns(200) {terminate: bool}

@endpoint POST /
@required {pipelineId: str, objectIds: [str], status: str}

@endpoint POST /
@required {taskId: str, taskStatus: str}
@optional {errorId: str, errorMessage: str, errorStackTrace: str}

@endpoint POST /
@required {pipelineId: str, pipelineObjects: [PipelineObject]}
@optional {parameterObjects: [ParameterObject], parameterValues: [ParameterValue]}
@returns(200) {validationErrors: [ValidationError]?, validationWarnings: [ValidationWarning]?, errored: bool}

@end