@aws-sdk/client-codepipeline 3.750.0 → 3.752.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.
@@ -107,6 +107,12 @@ declare const CreatePipelineCommand_base: {
107
107
  * region: "STRING_VALUE",
108
108
  * namespace: "STRING_VALUE",
109
109
  * timeoutInMinutes: Number("int"),
110
+ * environmentVariables: [ // EnvironmentVariableList
111
+ * { // EnvironmentVariable
112
+ * name: "STRING_VALUE", // required
113
+ * value: "STRING_VALUE", // required
114
+ * },
115
+ * ],
110
116
  * },
111
117
  * ],
112
118
  * onFailure: { // FailureConditions
@@ -357,6 +363,12 @@ declare const CreatePipelineCommand_base: {
357
363
  * // region: "STRING_VALUE",
358
364
  * // namespace: "STRING_VALUE",
359
365
  * // timeoutInMinutes: Number("int"),
366
+ * // environmentVariables: [ // EnvironmentVariableList
367
+ * // { // EnvironmentVariable
368
+ * // name: "STRING_VALUE", // required
369
+ * // value: "STRING_VALUE", // required
370
+ * // },
371
+ * // ],
360
372
  * // },
361
373
  * // ],
362
374
  * // onFailure: { // FailureConditions
@@ -109,6 +109,12 @@ declare const GetPipelineCommand_base: {
109
109
  * // region: "STRING_VALUE",
110
110
  * // namespace: "STRING_VALUE",
111
111
  * // timeoutInMinutes: Number("int"),
112
+ * // environmentVariables: [ // EnvironmentVariableList
113
+ * // { // EnvironmentVariable
114
+ * // name: "STRING_VALUE", // required
115
+ * // value: "STRING_VALUE", // required
116
+ * // },
117
+ * // ],
112
118
  * // },
113
119
  * // ],
114
120
  * // onFailure: { // FailureConditions
@@ -28,7 +28,7 @@ declare const ListRuleTypesCommand_base: {
28
28
  };
29
29
  /**
30
30
  * <p>Lists the rules for the condition. For more information about conditions, see <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/stage-conditions.html">Stage
31
- * conditions</a>. For more information about rules, see the <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/rule-reference.html">CodePipeline rule reference</a>.</p>
31
+ * conditions</a> and <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/concepts-how-it-works-conditions.html">How do stage conditions work?</a>.For more information about rules, see the <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/rule-reference.html">CodePipeline rule reference</a>.</p>
32
32
  * @example
33
33
  * Use a bare-bones client and the command you need to make an API call.
34
34
  * ```javascript
@@ -27,7 +27,8 @@ declare const OverrideStageConditionCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Used to override a stage condition.</p>
30
+ * <p>Used to override a stage condition. For more information about conditions, see <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/stage-conditions.html">Stage
31
+ * conditions</a> and <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/concepts-how-it-works-conditions.html">How do stage conditions work?</a>.</p>
31
32
  * @example
32
33
  * Use a bare-bones client and the command you need to make an API call.
33
34
  * ```javascript
@@ -104,6 +104,12 @@ declare const UpdatePipelineCommand_base: {
104
104
  * region: "STRING_VALUE",
105
105
  * namespace: "STRING_VALUE",
106
106
  * timeoutInMinutes: Number("int"),
107
+ * environmentVariables: [ // EnvironmentVariableList
108
+ * { // EnvironmentVariable
109
+ * name: "STRING_VALUE", // required
110
+ * value: "STRING_VALUE", // required
111
+ * },
112
+ * ],
107
113
  * },
108
114
  * ],
109
115
  * onFailure: { // FailureConditions
@@ -348,6 +354,12 @@ declare const UpdatePipelineCommand_base: {
348
354
  * // region: "STRING_VALUE",
349
355
  * // namespace: "STRING_VALUE",
350
356
  * // timeoutInMinutes: Number("int"),
357
+ * // environmentVariables: [ // EnvironmentVariableList
358
+ * // { // EnvironmentVariable
359
+ * // name: "STRING_VALUE", // required
360
+ * // value: "STRING_VALUE", // required
361
+ * // },
362
+ * // ],
351
363
  * // },
352
364
  * // ],
353
365
  * // onFailure: { // FailureConditions
@@ -310,6 +310,22 @@ export interface ActionTypeId {
310
310
  */
311
311
  version: string | undefined;
312
312
  }
313
+ /**
314
+ * <p>The environment variables for the action.</p>
315
+ * @public
316
+ */
317
+ export interface EnvironmentVariable {
318
+ /**
319
+ * <p>The environment variable name in the key-value pair.</p>
320
+ * @public
321
+ */
322
+ name: string | undefined;
323
+ /**
324
+ * <p>The environment variable value in the key-value pair.</p>
325
+ * @public
326
+ */
327
+ value: string | undefined;
328
+ }
313
329
  /**
314
330
  * <p>Represents information about an artifact to be worked on, such as a test or build
315
331
  * artifact.</p>
@@ -443,6 +459,11 @@ export interface ActionDeclaration {
443
459
  * @public
444
460
  */
445
461
  timeoutInMinutes?: number | undefined;
462
+ /**
463
+ * <p>The environment variables for the action.</p>
464
+ * @public
465
+ */
466
+ environmentVariables?: EnvironmentVariable[] | undefined;
446
467
  }
447
468
  /**
448
469
  * <p>Represents information about an error in CodePipeline.</p>
@@ -1583,7 +1604,10 @@ export declare const RuleOwner: {
1583
1604
  export type RuleOwner = (typeof RuleOwner)[keyof typeof RuleOwner];
1584
1605
  /**
1585
1606
  * <p>The ID for the rule type, which is made up of the combined values for category, owner,
1586
- * provider, and version.</p>
1607
+ * provider, and version. For more
1608
+ * information about conditions, see <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/stage-conditions.html">Stage conditions</a>.
1609
+ * For more information about rules, see the <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/rule-reference.html">CodePipeline rule
1610
+ * reference</a>.</p>
1587
1611
  * @public
1588
1612
  */
1589
1613
  export interface RuleTypeId {
@@ -1600,7 +1624,8 @@ export interface RuleTypeId {
1600
1624
  */
1601
1625
  owner?: RuleOwner | undefined;
1602
1626
  /**
1603
- * <p>The rule provider, such as the <code>DeploymentWindow</code> rule.</p>
1627
+ * <p>The rule provider, such as the <code>DeploymentWindow</code> rule. For a list of rule provider names, see the rules listed in the <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/rule-reference.html">CodePipeline rule
1628
+ * reference</a>.</p>
1604
1629
  * @public
1605
1630
  */
1606
1631
  provider: string | undefined;
@@ -1613,8 +1638,8 @@ export interface RuleTypeId {
1613
1638
  /**
1614
1639
  * <p>Represents information about the rule to be created for an associated condition. An
1615
1640
  * example would be creating a new rule for an entry condition, such as a rule that checks
1616
- * for a test result before allowing the run to enter the deployment stage. For more
1617
- * information about conditions, see <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/stage-conditions.html">Stage conditions</a>.
1641
+ * for a test result before allowing the run to enter the deployment stage. For more information about conditions, see <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/stage-conditions.html">Stage
1642
+ * conditions</a> and <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/concepts-how-it-works-conditions.html">How do stage conditions work?</a>.
1618
1643
  * For more information about rules, see the <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/rule-reference.html">CodePipeline rule
1619
1644
  * reference</a>.</p>
1620
1645
  * @public
@@ -1671,7 +1696,8 @@ export interface RuleDeclaration {
1671
1696
  }
1672
1697
  /**
1673
1698
  * <p>The condition for the stage. A condition is made up of the rules and the result for
1674
- * the condition. For more information about conditions, see <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/stage-conditions.html">Stage conditions</a>.
1699
+ * the condition. For more information about conditions, see <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/stage-conditions.html">Stage
1700
+ * conditions</a> and <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/concepts-how-it-works-conditions.html">How do stage conditions work?</a>..
1675
1701
  * For more information about rules, see the <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/rule-reference.html">CodePipeline rule
1676
1702
  * reference</a>.</p>
1677
1703
  * @public
@@ -1690,7 +1716,8 @@ export interface Condition {
1690
1716
  rules?: RuleDeclaration[] | undefined;
1691
1717
  }
1692
1718
  /**
1693
- * <p>The conditions for making checks for entry to a stage. </p>
1719
+ * <p>The conditions for making checks for entry to a stage. For more information about conditions, see <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/stage-conditions.html">Stage
1720
+ * conditions</a> and <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/concepts-how-it-works-conditions.html">How do stage conditions work?</a>. </p>
1694
1721
  * @public
1695
1722
  */
1696
1723
  export interface BeforeEntryConditions {
@@ -1907,16 +1934,16 @@ export type StageRetryMode = (typeof StageRetryMode)[keyof typeof StageRetryMode
1907
1934
  */
1908
1935
  export interface RetryConfiguration {
1909
1936
  /**
1910
- * <p>The method that you want to configure for automatic stage retry on stage
1911
- * failure. You can specify to retry only failed action in the stage or all actions in the
1912
- * stage.</p>
1937
+ * <p>The method that you want to configure for automatic stage retry on stage failure. You
1938
+ * can specify to retry only failed action in the stage or all actions in the stage.</p>
1913
1939
  * @public
1914
1940
  */
1915
1941
  retryMode?: StageRetryMode | undefined;
1916
1942
  }
1917
1943
  /**
1918
1944
  * <p>The configuration that specifies the result, such as rollback, to occur upon stage
1919
- * failure. </p>
1945
+ * failure. For more information about conditions, see <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/stage-conditions.html">Stage
1946
+ * conditions</a> and <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/concepts-how-it-works-conditions.html">How do stage conditions work?</a>. </p>
1920
1947
  * @public
1921
1948
  */
1922
1949
  export interface FailureConditions {
@@ -1933,13 +1960,15 @@ export interface FailureConditions {
1933
1960
  */
1934
1961
  retryConfiguration?: RetryConfiguration | undefined;
1935
1962
  /**
1936
- * <p>The conditions that are configured as failure conditions.</p>
1963
+ * <p>The conditions that are configured as failure conditions. For more information about conditions, see <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/stage-conditions.html">Stage
1964
+ * conditions</a> and <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/concepts-how-it-works-conditions.html">How do stage conditions work?</a>.</p>
1937
1965
  * @public
1938
1966
  */
1939
1967
  conditions?: Condition[] | undefined;
1940
1968
  }
1941
1969
  /**
1942
- * <p>The conditions for making checks that, if met, succeed a stage.</p>
1970
+ * <p>The conditions for making checks that, if met, succeed a stage. For more information about conditions, see <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/stage-conditions.html">Stage
1971
+ * conditions</a> and <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/concepts-how-it-works-conditions.html">How do stage conditions work?</a>.</p>
1943
1972
  * @public
1944
1973
  */
1945
1974
  export interface SuccessConditions {
@@ -2043,12 +2072,24 @@ export interface GitFilePathFilterCriteria {
2043
2072
  /**
2044
2073
  * <p>The event criteria for the pull request trigger configuration, such as the lists of
2045
2074
  * branches or file paths to include and exclude.</p>
2075
+ * <p>The following are valid values for the events for this filter:</p>
2076
+ * <ul>
2077
+ * <li>
2078
+ * <p>CLOSED</p>
2079
+ * </li>
2080
+ * <li>
2081
+ * <p>OPEN</p>
2082
+ * </li>
2083
+ * <li>
2084
+ * <p>UPDATED</p>
2085
+ * </li>
2086
+ * </ul>
2046
2087
  * @public
2047
2088
  */
2048
2089
  export interface GitPullRequestFilter {
2049
2090
  /**
2050
- * <p>The field that specifies which pull request events to filter on (opened, updated,
2051
- * closed) for the trigger configuration.</p>
2091
+ * <p>The field that specifies which pull request events to filter on (OPEN, UPDATED,
2092
+ * CLOSED) for the trigger configuration.</p>
2052
2093
  * @public
2053
2094
  */
2054
2095
  events?: GitPullRequestEventType[] | undefined;
@@ -3419,22 +3460,26 @@ export declare const RetryTrigger: {
3419
3460
  */
3420
3461
  export type RetryTrigger = (typeof RetryTrigger)[keyof typeof RetryTrigger];
3421
3462
  /**
3422
- * <p>The details of a specific automatic retry on stage failure, including the attempt number and trigger.</p>
3463
+ * <p>The details of a specific automatic retry on stage failure, including the attempt
3464
+ * number and trigger.</p>
3423
3465
  * @public
3424
3466
  */
3425
3467
  export interface RetryStageMetadata {
3426
3468
  /**
3427
- * <p>The number of attempts for a specific stage with automatic retry on stage failure. One attempt is allowed for automatic stage retry on failure.</p>
3469
+ * <p>The number of attempts for a specific stage with automatic retry on stage failure. One
3470
+ * attempt is allowed for automatic stage retry on failure.</p>
3428
3471
  * @public
3429
3472
  */
3430
3473
  autoStageRetryAttempt?: number | undefined;
3431
3474
  /**
3432
- * <p>The number of attempts for a specific stage where manual retries have been made upon stage failure.</p>
3475
+ * <p>The number of attempts for a specific stage where manual retries have been made upon
3476
+ * stage failure.</p>
3433
3477
  * @public
3434
3478
  */
3435
3479
  manualStageRetryAttempt?: number | undefined;
3436
3480
  /**
3437
- * <p>The latest trigger for a specific stage where manual or automatic retries have been made upon stage failure.</p>
3481
+ * <p>The latest trigger for a specific stage where manual or automatic retries have been
3482
+ * made upon stage failure.</p>
3438
3483
  * @public
3439
3484
  */
3440
3485
  latestRetryTrigger?: RetryTrigger | undefined;
@@ -3491,7 +3536,8 @@ export interface StageState {
3491
3536
  */
3492
3537
  onFailureConditionState?: StageConditionState | undefined;
3493
3538
  /**
3494
- * <p>he details of a specific automatic retry on stage failure, including the attempt number and trigger.</p>
3539
+ * <p>he details of a specific automatic retry on stage failure, including the attempt
3540
+ * number and trigger.</p>
3495
3541
  * @public
3496
3542
  */
3497
3543
  retryStageMetadata?: RetryStageMetadata | undefined;
@@ -4118,7 +4164,10 @@ export interface ListRuleExecutionsInput {
4118
4164
  export interface RuleExecutionInput {
4119
4165
  /**
4120
4166
  * <p>The ID for the rule type, which is made up of the combined values for category, owner,
4121
- * provider, and version.</p>
4167
+ * provider, and version. For more
4168
+ * information about conditions, see <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/stage-conditions.html">Stage conditions</a>.
4169
+ * For more information about rules, see the <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/rule-reference.html">CodePipeline rule
4170
+ * reference</a>.</p>
4122
4171
  * @public
4123
4172
  */
4124
4173
  ruleTypeId?: RuleTypeId | undefined;
@@ -4991,9 +5040,9 @@ export interface PutApprovalResultInput {
4991
5040
  * request corresponding to this token is still valid.</p>
4992
5041
  * <important>
4993
5042
  * <p>For a pipeline where the execution mode is set to PARALLEL, the token required to
4994
- * approve/reject approval request as detailed above is not available. Instead, use the
4995
- * <code>externalExecutionId</code> from the <code>GetPipelineState</code> action
4996
- * as the token in the approval request.</p>
5043
+ * approve/reject an approval request as detailed above is not available. Instead, use
5044
+ * the <code>externalExecutionId</code> in the response output from the <a>ListActionExecutions</a> action as the token in the approval
5045
+ * request.</p>
4997
5046
  * </important>
4998
5047
  * @public
4999
5048
  */
@@ -99,6 +99,10 @@ export interface ActionTypeId {
99
99
  provider: string | undefined;
100
100
  version: string | undefined;
101
101
  }
102
+ export interface EnvironmentVariable {
103
+ name: string | undefined;
104
+ value: string | undefined;
105
+ }
102
106
  export interface InputArtifact {
103
107
  name: string | undefined;
104
108
  }
@@ -119,6 +123,7 @@ export interface ActionDeclaration {
119
123
  region?: string | undefined;
120
124
  namespace?: string | undefined;
121
125
  timeoutInMinutes?: number | undefined;
126
+ environmentVariables?: EnvironmentVariable[] | undefined;
122
127
  }
123
128
  export interface ErrorDetails {
124
129
  code?: string | undefined;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-codepipeline",
3
3
  "description": "AWS SDK for JavaScript Codepipeline Client for Node.js, Browser and React Native",
4
- "version": "3.750.0",
4
+ "version": "3.752.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-codepipeline",