@aws-sdk/client-codebuild 3.529.1 → 3.530.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -26,7 +26,10 @@ declare const StartBuildCommand_base: {
26
26
  };
27
27
  /**
28
28
  * @public
29
- * <p>Starts running a build.</p>
29
+ * <p>Starts running a build with the settings defined in the project. These setting include: how to run a build,
30
+ * where to get the source code, which build environment to use, which build commands to run, and where to store the build output.</p>
31
+ * <p>You can also start a build run by overriding some of the build settings in the project. The overrides only apply for that
32
+ * specific start build request. The settings in the project are unaltered.</p>
30
33
  * @example
31
34
  * Use a bare-bones client and the command you need to make an API call.
32
35
  * ```javascript
@@ -3133,77 +3133,94 @@ export interface WebhookFilter {
3133
3133
  * <p> The type of webhook filter. There are six webhook filter types: <code>EVENT</code>,
3134
3134
  * <code>ACTOR_ACCOUNT_ID</code>, <code>HEAD_REF</code>, <code>BASE_REF</code>,
3135
3135
  * <code>FILE_PATH</code>, and <code>COMMIT_MESSAGE</code>. </p>
3136
- * <dl>
3137
- * <dt>
3138
- * EVENT
3139
- * </dt>
3140
- * <dd>
3141
- * <p> A webhook event triggers a build when the provided <code>pattern</code>
3142
- * matches one of five event types: <code>PUSH</code>,
3136
+ * <ul>
3137
+ * <li>
3138
+ * <p>
3139
+ * EVENT
3140
+ * </p>
3141
+ * <ul>
3142
+ * <li>
3143
+ * <p> A webhook event triggers a build when the provided <code>pattern</code>
3144
+ * matches one of six event types: <code>PUSH</code>,
3143
3145
  * <code>PULL_REQUEST_CREATED</code>, <code>PULL_REQUEST_UPDATED</code>,
3146
+ * <code>PULL_REQUEST_CLOSED</code>,
3144
3147
  * <code>PULL_REQUEST_REOPENED</code>, and
3145
- * <code>PULL_REQUEST_MERGED</code>. The <code>EVENT</code> patterns are
3146
- * specified as a comma-separated string. For example, <code>PUSH,
3147
- * PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED</code> filters all push, pull
3148
- * request created, and pull request updated events. </p>
3149
- * <note>
3150
- * <p> The <code>PULL_REQUEST_REOPENED</code> works with GitHub and GitHub
3151
- * Enterprise only. </p>
3152
- * </note>
3153
- * </dd>
3154
- * <dt>
3155
- * ACTOR_ACCOUNT_ID
3156
- * </dt>
3157
- * <dd>
3158
- * <p> A webhook event triggers a build when a GitHub, GitHub Enterprise, or
3159
- * Bitbucket account ID matches the regular expression <code>pattern</code>.
3160
- * </p>
3161
- * </dd>
3162
- * <dt>
3163
- * HEAD_REF
3164
- * </dt>
3165
- * <dd>
3166
- * <p> A webhook event triggers a build when the head reference matches the
3167
- * regular expression <code>pattern</code>. For example,
3148
+ * <code>PULL_REQUEST_MERGED</code>. The <code>EVENT</code> patterns are
3149
+ * specified as a comma-separated string. For example, <code>PUSH,
3150
+ * PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED</code> filters all push, pull
3151
+ * request created, and pull request updated events. </p>
3152
+ * <note>
3153
+ * <p> The <code>PULL_REQUEST_REOPENED</code> works with GitHub and GitHub
3154
+ * Enterprise only. </p>
3155
+ * </note>
3156
+ * </li>
3157
+ * </ul>
3158
+ * </li>
3159
+ * <li>
3160
+ * <p>ACTOR_ACCOUNT_ID</p>
3161
+ * <ul>
3162
+ * <li>
3163
+ * <p> A webhook event triggers a build when a GitHub, GitHub Enterprise, or
3164
+ * Bitbucket account ID matches the regular expression <code>pattern</code>.
3165
+ * </p>
3166
+ * </li>
3167
+ * </ul>
3168
+ * </li>
3169
+ * <li>
3170
+ * <p>HEAD_REF</p>
3171
+ * <ul>
3172
+ * <li>
3173
+ * <p> A webhook event triggers a build when the head reference matches the
3174
+ * regular expression <code>pattern</code>. For example,
3168
3175
  * <code>refs/heads/branch-name</code> and <code>refs/tags/tag-name</code>. </p>
3169
- * <p> Works with GitHub and GitHub Enterprise push, GitHub and GitHub
3170
- * Enterprise pull request, Bitbucket push, and Bitbucket pull request events.
3171
- * </p>
3172
- * </dd>
3173
- * <dt>
3174
- * BASE_REF
3175
- * </dt>
3176
- * <dd>
3177
- * <p> A webhook event triggers a build when the base reference matches the
3178
- * regular expression <code>pattern</code>. For example,
3176
+ * <p> Works with GitHub and GitHub Enterprise push, GitHub and GitHub
3177
+ * Enterprise pull request, Bitbucket push, and Bitbucket pull request events.
3178
+ * </p>
3179
+ * </li>
3180
+ * </ul>
3181
+ * </li>
3182
+ * <li>
3183
+ * <p>BASE_REF</p>
3184
+ * <ul>
3185
+ * <li>
3186
+ * <p> A webhook event triggers a build when the base reference matches the
3187
+ * regular expression <code>pattern</code>. For example,
3179
3188
  * <code>refs/heads/branch-name</code>. </p>
3180
- * <note>
3181
- * <p> Works with pull request events only. </p>
3182
- * </note>
3183
- * </dd>
3184
- * <dt>
3185
- * FILE_PATH
3186
- * </dt>
3187
- * <dd>
3188
- * <p> A webhook triggers a build when the path of a changed file matches the
3189
- * regular expression <code>pattern</code>. </p>
3190
- * <note>
3191
- * <p> Works with GitHub and Bitbucket events push and pull requests events.
3192
- * Also works with GitHub Enterprise push events, but does not work with
3193
- * GitHub Enterprise pull request events. </p>
3194
- * </note>
3195
- * </dd>
3196
- * <dt>COMMIT_MESSAGE</dt>
3197
- * <dd>
3198
- * <p>A webhook triggers a build when the head commit message matches the
3199
- * regular expression <code>pattern</code>.</p>
3200
- * <note>
3201
- * <p> Works with GitHub and Bitbucket events push and pull requests events.
3202
- * Also works with GitHub Enterprise push events, but does not work with
3203
- * GitHub Enterprise pull request events. </p>
3204
- * </note>
3205
- * </dd>
3206
- * </dl>
3189
+ * <note>
3190
+ * <p> Works with pull request events only. </p>
3191
+ * </note>
3192
+ * </li>
3193
+ * </ul>
3194
+ * </li>
3195
+ * <li>
3196
+ * <p>FILE_PATH</p>
3197
+ * <ul>
3198
+ * <li>
3199
+ * <p> A webhook triggers a build when the path of a changed file matches the
3200
+ * regular expression <code>pattern</code>. </p>
3201
+ * <note>
3202
+ * <p> Works with GitHub and Bitbucket events push and pull requests events.
3203
+ * Also works with GitHub Enterprise push events, but does not work with
3204
+ * GitHub Enterprise pull request events. </p>
3205
+ * </note>
3206
+ * </li>
3207
+ * </ul>
3208
+ * </li>
3209
+ * <li>
3210
+ * <p>COMMIT_MESSAGE</p>
3211
+ * <ul>
3212
+ * <li>
3213
+ * <p>A webhook triggers a build when the head commit message matches the
3214
+ * regular expression <code>pattern</code>.</p>
3215
+ * <note>
3216
+ * <p> Works with GitHub and Bitbucket events push and pull requests events.
3217
+ * Also works with GitHub Enterprise push events, but does not work with
3218
+ * GitHub Enterprise pull request events. </p>
3219
+ * </note>
3220
+ * </li>
3221
+ * </ul>
3222
+ * </li>
3223
+ * </ul>
3207
3224
  */
3208
3225
  type: WebhookFilterType | undefined;
3209
3226
  /**
@@ -6296,16 +6313,22 @@ export interface StartBuildInput {
6296
6313
  gitSubmodulesConfigOverride?: GitSubmodulesConfig;
6297
6314
  /**
6298
6315
  * @public
6299
- * <p>A buildspec file declaration that overrides, for this build only, the latest one
6300
- * already defined in the build project.</p>
6301
- * <p> If this value is set, it can be either an inline buildspec definition, the path to an
6316
+ * <p>A buildspec file declaration that overrides the latest one defined
6317
+ * in the build project, for this build only. The buildspec defined on the project is not changed.</p>
6318
+ * <p>If this value is set, it can be either an inline buildspec definition, the path to an
6302
6319
  * alternate buildspec file relative to the value of the built-in
6303
6320
  * <code>CODEBUILD_SRC_DIR</code> environment variable, or the path to an S3 bucket.
6304
6321
  * The bucket must be in the same Amazon Web Services Region as the build project. Specify the buildspec
6305
6322
  * file using its ARN (for example,
6306
6323
  * <code>arn:aws:s3:::my-codebuild-sample2/buildspec.yml</code>). If this value is not
6307
6324
  * provided or is set to an empty string, the source code must contain a buildspec file in
6308
- * its root directory. For more information, see <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html#build-spec-ref-name-storage">Buildspec File Name and Storage Location</a>. </p>
6325
+ * its root directory. For more information, see <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html#build-spec-ref-name-storage">Buildspec File Name and Storage Location</a>.</p>
6326
+ * <note>
6327
+ * <p>Since this property allows you to change the build commands that will run in the container,
6328
+ * you should note that an IAM principal with the ability to call this API and set this parameter
6329
+ * can override the default settings. Moreover, we encourage that you use a trustworthy buildspec location
6330
+ * like a file in your source repository or a Amazon S3 bucket.</p>
6331
+ * </note>
6309
6332
  */
6310
6333
  buildspecOverride?: string;
6311
6334
  /**
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-codebuild",
3
3
  "description": "AWS SDK for JavaScript Codebuild Client for Node.js, Browser and React Native",
4
- "version": "3.529.1",
4
+ "version": "3.530.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "node ../../scripts/compilation/inline client-codebuild",