doc.go 4.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495
  1. // Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
  2. // Package codebuild provides the client and types for making API
  3. // requests to AWS CodeBuild.
  4. //
  5. // AWS CodeBuild is a fully managed build service in the cloud. AWS CodeBuild
  6. // compiles your source code, runs unit tests, and produces artifacts that are
  7. // ready to deploy. AWS CodeBuild eliminates the need to provision, manage,
  8. // and scale your own build servers. It provides prepackaged build environments
  9. // for the most popular programming languages and build tools, such as Apache
  10. // Maven, Gradle, and more. You can also fully customize build environments
  11. // in AWS CodeBuild to use your own build tools. AWS CodeBuild scales automatically
  12. // to meet peak build requests. You pay only for the build time you consume.
  13. // For more information about AWS CodeBuild, see the AWS CodeBuild User Guide.
  14. //
  15. // AWS CodeBuild supports these operations:
  16. //
  17. // * BatchDeleteBuilds: Deletes one or more builds.
  18. //
  19. // * BatchGetProjects: Gets information about one or more build projects.
  20. // A build project defines how AWS CodeBuild runs a build. This includes
  21. // information such as where to get the source code to build, the build environment
  22. // to use, the build commands to run, and where to store the build output.
  23. // A build environment is a representation of operating system, programming
  24. // language runtime, and tools that AWS CodeBuild uses to run a build. You
  25. // can add tags to build projects to help manage your resources and costs.
  26. //
  27. // * CreateProject: Creates a build project.
  28. //
  29. // * CreateWebhook: For an existing AWS CodeBuild build project that has
  30. // its source code stored in a GitHub or Bitbucket repository, enables AWS
  31. // CodeBuild to start rebuilding the source code every time a code change
  32. // is pushed to the repository.
  33. //
  34. // * UpdateWebhook: Changes the settings of an existing webhook.
  35. //
  36. // * DeleteProject: Deletes a build project.
  37. //
  38. // * DeleteWebhook: For an existing AWS CodeBuild build project that has
  39. // its source code stored in a GitHub or Bitbucket repository, stops AWS
  40. // CodeBuild from rebuilding the source code every time a code change is
  41. // pushed to the repository.
  42. //
  43. // * ListProjects: Gets a list of build project names, with each build project
  44. // name representing a single build project.
  45. //
  46. // * UpdateProject: Changes the settings of an existing build project.
  47. //
  48. // * BatchGetBuilds: Gets information about one or more builds.
  49. //
  50. // * ListBuilds: Gets a list of build IDs, with each build ID representing
  51. // a single build.
  52. //
  53. // * ListBuildsForProject: Gets a list of build IDs for the specified build
  54. // project, with each build ID representing a single build.
  55. //
  56. // * StartBuild: Starts running a build.
  57. //
  58. // * StopBuild: Attempts to stop running a build.
  59. //
  60. // * ListCuratedEnvironmentImages: Gets information about Docker images that
  61. // are managed by AWS CodeBuild.
  62. //
  63. // * DeleteSourceCredentials: Deletes a set of GitHub, GitHub Enterprise,
  64. // or Bitbucket source credentials.
  65. //
  66. // * ImportSourceCredentials: Imports the source repository credentials for
  67. // an AWS CodeBuild project that has its source code stored in a GitHub,
  68. // GitHub Enterprise, or Bitbucket repository.
  69. //
  70. // * ListSourceCredentials: Returns a list of SourceCredentialsInfo objects.
  71. // Each SourceCredentialsInfo object includes the authentication type, token
  72. // ARN, and type of source provider for one set of credentials.
  73. //
  74. // See https://docs.aws.amazon.com/goto/WebAPI/codebuild-2016-10-06 for more information on this service.
  75. //
  76. // See codebuild package documentation for more information.
  77. // https://docs.aws.amazon.com/sdk-for-go/api/service/codebuild/
  78. //
  79. // Using the Client
  80. //
  81. // To contact AWS CodeBuild with the SDK use the New function to create
  82. // a new service client. With that client you can make API requests to the service.
  83. // These clients are safe to use concurrently.
  84. //
  85. // See the SDK's documentation for more information on how to use the SDK.
  86. // https://docs.aws.amazon.com/sdk-for-go/api/
  87. //
  88. // See aws.Config documentation for more information on configuring SDK clients.
  89. // https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config
  90. //
  91. // See the AWS CodeBuild client CodeBuild for more
  92. // information on creating client for this service.
  93. // https://docs.aws.amazon.com/sdk-for-go/api/service/codebuild/#New
  94. package codebuild