github.com/aavshr/aws-sdk-go@v1.41.3/service/codecommit/doc.go (about) 1 // Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. 2 3 // Package codecommit provides the client and types for making API 4 // requests to AWS CodeCommit. 5 // 6 // This is the AWS CodeCommit API Reference. This reference provides descriptions 7 // of the operations and data types for AWS CodeCommit API along with usage 8 // examples. 9 // 10 // You can use the AWS CodeCommit API to work with the following objects: 11 // 12 // Repositories, by calling the following: 13 // 14 // * BatchGetRepositories, which returns information about one or more repositories 15 // associated with your AWS account. 16 // 17 // * CreateRepository, which creates an AWS CodeCommit repository. 18 // 19 // * DeleteRepository, which deletes an AWS CodeCommit repository. 20 // 21 // * GetRepository, which returns information about a specified repository. 22 // 23 // * ListRepositories, which lists all AWS CodeCommit repositories associated 24 // with your AWS account. 25 // 26 // * UpdateRepositoryDescription, which sets or updates the description of 27 // the repository. 28 // 29 // * UpdateRepositoryName, which changes the name of the repository. If you 30 // change the name of a repository, no other users of that repository can 31 // access it until you send them the new HTTPS or SSH URL to use. 32 // 33 // Branches, by calling the following: 34 // 35 // * CreateBranch, which creates a branch in a specified repository. 36 // 37 // * DeleteBranch, which deletes the specified branch in a repository unless 38 // it is the default branch. 39 // 40 // * GetBranch, which returns information about a specified branch. 41 // 42 // * ListBranches, which lists all branches for a specified repository. 43 // 44 // * UpdateDefaultBranch, which changes the default branch for a repository. 45 // 46 // Files, by calling the following: 47 // 48 // * DeleteFile, which deletes the content of a specified file from a specified 49 // branch. 50 // 51 // * GetBlob, which returns the base-64 encoded content of an individual 52 // Git blob object in a repository. 53 // 54 // * GetFile, which returns the base-64 encoded content of a specified file. 55 // 56 // * GetFolder, which returns the contents of a specified folder or directory. 57 // 58 // * PutFile, which adds or modifies a single file in a specified repository 59 // and branch. 60 // 61 // Commits, by calling the following: 62 // 63 // * BatchGetCommits, which returns information about one or more commits 64 // in a repository. 65 // 66 // * CreateCommit, which creates a commit for changes to a repository. 67 // 68 // * GetCommit, which returns information about a commit, including commit 69 // messages and author and committer information. 70 // 71 // * GetDifferences, which returns information about the differences in a 72 // valid commit specifier (such as a branch, tag, HEAD, commit ID, or other 73 // fully qualified reference). 74 // 75 // Merges, by calling the following: 76 // 77 // * BatchDescribeMergeConflicts, which returns information about conflicts 78 // in a merge between commits in a repository. 79 // 80 // * CreateUnreferencedMergeCommit, which creates an unreferenced commit 81 // between two branches or commits for the purpose of comparing them and 82 // identifying any potential conflicts. 83 // 84 // * DescribeMergeConflicts, which returns information about merge conflicts 85 // between the base, source, and destination versions of a file in a potential 86 // merge. 87 // 88 // * GetMergeCommit, which returns information about the merge between a 89 // source and destination commit. 90 // 91 // * GetMergeConflicts, which returns information about merge conflicts between 92 // the source and destination branch in a pull request. 93 // 94 // * GetMergeOptions, which returns information about the available merge 95 // options between two branches or commit specifiers. 96 // 97 // * MergeBranchesByFastForward, which merges two branches using the fast-forward 98 // merge option. 99 // 100 // * MergeBranchesBySquash, which merges two branches using the squash merge 101 // option. 102 // 103 // * MergeBranchesByThreeWay, which merges two branches using the three-way 104 // merge option. 105 // 106 // Pull requests, by calling the following: 107 // 108 // * CreatePullRequest, which creates a pull request in a specified repository. 109 // 110 // * CreatePullRequestApprovalRule, which creates an approval rule for a 111 // specified pull request. 112 // 113 // * DeletePullRequestApprovalRule, which deletes an approval rule for a 114 // specified pull request. 115 // 116 // * DescribePullRequestEvents, which returns information about one or more 117 // pull request events. 118 // 119 // * EvaluatePullRequestApprovalRules, which evaluates whether a pull request 120 // has met all the conditions specified in its associated approval rules. 121 // 122 // * GetCommentsForPullRequest, which returns information about comments 123 // on a specified pull request. 124 // 125 // * GetPullRequest, which returns information about a specified pull request. 126 // 127 // * GetPullRequestApprovalStates, which returns information about the approval 128 // states for a specified pull request. 129 // 130 // * GetPullRequestOverrideState, which returns information about whether 131 // approval rules have been set aside (overriden) for a pull request, and 132 // if so, the Amazon Resource Name (ARN) of the user or identity that overrode 133 // the rules and their requirements for the pull request. 134 // 135 // * ListPullRequests, which lists all pull requests for a repository. 136 // 137 // * MergePullRequestByFastForward, which merges the source destination branch 138 // of a pull request into the specified destination branch for that pull 139 // request using the fast-forward merge option. 140 // 141 // * MergePullRequestBySquash, which merges the source destination branch 142 // of a pull request into the specified destination branch for that pull 143 // request using the squash merge option. 144 // 145 // * MergePullRequestByThreeWay. which merges the source destination branch 146 // of a pull request into the specified destination branch for that pull 147 // request using the three-way merge option. 148 // 149 // * OverridePullRequestApprovalRules, which sets aside all approval rule 150 // requirements for a pull request. 151 // 152 // * PostCommentForPullRequest, which posts a comment to a pull request at 153 // the specified line, file, or request. 154 // 155 // * UpdatePullRequestApprovalRuleContent, which updates the structure of 156 // an approval rule for a pull request. 157 // 158 // * UpdatePullRequestApprovalState, which updates the state of an approval 159 // on a pull request. 160 // 161 // * UpdatePullRequestDescription, which updates the description of a pull 162 // request. 163 // 164 // * UpdatePullRequestStatus, which updates the status of a pull request. 165 // 166 // * UpdatePullRequestTitle, which updates the title of a pull request. 167 // 168 // Approval rule templates, by calling the following: 169 // 170 // * AssociateApprovalRuleTemplateWithRepository, which associates a template 171 // with a specified repository. After the template is associated with a repository, 172 // AWS CodeCommit creates approval rules that match the template conditions 173 // on every pull request created in the specified repository. 174 // 175 // * BatchAssociateApprovalRuleTemplateWithRepositories, which associates 176 // a template with one or more specified repositories. After the template 177 // is associated with a repository, AWS CodeCommit creates approval rules 178 // that match the template conditions on every pull request created in the 179 // specified repositories. 180 // 181 // * BatchDisassociateApprovalRuleTemplateFromRepositories, which removes 182 // the association between a template and specified repositories so that 183 // approval rules based on the template are not automatically created when 184 // pull requests are created in those repositories. 185 // 186 // * CreateApprovalRuleTemplate, which creates a template for approval rules 187 // that can then be associated with one or more repositories in your AWS 188 // account. 189 // 190 // * DeleteApprovalRuleTemplate, which deletes the specified template. It 191 // does not remove approval rules on pull requests already created with the 192 // template. 193 // 194 // * DisassociateApprovalRuleTemplateFromRepository, which removes the association 195 // between a template and a repository so that approval rules based on the 196 // template are not automatically created when pull requests are created 197 // in the specified repository. 198 // 199 // * GetApprovalRuleTemplate, which returns information about an approval 200 // rule template. 201 // 202 // * ListApprovalRuleTemplates, which lists all approval rule templates in 203 // the AWS Region in your AWS account. 204 // 205 // * ListAssociatedApprovalRuleTemplatesForRepository, which lists all approval 206 // rule templates that are associated with a specified repository. 207 // 208 // * ListRepositoriesForApprovalRuleTemplate, which lists all repositories 209 // associated with the specified approval rule template. 210 // 211 // * UpdateApprovalRuleTemplateDescription, which updates the description 212 // of an approval rule template. 213 // 214 // * UpdateApprovalRuleTemplateName, which updates the name of an approval 215 // rule template. 216 // 217 // * UpdateApprovalRuleTemplateContent, which updates the content of an approval 218 // rule template. 219 // 220 // Comments in a repository, by calling the following: 221 // 222 // * DeleteCommentContent, which deletes the content of a comment on a commit 223 // in a repository. 224 // 225 // * GetComment, which returns information about a comment on a commit. 226 // 227 // * GetCommentReactions, which returns information about emoji reactions 228 // to comments. 229 // 230 // * GetCommentsForComparedCommit, which returns information about comments 231 // on the comparison between two commit specifiers in a repository. 232 // 233 // * PostCommentForComparedCommit, which creates a comment on the comparison 234 // between two commit specifiers in a repository. 235 // 236 // * PostCommentReply, which creates a reply to a comment. 237 // 238 // * PutCommentReaction, which creates or updates an emoji reaction to a 239 // comment. 240 // 241 // * UpdateComment, which updates the content of a comment on a commit in 242 // a repository. 243 // 244 // Tags used to tag resources in AWS CodeCommit (not Git tags), by calling the 245 // following: 246 // 247 // * ListTagsForResource, which gets information about AWS tags for a specified 248 // Amazon Resource Name (ARN) in AWS CodeCommit. 249 // 250 // * TagResource, which adds or updates tags for a resource in AWS CodeCommit. 251 // 252 // * UntagResource, which removes tags for a resource in AWS CodeCommit. 253 // 254 // Triggers, by calling the following: 255 // 256 // * GetRepositoryTriggers, which returns information about triggers configured 257 // for a repository. 258 // 259 // * PutRepositoryTriggers, which replaces all triggers for a repository 260 // and can be used to create or delete triggers. 261 // 262 // * TestRepositoryTriggers, which tests the functionality of a repository 263 // trigger by sending data to the trigger target. 264 // 265 // For information about how to use AWS CodeCommit, see the AWS CodeCommit User 266 // Guide (https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html). 267 // 268 // See https://docs.aws.amazon.com/goto/WebAPI/codecommit-2015-04-13 for more information on this service. 269 // 270 // See codecommit package documentation for more information. 271 // https://docs.aws.amazon.com/sdk-for-go/api/service/codecommit/ 272 // 273 // Using the Client 274 // 275 // To contact AWS CodeCommit with the SDK use the New function to create 276 // a new service client. With that client you can make API requests to the service. 277 // These clients are safe to use concurrently. 278 // 279 // See the SDK's documentation for more information on how to use the SDK. 280 // https://docs.aws.amazon.com/sdk-for-go/api/ 281 // 282 // See aws.Config documentation for more information on configuring SDK clients. 283 // https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config 284 // 285 // See the AWS CodeCommit client CodeCommit for more 286 // information on creating client for this service. 287 // https://docs.aws.amazon.com/sdk-for-go/api/service/codecommit/#New 288 package codecommit