@aws-sdk/client-bedrock 3.556.0 → 3.563.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.
Files changed (74) hide show
  1. package/README.md +81 -1
  2. package/dist-cjs/index.js +1005 -79
  3. package/dist-es/Bedrock.js +20 -0
  4. package/dist-es/commands/CreateEvaluationJobCommand.js +25 -0
  5. package/dist-es/commands/CreateGuardrailCommand.js +25 -0
  6. package/dist-es/commands/CreateGuardrailVersionCommand.js +25 -0
  7. package/dist-es/commands/DeleteGuardrailCommand.js +24 -0
  8. package/dist-es/commands/GetEvaluationJobCommand.js +25 -0
  9. package/dist-es/commands/GetGuardrailCommand.js +25 -0
  10. package/dist-es/commands/ListEvaluationJobsCommand.js +24 -0
  11. package/dist-es/commands/ListGuardrailsCommand.js +25 -0
  12. package/dist-es/commands/StopEvaluationJobCommand.js +25 -0
  13. package/dist-es/commands/UpdateGuardrailCommand.js +25 -0
  14. package/dist-es/commands/index.js +10 -0
  15. package/dist-es/models/models_0.js +312 -48
  16. package/dist-es/pagination/ListEvaluationJobsPaginator.js +4 -0
  17. package/dist-es/pagination/ListGuardrailsPaginator.js +4 -0
  18. package/dist-es/pagination/index.js +2 -0
  19. package/dist-es/protocols/Aws_restJson1.js +374 -4
  20. package/dist-types/Bedrock.d.ts +73 -1
  21. package/dist-types/BedrockClient.d.ts +13 -3
  22. package/dist-types/commands/CreateEvaluationJobCommand.d.ts +148 -0
  23. package/dist-types/commands/CreateGuardrailCommand.d.ts +186 -0
  24. package/dist-types/commands/CreateGuardrailVersionCommand.d.ts +84 -0
  25. package/dist-types/commands/CreateModelCustomizationJobCommand.d.ts +6 -8
  26. package/dist-types/commands/CreateProvisionedModelThroughputCommand.d.ts +2 -3
  27. package/dist-types/commands/DeleteCustomModelCommand.d.ts +2 -2
  28. package/dist-types/commands/DeleteGuardrailCommand.d.ts +84 -0
  29. package/dist-types/commands/DeleteProvisionedModelThroughputCommand.d.ts +2 -2
  30. package/dist-types/commands/GetCustomModelCommand.d.ts +2 -2
  31. package/dist-types/commands/GetEvaluationJobCommand.d.ts +144 -0
  32. package/dist-types/commands/GetFoundationModelCommand.d.ts +1 -1
  33. package/dist-types/commands/GetGuardrailCommand.d.ts +140 -0
  34. package/dist-types/commands/GetModelCustomizationJobCommand.d.ts +2 -2
  35. package/dist-types/commands/GetProvisionedModelThroughputCommand.d.ts +2 -2
  36. package/dist-types/commands/ListCustomModelsCommand.d.ts +1 -1
  37. package/dist-types/commands/ListEvaluationJobsCommand.d.ts +93 -0
  38. package/dist-types/commands/ListFoundationModelsCommand.d.ts +1 -1
  39. package/dist-types/commands/ListGuardrailsCommand.d.ts +89 -0
  40. package/dist-types/commands/ListModelCustomizationJobsCommand.d.ts +2 -2
  41. package/dist-types/commands/ListProvisionedModelThroughputsCommand.d.ts +1 -1
  42. package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -2
  43. package/dist-types/commands/StopEvaluationJobCommand.d.ts +75 -0
  44. package/dist-types/commands/StopModelCustomizationJobCommand.d.ts +2 -2
  45. package/dist-types/commands/TagResourceCommand.d.ts +2 -2
  46. package/dist-types/commands/UntagResourceCommand.d.ts +2 -2
  47. package/dist-types/commands/UpdateGuardrailCommand.d.ts +176 -0
  48. package/dist-types/commands/UpdateProvisionedModelThroughputCommand.d.ts +2 -2
  49. package/dist-types/commands/index.d.ts +10 -0
  50. package/dist-types/index.d.ts +1 -1
  51. package/dist-types/models/models_0.d.ts +1926 -215
  52. package/dist-types/pagination/ListEvaluationJobsPaginator.d.ts +7 -0
  53. package/dist-types/pagination/ListGuardrailsPaginator.d.ts +7 -0
  54. package/dist-types/pagination/index.d.ts +2 -0
  55. package/dist-types/protocols/Aws_restJson1.d.ts +90 -0
  56. package/dist-types/ts3.4/Bedrock.d.ts +172 -0
  57. package/dist-types/ts3.4/BedrockClient.d.ts +60 -0
  58. package/dist-types/ts3.4/commands/CreateEvaluationJobCommand.d.ts +39 -0
  59. package/dist-types/ts3.4/commands/CreateGuardrailCommand.d.ts +38 -0
  60. package/dist-types/ts3.4/commands/CreateGuardrailVersionCommand.d.ts +39 -0
  61. package/dist-types/ts3.4/commands/DeleteGuardrailCommand.d.ts +38 -0
  62. package/dist-types/ts3.4/commands/GetEvaluationJobCommand.d.ts +38 -0
  63. package/dist-types/ts3.4/commands/GetGuardrailCommand.d.ts +35 -0
  64. package/dist-types/ts3.4/commands/ListEvaluationJobsCommand.d.ts +39 -0
  65. package/dist-types/ts3.4/commands/ListGuardrailsCommand.d.ts +38 -0
  66. package/dist-types/ts3.4/commands/StopEvaluationJobCommand.d.ts +39 -0
  67. package/dist-types/ts3.4/commands/UpdateGuardrailCommand.d.ts +38 -0
  68. package/dist-types/ts3.4/commands/index.d.ts +10 -0
  69. package/dist-types/ts3.4/models/models_0.d.ts +572 -49
  70. package/dist-types/ts3.4/pagination/ListEvaluationJobsPaginator.d.ts +11 -0
  71. package/dist-types/ts3.4/pagination/ListGuardrailsPaginator.d.ts +11 -0
  72. package/dist-types/ts3.4/pagination/index.d.ts +2 -0
  73. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +120 -0
  74. package/package.json +2 -2
@@ -26,7 +26,7 @@ declare const DeleteProvisionedModelThroughputCommand_base: {
26
26
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
27
27
  };
28
28
  /**
29
- * <p>Deletes a provisioned throughput. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html">Provisioned throughput</a> in the Bedrock User Guide.</p>
29
+ * <p>Deletes a Provisioned Throughput. You can't delete a Provisioned Throughput before the commitment term is over. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prov-throughput.html">Provisioned Throughput</a> in the Amazon Bedrock User Guide.</p>
30
30
  * @example
31
31
  * Use a bare-bones client and the command you need to make an API call.
32
32
  * ```javascript
@@ -58,7 +58,7 @@ declare const DeleteProvisionedModelThroughputCommand_base: {
58
58
  * <p>An internal server error occurred. Retry your request.</p>
59
59
  *
60
60
  * @throws {@link ResourceNotFoundException} (client fault)
61
- * <p>The specified resource ARN was not found. Check the ARN and try your request again.</p>
61
+ * <p>The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.</p>
62
62
  *
63
63
  * @throws {@link ThrottlingException} (client fault)
64
64
  * <p>The number of requests exceeds the limit. Resubmit your request later.</p>
@@ -26,7 +26,7 @@ declare const GetCustomModelCommand_base: {
26
26
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
27
27
  };
28
28
  /**
29
- * <p>Get the properties associated with a Amazon Bedrock custom model that you have created.For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models.html">Custom models</a> in the Bedrock User Guide.</p>
29
+ * <p>Get the properties associated with a Amazon Bedrock custom model that you have created.For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models.html">Custom models</a> in the Amazon Bedrock User Guide.</p>
30
30
  * @example
31
31
  * Use a bare-bones client and the command you need to make an API call.
32
32
  * ```javascript
@@ -88,7 +88,7 @@ declare const GetCustomModelCommand_base: {
88
88
  * <p>An internal server error occurred. Retry your request.</p>
89
89
  *
90
90
  * @throws {@link ResourceNotFoundException} (client fault)
91
- * <p>The specified resource ARN was not found. Check the ARN and try your request again.</p>
91
+ * <p>The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.</p>
92
92
  *
93
93
  * @throws {@link ThrottlingException} (client fault)
94
94
  * <p>The number of requests exceeds the limit. Resubmit your request later.</p>
@@ -0,0 +1,144 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { BedrockClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BedrockClient";
4
+ import { GetEvaluationJobRequest, GetEvaluationJobResponse } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export { __MetadataBearer, $Command };
9
+ /**
10
+ * @public
11
+ *
12
+ * The input for {@link GetEvaluationJobCommand}.
13
+ */
14
+ export interface GetEvaluationJobCommandInput extends GetEvaluationJobRequest {
15
+ }
16
+ /**
17
+ * @public
18
+ *
19
+ * The output of {@link GetEvaluationJobCommand}.
20
+ */
21
+ export interface GetEvaluationJobCommandOutput extends GetEvaluationJobResponse, __MetadataBearer {
22
+ }
23
+ declare const GetEvaluationJobCommand_base: {
24
+ new (input: GetEvaluationJobCommandInput): import("@smithy/smithy-client").CommandImpl<GetEvaluationJobCommandInput, GetEvaluationJobCommandOutput, BedrockClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
25
+ new (__0_0: GetEvaluationJobCommandInput): import("@smithy/smithy-client").CommandImpl<GetEvaluationJobCommandInput, GetEvaluationJobCommandOutput, BedrockClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
27
+ };
28
+ /**
29
+ * <p>Retrieves the properties associated with a model evaluation job, including the
30
+ * status of the job. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/latest/userguide/model-evaluation.html">Model evaluations</a>.</p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { BedrockClient, GetEvaluationJobCommand } from "@aws-sdk/client-bedrock"; // ES Modules import
35
+ * // const { BedrockClient, GetEvaluationJobCommand } = require("@aws-sdk/client-bedrock"); // CommonJS import
36
+ * const client = new BedrockClient(config);
37
+ * const input = { // GetEvaluationJobRequest
38
+ * jobIdentifier: "STRING_VALUE", // required
39
+ * };
40
+ * const command = new GetEvaluationJobCommand(input);
41
+ * const response = await client.send(command);
42
+ * // { // GetEvaluationJobResponse
43
+ * // jobName: "STRING_VALUE", // required
44
+ * // status: "InProgress" || "Completed" || "Failed" || "Stopping" || "Stopped", // required
45
+ * // jobArn: "STRING_VALUE", // required
46
+ * // jobDescription: "STRING_VALUE",
47
+ * // roleArn: "STRING_VALUE", // required
48
+ * // customerEncryptionKeyId: "STRING_VALUE",
49
+ * // jobType: "Human" || "Automated", // required
50
+ * // evaluationConfig: { // EvaluationConfig Union: only one key present
51
+ * // automated: { // AutomatedEvaluationConfig
52
+ * // datasetMetricConfigs: [ // EvaluationDatasetMetricConfigs // required
53
+ * // { // EvaluationDatasetMetricConfig
54
+ * // taskType: "Summarization" || "Classification" || "QuestionAndAnswer" || "Generation" || "Custom", // required
55
+ * // dataset: { // EvaluationDataset
56
+ * // name: "STRING_VALUE", // required
57
+ * // datasetLocation: { // EvaluationDatasetLocation Union: only one key present
58
+ * // s3Uri: "STRING_VALUE",
59
+ * // },
60
+ * // },
61
+ * // metricNames: [ // EvaluationMetricNames // required
62
+ * // "STRING_VALUE",
63
+ * // ],
64
+ * // },
65
+ * // ],
66
+ * // },
67
+ * // human: { // HumanEvaluationConfig
68
+ * // humanWorkflowConfig: { // HumanWorkflowConfig
69
+ * // flowDefinitionArn: "STRING_VALUE", // required
70
+ * // instructions: "STRING_VALUE",
71
+ * // },
72
+ * // customMetrics: [ // HumanEvaluationCustomMetrics
73
+ * // { // HumanEvaluationCustomMetric
74
+ * // name: "STRING_VALUE", // required
75
+ * // description: "STRING_VALUE",
76
+ * // ratingMethod: "STRING_VALUE", // required
77
+ * // },
78
+ * // ],
79
+ * // datasetMetricConfigs: [ // required
80
+ * // {
81
+ * // taskType: "Summarization" || "Classification" || "QuestionAndAnswer" || "Generation" || "Custom", // required
82
+ * // dataset: {
83
+ * // name: "STRING_VALUE", // required
84
+ * // datasetLocation: {// Union: only one key present
85
+ * // s3Uri: "STRING_VALUE",
86
+ * // },
87
+ * // },
88
+ * // metricNames: [ // required
89
+ * // "STRING_VALUE",
90
+ * // ],
91
+ * // },
92
+ * // ],
93
+ * // },
94
+ * // },
95
+ * // inferenceConfig: { // EvaluationInferenceConfig Union: only one key present
96
+ * // models: [ // EvaluationModelConfigs
97
+ * // { // EvaluationModelConfig Union: only one key present
98
+ * // bedrockModel: { // EvaluationBedrockModel
99
+ * // modelIdentifier: "STRING_VALUE", // required
100
+ * // inferenceParams: "STRING_VALUE", // required
101
+ * // },
102
+ * // },
103
+ * // ],
104
+ * // },
105
+ * // outputDataConfig: { // EvaluationOutputDataConfig
106
+ * // s3Uri: "STRING_VALUE", // required
107
+ * // },
108
+ * // creationTime: new Date("TIMESTAMP"), // required
109
+ * // lastModifiedTime: new Date("TIMESTAMP"),
110
+ * // failureMessages: [ // ErrorMessages
111
+ * // "STRING_VALUE",
112
+ * // ],
113
+ * // };
114
+ *
115
+ * ```
116
+ *
117
+ * @param GetEvaluationJobCommandInput - {@link GetEvaluationJobCommandInput}
118
+ * @returns {@link GetEvaluationJobCommandOutput}
119
+ * @see {@link GetEvaluationJobCommandInput} for command's `input` shape.
120
+ * @see {@link GetEvaluationJobCommandOutput} for command's `response` shape.
121
+ * @see {@link BedrockClientResolvedConfig | config} for BedrockClient's `config` shape.
122
+ *
123
+ * @throws {@link AccessDeniedException} (client fault)
124
+ * <p>The request is denied because of missing access permissions.</p>
125
+ *
126
+ * @throws {@link InternalServerException} (server fault)
127
+ * <p>An internal server error occurred. Retry your request.</p>
128
+ *
129
+ * @throws {@link ResourceNotFoundException} (client fault)
130
+ * <p>The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.</p>
131
+ *
132
+ * @throws {@link ThrottlingException} (client fault)
133
+ * <p>The number of requests exceeds the limit. Resubmit your request later.</p>
134
+ *
135
+ * @throws {@link ValidationException} (client fault)
136
+ * <p>Input validation failed. Check your request parameters and retry the request.</p>
137
+ *
138
+ * @throws {@link BedrockServiceException}
139
+ * <p>Base exception class for all service exceptions from Bedrock service.</p>
140
+ *
141
+ * @public
142
+ */
143
+ export declare class GetEvaluationJobCommand extends GetEvaluationJobCommand_base {
144
+ }
@@ -78,7 +78,7 @@ declare const GetFoundationModelCommand_base: {
78
78
  * <p>An internal server error occurred. Retry your request.</p>
79
79
  *
80
80
  * @throws {@link ResourceNotFoundException} (client fault)
81
- * <p>The specified resource ARN was not found. Check the ARN and try your request again.</p>
81
+ * <p>The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.</p>
82
82
  *
83
83
  * @throws {@link ThrottlingException} (client fault)
84
84
  * <p>The number of requests exceeds the limit. Resubmit your request later.</p>
@@ -0,0 +1,140 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { BedrockClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BedrockClient";
4
+ import { GetGuardrailRequest, GetGuardrailResponse } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export { __MetadataBearer, $Command };
9
+ /**
10
+ * @public
11
+ *
12
+ * The input for {@link GetGuardrailCommand}.
13
+ */
14
+ export interface GetGuardrailCommandInput extends GetGuardrailRequest {
15
+ }
16
+ /**
17
+ * @public
18
+ *
19
+ * The output of {@link GetGuardrailCommand}.
20
+ */
21
+ export interface GetGuardrailCommandOutput extends GetGuardrailResponse, __MetadataBearer {
22
+ }
23
+ declare const GetGuardrailCommand_base: {
24
+ new (input: GetGuardrailCommandInput): import("@smithy/smithy-client").CommandImpl<GetGuardrailCommandInput, GetGuardrailCommandOutput, BedrockClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
25
+ new (__0_0: GetGuardrailCommandInput): import("@smithy/smithy-client").CommandImpl<GetGuardrailCommandInput, GetGuardrailCommandOutput, BedrockClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
27
+ };
28
+ /**
29
+ * <p>Gets details about a guardrail. If you don't specify a version, the response returns details for the <code>DRAFT</code> version.</p>
30
+ * @example
31
+ * Use a bare-bones client and the command you need to make an API call.
32
+ * ```javascript
33
+ * import { BedrockClient, GetGuardrailCommand } from "@aws-sdk/client-bedrock"; // ES Modules import
34
+ * // const { BedrockClient, GetGuardrailCommand } = require("@aws-sdk/client-bedrock"); // CommonJS import
35
+ * const client = new BedrockClient(config);
36
+ * const input = { // GetGuardrailRequest
37
+ * guardrailIdentifier: "STRING_VALUE", // required
38
+ * guardrailVersion: "STRING_VALUE",
39
+ * };
40
+ * const command = new GetGuardrailCommand(input);
41
+ * const response = await client.send(command);
42
+ * // { // GetGuardrailResponse
43
+ * // name: "STRING_VALUE", // required
44
+ * // description: "STRING_VALUE",
45
+ * // guardrailId: "STRING_VALUE", // required
46
+ * // guardrailArn: "STRING_VALUE", // required
47
+ * // version: "STRING_VALUE", // required
48
+ * // status: "CREATING" || "UPDATING" || "VERSIONING" || "READY" || "FAILED" || "DELETING", // required
49
+ * // topicPolicy: { // GuardrailTopicPolicy
50
+ * // topics: [ // GuardrailTopics // required
51
+ * // { // GuardrailTopic
52
+ * // name: "STRING_VALUE", // required
53
+ * // definition: "STRING_VALUE", // required
54
+ * // examples: [ // GuardrailTopicExamples
55
+ * // "STRING_VALUE",
56
+ * // ],
57
+ * // type: "DENY",
58
+ * // },
59
+ * // ],
60
+ * // },
61
+ * // contentPolicy: { // GuardrailContentPolicy
62
+ * // filters: [ // GuardrailContentFilters
63
+ * // { // GuardrailContentFilter
64
+ * // type: "SEXUAL" || "VIOLENCE" || "HATE" || "INSULTS" || "MISCONDUCT" || "PROMPT_ATTACK", // required
65
+ * // inputStrength: "NONE" || "LOW" || "MEDIUM" || "HIGH", // required
66
+ * // outputStrength: "NONE" || "LOW" || "MEDIUM" || "HIGH", // required
67
+ * // },
68
+ * // ],
69
+ * // },
70
+ * // wordPolicy: { // GuardrailWordPolicy
71
+ * // words: [ // GuardrailWords
72
+ * // { // GuardrailWord
73
+ * // text: "STRING_VALUE", // required
74
+ * // },
75
+ * // ],
76
+ * // managedWordLists: [ // GuardrailManagedWordLists
77
+ * // { // GuardrailManagedWords
78
+ * // type: "PROFANITY", // required
79
+ * // },
80
+ * // ],
81
+ * // },
82
+ * // sensitiveInformationPolicy: { // GuardrailSensitiveInformationPolicy
83
+ * // piiEntities: [ // GuardrailPiiEntities
84
+ * // { // GuardrailPiiEntity
85
+ * // type: "ADDRESS" || "AGE" || "AWS_ACCESS_KEY" || "AWS_SECRET_KEY" || "CA_HEALTH_NUMBER" || "CA_SOCIAL_INSURANCE_NUMBER" || "CREDIT_DEBIT_CARD_CVV" || "CREDIT_DEBIT_CARD_EXPIRY" || "CREDIT_DEBIT_CARD_NUMBER" || "DRIVER_ID" || "EMAIL" || "INTERNATIONAL_BANK_ACCOUNT_NUMBER" || "IP_ADDRESS" || "LICENSE_PLATE" || "MAC_ADDRESS" || "NAME" || "PASSWORD" || "PHONE" || "PIN" || "SWIFT_CODE" || "UK_NATIONAL_HEALTH_SERVICE_NUMBER" || "UK_NATIONAL_INSURANCE_NUMBER" || "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER" || "URL" || "USERNAME" || "US_BANK_ACCOUNT_NUMBER" || "US_BANK_ROUTING_NUMBER" || "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER" || "US_PASSPORT_NUMBER" || "US_SOCIAL_SECURITY_NUMBER" || "VEHICLE_IDENTIFICATION_NUMBER", // required
86
+ * // action: "BLOCK" || "ANONYMIZE", // required
87
+ * // },
88
+ * // ],
89
+ * // regexes: [ // GuardrailRegexes
90
+ * // { // GuardrailRegex
91
+ * // name: "STRING_VALUE", // required
92
+ * // description: "STRING_VALUE",
93
+ * // pattern: "STRING_VALUE", // required
94
+ * // action: "BLOCK" || "ANONYMIZE", // required
95
+ * // },
96
+ * // ],
97
+ * // },
98
+ * // createdAt: new Date("TIMESTAMP"), // required
99
+ * // updatedAt: new Date("TIMESTAMP"), // required
100
+ * // statusReasons: [ // GuardrailStatusReasons
101
+ * // "STRING_VALUE",
102
+ * // ],
103
+ * // failureRecommendations: [ // GuardrailFailureRecommendations
104
+ * // "STRING_VALUE",
105
+ * // ],
106
+ * // blockedInputMessaging: "STRING_VALUE", // required
107
+ * // blockedOutputsMessaging: "STRING_VALUE", // required
108
+ * // kmsKeyArn: "STRING_VALUE",
109
+ * // };
110
+ *
111
+ * ```
112
+ *
113
+ * @param GetGuardrailCommandInput - {@link GetGuardrailCommandInput}
114
+ * @returns {@link GetGuardrailCommandOutput}
115
+ * @see {@link GetGuardrailCommandInput} for command's `input` shape.
116
+ * @see {@link GetGuardrailCommandOutput} for command's `response` shape.
117
+ * @see {@link BedrockClientResolvedConfig | config} for BedrockClient's `config` shape.
118
+ *
119
+ * @throws {@link AccessDeniedException} (client fault)
120
+ * <p>The request is denied because of missing access permissions.</p>
121
+ *
122
+ * @throws {@link InternalServerException} (server fault)
123
+ * <p>An internal server error occurred. Retry your request.</p>
124
+ *
125
+ * @throws {@link ResourceNotFoundException} (client fault)
126
+ * <p>The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.</p>
127
+ *
128
+ * @throws {@link ThrottlingException} (client fault)
129
+ * <p>The number of requests exceeds the limit. Resubmit your request later.</p>
130
+ *
131
+ * @throws {@link ValidationException} (client fault)
132
+ * <p>Input validation failed. Check your request parameters and retry the request.</p>
133
+ *
134
+ * @throws {@link BedrockServiceException}
135
+ * <p>Base exception class for all service exceptions from Bedrock service.</p>
136
+ *
137
+ * @public
138
+ */
139
+ export declare class GetGuardrailCommand extends GetGuardrailCommand_base {
140
+ }
@@ -27,7 +27,7 @@ declare const GetModelCustomizationJobCommand_base: {
27
27
  };
28
28
  /**
29
29
  * <p>Retrieves the properties associated with a model-customization job, including the status of the job.
30
- * For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models.html">Custom models</a> in the Bedrock User Guide.</p>
30
+ * For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models.html">Custom models</a> in the Amazon Bedrock User Guide.</p>
31
31
  * @example
32
32
  * Use a bare-bones client and the command you need to make an API call.
33
33
  * ```javascript
@@ -103,7 +103,7 @@ declare const GetModelCustomizationJobCommand_base: {
103
103
  * <p>An internal server error occurred. Retry your request.</p>
104
104
  *
105
105
  * @throws {@link ResourceNotFoundException} (client fault)
106
- * <p>The specified resource ARN was not found. Check the ARN and try your request again.</p>
106
+ * <p>The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.</p>
107
107
  *
108
108
  * @throws {@link ThrottlingException} (client fault)
109
109
  * <p>The number of requests exceeds the limit. Resubmit your request later.</p>
@@ -26,7 +26,7 @@ declare const GetProvisionedModelThroughputCommand_base: {
26
26
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
27
27
  };
28
28
  /**
29
- * <p>Get details for a provisioned throughput. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html">Provisioned throughput</a> in the Bedrock User Guide.</p>
29
+ * <p>Returns details for a Provisioned Throughput. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prov-throughput.html">Provisioned Throughput</a> in the Amazon Bedrock User Guide.</p>
30
30
  * @example
31
31
  * Use a bare-bones client and the command you need to make an API call.
32
32
  * ```javascript
@@ -69,7 +69,7 @@ declare const GetProvisionedModelThroughputCommand_base: {
69
69
  * <p>An internal server error occurred. Retry your request.</p>
70
70
  *
71
71
  * @throws {@link ResourceNotFoundException} (client fault)
72
- * <p>The specified resource ARN was not found. Check the ARN and try your request again.</p>
72
+ * <p>The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.</p>
73
73
  *
74
74
  * @throws {@link ThrottlingException} (client fault)
75
75
  * <p>The number of requests exceeds the limit. Resubmit your request later.</p>
@@ -27,7 +27,7 @@ declare const ListCustomModelsCommand_base: {
27
27
  };
28
28
  /**
29
29
  * <p>Returns a list of the custom models that you have created with the <code>CreateModelCustomizationJob</code> operation.</p>
30
- * <p>For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models.html">Custom models</a> in the Bedrock User Guide.</p>
30
+ * <p>For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models.html">Custom models</a> in the Amazon Bedrock User Guide.</p>
31
31
  * @example
32
32
  * Use a bare-bones client and the command you need to make an API call.
33
33
  * ```javascript
@@ -0,0 +1,93 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { BedrockClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BedrockClient";
4
+ import { ListEvaluationJobsRequest, ListEvaluationJobsResponse } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export { __MetadataBearer, $Command };
9
+ /**
10
+ * @public
11
+ *
12
+ * The input for {@link ListEvaluationJobsCommand}.
13
+ */
14
+ export interface ListEvaluationJobsCommandInput extends ListEvaluationJobsRequest {
15
+ }
16
+ /**
17
+ * @public
18
+ *
19
+ * The output of {@link ListEvaluationJobsCommand}.
20
+ */
21
+ export interface ListEvaluationJobsCommandOutput extends ListEvaluationJobsResponse, __MetadataBearer {
22
+ }
23
+ declare const ListEvaluationJobsCommand_base: {
24
+ new (input: ListEvaluationJobsCommandInput): import("@smithy/smithy-client").CommandImpl<ListEvaluationJobsCommandInput, ListEvaluationJobsCommandOutput, BedrockClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
25
+ new (...[input]: [] | [ListEvaluationJobsCommandInput]): import("@smithy/smithy-client").CommandImpl<ListEvaluationJobsCommandInput, ListEvaluationJobsCommandOutput, BedrockClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
27
+ };
28
+ /**
29
+ * <p>Lists model evaluation jobs.</p>
30
+ * @example
31
+ * Use a bare-bones client and the command you need to make an API call.
32
+ * ```javascript
33
+ * import { BedrockClient, ListEvaluationJobsCommand } from "@aws-sdk/client-bedrock"; // ES Modules import
34
+ * // const { BedrockClient, ListEvaluationJobsCommand } = require("@aws-sdk/client-bedrock"); // CommonJS import
35
+ * const client = new BedrockClient(config);
36
+ * const input = { // ListEvaluationJobsRequest
37
+ * creationTimeAfter: new Date("TIMESTAMP"),
38
+ * creationTimeBefore: new Date("TIMESTAMP"),
39
+ * statusEquals: "InProgress" || "Completed" || "Failed" || "Stopping" || "Stopped",
40
+ * nameContains: "STRING_VALUE",
41
+ * maxResults: Number("int"),
42
+ * nextToken: "STRING_VALUE",
43
+ * sortBy: "CreationTime",
44
+ * sortOrder: "Ascending" || "Descending",
45
+ * };
46
+ * const command = new ListEvaluationJobsCommand(input);
47
+ * const response = await client.send(command);
48
+ * // { // ListEvaluationJobsResponse
49
+ * // nextToken: "STRING_VALUE",
50
+ * // jobSummaries: [ // EvaluationSummaries
51
+ * // { // EvaluationSummary
52
+ * // jobArn: "STRING_VALUE", // required
53
+ * // jobName: "STRING_VALUE", // required
54
+ * // status: "InProgress" || "Completed" || "Failed" || "Stopping" || "Stopped", // required
55
+ * // creationTime: new Date("TIMESTAMP"), // required
56
+ * // jobType: "Human" || "Automated", // required
57
+ * // evaluationTaskTypes: [ // EvaluationTaskTypes // required
58
+ * // "Summarization" || "Classification" || "QuestionAndAnswer" || "Generation" || "Custom",
59
+ * // ],
60
+ * // modelIdentifiers: [ // EvaluationModelIdentifiers // required
61
+ * // "STRING_VALUE",
62
+ * // ],
63
+ * // },
64
+ * // ],
65
+ * // };
66
+ *
67
+ * ```
68
+ *
69
+ * @param ListEvaluationJobsCommandInput - {@link ListEvaluationJobsCommandInput}
70
+ * @returns {@link ListEvaluationJobsCommandOutput}
71
+ * @see {@link ListEvaluationJobsCommandInput} for command's `input` shape.
72
+ * @see {@link ListEvaluationJobsCommandOutput} for command's `response` shape.
73
+ * @see {@link BedrockClientResolvedConfig | config} for BedrockClient's `config` shape.
74
+ *
75
+ * @throws {@link AccessDeniedException} (client fault)
76
+ * <p>The request is denied because of missing access permissions.</p>
77
+ *
78
+ * @throws {@link InternalServerException} (server fault)
79
+ * <p>An internal server error occurred. Retry your request.</p>
80
+ *
81
+ * @throws {@link ThrottlingException} (client fault)
82
+ * <p>The number of requests exceeds the limit. Resubmit your request later.</p>
83
+ *
84
+ * @throws {@link ValidationException} (client fault)
85
+ * <p>Input validation failed. Check your request parameters and retry the request.</p>
86
+ *
87
+ * @throws {@link BedrockServiceException}
88
+ * <p>Base exception class for all service exceptions from Bedrock service.</p>
89
+ *
90
+ * @public
91
+ */
92
+ export declare class ListEvaluationJobsCommand extends ListEvaluationJobsCommand_base {
93
+ }
@@ -26,7 +26,7 @@ declare const ListFoundationModelsCommand_base: {
26
26
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
27
27
  };
28
28
  /**
29
- * <p>List of Amazon Bedrock foundation models that you can use. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/foundation-models.html">Foundation models</a> in the Bedrock User Guide.</p>
29
+ * <p>Lists Amazon Bedrock foundation models that you can use. You can filter the results with the request parameters. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/foundation-models.html">Foundation models</a> in the Amazon Bedrock User Guide.</p>
30
30
  * @example
31
31
  * Use a bare-bones client and the command you need to make an API call.
32
32
  * ```javascript
@@ -0,0 +1,89 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { BedrockClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BedrockClient";
4
+ import { ListGuardrailsRequest, ListGuardrailsResponse } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export { __MetadataBearer, $Command };
9
+ /**
10
+ * @public
11
+ *
12
+ * The input for {@link ListGuardrailsCommand}.
13
+ */
14
+ export interface ListGuardrailsCommandInput extends ListGuardrailsRequest {
15
+ }
16
+ /**
17
+ * @public
18
+ *
19
+ * The output of {@link ListGuardrailsCommand}.
20
+ */
21
+ export interface ListGuardrailsCommandOutput extends ListGuardrailsResponse, __MetadataBearer {
22
+ }
23
+ declare const ListGuardrailsCommand_base: {
24
+ new (input: ListGuardrailsCommandInput): import("@smithy/smithy-client").CommandImpl<ListGuardrailsCommandInput, ListGuardrailsCommandOutput, BedrockClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
25
+ new (...[input]: [] | [ListGuardrailsCommandInput]): import("@smithy/smithy-client").CommandImpl<ListGuardrailsCommandInput, ListGuardrailsCommandOutput, BedrockClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
27
+ };
28
+ /**
29
+ * <p>Lists details about all the guardrails in an account. To list the <code>DRAFT</code> version of all your guardrails, don't specify the <code>guardrailIdentifier</code> field. To list all versions of a guardrail, specify the ARN of the guardrail in the <code>guardrailIdentifier</code> field.</p>
30
+ * <p>You can set the maximum number of results to return in a response in the <code>maxResults</code> field. If there are more results than the number you set, the response returns a <code>nextToken</code> that you can send in another <code>ListGuardrails</code> request to see the next batch of results.</p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { BedrockClient, ListGuardrailsCommand } from "@aws-sdk/client-bedrock"; // ES Modules import
35
+ * // const { BedrockClient, ListGuardrailsCommand } = require("@aws-sdk/client-bedrock"); // CommonJS import
36
+ * const client = new BedrockClient(config);
37
+ * const input = { // ListGuardrailsRequest
38
+ * guardrailIdentifier: "STRING_VALUE",
39
+ * maxResults: Number("int"),
40
+ * nextToken: "STRING_VALUE",
41
+ * };
42
+ * const command = new ListGuardrailsCommand(input);
43
+ * const response = await client.send(command);
44
+ * // { // ListGuardrailsResponse
45
+ * // guardrails: [ // GuardrailSummaries // required
46
+ * // { // GuardrailSummary
47
+ * // id: "STRING_VALUE", // required
48
+ * // arn: "STRING_VALUE", // required
49
+ * // status: "CREATING" || "UPDATING" || "VERSIONING" || "READY" || "FAILED" || "DELETING", // required
50
+ * // name: "STRING_VALUE", // required
51
+ * // description: "STRING_VALUE",
52
+ * // version: "STRING_VALUE", // required
53
+ * // createdAt: new Date("TIMESTAMP"), // required
54
+ * // updatedAt: new Date("TIMESTAMP"), // required
55
+ * // },
56
+ * // ],
57
+ * // nextToken: "STRING_VALUE",
58
+ * // };
59
+ *
60
+ * ```
61
+ *
62
+ * @param ListGuardrailsCommandInput - {@link ListGuardrailsCommandInput}
63
+ * @returns {@link ListGuardrailsCommandOutput}
64
+ * @see {@link ListGuardrailsCommandInput} for command's `input` shape.
65
+ * @see {@link ListGuardrailsCommandOutput} for command's `response` shape.
66
+ * @see {@link BedrockClientResolvedConfig | config} for BedrockClient's `config` shape.
67
+ *
68
+ * @throws {@link AccessDeniedException} (client fault)
69
+ * <p>The request is denied because of missing access permissions.</p>
70
+ *
71
+ * @throws {@link InternalServerException} (server fault)
72
+ * <p>An internal server error occurred. Retry your request.</p>
73
+ *
74
+ * @throws {@link ResourceNotFoundException} (client fault)
75
+ * <p>The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.</p>
76
+ *
77
+ * @throws {@link ThrottlingException} (client fault)
78
+ * <p>The number of requests exceeds the limit. Resubmit your request later.</p>
79
+ *
80
+ * @throws {@link ValidationException} (client fault)
81
+ * <p>Input validation failed. Check your request parameters and retry the request.</p>
82
+ *
83
+ * @throws {@link BedrockServiceException}
84
+ * <p>Base exception class for all service exceptions from Bedrock service.</p>
85
+ *
86
+ * @public
87
+ */
88
+ export declare class ListGuardrailsCommand extends ListGuardrailsCommand_base {
89
+ }
@@ -27,8 +27,8 @@ declare const ListModelCustomizationJobsCommand_base: {
27
27
  };
28
28
  /**
29
29
  * <p>Returns a list of model customization jobs that you have submitted. You can filter the jobs to return based on
30
- * one or more criteria.</p>
31
- * <p>For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models.html">Custom models</a> in the Bedrock User Guide.</p>
30
+ * one or more criteria.</p>
31
+ * <p>For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models.html">Custom models</a> in the Amazon Bedrock User Guide.</p>
32
32
  * @example
33
33
  * Use a bare-bones client and the command you need to make an API call.
34
34
  * ```javascript
@@ -26,7 +26,7 @@ declare const ListProvisionedModelThroughputsCommand_base: {
26
26
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
27
27
  };
28
28
  /**
29
- * <p>List the provisioned capacities. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html">Provisioned throughput</a> in the Bedrock User Guide.</p>
29
+ * <p>Lists the Provisioned Throughputs in the account. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prov-throughput.html">Provisioned Throughput</a> in the Amazon Bedrock User Guide.</p>
30
30
  * @example
31
31
  * Use a bare-bones client and the command you need to make an API call.
32
32
  * ```javascript
@@ -27,7 +27,7 @@ declare const ListTagsForResourceCommand_base: {
27
27
  };
28
28
  /**
29
29
  * <p>List the tags associated with the specified resource.</p>
30
- * <p>For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html">Tagging resources</a> in the Bedrock User Guide.</p>
30
+ * <p>For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/tagging.html">Tagging resources</a> in the Amazon Bedrock User Guide.</p>
31
31
  * @example
32
32
  * Use a bare-bones client and the command you need to make an API call.
33
33
  * ```javascript
@@ -63,7 +63,7 @@ declare const ListTagsForResourceCommand_base: {
63
63
  * <p>An internal server error occurred. Retry your request.</p>
64
64
  *
65
65
  * @throws {@link ResourceNotFoundException} (client fault)
66
- * <p>The specified resource ARN was not found. Check the ARN and try your request again.</p>
66
+ * <p>The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.</p>
67
67
  *
68
68
  * @throws {@link ThrottlingException} (client fault)
69
69
  * <p>The number of requests exceeds the limit. Resubmit your request later.</p>