forked from aws/aws-sdk-js
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathcodepipeline-2015-07-09.normal.json
2485 lines (2485 loc) · 95.7 KB
/
codepipeline-2015-07-09.normal.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"version":"2.0",
"metadata":{
"apiVersion":"2015-07-09",
"endpointPrefix":"codepipeline",
"jsonVersion":"1.1",
"protocol":"json",
"serviceAbbreviation":"CodePipeline",
"serviceFullName":"AWS CodePipeline",
"signatureVersion":"v4",
"targetPrefix":"CodePipeline_20150709",
"uid":"codepipeline-2015-07-09"
},
"operations":{
"AcknowledgeJob":{
"name":"AcknowledgeJob",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"AcknowledgeJobInput"},
"output":{"shape":"AcknowledgeJobOutput"},
"errors":[
{"shape":"ValidationException"},
{"shape":"InvalidNonceException"},
{"shape":"JobNotFoundException"}
],
"documentation":"<p>Returns information about a specified job and whether that job has been received by the job worker. Only used for custom actions.</p>"
},
"AcknowledgeThirdPartyJob":{
"name":"AcknowledgeThirdPartyJob",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"AcknowledgeThirdPartyJobInput"},
"output":{"shape":"AcknowledgeThirdPartyJobOutput"},
"errors":[
{"shape":"ValidationException"},
{"shape":"InvalidNonceException"},
{"shape":"JobNotFoundException"},
{"shape":"InvalidClientTokenException"}
],
"documentation":"<p>Confirms a job worker has received the specified job. Only used for partner actions.</p>"
},
"CreateCustomActionType":{
"name":"CreateCustomActionType",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateCustomActionTypeInput"},
"output":{"shape":"CreateCustomActionTypeOutput"},
"errors":[
{"shape":"ValidationException"},
{"shape":"LimitExceededException"}
],
"documentation":"<p>Creates a new custom action that can be used in all pipelines associated with the AWS account. Only used for custom actions.</p>"
},
"CreatePipeline":{
"name":"CreatePipeline",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreatePipelineInput"},
"output":{"shape":"CreatePipelineOutput"},
"errors":[
{"shape":"ValidationException"},
{"shape":"PipelineNameInUseException"},
{"shape":"InvalidStageDeclarationException"},
{"shape":"InvalidActionDeclarationException"},
{"shape":"InvalidBlockerDeclarationException"},
{"shape":"InvalidStructureException"},
{"shape":"LimitExceededException"}
],
"documentation":"<p>Creates a pipeline.</p>"
},
"DeleteCustomActionType":{
"name":"DeleteCustomActionType",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteCustomActionTypeInput"},
"errors":[
{"shape":"ValidationException"}
],
"documentation":"<p>Marks a custom action as deleted. PollForJobs for the custom action will fail after the action is marked for deletion. Only used for custom actions.</p> <important> <p>You cannot recreate a custom action after it has been deleted unless you increase the version number of the action.</p> </important>"
},
"DeletePipeline":{
"name":"DeletePipeline",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeletePipelineInput"},
"errors":[
{"shape":"ValidationException"}
],
"documentation":"<p>Deletes the specified pipeline.</p>"
},
"DisableStageTransition":{
"name":"DisableStageTransition",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DisableStageTransitionInput"},
"errors":[
{"shape":"ValidationException"},
{"shape":"PipelineNotFoundException"},
{"shape":"StageNotFoundException"}
],
"documentation":"<p>Prevents artifacts in a pipeline from transitioning to the next stage in the pipeline.</p>"
},
"EnableStageTransition":{
"name":"EnableStageTransition",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"EnableStageTransitionInput"},
"errors":[
{"shape":"ValidationException"},
{"shape":"PipelineNotFoundException"},
{"shape":"StageNotFoundException"}
],
"documentation":"<p>Enables artifacts in a pipeline to transition to a stage in a pipeline.</p>"
},
"GetJobDetails":{
"name":"GetJobDetails",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetJobDetailsInput"},
"output":{"shape":"GetJobDetailsOutput"},
"errors":[
{"shape":"ValidationException"},
{"shape":"JobNotFoundException"}
],
"documentation":"<p>Returns information about a job. Only used for custom actions.</p> <important> <p>When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. Additionally, this API returns any secret values defined for the action.</p> </important>"
},
"GetPipeline":{
"name":"GetPipeline",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetPipelineInput"},
"output":{"shape":"GetPipelineOutput"},
"errors":[
{"shape":"ValidationException"},
{"shape":"PipelineNotFoundException"},
{"shape":"PipelineVersionNotFoundException"}
],
"documentation":"<p>Returns the metadata, structure, stages, and actions of a pipeline. Can be used to return the entire structure of a pipeline in JSON format, which can then be modified and used to update the pipeline structure with <a>UpdatePipeline</a>.</p>"
},
"GetPipelineExecution":{
"name":"GetPipelineExecution",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetPipelineExecutionInput"},
"output":{"shape":"GetPipelineExecutionOutput"},
"errors":[
{"shape":"ValidationException"},
{"shape":"PipelineNotFoundException"},
{"shape":"PipelineExecutionNotFoundException"}
],
"documentation":"<p>Returns information about an execution of a pipeline, including details about artifacts, the pipeline execution ID, and the name, version, and status of the pipeline.</p>"
},
"GetPipelineState":{
"name":"GetPipelineState",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetPipelineStateInput"},
"output":{"shape":"GetPipelineStateOutput"},
"errors":[
{"shape":"ValidationException"},
{"shape":"PipelineNotFoundException"}
],
"documentation":"<p>Returns information about the state of a pipeline, including the stages and actions.</p>"
},
"GetThirdPartyJobDetails":{
"name":"GetThirdPartyJobDetails",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetThirdPartyJobDetailsInput"},
"output":{"shape":"GetThirdPartyJobDetailsOutput"},
"errors":[
{"shape":"JobNotFoundException"},
{"shape":"ValidationException"},
{"shape":"InvalidClientTokenException"},
{"shape":"InvalidJobException"}
],
"documentation":"<p>Requests the details of a job for a third party action. Only used for partner actions.</p> <important> <p>When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. Additionally, this API returns any secret values defined for the action.</p> </important>"
},
"ListActionTypes":{
"name":"ListActionTypes",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListActionTypesInput"},
"output":{"shape":"ListActionTypesOutput"},
"errors":[
{"shape":"ValidationException"},
{"shape":"InvalidNextTokenException"}
],
"documentation":"<p>Gets a summary of all AWS CodePipeline action types associated with your account.</p>"
},
"ListPipelines":{
"name":"ListPipelines",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListPipelinesInput"},
"output":{"shape":"ListPipelinesOutput"},
"errors":[
{"shape":"InvalidNextTokenException"}
],
"documentation":"<p>Gets a summary of all of the pipelines associated with your account.</p>"
},
"PollForJobs":{
"name":"PollForJobs",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"PollForJobsInput"},
"output":{"shape":"PollForJobsOutput"},
"errors":[
{"shape":"ValidationException"},
{"shape":"ActionTypeNotFoundException"}
],
"documentation":"<p>Returns information about any jobs for AWS CodePipeline to act upon.</p> <important> <p>When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. Additionally, this API returns any secret values defined for the action.</p> </important>"
},
"PollForThirdPartyJobs":{
"name":"PollForThirdPartyJobs",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"PollForThirdPartyJobsInput"},
"output":{"shape":"PollForThirdPartyJobsOutput"},
"errors":[
{"shape":"ActionTypeNotFoundException"},
{"shape":"ValidationException"}
],
"documentation":"<p>Determines whether there are any third party jobs for a job worker to act on. Only used for partner actions.</p> <important> <p>When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts.</p> </important>"
},
"PutActionRevision":{
"name":"PutActionRevision",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"PutActionRevisionInput"},
"output":{"shape":"PutActionRevisionOutput"},
"errors":[
{"shape":"PipelineNotFoundException"},
{"shape":"StageNotFoundException"},
{"shape":"ActionNotFoundException"},
{"shape":"ValidationException"}
],
"documentation":"<p>Provides information to AWS CodePipeline about new revisions to a source.</p>"
},
"PutApprovalResult":{
"name":"PutApprovalResult",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"PutApprovalResultInput"},
"output":{"shape":"PutApprovalResultOutput"},
"errors":[
{"shape":"InvalidApprovalTokenException"},
{"shape":"ApprovalAlreadyCompletedException"},
{"shape":"PipelineNotFoundException"},
{"shape":"StageNotFoundException"},
{"shape":"ActionNotFoundException"},
{"shape":"ValidationException"}
],
"documentation":"<p>Provides the response to a manual approval request to AWS CodePipeline. Valid responses include Approved and Rejected.</p>"
},
"PutJobFailureResult":{
"name":"PutJobFailureResult",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"PutJobFailureResultInput"},
"errors":[
{"shape":"ValidationException"},
{"shape":"JobNotFoundException"},
{"shape":"InvalidJobStateException"}
],
"documentation":"<p>Represents the failure of a job as returned to the pipeline by a job worker. Only used for custom actions.</p>"
},
"PutJobSuccessResult":{
"name":"PutJobSuccessResult",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"PutJobSuccessResultInput"},
"errors":[
{"shape":"ValidationException"},
{"shape":"JobNotFoundException"},
{"shape":"InvalidJobStateException"}
],
"documentation":"<p>Represents the success of a job as returned to the pipeline by a job worker. Only used for custom actions.</p>"
},
"PutThirdPartyJobFailureResult":{
"name":"PutThirdPartyJobFailureResult",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"PutThirdPartyJobFailureResultInput"},
"errors":[
{"shape":"ValidationException"},
{"shape":"JobNotFoundException"},
{"shape":"InvalidJobStateException"},
{"shape":"InvalidClientTokenException"}
],
"documentation":"<p>Represents the failure of a third party job as returned to the pipeline by a job worker. Only used for partner actions.</p>"
},
"PutThirdPartyJobSuccessResult":{
"name":"PutThirdPartyJobSuccessResult",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"PutThirdPartyJobSuccessResultInput"},
"errors":[
{"shape":"ValidationException"},
{"shape":"JobNotFoundException"},
{"shape":"InvalidJobStateException"},
{"shape":"InvalidClientTokenException"}
],
"documentation":"<p>Represents the success of a third party job as returned to the pipeline by a job worker. Only used for partner actions.</p>"
},
"RetryStageExecution":{
"name":"RetryStageExecution",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"RetryStageExecutionInput"},
"output":{"shape":"RetryStageExecutionOutput"},
"errors":[
{"shape":"ValidationException"},
{"shape":"PipelineNotFoundException"},
{"shape":"StageNotFoundException"},
{"shape":"StageNotRetryableException"},
{"shape":"NotLatestPipelineExecutionException"}
],
"documentation":"<p>Resumes the pipeline execution by retrying the last failed actions in a stage.</p>"
},
"StartPipelineExecution":{
"name":"StartPipelineExecution",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"StartPipelineExecutionInput"},
"output":{"shape":"StartPipelineExecutionOutput"},
"errors":[
{"shape":"ValidationException"},
{"shape":"PipelineNotFoundException"}
],
"documentation":"<p>Starts the specified pipeline. Specifically, it begins processing the latest commit to the source location specified as part of the pipeline.</p>"
},
"UpdatePipeline":{
"name":"UpdatePipeline",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdatePipelineInput"},
"output":{"shape":"UpdatePipelineOutput"},
"errors":[
{"shape":"ValidationException"},
{"shape":"InvalidStageDeclarationException"},
{"shape":"InvalidActionDeclarationException"},
{"shape":"InvalidBlockerDeclarationException"},
{"shape":"InvalidStructureException"}
],
"documentation":"<p>Updates a specified pipeline with edits or changes to its structure. Use a JSON file with the pipeline structure in conjunction with UpdatePipeline to provide the full structure of the pipeline. Updating the pipeline increases the version number of the pipeline by 1.</p>"
}
},
"shapes":{
"AWSSessionCredentials":{
"type":"structure",
"required":[
"accessKeyId",
"secretAccessKey",
"sessionToken"
],
"members":{
"accessKeyId":{
"shape":"AccessKeyId",
"documentation":"<p>The access key for the session.</p>"
},
"secretAccessKey":{
"shape":"SecretAccessKey",
"documentation":"<p>The secret access key for the session.</p>"
},
"sessionToken":{
"shape":"SessionToken",
"documentation":"<p>The token for the session.</p>"
}
},
"documentation":"<p>Represents an AWS session credentials object. These credentials are temporary credentials that are issued by AWS Secure Token Service (STS). They can be used to access input and output artifacts in the Amazon S3 bucket used to store artifact for the pipeline in AWS CodePipeline.</p>",
"sensitive":true
},
"AccessKeyId":{"type":"string"},
"AccountId":{
"type":"string",
"pattern":"[0-9]{12}"
},
"AcknowledgeJobInput":{
"type":"structure",
"required":[
"jobId",
"nonce"
],
"members":{
"jobId":{
"shape":"JobId",
"documentation":"<p>The unique system-generated ID of the job for which you want to confirm receipt.</p>"
},
"nonce":{
"shape":"Nonce",
"documentation":"<p>A system-generated random number that AWS CodePipeline uses to ensure that the job is being worked on by only one job worker. Get this number from the response of the <a>PollForJobs</a> request that returned this job.</p>"
}
},
"documentation":"<p>Represents the input of an acknowledge job action.</p>"
},
"AcknowledgeJobOutput":{
"type":"structure",
"members":{
"status":{
"shape":"JobStatus",
"documentation":"<p>Whether the job worker has received the specified job.</p>"
}
},
"documentation":"<p>Represents the output of an acknowledge job action.</p>"
},
"AcknowledgeThirdPartyJobInput":{
"type":"structure",
"required":[
"jobId",
"nonce",
"clientToken"
],
"members":{
"jobId":{
"shape":"ThirdPartyJobId",
"documentation":"<p>The unique system-generated ID of the job.</p>"
},
"nonce":{
"shape":"Nonce",
"documentation":"<p>A system-generated random number that AWS CodePipeline uses to ensure that the job is being worked on by only one job worker. Get this number from the response to a <a>GetThirdPartyJobDetails</a> request.</p>"
},
"clientToken":{
"shape":"ClientToken",
"documentation":"<p>The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details.</p>"
}
},
"documentation":"<p>Represents the input of an acknowledge third party job action.</p>"
},
"AcknowledgeThirdPartyJobOutput":{
"type":"structure",
"members":{
"status":{
"shape":"JobStatus",
"documentation":"<p>The status information for the third party job, if any.</p>"
}
},
"documentation":"<p>Represents the output of an acknowledge third party job action.</p>"
},
"ActionCategory":{
"type":"string",
"enum":[
"Source",
"Build",
"Deploy",
"Test",
"Invoke",
"Approval"
]
},
"ActionConfiguration":{
"type":"structure",
"members":{
"configuration":{
"shape":"ActionConfigurationMap",
"documentation":"<p>The configuration data for the action.</p>"
}
},
"documentation":"<p>Represents information about an action configuration.</p>"
},
"ActionConfigurationKey":{
"type":"string",
"max":50,
"min":1
},
"ActionConfigurationMap":{
"type":"map",
"key":{"shape":"ActionConfigurationKey"},
"value":{"shape":"ActionConfigurationValue"}
},
"ActionConfigurationProperty":{
"type":"structure",
"required":[
"name",
"required",
"key",
"secret"
],
"members":{
"name":{
"shape":"ActionConfigurationKey",
"documentation":"<p>The name of the action configuration property.</p>"
},
"required":{
"shape":"Boolean",
"documentation":"<p>Whether the configuration property is a required value.</p>"
},
"key":{
"shape":"Boolean",
"documentation":"<p>Whether the configuration property is a key.</p>"
},
"secret":{
"shape":"Boolean",
"documentation":"<p>Whether the configuration property is secret. Secrets are hidden from all calls except for GetJobDetails, GetThirdPartyJobDetails, PollForJobs, and PollForThirdPartyJobs.</p> <p>When updating a pipeline, passing * * * * * without changing any other values of the action will preserve the prior value of the secret.</p>"
},
"queryable":{
"shape":"Boolean",
"documentation":"<p>Indicates that the proprety will be used in conjunction with PollForJobs. When creating a custom action, an action can have up to one queryable property. If it has one, that property must be both required and not secret.</p> <p>If you create a pipeline with a custom action type, and that custom action contains a queryable property, the value for that configuration property is subject to additional restrictions. The value must be less than or equal to twenty (20) characters. The value can contain only alphanumeric characters, underscores, and hyphens.</p>"
},
"description":{
"shape":"Description",
"documentation":"<p>The description of the action configuration property that will be displayed to users.</p>"
},
"type":{
"shape":"ActionConfigurationPropertyType",
"documentation":"<p>The type of the configuration property.</p>"
}
},
"documentation":"<p>Represents information about an action configuration property.</p>"
},
"ActionConfigurationPropertyList":{
"type":"list",
"member":{"shape":"ActionConfigurationProperty"},
"max":10
},
"ActionConfigurationPropertyType":{
"type":"string",
"enum":[
"String",
"Number",
"Boolean"
]
},
"ActionConfigurationQueryableValue":{
"type":"string",
"max":20,
"min":1,
"pattern":"[a-zA-Z0-9_-]+"
},
"ActionConfigurationValue":{
"type":"string",
"max":1000,
"min":1
},
"ActionContext":{
"type":"structure",
"members":{
"name":{
"shape":"ActionName",
"documentation":"<p>The name of the action within the context of a job.</p>"
}
},
"documentation":"<p>Represents the context of an action within the stage of a pipeline to a job worker.</p>"
},
"ActionDeclaration":{
"type":"structure",
"required":[
"name",
"actionTypeId"
],
"members":{
"name":{
"shape":"ActionName",
"documentation":"<p>The action declaration's name.</p>"
},
"actionTypeId":{
"shape":"ActionTypeId",
"documentation":"<p>The configuration information for the action type.</p>"
},
"runOrder":{
"shape":"ActionRunOrder",
"documentation":"<p>The order in which actions are run.</p>"
},
"configuration":{
"shape":"ActionConfigurationMap",
"documentation":"<p>The action declaration's configuration.</p>"
},
"outputArtifacts":{
"shape":"OutputArtifactList",
"documentation":"<p>The name or ID of the result of the action declaration, such as a test or build artifact.</p>"
},
"inputArtifacts":{
"shape":"InputArtifactList",
"documentation":"<p>The name or ID of the artifact consumed by the action, such as a test or build artifact.</p>"
},
"roleArn":{
"shape":"RoleArn",
"documentation":"<p>The ARN of the IAM service role that will perform the declared action. This is assumed through the roleArn for the pipeline.</p>"
}
},
"documentation":"<p>Represents information about an action declaration.</p>"
},
"ActionExecution":{
"type":"structure",
"members":{
"status":{
"shape":"ActionExecutionStatus",
"documentation":"<p>The status of the action, or for a completed action, the last status of the action.</p>"
},
"summary":{
"shape":"ExecutionSummary",
"documentation":"<p>A summary of the run of the action.</p>"
},
"lastStatusChange":{
"shape":"Timestamp",
"documentation":"<p>The last status change of the action.</p>"
},
"token":{
"shape":"ActionExecutionToken",
"documentation":"<p>The system-generated token used to identify a unique approval request. The token for each open approval request can be obtained using the GetPipelineState command and is used to validate that the approval request corresponding to this token is still valid.</p>"
},
"lastUpdatedBy":{
"shape":"LastUpdatedBy",
"documentation":"<p>The ARN of the user who last changed the pipeline.</p>"
},
"externalExecutionId":{
"shape":"ExecutionId",
"documentation":"<p>The external ID of the run of the action.</p>"
},
"externalExecutionUrl":{
"shape":"Url",
"documentation":"<p>The URL of a resource external to AWS that will be used when running the action, for example an external repository URL.</p>"
},
"percentComplete":{
"shape":"Percentage",
"documentation":"<p>A percentage of completeness of the action as it runs.</p>"
},
"errorDetails":{
"shape":"ErrorDetails",
"documentation":"<p>The details of an error returned by a URL external to AWS.</p>"
}
},
"documentation":"<p>Represents information about the run of an action.</p>"
},
"ActionExecutionStatus":{
"type":"string",
"enum":[
"InProgress",
"Succeeded",
"Failed"
]
},
"ActionExecutionToken":{"type":"string"},
"ActionName":{
"type":"string",
"max":100,
"min":1,
"pattern":"[A-Za-z0-9.@\\-_]+"
},
"ActionNotFoundException":{
"type":"structure",
"members":{
},
"documentation":"<p>The specified action cannot be found.</p>",
"exception":true
},
"ActionOwner":{
"type":"string",
"enum":[
"AWS",
"ThirdParty",
"Custom"
]
},
"ActionProvider":{
"type":"string",
"max":25,
"min":1,
"pattern":"[0-9A-Za-z_-]+"
},
"ActionRevision":{
"type":"structure",
"required":[
"revisionId",
"revisionChangeId",
"created"
],
"members":{
"revisionId":{
"shape":"Revision",
"documentation":"<p>The system-generated unique ID that identifies the revision number of the action.</p>"
},
"revisionChangeId":{
"shape":"RevisionChangeIdentifier",
"documentation":"<p>The unique identifier of the change that set the state to this revision, for example a deployment ID or timestamp.</p>"
},
"created":{
"shape":"Timestamp",
"documentation":"<p>The date and time when the most recent version of the action was created, in timestamp format.</p>"
}
},
"documentation":"<p>Represents information about the version (or revision) of an action.</p>"
},
"ActionRunOrder":{
"type":"integer",
"max":999,
"min":1
},
"ActionState":{
"type":"structure",
"members":{
"actionName":{
"shape":"ActionName",
"documentation":"<p>The name of the action.</p>"
},
"currentRevision":{"shape":"ActionRevision"},
"latestExecution":{"shape":"ActionExecution"},
"entityUrl":{
"shape":"Url",
"documentation":"<p>A URL link for more information about the state of the action, such as a deployment group details page.</p>"
},
"revisionUrl":{
"shape":"Url",
"documentation":"<p>A URL link for more information about the revision, such as a commit details page.</p>"
}
},
"documentation":"<p>Represents information about the state of an action.</p>"
},
"ActionStateList":{
"type":"list",
"member":{"shape":"ActionState"}
},
"ActionType":{
"type":"structure",
"required":[
"id",
"inputArtifactDetails",
"outputArtifactDetails"
],
"members":{
"id":{"shape":"ActionTypeId"},
"settings":{
"shape":"ActionTypeSettings",
"documentation":"<p>The settings for the action type.</p>"
},
"actionConfigurationProperties":{
"shape":"ActionConfigurationPropertyList",
"documentation":"<p>The configuration properties for the action type.</p>"
},
"inputArtifactDetails":{
"shape":"ArtifactDetails",
"documentation":"<p>The details of the input artifact for the action, such as its commit ID.</p>"
},
"outputArtifactDetails":{
"shape":"ArtifactDetails",
"documentation":"<p>The details of the output artifact of the action, such as its commit ID.</p>"
}
},
"documentation":"<p>Returns information about the details of an action type.</p>"
},
"ActionTypeId":{
"type":"structure",
"required":[
"category",
"owner",
"provider",
"version"
],
"members":{
"category":{
"shape":"ActionCategory",
"documentation":"<p>A category defines what kind of action can be taken in the stage, and constrains the provider type for the action. Valid categories are limited to one of the values below.</p>"
},
"owner":{
"shape":"ActionOwner",
"documentation":"<p>The creator of the action being called.</p>"
},
"provider":{
"shape":"ActionProvider",
"documentation":"<p>The provider of the service being called by the action. Valid providers are determined by the action category. For example, an action in the Deploy category type might have a provider of AWS CodeDeploy, which would be specified as CodeDeploy.</p>"
},
"version":{
"shape":"Version",
"documentation":"<p>A string that identifies the action type.</p>"
}
},
"documentation":"<p>Represents information about an action type.</p>"
},
"ActionTypeList":{
"type":"list",
"member":{"shape":"ActionType"}
},
"ActionTypeNotFoundException":{
"type":"structure",
"members":{
},
"documentation":"<p>The specified action type cannot be found.</p>",
"exception":true
},
"ActionTypeSettings":{
"type":"structure",
"members":{
"thirdPartyConfigurationUrl":{
"shape":"Url",
"documentation":"<p>The URL of a sign-up page where users can sign up for an external service and perform initial configuration of the action provided by that service.</p>"
},
"entityUrlTemplate":{
"shape":"UrlTemplate",
"documentation":"<p>The URL returned to the AWS CodePipeline console that provides a deep link to the resources of the external system, such as the configuration page for an AWS CodeDeploy deployment group. This link is provided as part of the action display within the pipeline.</p>"
},
"executionUrlTemplate":{
"shape":"UrlTemplate",
"documentation":"<p>The URL returned to the AWS CodePipeline console that contains a link to the top-level landing page for the external system, such as console page for AWS CodeDeploy. This link is shown on the pipeline view page in the AWS CodePipeline console and provides a link to the execution entity of the external action.</p>"
},
"revisionUrlTemplate":{
"shape":"UrlTemplate",
"documentation":"<p>The URL returned to the AWS CodePipeline console that contains a link to the page where customers can update or change the configuration of the external action.</p>"
}
},
"documentation":"<p>Returns information about the settings for an action type.</p>"
},
"ApprovalAlreadyCompletedException":{
"type":"structure",
"members":{
},
"documentation":"<p>The approval action has already been approved or rejected.</p>",
"exception":true
},
"ApprovalResult":{
"type":"structure",
"required":[
"summary",
"status"
],
"members":{
"summary":{
"shape":"ApprovalSummary",
"documentation":"<p>The summary of the current status of the approval request.</p>"
},
"status":{
"shape":"ApprovalStatus",
"documentation":"<p>The response submitted by a reviewer assigned to an approval action request.</p>"
}
},
"documentation":"<p>Represents information about the result of an approval request.</p>"
},
"ApprovalStatus":{
"type":"string",
"enum":[
"Approved",
"Rejected"
]
},
"ApprovalSummary":{
"type":"string",
"max":512,
"min":0
},
"ApprovalToken":{
"type":"string",
"pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}"
},
"Artifact":{
"type":"structure",
"members":{
"name":{
"shape":"ArtifactName",
"documentation":"<p>The artifact's name.</p>"
},
"revision":{
"shape":"Revision",
"documentation":"<p>The artifact's revision ID. Depending on the type of object, this could be a commit ID (GitHub) or a revision ID (Amazon S3).</p>"
},
"location":{
"shape":"ArtifactLocation",
"documentation":"<p>The location of an artifact.</p>"
}
},
"documentation":"<p>Represents information about an artifact that will be worked upon by actions in the pipeline.</p>"
},
"ArtifactDetails":{
"type":"structure",
"required":[
"minimumCount",
"maximumCount"
],
"members":{
"minimumCount":{
"shape":"MinimumArtifactCount",
"documentation":"<p>The minimum number of artifacts allowed for the action type.</p>"
},
"maximumCount":{
"shape":"MaximumArtifactCount",
"documentation":"<p>The maximum number of artifacts allowed for the action type.</p>"
}
},
"documentation":"<p>Returns information about the details of an artifact.</p>"
},
"ArtifactList":{
"type":"list",
"member":{"shape":"Artifact"}
},
"ArtifactLocation":{
"type":"structure",
"members":{
"type":{
"shape":"ArtifactLocationType",
"documentation":"<p>The type of artifact in the location.</p>"
},
"s3Location":{
"shape":"S3ArtifactLocation",
"documentation":"<p>The Amazon S3 bucket that contains the artifact.</p>"
}
},
"documentation":"<p>Represents information about the location of an artifact.</p>"
},
"ArtifactLocationType":{
"type":"string",
"enum":["S3"]
},
"ArtifactName":{
"type":"string",
"max":100,
"min":1,
"pattern":"[a-zA-Z0-9_\\-]+"
},
"ArtifactRevision":{
"type":"structure",
"members":{
"name":{
"shape":"ArtifactName",
"documentation":"<p>The name of an artifact. This name might be system-generated, such as \"MyApp\", or might be defined by the user when an action is created.</p>"
},
"revisionId":{
"shape":"Revision",
"documentation":"<p>The revision ID of the artifact.</p>"
},
"revisionChangeIdentifier":{
"shape":"RevisionChangeIdentifier",
"documentation":"<p>An additional identifier for a revision, such as a commit date or, for artifacts stored in Amazon S3 buckets, the ETag value.</p>"
},
"revisionSummary":{
"shape":"RevisionSummary",
"documentation":"<p>Summary information about the most recent revision of the artifact. For GitHub and AWS CodeCommit repositories, the commit message. For Amazon S3 buckets or actions, the user-provided content of a <code>codepipeline-artifact-revision-summary</code> key specified in the object metadata.</p>"
},
"created":{
"shape":"Timestamp",
"documentation":"<p>The date and time when the most recent revision of the artifact was created, in timestamp format.</p>"
},
"revisionUrl":{
"shape":"Url",
"documentation":"<p>The commit ID for the artifact revision. For artifacts stored in GitHub or AWS CodeCommit repositories, the commit ID is linked to a commit details page.</p>"
}
},
"documentation":"<p>Represents revision details of an artifact. </p>"
},
"ArtifactRevisionList":{
"type":"list",
"member":{"shape":"ArtifactRevision"}
},
"ArtifactStore":{
"type":"structure",
"required":[
"type",
"location"
],
"members":{
"type":{