ebook img

AWS CodePipeline - API Reference PDF

187 Pages·2017·1.43 MB·English
by  
Save to my drive
Quick download
Download
Most books are stored in the elastic cloud where traffic is expensive. For this reason, we have a limit on daily download.

Preview AWS CodePipeline - API Reference

CodePipeline API Reference API Version 2015-07-09 CodePipeline API Reference CodePipeline: API Reference Copyright © 2022 Amazon Web Services, Inc. and/or its affiliates. All rights reserved. Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be affiliated with, connected to, or sponsored by Amazon. CodePipeline API Reference Table of Contents Welcome........................................................................................................................................... 1 Actions............................................................................................................................................. 3 AcknowledgeJob........................................................................................................................ 5 Request Syntax.................................................................................................................. 5 Request Parameters............................................................................................................ 5 Response Syntax................................................................................................................ 5 Response Elements............................................................................................................. 5 Errors............................................................................................................................... 6 Examples........................................................................................................................... 6 See Also............................................................................................................................ 7 AcknowledgeThirdPartyJob......................................................................................................... 8 Request Syntax.................................................................................................................. 8 Request Parameters............................................................................................................ 8 Response Syntax................................................................................................................ 8 Response Elements............................................................................................................. 9 Errors............................................................................................................................... 9 See Also............................................................................................................................ 9 CreateCustomActionType........................................................................................................... 11 Request Syntax................................................................................................................ 11 Request Parameters.......................................................................................................... 11 Response Syntax.............................................................................................................. 13 Response Elements........................................................................................................... 13 Errors.............................................................................................................................. 14 Examples......................................................................................................................... 14 See Also.......................................................................................................................... 16 CreatePipeline.......................................................................................................................... 17 Request Syntax................................................................................................................ 17 Request Parameters.......................................................................................................... 18 Response Syntax.............................................................................................................. 18 Response Elements........................................................................................................... 19 Errors.............................................................................................................................. 20 Examples......................................................................................................................... 21 See Also.......................................................................................................................... 23 DeleteCustomActionType........................................................................................................... 24 Request Syntax................................................................................................................ 24 Request Parameters.......................................................................................................... 24 Response Elements........................................................................................................... 25 Errors.............................................................................................................................. 25 Examples......................................................................................................................... 25 See Also.......................................................................................................................... 25 DeletePipeline.......................................................................................................................... 27 Request Syntax................................................................................................................ 27 Request Parameters.......................................................................................................... 27 Response Elements........................................................................................................... 27 Errors.............................................................................................................................. 27 Examples......................................................................................................................... 27 See Also.......................................................................................................................... 28 DeleteWebhook........................................................................................................................ 29 Request Syntax................................................................................................................ 29 Request Parameters.......................................................................................................... 29 Response Elements........................................................................................................... 29 Errors.............................................................................................................................. 29 See Also.......................................................................................................................... 29 DeregisterWebhookWithThirdParty............................................................................................. 31 API Version 2015-07-09 iii CodePipeline API Reference Request Syntax................................................................................................................ 31 Request Parameters.......................................................................................................... 31 Response Elements........................................................................................................... 31 Errors.............................................................................................................................. 31 See Also.......................................................................................................................... 31 DisableStageTransition.............................................................................................................. 33 Request Syntax................................................................................................................ 33 Request Parameters.......................................................................................................... 33 Response Elements........................................................................................................... 34 Errors.............................................................................................................................. 34 Examples......................................................................................................................... 34 See Also.......................................................................................................................... 35 EnableStageTransition............................................................................................................... 36 Request Syntax................................................................................................................ 36 Request Parameters.......................................................................................................... 36 Response Elements........................................................................................................... 37 Errors.............................................................................................................................. 37 Examples......................................................................................................................... 37 See Also.......................................................................................................................... 38 GetActionType......................................................................................................................... 39 Request Syntax................................................................................................................ 39 Request Parameters.......................................................................................................... 39 Response Syntax.............................................................................................................. 40 Response Elements........................................................................................................... 41 Errors.............................................................................................................................. 41 See Also.......................................................................................................................... 41 GetJobDetails........................................................................................................................... 42 Request Syntax................................................................................................................ 42 Request Parameters.......................................................................................................... 42 Response Syntax.............................................................................................................. 42 Response Elements........................................................................................................... 43 Errors.............................................................................................................................. 43 Examples......................................................................................................................... 44 See Also.......................................................................................................................... 45 GetPipeline.............................................................................................................................. 46 Request Syntax................................................................................................................ 46 Request Parameters.......................................................................................................... 46 Response Syntax.............................................................................................................. 46 Response Elements........................................................................................................... 47 Errors.............................................................................................................................. 48 Examples......................................................................................................................... 48 See Also.......................................................................................................................... 50 GetPipelineExecution................................................................................................................ 51 Request Syntax................................................................................................................ 51 Request Parameters.......................................................................................................... 51 Response Syntax.............................................................................................................. 51 Response Elements........................................................................................................... 52 Errors.............................................................................................................................. 52 Examples......................................................................................................................... 52 See Also.......................................................................................................................... 53 GetPipelineState....................................................................................................................... 54 Request Syntax................................................................................................................ 54 Request Parameters.......................................................................................................... 54 Response Syntax.............................................................................................................. 54 Response Elements........................................................................................................... 55 Errors.............................................................................................................................. 56 Examples......................................................................................................................... 56 API Version 2015-07-09 iv CodePipeline API Reference See Also.......................................................................................................................... 57 GetThirdPartyJobDetails............................................................................................................ 59 Request Syntax................................................................................................................ 59 Request Parameters.......................................................................................................... 59 Response Syntax.............................................................................................................. 59 Response Elements........................................................................................................... 60 Errors.............................................................................................................................. 61 See Also.......................................................................................................................... 61 ListActionExecutions................................................................................................................. 62 Request Syntax................................................................................................................ 62 Request Parameters.......................................................................................................... 62 Response Syntax.............................................................................................................. 63 Response Elements........................................................................................................... 64 Errors.............................................................................................................................. 64 See Also.......................................................................................................................... 64 ListActionTypes........................................................................................................................ 66 Request Syntax................................................................................................................ 66 Request Parameters.......................................................................................................... 66 Response Syntax.............................................................................................................. 66 Response Elements........................................................................................................... 67 Errors.............................................................................................................................. 67 Examples......................................................................................................................... 68 See Also.......................................................................................................................... 72 ListPipelineExecutions............................................................................................................... 73 Request Syntax................................................................................................................ 73 Request Parameters.......................................................................................................... 73 Response Syntax.............................................................................................................. 73 Response Elements........................................................................................................... 74 Errors.............................................................................................................................. 74 See Also.......................................................................................................................... 75 ListPipelines............................................................................................................................. 76 Request Syntax................................................................................................................ 76 Request Parameters.......................................................................................................... 76 Response Syntax.............................................................................................................. 76 Response Elements........................................................................................................... 77 Errors.............................................................................................................................. 77 Examples......................................................................................................................... 77 See Also.......................................................................................................................... 78 ListTagsForResource.................................................................................................................. 79 Request Syntax................................................................................................................ 79 Request Parameters.......................................................................................................... 79 Response Syntax.............................................................................................................. 79 Response Elements........................................................................................................... 80 Errors.............................................................................................................................. 80 See Also.......................................................................................................................... 80 ListWebhooks........................................................................................................................... 82 Request Syntax................................................................................................................ 82 Request Parameters.......................................................................................................... 82 Response Syntax.............................................................................................................. 82 Response Elements........................................................................................................... 83 Errors.............................................................................................................................. 83 See Also.......................................................................................................................... 84 PollForJobs.............................................................................................................................. 85 Request Syntax................................................................................................................ 85 Request Parameters.......................................................................................................... 85 Response Syntax.............................................................................................................. 86 Response Elements........................................................................................................... 87 API Version 2015-07-09 v CodePipeline API Reference Errors.............................................................................................................................. 87 Examples......................................................................................................................... 87 See Also.......................................................................................................................... 89 PollForThirdPartyJobs............................................................................................................... 90 Request Syntax................................................................................................................ 90 Request Parameters.......................................................................................................... 90 Response Syntax.............................................................................................................. 90 Response Elements........................................................................................................... 91 Errors.............................................................................................................................. 91 See Also.......................................................................................................................... 91 PutActionRevision..................................................................................................................... 92 Request Syntax................................................................................................................ 92 Request Parameters.......................................................................................................... 92 Response Syntax.............................................................................................................. 93 Response Elements........................................................................................................... 93 Errors.............................................................................................................................. 93 Examples......................................................................................................................... 94 See Also.......................................................................................................................... 94 PutApprovalResult.................................................................................................................... 96 Request Syntax................................................................................................................ 96 Request Parameters.......................................................................................................... 96 Response Syntax.............................................................................................................. 97 Response Elements........................................................................................................... 97 Errors.............................................................................................................................. 97 Examples......................................................................................................................... 98 See Also.......................................................................................................................... 99 PutJobFailureResult................................................................................................................ 100 Request Syntax.............................................................................................................. 100 Request Parameters........................................................................................................ 100 Response Elements......................................................................................................... 100 Errors............................................................................................................................ 100 See Also........................................................................................................................ 101 PutJobSuccessResult............................................................................................................... 102 Request Syntax.............................................................................................................. 102 Request Parameters........................................................................................................ 102 Response Elements......................................................................................................... 103 Errors............................................................................................................................ 103 See Also........................................................................................................................ 103 PutThirdPartyJobFailureResult.................................................................................................. 105 Request Syntax.............................................................................................................. 105 Request Parameters........................................................................................................ 105 Response Elements......................................................................................................... 105 Errors............................................................................................................................ 106 See Also........................................................................................................................ 106 PutThirdPartyJobSuccessResult................................................................................................. 107 Request Syntax.............................................................................................................. 107 Request Parameters........................................................................................................ 107 Response Elements......................................................................................................... 108 Errors............................................................................................................................ 108 See Also........................................................................................................................ 108 PutWebhook.......................................................................................................................... 110 Request Syntax.............................................................................................................. 110 Request Parameters........................................................................................................ 110 Response Syntax............................................................................................................ 111 Response Elements......................................................................................................... 111 Errors............................................................................................................................ 111 See Also........................................................................................................................ 112 API Version 2015-07-09 vi CodePipeline API Reference RegisterWebhookWithThirdParty.............................................................................................. 113 Request Syntax.............................................................................................................. 113 Request Parameters........................................................................................................ 113 Response Elements......................................................................................................... 113 Errors............................................................................................................................ 113 See Also........................................................................................................................ 113 RetryStageExecution............................................................................................................... 115 Request Syntax.............................................................................................................. 115 Request Parameters........................................................................................................ 115 Response Syntax............................................................................................................ 116 Response Elements......................................................................................................... 116 Errors............................................................................................................................ 116 Examples....................................................................................................................... 117 See Also........................................................................................................................ 117 StartPipelineExecution............................................................................................................. 119 Request Syntax.............................................................................................................. 119 Request Parameters........................................................................................................ 119 Response Syntax............................................................................................................ 119 Response Elements......................................................................................................... 119 Errors............................................................................................................................ 120 Examples....................................................................................................................... 120 See Also........................................................................................................................ 121 StopPipelineExecution............................................................................................................. 122 Request Syntax.............................................................................................................. 122 Request Parameters........................................................................................................ 122 Response Syntax............................................................................................................ 123 Response Elements......................................................................................................... 123 Errors............................................................................................................................ 123 See Also........................................................................................................................ 124 TagResource........................................................................................................................... 125 Request Syntax.............................................................................................................. 125 Request Parameters........................................................................................................ 125 Response Elements......................................................................................................... 125 Errors............................................................................................................................ 125 See Also........................................................................................................................ 126 UntagResource....................................................................................................................... 127 Request Syntax.............................................................................................................. 127 Request Parameters........................................................................................................ 127 Response Elements......................................................................................................... 127 Errors............................................................................................................................ 127 See Also........................................................................................................................ 128 UpdateActionType.................................................................................................................. 129 Request Syntax.............................................................................................................. 129 Request Parameters........................................................................................................ 130 Response Elements......................................................................................................... 130 Errors............................................................................................................................ 130 See Also........................................................................................................................ 130 UpdatePipeline....................................................................................................................... 132 Request Syntax.............................................................................................................. 132 Request Parameters........................................................................................................ 133 Response Syntax............................................................................................................ 133 Response Elements......................................................................................................... 134 Errors............................................................................................................................ 134 Examples....................................................................................................................... 135 See Also........................................................................................................................ 137 Data Types.................................................................................................................................... 139 ActionConfiguration................................................................................................................ 141 API Version 2015-07-09 vii CodePipeline API Reference Contents........................................................................................................................ 141 See Also........................................................................................................................ 141 ActionConfigurationProperty.................................................................................................... 142 Contents........................................................................................................................ 142 See Also........................................................................................................................ 143 ActionContext........................................................................................................................ 144 Contents........................................................................................................................ 144 See Also........................................................................................................................ 144 ActionDeclaration................................................................................................................... 145 Contents........................................................................................................................ 145 See Also........................................................................................................................ 146 ActionExecution...................................................................................................................... 147 Contents........................................................................................................................ 147 See Also........................................................................................................................ 148 ActionExecutionDetail .............................................................................................................. 149 Contents........................................................................................................................ 149 See Also........................................................................................................................ 150 ActionExecutionFilter.............................................................................................................. 151 Contents........................................................................................................................ 151 See Also........................................................................................................................ 151 ActionExecutionInput.............................................................................................................. 152 Contents........................................................................................................................ 152 See Also........................................................................................................................ 153 ActionExecutionOutput............................................................................................................ 154 Contents........................................................................................................................ 154 See Also........................................................................................................................ 154 ActionExecutionResult............................................................................................................. 155 Contents........................................................................................................................ 155 See Also........................................................................................................................ 155 ActionRevision........................................................................................................................ 156 Contents........................................................................................................................ 156 See Also........................................................................................................................ 156 ActionState............................................................................................................................ 157 Contents........................................................................................................................ 157 See Also........................................................................................................................ 157 ActionType............................................................................................................................. 159 Contents........................................................................................................................ 159 See Also........................................................................................................................ 159 ActionTypeArtifactDetails........................................................................................................ 160 Contents........................................................................................................................ 160 See Also........................................................................................................................ 160 ActionTypeDeclaration............................................................................................................. 161 Contents........................................................................................................................ 161 See Also........................................................................................................................ 162 ActionTypeExecutor................................................................................................................ 163 Contents........................................................................................................................ 163 See Also........................................................................................................................ 163 ActionTypeId.......................................................................................................................... 165 Contents........................................................................................................................ 165 See Also........................................................................................................................ 166 ActionTypeIdentifier................................................................................................................ 167 Contents........................................................................................................................ 167 See Also........................................................................................................................ 167 ActionTypePermissions............................................................................................................ 169 Contents........................................................................................................................ 169 See Also........................................................................................................................ 169 ActionTypeProperty................................................................................................................ 170 API Version 2015-07-09 viii CodePipeline API Reference Contents........................................................................................................................ 170 See Also........................................................................................................................ 171 ActionTypeSettings................................................................................................................. 172 Contents........................................................................................................................ 172 See Also........................................................................................................................ 172 ActionTypeUrls....................................................................................................................... 174 Contents........................................................................................................................ 174 See Also........................................................................................................................ 174 ApprovalResult....................................................................................................................... 176 Contents........................................................................................................................ 176 See Also........................................................................................................................ 176 Artifact.................................................................................................................................. 177 Contents........................................................................................................................ 177 See Also........................................................................................................................ 177 ArtifactDetail......................................................................................................................... 178 Contents........................................................................................................................ 178 See Also........................................................................................................................ 178 ArtifactDetails........................................................................................................................ 179 Contents........................................................................................................................ 179 See Also........................................................................................................................ 179 ArtifactLocation...................................................................................................................... 180 Contents........................................................................................................................ 180 See Also........................................................................................................................ 180 ArtifactRevision...................................................................................................................... 181 Contents........................................................................................................................ 181 See Also........................................................................................................................ 182 ArtifactStore.......................................................................................................................... 183 Contents........................................................................................................................ 183 See Also........................................................................................................................ 183 AWSSessionCredentials............................................................................................................ 184 Contents........................................................................................................................ 184 See Also........................................................................................................................ 184 BlockerDeclaration.................................................................................................................. 185 Contents........................................................................................................................ 185 See Also........................................................................................................................ 185 CurrentRevision...................................................................................................................... 186 Contents........................................................................................................................ 186 See Also........................................................................................................................ 186 EncryptionKey........................................................................................................................ 187 Contents........................................................................................................................ 187 See Also........................................................................................................................ 187 ErrorDetails............................................................................................................................ 188 Contents........................................................................................................................ 188 See Also........................................................................................................................ 188 ExecutionDetails..................................................................................................................... 189 Contents........................................................................................................................ 189 See Also........................................................................................................................ 189 ExecutionTrigger..................................................................................................................... 190 Contents........................................................................................................................ 190 See Also........................................................................................................................ 190 ExecutorConfiguration............................................................................................................. 191 Contents........................................................................................................................ 191 See Also........................................................................................................................ 191 FailureDetails......................................................................................................................... 192 Contents........................................................................................................................ 192 See Also........................................................................................................................ 192 InputArtifact.......................................................................................................................... 193 API Version 2015-07-09 ix CodePipeline API Reference Contents........................................................................................................................ 193 See Also........................................................................................................................ 193 Job....................................................................................................................................... 194 Contents........................................................................................................................ 194 See Also........................................................................................................................ 194 JobData................................................................................................................................. 195 Contents........................................................................................................................ 195 See Also........................................................................................................................ 196 JobDetails.............................................................................................................................. 197 Contents........................................................................................................................ 197 See Also........................................................................................................................ 197 JobWorkerExecutorConfiguration.............................................................................................. 198 Contents........................................................................................................................ 198 See Also........................................................................................................................ 198 LambdaExecutorConfiguration.................................................................................................. 199 Contents........................................................................................................................ 199 See Also........................................................................................................................ 199 ListWebhookItem.................................................................................................................... 200 Contents........................................................................................................................ 200 See Also........................................................................................................................ 201 OutputArtifact....................................................................................................................... 202 Contents........................................................................................................................ 202 See Also........................................................................................................................ 202 PipelineContext...................................................................................................................... 203 Contents........................................................................................................................ 203 See Also........................................................................................................................ 203 PipelineDeclaration................................................................................................................. 205 Contents........................................................................................................................ 205 See Also........................................................................................................................ 206 PipelineExecution................................................................................................................... 207 Contents........................................................................................................................ 207 See Also........................................................................................................................ 208 PipelineExecutionSummary...................................................................................................... 209 Contents........................................................................................................................ 209 See Also........................................................................................................................ 210 PipelineMetadata.................................................................................................................... 211 Contents........................................................................................................................ 211 See Also........................................................................................................................ 211 PipelineSummary.................................................................................................................... 212 Contents........................................................................................................................ 212 See Also........................................................................................................................ 212 S3ArtifactLocation.................................................................................................................. 213 Contents........................................................................................................................ 213 See Also........................................................................................................................ 213 S3Location............................................................................................................................. 214 Contents........................................................................................................................ 214 See Also........................................................................................................................ 214 SourceRevision....................................................................................................................... 215 Contents........................................................................................................................ 215 See Also........................................................................................................................ 215 StageContext......................................................................................................................... 217 Contents........................................................................................................................ 217 See Also........................................................................................................................ 217 StageDeclaration.................................................................................................................... 218 Contents........................................................................................................................ 218 See Also........................................................................................................................ 218 StageExecution....................................................................................................................... 219 API Version 2015-07-09 x

Description:
AWS CodePipeline API Reference. Response Elements. Response Elements. If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors. For information about the errors that are common to all actions, see Common Errors (p. 159). ValidationException.
See more

The list of books you might like

Most books are stored in the elastic cloud where traffic is expensive. For this reason, we have a limit on daily download.