Skip to content

Commit

Permalink
feat(client-appconfig): Enabling boto3 paginators for list APIs and a…
Browse files Browse the repository at this point in the history
…dding documentation around ServiceQuotaExceededException errors
  • Loading branch information
awstools committed Sep 20, 2023
1 parent 70e51ce commit 78ddf33
Show file tree
Hide file tree
Showing 14 changed files with 227 additions and 52 deletions.
11 changes: 11 additions & 0 deletions clients/client-appconfig/src/commands/CreateApplicationCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,17 @@ export interface CreateApplicationCommandOutput extends Application, __MetadataB
* @throws {@link InternalServerException} (server fault)
* <p>There was an internal failure in the AppConfig service.</p>
*
* @throws {@link ServiceQuotaExceededException} (client fault)
* <p>The number of one more AppConfig resources exceeds the maximum allowed. Verify that your
* environment doesn't exceed the following service quotas:</p>
* <p>Applications: 100 max</p>
* <p>Deployment strategies: 20 max</p>
* <p>Configuration profiles: 100 max per application</p>
* <p>Environments: 20 max per application</p>
* <p>To resolve this issue, you can delete one or more resources and try again. Or, you
* can request a quota increase. For more information about quotas and to request an increase,
* 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>
*
* @throws {@link AppConfigServiceException}
* <p>Base exception class for all service exceptions from AppConfig service.</p>
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,17 @@ export interface CreateConfigurationProfileCommandOutput extends ConfigurationPr
* @throws {@link ResourceNotFoundException} (client fault)
* <p>The requested resource could not be found.</p>
*
* @throws {@link ServiceQuotaExceededException} (client fault)
* <p>The number of one more AppConfig resources exceeds the maximum allowed. Verify that your
* environment doesn't exceed the following service quotas:</p>
* <p>Applications: 100 max</p>
* <p>Deployment strategies: 20 max</p>
* <p>Configuration profiles: 100 max per application</p>
* <p>Environments: 20 max per application</p>
* <p>To resolve this issue, you can delete one or more resources and try again. Or, you
* can request a quota increase. For more information about quotas and to request an increase,
* 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>
*
* @throws {@link AppConfigServiceException}
* <p>Base exception class for all service exceptions from AppConfig service.</p>
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,17 @@ export interface CreateDeploymentStrategyCommandOutput extends DeploymentStrateg
* @throws {@link InternalServerException} (server fault)
* <p>There was an internal failure in the AppConfig service.</p>
*
* @throws {@link ServiceQuotaExceededException} (client fault)
* <p>The number of one more AppConfig resources exceeds the maximum allowed. Verify that your
* environment doesn't exceed the following service quotas:</p>
* <p>Applications: 100 max</p>
* <p>Deployment strategies: 20 max</p>
* <p>Configuration profiles: 100 max per application</p>
* <p>Environments: 20 max per application</p>
* <p>To resolve this issue, you can delete one or more resources and try again. Or, you
* can request a quota increase. For more information about quotas and to request an increase,
* 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>
*
* @throws {@link AppConfigServiceException}
* <p>Base exception class for all service exceptions from AppConfig service.</p>
*
Expand Down
11 changes: 11 additions & 0 deletions clients/client-appconfig/src/commands/CreateEnvironmentCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,17 @@ export interface CreateEnvironmentCommandOutput extends Environment, __MetadataB
* @throws {@link ResourceNotFoundException} (client fault)
* <p>The requested resource could not be found.</p>
*
* @throws {@link ServiceQuotaExceededException} (client fault)
* <p>The number of one more AppConfig resources exceeds the maximum allowed. Verify that your
* environment doesn't exceed the following service quotas:</p>
* <p>Applications: 100 max</p>
* <p>Deployment strategies: 20 max</p>
* <p>Configuration profiles: 100 max per application</p>
* <p>Environments: 20 max per application</p>
* <p>To resolve this issue, you can delete one or more resources and try again. Or, you
* can request a quota increase. For more information about quotas and to request an increase,
* 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>
*
* @throws {@link AppConfigServiceException}
* <p>Base exception class for all service exceptions from AppConfig service.</p>
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,15 @@ export interface CreateExtensionAssociationCommandOutput extends ExtensionAssoci
* <p>The requested resource could not be found.</p>
*
* @throws {@link ServiceQuotaExceededException} (client fault)
* <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>
* <p>The number of one more AppConfig resources exceeds the maximum allowed. Verify that your
* environment doesn't exceed the following service quotas:</p>
* <p>Applications: 100 max</p>
* <p>Deployment strategies: 20 max</p>
* <p>Configuration profiles: 100 max per application</p>
* <p>Environments: 20 max per application</p>
* <p>To resolve this issue, you can delete one or more resources and try again. Or, you
* can request a quota increase. For more information about quotas and to request an increase,
* 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>
*
* @throws {@link AppConfigServiceException}
* <p>Base exception class for all service exceptions from AppConfig service.</p>
Expand Down
32 changes: 28 additions & 4 deletions clients/client-appconfig/src/commands/CreateExtensionCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -40,9 +40,25 @@ export interface CreateExtensionCommandOutput extends Extension, __MetadataBeare
* logic or behavior at different points during the AppConfig workflow of creating
* or deploying a configuration.</p>
* <p>You can create your own extensions or use the Amazon Web Services authored extensions provided by
* AppConfig. For most use cases, to create your own extension, you must create
* an Lambda function to perform any computation and processing defined in the
* extension. For more information about extensions, see <a href="https://docs.aws.amazon.com/appconfig/latest/userguide/working-with-appconfig-extensions.html">Working with
* AppConfig. For an AppConfig extension that uses Lambda, you must create a Lambda function to perform any computation and processing
* defined in the extension. If you plan to create custom versions of the Amazon Web Services
* authored notification extensions, you only need to specify an Amazon Resource Name (ARN) in
* the <code>Uri</code> field for the new extension version.</p>
* <ul>
* <li>
* <p>For a custom EventBridge notification extension, enter the ARN of the EventBridge
* default events in the <code>Uri</code> field.</p>
* </li>
* <li>
* <p>For a custom Amazon SNS notification extension, enter the ARN of an Amazon SNS
* topic in the <code>Uri</code> field.</p>
* </li>
* <li>
* <p>For a custom Amazon SQS notification extension, enter the ARN of an Amazon SQS
* message queue in the <code>Uri</code> field. </p>
* </li>
* </ul>
* <p>For more information about extensions, see <a href="https://docs.aws.amazon.com/appconfig/latest/userguide/working-with-appconfig-extensions.html">Working with
* AppConfig extensions</a> in the
* <i>AppConfig User Guide</i>.</p>
* @example
Expand Down Expand Up @@ -120,7 +136,15 @@ export interface CreateExtensionCommandOutput extends Extension, __MetadataBeare
* <p>There was an internal failure in the AppConfig service.</p>
*
* @throws {@link ServiceQuotaExceededException} (client fault)
* <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>
* <p>The number of one more AppConfig resources exceeds the maximum allowed. Verify that your
* environment doesn't exceed the following service quotas:</p>
* <p>Applications: 100 max</p>
* <p>Deployment strategies: 20 max</p>
* <p>Configuration profiles: 100 max per application</p>
* <p>Environments: 20 max per application</p>
* <p>To resolve this issue, you can delete one or more resources and try again. Or, you
* can request a quota increase. For more information about quotas and to request an increase,
* 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>
*
* @throws {@link AppConfigServiceException}
* <p>Base exception class for all service exceptions from AppConfig service.</p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,15 @@ export interface CreateHostedConfigurationVersionCommandOutput
* <p>The requested resource could not be found.</p>
*
* @throws {@link ServiceQuotaExceededException} (client fault)
* <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>
* <p>The number of one more AppConfig resources exceeds the maximum allowed. Verify that your
* environment doesn't exceed the following service quotas:</p>
* <p>Applications: 100 max</p>
* <p>Deployment strategies: 20 max</p>
* <p>Configuration profiles: 100 max per application</p>
* <p>Environments: 20 max per application</p>
* <p>To resolve this issue, you can delete one or more resources and try again. Or, you
* can request a quota increase. For more information about quotas and to request an increase,
* 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>
*
* @throws {@link AppConfigServiceException}
* <p>Base exception class for all service exceptions from AppConfig service.</p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,7 @@ export interface GetDeploymentCommandOutput extends Deployment, __MetadataBearer
* // ],
* // KmsKeyArn: "STRING_VALUE",
* // KmsKeyIdentifier: "STRING_VALUE",
* // VersionLabel: "STRING_VALUE",
* // };
*
* ```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@ export interface ListDeploymentsCommandOutput extends Deployments, __MetadataBea
* // PercentageComplete: Number("float"),
* // StartedAt: new Date("TIMESTAMP"),
* // CompletedAt: new Date("TIMESTAMP"),
* // VersionLabel: "STRING_VALUE",
* // },
* // ],
* // NextToken: "STRING_VALUE",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,7 @@ export interface StartDeploymentCommandOutput extends Deployment, __MetadataBear
* // ],
* // KmsKeyArn: "STRING_VALUE",
* // KmsKeyIdentifier: "STRING_VALUE",
* // VersionLabel: "STRING_VALUE",
* // };
*
* ```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,7 @@ export interface StopDeploymentCommandOutput extends Deployment, __MetadataBeare
* // ],
* // KmsKeyArn: "STRING_VALUE",
* // KmsKeyIdentifier: "STRING_VALUE",
* // VersionLabel: "STRING_VALUE",
* // };
*
* ```
Expand Down
99 changes: 70 additions & 29 deletions clients/client-appconfig/src/models/models_0.ts
Original file line number Diff line number Diff line change
Expand Up @@ -339,6 +339,36 @@ export class InternalServerException extends __BaseException {
}
}

/**
* @public
* <p>The number of one more AppConfig resources exceeds the maximum allowed. Verify that your
* environment doesn't exceed the following service quotas:</p>
* <p>Applications: 100 max</p>
* <p>Deployment strategies: 20 max</p>
* <p>Configuration profiles: 100 max per application</p>
* <p>Environments: 20 max per application</p>
* <p>To resolve this issue, you can delete one or more resources and try again. Or, you
* can request a quota increase. For more information about quotas and to request an increase,
* 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>
*/
export class ServiceQuotaExceededException extends __BaseException {
readonly name: "ServiceQuotaExceededException" = "ServiceQuotaExceededException";
readonly $fault: "client" = "client";
Message?: string;
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>) {
super({
name: "ServiceQuotaExceededException",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, ServiceQuotaExceededException.prototype);
this.Message = opts.Message;
}
}

/**
* @public
* @enum
Expand Down Expand Up @@ -477,8 +507,13 @@ export interface CreateConfigurationProfileRequest {
* the format <code>ssm-parameter://<parameter name></code> or the ARN.</p>
* </li>
* <li>
* <p>For an Amazon Web Services
* CodePipeline pipeline, specify the URI in the following format:
* <code>codepipeline</code>://<pipeline name>.</p>
* </li>
* <li>
* <p>For an Secrets Manager secret, specify the URI in the following format:
* <code>secrets-manager</code>://<secret name>.</p>
* <code>secretsmanager</code>://<secret name>.</p>
* </li>
* <li>
* <p>For an Amazon S3 object, specify the URI in the following format:
Expand Down Expand Up @@ -992,28 +1027,6 @@ export interface Extension {
Parameters?: Record<string, Parameter>;
}

/**
* @public
* <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>
*/
export class ServiceQuotaExceededException extends __BaseException {
readonly name: "ServiceQuotaExceededException" = "ServiceQuotaExceededException";
readonly $fault: "client" = "client";
Message?: string;
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>) {
super({
name: "ServiceQuotaExceededException",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, ServiceQuotaExceededException.prototype);
this.Message = opts.Message;
}
}

/**
* @public
*/
Expand Down Expand Up @@ -1142,7 +1155,9 @@ export interface CreateHostedConfigurationVersionRequest {

/**
* @public
* <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>
* <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>
*/
VersionLabel?: string;
}
Expand Down Expand Up @@ -1549,9 +1564,19 @@ export interface DeploymentEvent {
/**
* @public
* <p>A description of the deployment event. Descriptions include, but are not limited to, the
* user account or the Amazon CloudWatch alarm ARN that initiated a rollback, the percentage of hosts
* that received the deployment, or in the case of an internal error, a recommendation to
* attempt a new deployment.</p>
* following:</p>
* <ul>
* <li>
* <p>The Amazon Web Services account or the Amazon CloudWatch alarm ARN that initiated a rollback.</p>
* </li>
* <li>
* <p>The percentage of hosts that received the deployment.</p>
* </li>
* <li>
* <p>A recommendation to attempt a new deployment (in the case of an internal
* error).</p>
* </li>
* </ul>
*/
Description?: string;

Expand Down Expand Up @@ -1723,6 +1748,12 @@ export interface Deployment {
* <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>
*/
KmsKeyIdentifier?: string;

/**
* @public
* <p>A user-defined label for an AppConfig hosted configuration version.</p>
*/
VersionLabel?: string;
}

/**
Expand Down Expand Up @@ -2040,6 +2071,12 @@ export interface DeploymentSummary {
* <p>Time the deployment completed.</p>
*/
CompletedAt?: Date;

/**
* @public
* <p>A user-defined label for an AppConfig hosted configuration version.</p>
*/
VersionLabel?: string;
}

/**
Expand Down Expand Up @@ -2429,7 +2466,9 @@ export interface ListHostedConfigurationVersionsRequest {

/**
* @public
* <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>
* <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>
*/
VersionLabel?: string;
}
Expand Down Expand Up @@ -2488,7 +2527,9 @@ export interface StartDeploymentRequest {

/**
* @public
* <p>The configuration version to deploy. If deploying an AppConfig hosted configuration version, you can specify either the version number or version label.</p>
* <p>The configuration version to deploy. If deploying an AppConfig hosted
* configuration version, you can specify either the version number or version label. For all
* other configurations, you must specify the version number.</p>
*/
ConfigurationVersion: string | undefined;

Expand Down
Loading

0 comments on commit 78ddf33

Please sign in to comment.