feat(client-bedrock-runtime): Provides ServiceUnavailableException er…

…ror message
aws · Jul 25, 2024 · 690bc7f · 690bc7f
1 parent 2156a87
commit 690bc7f
Show file tree

Hide file tree

Showing 8 changed files with 210 additions and 19 deletions.
diff --git a/clients/client-bedrock-runtime/src/commands/ApplyGuardrailCommand.ts b/clients/client-bedrock-runtime/src/commands/ApplyGuardrailCommand.ts
@@ -151,10 +151,10 @@ export interface ApplyGuardrailCommandOutput extends ApplyGuardrailResponse, __M
  * <p>The specified resource ARN was not found. Check the ARN and try your request again.</p>
  *
  * @throws {@link ServiceQuotaExceededException} (client fault)
- * <p>The number of requests exceeds the service quota. Resubmit your request later.</p>
+ * <p>Your request exceeds the service quota for your account. You can view your quotas at <a href="https://docs.aws.amazon.com/servicequotas/latest/userguide/gs-request-quota.html">Viewing service quotas</a>. You can resubmit your request later.</p>
  *
  * @throws {@link ThrottlingException} (client fault)
- * <p>The number of requests exceeds the limit. Resubmit your request later.</p>
+ * <p>Your request was throttled because of service-wide limitations. Resubmit your request later or in a different region. You can also purchase <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prov-throughput.html">Provisioned Throughput</a> to increase the rate or number of tokens you can process.</p>
  *
  * @throws {@link ValidationException} (client fault)
  * <p>Input validation failed. Check your request parameters and retry the request.</p>

diff --git a/clients/client-bedrock-runtime/src/commands/ConverseCommand.ts b/clients/client-bedrock-runtime/src/commands/ConverseCommand.ts
@@ -31,8 +31,9 @@ export interface ConverseCommandOutput extends ConverseResponse, __MetadataBeare
  * <p>Sends messages to the specified Amazon Bedrock model. <code>Converse</code> provides
  * a consistent interface that works with all models that
  * support messages. This allows you to write code once and use it with different models.
- * Should a model have unique inference parameters, you can also pass those unique parameters
+ * If a model has unique inference parameters, you can also pass those unique parameters
  * to the model.</p>
+ * <p>Amazon Bedrock doesn't store any text, images, or documents that you provide as content. The data is only used to generate the response.</p>
  * <p>For information about the Converse API, see <i>Use the Converse API</i> in the <i>Amazon Bedrock User Guide</i>.
  * To use a guardrail, see <i>Use a guardrail with the Converse API</i> in the <i>Amazon Bedrock User Guide</i>.
  * To use a tool with a model, see <i>Tool use (Function calling)</i> in the <i>Amazon Bedrock User Guide</i>
@@ -395,8 +396,11 @@ export interface ConverseCommandOutput extends ConverseResponse, __MetadataBeare
  * @throws {@link ResourceNotFoundException} (client fault)
  * <p>The specified resource ARN was not found. Check the ARN and try your request again.</p>
  *
+ * @throws {@link ServiceUnavailableException} (server fault)
+ * <p>The service isn't currently available. Try again later.</p>
+ *
  * @throws {@link ThrottlingException} (client fault)
- * <p>The number of requests exceeds the limit. Resubmit your request later.</p>
+ * <p>Your request was throttled because of service-wide limitations. Resubmit your request later or in a different region. You can also purchase <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prov-throughput.html">Provisioned Throughput</a> to increase the rate or number of tokens you can process.</p>
  *
  * @throws {@link ValidationException} (client fault)
  * <p>Input validation failed. Check your request parameters and retry the request.</p>

diff --git a/clients/client-bedrock-runtime/src/commands/ConverseStreamCommand.ts b/clients/client-bedrock-runtime/src/commands/ConverseStreamCommand.ts
@@ -40,6 +40,10 @@ export interface ConverseStreamCommandOutput extends ConverseStreamResponse, __M
  * model. </p>
  * <p>To find out if a model supports streaming, call <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GetFoundationModel.html">GetFoundationModel</a>
  * and check the <code>responseStreamingSupported</code> field in the response.</p>
+ * <note>
+ * <p>The CLI doesn't support streaming operations in Amazon Bedrock, including <code>ConverseStream</code>.</p>
+ * </note>
+ * <p>Amazon Bedrock doesn't store any text, images, or documents that you provide as content. The data is only used to generate the response.</p>
  * <p>For information about the Converse API, see <i>Use the Converse API</i> in the <i>Amazon Bedrock User Guide</i>.
  * To use a guardrail, see <i>Use a guardrail with the Converse API</i> in the <i>Amazon Bedrock User Guide</i>.
  * To use a tool with a model, see <i>Tool use (Function calling)</i> in the <i>Amazon Bedrock User Guide</i>
@@ -359,6 +363,9 @@ export interface ConverseStreamCommandOutput extends ConverseStreamResponse, __M
  * // throttlingException: { // ThrottlingException
  * // message: "STRING_VALUE",
  * // },
+ * // serviceUnavailableException: { // ServiceUnavailableException
+ * // message: "STRING_VALUE",
+ * // },
  * // },
  * // };
  *
@@ -388,8 +395,11 @@ export interface ConverseStreamCommandOutput extends ConverseStreamResponse, __M
  * @throws {@link ResourceNotFoundException} (client fault)
  * <p>The specified resource ARN was not found. Check the ARN and try your request again.</p>
  *
+ * @throws {@link ServiceUnavailableException} (server fault)
+ * <p>The service isn't currently available. Try again later.</p>
+ *
  * @throws {@link ThrottlingException} (client fault)
- * <p>The number of requests exceeds the limit. Resubmit your request later.</p>
+ * <p>Your request was throttled because of service-wide limitations. Resubmit your request later or in a different region. You can also purchase <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prov-throughput.html">Provisioned Throughput</a> to increase the rate or number of tokens you can process.</p>
  *
  * @throws {@link ValidationException} (client fault)
  * <p>Input validation failed. Check your request parameters and retry the request.</p>

diff --git a/clients/client-bedrock-runtime/src/commands/InvokeModelCommand.ts b/clients/client-bedrock-runtime/src/commands/InvokeModelCommand.ts
@@ -102,10 +102,13 @@ export interface InvokeModelCommandOutput extends InvokeModelCommandOutputType,
  * <p>The specified resource ARN was not found. Check the ARN and try your request again.</p>
  *
  * @throws {@link ServiceQuotaExceededException} (client fault)
- * <p>The number of requests exceeds the service quota. Resubmit your request later.</p>
+ * <p>Your request exceeds the service quota for your account. You can view your quotas at <a href="https://docs.aws.amazon.com/servicequotas/latest/userguide/gs-request-quota.html">Viewing service quotas</a>. You can resubmit your request later.</p>
+ *
+ * @throws {@link ServiceUnavailableException} (server fault)
+ * <p>The service isn't currently available. Try again later.</p>
  *
  * @throws {@link ThrottlingException} (client fault)
- * <p>The number of requests exceeds the limit. Resubmit your request later.</p>
+ * <p>Your request was throttled because of service-wide limitations. Resubmit your request later or in a different region. You can also purchase <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prov-throughput.html">Provisioned Throughput</a> to increase the rate or number of tokens you can process.</p>
  *
  * @throws {@link ValidationException} (client fault)
  * <p>Input validation failed. Check your request parameters and retry the request.</p>

diff --git a/clients/client-bedrock-runtime/src/commands/InvokeModelWithResponseStreamCommand.ts b/clients/client-bedrock-runtime/src/commands/InvokeModelWithResponseStreamCommand.ts
@@ -49,7 +49,7 @@ export interface InvokeModelWithResponseStreamCommandOutput
  * <p>To see if a model supports streaming, call <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GetFoundationModel.html">GetFoundationModel</a>
  * and check the <code>responseStreamingSupported</code> field in the response.</p>
  * <note>
- * <p>The CLI doesn't support <code>InvokeModelWithResponseStream</code>.</p>
+ * <p>The CLI doesn't support streaming operations in Amazon Bedrock, including <code>InvokeModelWithResponseStream</code>.</p>
  * </note>
  * <p>For example code, see <i>Invoke model with streaming code
  * example</i> in the <i>Amazon Bedrock User Guide</i>.
@@ -94,6 +94,9 @@ export interface InvokeModelWithResponseStreamCommandOutput
  * // modelTimeoutException: { // ModelTimeoutException
  * // message: "STRING_VALUE",
  * // },
+ * // serviceUnavailableException: { // ServiceUnavailableException
+ * // message: "STRING_VALUE",
+ * // },
  * // },
  * // contentType: "STRING_VALUE", // required
  * // };
@@ -128,10 +131,13 @@ export interface InvokeModelWithResponseStreamCommandOutput
  * <p>The specified resource ARN was not found. Check the ARN and try your request again.</p>
  *
  * @throws {@link ServiceQuotaExceededException} (client fault)
- * <p>The number of requests exceeds the service quota. Resubmit your request later.</p>
+ * <p>Your request exceeds the service quota for your account. You can view your quotas at <a href="https://docs.aws.amazon.com/servicequotas/latest/userguide/gs-request-quota.html">Viewing service quotas</a>. You can resubmit your request later.</p>
+ *
+ * @throws {@link ServiceUnavailableException} (server fault)
+ * <p>The service isn't currently available. Try again later.</p>
  *
  * @throws {@link ThrottlingException} (client fault)
- * <p>The number of requests exceeds the limit. Resubmit your request later.</p>
+ * <p>Your request was throttled because of service-wide limitations. Resubmit your request later or in a different region. You can also purchase <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prov-throughput.html">Provisioned Throughput</a> to increase the rate or number of tokens you can process.</p>
  *
  * @throws {@link ValidationException} (client fault)
  * <p>Input validation failed. Check your request parameters and retry the request.</p>