github.com/aavshr/aws-sdk-go@v1.41.3/service/codepipeline/doc.go (about) 1 // Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. 2 3 // Package codepipeline provides the client and types for making API 4 // requests to AWS CodePipeline. 5 // 6 // Overview 7 // 8 // This is the AWS CodePipeline API Reference. This guide provides descriptions 9 // of the actions and data types for AWS CodePipeline. Some functionality for 10 // your pipeline can only be configured through the API. For more information, 11 // see the AWS CodePipeline User Guide (https://docs.aws.amazon.com/codepipeline/latest/userguide/welcome.html). 12 // 13 // You can use the AWS CodePipeline API to work with pipelines, stages, actions, 14 // and transitions. 15 // 16 // Pipelines are models of automated release processes. Each pipeline is uniquely 17 // named, and consists of stages, actions, and transitions. 18 // 19 // You can work with pipelines by calling: 20 // 21 // * CreatePipeline, which creates a uniquely named pipeline. 22 // 23 // * DeletePipeline, which deletes the specified pipeline. 24 // 25 // * GetPipeline, which returns information about the pipeline structure 26 // and pipeline metadata, including the pipeline Amazon Resource Name (ARN). 27 // 28 // * GetPipelineExecution, which returns information about a specific execution 29 // of a pipeline. 30 // 31 // * GetPipelineState, which returns information about the current state 32 // of the stages and actions of a pipeline. 33 // 34 // * ListActionExecutions, which returns action-level details for past executions. 35 // The details include full stage and action-level details, including individual 36 // action duration, status, any errors that occurred during the execution, 37 // and input and output artifact location details. 38 // 39 // * ListPipelines, which gets a summary of all of the pipelines associated 40 // with your account. 41 // 42 // * ListPipelineExecutions, which gets a summary of the most recent executions 43 // for a pipeline. 44 // 45 // * StartPipelineExecution, which runs the most recent revision of an artifact 46 // through the pipeline. 47 // 48 // * StopPipelineExecution, which stops the specified pipeline execution 49 // from continuing through the pipeline. 50 // 51 // * UpdatePipeline, which updates a pipeline with edits or changes to the 52 // structure of the pipeline. 53 // 54 // Pipelines include stages. Each stage contains one or more actions that must 55 // complete before the next stage begins. A stage results in success or failure. 56 // If a stage fails, the pipeline stops at that stage and remains stopped until 57 // either a new version of an artifact appears in the source location, or a 58 // user takes action to rerun the most recent artifact through the pipeline. 59 // You can call GetPipelineState, which displays the status of a pipeline, including 60 // the status of stages in the pipeline, or GetPipeline, which returns the entire 61 // structure of the pipeline, including the stages of that pipeline. For more 62 // information about the structure of stages and actions, see AWS CodePipeline 63 // Pipeline Structure Reference (https://docs.aws.amazon.com/codepipeline/latest/userguide/pipeline-structure.html). 64 // 65 // Pipeline stages include actions that are categorized into categories such 66 // as source or build actions performed in a stage of a pipeline. For example, 67 // you can use a source action to import artifacts into a pipeline from a source 68 // such as Amazon S3. Like stages, you do not work with actions directly in 69 // most cases, but you do define and interact with actions when working with 70 // pipeline operations such as CreatePipeline and GetPipelineState. Valid action 71 // categories are: 72 // 73 // * Source 74 // 75 // * Build 76 // 77 // * Test 78 // 79 // * Deploy 80 // 81 // * Approval 82 // 83 // * Invoke 84 // 85 // Pipelines also include transitions, which allow the transition of artifacts 86 // from one stage to the next in a pipeline after the actions in one stage complete. 87 // 88 // You can work with transitions by calling: 89 // 90 // * DisableStageTransition, which prevents artifacts from transitioning 91 // to the next stage in a pipeline. 92 // 93 // * EnableStageTransition, which enables transition of artifacts between 94 // stages in a pipeline. 95 // 96 // Using the API to integrate with AWS CodePipeline 97 // 98 // For third-party integrators or developers who want to create their own integrations 99 // with AWS CodePipeline, the expected sequence varies from the standard API 100 // user. To integrate with AWS CodePipeline, developers need to work with the 101 // following items: 102 // 103 // Jobs, which are instances of an action. For example, a job for a source action 104 // might import a revision of an artifact from a source. 105 // 106 // You can work with jobs by calling: 107 // 108 // * AcknowledgeJob, which confirms whether a job worker has received the 109 // specified job. 110 // 111 // * GetJobDetails, which returns the details of a job. 112 // 113 // * PollForJobs, which determines whether there are any jobs to act on. 114 // 115 // * PutJobFailureResult, which provides details of a job failure. 116 // 117 // * PutJobSuccessResult, which provides details of a job success. 118 // 119 // Third party jobs, which are instances of an action created by a partner action 120 // and integrated into AWS CodePipeline. Partner actions are created by members 121 // of the AWS Partner Network. 122 // 123 // You can work with third party jobs by calling: 124 // 125 // * AcknowledgeThirdPartyJob, which confirms whether a job worker has received 126 // the specified job. 127 // 128 // * GetThirdPartyJobDetails, which requests the details of a job for a partner 129 // action. 130 // 131 // * PollForThirdPartyJobs, which determines whether there are any jobs to 132 // act on. 133 // 134 // * PutThirdPartyJobFailureResult, which provides details of a job failure. 135 // 136 // * PutThirdPartyJobSuccessResult, which provides details of a job success. 137 // 138 // See https://docs.aws.amazon.com/goto/WebAPI/codepipeline-2015-07-09 for more information on this service. 139 // 140 // See codepipeline package documentation for more information. 141 // https://docs.aws.amazon.com/sdk-for-go/api/service/codepipeline/ 142 // 143 // Using the Client 144 // 145 // To contact AWS CodePipeline with the SDK use the New function to create 146 // a new service client. With that client you can make API requests to the service. 147 // These clients are safe to use concurrently. 148 // 149 // See the SDK's documentation for more information on how to use the SDK. 150 // https://docs.aws.amazon.com/sdk-for-go/api/ 151 // 152 // See aws.Config documentation for more information on configuring SDK clients. 153 // https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config 154 // 155 // See the AWS CodePipeline client CodePipeline for more 156 // information on creating client for this service. 157 // https://docs.aws.amazon.com/sdk-for-go/api/service/codepipeline/#New 158 package codepipeline