api.go 69 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158
  1. // THIS FILE IS AUTOMATICALLY GENERATED. DO NOT EDIT.
  2. // Package datapipeline provides a client for AWS Data Pipeline.
  3. package datapipeline
  4. import (
  5. "time"
  6. "github.com/aws/aws-sdk-go/aws/awsutil"
  7. "github.com/aws/aws-sdk-go/aws/request"
  8. )
  9. const opActivatePipeline = "ActivatePipeline"
  10. // ActivatePipelineRequest generates a request for the ActivatePipeline operation.
  11. func (c *DataPipeline) ActivatePipelineRequest(input *ActivatePipelineInput) (req *request.Request, output *ActivatePipelineOutput) {
  12. op := &request.Operation{
  13. Name: opActivatePipeline,
  14. HTTPMethod: "POST",
  15. HTTPPath: "/",
  16. }
  17. if input == nil {
  18. input = &ActivatePipelineInput{}
  19. }
  20. req = c.newRequest(op, input, output)
  21. output = &ActivatePipelineOutput{}
  22. req.Data = output
  23. return
  24. }
  25. // Validates the specified pipeline and starts processing pipeline tasks. If
  26. // the pipeline does not pass validation, activation fails.
  27. //
  28. // If you need to pause the pipeline to investigate an issue with a component,
  29. // such as a data source or script, call DeactivatePipeline.
  30. //
  31. // To activate a finished pipeline, modify the end date for the pipeline and
  32. // then activate it.
  33. func (c *DataPipeline) ActivatePipeline(input *ActivatePipelineInput) (*ActivatePipelineOutput, error) {
  34. req, out := c.ActivatePipelineRequest(input)
  35. err := req.Send()
  36. return out, err
  37. }
  38. const opAddTags = "AddTags"
  39. // AddTagsRequest generates a request for the AddTags operation.
  40. func (c *DataPipeline) AddTagsRequest(input *AddTagsInput) (req *request.Request, output *AddTagsOutput) {
  41. op := &request.Operation{
  42. Name: opAddTags,
  43. HTTPMethod: "POST",
  44. HTTPPath: "/",
  45. }
  46. if input == nil {
  47. input = &AddTagsInput{}
  48. }
  49. req = c.newRequest(op, input, output)
  50. output = &AddTagsOutput{}
  51. req.Data = output
  52. return
  53. }
  54. // Adds or modifies tags for the specified pipeline.
  55. func (c *DataPipeline) AddTags(input *AddTagsInput) (*AddTagsOutput, error) {
  56. req, out := c.AddTagsRequest(input)
  57. err := req.Send()
  58. return out, err
  59. }
  60. const opCreatePipeline = "CreatePipeline"
  61. // CreatePipelineRequest generates a request for the CreatePipeline operation.
  62. func (c *DataPipeline) CreatePipelineRequest(input *CreatePipelineInput) (req *request.Request, output *CreatePipelineOutput) {
  63. op := &request.Operation{
  64. Name: opCreatePipeline,
  65. HTTPMethod: "POST",
  66. HTTPPath: "/",
  67. }
  68. if input == nil {
  69. input = &CreatePipelineInput{}
  70. }
  71. req = c.newRequest(op, input, output)
  72. output = &CreatePipelineOutput{}
  73. req.Data = output
  74. return
  75. }
  76. // Creates a new, empty pipeline. Use PutPipelineDefinition to populate the
  77. // pipeline.
  78. func (c *DataPipeline) CreatePipeline(input *CreatePipelineInput) (*CreatePipelineOutput, error) {
  79. req, out := c.CreatePipelineRequest(input)
  80. err := req.Send()
  81. return out, err
  82. }
  83. const opDeactivatePipeline = "DeactivatePipeline"
  84. // DeactivatePipelineRequest generates a request for the DeactivatePipeline operation.
  85. func (c *DataPipeline) DeactivatePipelineRequest(input *DeactivatePipelineInput) (req *request.Request, output *DeactivatePipelineOutput) {
  86. op := &request.Operation{
  87. Name: opDeactivatePipeline,
  88. HTTPMethod: "POST",
  89. HTTPPath: "/",
  90. }
  91. if input == nil {
  92. input = &DeactivatePipelineInput{}
  93. }
  94. req = c.newRequest(op, input, output)
  95. output = &DeactivatePipelineOutput{}
  96. req.Data = output
  97. return
  98. }
  99. // Deactivates the specified running pipeline. The pipeline is set to the DEACTIVATING
  100. // state until the deactivation process completes.
  101. //
  102. // To resume a deactivated pipeline, use ActivatePipeline. By default, the
  103. // pipeline resumes from the last completed execution. Optionally, you can specify
  104. // the date and time to resume the pipeline.
  105. func (c *DataPipeline) DeactivatePipeline(input *DeactivatePipelineInput) (*DeactivatePipelineOutput, error) {
  106. req, out := c.DeactivatePipelineRequest(input)
  107. err := req.Send()
  108. return out, err
  109. }
  110. const opDeletePipeline = "DeletePipeline"
  111. // DeletePipelineRequest generates a request for the DeletePipeline operation.
  112. func (c *DataPipeline) DeletePipelineRequest(input *DeletePipelineInput) (req *request.Request, output *DeletePipelineOutput) {
  113. op := &request.Operation{
  114. Name: opDeletePipeline,
  115. HTTPMethod: "POST",
  116. HTTPPath: "/",
  117. }
  118. if input == nil {
  119. input = &DeletePipelineInput{}
  120. }
  121. req = c.newRequest(op, input, output)
  122. output = &DeletePipelineOutput{}
  123. req.Data = output
  124. return
  125. }
  126. // Deletes a pipeline, its pipeline definition, and its run history. AWS Data
  127. // Pipeline attempts to cancel instances associated with the pipeline that are
  128. // currently being processed by task runners.
  129. //
  130. // Deleting a pipeline cannot be undone. You cannot query or restore a deleted
  131. // pipeline. To temporarily pause a pipeline instead of deleting it, call SetStatus
  132. // with the status set to PAUSE on individual components. Components that are
  133. // paused by SetStatus can be resumed.
  134. func (c *DataPipeline) DeletePipeline(input *DeletePipelineInput) (*DeletePipelineOutput, error) {
  135. req, out := c.DeletePipelineRequest(input)
  136. err := req.Send()
  137. return out, err
  138. }
  139. const opDescribeObjects = "DescribeObjects"
  140. // DescribeObjectsRequest generates a request for the DescribeObjects operation.
  141. func (c *DataPipeline) DescribeObjectsRequest(input *DescribeObjectsInput) (req *request.Request, output *DescribeObjectsOutput) {
  142. op := &request.Operation{
  143. Name: opDescribeObjects,
  144. HTTPMethod: "POST",
  145. HTTPPath: "/",
  146. Paginator: &request.Paginator{
  147. InputTokens: []string{"marker"},
  148. OutputTokens: []string{"marker"},
  149. LimitToken: "",
  150. TruncationToken: "hasMoreResults",
  151. },
  152. }
  153. if input == nil {
  154. input = &DescribeObjectsInput{}
  155. }
  156. req = c.newRequest(op, input, output)
  157. output = &DescribeObjectsOutput{}
  158. req.Data = output
  159. return
  160. }
  161. // Gets the object definitions for a set of objects associated with the pipeline.
  162. // Object definitions are composed of a set of fields that define the properties
  163. // of the object.
  164. func (c *DataPipeline) DescribeObjects(input *DescribeObjectsInput) (*DescribeObjectsOutput, error) {
  165. req, out := c.DescribeObjectsRequest(input)
  166. err := req.Send()
  167. return out, err
  168. }
  169. func (c *DataPipeline) DescribeObjectsPages(input *DescribeObjectsInput, fn func(p *DescribeObjectsOutput, lastPage bool) (shouldContinue bool)) error {
  170. page, _ := c.DescribeObjectsRequest(input)
  171. return page.EachPage(func(p interface{}, lastPage bool) bool {
  172. return fn(p.(*DescribeObjectsOutput), lastPage)
  173. })
  174. }
  175. const opDescribePipelines = "DescribePipelines"
  176. // DescribePipelinesRequest generates a request for the DescribePipelines operation.
  177. func (c *DataPipeline) DescribePipelinesRequest(input *DescribePipelinesInput) (req *request.Request, output *DescribePipelinesOutput) {
  178. op := &request.Operation{
  179. Name: opDescribePipelines,
  180. HTTPMethod: "POST",
  181. HTTPPath: "/",
  182. }
  183. if input == nil {
  184. input = &DescribePipelinesInput{}
  185. }
  186. req = c.newRequest(op, input, output)
  187. output = &DescribePipelinesOutput{}
  188. req.Data = output
  189. return
  190. }
  191. // Retrieves metadata about one or more pipelines. The information retrieved
  192. // includes the name of the pipeline, the pipeline identifier, its current state,
  193. // and the user account that owns the pipeline. Using account credentials, you
  194. // can retrieve metadata about pipelines that you or your IAM users have created.
  195. // If you are using an IAM user account, you can retrieve metadata about only
  196. // those pipelines for which you have read permissions.
  197. //
  198. // To retrieve the full pipeline definition instead of metadata about the pipeline,
  199. // call GetPipelineDefinition.
  200. func (c *DataPipeline) DescribePipelines(input *DescribePipelinesInput) (*DescribePipelinesOutput, error) {
  201. req, out := c.DescribePipelinesRequest(input)
  202. err := req.Send()
  203. return out, err
  204. }
  205. const opEvaluateExpression = "EvaluateExpression"
  206. // EvaluateExpressionRequest generates a request for the EvaluateExpression operation.
  207. func (c *DataPipeline) EvaluateExpressionRequest(input *EvaluateExpressionInput) (req *request.Request, output *EvaluateExpressionOutput) {
  208. op := &request.Operation{
  209. Name: opEvaluateExpression,
  210. HTTPMethod: "POST",
  211. HTTPPath: "/",
  212. }
  213. if input == nil {
  214. input = &EvaluateExpressionInput{}
  215. }
  216. req = c.newRequest(op, input, output)
  217. output = &EvaluateExpressionOutput{}
  218. req.Data = output
  219. return
  220. }
  221. // Task runners call EvaluateExpression to evaluate a string in the context
  222. // of the specified object. For example, a task runner can evaluate SQL queries
  223. // stored in Amazon S3.
  224. func (c *DataPipeline) EvaluateExpression(input *EvaluateExpressionInput) (*EvaluateExpressionOutput, error) {
  225. req, out := c.EvaluateExpressionRequest(input)
  226. err := req.Send()
  227. return out, err
  228. }
  229. const opGetPipelineDefinition = "GetPipelineDefinition"
  230. // GetPipelineDefinitionRequest generates a request for the GetPipelineDefinition operation.
  231. func (c *DataPipeline) GetPipelineDefinitionRequest(input *GetPipelineDefinitionInput) (req *request.Request, output *GetPipelineDefinitionOutput) {
  232. op := &request.Operation{
  233. Name: opGetPipelineDefinition,
  234. HTTPMethod: "POST",
  235. HTTPPath: "/",
  236. }
  237. if input == nil {
  238. input = &GetPipelineDefinitionInput{}
  239. }
  240. req = c.newRequest(op, input, output)
  241. output = &GetPipelineDefinitionOutput{}
  242. req.Data = output
  243. return
  244. }
  245. // Gets the definition of the specified pipeline. You can call GetPipelineDefinition
  246. // to retrieve the pipeline definition that you provided using PutPipelineDefinition.
  247. func (c *DataPipeline) GetPipelineDefinition(input *GetPipelineDefinitionInput) (*GetPipelineDefinitionOutput, error) {
  248. req, out := c.GetPipelineDefinitionRequest(input)
  249. err := req.Send()
  250. return out, err
  251. }
  252. const opListPipelines = "ListPipelines"
  253. // ListPipelinesRequest generates a request for the ListPipelines operation.
  254. func (c *DataPipeline) ListPipelinesRequest(input *ListPipelinesInput) (req *request.Request, output *ListPipelinesOutput) {
  255. op := &request.Operation{
  256. Name: opListPipelines,
  257. HTTPMethod: "POST",
  258. HTTPPath: "/",
  259. Paginator: &request.Paginator{
  260. InputTokens: []string{"marker"},
  261. OutputTokens: []string{"marker"},
  262. LimitToken: "",
  263. TruncationToken: "hasMoreResults",
  264. },
  265. }
  266. if input == nil {
  267. input = &ListPipelinesInput{}
  268. }
  269. req = c.newRequest(op, input, output)
  270. output = &ListPipelinesOutput{}
  271. req.Data = output
  272. return
  273. }
  274. // Lists the pipeline identifiers for all active pipelines that you have permission
  275. // to access.
  276. func (c *DataPipeline) ListPipelines(input *ListPipelinesInput) (*ListPipelinesOutput, error) {
  277. req, out := c.ListPipelinesRequest(input)
  278. err := req.Send()
  279. return out, err
  280. }
  281. func (c *DataPipeline) ListPipelinesPages(input *ListPipelinesInput, fn func(p *ListPipelinesOutput, lastPage bool) (shouldContinue bool)) error {
  282. page, _ := c.ListPipelinesRequest(input)
  283. return page.EachPage(func(p interface{}, lastPage bool) bool {
  284. return fn(p.(*ListPipelinesOutput), lastPage)
  285. })
  286. }
  287. const opPollForTask = "PollForTask"
  288. // PollForTaskRequest generates a request for the PollForTask operation.
  289. func (c *DataPipeline) PollForTaskRequest(input *PollForTaskInput) (req *request.Request, output *PollForTaskOutput) {
  290. op := &request.Operation{
  291. Name: opPollForTask,
  292. HTTPMethod: "POST",
  293. HTTPPath: "/",
  294. }
  295. if input == nil {
  296. input = &PollForTaskInput{}
  297. }
  298. req = c.newRequest(op, input, output)
  299. output = &PollForTaskOutput{}
  300. req.Data = output
  301. return
  302. }
  303. // Task runners call PollForTask to receive a task to perform from AWS Data
  304. // Pipeline. The task runner specifies which tasks it can perform by setting
  305. // a value for the workerGroup parameter. The task returned can come from any
  306. // of the pipelines that match the workerGroup value passed in by the task runner
  307. // and that was launched using the IAM user credentials specified by the task
  308. // runner.
  309. //
  310. // If tasks are ready in the work queue, PollForTask returns a response immediately.
  311. // If no tasks are available in the queue, PollForTask uses long-polling and
  312. // holds on to a poll connection for up to a 90 seconds, during which time the
  313. // first newly scheduled task is handed to the task runner. To accomodate this,
  314. // set the socket timeout in your task runner to 90 seconds. The task runner
  315. // should not call PollForTask again on the same workerGroup until it receives
  316. // a response, and this can take up to 90 seconds.
  317. func (c *DataPipeline) PollForTask(input *PollForTaskInput) (*PollForTaskOutput, error) {
  318. req, out := c.PollForTaskRequest(input)
  319. err := req.Send()
  320. return out, err
  321. }
  322. const opPutPipelineDefinition = "PutPipelineDefinition"
  323. // PutPipelineDefinitionRequest generates a request for the PutPipelineDefinition operation.
  324. func (c *DataPipeline) PutPipelineDefinitionRequest(input *PutPipelineDefinitionInput) (req *request.Request, output *PutPipelineDefinitionOutput) {
  325. op := &request.Operation{
  326. Name: opPutPipelineDefinition,
  327. HTTPMethod: "POST",
  328. HTTPPath: "/",
  329. }
  330. if input == nil {
  331. input = &PutPipelineDefinitionInput{}
  332. }
  333. req = c.newRequest(op, input, output)
  334. output = &PutPipelineDefinitionOutput{}
  335. req.Data = output
  336. return
  337. }
  338. // Adds tasks, schedules, and preconditions to the specified pipeline. You can
  339. // use PutPipelineDefinition to populate a new pipeline.
  340. //
  341. // PutPipelineDefinition also validates the configuration as it adds it to
  342. // the pipeline. Changes to the pipeline are saved unless one of the following
  343. // three validation errors exists in the pipeline.
  344. //
  345. // An object is missing a name or identifier field. A string or reference
  346. // field is empty. The number of objects in the pipeline exceeds the maximum
  347. // allowed objects. The pipeline is in a FINISHED state. Pipeline object definitions
  348. // are passed to the PutPipelineDefinition action and returned by the GetPipelineDefinition
  349. // action.
  350. func (c *DataPipeline) PutPipelineDefinition(input *PutPipelineDefinitionInput) (*PutPipelineDefinitionOutput, error) {
  351. req, out := c.PutPipelineDefinitionRequest(input)
  352. err := req.Send()
  353. return out, err
  354. }
  355. const opQueryObjects = "QueryObjects"
  356. // QueryObjectsRequest generates a request for the QueryObjects operation.
  357. func (c *DataPipeline) QueryObjectsRequest(input *QueryObjectsInput) (req *request.Request, output *QueryObjectsOutput) {
  358. op := &request.Operation{
  359. Name: opQueryObjects,
  360. HTTPMethod: "POST",
  361. HTTPPath: "/",
  362. Paginator: &request.Paginator{
  363. InputTokens: []string{"marker"},
  364. OutputTokens: []string{"marker"},
  365. LimitToken: "limit",
  366. TruncationToken: "hasMoreResults",
  367. },
  368. }
  369. if input == nil {
  370. input = &QueryObjectsInput{}
  371. }
  372. req = c.newRequest(op, input, output)
  373. output = &QueryObjectsOutput{}
  374. req.Data = output
  375. return
  376. }
  377. // Queries the specified pipeline for the names of objects that match the specified
  378. // set of conditions.
  379. func (c *DataPipeline) QueryObjects(input *QueryObjectsInput) (*QueryObjectsOutput, error) {
  380. req, out := c.QueryObjectsRequest(input)
  381. err := req.Send()
  382. return out, err
  383. }
  384. func (c *DataPipeline) QueryObjectsPages(input *QueryObjectsInput, fn func(p *QueryObjectsOutput, lastPage bool) (shouldContinue bool)) error {
  385. page, _ := c.QueryObjectsRequest(input)
  386. return page.EachPage(func(p interface{}, lastPage bool) bool {
  387. return fn(p.(*QueryObjectsOutput), lastPage)
  388. })
  389. }
  390. const opRemoveTags = "RemoveTags"
  391. // RemoveTagsRequest generates a request for the RemoveTags operation.
  392. func (c *DataPipeline) RemoveTagsRequest(input *RemoveTagsInput) (req *request.Request, output *RemoveTagsOutput) {
  393. op := &request.Operation{
  394. Name: opRemoveTags,
  395. HTTPMethod: "POST",
  396. HTTPPath: "/",
  397. }
  398. if input == nil {
  399. input = &RemoveTagsInput{}
  400. }
  401. req = c.newRequest(op, input, output)
  402. output = &RemoveTagsOutput{}
  403. req.Data = output
  404. return
  405. }
  406. // Removes existing tags from the specified pipeline.
  407. func (c *DataPipeline) RemoveTags(input *RemoveTagsInput) (*RemoveTagsOutput, error) {
  408. req, out := c.RemoveTagsRequest(input)
  409. err := req.Send()
  410. return out, err
  411. }
  412. const opReportTaskProgress = "ReportTaskProgress"
  413. // ReportTaskProgressRequest generates a request for the ReportTaskProgress operation.
  414. func (c *DataPipeline) ReportTaskProgressRequest(input *ReportTaskProgressInput) (req *request.Request, output *ReportTaskProgressOutput) {
  415. op := &request.Operation{
  416. Name: opReportTaskProgress,
  417. HTTPMethod: "POST",
  418. HTTPPath: "/",
  419. }
  420. if input == nil {
  421. input = &ReportTaskProgressInput{}
  422. }
  423. req = c.newRequest(op, input, output)
  424. output = &ReportTaskProgressOutput{}
  425. req.Data = output
  426. return
  427. }
  428. // Task runners call ReportTaskProgress when assigned a task to acknowledge
  429. // that it has the task. If the web service does not receive this acknowledgement
  430. // within 2 minutes, it assigns the task in a subsequent PollForTask call. After
  431. // this initial acknowledgement, the task runner only needs to report progress
  432. // every 15 minutes to maintain its ownership of the task. You can change this
  433. // reporting time from 15 minutes by specifying a reportProgressTimeout field
  434. // in your pipeline.
  435. //
  436. // If a task runner does not report its status after 5 minutes, AWS Data Pipeline
  437. // assumes that the task runner is unable to process the task and reassigns
  438. // the task in a subsequent response to PollForTask. Task runners should call
  439. // ReportTaskProgress every 60 seconds.
  440. func (c *DataPipeline) ReportTaskProgress(input *ReportTaskProgressInput) (*ReportTaskProgressOutput, error) {
  441. req, out := c.ReportTaskProgressRequest(input)
  442. err := req.Send()
  443. return out, err
  444. }
  445. const opReportTaskRunnerHeartbeat = "ReportTaskRunnerHeartbeat"
  446. // ReportTaskRunnerHeartbeatRequest generates a request for the ReportTaskRunnerHeartbeat operation.
  447. func (c *DataPipeline) ReportTaskRunnerHeartbeatRequest(input *ReportTaskRunnerHeartbeatInput) (req *request.Request, output *ReportTaskRunnerHeartbeatOutput) {
  448. op := &request.Operation{
  449. Name: opReportTaskRunnerHeartbeat,
  450. HTTPMethod: "POST",
  451. HTTPPath: "/",
  452. }
  453. if input == nil {
  454. input = &ReportTaskRunnerHeartbeatInput{}
  455. }
  456. req = c.newRequest(op, input, output)
  457. output = &ReportTaskRunnerHeartbeatOutput{}
  458. req.Data = output
  459. return
  460. }
  461. // Task runners call ReportTaskRunnerHeartbeat every 15 minutes to indicate
  462. // that they are operational. If the AWS Data Pipeline Task Runner is launched
  463. // on a resource managed by AWS Data Pipeline, the web service can use this
  464. // call to detect when the task runner application has failed and restart a
  465. // new instance.
  466. func (c *DataPipeline) ReportTaskRunnerHeartbeat(input *ReportTaskRunnerHeartbeatInput) (*ReportTaskRunnerHeartbeatOutput, error) {
  467. req, out := c.ReportTaskRunnerHeartbeatRequest(input)
  468. err := req.Send()
  469. return out, err
  470. }
  471. const opSetStatus = "SetStatus"
  472. // SetStatusRequest generates a request for the SetStatus operation.
  473. func (c *DataPipeline) SetStatusRequest(input *SetStatusInput) (req *request.Request, output *SetStatusOutput) {
  474. op := &request.Operation{
  475. Name: opSetStatus,
  476. HTTPMethod: "POST",
  477. HTTPPath: "/",
  478. }
  479. if input == nil {
  480. input = &SetStatusInput{}
  481. }
  482. req = c.newRequest(op, input, output)
  483. output = &SetStatusOutput{}
  484. req.Data = output
  485. return
  486. }
  487. // Requests that the status of the specified physical or logical pipeline objects
  488. // be updated in the specified pipeline. This update might not occur immediately,
  489. // but is eventually consistent. The status that can be set depends on the type
  490. // of object (for example, DataNode or Activity). You cannot perform this operation
  491. // on FINISHED pipelines and attempting to do so returns InvalidRequestException.
  492. func (c *DataPipeline) SetStatus(input *SetStatusInput) (*SetStatusOutput, error) {
  493. req, out := c.SetStatusRequest(input)
  494. err := req.Send()
  495. return out, err
  496. }
  497. const opSetTaskStatus = "SetTaskStatus"
  498. // SetTaskStatusRequest generates a request for the SetTaskStatus operation.
  499. func (c *DataPipeline) SetTaskStatusRequest(input *SetTaskStatusInput) (req *request.Request, output *SetTaskStatusOutput) {
  500. op := &request.Operation{
  501. Name: opSetTaskStatus,
  502. HTTPMethod: "POST",
  503. HTTPPath: "/",
  504. }
  505. if input == nil {
  506. input = &SetTaskStatusInput{}
  507. }
  508. req = c.newRequest(op, input, output)
  509. output = &SetTaskStatusOutput{}
  510. req.Data = output
  511. return
  512. }
  513. // Task runners call SetTaskStatus to notify AWS Data Pipeline that a task is
  514. // completed and provide information about the final status. A task runner makes
  515. // this call regardless of whether the task was sucessful. A task runner does
  516. // not need to call SetTaskStatus for tasks that are canceled by the web service
  517. // during a call to ReportTaskProgress.
  518. func (c *DataPipeline) SetTaskStatus(input *SetTaskStatusInput) (*SetTaskStatusOutput, error) {
  519. req, out := c.SetTaskStatusRequest(input)
  520. err := req.Send()
  521. return out, err
  522. }
  523. const opValidatePipelineDefinition = "ValidatePipelineDefinition"
  524. // ValidatePipelineDefinitionRequest generates a request for the ValidatePipelineDefinition operation.
  525. func (c *DataPipeline) ValidatePipelineDefinitionRequest(input *ValidatePipelineDefinitionInput) (req *request.Request, output *ValidatePipelineDefinitionOutput) {
  526. op := &request.Operation{
  527. Name: opValidatePipelineDefinition,
  528. HTTPMethod: "POST",
  529. HTTPPath: "/",
  530. }
  531. if input == nil {
  532. input = &ValidatePipelineDefinitionInput{}
  533. }
  534. req = c.newRequest(op, input, output)
  535. output = &ValidatePipelineDefinitionOutput{}
  536. req.Data = output
  537. return
  538. }
  539. // Validates the specified pipeline definition to ensure that it is well formed
  540. // and can be run without error.
  541. func (c *DataPipeline) ValidatePipelineDefinition(input *ValidatePipelineDefinitionInput) (*ValidatePipelineDefinitionOutput, error) {
  542. req, out := c.ValidatePipelineDefinitionRequest(input)
  543. err := req.Send()
  544. return out, err
  545. }
  546. // Contains the parameters for ActivatePipeline.
  547. type ActivatePipelineInput struct {
  548. // A list of parameter values to pass to the pipeline at activation.
  549. ParameterValues []*ParameterValue `locationName:"parameterValues" type:"list"`
  550. // The ID of the pipeline.
  551. PipelineId *string `locationName:"pipelineId" type:"string" required:"true"`
  552. // The date and time to resume the pipeline. By default, the pipeline resumes
  553. // from the last completed execution.
  554. StartTimestamp *time.Time `locationName:"startTimestamp" type:"timestamp" timestampFormat:"unix"`
  555. metadataActivatePipelineInput `json:"-" xml:"-"`
  556. }
  557. type metadataActivatePipelineInput struct {
  558. SDKShapeTraits bool `type:"structure"`
  559. }
  560. // String returns the string representation
  561. func (s ActivatePipelineInput) String() string {
  562. return awsutil.Prettify(s)
  563. }
  564. // GoString returns the string representation
  565. func (s ActivatePipelineInput) GoString() string {
  566. return s.String()
  567. }
  568. // Contains the output of ActivatePipeline.
  569. type ActivatePipelineOutput struct {
  570. metadataActivatePipelineOutput `json:"-" xml:"-"`
  571. }
  572. type metadataActivatePipelineOutput struct {
  573. SDKShapeTraits bool `type:"structure"`
  574. }
  575. // String returns the string representation
  576. func (s ActivatePipelineOutput) String() string {
  577. return awsutil.Prettify(s)
  578. }
  579. // GoString returns the string representation
  580. func (s ActivatePipelineOutput) GoString() string {
  581. return s.String()
  582. }
  583. // Contains the parameters for AddTags.
  584. type AddTagsInput struct {
  585. // The ID of the pipeline.
  586. PipelineId *string `locationName:"pipelineId" type:"string" required:"true"`
  587. // The tags to add, as key/value pairs.
  588. Tags []*Tag `locationName:"tags" type:"list" required:"true"`
  589. metadataAddTagsInput `json:"-" xml:"-"`
  590. }
  591. type metadataAddTagsInput struct {
  592. SDKShapeTraits bool `type:"structure"`
  593. }
  594. // String returns the string representation
  595. func (s AddTagsInput) String() string {
  596. return awsutil.Prettify(s)
  597. }
  598. // GoString returns the string representation
  599. func (s AddTagsInput) GoString() string {
  600. return s.String()
  601. }
  602. // Contains the output of AddTags.
  603. type AddTagsOutput struct {
  604. metadataAddTagsOutput `json:"-" xml:"-"`
  605. }
  606. type metadataAddTagsOutput struct {
  607. SDKShapeTraits bool `type:"structure"`
  608. }
  609. // String returns the string representation
  610. func (s AddTagsOutput) String() string {
  611. return awsutil.Prettify(s)
  612. }
  613. // GoString returns the string representation
  614. func (s AddTagsOutput) GoString() string {
  615. return s.String()
  616. }
  617. // Contains the parameters for CreatePipeline.
  618. type CreatePipelineInput struct {
  619. // The description for the pipeline.
  620. Description *string `locationName:"description" type:"string"`
  621. // The name for the pipeline. You can use the same name for multiple pipelines
  622. // associated with your AWS account, because AWS Data Pipeline assigns each
  623. // pipeline a unique pipeline identifier.
  624. Name *string `locationName:"name" type:"string" required:"true"`
  625. // A list of tags to associate with the pipeline at creation. Tags let you control
  626. // access to pipelines. For more information, see Controlling User Access to
  627. // Pipelines (http://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-control-access.html)
  628. // in the AWS Data Pipeline Developer Guide.
  629. Tags []*Tag `locationName:"tags" type:"list"`
  630. // A unique identifier. This identifier is not the same as the pipeline identifier
  631. // assigned by AWS Data Pipeline. You are responsible for defining the format
  632. // and ensuring the uniqueness of this identifier. You use this parameter to
  633. // ensure idempotency during repeated calls to CreatePipeline. For example,
  634. // if the first call to CreatePipeline does not succeed, you can pass in the
  635. // same unique identifier and pipeline name combination on a subsequent call
  636. // to CreatePipeline. CreatePipeline ensures that if a pipeline already exists
  637. // with the same name and unique identifier, a new pipeline is not created.
  638. // Instead, you'll receive the pipeline identifier from the previous attempt.
  639. // The uniqueness of the name and unique identifier combination is scoped to
  640. // the AWS account or IAM user credentials.
  641. UniqueId *string `locationName:"uniqueId" type:"string" required:"true"`
  642. metadataCreatePipelineInput `json:"-" xml:"-"`
  643. }
  644. type metadataCreatePipelineInput struct {
  645. SDKShapeTraits bool `type:"structure"`
  646. }
  647. // String returns the string representation
  648. func (s CreatePipelineInput) String() string {
  649. return awsutil.Prettify(s)
  650. }
  651. // GoString returns the string representation
  652. func (s CreatePipelineInput) GoString() string {
  653. return s.String()
  654. }
  655. // Contains the output of CreatePipeline.
  656. type CreatePipelineOutput struct {
  657. // The ID that AWS Data Pipeline assigns the newly created pipeline. For example,
  658. // df-06372391ZG65EXAMPLE.
  659. PipelineId *string `locationName:"pipelineId" type:"string" required:"true"`
  660. metadataCreatePipelineOutput `json:"-" xml:"-"`
  661. }
  662. type metadataCreatePipelineOutput struct {
  663. SDKShapeTraits bool `type:"structure"`
  664. }
  665. // String returns the string representation
  666. func (s CreatePipelineOutput) String() string {
  667. return awsutil.Prettify(s)
  668. }
  669. // GoString returns the string representation
  670. func (s CreatePipelineOutput) GoString() string {
  671. return s.String()
  672. }
  673. // Contains the parameters for DeactivatePipeline.
  674. type DeactivatePipelineInput struct {
  675. // Indicates whether to cancel any running objects. The default is true, which
  676. // sets the state of any running objects to CANCELED. If this value is false,
  677. // the pipeline is deactivated after all running objects finish.
  678. CancelActive *bool `locationName:"cancelActive" type:"boolean"`
  679. // The ID of the pipeline.
  680. PipelineId *string `locationName:"pipelineId" type:"string" required:"true"`
  681. metadataDeactivatePipelineInput `json:"-" xml:"-"`
  682. }
  683. type metadataDeactivatePipelineInput struct {
  684. SDKShapeTraits bool `type:"structure"`
  685. }
  686. // String returns the string representation
  687. func (s DeactivatePipelineInput) String() string {
  688. return awsutil.Prettify(s)
  689. }
  690. // GoString returns the string representation
  691. func (s DeactivatePipelineInput) GoString() string {
  692. return s.String()
  693. }
  694. // Contains the output of DeactivatePipeline.
  695. type DeactivatePipelineOutput struct {
  696. metadataDeactivatePipelineOutput `json:"-" xml:"-"`
  697. }
  698. type metadataDeactivatePipelineOutput struct {
  699. SDKShapeTraits bool `type:"structure"`
  700. }
  701. // String returns the string representation
  702. func (s DeactivatePipelineOutput) String() string {
  703. return awsutil.Prettify(s)
  704. }
  705. // GoString returns the string representation
  706. func (s DeactivatePipelineOutput) GoString() string {
  707. return s.String()
  708. }
  709. // Contains the parameters for DeletePipeline.
  710. type DeletePipelineInput struct {
  711. // The ID of the pipeline.
  712. PipelineId *string `locationName:"pipelineId" type:"string" required:"true"`
  713. metadataDeletePipelineInput `json:"-" xml:"-"`
  714. }
  715. type metadataDeletePipelineInput struct {
  716. SDKShapeTraits bool `type:"structure"`
  717. }
  718. // String returns the string representation
  719. func (s DeletePipelineInput) String() string {
  720. return awsutil.Prettify(s)
  721. }
  722. // GoString returns the string representation
  723. func (s DeletePipelineInput) GoString() string {
  724. return s.String()
  725. }
  726. type DeletePipelineOutput struct {
  727. metadataDeletePipelineOutput `json:"-" xml:"-"`
  728. }
  729. type metadataDeletePipelineOutput struct {
  730. SDKShapeTraits bool `type:"structure"`
  731. }
  732. // String returns the string representation
  733. func (s DeletePipelineOutput) String() string {
  734. return awsutil.Prettify(s)
  735. }
  736. // GoString returns the string representation
  737. func (s DeletePipelineOutput) GoString() string {
  738. return s.String()
  739. }
  740. // Contains the parameters for DescribeObjects.
  741. type DescribeObjectsInput struct {
  742. // Indicates whether any expressions in the object should be evaluated when
  743. // the object descriptions are returned.
  744. EvaluateExpressions *bool `locationName:"evaluateExpressions" type:"boolean"`
  745. // The starting point for the results to be returned. For the first call, this
  746. // value should be empty. As long as there are more results, continue to call
  747. // DescribeObjects with the marker value from the previous call to retrieve
  748. // the next set of results.
  749. Marker *string `locationName:"marker" type:"string"`
  750. // The IDs of the pipeline objects that contain the definitions to be described.
  751. // You can pass as many as 25 identifiers in a single call to DescribeObjects.
  752. ObjectIds []*string `locationName:"objectIds" type:"list" required:"true"`
  753. // The ID of the pipeline that contains the object definitions.
  754. PipelineId *string `locationName:"pipelineId" type:"string" required:"true"`
  755. metadataDescribeObjectsInput `json:"-" xml:"-"`
  756. }
  757. type metadataDescribeObjectsInput struct {
  758. SDKShapeTraits bool `type:"structure"`
  759. }
  760. // String returns the string representation
  761. func (s DescribeObjectsInput) String() string {
  762. return awsutil.Prettify(s)
  763. }
  764. // GoString returns the string representation
  765. func (s DescribeObjectsInput) GoString() string {
  766. return s.String()
  767. }
  768. // Contains the output of DescribeObjects.
  769. type DescribeObjectsOutput struct {
  770. // Indicates whether there are more results to return.
  771. HasMoreResults *bool `locationName:"hasMoreResults" type:"boolean"`
  772. // The starting point for the next page of results. To view the next page of
  773. // results, call DescribeObjects again with this marker value. If the value
  774. // is null, there are no more results.
  775. Marker *string `locationName:"marker" type:"string"`
  776. // An array of object definitions.
  777. PipelineObjects []*PipelineObject `locationName:"pipelineObjects" type:"list" required:"true"`
  778. metadataDescribeObjectsOutput `json:"-" xml:"-"`
  779. }
  780. type metadataDescribeObjectsOutput struct {
  781. SDKShapeTraits bool `type:"structure"`
  782. }
  783. // String returns the string representation
  784. func (s DescribeObjectsOutput) String() string {
  785. return awsutil.Prettify(s)
  786. }
  787. // GoString returns the string representation
  788. func (s DescribeObjectsOutput) GoString() string {
  789. return s.String()
  790. }
  791. // Contains the parameters for DescribePipelines.
  792. type DescribePipelinesInput struct {
  793. // The IDs of the pipelines to describe. You can pass as many as 25 identifiers
  794. // in a single call. To obtain pipeline IDs, call ListPipelines.
  795. PipelineIds []*string `locationName:"pipelineIds" type:"list" required:"true"`
  796. metadataDescribePipelinesInput `json:"-" xml:"-"`
  797. }
  798. type metadataDescribePipelinesInput struct {
  799. SDKShapeTraits bool `type:"structure"`
  800. }
  801. // String returns the string representation
  802. func (s DescribePipelinesInput) String() string {
  803. return awsutil.Prettify(s)
  804. }
  805. // GoString returns the string representation
  806. func (s DescribePipelinesInput) GoString() string {
  807. return s.String()
  808. }
  809. // Contains the output of DescribePipelines.
  810. type DescribePipelinesOutput struct {
  811. // An array of descriptions for the specified pipelines.
  812. PipelineDescriptionList []*PipelineDescription `locationName:"pipelineDescriptionList" type:"list" required:"true"`
  813. metadataDescribePipelinesOutput `json:"-" xml:"-"`
  814. }
  815. type metadataDescribePipelinesOutput struct {
  816. SDKShapeTraits bool `type:"structure"`
  817. }
  818. // String returns the string representation
  819. func (s DescribePipelinesOutput) String() string {
  820. return awsutil.Prettify(s)
  821. }
  822. // GoString returns the string representation
  823. func (s DescribePipelinesOutput) GoString() string {
  824. return s.String()
  825. }
  826. // Contains the parameters for EvaluateExpression.
  827. type EvaluateExpressionInput struct {
  828. // The expression to evaluate.
  829. Expression *string `locationName:"expression" type:"string" required:"true"`
  830. // The ID of the object.
  831. ObjectId *string `locationName:"objectId" type:"string" required:"true"`
  832. // The ID of the pipeline.
  833. PipelineId *string `locationName:"pipelineId" type:"string" required:"true"`
  834. metadataEvaluateExpressionInput `json:"-" xml:"-"`
  835. }
  836. type metadataEvaluateExpressionInput struct {
  837. SDKShapeTraits bool `type:"structure"`
  838. }
  839. // String returns the string representation
  840. func (s EvaluateExpressionInput) String() string {
  841. return awsutil.Prettify(s)
  842. }
  843. // GoString returns the string representation
  844. func (s EvaluateExpressionInput) GoString() string {
  845. return s.String()
  846. }
  847. // Contains the output of EvaluateExpression.
  848. type EvaluateExpressionOutput struct {
  849. // The evaluated expression.
  850. EvaluatedExpression *string `locationName:"evaluatedExpression" type:"string" required:"true"`
  851. metadataEvaluateExpressionOutput `json:"-" xml:"-"`
  852. }
  853. type metadataEvaluateExpressionOutput struct {
  854. SDKShapeTraits bool `type:"structure"`
  855. }
  856. // String returns the string representation
  857. func (s EvaluateExpressionOutput) String() string {
  858. return awsutil.Prettify(s)
  859. }
  860. // GoString returns the string representation
  861. func (s EvaluateExpressionOutput) GoString() string {
  862. return s.String()
  863. }
  864. // A key-value pair that describes a property of a pipeline object. The value
  865. // is specified as either a string value (StringValue) or a reference to another
  866. // object (RefValue) but not as both.
  867. type Field struct {
  868. // The field identifier.
  869. Key *string `locationName:"key" type:"string" required:"true"`
  870. // The field value, expressed as the identifier of another object.
  871. RefValue *string `locationName:"refValue" type:"string"`
  872. // The field value, expressed as a String.
  873. StringValue *string `locationName:"stringValue" type:"string"`
  874. metadataField `json:"-" xml:"-"`
  875. }
  876. type metadataField struct {
  877. SDKShapeTraits bool `type:"structure"`
  878. }
  879. // String returns the string representation
  880. func (s Field) String() string {
  881. return awsutil.Prettify(s)
  882. }
  883. // GoString returns the string representation
  884. func (s Field) GoString() string {
  885. return s.String()
  886. }
  887. // Contains the parameters for GetPipelineDefinition.
  888. type GetPipelineDefinitionInput struct {
  889. // The ID of the pipeline.
  890. PipelineId *string `locationName:"pipelineId" type:"string" required:"true"`
  891. // The version of the pipeline definition to retrieve. Set this parameter to
  892. // latest (default) to use the last definition saved to the pipeline or active
  893. // to use the last definition that was activated.
  894. Version *string `locationName:"version" type:"string"`
  895. metadataGetPipelineDefinitionInput `json:"-" xml:"-"`
  896. }
  897. type metadataGetPipelineDefinitionInput struct {
  898. SDKShapeTraits bool `type:"structure"`
  899. }
  900. // String returns the string representation
  901. func (s GetPipelineDefinitionInput) String() string {
  902. return awsutil.Prettify(s)
  903. }
  904. // GoString returns the string representation
  905. func (s GetPipelineDefinitionInput) GoString() string {
  906. return s.String()
  907. }
  908. // Contains the output of GetPipelineDefinition.
  909. type GetPipelineDefinitionOutput struct {
  910. // The parameter objects used in the pipeline definition.
  911. ParameterObjects []*ParameterObject `locationName:"parameterObjects" type:"list"`
  912. // The parameter values used in the pipeline definition.
  913. ParameterValues []*ParameterValue `locationName:"parameterValues" type:"list"`
  914. // The objects defined in the pipeline.
  915. PipelineObjects []*PipelineObject `locationName:"pipelineObjects" type:"list"`
  916. metadataGetPipelineDefinitionOutput `json:"-" xml:"-"`
  917. }
  918. type metadataGetPipelineDefinitionOutput struct {
  919. SDKShapeTraits bool `type:"structure"`
  920. }
  921. // String returns the string representation
  922. func (s GetPipelineDefinitionOutput) String() string {
  923. return awsutil.Prettify(s)
  924. }
  925. // GoString returns the string representation
  926. func (s GetPipelineDefinitionOutput) GoString() string {
  927. return s.String()
  928. }
  929. // Identity information for the EC2 instance that is hosting the task runner.
  930. // You can get this value by calling a metadata URI from the EC2 instance. For
  931. // more information, see Instance Metadata (http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AESDG-chapter-instancedata.html)
  932. // in the Amazon Elastic Compute Cloud User Guide. Passing in this value proves
  933. // that your task runner is running on an EC2 instance, and ensures the proper
  934. // AWS Data Pipeline service charges are applied to your pipeline.
  935. type InstanceIdentity struct {
  936. // A description of an EC2 instance that is generated when the instance is launched
  937. // and exposed to the instance via the instance metadata service in the form
  938. // of a JSON representation of an object.
  939. Document *string `locationName:"document" type:"string"`
  940. // A signature which can be used to verify the accuracy and authenticity of
  941. // the information provided in the instance identity document.
  942. Signature *string `locationName:"signature" type:"string"`
  943. metadataInstanceIdentity `json:"-" xml:"-"`
  944. }
  945. type metadataInstanceIdentity struct {
  946. SDKShapeTraits bool `type:"structure"`
  947. }
  948. // String returns the string representation
  949. func (s InstanceIdentity) String() string {
  950. return awsutil.Prettify(s)
  951. }
  952. // GoString returns the string representation
  953. func (s InstanceIdentity) GoString() string {
  954. return s.String()
  955. }
  956. // Contains the parameters for ListPipelines.
  957. type ListPipelinesInput struct {
  958. // The starting point for the results to be returned. For the first call, this
  959. // value should be empty. As long as there are more results, continue to call
  960. // ListPipelines with the marker value from the previous call to retrieve the
  961. // next set of results.
  962. Marker *string `locationName:"marker" type:"string"`
  963. metadataListPipelinesInput `json:"-" xml:"-"`
  964. }
  965. type metadataListPipelinesInput struct {
  966. SDKShapeTraits bool `type:"structure"`
  967. }
  968. // String returns the string representation
  969. func (s ListPipelinesInput) String() string {
  970. return awsutil.Prettify(s)
  971. }
  972. // GoString returns the string representation
  973. func (s ListPipelinesInput) GoString() string {
  974. return s.String()
  975. }
  976. // Contains the output of ListPipelines.
  977. type ListPipelinesOutput struct {
  978. // Indicates whether there are more results that can be obtained by a subsequent
  979. // call.
  980. HasMoreResults *bool `locationName:"hasMoreResults" type:"boolean"`
  981. // The starting point for the next page of results. To view the next page of
  982. // results, call ListPipelinesOutput again with this marker value. If the value
  983. // is null, there are no more results.
  984. Marker *string `locationName:"marker" type:"string"`
  985. // The pipeline identifiers. If you require additional information about the
  986. // pipelines, you can use these identifiers to call DescribePipelines and GetPipelineDefinition.
  987. PipelineIdList []*PipelineIdName `locationName:"pipelineIdList" type:"list" required:"true"`
  988. metadataListPipelinesOutput `json:"-" xml:"-"`
  989. }
  990. type metadataListPipelinesOutput struct {
  991. SDKShapeTraits bool `type:"structure"`
  992. }
  993. // String returns the string representation
  994. func (s ListPipelinesOutput) String() string {
  995. return awsutil.Prettify(s)
  996. }
  997. // GoString returns the string representation
  998. func (s ListPipelinesOutput) GoString() string {
  999. return s.String()
  1000. }
  1001. // Contains a logical operation for comparing the value of a field with a specified
  1002. // value.
  1003. type Operator struct {
  1004. // The logical operation to be performed: equal (EQ), equal reference (REF_EQ),
  1005. // less than or equal (LE), greater than or equal (GE), or between (BETWEEN).
  1006. // Equal reference (REF_EQ) can be used only with reference fields. The other
  1007. // comparison types can be used only with String fields. The comparison types
  1008. // you can use apply only to certain object fields, as detailed below.
  1009. //
  1010. // The comparison operators EQ and REF_EQ act on the following fields:
  1011. //
  1012. // name @sphere parent @componentParent @instanceParent @status @scheduledStartTime
  1013. // @scheduledEndTime @actualStartTime @actualEndTime The comparison operators
  1014. // GE, LE, and BETWEEN act on the following fields:
  1015. //
  1016. // @scheduledStartTime @scheduledEndTime @actualStartTime @actualEndTime
  1017. // Note that fields beginning with the at sign (@) are read-only and set by
  1018. // the web service. When you name fields, you should choose names containing
  1019. // only alpha-numeric values, as symbols may be reserved by AWS Data Pipeline.
  1020. // User-defined fields that you add to a pipeline should prefix their name with
  1021. // the string "my".
  1022. Type *string `locationName:"type" type:"string" enum:"OperatorType"`
  1023. // The value that the actual field value will be compared with.
  1024. Values []*string `locationName:"values" type:"list"`
  1025. metadataOperator `json:"-" xml:"-"`
  1026. }
  1027. type metadataOperator struct {
  1028. SDKShapeTraits bool `type:"structure"`
  1029. }
  1030. // String returns the string representation
  1031. func (s Operator) String() string {
  1032. return awsutil.Prettify(s)
  1033. }
  1034. // GoString returns the string representation
  1035. func (s Operator) GoString() string {
  1036. return s.String()
  1037. }
  1038. // The attributes allowed or specified with a parameter object.
  1039. type ParameterAttribute struct {
  1040. // The field identifier.
  1041. Key *string `locationName:"key" type:"string" required:"true"`
  1042. // The field value, expressed as a String.
  1043. StringValue *string `locationName:"stringValue" type:"string" required:"true"`
  1044. metadataParameterAttribute `json:"-" xml:"-"`
  1045. }
  1046. type metadataParameterAttribute struct {
  1047. SDKShapeTraits bool `type:"structure"`
  1048. }
  1049. // String returns the string representation
  1050. func (s ParameterAttribute) String() string {
  1051. return awsutil.Prettify(s)
  1052. }
  1053. // GoString returns the string representation
  1054. func (s ParameterAttribute) GoString() string {
  1055. return s.String()
  1056. }
  1057. // Contains information about a parameter object.
  1058. type ParameterObject struct {
  1059. // The attributes of the parameter object.
  1060. Attributes []*ParameterAttribute `locationName:"attributes" type:"list" required:"true"`
  1061. // The ID of the parameter object.
  1062. Id *string `locationName:"id" type:"string" required:"true"`
  1063. metadataParameterObject `json:"-" xml:"-"`
  1064. }
  1065. type metadataParameterObject struct {
  1066. SDKShapeTraits bool `type:"structure"`
  1067. }
  1068. // String returns the string representation
  1069. func (s ParameterObject) String() string {
  1070. return awsutil.Prettify(s)
  1071. }
  1072. // GoString returns the string representation
  1073. func (s ParameterObject) GoString() string {
  1074. return s.String()
  1075. }
  1076. // A value or list of parameter values.
  1077. type ParameterValue struct {
  1078. // The ID of the parameter value.
  1079. Id *string `locationName:"id" type:"string" required:"true"`
  1080. // The field value, expressed as a String.
  1081. StringValue *string `locationName:"stringValue" type:"string" required:"true"`
  1082. metadataParameterValue `json:"-" xml:"-"`
  1083. }
  1084. type metadataParameterValue struct {
  1085. SDKShapeTraits bool `type:"structure"`
  1086. }
  1087. // String returns the string representation
  1088. func (s ParameterValue) String() string {
  1089. return awsutil.Prettify(s)
  1090. }
  1091. // GoString returns the string representation
  1092. func (s ParameterValue) GoString() string {
  1093. return s.String()
  1094. }
  1095. // Contains pipeline metadata.
  1096. type PipelineDescription struct {
  1097. // Description of the pipeline.
  1098. Description *string `locationName:"description" type:"string"`
  1099. // A list of read-only fields that contain metadata about the pipeline: @userId,
  1100. // @accountId, and @pipelineState.
  1101. Fields []*Field `locationName:"fields" type:"list" required:"true"`
  1102. // The name of the pipeline.
  1103. Name *string `locationName:"name" type:"string" required:"true"`
  1104. // The pipeline identifier that was assigned by AWS Data Pipeline. This is a
  1105. // string of the form df-297EG78HU43EEXAMPLE.
  1106. PipelineId *string `locationName:"pipelineId" type:"string" required:"true"`
  1107. // A list of tags to associated with a pipeline. Tags let you control access
  1108. // to pipelines. For more information, see Controlling User Access to Pipelines
  1109. // (http://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-control-access.html)
  1110. // in the AWS Data Pipeline Developer Guide.
  1111. Tags []*Tag `locationName:"tags" type:"list"`
  1112. metadataPipelineDescription `json:"-" xml:"-"`
  1113. }
  1114. type metadataPipelineDescription struct {
  1115. SDKShapeTraits bool `type:"structure"`
  1116. }
  1117. // String returns the string representation
  1118. func (s PipelineDescription) String() string {
  1119. return awsutil.Prettify(s)
  1120. }
  1121. // GoString returns the string representation
  1122. func (s PipelineDescription) GoString() string {
  1123. return s.String()
  1124. }
  1125. // Contains the name and identifier of a pipeline.
  1126. type PipelineIdName struct {
  1127. // The ID of the pipeline that was assigned by AWS Data Pipeline. This is a
  1128. // string of the form df-297EG78HU43EEXAMPLE.
  1129. Id *string `locationName:"id" type:"string"`
  1130. // The name of the pipeline.
  1131. Name *string `locationName:"name" type:"string"`
  1132. metadataPipelineIdName `json:"-" xml:"-"`
  1133. }
  1134. type metadataPipelineIdName struct {
  1135. SDKShapeTraits bool `type:"structure"`
  1136. }
  1137. // String returns the string representation
  1138. func (s PipelineIdName) String() string {
  1139. return awsutil.Prettify(s)
  1140. }
  1141. // GoString returns the string representation
  1142. func (s PipelineIdName) GoString() string {
  1143. return s.String()
  1144. }
  1145. // Contains information about a pipeline object. This can be a logical, physical,
  1146. // or physical attempt pipeline object. The complete set of components of a
  1147. // pipeline defines the pipeline.
  1148. type PipelineObject struct {
  1149. // Key-value pairs that define the properties of the object.
  1150. Fields []*Field `locationName:"fields" type:"list" required:"true"`
  1151. // The ID of the object.
  1152. Id *string `locationName:"id" type:"string" required:"true"`
  1153. // The name of the object.
  1154. Name *string `locationName:"name" type:"string" required:"true"`
  1155. metadataPipelineObject `json:"-" xml:"-"`
  1156. }
  1157. type metadataPipelineObject struct {
  1158. SDKShapeTraits bool `type:"structure"`
  1159. }
  1160. // String returns the string representation
  1161. func (s PipelineObject) String() string {
  1162. return awsutil.Prettify(s)
  1163. }
  1164. // GoString returns the string representation
  1165. func (s PipelineObject) GoString() string {
  1166. return s.String()
  1167. }
  1168. // Contains the parameters for PollForTask.
  1169. type PollForTaskInput struct {
  1170. // The public DNS name of the calling task runner.
  1171. Hostname *string `locationName:"hostname" type:"string"`
  1172. // Identity information for the EC2 instance that is hosting the task runner.
  1173. // You can get this value from the instance using http://169.254.169.254/latest/meta-data/instance-id.
  1174. // For more information, see Instance Metadata (http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AESDG-chapter-instancedata.html)
  1175. // in the Amazon Elastic Compute Cloud User Guide. Passing in this value proves
  1176. // that your task runner is running on an EC2 instance, and ensures the proper
  1177. // AWS Data Pipeline service charges are applied to your pipeline.
  1178. InstanceIdentity *InstanceIdentity `locationName:"instanceIdentity" type:"structure"`
  1179. // The type of task the task runner is configured to accept and process. The
  1180. // worker group is set as a field on objects in the pipeline when they are created.
  1181. // You can only specify a single value for workerGroup in the call to PollForTask.
  1182. // There are no wildcard values permitted in workerGroup; the string must be
  1183. // an exact, case-sensitive, match.
  1184. WorkerGroup *string `locationName:"workerGroup" type:"string" required:"true"`
  1185. metadataPollForTaskInput `json:"-" xml:"-"`
  1186. }
  1187. type metadataPollForTaskInput struct {
  1188. SDKShapeTraits bool `type:"structure"`
  1189. }
  1190. // String returns the string representation
  1191. func (s PollForTaskInput) String() string {
  1192. return awsutil.Prettify(s)
  1193. }
  1194. // GoString returns the string representation
  1195. func (s PollForTaskInput) GoString() string {
  1196. return s.String()
  1197. }
  1198. // Contains the output of PollForTask.
  1199. type PollForTaskOutput struct {
  1200. // The information needed to complete the task that is being assigned to the
  1201. // task runner. One of the fields returned in this object is taskId, which contains
  1202. // an identifier for the task being assigned. The calling task runner uses taskId
  1203. // in subsequent calls to ReportTaskProgress and SetTaskStatus.
  1204. TaskObject *TaskObject `locationName:"taskObject" type:"structure"`
  1205. metadataPollForTaskOutput `json:"-" xml:"-"`
  1206. }
  1207. type metadataPollForTaskOutput struct {
  1208. SDKShapeTraits bool `type:"structure"`
  1209. }
  1210. // String returns the string representation
  1211. func (s PollForTaskOutput) String() string {
  1212. return awsutil.Prettify(s)
  1213. }
  1214. // GoString returns the string representation
  1215. func (s PollForTaskOutput) GoString() string {
  1216. return s.String()
  1217. }
  1218. // Contains the parameters for PutPipelineDefinition.
  1219. type PutPipelineDefinitionInput struct {
  1220. // The parameter objects used with the pipeline.
  1221. ParameterObjects []*ParameterObject `locationName:"parameterObjects" type:"list"`
  1222. // The parameter values used with the pipeline.
  1223. ParameterValues []*ParameterValue `locationName:"parameterValues" type:"list"`
  1224. // The ID of the pipeline.
  1225. PipelineId *string `locationName:"pipelineId" type:"string" required:"true"`
  1226. // The objects that define the pipeline. These objects overwrite the existing
  1227. // pipeline definition.
  1228. PipelineObjects []*PipelineObject `locationName:"pipelineObjects" type:"list" required:"true"`
  1229. metadataPutPipelineDefinitionInput `json:"-" xml:"-"`
  1230. }
  1231. type metadataPutPipelineDefinitionInput struct {
  1232. SDKShapeTraits bool `type:"structure"`
  1233. }
  1234. // String returns the string representation
  1235. func (s PutPipelineDefinitionInput) String() string {
  1236. return awsutil.Prettify(s)
  1237. }
  1238. // GoString returns the string representation
  1239. func (s PutPipelineDefinitionInput) GoString() string {
  1240. return s.String()
  1241. }
  1242. // Contains the output of PutPipelineDefinition.
  1243. type PutPipelineDefinitionOutput struct {
  1244. // Indicates whether there were validation errors, and the pipeline definition
  1245. // is stored but cannot be activated until you correct the pipeline and call
  1246. // PutPipelineDefinition to commit the corrected pipeline.
  1247. Errored *bool `locationName:"errored" type:"boolean" required:"true"`
  1248. // The validation errors that are associated with the objects defined in pipelineObjects.
  1249. ValidationErrors []*ValidationError `locationName:"validationErrors" type:"list"`
  1250. // The validation warnings that are associated with the objects defined in pipelineObjects.
  1251. ValidationWarnings []*ValidationWarning `locationName:"validationWarnings" type:"list"`
  1252. metadataPutPipelineDefinitionOutput `json:"-" xml:"-"`
  1253. }
  1254. type metadataPutPipelineDefinitionOutput struct {
  1255. SDKShapeTraits bool `type:"structure"`
  1256. }
  1257. // String returns the string representation
  1258. func (s PutPipelineDefinitionOutput) String() string {
  1259. return awsutil.Prettify(s)
  1260. }
  1261. // GoString returns the string representation
  1262. func (s PutPipelineDefinitionOutput) GoString() string {
  1263. return s.String()
  1264. }
  1265. // Defines the query to run against an object.
  1266. type Query struct {
  1267. // List of selectors that define the query. An object must satisfy all of the
  1268. // selectors to match the query.
  1269. Selectors []*Selector `locationName:"selectors" type:"list"`
  1270. metadataQuery `json:"-" xml:"-"`
  1271. }
  1272. type metadataQuery struct {
  1273. SDKShapeTraits bool `type:"structure"`
  1274. }
  1275. // String returns the string representation
  1276. func (s Query) String() string {
  1277. return awsutil.Prettify(s)
  1278. }
  1279. // GoString returns the string representation
  1280. func (s Query) GoString() string {
  1281. return s.String()
  1282. }
  1283. // Contains the parameters for QueryObjects.
  1284. type QueryObjectsInput struct {
  1285. // The maximum number of object names that QueryObjects will return in a single
  1286. // call. The default value is 100.
  1287. Limit *int64 `locationName:"limit" type:"integer"`
  1288. // The starting point for the results to be returned. For the first call, this
  1289. // value should be empty. As long as there are more results, continue to call
  1290. // QueryObjects with the marker value from the previous call to retrieve the
  1291. // next set of results.
  1292. Marker *string `locationName:"marker" type:"string"`
  1293. // The ID of the pipeline.
  1294. PipelineId *string `locationName:"pipelineId" type:"string" required:"true"`
  1295. // The query that defines the objects to be returned. The Query object can contain
  1296. // a maximum of ten selectors. The conditions in the query are limited to top-level
  1297. // String fields in the object. These filters can be applied to components,
  1298. // instances, and attempts.
  1299. Query *Query `locationName:"query" type:"structure"`
  1300. // Indicates whether the query applies to components or instances. The possible
  1301. // values are: COMPONENT, INSTANCE, and ATTEMPT.
  1302. Sphere *string `locationName:"sphere" type:"string" required:"true"`
  1303. metadataQueryObjectsInput `json:"-" xml:"-"`
  1304. }
  1305. type metadataQueryObjectsInput struct {
  1306. SDKShapeTraits bool `type:"structure"`
  1307. }
  1308. // String returns the string representation
  1309. func (s QueryObjectsInput) String() string {
  1310. return awsutil.Prettify(s)
  1311. }
  1312. // GoString returns the string representation
  1313. func (s QueryObjectsInput) GoString() string {
  1314. return s.String()
  1315. }
  1316. // Contains the output of QueryObjects.
  1317. type QueryObjectsOutput struct {
  1318. // Indicates whether there are more results that can be obtained by a subsequent
  1319. // call.
  1320. HasMoreResults *bool `locationName:"hasMoreResults" type:"boolean"`
  1321. // The identifiers that match the query selectors.
  1322. Ids []*string `locationName:"ids" type:"list"`
  1323. // The starting point for the next page of results. To view the next page of
  1324. // results, call QueryObjects again with this marker value. If the value is
  1325. // null, there are no more results.
  1326. Marker *string `locationName:"marker" type:"string"`
  1327. metadataQueryObjectsOutput `json:"-" xml:"-"`
  1328. }
  1329. type metadataQueryObjectsOutput struct {
  1330. SDKShapeTraits bool `type:"structure"`
  1331. }
  1332. // String returns the string representation
  1333. func (s QueryObjectsOutput) String() string {
  1334. return awsutil.Prettify(s)
  1335. }
  1336. // GoString returns the string representation
  1337. func (s QueryObjectsOutput) GoString() string {
  1338. return s.String()
  1339. }
  1340. // Contains the parameters for RemoveTags.
  1341. type RemoveTagsInput struct {
  1342. // The ID of the pipeline.
  1343. PipelineId *string `locationName:"pipelineId" type:"string" required:"true"`
  1344. // The keys of the tags to remove.
  1345. TagKeys []*string `locationName:"tagKeys" type:"list" required:"true"`
  1346. metadataRemoveTagsInput `json:"-" xml:"-"`
  1347. }
  1348. type metadataRemoveTagsInput struct {
  1349. SDKShapeTraits bool `type:"structure"`
  1350. }
  1351. // String returns the string representation
  1352. func (s RemoveTagsInput) String() string {
  1353. return awsutil.Prettify(s)
  1354. }
  1355. // GoString returns the string representation
  1356. func (s RemoveTagsInput) GoString() string {
  1357. return s.String()
  1358. }
  1359. // Contains the output of RemoveTags.
  1360. type RemoveTagsOutput struct {
  1361. metadataRemoveTagsOutput `json:"-" xml:"-"`
  1362. }
  1363. type metadataRemoveTagsOutput struct {
  1364. SDKShapeTraits bool `type:"structure"`
  1365. }
  1366. // String returns the string representation
  1367. func (s RemoveTagsOutput) String() string {
  1368. return awsutil.Prettify(s)
  1369. }
  1370. // GoString returns the string representation
  1371. func (s RemoveTagsOutput) GoString() string {
  1372. return s.String()
  1373. }
  1374. // Contains the parameters for ReportTaskProgress.
  1375. type ReportTaskProgressInput struct {
  1376. // Key-value pairs that define the properties of the ReportTaskProgressInput
  1377. // object.
  1378. Fields []*Field `locationName:"fields" type:"list"`
  1379. // The ID of the task assigned to the task runner. This value is provided in
  1380. // the response for PollForTask.
  1381. TaskId *string `locationName:"taskId" type:"string" required:"true"`
  1382. metadataReportTaskProgressInput `json:"-" xml:"-"`
  1383. }
  1384. type metadataReportTaskProgressInput struct {
  1385. SDKShapeTraits bool `type:"structure"`
  1386. }
  1387. // String returns the string representation
  1388. func (s ReportTaskProgressInput) String() string {
  1389. return awsutil.Prettify(s)
  1390. }
  1391. // GoString returns the string representation
  1392. func (s ReportTaskProgressInput) GoString() string {
  1393. return s.String()
  1394. }
  1395. // Contains the output of ReportTaskProgress.
  1396. type ReportTaskProgressOutput struct {
  1397. // If true, the calling task runner should cancel processing of the task. The
  1398. // task runner does not need to call SetTaskStatus for canceled tasks.
  1399. Canceled *bool `locationName:"canceled" type:"boolean" required:"true"`
  1400. metadataReportTaskProgressOutput `json:"-" xml:"-"`
  1401. }
  1402. type metadataReportTaskProgressOutput struct {
  1403. SDKShapeTraits bool `type:"structure"`
  1404. }
  1405. // String returns the string representation
  1406. func (s ReportTaskProgressOutput) String() string {
  1407. return awsutil.Prettify(s)
  1408. }
  1409. // GoString returns the string representation
  1410. func (s ReportTaskProgressOutput) GoString() string {
  1411. return s.String()
  1412. }
  1413. // Contains the parameters for ReportTaskRunnerHeartbeat.
  1414. type ReportTaskRunnerHeartbeatInput struct {
  1415. // The public DNS name of the task runner.
  1416. Hostname *string `locationName:"hostname" type:"string"`
  1417. // The ID of the task runner. This value should be unique across your AWS account.
  1418. // In the case of AWS Data Pipeline Task Runner launched on a resource managed
  1419. // by AWS Data Pipeline, the web service provides a unique identifier when it
  1420. // launches the application. If you have written a custom task runner, you should
  1421. // assign a unique identifier for the task runner.
  1422. TaskrunnerId *string `locationName:"taskrunnerId" type:"string" required:"true"`
  1423. // The type of task the task runner is configured to accept and process. The
  1424. // worker group is set as a field on objects in the pipeline when they are created.
  1425. // You can only specify a single value for workerGroup. There are no wildcard
  1426. // values permitted in workerGroup; the string must be an exact, case-sensitive,
  1427. // match.
  1428. WorkerGroup *string `locationName:"workerGroup" type:"string"`
  1429. metadataReportTaskRunnerHeartbeatInput `json:"-" xml:"-"`
  1430. }
  1431. type metadataReportTaskRunnerHeartbeatInput struct {
  1432. SDKShapeTraits bool `type:"structure"`
  1433. }
  1434. // String returns the string representation
  1435. func (s ReportTaskRunnerHeartbeatInput) String() string {
  1436. return awsutil.Prettify(s)
  1437. }
  1438. // GoString returns the string representation
  1439. func (s ReportTaskRunnerHeartbeatInput) GoString() string {
  1440. return s.String()
  1441. }
  1442. // Contains the output of ReportTaskRunnerHeartbeat.
  1443. type ReportTaskRunnerHeartbeatOutput struct {
  1444. // Indicates whether the calling task runner should terminate.
  1445. Terminate *bool `locationName:"terminate" type:"boolean" required:"true"`
  1446. metadataReportTaskRunnerHeartbeatOutput `json:"-" xml:"-"`
  1447. }
  1448. type metadataReportTaskRunnerHeartbeatOutput struct {
  1449. SDKShapeTraits bool `type:"structure"`
  1450. }
  1451. // String returns the string representation
  1452. func (s ReportTaskRunnerHeartbeatOutput) String() string {
  1453. return awsutil.Prettify(s)
  1454. }
  1455. // GoString returns the string representation
  1456. func (s ReportTaskRunnerHeartbeatOutput) GoString() string {
  1457. return s.String()
  1458. }
  1459. // A comparision that is used to determine whether a query should return this
  1460. // object.
  1461. type Selector struct {
  1462. // The name of the field that the operator will be applied to. The field name
  1463. // is the "key" portion of the field definition in the pipeline definition syntax
  1464. // that is used by the AWS Data Pipeline API. If the field is not set on the
  1465. // object, the condition fails.
  1466. FieldName *string `locationName:"fieldName" type:"string"`
  1467. // Contains a logical operation for comparing the value of a field with a specified
  1468. // value.
  1469. Operator *Operator `locationName:"operator" type:"structure"`
  1470. metadataSelector `json:"-" xml:"-"`
  1471. }
  1472. type metadataSelector struct {
  1473. SDKShapeTraits bool `type:"structure"`
  1474. }
  1475. // String returns the string representation
  1476. func (s Selector) String() string {
  1477. return awsutil.Prettify(s)
  1478. }
  1479. // GoString returns the string representation
  1480. func (s Selector) GoString() string {
  1481. return s.String()
  1482. }
  1483. // Contains the parameters for SetStatus.
  1484. type SetStatusInput struct {
  1485. // The IDs of the objects. The corresponding objects can be either physical
  1486. // or components, but not a mix of both types.
  1487. ObjectIds []*string `locationName:"objectIds" type:"list" required:"true"`
  1488. // The ID of the pipeline that contains the objects.
  1489. PipelineId *string `locationName:"pipelineId" type:"string" required:"true"`
  1490. // The status to be set on all the objects specified in objectIds. For components,
  1491. // use PAUSE or RESUME. For instances, use TRY_CANCEL, RERUN, or MARK_FINISHED.
  1492. Status *string `locationName:"status" type:"string" required:"true"`
  1493. metadataSetStatusInput `json:"-" xml:"-"`
  1494. }
  1495. type metadataSetStatusInput struct {
  1496. SDKShapeTraits bool `type:"structure"`
  1497. }
  1498. // String returns the string representation
  1499. func (s SetStatusInput) String() string {
  1500. return awsutil.Prettify(s)
  1501. }
  1502. // GoString returns the string representation
  1503. func (s SetStatusInput) GoString() string {
  1504. return s.String()
  1505. }
  1506. type SetStatusOutput struct {
  1507. metadataSetStatusOutput `json:"-" xml:"-"`
  1508. }
  1509. type metadataSetStatusOutput struct {
  1510. SDKShapeTraits bool `type:"structure"`
  1511. }
  1512. // String returns the string representation
  1513. func (s SetStatusOutput) String() string {
  1514. return awsutil.Prettify(s)
  1515. }
  1516. // GoString returns the string representation
  1517. func (s SetStatusOutput) GoString() string {
  1518. return s.String()
  1519. }
  1520. // Contains the parameters for SetTaskStatus.
  1521. type SetTaskStatusInput struct {
  1522. // If an error occurred during the task, this value specifies the error code.
  1523. // This value is set on the physical attempt object. It is used to display error
  1524. // information to the user. It should not start with string "Service_" which
  1525. // is reserved by the system.
  1526. ErrorId *string `locationName:"errorId" type:"string"`
  1527. // If an error occurred during the task, this value specifies a text description
  1528. // of the error. This value is set on the physical attempt object. It is used
  1529. // to display error information to the user. The web service does not parse
  1530. // this value.
  1531. ErrorMessage *string `locationName:"errorMessage" type:"string"`
  1532. // If an error occurred during the task, this value specifies the stack trace
  1533. // associated with the error. This value is set on the physical attempt object.
  1534. // It is used to display error information to the user. The web service does
  1535. // not parse this value.
  1536. ErrorStackTrace *string `locationName:"errorStackTrace" type:"string"`
  1537. // The ID of the task assigned to the task runner. This value is provided in
  1538. // the response for PollForTask.
  1539. TaskId *string `locationName:"taskId" type:"string" required:"true"`
  1540. // If FINISHED, the task successfully completed. If FAILED, the task ended unsuccessfully.
  1541. // Preconditions use false.
  1542. TaskStatus *string `locationName:"taskStatus" type:"string" required:"true" enum:"TaskStatus"`
  1543. metadataSetTaskStatusInput `json:"-" xml:"-"`
  1544. }
  1545. type metadataSetTaskStatusInput struct {
  1546. SDKShapeTraits bool `type:"structure"`
  1547. }
  1548. // String returns the string representation
  1549. func (s SetTaskStatusInput) String() string {
  1550. return awsutil.Prettify(s)
  1551. }
  1552. // GoString returns the string representation
  1553. func (s SetTaskStatusInput) GoString() string {
  1554. return s.String()
  1555. }
  1556. // Contains the output of SetTaskStatus.
  1557. type SetTaskStatusOutput struct {
  1558. metadataSetTaskStatusOutput `json:"-" xml:"-"`
  1559. }
  1560. type metadataSetTaskStatusOutput struct {
  1561. SDKShapeTraits bool `type:"structure"`
  1562. }
  1563. // String returns the string representation
  1564. func (s SetTaskStatusOutput) String() string {
  1565. return awsutil.Prettify(s)
  1566. }
  1567. // GoString returns the string representation
  1568. func (s SetTaskStatusOutput) GoString() string {
  1569. return s.String()
  1570. }
  1571. // Tags are key/value pairs defined by a user and associated with a pipeline
  1572. // to control access. AWS Data Pipeline allows you to associate ten tags per
  1573. // pipeline. For more information, see Controlling User Access to Pipelines
  1574. // (http://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-control-access.html)
  1575. // in the AWS Data Pipeline Developer Guide.
  1576. type Tag struct {
  1577. // The key name of a tag defined by a user. For more information, see Controlling
  1578. // User Access to Pipelines (http://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-control-access.html)
  1579. // in the AWS Data Pipeline Developer Guide.
  1580. Key *string `locationName:"key" type:"string" required:"true"`
  1581. // The optional value portion of a tag defined by a user. For more information,
  1582. // see Controlling User Access to Pipelines (http://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-control-access.html)
  1583. // in the AWS Data Pipeline Developer Guide.
  1584. Value *string `locationName:"value" type:"string" required:"true"`
  1585. metadataTag `json:"-" xml:"-"`
  1586. }
  1587. type metadataTag struct {
  1588. SDKShapeTraits bool `type:"structure"`
  1589. }
  1590. // String returns the string representation
  1591. func (s Tag) String() string {
  1592. return awsutil.Prettify(s)
  1593. }
  1594. // GoString returns the string representation
  1595. func (s Tag) GoString() string {
  1596. return s.String()
  1597. }
  1598. // Contains information about a pipeline task that is assigned to a task runner.
  1599. type TaskObject struct {
  1600. // The ID of the pipeline task attempt object. AWS Data Pipeline uses this value
  1601. // to track how many times a task is attempted.
  1602. AttemptId *string `locationName:"attemptId" type:"string"`
  1603. // Connection information for the location where the task runner will publish
  1604. // the output of the task.
  1605. Objects map[string]*PipelineObject `locationName:"objects" type:"map"`
  1606. // The ID of the pipeline that provided the task.
  1607. PipelineId *string `locationName:"pipelineId" type:"string"`
  1608. // An internal identifier for the task. This ID is passed to the SetTaskStatus
  1609. // and ReportTaskProgress actions.
  1610. TaskId *string `locationName:"taskId" type:"string"`
  1611. metadataTaskObject `json:"-" xml:"-"`
  1612. }
  1613. type metadataTaskObject struct {
  1614. SDKShapeTraits bool `type:"structure"`
  1615. }
  1616. // String returns the string representation
  1617. func (s TaskObject) String() string {
  1618. return awsutil.Prettify(s)
  1619. }
  1620. // GoString returns the string representation
  1621. func (s TaskObject) GoString() string {
  1622. return s.String()
  1623. }
  1624. // Contains the parameters for ValidatePipelineDefinition.
  1625. type ValidatePipelineDefinitionInput struct {
  1626. // The parameter objects used with the pipeline.
  1627. ParameterObjects []*ParameterObject `locationName:"parameterObjects" type:"list"`
  1628. // The parameter values used with the pipeline.
  1629. ParameterValues []*ParameterValue `locationName:"parameterValues" type:"list"`
  1630. // The ID of the pipeline.
  1631. PipelineId *string `locationName:"pipelineId" type:"string" required:"true"`
  1632. // The objects that define the pipeline changes to validate against the pipeline.
  1633. PipelineObjects []*PipelineObject `locationName:"pipelineObjects" type:"list" required:"true"`
  1634. metadataValidatePipelineDefinitionInput `json:"-" xml:"-"`
  1635. }
  1636. type metadataValidatePipelineDefinitionInput struct {
  1637. SDKShapeTraits bool `type:"structure"`
  1638. }
  1639. // String returns the string representation
  1640. func (s ValidatePipelineDefinitionInput) String() string {
  1641. return awsutil.Prettify(s)
  1642. }
  1643. // GoString returns the string representation
  1644. func (s ValidatePipelineDefinitionInput) GoString() string {
  1645. return s.String()
  1646. }
  1647. // Contains the output of ValidatePipelineDefinition.
  1648. type ValidatePipelineDefinitionOutput struct {
  1649. // Indicates whether there were validation errors.
  1650. Errored *bool `locationName:"errored" type:"boolean" required:"true"`
  1651. // Any validation errors that were found.
  1652. ValidationErrors []*ValidationError `locationName:"validationErrors" type:"list"`
  1653. // Any validation warnings that were found.
  1654. ValidationWarnings []*ValidationWarning `locationName:"validationWarnings" type:"list"`
  1655. metadataValidatePipelineDefinitionOutput `json:"-" xml:"-"`
  1656. }
  1657. type metadataValidatePipelineDefinitionOutput struct {
  1658. SDKShapeTraits bool `type:"structure"`
  1659. }
  1660. // String returns the string representation
  1661. func (s ValidatePipelineDefinitionOutput) String() string {
  1662. return awsutil.Prettify(s)
  1663. }
  1664. // GoString returns the string representation
  1665. func (s ValidatePipelineDefinitionOutput) GoString() string {
  1666. return s.String()
  1667. }
  1668. // Defines a validation error. Validation errors prevent pipeline activation.
  1669. // The set of validation errors that can be returned are defined by AWS Data
  1670. // Pipeline.
  1671. type ValidationError struct {
  1672. // A description of the validation error.
  1673. Errors []*string `locationName:"errors" type:"list"`
  1674. // The identifier of the object that contains the validation error.
  1675. Id *string `locationName:"id" type:"string"`
  1676. metadataValidationError `json:"-" xml:"-"`
  1677. }
  1678. type metadataValidationError struct {
  1679. SDKShapeTraits bool `type:"structure"`
  1680. }
  1681. // String returns the string representation
  1682. func (s ValidationError) String() string {
  1683. return awsutil.Prettify(s)
  1684. }
  1685. // GoString returns the string representation
  1686. func (s ValidationError) GoString() string {
  1687. return s.String()
  1688. }
  1689. // Defines a validation warning. Validation warnings do not prevent pipeline
  1690. // activation. The set of validation warnings that can be returned are defined
  1691. // by AWS Data Pipeline.
  1692. type ValidationWarning struct {
  1693. // The identifier of the object that contains the validation warning.
  1694. Id *string `locationName:"id" type:"string"`
  1695. // A description of the validation warning.
  1696. Warnings []*string `locationName:"warnings" type:"list"`
  1697. metadataValidationWarning `json:"-" xml:"-"`
  1698. }
  1699. type metadataValidationWarning struct {
  1700. SDKShapeTraits bool `type:"structure"`
  1701. }
  1702. // String returns the string representation
  1703. func (s ValidationWarning) String() string {
  1704. return awsutil.Prettify(s)
  1705. }
  1706. // GoString returns the string representation
  1707. func (s ValidationWarning) GoString() string {
  1708. return s.String()
  1709. }
  1710. const (
  1711. // @enum OperatorType
  1712. OperatorTypeEq = "EQ"
  1713. // @enum OperatorType
  1714. OperatorTypeRefEq = "REF_EQ"
  1715. // @enum OperatorType
  1716. OperatorTypeLe = "LE"
  1717. // @enum OperatorType
  1718. OperatorTypeGe = "GE"
  1719. // @enum OperatorType
  1720. OperatorTypeBetween = "BETWEEN"
  1721. )
  1722. const (
  1723. // @enum TaskStatus
  1724. TaskStatusFinished = "FINISHED"
  1725. // @enum TaskStatus
  1726. TaskStatusFailed = "FAILED"
  1727. // @enum TaskStatus
  1728. TaskStatusFalse = "FALSE"
  1729. )