Skip to content

Commit 78ddf33

Browse files
author
awstools
committed
feat(client-appconfig): Enabling boto3 paginators for list APIs and adding documentation around ServiceQuotaExceededException errors
1 parent 70e51ce commit 78ddf33

14 files changed

+227
-52
lines changed

‎clients/client-appconfig/src/commands/CreateApplicationCommand.ts

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,17 @@ export interface CreateApplicationCommandOutput extends Application, __MetadataB
7676
* @throws {@link InternalServerException} (server fault)
7777
* <p>There was an internal failure in the AppConfig service.</p>
7878
*
79+
* @throws {@link ServiceQuotaExceededException} (client fault)
80+
* <p>The number of one more AppConfig resources exceeds the maximum allowed. Verify that your
81+
* environment doesn't exceed the following service quotas:</p>
82+
* <p>Applications: 100 max</p>
83+
* <p>Deployment strategies: 20 max</p>
84+
* <p>Configuration profiles: 100 max per application</p>
85+
* <p>Environments: 20 max per application</p>
86+
* <p>To resolve this issue, you can delete one or more resources and try again. Or, you
87+
* can request a quota increase. For more information about quotas and to request an increase,
88+
* see <a href="https://docs.aws.amazon.com/general/latest/gr/appconfig.html#limits_appconfig">Service quotas for AppConfig</a> in the Amazon Web Services General Reference.</p>
89+
*
7990
* @throws {@link AppConfigServiceException}
8091
* <p>Base exception class for all service exceptions from AppConfig service.</p>
8192
*

‎clients/client-appconfig/src/commands/CreateConfigurationProfileCommand.ts

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -139,6 +139,17 @@ export interface CreateConfigurationProfileCommandOutput extends ConfigurationPr
139139
* @throws {@link ResourceNotFoundException} (client fault)
140140
* <p>The requested resource could not be found.</p>
141141
*
142+
* @throws {@link ServiceQuotaExceededException} (client fault)
143+
* <p>The number of one more AppConfig resources exceeds the maximum allowed. Verify that your
144+
* environment doesn't exceed the following service quotas:</p>
145+
* <p>Applications: 100 max</p>
146+
* <p>Deployment strategies: 20 max</p>
147+
* <p>Configuration profiles: 100 max per application</p>
148+
* <p>Environments: 20 max per application</p>
149+
* <p>To resolve this issue, you can delete one or more resources and try again. Or, you
150+
* can request a quota increase. For more information about quotas and to request an increase,
151+
* see <a href="https://docs.aws.amazon.com/general/latest/gr/appconfig.html#limits_appconfig">Service quotas for AppConfig</a> in the Amazon Web Services General Reference.</p>
152+
*
142153
* @throws {@link AppConfigServiceException}
143154
* <p>Base exception class for all service exceptions from AppConfig service.</p>
144155
*

‎clients/client-appconfig/src/commands/CreateDeploymentStrategyCommand.ts

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,17 @@ export interface CreateDeploymentStrategyCommandOutput extends DeploymentStrateg
8585
* @throws {@link InternalServerException} (server fault)
8686
* <p>There was an internal failure in the AppConfig service.</p>
8787
*
88+
* @throws {@link ServiceQuotaExceededException} (client fault)
89+
* <p>The number of one more AppConfig resources exceeds the maximum allowed. Verify that your
90+
* environment doesn't exceed the following service quotas:</p>
91+
* <p>Applications: 100 max</p>
92+
* <p>Deployment strategies: 20 max</p>
93+
* <p>Configuration profiles: 100 max per application</p>
94+
* <p>Environments: 20 max per application</p>
95+
* <p>To resolve this issue, you can delete one or more resources and try again. Or, you
96+
* can request a quota increase. For more information about quotas and to request an increase,
97+
* see <a href="https://docs.aws.amazon.com/general/latest/gr/appconfig.html#limits_appconfig">Service quotas for AppConfig</a> in the Amazon Web Services General Reference.</p>
98+
*
8899
* @throws {@link AppConfigServiceException}
89100
* <p>Base exception class for all service exceptions from AppConfig service.</p>
90101
*

‎clients/client-appconfig/src/commands/CreateEnvironmentCommand.ts

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,17 @@ export interface CreateEnvironmentCommandOutput extends Environment, __MetadataB
9797
* @throws {@link ResourceNotFoundException} (client fault)
9898
* <p>The requested resource could not be found.</p>
9999
*
100+
* @throws {@link ServiceQuotaExceededException} (client fault)
101+
* <p>The number of one more AppConfig resources exceeds the maximum allowed. Verify that your
102+
* environment doesn't exceed the following service quotas:</p>
103+
* <p>Applications: 100 max</p>
104+
* <p>Deployment strategies: 20 max</p>
105+
* <p>Configuration profiles: 100 max per application</p>
106+
* <p>Environments: 20 max per application</p>
107+
* <p>To resolve this issue, you can delete one or more resources and try again. Or, you
108+
* can request a quota increase. For more information about quotas and to request an increase,
109+
* see <a href="https://docs.aws.amazon.com/general/latest/gr/appconfig.html#limits_appconfig">Service quotas for AppConfig</a> in the Amazon Web Services General Reference.</p>
110+
*
100111
* @throws {@link AppConfigServiceException}
101112
* <p>Base exception class for all service exceptions from AppConfig service.</p>
102113
*

‎clients/client-appconfig/src/commands/CreateExtensionAssociationCommand.ts

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,15 @@ export interface CreateExtensionAssociationCommandOutput extends ExtensionAssoci
9797
* <p>The requested resource could not be found.</p>
9898
*
9999
* @throws {@link ServiceQuotaExceededException} (client fault)
100-
* <p>The number of hosted configuration versions exceeds the limit for the AppConfig hosted configuration store. Delete one or more versions and try again.</p>
100+
* <p>The number of one more AppConfig resources exceeds the maximum allowed. Verify that your
101+
* environment doesn't exceed the following service quotas:</p>
102+
* <p>Applications: 100 max</p>
103+
* <p>Deployment strategies: 20 max</p>
104+
* <p>Configuration profiles: 100 max per application</p>
105+
* <p>Environments: 20 max per application</p>
106+
* <p>To resolve this issue, you can delete one or more resources and try again. Or, you
107+
* can request a quota increase. For more information about quotas and to request an increase,
108+
* see <a href="https://docs.aws.amazon.com/general/latest/gr/appconfig.html#limits_appconfig">Service quotas for AppConfig</a> in the Amazon Web Services General Reference.</p>
101109
*
102110
* @throws {@link AppConfigServiceException}
103111
* <p>Base exception class for all service exceptions from AppConfig service.</p>

‎clients/client-appconfig/src/commands/CreateExtensionCommand.ts

Lines changed: 28 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,25 @@ export interface CreateExtensionCommandOutput extends Extension, __MetadataBeare
4040
* logic or behavior at different points during the AppConfig workflow of creating
4141
* or deploying a configuration.</p>
4242
* <p>You can create your own extensions or use the Amazon Web Services authored extensions provided by
43-
* AppConfig. For most use cases, to create your own extension, you must create
44-
* an Lambda function to perform any computation and processing defined in the
45-
* extension. For more information about extensions, see <a href="https://docs.aws.amazon.com/appconfig/latest/userguide/working-with-appconfig-extensions.html">Working with
43+
* AppConfig. For an AppConfig extension that uses Lambda, you must create a Lambda function to perform any computation and processing
44+
* defined in the extension. If you plan to create custom versions of the Amazon Web Services
45+
* authored notification extensions, you only need to specify an Amazon Resource Name (ARN) in
46+
* the <code>Uri</code> field for the new extension version.</p>
47+
* <ul>
48+
* <li>
49+
* <p>For a custom EventBridge notification extension, enter the ARN of the EventBridge
50+
* default events in the <code>Uri</code> field.</p>
51+
* </li>
52+
* <li>
53+
* <p>For a custom Amazon SNS notification extension, enter the ARN of an Amazon SNS
54+
* topic in the <code>Uri</code> field.</p>
55+
* </li>
56+
* <li>
57+
* <p>For a custom Amazon SQS notification extension, enter the ARN of an Amazon SQS
58+
* message queue in the <code>Uri</code> field. </p>
59+
* </li>
60+
* </ul>
61+
* <p>For more information about extensions, see <a href="https://docs.aws.amazon.com/appconfig/latest/userguide/working-with-appconfig-extensions.html">Working with
4662
* AppConfig extensions</a> in the
4763
* <i>AppConfig User Guide</i>.</p>
4864
* @example
@@ -120,7 +136,15 @@ export interface CreateExtensionCommandOutput extends Extension, __MetadataBeare
120136
* <p>There was an internal failure in the AppConfig service.</p>
121137
*
122138
* @throws {@link ServiceQuotaExceededException} (client fault)
123-
* <p>The number of hosted configuration versions exceeds the limit for the AppConfig hosted configuration store. Delete one or more versions and try again.</p>
139+
* <p>The number of one more AppConfig resources exceeds the maximum allowed. Verify that your
140+
* environment doesn't exceed the following service quotas:</p>
141+
* <p>Applications: 100 max</p>
142+
* <p>Deployment strategies: 20 max</p>
143+
* <p>Configuration profiles: 100 max per application</p>
144+
* <p>Environments: 20 max per application</p>
145+
* <p>To resolve this issue, you can delete one or more resources and try again. Or, you
146+
* can request a quota increase. For more information about quotas and to request an increase,
147+
* see <a href="https://docs.aws.amazon.com/general/latest/gr/appconfig.html#limits_appconfig">Service quotas for AppConfig</a> in the Amazon Web Services General Reference.</p>
124148
*
125149
* @throws {@link AppConfigServiceException}
126150
* <p>Base exception class for all service exceptions from AppConfig service.</p>

‎clients/client-appconfig/src/commands/CreateHostedConfigurationVersionCommand.ts

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,15 @@ export interface CreateHostedConfigurationVersionCommandOutput
120120
* <p>The requested resource could not be found.</p>
121121
*
122122
* @throws {@link ServiceQuotaExceededException} (client fault)
123-
* <p>The number of hosted configuration versions exceeds the limit for the AppConfig hosted configuration store. Delete one or more versions and try again.</p>
123+
* <p>The number of one more AppConfig resources exceeds the maximum allowed. Verify that your
124+
* environment doesn't exceed the following service quotas:</p>
125+
* <p>Applications: 100 max</p>
126+
* <p>Deployment strategies: 20 max</p>
127+
* <p>Configuration profiles: 100 max per application</p>
128+
* <p>Environments: 20 max per application</p>
129+
* <p>To resolve this issue, you can delete one or more resources and try again. Or, you
130+
* can request a quota increase. For more information about quotas and to request an increase,
131+
* see <a href="https://docs.aws.amazon.com/general/latest/gr/appconfig.html#limits_appconfig">Service quotas for AppConfig</a> in the Amazon Web Services General Reference.</p>
124132
*
125133
* @throws {@link AppConfigServiceException}
126134
* <p>Base exception class for all service exceptions from AppConfig service.</p>

‎clients/client-appconfig/src/commands/GetDeploymentCommand.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,7 @@ export interface GetDeploymentCommandOutput extends Deployment, __MetadataBearer
9999
* // ],
100100
* // KmsKeyArn: "STRING_VALUE",
101101
* // KmsKeyIdentifier: "STRING_VALUE",
102+
* // VersionLabel: "STRING_VALUE",
102103
* // };
103104
*
104105
* ```

‎clients/client-appconfig/src/commands/ListDeploymentsCommand.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,7 @@ export interface ListDeploymentsCommandOutput extends Deployments, __MetadataBea
6565
* // PercentageComplete: Number("float"),
6666
* // StartedAt: new Date("TIMESTAMP"),
6767
* // CompletedAt: new Date("TIMESTAMP"),
68+
* // VersionLabel: "STRING_VALUE",
6869
* // },
6970
* // ],
7071
* // NextToken: "STRING_VALUE",

‎clients/client-appconfig/src/commands/StartDeploymentCommand.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,7 @@ export interface StartDeploymentCommandOutput extends Deployment, __MetadataBear
106106
* // ],
107107
* // KmsKeyArn: "STRING_VALUE",
108108
* // KmsKeyIdentifier: "STRING_VALUE",
109+
* // VersionLabel: "STRING_VALUE",
109110
* // };
110111
*
111112
* ```

‎clients/client-appconfig/src/commands/StopDeploymentCommand.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,7 @@ export interface StopDeploymentCommandOutput extends Deployment, __MetadataBeare
101101
* // ],
102102
* // KmsKeyArn: "STRING_VALUE",
103103
* // KmsKeyIdentifier: "STRING_VALUE",
104+
* // VersionLabel: "STRING_VALUE",
104105
* // };
105106
*
106107
* ```

‎clients/client-appconfig/src/models/models_0.ts

Lines changed: 70 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -339,6 +339,36 @@ export class InternalServerException extends __BaseException {
339339
}
340340
}
341341

342+
/**
343+
* @public
344+
* <p>The number of one more AppConfig resources exceeds the maximum allowed. Verify that your
345+
* environment doesn't exceed the following service quotas:</p>
346+
* <p>Applications: 100 max</p>
347+
* <p>Deployment strategies: 20 max</p>
348+
* <p>Configuration profiles: 100 max per application</p>
349+
* <p>Environments: 20 max per application</p>
350+
* <p>To resolve this issue, you can delete one or more resources and try again. Or, you
351+
* can request a quota increase. For more information about quotas and to request an increase,
352+
* see <a href="https://docs.aws.amazon.com/general/latest/gr/appconfig.html#limits_appconfig">Service quotas for AppConfig</a> in the Amazon Web Services General Reference.</p>
353+
*/
354+
export class ServiceQuotaExceededException extends __BaseException {
355+
readonly name: "ServiceQuotaExceededException" = "ServiceQuotaExceededException";
356+
readonly $fault: "client" = "client";
357+
Message?: string;
358+
/**
359+
* @internal
360+
*/
361+
constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>) {
362+
super({
363+
name: "ServiceQuotaExceededException",
364+
$fault: "client",
365+
...opts,
366+
});
367+
Object.setPrototypeOf(this, ServiceQuotaExceededException.prototype);
368+
this.Message = opts.Message;
369+
}
370+
}
371+
342372
/**
343373
* @public
344374
* @enum
@@ -477,8 +507,13 @@ export interface CreateConfigurationProfileRequest {
477507
* the format <code>ssm-parameter://<parameter name></code> or the ARN.</p>
478508
* </li>
479509
* <li>
510+
* <p>For an Amazon Web Services
511+
* CodePipeline pipeline, specify the URI in the following format:
512+
* <code>codepipeline</code>://<pipeline name>.</p>
513+
* </li>
514+
* <li>
480515
* <p>For an Secrets Manager secret, specify the URI in the following format:
481-
* <code>secrets-manager</code>://<secret name>.</p>
516+
* <code>secretsmanager</code>://<secret name>.</p>
482517
* </li>
483518
* <li>
484519
* <p>For an Amazon S3 object, specify the URI in the following format:
@@ -992,28 +1027,6 @@ export interface Extension {
9921027
Parameters?: Record<string, Parameter>;
9931028
}
9941029

995-
/**
996-
* @public
997-
* <p>The number of hosted configuration versions exceeds the limit for the AppConfig hosted configuration store. Delete one or more versions and try again.</p>
998-
*/
999-
export class ServiceQuotaExceededException extends __BaseException {
1000-
readonly name: "ServiceQuotaExceededException" = "ServiceQuotaExceededException";
1001-
readonly $fault: "client" = "client";
1002-
Message?: string;
1003-
/**
1004-
* @internal
1005-
*/
1006-
constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>) {
1007-
super({
1008-
name: "ServiceQuotaExceededException",
1009-
$fault: "client",
1010-
...opts,
1011-
});
1012-
Object.setPrototypeOf(this, ServiceQuotaExceededException.prototype);
1013-
this.Message = opts.Message;
1014-
}
1015-
}
1016-
10171030
/**
10181031
* @public
10191032
*/
@@ -1142,7 +1155,9 @@ export interface CreateHostedConfigurationVersionRequest {
11421155

11431156
/**
11441157
* @public
1145-
* <p>An optional, user-defined label for the AppConfig hosted configuration version. This value must contain at least one non-numeric character. For example, "v2.2.0".</p>
1158+
* <p>An optional, user-defined label for the AppConfig hosted configuration
1159+
* version. This value must contain at least one non-numeric character. For example,
1160+
* "v2.2.0".</p>
11461161
*/
11471162
VersionLabel?: string;
11481163
}
@@ -1549,9 +1564,19 @@ export interface DeploymentEvent {
15491564
/**
15501565
* @public
15511566
* <p>A description of the deployment event. Descriptions include, but are not limited to, the
1552-
* user account or the Amazon CloudWatch alarm ARN that initiated a rollback, the percentage of hosts
1553-
* that received the deployment, or in the case of an internal error, a recommendation to
1554-
* attempt a new deployment.</p>
1567+
* following:</p>
1568+
* <ul>
1569+
* <li>
1570+
* <p>The Amazon Web Services account or the Amazon CloudWatch alarm ARN that initiated a rollback.</p>
1571+
* </li>
1572+
* <li>
1573+
* <p>The percentage of hosts that received the deployment.</p>
1574+
* </li>
1575+
* <li>
1576+
* <p>A recommendation to attempt a new deployment (in the case of an internal
1577+
* error).</p>
1578+
* </li>
1579+
* </ul>
15551580
*/
15561581
Description?: string;
15571582

@@ -1723,6 +1748,12 @@ export interface Deployment {
17231748
* <p>The KMS key identifier (key ID, key alias, or key ARN). AppConfig uses this ID to encrypt the configuration data using a customer managed key. </p>
17241749
*/
17251750
KmsKeyIdentifier?: string;
1751+
1752+
/**
1753+
* @public
1754+
* <p>A user-defined label for an AppConfig hosted configuration version.</p>
1755+
*/
1756+
VersionLabel?: string;
17261757
}
17271758

17281759
/**
@@ -2040,6 +2071,12 @@ export interface DeploymentSummary {
20402071
* <p>Time the deployment completed.</p>
20412072
*/
20422073
CompletedAt?: Date;
2074+
2075+
/**
2076+
* @public
2077+
* <p>A user-defined label for an AppConfig hosted configuration version.</p>
2078+
*/
2079+
VersionLabel?: string;
20432080
}
20442081

20452082
/**
@@ -2429,7 +2466,9 @@ export interface ListHostedConfigurationVersionsRequest {
24292466

24302467
/**
24312468
* @public
2432-
* <p>An optional filter that can be used to specify the version label of an AppConfig hosted configuration version. This parameter supports filtering by prefix using a wildcard, for example "v2*". If you don't specify an asterisk at the end of the value, only an exact match is returned.</p>
2469+
* <p>An optional filter that can be used to specify the version label of an AppConfig hosted configuration version. This parameter supports filtering by prefix using a
2470+
* wildcard, for example "v2*". If you don't specify an asterisk at the end of the value, only
2471+
* an exact match is returned.</p>
24332472
*/
24342473
VersionLabel?: string;
24352474
}
@@ -2488,7 +2527,9 @@ export interface StartDeploymentRequest {
24882527

24892528
/**
24902529
* @public
2491-
* <p>The configuration version to deploy. If deploying an AppConfig hosted configuration version, you can specify either the version number or version label.</p>
2530+
* <p>The configuration version to deploy. If deploying an AppConfig hosted
2531+
* configuration version, you can specify either the version number or version label. For all
2532+
* other configurations, you must specify the version number.</p>
24922533
*/
24932534
ConfigurationVersion: string | undefined;
24942535

0 commit comments

Comments
 (0)