doc.go 6.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153
  1. // Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
  2. // Package codecommit provides the client and types for making API
  3. // requests to AWS CodeCommit.
  4. //
  5. // This is the AWS CodeCommit API Reference. This reference provides descriptions
  6. // of the operations and data types for AWS CodeCommit API along with usage
  7. // examples.
  8. //
  9. // You can use the AWS CodeCommit API to work with the following objects:
  10. //
  11. // Repositories, by calling the following:
  12. //
  13. // * BatchGetRepositories, which returns information about one or more repositories
  14. // associated with your AWS account.
  15. //
  16. // * CreateRepository, which creates an AWS CodeCommit repository.
  17. //
  18. // * DeleteRepository, which deletes an AWS CodeCommit repository.
  19. //
  20. // * GetRepository, which returns information about a specified repository.
  21. //
  22. // * ListRepositories, which lists all AWS CodeCommit repositories associated
  23. // with your AWS account.
  24. //
  25. // * UpdateRepositoryDescription, which sets or updates the description of
  26. // the repository.
  27. //
  28. // * UpdateRepositoryName, which changes the name of the repository. If you
  29. // change the name of a repository, no other users of that repository will
  30. // be able to access it until you send them the new HTTPS or SSH URL to use.
  31. //
  32. // Branches, by calling the following:
  33. //
  34. // * CreateBranch, which creates a new branch in a specified repository.
  35. //
  36. // * DeleteBranch, which deletes the specified branch in a repository unless
  37. // it is the default branch.
  38. //
  39. // * GetBranch, which returns information about a specified branch.
  40. //
  41. // * ListBranches, which lists all branches for a specified repository.
  42. //
  43. // * UpdateDefaultBranch, which changes the default branch for a repository.
  44. //
  45. // Files, by calling the following:
  46. //
  47. // * DeleteFile, which deletes the content of a specified file from a specified
  48. // branch.
  49. //
  50. // * GetFile, which returns the base-64 encoded content of a specified file.
  51. //
  52. // * GetFolder, which returns the contents of a specified folder or directory.
  53. //
  54. // * PutFile, which adds or modifies a file in a specified repository and
  55. // branch.
  56. //
  57. // Information about committed code in a repository, by calling the following:
  58. //
  59. // * GetBlob, which returns the base-64 encoded content of an individual
  60. // Git blob object within a repository.
  61. //
  62. // * GetCommit, which returns information about a commit, including commit
  63. // messages and author and committer information.
  64. //
  65. // * GetDifferences, which returns information about the differences in a
  66. // valid commit specifier (such as a branch, tag, HEAD, commit ID or other
  67. // fully qualified reference).
  68. //
  69. // Pull requests, by calling the following:
  70. //
  71. // * CreatePullRequest, which creates a pull request in a specified repository.
  72. //
  73. // * DescribePullRequestEvents, which returns information about one or more
  74. // pull request events.
  75. //
  76. // * GetCommentsForPullRequest, which returns information about comments
  77. // on a specified pull request.
  78. //
  79. // * GetMergeConflicts, which returns information about merge conflicts between
  80. // the source and destination branch in a pull request.
  81. //
  82. // * GetPullRequest, which returns information about a specified pull request.
  83. //
  84. // * ListPullRequests, which lists all pull requests for a repository.
  85. //
  86. // * MergePullRequestByFastForward, which merges the source destination branch
  87. // of a pull request into the specified destination branch for that pull
  88. // request using the fast-forward merge option.
  89. //
  90. // * PostCommentForPullRequest, which posts a comment to a pull request at
  91. // the specified line, file, or request.
  92. //
  93. // * UpdatePullRequestDescription, which updates the description of a pull
  94. // request.
  95. //
  96. // * UpdatePullRequestStatus, which updates the status of a pull request.
  97. //
  98. // * UpdatePullRequestTitle, which updates the title of a pull request.
  99. //
  100. // Information about comments in a repository, by calling the following:
  101. //
  102. // * DeleteCommentContent, which deletes the content of a comment on a commit
  103. // in a repository.
  104. //
  105. // * GetComment, which returns information about a comment on a commit.
  106. //
  107. // * GetCommentsForComparedCommit, which returns information about comments
  108. // on the comparison between two commit specifiers in a repository.
  109. //
  110. // * PostCommentForComparedCommit, which creates a comment on the comparison
  111. // between two commit specifiers in a repository.
  112. //
  113. // * PostCommentReply, which creates a reply to a comment.
  114. //
  115. // * UpdateComment, which updates the content of a comment on a commit in
  116. // a repository.
  117. //
  118. // Triggers, by calling the following:
  119. //
  120. // * GetRepositoryTriggers, which returns information about triggers configured
  121. // for a repository.
  122. //
  123. // * PutRepositoryTriggers, which replaces all triggers for a repository
  124. // and can be used to create or delete triggers.
  125. //
  126. // * TestRepositoryTriggers, which tests the functionality of a repository
  127. // trigger by sending data to the trigger target.
  128. //
  129. // For information about how to use AWS CodeCommit, see the AWS CodeCommit User
  130. // Guide (http://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html).
  131. //
  132. // See https://docs.aws.amazon.com/goto/WebAPI/codecommit-2015-04-13 for more information on this service.
  133. //
  134. // See codecommit package documentation for more information.
  135. // https://docs.aws.amazon.com/sdk-for-go/api/service/codecommit/
  136. //
  137. // Using the Client
  138. //
  139. // To contact AWS CodeCommit with the SDK use the New function to create
  140. // a new service client. With that client you can make API requests to the service.
  141. // These clients are safe to use concurrently.
  142. //
  143. // See the SDK's documentation for more information on how to use the SDK.
  144. // https://docs.aws.amazon.com/sdk-for-go/api/
  145. //
  146. // See aws.Config documentation for more information on configuring SDK clients.
  147. // https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config
  148. //
  149. // See the AWS CodeCommit client CodeCommit for more
  150. // information on creating client for this service.
  151. // https://docs.aws.amazon.com/sdk-for-go/api/service/codecommit/#New
  152. package codecommit