|
2 | 2 | "version":"2.0",
|
3 | 3 | "metadata":{
|
4 | 4 | "apiVersion":"2023-09-30",
|
| 5 | + "auth":["aws.auth#sigv4"], |
5 | 6 | "endpointPrefix":"bedrock-runtime",
|
6 |
| - "jsonVersion":"1.1", |
7 | 7 | "protocol":"rest-json",
|
| 8 | + "protocols":["rest-json"], |
8 | 9 | "serviceFullName":"Amazon Bedrock Runtime",
|
9 | 10 | "serviceId":"Bedrock Runtime",
|
10 | 11 | "signatureVersion":"v4",
|
|
46 | 47 | {"shape":"ThrottlingException"},
|
47 | 48 | {"shape":"ModelTimeoutException"},
|
48 | 49 | {"shape":"InternalServerException"},
|
| 50 | + {"shape":"ServiceUnavailableException"}, |
49 | 51 | {"shape":"ValidationException"},
|
50 | 52 | {"shape":"ModelNotReadyException"},
|
51 | 53 | {"shape":"ModelErrorException"}
|
52 | 54 | ],
|
53 |
| - "documentation":"<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 to the model.</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> </p> <p>For example code, see <i>Converse API examples</i> in the <i>Amazon Bedrock User Guide</i>. </p> <p>This operation requires permission for the <code>bedrock:InvokeModel</code> action. </p>" |
| 55 | + "documentation":"<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. 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> </p> <p>For example code, see <i>Converse API examples</i> in the <i>Amazon Bedrock User Guide</i>. </p> <p>This operation requires permission for the <code>bedrock:InvokeModel</code> action. </p>" |
54 | 56 | },
|
55 | 57 | "ConverseStream":{
|
56 | 58 | "name":"ConverseStream",
|
|
67 | 69 | {"shape":"ThrottlingException"},
|
68 | 70 | {"shape":"ModelTimeoutException"},
|
69 | 71 | {"shape":"InternalServerException"},
|
| 72 | + {"shape":"ServiceUnavailableException"}, |
70 | 73 | {"shape":"ValidationException"},
|
71 | 74 | {"shape":"ModelNotReadyException"},
|
72 | 75 | {"shape":"ModelErrorException"}
|
73 | 76 | ],
|
74 |
| - "documentation":"<p>Sends messages to the specified Amazon Bedrock model and returns the response in a stream. <code>ConverseStream</code> provides a consistent API that works with all Amazon Bedrock 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 to the 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> <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> </p> <p>For example code, see <i>Conversation streaming example</i> in the <i>Amazon Bedrock User Guide</i>. </p> <p>This operation requires permission for the <code>bedrock:InvokeModelWithResponseStream</code> action.</p>" |
| 77 | + "documentation":"<p>Sends messages to the specified Amazon Bedrock model and returns the response in a stream. <code>ConverseStream</code> provides a consistent API that works with all Amazon Bedrock 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 to the 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> </p> <p>For example code, see <i>Conversation streaming example</i> in the <i>Amazon Bedrock User Guide</i>. </p> <p>This operation requires permission for the <code>bedrock:InvokeModelWithResponseStream</code> action.</p>" |
75 | 78 | },
|
76 | 79 | "InvokeModel":{
|
77 | 80 | "name":"InvokeModel",
|
|
88 | 91 | {"shape":"ThrottlingException"},
|
89 | 92 | {"shape":"ModelTimeoutException"},
|
90 | 93 | {"shape":"InternalServerException"},
|
| 94 | + {"shape":"ServiceUnavailableException"}, |
91 | 95 | {"shape":"ValidationException"},
|
92 | 96 | {"shape":"ModelNotReadyException"},
|
93 | 97 | {"shape":"ServiceQuotaExceededException"},
|
|
110 | 114 | {"shape":"ThrottlingException"},
|
111 | 115 | {"shape":"ModelTimeoutException"},
|
112 | 116 | {"shape":"InternalServerException"},
|
| 117 | + {"shape":"ServiceUnavailableException"}, |
113 | 118 | {"shape":"ModelStreamErrorException"},
|
114 | 119 | {"shape":"ValidationException"},
|
115 | 120 | {"shape":"ModelNotReadyException"},
|
116 | 121 | {"shape":"ServiceQuotaExceededException"},
|
117 | 122 | {"shape":"ModelErrorException"}
|
118 | 123 | ],
|
119 |
| - "documentation":"<p>Invoke the specified Amazon Bedrock model to run inference using the prompt and inference parameters provided in the request body. The response is returned in a stream.</p> <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> </note> <p>For example code, see <i>Invoke model with streaming code example</i> in the <i>Amazon Bedrock User Guide</i>. </p> <p>This operation requires permissions to perform the <code>bedrock:InvokeModelWithResponseStream</code> action. </p>" |
| 124 | + "documentation":"<p>Invoke the specified Amazon Bedrock model to run inference using the prompt and inference parameters provided in the request body. The response is returned in a stream.</p> <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 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>. </p> <p>This operation requires permissions to perform the <code>bedrock:InvokeModelWithResponseStream</code> action. </p>" |
120 | 125 | }
|
121 | 126 | },
|
122 | 127 | "shapes":{
|
|
519 | 524 | "throttlingException":{
|
520 | 525 | "shape":"ThrottlingException",
|
521 | 526 | "documentation":"<p>The number of requests exceeds the limit. Resubmit your request later.</p>"
|
| 527 | + }, |
| 528 | + "serviceUnavailableException":{ |
| 529 | + "shape":"ServiceUnavailableException", |
| 530 | + "documentation":"<p>The service isn't currently available. Try again later.</p>" |
522 | 531 | }
|
523 | 532 | },
|
524 | 533 | "documentation":"<p>The messages output stream</p>",
|
|
1768 | 1777 | },
|
1769 | 1778 | "throttlingException":{
|
1770 | 1779 | "shape":"ThrottlingException",
|
1771 |
| - "documentation":"<p>The number or frequency of requests exceeds the limit. Resubmit your request later.</p>" |
| 1780 | + "documentation":"<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>" |
1772 | 1781 | },
|
1773 | 1782 | "modelTimeoutException":{
|
1774 | 1783 | "shape":"ModelTimeoutException",
|
1775 | 1784 | "documentation":"<p>The request took too long to process. Processing time exceeded the model timeout length.</p>"
|
1776 |
| - } |
| 1785 | + }, |
| 1786 | + "serviceUnavailableException":{"shape":"ServiceUnavailableException"} |
1777 | 1787 | },
|
1778 | 1788 | "documentation":"<p>Definition of content in the response stream.</p>",
|
1779 | 1789 | "eventstream":true
|
|
1783 | 1793 | "members":{
|
1784 | 1794 | "message":{"shape":"NonBlankString"}
|
1785 | 1795 | },
|
1786 |
| - "documentation":"<p>The number of requests exceeds the service quota. Resubmit your request later.</p>", |
| 1796 | + "documentation":"<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>", |
1787 | 1797 | "error":{
|
1788 | 1798 | "httpStatusCode":400,
|
1789 | 1799 | "senderFault":true
|
1790 | 1800 | },
|
1791 | 1801 | "exception":true
|
1792 | 1802 | },
|
| 1803 | + "ServiceUnavailableException":{ |
| 1804 | + "type":"structure", |
| 1805 | + "members":{ |
| 1806 | + "message":{"shape":"NonBlankString"} |
| 1807 | + }, |
| 1808 | + "documentation":"<p>The service isn't currently available. Try again later.</p>", |
| 1809 | + "error":{"httpStatusCode":503}, |
| 1810 | + "exception":true, |
| 1811 | + "fault":true |
| 1812 | + }, |
1793 | 1813 | "SpecificToolChoice":{
|
1794 | 1814 | "type":"structure",
|
1795 | 1815 | "required":["name"],
|
|
1843 | 1863 | "members":{
|
1844 | 1864 | "message":{"shape":"NonBlankString"}
|
1845 | 1865 | },
|
1846 |
| - "documentation":"<p>The number of requests exceeds the limit. Resubmit your request later.</p>", |
| 1866 | + "documentation":"<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>", |
1847 | 1867 | "error":{
|
1848 | 1868 | "httpStatusCode":429,
|
1849 | 1869 | "senderFault":true
|
|
0 commit comments