@aws-sdk/client-bedrock 3.859.0 → 3.861.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 (192) hide show
  1. package/README.md +192 -0
  2. package/dist-cjs/index.js +2684 -369
  3. package/dist-es/Bedrock.js +48 -0
  4. package/dist-es/commands/CancelAutomatedReasoningPolicyBuildWorkflowCommand.js +22 -0
  5. package/dist-es/commands/CreateAutomatedReasoningPolicyCommand.js +23 -0
  6. package/dist-es/commands/CreateAutomatedReasoningPolicyTestCaseCommand.js +23 -0
  7. package/dist-es/commands/CreateAutomatedReasoningPolicyVersionCommand.js +23 -0
  8. package/dist-es/commands/CreateGuardrailCommand.js +1 -1
  9. package/dist-es/commands/CreateGuardrailVersionCommand.js +1 -1
  10. package/dist-es/commands/CreateInferenceProfileCommand.js +1 -1
  11. package/dist-es/commands/CreatePromptRouterCommand.js +1 -1
  12. package/dist-es/commands/DeleteAutomatedReasoningPolicyBuildWorkflowCommand.js +22 -0
  13. package/dist-es/commands/DeleteAutomatedReasoningPolicyCommand.js +22 -0
  14. package/dist-es/commands/DeleteAutomatedReasoningPolicyTestCaseCommand.js +22 -0
  15. package/dist-es/commands/ExportAutomatedReasoningPolicyVersionCommand.js +23 -0
  16. package/dist-es/commands/GetAutomatedReasoningPolicyAnnotationsCommand.js +23 -0
  17. package/dist-es/commands/GetAutomatedReasoningPolicyBuildWorkflowCommand.js +23 -0
  18. package/dist-es/commands/GetAutomatedReasoningPolicyBuildWorkflowResultAssetsCommand.js +23 -0
  19. package/dist-es/commands/GetAutomatedReasoningPolicyCommand.js +23 -0
  20. package/dist-es/commands/GetAutomatedReasoningPolicyNextScenarioCommand.js +23 -0
  21. package/dist-es/commands/GetAutomatedReasoningPolicyTestCaseCommand.js +23 -0
  22. package/dist-es/commands/GetAutomatedReasoningPolicyTestResultCommand.js +23 -0
  23. package/dist-es/commands/GetGuardrailCommand.js +1 -1
  24. package/dist-es/commands/GetInferenceProfileCommand.js +1 -1
  25. package/dist-es/commands/GetModelInvocationJobCommand.js +1 -1
  26. package/dist-es/commands/GetPromptRouterCommand.js +1 -1
  27. package/dist-es/commands/ListAutomatedReasoningPoliciesCommand.js +23 -0
  28. package/dist-es/commands/ListAutomatedReasoningPolicyBuildWorkflowsCommand.js +22 -0
  29. package/dist-es/commands/ListAutomatedReasoningPolicyTestCasesCommand.js +23 -0
  30. package/dist-es/commands/ListAutomatedReasoningPolicyTestResultsCommand.js +23 -0
  31. package/dist-es/commands/ListGuardrailsCommand.js +1 -1
  32. package/dist-es/commands/ListInferenceProfilesCommand.js +1 -1
  33. package/dist-es/commands/ListModelInvocationJobsCommand.js +1 -1
  34. package/dist-es/commands/ListPromptRoutersCommand.js +1 -1
  35. package/dist-es/commands/StartAutomatedReasoningPolicyBuildWorkflowCommand.js +23 -0
  36. package/dist-es/commands/StartAutomatedReasoningPolicyTestWorkflowCommand.js +22 -0
  37. package/dist-es/commands/UpdateAutomatedReasoningPolicyAnnotationsCommand.js +23 -0
  38. package/dist-es/commands/UpdateAutomatedReasoningPolicyCommand.js +23 -0
  39. package/dist-es/commands/UpdateAutomatedReasoningPolicyTestCaseCommand.js +23 -0
  40. package/dist-es/commands/UpdateGuardrailCommand.js +1 -1
  41. package/dist-es/commands/index.js +24 -0
  42. package/dist-es/models/models_0.js +742 -315
  43. package/dist-es/models/models_1.js +300 -1
  44. package/dist-es/pagination/ListAutomatedReasoningPoliciesPaginator.js +4 -0
  45. package/dist-es/pagination/ListAutomatedReasoningPolicyBuildWorkflowsPaginator.js +4 -0
  46. package/dist-es/pagination/ListAutomatedReasoningPolicyTestCasesPaginator.js +4 -0
  47. package/dist-es/pagination/ListAutomatedReasoningPolicyTestResultsPaginator.js +4 -0
  48. package/dist-es/pagination/index.js +4 -0
  49. package/dist-es/protocols/Aws_restJson1.js +997 -31
  50. package/dist-types/Bedrock.d.ts +169 -0
  51. package/dist-types/BedrockClient.d.ts +26 -2
  52. package/dist-types/commands/CancelAutomatedReasoningPolicyBuildWorkflowCommand.d.ts +86 -0
  53. package/dist-types/commands/CreateAutomatedReasoningPolicyCommand.d.ts +139 -0
  54. package/dist-types/commands/CreateAutomatedReasoningPolicyTestCaseCommand.d.ts +99 -0
  55. package/dist-types/commands/CreateAutomatedReasoningPolicyVersionCommand.d.ts +106 -0
  56. package/dist-types/commands/CreateGuardrailCommand.d.ts +7 -1
  57. package/dist-types/commands/CreateGuardrailVersionCommand.d.ts +1 -1
  58. package/dist-types/commands/CreateInferenceProfileCommand.d.ts +1 -1
  59. package/dist-types/commands/CreateModelCopyJobCommand.d.ts +1 -1
  60. package/dist-types/commands/CreateModelImportJobCommand.d.ts +1 -1
  61. package/dist-types/commands/CreateModelInvocationJobCommand.d.ts +1 -1
  62. package/dist-types/commands/CreatePromptRouterCommand.d.ts +1 -1
  63. package/dist-types/commands/CreateProvisionedModelThroughputCommand.d.ts +1 -1
  64. package/dist-types/commands/DeleteAutomatedReasoningPolicyBuildWorkflowCommand.d.ts +90 -0
  65. package/dist-types/commands/DeleteAutomatedReasoningPolicyCommand.d.ts +85 -0
  66. package/dist-types/commands/DeleteAutomatedReasoningPolicyTestCaseCommand.d.ts +93 -0
  67. package/dist-types/commands/DeleteGuardrailCommand.d.ts +1 -1
  68. package/dist-types/commands/DeleteImportedModelCommand.d.ts +1 -1
  69. package/dist-types/commands/DeleteInferenceProfileCommand.d.ts +1 -1
  70. package/dist-types/commands/DeleteModelInvocationLoggingConfigurationCommand.d.ts +1 -1
  71. package/dist-types/commands/DeletePromptRouterCommand.d.ts +1 -1
  72. package/dist-types/commands/DeleteProvisionedModelThroughputCommand.d.ts +1 -1
  73. package/dist-types/commands/ExportAutomatedReasoningPolicyVersionCommand.d.ts +115 -0
  74. package/dist-types/commands/GetAutomatedReasoningPolicyAnnotationsCommand.d.ts +172 -0
  75. package/dist-types/commands/GetAutomatedReasoningPolicyBuildWorkflowCommand.d.ts +96 -0
  76. package/dist-types/commands/GetAutomatedReasoningPolicyBuildWorkflowResultAssetsCommand.d.ts +307 -0
  77. package/dist-types/commands/GetAutomatedReasoningPolicyCommand.d.ts +94 -0
  78. package/dist-types/commands/GetAutomatedReasoningPolicyNextScenarioCommand.d.ts +96 -0
  79. package/dist-types/commands/GetAutomatedReasoningPolicyTestCaseCommand.d.ts +97 -0
  80. package/dist-types/commands/GetAutomatedReasoningPolicyTestResultCommand.d.ts +258 -0
  81. package/dist-types/commands/GetFoundationModelCommand.d.ts +1 -1
  82. package/dist-types/commands/GetGuardrailCommand.d.ts +7 -1
  83. package/dist-types/commands/GetImportedModelCommand.d.ts +1 -1
  84. package/dist-types/commands/GetInferenceProfileCommand.d.ts +1 -1
  85. package/dist-types/commands/GetModelCopyJobCommand.d.ts +1 -1
  86. package/dist-types/commands/GetModelImportJobCommand.d.ts +1 -1
  87. package/dist-types/commands/GetModelInvocationJobCommand.d.ts +1 -1
  88. package/dist-types/commands/GetModelInvocationLoggingConfigurationCommand.d.ts +1 -1
  89. package/dist-types/commands/GetPromptRouterCommand.d.ts +1 -1
  90. package/dist-types/commands/GetProvisionedModelThroughputCommand.d.ts +1 -1
  91. package/dist-types/commands/ListAutomatedReasoningPoliciesCommand.d.ts +100 -0
  92. package/dist-types/commands/ListAutomatedReasoningPolicyBuildWorkflowsCommand.d.ts +99 -0
  93. package/dist-types/commands/ListAutomatedReasoningPolicyTestCasesCommand.d.ts +100 -0
  94. package/dist-types/commands/ListAutomatedReasoningPolicyTestResultsCommand.d.ts +265 -0
  95. package/dist-types/commands/ListFoundationModelsCommand.d.ts +1 -1
  96. package/dist-types/commands/ListGuardrailsCommand.d.ts +1 -1
  97. package/dist-types/commands/ListImportedModelsCommand.d.ts +1 -1
  98. package/dist-types/commands/ListInferenceProfilesCommand.d.ts +1 -1
  99. package/dist-types/commands/ListModelCopyJobsCommand.d.ts +1 -1
  100. package/dist-types/commands/ListModelImportJobsCommand.d.ts +1 -1
  101. package/dist-types/commands/ListModelInvocationJobsCommand.d.ts +1 -1
  102. package/dist-types/commands/ListPromptRoutersCommand.d.ts +1 -1
  103. package/dist-types/commands/ListProvisionedModelThroughputsCommand.d.ts +1 -2
  104. package/dist-types/commands/PutModelInvocationLoggingConfigurationCommand.d.ts +1 -1
  105. package/dist-types/commands/StartAutomatedReasoningPolicyBuildWorkflowCommand.d.ts +222 -0
  106. package/dist-types/commands/StartAutomatedReasoningPolicyTestWorkflowCommand.d.ts +95 -0
  107. package/dist-types/commands/StopModelInvocationJobCommand.d.ts +1 -1
  108. package/dist-types/commands/UpdateAutomatedReasoningPolicyAnnotationsCommand.d.ts +175 -0
  109. package/dist-types/commands/UpdateAutomatedReasoningPolicyCommand.d.ts +127 -0
  110. package/dist-types/commands/UpdateAutomatedReasoningPolicyTestCaseCommand.d.ts +102 -0
  111. package/dist-types/commands/UpdateGuardrailCommand.d.ts +7 -1
  112. package/dist-types/commands/index.d.ts +24 -0
  113. package/dist-types/models/models_0.d.ts +3899 -3774
  114. package/dist-types/models/models_1.d.ts +3320 -1
  115. package/dist-types/pagination/ListAutomatedReasoningPoliciesPaginator.d.ts +7 -0
  116. package/dist-types/pagination/ListAutomatedReasoningPolicyBuildWorkflowsPaginator.d.ts +7 -0
  117. package/dist-types/pagination/ListAutomatedReasoningPolicyTestCasesPaginator.d.ts +7 -0
  118. package/dist-types/pagination/ListAutomatedReasoningPolicyTestResultsPaginator.d.ts +7 -0
  119. package/dist-types/pagination/index.d.ts +4 -0
  120. package/dist-types/protocols/Aws_restJson1.d.ts +216 -0
  121. package/dist-types/ts3.4/Bedrock.d.ts +523 -0
  122. package/dist-types/ts3.4/BedrockClient.d.ts +144 -0
  123. package/dist-types/ts3.4/commands/CancelAutomatedReasoningPolicyBuildWorkflowCommand.d.ts +51 -0
  124. package/dist-types/ts3.4/commands/CreateAutomatedReasoningPolicyCommand.d.ts +51 -0
  125. package/dist-types/ts3.4/commands/CreateAutomatedReasoningPolicyTestCaseCommand.d.ts +51 -0
  126. package/dist-types/ts3.4/commands/CreateAutomatedReasoningPolicyVersionCommand.d.ts +51 -0
  127. package/dist-types/ts3.4/commands/CreateGuardrailCommand.d.ts +1 -1
  128. package/dist-types/ts3.4/commands/CreateGuardrailVersionCommand.d.ts +1 -1
  129. package/dist-types/ts3.4/commands/CreateInferenceProfileCommand.d.ts +1 -1
  130. package/dist-types/ts3.4/commands/CreateModelCopyJobCommand.d.ts +1 -1
  131. package/dist-types/ts3.4/commands/CreateModelImportJobCommand.d.ts +1 -1
  132. package/dist-types/ts3.4/commands/CreateModelInvocationJobCommand.d.ts +1 -1
  133. package/dist-types/ts3.4/commands/CreatePromptRouterCommand.d.ts +1 -1
  134. package/dist-types/ts3.4/commands/CreateProvisionedModelThroughputCommand.d.ts +1 -1
  135. package/dist-types/ts3.4/commands/DeleteAutomatedReasoningPolicyBuildWorkflowCommand.d.ts +51 -0
  136. package/dist-types/ts3.4/commands/DeleteAutomatedReasoningPolicyCommand.d.ts +51 -0
  137. package/dist-types/ts3.4/commands/DeleteAutomatedReasoningPolicyTestCaseCommand.d.ts +51 -0
  138. package/dist-types/ts3.4/commands/DeleteGuardrailCommand.d.ts +1 -1
  139. package/dist-types/ts3.4/commands/DeleteImportedModelCommand.d.ts +1 -1
  140. package/dist-types/ts3.4/commands/DeleteInferenceProfileCommand.d.ts +1 -1
  141. package/dist-types/ts3.4/commands/DeleteModelInvocationLoggingConfigurationCommand.d.ts +1 -1
  142. package/dist-types/ts3.4/commands/DeletePromptRouterCommand.d.ts +1 -1
  143. package/dist-types/ts3.4/commands/DeleteProvisionedModelThroughputCommand.d.ts +1 -1
  144. package/dist-types/ts3.4/commands/ExportAutomatedReasoningPolicyVersionCommand.d.ts +51 -0
  145. package/dist-types/ts3.4/commands/GetAutomatedReasoningPolicyAnnotationsCommand.d.ts +51 -0
  146. package/dist-types/ts3.4/commands/GetAutomatedReasoningPolicyBuildWorkflowCommand.d.ts +51 -0
  147. package/dist-types/ts3.4/commands/GetAutomatedReasoningPolicyBuildWorkflowResultAssetsCommand.d.ts +51 -0
  148. package/dist-types/ts3.4/commands/GetAutomatedReasoningPolicyCommand.d.ts +51 -0
  149. package/dist-types/ts3.4/commands/GetAutomatedReasoningPolicyNextScenarioCommand.d.ts +51 -0
  150. package/dist-types/ts3.4/commands/GetAutomatedReasoningPolicyTestCaseCommand.d.ts +51 -0
  151. package/dist-types/ts3.4/commands/GetAutomatedReasoningPolicyTestResultCommand.d.ts +51 -0
  152. package/dist-types/ts3.4/commands/GetFoundationModelCommand.d.ts +1 -1
  153. package/dist-types/ts3.4/commands/GetGuardrailCommand.d.ts +1 -1
  154. package/dist-types/ts3.4/commands/GetImportedModelCommand.d.ts +1 -1
  155. package/dist-types/ts3.4/commands/GetInferenceProfileCommand.d.ts +1 -1
  156. package/dist-types/ts3.4/commands/GetModelCopyJobCommand.d.ts +1 -1
  157. package/dist-types/ts3.4/commands/GetModelImportJobCommand.d.ts +1 -1
  158. package/dist-types/ts3.4/commands/GetModelInvocationJobCommand.d.ts +1 -1
  159. package/dist-types/ts3.4/commands/GetModelInvocationLoggingConfigurationCommand.d.ts +1 -1
  160. package/dist-types/ts3.4/commands/GetPromptRouterCommand.d.ts +1 -1
  161. package/dist-types/ts3.4/commands/GetProvisionedModelThroughputCommand.d.ts +1 -1
  162. package/dist-types/ts3.4/commands/ListAutomatedReasoningPoliciesCommand.d.ts +51 -0
  163. package/dist-types/ts3.4/commands/ListAutomatedReasoningPolicyBuildWorkflowsCommand.d.ts +51 -0
  164. package/dist-types/ts3.4/commands/ListAutomatedReasoningPolicyTestCasesCommand.d.ts +51 -0
  165. package/dist-types/ts3.4/commands/ListAutomatedReasoningPolicyTestResultsCommand.d.ts +51 -0
  166. package/dist-types/ts3.4/commands/ListFoundationModelsCommand.d.ts +1 -1
  167. package/dist-types/ts3.4/commands/ListGuardrailsCommand.d.ts +1 -1
  168. package/dist-types/ts3.4/commands/ListImportedModelsCommand.d.ts +1 -1
  169. package/dist-types/ts3.4/commands/ListInferenceProfilesCommand.d.ts +1 -1
  170. package/dist-types/ts3.4/commands/ListModelCopyJobsCommand.d.ts +1 -1
  171. package/dist-types/ts3.4/commands/ListModelImportJobsCommand.d.ts +1 -1
  172. package/dist-types/ts3.4/commands/ListModelInvocationJobsCommand.d.ts +1 -1
  173. package/dist-types/ts3.4/commands/ListPromptRoutersCommand.d.ts +1 -1
  174. package/dist-types/ts3.4/commands/ListProvisionedModelThroughputsCommand.d.ts +4 -2
  175. package/dist-types/ts3.4/commands/PutModelInvocationLoggingConfigurationCommand.d.ts +1 -1
  176. package/dist-types/ts3.4/commands/StartAutomatedReasoningPolicyBuildWorkflowCommand.d.ts +51 -0
  177. package/dist-types/ts3.4/commands/StartAutomatedReasoningPolicyTestWorkflowCommand.d.ts +51 -0
  178. package/dist-types/ts3.4/commands/StopModelInvocationJobCommand.d.ts +1 -1
  179. package/dist-types/ts3.4/commands/UpdateAutomatedReasoningPolicyAnnotationsCommand.d.ts +51 -0
  180. package/dist-types/ts3.4/commands/UpdateAutomatedReasoningPolicyCommand.d.ts +51 -0
  181. package/dist-types/ts3.4/commands/UpdateAutomatedReasoningPolicyTestCaseCommand.d.ts +51 -0
  182. package/dist-types/ts3.4/commands/UpdateGuardrailCommand.d.ts +1 -1
  183. package/dist-types/ts3.4/commands/index.d.ts +24 -0
  184. package/dist-types/ts3.4/models/models_0.d.ts +2324 -1702
  185. package/dist-types/ts3.4/models/models_1.d.ts +970 -2
  186. package/dist-types/ts3.4/pagination/ListAutomatedReasoningPoliciesPaginator.d.ts +11 -0
  187. package/dist-types/ts3.4/pagination/ListAutomatedReasoningPolicyBuildWorkflowsPaginator.d.ts +11 -0
  188. package/dist-types/ts3.4/pagination/ListAutomatedReasoningPolicyTestCasesPaginator.d.ts +11 -0
  189. package/dist-types/ts3.4/pagination/ListAutomatedReasoningPolicyTestResultsPaginator.d.ts +11 -0
  190. package/dist-types/ts3.4/pagination/index.d.ts +4 -0
  191. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +288 -0
  192. package/package.json +1 -1
@@ -1,4 +1,3199 @@
1
- import { AgreementAvailability, ApplicationType, CommitmentDuration, CustomizationConfig, CustomizationType, EvaluationConfig, EvaluationJobStatus, EvaluationJobType, EvaluationModelConfig, EvaluationOutputDataConfig, EvaluationPrecomputedRagSourceConfig, ExternalSourcesRetrieveAndGenerateConfiguration, FilterAttribute, GenerationConfiguration, ImplicitFilterConfiguration, OrchestrationConfiguration, OutputDataConfig, ProvisionedModelStatus, RetrieveAndGenerateType, SearchType, SortJobsBy, SortOrder, Tag, TrainingDataConfig, TrainingMetrics, ValidationDataConfig, ValidatorMetric, VectorSearchRerankingConfiguration, VpcConfig } from "./models_0";
1
+ import { AgreementAvailability, ApplicationType, CustomizationConfig, CustomizationType, EvaluationConfig, EvaluationJobStatus, EvaluationJobType, EvaluationModelConfig, EvaluationOutputDataConfig, EvaluationPrecomputedRagSourceConfig, ExternalSourcesRetrieveAndGenerateConfiguration, FilterAttribute, GenerationConfiguration, GuardrailAutomatedReasoningPolicyConfig, GuardrailContentFilterAction, GuardrailContentFiltersTierName, GuardrailContentFilterType, GuardrailContentPolicyConfig, GuardrailContextualGroundingAction, GuardrailContextualGroundingFilterType, GuardrailContextualGroundingPolicyConfig, GuardrailCrossRegionConfig, GuardrailFilterStrength, GuardrailModality, GuardrailPiiEntityType, GuardrailSensitiveInformationAction, GuardrailSensitiveInformationPolicyConfig, GuardrailTopicAction, GuardrailTopicPolicyConfig, GuardrailTopicsTierName, GuardrailTopicType, GuardrailWordAction, ImplicitFilterConfiguration, ModelDataSource, OrchestrationConfiguration, OutputDataConfig, RetrieveAndGenerateType, SearchType, SortJobsBy, SortModelsBy, SortOrder, Tag, TrainingDataConfig, TrainingMetrics, ValidationDataConfig, ValidatorMetric, VectorSearchRerankingConfiguration, VpcConfig } from "./models_0";
2
+ /**
3
+ * @public
4
+ * @enum
5
+ */
6
+ export declare const GuardrailManagedWordsType: {
7
+ readonly PROFANITY: "PROFANITY";
8
+ };
9
+ /**
10
+ * @public
11
+ */
12
+ export type GuardrailManagedWordsType = (typeof GuardrailManagedWordsType)[keyof typeof GuardrailManagedWordsType];
13
+ /**
14
+ * <p>The managed word list to configure for the guardrail.</p>
15
+ * @public
16
+ */
17
+ export interface GuardrailManagedWordsConfig {
18
+ /**
19
+ * <p>The managed word type to configure for the guardrail.</p>
20
+ * @public
21
+ */
22
+ type: GuardrailManagedWordsType | undefined;
23
+ /**
24
+ * <p>Specifies the action to take when harmful content is detected in the input. Supported values include:</p> <ul> <li> <p> <code>BLOCK</code> – Block the content and replace it with blocked messaging.</p> </li> <li> <p> <code>NONE</code> – Take no action but return detection information in the trace response.</p> </li> </ul>
25
+ * @public
26
+ */
27
+ inputAction?: GuardrailWordAction | undefined;
28
+ /**
29
+ * <p>Specifies the action to take when harmful content is detected in the output. Supported values include:</p> <ul> <li> <p> <code>BLOCK</code> – Block the content and replace it with blocked messaging.</p> </li> <li> <p> <code>NONE</code> – Take no action but return detection information in the trace response.</p> </li> </ul>
30
+ * @public
31
+ */
32
+ outputAction?: GuardrailWordAction | undefined;
33
+ /**
34
+ * <p>Specifies whether to enable guardrail evaluation on the input. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.</p>
35
+ * @public
36
+ */
37
+ inputEnabled?: boolean | undefined;
38
+ /**
39
+ * <p>Specifies whether to enable guardrail evaluation on the output. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.</p>
40
+ * @public
41
+ */
42
+ outputEnabled?: boolean | undefined;
43
+ }
44
+ /**
45
+ * <p>A word to configure for the guardrail.</p>
46
+ * @public
47
+ */
48
+ export interface GuardrailWordConfig {
49
+ /**
50
+ * <p>Text of the word configured for the guardrail to block.</p>
51
+ * @public
52
+ */
53
+ text: string | undefined;
54
+ /**
55
+ * <p>Specifies the action to take when harmful content is detected in the input. Supported values include:</p> <ul> <li> <p> <code>BLOCK</code> – Block the content and replace it with blocked messaging.</p> </li> <li> <p> <code>NONE</code> – Take no action but return detection information in the trace response.</p> </li> </ul>
56
+ * @public
57
+ */
58
+ inputAction?: GuardrailWordAction | undefined;
59
+ /**
60
+ * <p>Specifies the action to take when harmful content is detected in the output. Supported values include:</p> <ul> <li> <p> <code>BLOCK</code> – Block the content and replace it with blocked messaging.</p> </li> <li> <p> <code>NONE</code> – Take no action but return detection information in the trace response.</p> </li> </ul>
61
+ * @public
62
+ */
63
+ outputAction?: GuardrailWordAction | undefined;
64
+ /**
65
+ * <p>Specifies whether to enable guardrail evaluation on the intput. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.</p>
66
+ * @public
67
+ */
68
+ inputEnabled?: boolean | undefined;
69
+ /**
70
+ * <p>Specifies whether to enable guardrail evaluation on the output. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.</p>
71
+ * @public
72
+ */
73
+ outputEnabled?: boolean | undefined;
74
+ }
75
+ /**
76
+ * <p>Contains details about the word policy to configured for the guardrail.</p>
77
+ * @public
78
+ */
79
+ export interface GuardrailWordPolicyConfig {
80
+ /**
81
+ * <p>A list of words to configure for the guardrail.</p>
82
+ * @public
83
+ */
84
+ wordsConfig?: GuardrailWordConfig[] | undefined;
85
+ /**
86
+ * <p>A list of managed words to configure for the guardrail.</p>
87
+ * @public
88
+ */
89
+ managedWordListsConfig?: GuardrailManagedWordsConfig[] | undefined;
90
+ }
91
+ /**
92
+ * @public
93
+ */
94
+ export interface CreateGuardrailRequest {
95
+ /**
96
+ * <p>The name to give the guardrail.</p>
97
+ * @public
98
+ */
99
+ name: string | undefined;
100
+ /**
101
+ * <p>A description of the guardrail.</p>
102
+ * @public
103
+ */
104
+ description?: string | undefined;
105
+ /**
106
+ * <p>The topic policies to configure for the guardrail.</p>
107
+ * @public
108
+ */
109
+ topicPolicyConfig?: GuardrailTopicPolicyConfig | undefined;
110
+ /**
111
+ * <p>The content filter policies to configure for the guardrail.</p>
112
+ * @public
113
+ */
114
+ contentPolicyConfig?: GuardrailContentPolicyConfig | undefined;
115
+ /**
116
+ * <p>The word policy you configure for the guardrail.</p>
117
+ * @public
118
+ */
119
+ wordPolicyConfig?: GuardrailWordPolicyConfig | undefined;
120
+ /**
121
+ * <p>The sensitive information policy to configure for the guardrail.</p>
122
+ * @public
123
+ */
124
+ sensitiveInformationPolicyConfig?: GuardrailSensitiveInformationPolicyConfig | undefined;
125
+ /**
126
+ * <p>The contextual grounding policy configuration used to create a guardrail.</p>
127
+ * @public
128
+ */
129
+ contextualGroundingPolicyConfig?: GuardrailContextualGroundingPolicyConfig | undefined;
130
+ /**
131
+ * <p>Optional configuration for integrating Automated Reasoning policies with the new guardrail.</p>
132
+ * @public
133
+ */
134
+ automatedReasoningPolicyConfig?: GuardrailAutomatedReasoningPolicyConfig | undefined;
135
+ /**
136
+ * <p>The system-defined guardrail profile that you're using with your guardrail. Guardrail profiles define the destination Amazon Web Services Regions where guardrail inference requests can be automatically routed.</p> <p>For more information, see the <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-cross-region.html">Amazon Bedrock User Guide</a>.</p>
137
+ * @public
138
+ */
139
+ crossRegionConfig?: GuardrailCrossRegionConfig | undefined;
140
+ /**
141
+ * <p>The message to return when the guardrail blocks a prompt.</p>
142
+ * @public
143
+ */
144
+ blockedInputMessaging: string | undefined;
145
+ /**
146
+ * <p>The message to return when the guardrail blocks a model response.</p>
147
+ * @public
148
+ */
149
+ blockedOutputsMessaging: string | undefined;
150
+ /**
151
+ * <p>The ARN of the KMS key that you use to encrypt the guardrail.</p>
152
+ * @public
153
+ */
154
+ kmsKeyId?: string | undefined;
155
+ /**
156
+ * <p>The tags that you want to attach to the guardrail. </p>
157
+ * @public
158
+ */
159
+ tags?: Tag[] | undefined;
160
+ /**
161
+ * <p>A unique, case-sensitive identifier to ensure that the API request completes no more than once. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a> in the <i>Amazon S3 User Guide</i>.</p>
162
+ * @public
163
+ */
164
+ clientRequestToken?: string | undefined;
165
+ }
166
+ /**
167
+ * @public
168
+ */
169
+ export interface CreateGuardrailResponse {
170
+ /**
171
+ * <p>The unique identifier of the guardrail that was created.</p>
172
+ * @public
173
+ */
174
+ guardrailId: string | undefined;
175
+ /**
176
+ * <p>The ARN of the guardrail.</p>
177
+ * @public
178
+ */
179
+ guardrailArn: string | undefined;
180
+ /**
181
+ * <p>The version of the guardrail that was created. This value will always be <code>DRAFT</code>.</p>
182
+ * @public
183
+ */
184
+ version: string | undefined;
185
+ /**
186
+ * <p>The time at which the guardrail was created.</p>
187
+ * @public
188
+ */
189
+ createdAt: Date | undefined;
190
+ }
191
+ /**
192
+ * @public
193
+ */
194
+ export interface CreateGuardrailVersionRequest {
195
+ /**
196
+ * <p>The unique identifier of the guardrail. This can be an ID or the ARN.</p>
197
+ * @public
198
+ */
199
+ guardrailIdentifier: string | undefined;
200
+ /**
201
+ * <p>A description of the guardrail version.</p>
202
+ * @public
203
+ */
204
+ description?: string | undefined;
205
+ /**
206
+ * <p>A unique, case-sensitive identifier to ensure that the API request completes no more than once. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a> in the <i>Amazon S3 User Guide</i>.</p>
207
+ * @public
208
+ */
209
+ clientRequestToken?: string | undefined;
210
+ }
211
+ /**
212
+ * @public
213
+ */
214
+ export interface CreateGuardrailVersionResponse {
215
+ /**
216
+ * <p>The unique identifier of the guardrail.</p>
217
+ * @public
218
+ */
219
+ guardrailId: string | undefined;
220
+ /**
221
+ * <p>The number of the version of the guardrail.</p>
222
+ * @public
223
+ */
224
+ version: string | undefined;
225
+ }
226
+ /**
227
+ * @public
228
+ */
229
+ export interface DeleteGuardrailRequest {
230
+ /**
231
+ * <p>The unique identifier of the guardrail. This can be an ID or the ARN.</p>
232
+ * @public
233
+ */
234
+ guardrailIdentifier: string | undefined;
235
+ /**
236
+ * <p>The version of the guardrail.</p>
237
+ * @public
238
+ */
239
+ guardrailVersion?: string | undefined;
240
+ }
241
+ /**
242
+ * @public
243
+ */
244
+ export interface DeleteGuardrailResponse {
245
+ }
246
+ /**
247
+ * @public
248
+ */
249
+ export interface GetGuardrailRequest {
250
+ /**
251
+ * <p>The unique identifier of the guardrail for which to get details. This can be an ID or the ARN.</p>
252
+ * @public
253
+ */
254
+ guardrailIdentifier: string | undefined;
255
+ /**
256
+ * <p>The version of the guardrail for which to get details. If you don't specify a version, the response returns details for the <code>DRAFT</code> version.</p>
257
+ * @public
258
+ */
259
+ guardrailVersion?: string | undefined;
260
+ }
261
+ /**
262
+ * <p>Represents the configuration of Automated Reasoning policies within a Amazon Bedrock Guardrail, including the policies to apply and confidence thresholds.</p>
263
+ * @public
264
+ */
265
+ export interface GuardrailAutomatedReasoningPolicy {
266
+ /**
267
+ * <p>The list of Automated Reasoning policy ARNs that should be applied as part of this guardrail configuration.</p>
268
+ * @public
269
+ */
270
+ policies: string[] | undefined;
271
+ /**
272
+ * <p>The minimum confidence level required for Automated Reasoning policy violations to trigger guardrail actions. Values range from 0.0 to 1.0.</p>
273
+ * @public
274
+ */
275
+ confidenceThreshold?: number | undefined;
276
+ }
277
+ /**
278
+ * <p>Contains filter strengths for harmful content. Guardrails support the following content filters to detect and filter harmful user inputs and FM-generated outputs.</p> <ul> <li> <p> <b>Hate</b> – Describes language or a statement that discriminates, criticizes, insults, denounces, or dehumanizes a person or group on the basis of an identity (such as race, ethnicity, gender, religion, sexual orientation, ability, and national origin).</p> </li> <li> <p> <b>Insults</b> – Describes language or a statement that includes demeaning, humiliating, mocking, insulting, or belittling language. This type of language is also labeled as bullying.</p> </li> <li> <p> <b>Sexual</b> – Describes language or a statement that indicates sexual interest, activity, or arousal using direct or indirect references to body parts, physical traits, or sex.</p> </li> <li> <p> <b>Violence</b> – Describes language or a statement that includes glorification of or threats to inflict physical pain, hurt, or injury toward a person, group or thing.</p> </li> </ul> <p>Content filtering depends on the confidence classification of user inputs and FM responses across each of the four harmful categories. All input and output statements are classified into one of four confidence levels (NONE, LOW, MEDIUM, HIGH) for each harmful category. For example, if a statement is classified as <i>Hate</i> with HIGH confidence, the likelihood of the statement representing hateful content is high. A single statement can be classified across multiple categories with varying confidence levels. For example, a single statement can be classified as <i>Hate</i> with HIGH confidence, <i>Insults</i> with LOW confidence, <i>Sexual</i> with NONE confidence, and <i>Violence</i> with MEDIUM confidence.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-filters.html">Guardrails content filters</a>.</p> <p>This data type is used in the following API operations:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GetGuardrail.html#API_GetGuardrail_ResponseSyntax">GetGuardrail response body</a> </p> </li> </ul>
279
+ * @public
280
+ */
281
+ export interface GuardrailContentFilter {
282
+ /**
283
+ * <p>The harmful category that the content filter is applied to.</p>
284
+ * @public
285
+ */
286
+ type: GuardrailContentFilterType | undefined;
287
+ /**
288
+ * <p>The strength of the content filter to apply to prompts. As you increase the filter strength, the likelihood of filtering harmful content increases and the probability of seeing harmful content in your application reduces.</p>
289
+ * @public
290
+ */
291
+ inputStrength: GuardrailFilterStrength | undefined;
292
+ /**
293
+ * <p>The strength of the content filter to apply to model responses. As you increase the filter strength, the likelihood of filtering harmful content increases and the probability of seeing harmful content in your application reduces.</p>
294
+ * @public
295
+ */
296
+ outputStrength: GuardrailFilterStrength | undefined;
297
+ /**
298
+ * <p>The input modalities selected for the guardrail content filter.</p>
299
+ * @public
300
+ */
301
+ inputModalities?: GuardrailModality[] | undefined;
302
+ /**
303
+ * <p>The output modalities selected for the guardrail content filter.</p>
304
+ * @public
305
+ */
306
+ outputModalities?: GuardrailModality[] | undefined;
307
+ /**
308
+ * <p>The action to take when harmful content is detected in the input. Supported values include:</p> <ul> <li> <p> <code>BLOCK</code> – Block the content and replace it with blocked messaging.</p> </li> <li> <p> <code>NONE</code> – Take no action but return detection information in the trace response.</p> </li> </ul>
309
+ * @public
310
+ */
311
+ inputAction?: GuardrailContentFilterAction | undefined;
312
+ /**
313
+ * <p>The action to take when harmful content is detected in the output. Supported values include:</p> <ul> <li> <p> <code>BLOCK</code> – Block the content and replace it with blocked messaging.</p> </li> <li> <p> <code>NONE</code> – Take no action but return detection information in the trace response.</p> </li> </ul>
314
+ * @public
315
+ */
316
+ outputAction?: GuardrailContentFilterAction | undefined;
317
+ /**
318
+ * <p>Indicates whether guardrail evaluation is enabled on the input. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.</p>
319
+ * @public
320
+ */
321
+ inputEnabled?: boolean | undefined;
322
+ /**
323
+ * <p>Indicates whether guardrail evaluation is enabled on the output. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.</p>
324
+ * @public
325
+ */
326
+ outputEnabled?: boolean | undefined;
327
+ }
328
+ /**
329
+ * <p>The tier that your guardrail uses for content filters.</p>
330
+ * @public
331
+ */
332
+ export interface GuardrailContentFiltersTier {
333
+ /**
334
+ * <p>The tier that your guardrail uses for content filters. Valid values include:</p> <ul> <li> <p> <code>CLASSIC</code> tier – Provides established guardrails functionality supporting English, French, and Spanish languages.</p> </li> <li> <p> <code>STANDARD</code> tier – Provides a more robust solution than the <code>CLASSIC</code> tier and has more comprehensive language support. This tier requires that your guardrail use <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-cross-region.html">cross-Region inference</a>.</p> </li> </ul>
335
+ * @public
336
+ */
337
+ tierName: GuardrailContentFiltersTierName | undefined;
338
+ }
339
+ /**
340
+ * <p>Contains details about how to handle harmful content.</p> <p>This data type is used in the following API operations:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GetGuardrail.html#API_GetGuardrail_ResponseSyntax">GetGuardrail response body</a> </p> </li> </ul>
341
+ * @public
342
+ */
343
+ export interface GuardrailContentPolicy {
344
+ /**
345
+ * <p>Contains the type of the content filter and how strongly it should apply to prompts and model responses.</p>
346
+ * @public
347
+ */
348
+ filters?: GuardrailContentFilter[] | undefined;
349
+ /**
350
+ * <p>The tier that your guardrail uses for content filters.</p>
351
+ * @public
352
+ */
353
+ tier?: GuardrailContentFiltersTier | undefined;
354
+ }
355
+ /**
356
+ * <p>The details for the guardrails contextual grounding filter.</p>
357
+ * @public
358
+ */
359
+ export interface GuardrailContextualGroundingFilter {
360
+ /**
361
+ * <p>The filter type details for the guardrails contextual grounding filter.</p>
362
+ * @public
363
+ */
364
+ type: GuardrailContextualGroundingFilterType | undefined;
365
+ /**
366
+ * <p>The threshold details for the guardrails contextual grounding filter.</p>
367
+ * @public
368
+ */
369
+ threshold: number | undefined;
370
+ /**
371
+ * <p>The action to take when content fails the contextual grounding evaluation. Supported values include:</p> <ul> <li> <p> <code>BLOCK</code> – Block the content and replace it with blocked messaging.</p> </li> <li> <p> <code>NONE</code> – Take no action but return detection information in the trace response.</p> </li> </ul>
372
+ * @public
373
+ */
374
+ action?: GuardrailContextualGroundingAction | undefined;
375
+ /**
376
+ * <p>Indicates whether contextual grounding is enabled for evaluation. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.</p>
377
+ * @public
378
+ */
379
+ enabled?: boolean | undefined;
380
+ }
381
+ /**
382
+ * <p>The details for the guardrails contextual grounding policy.</p>
383
+ * @public
384
+ */
385
+ export interface GuardrailContextualGroundingPolicy {
386
+ /**
387
+ * <p>The filter details for the guardrails contextual grounding policy.</p>
388
+ * @public
389
+ */
390
+ filters: GuardrailContextualGroundingFilter[] | undefined;
391
+ }
392
+ /**
393
+ * <p>Contains details about the system-defined guardrail profile that you're using with your guardrail for cross-Region inference.</p> <p>For more information, see the <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-cross-region.html">Amazon Bedrock User Guide</a>.</p>
394
+ * @public
395
+ */
396
+ export interface GuardrailCrossRegionDetails {
397
+ /**
398
+ * <p>The ID of the guardrail profile that your guardrail is using. Profile availability depends on your current Amazon Web Services Region. For more information, see the <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-cross-region-support.html">Amazon Bedrock User Guide</a>.</p>
399
+ * @public
400
+ */
401
+ guardrailProfileId?: string | undefined;
402
+ /**
403
+ * <p>The Amazon Resource Name (ARN) of the guardrail profile that you're using with your guardrail.</p>
404
+ * @public
405
+ */
406
+ guardrailProfileArn?: string | undefined;
407
+ }
408
+ /**
409
+ * <p>The PII entity configured for the guardrail.</p>
410
+ * @public
411
+ */
412
+ export interface GuardrailPiiEntity {
413
+ /**
414
+ * <p>The type of PII entity. For example, Social Security Number.</p>
415
+ * @public
416
+ */
417
+ type: GuardrailPiiEntityType | undefined;
418
+ /**
419
+ * <p>The configured guardrail action when PII entity is detected.</p>
420
+ * @public
421
+ */
422
+ action: GuardrailSensitiveInformationAction | undefined;
423
+ /**
424
+ * <p>The action to take when harmful content is detected in the input. Supported values include:</p> <ul> <li> <p> <code>BLOCK</code> – Block the content and replace it with blocked messaging.</p> </li> <li> <p> <code>ANONYMIZE</code> – Mask the content and replace it with identifier tags.</p> </li> <li> <p> <code>NONE</code> – Take no action but return detection information in the trace response.</p> </li> </ul>
425
+ * @public
426
+ */
427
+ inputAction?: GuardrailSensitiveInformationAction | undefined;
428
+ /**
429
+ * <p>The action to take when harmful content is detected in the output. Supported values include:</p> <ul> <li> <p> <code>BLOCK</code> – Block the content and replace it with blocked messaging.</p> </li> <li> <p> <code>ANONYMIZE</code> – Mask the content and replace it with identifier tags.</p> </li> <li> <p> <code>NONE</code> – Take no action but return detection information in the trace response.</p> </li> </ul>
430
+ * @public
431
+ */
432
+ outputAction?: GuardrailSensitiveInformationAction | undefined;
433
+ /**
434
+ * <p>Indicates whether guardrail evaluation is enabled on the input. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.</p>
435
+ * @public
436
+ */
437
+ inputEnabled?: boolean | undefined;
438
+ /**
439
+ * <p>Indicates whether guardrail evaluation is enabled on the output. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.</p>
440
+ * @public
441
+ */
442
+ outputEnabled?: boolean | undefined;
443
+ }
444
+ /**
445
+ * <p>The regular expression configured for the guardrail.</p>
446
+ * @public
447
+ */
448
+ export interface GuardrailRegex {
449
+ /**
450
+ * <p>The name of the regular expression for the guardrail.</p>
451
+ * @public
452
+ */
453
+ name: string | undefined;
454
+ /**
455
+ * <p>The description of the regular expression for the guardrail.</p>
456
+ * @public
457
+ */
458
+ description?: string | undefined;
459
+ /**
460
+ * <p>The pattern of the regular expression configured for the guardrail.</p>
461
+ * @public
462
+ */
463
+ pattern: string | undefined;
464
+ /**
465
+ * <p>The action taken when a match to the regular expression is detected.</p>
466
+ * @public
467
+ */
468
+ action: GuardrailSensitiveInformationAction | undefined;
469
+ /**
470
+ * <p>The action to take when harmful content is detected in the input. Supported values include:</p> <ul> <li> <p> <code>BLOCK</code> – Block the content and replace it with blocked messaging.</p> </li> <li> <p> <code>NONE</code> – Take no action but return detection information in the trace response.</p> </li> </ul>
471
+ * @public
472
+ */
473
+ inputAction?: GuardrailSensitiveInformationAction | undefined;
474
+ /**
475
+ * <p>The action to take when harmful content is detected in the output. Supported values include:</p> <ul> <li> <p> <code>BLOCK</code> – Block the content and replace it with blocked messaging.</p> </li> <li> <p> <code>NONE</code> – Take no action but return detection information in the trace response.</p> </li> </ul>
476
+ * @public
477
+ */
478
+ outputAction?: GuardrailSensitiveInformationAction | undefined;
479
+ /**
480
+ * <p>Indicates whether guardrail evaluation is enabled on the input. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.</p>
481
+ * @public
482
+ */
483
+ inputEnabled?: boolean | undefined;
484
+ /**
485
+ * <p>Indicates whether guardrail evaluation is enabled on the output. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.</p>
486
+ * @public
487
+ */
488
+ outputEnabled?: boolean | undefined;
489
+ }
490
+ /**
491
+ * <p>Contains details about PII entities and regular expressions configured for the guardrail.</p>
492
+ * @public
493
+ */
494
+ export interface GuardrailSensitiveInformationPolicy {
495
+ /**
496
+ * <p>The list of PII entities configured for the guardrail.</p>
497
+ * @public
498
+ */
499
+ piiEntities?: GuardrailPiiEntity[] | undefined;
500
+ /**
501
+ * <p>The list of regular expressions configured for the guardrail.</p>
502
+ * @public
503
+ */
504
+ regexes?: GuardrailRegex[] | undefined;
505
+ }
506
+ /**
507
+ * @public
508
+ * @enum
509
+ */
510
+ export declare const GuardrailStatus: {
511
+ readonly CREATING: "CREATING";
512
+ readonly DELETING: "DELETING";
513
+ readonly FAILED: "FAILED";
514
+ readonly READY: "READY";
515
+ readonly UPDATING: "UPDATING";
516
+ readonly VERSIONING: "VERSIONING";
517
+ };
518
+ /**
519
+ * @public
520
+ */
521
+ export type GuardrailStatus = (typeof GuardrailStatus)[keyof typeof GuardrailStatus];
522
+ /**
523
+ * <p>The tier that your guardrail uses for denied topic filters.</p>
524
+ * @public
525
+ */
526
+ export interface GuardrailTopicsTier {
527
+ /**
528
+ * <p>The tier that your guardrail uses for denied topic filters. Valid values include:</p> <ul> <li> <p> <code>CLASSIC</code> tier – Provides established guardrails functionality supporting English, French, and Spanish languages.</p> </li> <li> <p> <code>STANDARD</code> tier – Provides a more robust solution than the <code>CLASSIC</code> tier and has more comprehensive language support. This tier requires that your guardrail use <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-cross-region.html">cross-Region inference</a>.</p> </li> </ul>
529
+ * @public
530
+ */
531
+ tierName: GuardrailTopicsTierName | undefined;
532
+ }
533
+ /**
534
+ * <p>Details about topics for the guardrail to identify and deny.</p> <p>This data type is used in the following API operations:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GetGuardrail.html#API_GetGuardrail_ResponseSyntax">GetGuardrail response body</a> </p> </li> </ul>
535
+ * @public
536
+ */
537
+ export interface GuardrailTopic {
538
+ /**
539
+ * <p>The name of the topic to deny.</p>
540
+ * @public
541
+ */
542
+ name: string | undefined;
543
+ /**
544
+ * <p>A definition of the topic to deny.</p>
545
+ * @public
546
+ */
547
+ definition: string | undefined;
548
+ /**
549
+ * <p>A list of prompts, each of which is an example of a prompt that can be categorized as belonging to the topic.</p>
550
+ * @public
551
+ */
552
+ examples?: string[] | undefined;
553
+ /**
554
+ * <p>Specifies to deny the topic.</p>
555
+ * @public
556
+ */
557
+ type?: GuardrailTopicType | undefined;
558
+ /**
559
+ * <p>The action to take when harmful content is detected in the input. Supported values include:</p> <ul> <li> <p> <code>BLOCK</code> – Block the content and replace it with blocked messaging.</p> </li> <li> <p> <code>NONE</code> – Take no action but return detection information in the trace response.</p> </li> </ul>
560
+ * @public
561
+ */
562
+ inputAction?: GuardrailTopicAction | undefined;
563
+ /**
564
+ * <p>The action to take when harmful content is detected in the output. Supported values include:</p> <ul> <li> <p> <code>BLOCK</code> – Block the content and replace it with blocked messaging.</p> </li> <li> <p> <code>NONE</code> – Take no action but return detection information in the trace response.</p> </li> </ul>
565
+ * @public
566
+ */
567
+ outputAction?: GuardrailTopicAction | undefined;
568
+ /**
569
+ * <p>Indicates whether guardrail evaluation is enabled on the input. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.</p>
570
+ * @public
571
+ */
572
+ inputEnabled?: boolean | undefined;
573
+ /**
574
+ * <p>Indicates whether guardrail evaluation is enabled on the output. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.</p>
575
+ * @public
576
+ */
577
+ outputEnabled?: boolean | undefined;
578
+ }
579
+ /**
580
+ * <p>Contains details about topics that the guardrail should identify and deny.</p> <p>This data type is used in the following API operations:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GetGuardrail.html#API_GetGuardrail_ResponseSyntax">GetGuardrail response body</a> </p> </li> </ul>
581
+ * @public
582
+ */
583
+ export interface GuardrailTopicPolicy {
584
+ /**
585
+ * <p>A list of policies related to topics that the guardrail should deny.</p>
586
+ * @public
587
+ */
588
+ topics: GuardrailTopic[] | undefined;
589
+ /**
590
+ * <p>The tier that your guardrail uses for denied topic filters.</p>
591
+ * @public
592
+ */
593
+ tier?: GuardrailTopicsTier | undefined;
594
+ }
595
+ /**
596
+ * <p>The managed word list that was configured for the guardrail. (This is a list of words that are pre-defined and managed by guardrails only.)</p>
597
+ * @public
598
+ */
599
+ export interface GuardrailManagedWords {
600
+ /**
601
+ * <p>ManagedWords$type The managed word type that was configured for the guardrail. (For now, we only offer profanity word list)</p>
602
+ * @public
603
+ */
604
+ type: GuardrailManagedWordsType | undefined;
605
+ /**
606
+ * <p>The action to take when harmful content is detected in the input. Supported values include:</p> <ul> <li> <p> <code>BLOCK</code> – Block the content and replace it with blocked messaging.</p> </li> <li> <p> <code>NONE</code> – Take no action but return detection information in the trace response.</p> </li> </ul>
607
+ * @public
608
+ */
609
+ inputAction?: GuardrailWordAction | undefined;
610
+ /**
611
+ * <p>The action to take when harmful content is detected in the output. Supported values include:</p> <ul> <li> <p> <code>BLOCK</code> – Block the content and replace it with blocked messaging.</p> </li> <li> <p> <code>NONE</code> – Take no action but return detection information in the trace response.</p> </li> </ul>
612
+ * @public
613
+ */
614
+ outputAction?: GuardrailWordAction | undefined;
615
+ /**
616
+ * <p>Indicates whether guardrail evaluation is enabled on the input. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.</p>
617
+ * @public
618
+ */
619
+ inputEnabled?: boolean | undefined;
620
+ /**
621
+ * <p>Indicates whether guardrail evaluation is enabled on the output. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.</p>
622
+ * @public
623
+ */
624
+ outputEnabled?: boolean | undefined;
625
+ }
626
+ /**
627
+ * <p>A word configured for the guardrail.</p>
628
+ * @public
629
+ */
630
+ export interface GuardrailWord {
631
+ /**
632
+ * <p>Text of the word configured for the guardrail to block.</p>
633
+ * @public
634
+ */
635
+ text: string | undefined;
636
+ /**
637
+ * <p>The action to take when harmful content is detected in the input. Supported values include:</p> <ul> <li> <p> <code>BLOCK</code> – Block the content and replace it with blocked messaging.</p> </li> <li> <p> <code>NONE</code> – Take no action but return detection information in the trace response.</p> </li> </ul>
638
+ * @public
639
+ */
640
+ inputAction?: GuardrailWordAction | undefined;
641
+ /**
642
+ * <p>The action to take when harmful content is detected in the output. Supported values include:</p> <ul> <li> <p> <code>BLOCK</code> – Block the content and replace it with blocked messaging.</p> </li> <li> <p> <code>NONE</code> – Take no action but return detection information in the trace response.</p> </li> </ul>
643
+ * @public
644
+ */
645
+ outputAction?: GuardrailWordAction | undefined;
646
+ /**
647
+ * <p>Indicates whether guardrail evaluation is enabled on the input. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.</p>
648
+ * @public
649
+ */
650
+ inputEnabled?: boolean | undefined;
651
+ /**
652
+ * <p>Indicates whether guardrail evaluation is enabled on the output. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.</p>
653
+ * @public
654
+ */
655
+ outputEnabled?: boolean | undefined;
656
+ }
657
+ /**
658
+ * <p>Contains details about the word policy configured for the guardrail.</p>
659
+ * @public
660
+ */
661
+ export interface GuardrailWordPolicy {
662
+ /**
663
+ * <p>A list of words configured for the guardrail.</p>
664
+ * @public
665
+ */
666
+ words?: GuardrailWord[] | undefined;
667
+ /**
668
+ * <p>A list of managed words configured for the guardrail.</p>
669
+ * @public
670
+ */
671
+ managedWordLists?: GuardrailManagedWords[] | undefined;
672
+ }
673
+ /**
674
+ * @public
675
+ */
676
+ export interface GetGuardrailResponse {
677
+ /**
678
+ * <p>The name of the guardrail.</p>
679
+ * @public
680
+ */
681
+ name: string | undefined;
682
+ /**
683
+ * <p>The description of the guardrail.</p>
684
+ * @public
685
+ */
686
+ description?: string | undefined;
687
+ /**
688
+ * <p>The unique identifier of the guardrail.</p>
689
+ * @public
690
+ */
691
+ guardrailId: string | undefined;
692
+ /**
693
+ * <p>The ARN of the guardrail.</p>
694
+ * @public
695
+ */
696
+ guardrailArn: string | undefined;
697
+ /**
698
+ * <p>The version of the guardrail.</p>
699
+ * @public
700
+ */
701
+ version: string | undefined;
702
+ /**
703
+ * <p>The status of the guardrail.</p>
704
+ * @public
705
+ */
706
+ status: GuardrailStatus | undefined;
707
+ /**
708
+ * <p>The topic policy that was configured for the guardrail.</p>
709
+ * @public
710
+ */
711
+ topicPolicy?: GuardrailTopicPolicy | undefined;
712
+ /**
713
+ * <p>The content policy that was configured for the guardrail.</p>
714
+ * @public
715
+ */
716
+ contentPolicy?: GuardrailContentPolicy | undefined;
717
+ /**
718
+ * <p>The word policy that was configured for the guardrail.</p>
719
+ * @public
720
+ */
721
+ wordPolicy?: GuardrailWordPolicy | undefined;
722
+ /**
723
+ * <p>The sensitive information policy that was configured for the guardrail.</p>
724
+ * @public
725
+ */
726
+ sensitiveInformationPolicy?: GuardrailSensitiveInformationPolicy | undefined;
727
+ /**
728
+ * <p>The contextual grounding policy used in the guardrail.</p>
729
+ * @public
730
+ */
731
+ contextualGroundingPolicy?: GuardrailContextualGroundingPolicy | undefined;
732
+ /**
733
+ * <p>The current Automated Reasoning policy configuration for the guardrail, if any is configured.</p>
734
+ * @public
735
+ */
736
+ automatedReasoningPolicy?: GuardrailAutomatedReasoningPolicy | undefined;
737
+ /**
738
+ * <p>Details about the system-defined guardrail profile that you're using with your guardrail, including the guardrail profile ID and Amazon Resource Name (ARN).</p>
739
+ * @public
740
+ */
741
+ crossRegionDetails?: GuardrailCrossRegionDetails | undefined;
742
+ /**
743
+ * <p>The date and time at which the guardrail was created.</p>
744
+ * @public
745
+ */
746
+ createdAt: Date | undefined;
747
+ /**
748
+ * <p>The date and time at which the guardrail was updated.</p>
749
+ * @public
750
+ */
751
+ updatedAt: Date | undefined;
752
+ /**
753
+ * <p>Appears if the <code>status</code> is <code>FAILED</code>. A list of reasons for why the guardrail failed to be created, updated, versioned, or deleted.</p>
754
+ * @public
755
+ */
756
+ statusReasons?: string[] | undefined;
757
+ /**
758
+ * <p>Appears if the <code>status</code> of the guardrail is <code>FAILED</code>. A list of recommendations to carry out before retrying the request.</p>
759
+ * @public
760
+ */
761
+ failureRecommendations?: string[] | undefined;
762
+ /**
763
+ * <p>The message that the guardrail returns when it blocks a prompt.</p>
764
+ * @public
765
+ */
766
+ blockedInputMessaging: string | undefined;
767
+ /**
768
+ * <p>The message that the guardrail returns when it blocks a model response.</p>
769
+ * @public
770
+ */
771
+ blockedOutputsMessaging: string | undefined;
772
+ /**
773
+ * <p>The ARN of the KMS key that encrypts the guardrail.</p>
774
+ * @public
775
+ */
776
+ kmsKeyArn?: string | undefined;
777
+ }
778
+ /**
779
+ * @public
780
+ */
781
+ export interface ListGuardrailsRequest {
782
+ /**
783
+ * <p>The unique identifier of the guardrail. This can be an ID or the ARN.</p>
784
+ * @public
785
+ */
786
+ guardrailIdentifier?: string | undefined;
787
+ /**
788
+ * <p>The maximum number of results to return in the response.</p>
789
+ * @public
790
+ */
791
+ maxResults?: number | undefined;
792
+ /**
793
+ * <p>If there are more results than were returned in the response, 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>
794
+ * @public
795
+ */
796
+ nextToken?: string | undefined;
797
+ }
798
+ /**
799
+ * <p>Contains details about a guardrail.</p> <p>This data type is used in the following API operations:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_ListGuardrails.html#API_ListGuardrails_ResponseSyntax">ListGuardrails response body</a> </p> </li> </ul>
800
+ * @public
801
+ */
802
+ export interface GuardrailSummary {
803
+ /**
804
+ * <p>The unique identifier of the guardrail.</p>
805
+ * @public
806
+ */
807
+ id: string | undefined;
808
+ /**
809
+ * <p>The ARN of the guardrail.</p>
810
+ * @public
811
+ */
812
+ arn: string | undefined;
813
+ /**
814
+ * <p>The status of the guardrail.</p>
815
+ * @public
816
+ */
817
+ status: GuardrailStatus | undefined;
818
+ /**
819
+ * <p>The name of the guardrail.</p>
820
+ * @public
821
+ */
822
+ name: string | undefined;
823
+ /**
824
+ * <p>A description of the guardrail.</p>
825
+ * @public
826
+ */
827
+ description?: string | undefined;
828
+ /**
829
+ * <p>The version of the guardrail.</p>
830
+ * @public
831
+ */
832
+ version: string | undefined;
833
+ /**
834
+ * <p>The date and time at which the guardrail was created.</p>
835
+ * @public
836
+ */
837
+ createdAt: Date | undefined;
838
+ /**
839
+ * <p>The date and time at which the guardrail was last updated.</p>
840
+ * @public
841
+ */
842
+ updatedAt: Date | undefined;
843
+ /**
844
+ * <p>Details about the system-defined guardrail profile that you're using with your guardrail, including the guardrail profile ID and Amazon Resource Name (ARN).</p>
845
+ * @public
846
+ */
847
+ crossRegionDetails?: GuardrailCrossRegionDetails | undefined;
848
+ }
849
+ /**
850
+ * @public
851
+ */
852
+ export interface ListGuardrailsResponse {
853
+ /**
854
+ * <p>A list of objects, each of which contains details about a guardrail.</p>
855
+ * @public
856
+ */
857
+ guardrails: GuardrailSummary[] | undefined;
858
+ /**
859
+ * <p>If there are more results than were returned in the response, 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>
860
+ * @public
861
+ */
862
+ nextToken?: string | undefined;
863
+ }
864
+ /**
865
+ * @public
866
+ */
867
+ export interface UpdateGuardrailRequest {
868
+ /**
869
+ * <p>The unique identifier of the guardrail. This can be an ID or the ARN.</p>
870
+ * @public
871
+ */
872
+ guardrailIdentifier: string | undefined;
873
+ /**
874
+ * <p>A name for the guardrail.</p>
875
+ * @public
876
+ */
877
+ name: string | undefined;
878
+ /**
879
+ * <p>A description of the guardrail.</p>
880
+ * @public
881
+ */
882
+ description?: string | undefined;
883
+ /**
884
+ * <p>The topic policy to configure for the guardrail.</p>
885
+ * @public
886
+ */
887
+ topicPolicyConfig?: GuardrailTopicPolicyConfig | undefined;
888
+ /**
889
+ * <p>The content policy to configure for the guardrail.</p>
890
+ * @public
891
+ */
892
+ contentPolicyConfig?: GuardrailContentPolicyConfig | undefined;
893
+ /**
894
+ * <p>The word policy to configure for the guardrail.</p>
895
+ * @public
896
+ */
897
+ wordPolicyConfig?: GuardrailWordPolicyConfig | undefined;
898
+ /**
899
+ * <p>The sensitive information policy to configure for the guardrail.</p>
900
+ * @public
901
+ */
902
+ sensitiveInformationPolicyConfig?: GuardrailSensitiveInformationPolicyConfig | undefined;
903
+ /**
904
+ * <p>The contextual grounding policy configuration used to update a guardrail.</p>
905
+ * @public
906
+ */
907
+ contextualGroundingPolicyConfig?: GuardrailContextualGroundingPolicyConfig | undefined;
908
+ /**
909
+ * <p>Updated configuration for Automated Reasoning policies associated with the guardrail.</p>
910
+ * @public
911
+ */
912
+ automatedReasoningPolicyConfig?: GuardrailAutomatedReasoningPolicyConfig | undefined;
913
+ /**
914
+ * <p>The system-defined guardrail profile that you're using with your guardrail. Guardrail profiles define the destination Amazon Web Services Regions where guardrail inference requests can be automatically routed.</p> <p>For more information, see the <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-cross-region.html">Amazon Bedrock User Guide</a>.</p>
915
+ * @public
916
+ */
917
+ crossRegionConfig?: GuardrailCrossRegionConfig | undefined;
918
+ /**
919
+ * <p>The message to return when the guardrail blocks a prompt.</p>
920
+ * @public
921
+ */
922
+ blockedInputMessaging: string | undefined;
923
+ /**
924
+ * <p>The message to return when the guardrail blocks a model response.</p>
925
+ * @public
926
+ */
927
+ blockedOutputsMessaging: string | undefined;
928
+ /**
929
+ * <p>The ARN of the KMS key with which to encrypt the guardrail.</p>
930
+ * @public
931
+ */
932
+ kmsKeyId?: string | undefined;
933
+ }
934
+ /**
935
+ * @public
936
+ */
937
+ export interface UpdateGuardrailResponse {
938
+ /**
939
+ * <p>The unique identifier of the guardrail</p>
940
+ * @public
941
+ */
942
+ guardrailId: string | undefined;
943
+ /**
944
+ * <p>The ARN of the guardrail.</p>
945
+ * @public
946
+ */
947
+ guardrailArn: string | undefined;
948
+ /**
949
+ * <p>The version of the guardrail.</p>
950
+ * @public
951
+ */
952
+ version: string | undefined;
953
+ /**
954
+ * <p>The date and time at which the guardrail was updated.</p>
955
+ * @public
956
+ */
957
+ updatedAt: Date | undefined;
958
+ }
959
+ /**
960
+ * <p>Contains information about the model or system-defined inference profile that is the source for an inference profile..</p>
961
+ * @public
962
+ */
963
+ export type InferenceProfileModelSource = InferenceProfileModelSource.CopyFromMember | InferenceProfileModelSource.$UnknownMember;
964
+ /**
965
+ * @public
966
+ */
967
+ export declare namespace InferenceProfileModelSource {
968
+ /**
969
+ * <p>The ARN of the model or system-defined inference profile that is the source for the inference profile.</p>
970
+ * @public
971
+ */
972
+ interface CopyFromMember {
973
+ copyFrom: string;
974
+ $unknown?: never;
975
+ }
976
+ /**
977
+ * @public
978
+ */
979
+ interface $UnknownMember {
980
+ copyFrom?: never;
981
+ $unknown: [string, any];
982
+ }
983
+ interface Visitor<T> {
984
+ copyFrom: (value: string) => T;
985
+ _: (name: string, value: any) => T;
986
+ }
987
+ const visit: <T>(value: InferenceProfileModelSource, visitor: Visitor<T>) => T;
988
+ }
989
+ /**
990
+ * @public
991
+ */
992
+ export interface CreateInferenceProfileRequest {
993
+ /**
994
+ * <p>A name for the inference profile.</p>
995
+ * @public
996
+ */
997
+ inferenceProfileName: string | undefined;
998
+ /**
999
+ * <p>A description for the inference profile.</p>
1000
+ * @public
1001
+ */
1002
+ description?: string | undefined;
1003
+ /**
1004
+ * <p>A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</p>
1005
+ * @public
1006
+ */
1007
+ clientRequestToken?: string | undefined;
1008
+ /**
1009
+ * <p>The foundation model or system-defined inference profile that the inference profile will track metrics and costs for.</p>
1010
+ * @public
1011
+ */
1012
+ modelSource: InferenceProfileModelSource | undefined;
1013
+ /**
1014
+ * <p>An array of objects, each of which contains a tag and its value. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html">Tagging resources</a> in the <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html">Amazon Bedrock User Guide</a>.</p>
1015
+ * @public
1016
+ */
1017
+ tags?: Tag[] | undefined;
1018
+ }
1019
+ /**
1020
+ * @public
1021
+ * @enum
1022
+ */
1023
+ export declare const InferenceProfileStatus: {
1024
+ readonly ACTIVE: "ACTIVE";
1025
+ };
1026
+ /**
1027
+ * @public
1028
+ */
1029
+ export type InferenceProfileStatus = (typeof InferenceProfileStatus)[keyof typeof InferenceProfileStatus];
1030
+ /**
1031
+ * @public
1032
+ */
1033
+ export interface CreateInferenceProfileResponse {
1034
+ /**
1035
+ * <p>The ARN of the inference profile that you created.</p>
1036
+ * @public
1037
+ */
1038
+ inferenceProfileArn: string | undefined;
1039
+ /**
1040
+ * <p>The status of the inference profile. <code>ACTIVE</code> means that the inference profile is ready to be used.</p>
1041
+ * @public
1042
+ */
1043
+ status?: InferenceProfileStatus | undefined;
1044
+ }
1045
+ /**
1046
+ * @public
1047
+ */
1048
+ export interface DeleteInferenceProfileRequest {
1049
+ /**
1050
+ * <p>The Amazon Resource Name (ARN) or ID of the application inference profile to delete.</p>
1051
+ * @public
1052
+ */
1053
+ inferenceProfileIdentifier: string | undefined;
1054
+ }
1055
+ /**
1056
+ * @public
1057
+ */
1058
+ export interface DeleteInferenceProfileResponse {
1059
+ }
1060
+ /**
1061
+ * @public
1062
+ */
1063
+ export interface GetInferenceProfileRequest {
1064
+ /**
1065
+ * <p>The ID or Amazon Resource Name (ARN) of the inference profile.</p>
1066
+ * @public
1067
+ */
1068
+ inferenceProfileIdentifier: string | undefined;
1069
+ }
1070
+ /**
1071
+ * <p>Contains information about a model.</p>
1072
+ * @public
1073
+ */
1074
+ export interface InferenceProfileModel {
1075
+ /**
1076
+ * <p>The Amazon Resource Name (ARN) of the model.</p>
1077
+ * @public
1078
+ */
1079
+ modelArn?: string | undefined;
1080
+ }
1081
+ /**
1082
+ * @public
1083
+ * @enum
1084
+ */
1085
+ export declare const InferenceProfileType: {
1086
+ readonly APPLICATION: "APPLICATION";
1087
+ readonly SYSTEM_DEFINED: "SYSTEM_DEFINED";
1088
+ };
1089
+ /**
1090
+ * @public
1091
+ */
1092
+ export type InferenceProfileType = (typeof InferenceProfileType)[keyof typeof InferenceProfileType];
1093
+ /**
1094
+ * @public
1095
+ */
1096
+ export interface GetInferenceProfileResponse {
1097
+ /**
1098
+ * <p>The name of the inference profile.</p>
1099
+ * @public
1100
+ */
1101
+ inferenceProfileName: string | undefined;
1102
+ /**
1103
+ * <p>The description of the inference profile.</p>
1104
+ * @public
1105
+ */
1106
+ description?: string | undefined;
1107
+ /**
1108
+ * <p>The time at which the inference profile was created.</p>
1109
+ * @public
1110
+ */
1111
+ createdAt?: Date | undefined;
1112
+ /**
1113
+ * <p>The time at which the inference profile was last updated.</p>
1114
+ * @public
1115
+ */
1116
+ updatedAt?: Date | undefined;
1117
+ /**
1118
+ * <p>The Amazon Resource Name (ARN) of the inference profile.</p>
1119
+ * @public
1120
+ */
1121
+ inferenceProfileArn: string | undefined;
1122
+ /**
1123
+ * <p>A list of information about each model in the inference profile.</p>
1124
+ * @public
1125
+ */
1126
+ models: InferenceProfileModel[] | undefined;
1127
+ /**
1128
+ * <p>The unique identifier of the inference profile.</p>
1129
+ * @public
1130
+ */
1131
+ inferenceProfileId: string | undefined;
1132
+ /**
1133
+ * <p>The status of the inference profile. <code>ACTIVE</code> means that the inference profile is ready to be used.</p>
1134
+ * @public
1135
+ */
1136
+ status: InferenceProfileStatus | undefined;
1137
+ /**
1138
+ * <p>The type of the inference profile. The following types are possible:</p> <ul> <li> <p> <code>SYSTEM_DEFINED</code> – The inference profile is defined by Amazon Bedrock. You can route inference requests across regions with these inference profiles.</p> </li> <li> <p> <code>APPLICATION</code> – The inference profile was created by a user. This type of inference profile can track metrics and costs when invoking the model in it. The inference profile may route requests to one or multiple regions.</p> </li> </ul>
1139
+ * @public
1140
+ */
1141
+ type: InferenceProfileType | undefined;
1142
+ }
1143
+ /**
1144
+ * @public
1145
+ */
1146
+ export interface ListInferenceProfilesRequest {
1147
+ /**
1148
+ * <p>The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the <code>nextToken</code> field when making another request to return the next batch of results.</p>
1149
+ * @public
1150
+ */
1151
+ maxResults?: number | undefined;
1152
+ /**
1153
+ * <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, enter the token returned in the <code>nextToken</code> field in the response in this field to return the next batch of results.</p>
1154
+ * @public
1155
+ */
1156
+ nextToken?: string | undefined;
1157
+ /**
1158
+ * <p>Filters for inference profiles that match the type you specify.</p> <ul> <li> <p> <code>SYSTEM_DEFINED</code> – The inference profile is defined by Amazon Bedrock. You can route inference requests across regions with these inference profiles.</p> </li> <li> <p> <code>APPLICATION</code> – The inference profile was created by a user. This type of inference profile can track metrics and costs when invoking the model in it. The inference profile may route requests to one or multiple regions.</p> </li> </ul>
1159
+ * @public
1160
+ */
1161
+ typeEquals?: InferenceProfileType | undefined;
1162
+ }
1163
+ /**
1164
+ * <p>Contains information about an inference profile.</p>
1165
+ * @public
1166
+ */
1167
+ export interface InferenceProfileSummary {
1168
+ /**
1169
+ * <p>The name of the inference profile.</p>
1170
+ * @public
1171
+ */
1172
+ inferenceProfileName: string | undefined;
1173
+ /**
1174
+ * <p>The description of the inference profile.</p>
1175
+ * @public
1176
+ */
1177
+ description?: string | undefined;
1178
+ /**
1179
+ * <p>The time at which the inference profile was created.</p>
1180
+ * @public
1181
+ */
1182
+ createdAt?: Date | undefined;
1183
+ /**
1184
+ * <p>The time at which the inference profile was last updated.</p>
1185
+ * @public
1186
+ */
1187
+ updatedAt?: Date | undefined;
1188
+ /**
1189
+ * <p>The Amazon Resource Name (ARN) of the inference profile.</p>
1190
+ * @public
1191
+ */
1192
+ inferenceProfileArn: string | undefined;
1193
+ /**
1194
+ * <p>A list of information about each model in the inference profile.</p>
1195
+ * @public
1196
+ */
1197
+ models: InferenceProfileModel[] | undefined;
1198
+ /**
1199
+ * <p>The unique identifier of the inference profile.</p>
1200
+ * @public
1201
+ */
1202
+ inferenceProfileId: string | undefined;
1203
+ /**
1204
+ * <p>The status of the inference profile. <code>ACTIVE</code> means that the inference profile is ready to be used.</p>
1205
+ * @public
1206
+ */
1207
+ status: InferenceProfileStatus | undefined;
1208
+ /**
1209
+ * <p>The type of the inference profile. The following types are possible:</p> <ul> <li> <p> <code>SYSTEM_DEFINED</code> – The inference profile is defined by Amazon Bedrock. You can route inference requests across regions with these inference profiles.</p> </li> <li> <p> <code>APPLICATION</code> – The inference profile was created by a user. This type of inference profile can track metrics and costs when invoking the model in it. The inference profile may route requests to one or multiple regions.</p> </li> </ul>
1210
+ * @public
1211
+ */
1212
+ type: InferenceProfileType | undefined;
1213
+ }
1214
+ /**
1215
+ * @public
1216
+ */
1217
+ export interface ListInferenceProfilesResponse {
1218
+ /**
1219
+ * <p>A list of information about each inference profile that you can use.</p>
1220
+ * @public
1221
+ */
1222
+ inferenceProfileSummaries?: InferenceProfileSummary[] | undefined;
1223
+ /**
1224
+ * <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, use this token when making another request in the <code>nextToken</code> field to return the next batch of results.</p>
1225
+ * @public
1226
+ */
1227
+ nextToken?: string | undefined;
1228
+ }
1229
+ /**
1230
+ * @public
1231
+ */
1232
+ export interface DeleteModelInvocationLoggingConfigurationRequest {
1233
+ }
1234
+ /**
1235
+ * @public
1236
+ */
1237
+ export interface DeleteModelInvocationLoggingConfigurationResponse {
1238
+ }
1239
+ /**
1240
+ * @public
1241
+ */
1242
+ export interface GetModelInvocationLoggingConfigurationRequest {
1243
+ }
1244
+ /**
1245
+ * <p>S3 configuration for storing log data.</p>
1246
+ * @public
1247
+ */
1248
+ export interface S3Config {
1249
+ /**
1250
+ * <p>S3 bucket name.</p>
1251
+ * @public
1252
+ */
1253
+ bucketName: string | undefined;
1254
+ /**
1255
+ * <p>S3 prefix. </p>
1256
+ * @public
1257
+ */
1258
+ keyPrefix?: string | undefined;
1259
+ }
1260
+ /**
1261
+ * <p>CloudWatch logging configuration.</p>
1262
+ * @public
1263
+ */
1264
+ export interface CloudWatchConfig {
1265
+ /**
1266
+ * <p>The log group name.</p>
1267
+ * @public
1268
+ */
1269
+ logGroupName: string | undefined;
1270
+ /**
1271
+ * <p>The role Amazon Resource Name (ARN).</p>
1272
+ * @public
1273
+ */
1274
+ roleArn: string | undefined;
1275
+ /**
1276
+ * <p>S3 configuration for delivering a large amount of data.</p>
1277
+ * @public
1278
+ */
1279
+ largeDataDeliveryS3Config?: S3Config | undefined;
1280
+ }
1281
+ /**
1282
+ * <p>Configuration fields for invocation logging.</p>
1283
+ * @public
1284
+ */
1285
+ export interface LoggingConfig {
1286
+ /**
1287
+ * <p>CloudWatch logging configuration.</p>
1288
+ * @public
1289
+ */
1290
+ cloudWatchConfig?: CloudWatchConfig | undefined;
1291
+ /**
1292
+ * <p>S3 configuration for storing log data.</p>
1293
+ * @public
1294
+ */
1295
+ s3Config?: S3Config | undefined;
1296
+ /**
1297
+ * <p>Set to include text data in the log delivery.</p>
1298
+ * @public
1299
+ */
1300
+ textDataDeliveryEnabled?: boolean | undefined;
1301
+ /**
1302
+ * <p>Set to include image data in the log delivery.</p>
1303
+ * @public
1304
+ */
1305
+ imageDataDeliveryEnabled?: boolean | undefined;
1306
+ /**
1307
+ * <p>Set to include embeddings data in the log delivery.</p>
1308
+ * @public
1309
+ */
1310
+ embeddingDataDeliveryEnabled?: boolean | undefined;
1311
+ /**
1312
+ * <p>Set to include video data in the log delivery.</p>
1313
+ * @public
1314
+ */
1315
+ videoDataDeliveryEnabled?: boolean | undefined;
1316
+ }
1317
+ /**
1318
+ * @public
1319
+ */
1320
+ export interface GetModelInvocationLoggingConfigurationResponse {
1321
+ /**
1322
+ * <p>The current configuration values.</p>
1323
+ * @public
1324
+ */
1325
+ loggingConfig?: LoggingConfig | undefined;
1326
+ }
1327
+ /**
1328
+ * @public
1329
+ */
1330
+ export interface PutModelInvocationLoggingConfigurationRequest {
1331
+ /**
1332
+ * <p>The logging configuration values to set.</p>
1333
+ * @public
1334
+ */
1335
+ loggingConfig: LoggingConfig | undefined;
1336
+ }
1337
+ /**
1338
+ * @public
1339
+ */
1340
+ export interface PutModelInvocationLoggingConfigurationResponse {
1341
+ }
1342
+ /**
1343
+ * @public
1344
+ */
1345
+ export interface CreateModelCopyJobRequest {
1346
+ /**
1347
+ * <p>The Amazon Resource Name (ARN) of the model to be copied.</p>
1348
+ * @public
1349
+ */
1350
+ sourceModelArn: string | undefined;
1351
+ /**
1352
+ * <p>A name for the copied model.</p>
1353
+ * @public
1354
+ */
1355
+ targetModelName: string | undefined;
1356
+ /**
1357
+ * <p>The ARN of the KMS key that you use to encrypt the model copy.</p>
1358
+ * @public
1359
+ */
1360
+ modelKmsKeyId?: string | undefined;
1361
+ /**
1362
+ * <p>Tags to associate with the target model. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/tagging.html">Tag resources</a> in the <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html">Amazon Bedrock User Guide</a>.</p>
1363
+ * @public
1364
+ */
1365
+ targetModelTags?: Tag[] | undefined;
1366
+ /**
1367
+ * <p>A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</p>
1368
+ * @public
1369
+ */
1370
+ clientRequestToken?: string | undefined;
1371
+ }
1372
+ /**
1373
+ * @public
1374
+ */
1375
+ export interface CreateModelCopyJobResponse {
1376
+ /**
1377
+ * <p>The Amazon Resource Name (ARN) of the model copy job.</p>
1378
+ * @public
1379
+ */
1380
+ jobArn: string | undefined;
1381
+ }
1382
+ /**
1383
+ * @public
1384
+ */
1385
+ export interface GetModelCopyJobRequest {
1386
+ /**
1387
+ * <p>The Amazon Resource Name (ARN) of the model copy job.</p>
1388
+ * @public
1389
+ */
1390
+ jobArn: string | undefined;
1391
+ }
1392
+ /**
1393
+ * @public
1394
+ * @enum
1395
+ */
1396
+ export declare const ModelCopyJobStatus: {
1397
+ readonly COMPLETED: "Completed";
1398
+ readonly FAILED: "Failed";
1399
+ readonly IN_PROGRESS: "InProgress";
1400
+ };
1401
+ /**
1402
+ * @public
1403
+ */
1404
+ export type ModelCopyJobStatus = (typeof ModelCopyJobStatus)[keyof typeof ModelCopyJobStatus];
1405
+ /**
1406
+ * @public
1407
+ */
1408
+ export interface GetModelCopyJobResponse {
1409
+ /**
1410
+ * <p>The Amazon Resource Name (ARN) of the model copy job.</p>
1411
+ * @public
1412
+ */
1413
+ jobArn: string | undefined;
1414
+ /**
1415
+ * <p>The status of the model copy job.</p>
1416
+ * @public
1417
+ */
1418
+ status: ModelCopyJobStatus | undefined;
1419
+ /**
1420
+ * <p>The time at which the model copy job was created.</p>
1421
+ * @public
1422
+ */
1423
+ creationTime: Date | undefined;
1424
+ /**
1425
+ * <p>The Amazon Resource Name (ARN) of the copied model.</p>
1426
+ * @public
1427
+ */
1428
+ targetModelArn: string | undefined;
1429
+ /**
1430
+ * <p>The name of the copied model.</p>
1431
+ * @public
1432
+ */
1433
+ targetModelName?: string | undefined;
1434
+ /**
1435
+ * <p>The unique identifier of the account that the model being copied originated from.</p>
1436
+ * @public
1437
+ */
1438
+ sourceAccountId: string | undefined;
1439
+ /**
1440
+ * <p>The Amazon Resource Name (ARN) of the original model being copied.</p>
1441
+ * @public
1442
+ */
1443
+ sourceModelArn: string | undefined;
1444
+ /**
1445
+ * <p>The Amazon Resource Name (ARN) of the KMS key encrypting the copied model.</p>
1446
+ * @public
1447
+ */
1448
+ targetModelKmsKeyArn?: string | undefined;
1449
+ /**
1450
+ * <p>The tags associated with the copied model.</p>
1451
+ * @public
1452
+ */
1453
+ targetModelTags?: Tag[] | undefined;
1454
+ /**
1455
+ * <p>An error message for why the model copy job failed.</p>
1456
+ * @public
1457
+ */
1458
+ failureMessage?: string | undefined;
1459
+ /**
1460
+ * <p>The name of the original model being copied.</p>
1461
+ * @public
1462
+ */
1463
+ sourceModelName?: string | undefined;
1464
+ }
1465
+ /**
1466
+ * @public
1467
+ */
1468
+ export interface ListModelCopyJobsRequest {
1469
+ /**
1470
+ * <p>Filters for model copy jobs created after the specified time.</p>
1471
+ * @public
1472
+ */
1473
+ creationTimeAfter?: Date | undefined;
1474
+ /**
1475
+ * <p>Filters for model copy jobs created before the specified time. </p>
1476
+ * @public
1477
+ */
1478
+ creationTimeBefore?: Date | undefined;
1479
+ /**
1480
+ * <p>Filters for model copy jobs whose status matches the value that you specify.</p>
1481
+ * @public
1482
+ */
1483
+ statusEquals?: ModelCopyJobStatus | undefined;
1484
+ /**
1485
+ * <p>Filters for model copy jobs in which the account that the source model belongs to is equal to the value that you specify.</p>
1486
+ * @public
1487
+ */
1488
+ sourceAccountEquals?: string | undefined;
1489
+ /**
1490
+ * <p>Filters for model copy jobs in which the Amazon Resource Name (ARN) of the source model to is equal to the value that you specify.</p>
1491
+ * @public
1492
+ */
1493
+ sourceModelArnEquals?: string | undefined;
1494
+ /**
1495
+ * <p>Filters for model copy jobs in which the name of the copied model contains the string that you specify.</p>
1496
+ * @public
1497
+ */
1498
+ targetModelNameContains?: string | undefined;
1499
+ /**
1500
+ * <p>The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the <code>nextToken</code> field when making another request to return the next batch of results.</p>
1501
+ * @public
1502
+ */
1503
+ maxResults?: number | undefined;
1504
+ /**
1505
+ * <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, enter the token returned in the <code>nextToken</code> field in the response in this field to return the next batch of results.</p>
1506
+ * @public
1507
+ */
1508
+ nextToken?: string | undefined;
1509
+ /**
1510
+ * <p>The field to sort by in the returned list of model copy jobs.</p>
1511
+ * @public
1512
+ */
1513
+ sortBy?: SortJobsBy | undefined;
1514
+ /**
1515
+ * <p>Specifies whether to sort the results in ascending or descending order.</p>
1516
+ * @public
1517
+ */
1518
+ sortOrder?: SortOrder | undefined;
1519
+ }
1520
+ /**
1521
+ * <p>Contains details about each model copy job.</p> <p>This data type is used in the following API operations:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_ListModelCopyJobs.html#API_ListModelCopyJobs_ResponseSyntax">ListModelCopyJobs response</a> </p> </li> </ul>
1522
+ * @public
1523
+ */
1524
+ export interface ModelCopyJobSummary {
1525
+ /**
1526
+ * <p>The Amazon Resoource Name (ARN) of the model copy job.</p>
1527
+ * @public
1528
+ */
1529
+ jobArn: string | undefined;
1530
+ /**
1531
+ * <p>The status of the model copy job.</p>
1532
+ * @public
1533
+ */
1534
+ status: ModelCopyJobStatus | undefined;
1535
+ /**
1536
+ * <p>The time that the model copy job was created.</p>
1537
+ * @public
1538
+ */
1539
+ creationTime: Date | undefined;
1540
+ /**
1541
+ * <p>The Amazon Resource Name (ARN) of the copied model.</p>
1542
+ * @public
1543
+ */
1544
+ targetModelArn: string | undefined;
1545
+ /**
1546
+ * <p>The name of the copied model.</p>
1547
+ * @public
1548
+ */
1549
+ targetModelName?: string | undefined;
1550
+ /**
1551
+ * <p>The unique identifier of the account that the model being copied originated from.</p>
1552
+ * @public
1553
+ */
1554
+ sourceAccountId: string | undefined;
1555
+ /**
1556
+ * <p>The Amazon Resource Name (ARN) of the original model being copied.</p>
1557
+ * @public
1558
+ */
1559
+ sourceModelArn: string | undefined;
1560
+ /**
1561
+ * <p>The Amazon Resource Name (ARN) of the KMS key used to encrypt the copied model.</p>
1562
+ * @public
1563
+ */
1564
+ targetModelKmsKeyArn?: string | undefined;
1565
+ /**
1566
+ * <p>Tags associated with the copied model.</p>
1567
+ * @public
1568
+ */
1569
+ targetModelTags?: Tag[] | undefined;
1570
+ /**
1571
+ * <p>If a model fails to be copied, a message describing why the job failed is included here.</p>
1572
+ * @public
1573
+ */
1574
+ failureMessage?: string | undefined;
1575
+ /**
1576
+ * <p>The name of the original model being copied.</p>
1577
+ * @public
1578
+ */
1579
+ sourceModelName?: string | undefined;
1580
+ }
1581
+ /**
1582
+ * @public
1583
+ */
1584
+ export interface ListModelCopyJobsResponse {
1585
+ /**
1586
+ * <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, use this token when making another request in the <code>nextToken</code> field to return the next batch of results.</p>
1587
+ * @public
1588
+ */
1589
+ nextToken?: string | undefined;
1590
+ /**
1591
+ * <p>A list of information about each model copy job.</p>
1592
+ * @public
1593
+ */
1594
+ modelCopyJobSummaries?: ModelCopyJobSummary[] | undefined;
1595
+ }
1596
+ /**
1597
+ * @public
1598
+ */
1599
+ export interface CreateModelImportJobRequest {
1600
+ /**
1601
+ * <p>The name of the import job.</p>
1602
+ * @public
1603
+ */
1604
+ jobName: string | undefined;
1605
+ /**
1606
+ * <p>The name of the imported model.</p>
1607
+ * @public
1608
+ */
1609
+ importedModelName: string | undefined;
1610
+ /**
1611
+ * <p>The Amazon Resource Name (ARN) of the model import job.</p>
1612
+ * @public
1613
+ */
1614
+ roleArn: string | undefined;
1615
+ /**
1616
+ * <p>The data source for the imported model.</p>
1617
+ * @public
1618
+ */
1619
+ modelDataSource: ModelDataSource | undefined;
1620
+ /**
1621
+ * <p>Tags to attach to this import job. </p>
1622
+ * @public
1623
+ */
1624
+ jobTags?: Tag[] | undefined;
1625
+ /**
1626
+ * <p>Tags to attach to the imported model.</p>
1627
+ * @public
1628
+ */
1629
+ importedModelTags?: Tag[] | undefined;
1630
+ /**
1631
+ * <p>A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</p>
1632
+ * @public
1633
+ */
1634
+ clientRequestToken?: string | undefined;
1635
+ /**
1636
+ * <p>VPC configuration parameters for the private Virtual Private Cloud (VPC) that contains the resources you are using for the import job.</p>
1637
+ * @public
1638
+ */
1639
+ vpcConfig?: VpcConfig | undefined;
1640
+ /**
1641
+ * <p>The imported model is encrypted at rest using this key.</p>
1642
+ * @public
1643
+ */
1644
+ importedModelKmsKeyId?: string | undefined;
1645
+ }
1646
+ /**
1647
+ * @public
1648
+ */
1649
+ export interface CreateModelImportJobResponse {
1650
+ /**
1651
+ * <p>The Amazon Resource Name (ARN) of the model import job.</p>
1652
+ * @public
1653
+ */
1654
+ jobArn: string | undefined;
1655
+ }
1656
+ /**
1657
+ * @public
1658
+ */
1659
+ export interface DeleteImportedModelRequest {
1660
+ /**
1661
+ * <p>Name of the imported model to delete.</p>
1662
+ * @public
1663
+ */
1664
+ modelIdentifier: string | undefined;
1665
+ }
1666
+ /**
1667
+ * @public
1668
+ */
1669
+ export interface DeleteImportedModelResponse {
1670
+ }
1671
+ /**
1672
+ * @public
1673
+ */
1674
+ export interface GetImportedModelRequest {
1675
+ /**
1676
+ * <p>Name or Amazon Resource Name (ARN) of the imported model.</p>
1677
+ * @public
1678
+ */
1679
+ modelIdentifier: string | undefined;
1680
+ }
1681
+ /**
1682
+ * <p>A <code>CustomModelUnit</code> (CMU) is an abstract view of the hardware utilization that Amazon Bedrock needs to host a single copy of your custom model. A model copy represents a single instance of your imported model that is ready to serve inference requests. Amazon Bedrock determines the number of custom model units that a model copy needs when you import the custom model. </p> <p>You can use <code>CustomModelUnits</code> to estimate the cost of running your custom model. For more information, see Calculate the cost of running a custom model in the Amazon Bedrock user guide. </p>
1683
+ * @public
1684
+ */
1685
+ export interface CustomModelUnits {
1686
+ /**
1687
+ * <p>The number of custom model units used to host a model copy. </p>
1688
+ * @public
1689
+ */
1690
+ customModelUnitsPerModelCopy?: number | undefined;
1691
+ /**
1692
+ * <p>The version of the custom model unit. Use to determine the billing rate for the custom model unit.</p>
1693
+ * @public
1694
+ */
1695
+ customModelUnitsVersion?: string | undefined;
1696
+ }
1697
+ /**
1698
+ * @public
1699
+ */
1700
+ export interface GetImportedModelResponse {
1701
+ /**
1702
+ * <p>The Amazon Resource Name (ARN) associated with this imported model.</p>
1703
+ * @public
1704
+ */
1705
+ modelArn?: string | undefined;
1706
+ /**
1707
+ * <p>The name of the imported model.</p>
1708
+ * @public
1709
+ */
1710
+ modelName?: string | undefined;
1711
+ /**
1712
+ * <p>Job name associated with the imported model.</p>
1713
+ * @public
1714
+ */
1715
+ jobName?: string | undefined;
1716
+ /**
1717
+ * <p>Job Amazon Resource Name (ARN) associated with the imported model.</p>
1718
+ * @public
1719
+ */
1720
+ jobArn?: string | undefined;
1721
+ /**
1722
+ * <p>The data source for this imported model.</p>
1723
+ * @public
1724
+ */
1725
+ modelDataSource?: ModelDataSource | undefined;
1726
+ /**
1727
+ * <p>Creation time of the imported model.</p>
1728
+ * @public
1729
+ */
1730
+ creationTime?: Date | undefined;
1731
+ /**
1732
+ * <p>The architecture of the imported model.</p>
1733
+ * @public
1734
+ */
1735
+ modelArchitecture?: string | undefined;
1736
+ /**
1737
+ * <p>The imported model is encrypted at rest using this key.</p>
1738
+ * @public
1739
+ */
1740
+ modelKmsKeyArn?: string | undefined;
1741
+ /**
1742
+ * <p>Specifies if the imported model supports converse.</p>
1743
+ * @public
1744
+ */
1745
+ instructSupported?: boolean | undefined;
1746
+ /**
1747
+ * <p>Information about the hardware utilization for a single copy of the model.</p>
1748
+ * @public
1749
+ */
1750
+ customModelUnits?: CustomModelUnits | undefined;
1751
+ }
1752
+ /**
1753
+ * @public
1754
+ */
1755
+ export interface GetModelImportJobRequest {
1756
+ /**
1757
+ * <p>The identifier of the import job.</p>
1758
+ * @public
1759
+ */
1760
+ jobIdentifier: string | undefined;
1761
+ }
1762
+ /**
1763
+ * @public
1764
+ * @enum
1765
+ */
1766
+ export declare const ModelImportJobStatus: {
1767
+ readonly COMPLETED: "Completed";
1768
+ readonly FAILED: "Failed";
1769
+ readonly IN_PROGRESS: "InProgress";
1770
+ };
1771
+ /**
1772
+ * @public
1773
+ */
1774
+ export type ModelImportJobStatus = (typeof ModelImportJobStatus)[keyof typeof ModelImportJobStatus];
1775
+ /**
1776
+ * @public
1777
+ */
1778
+ export interface GetModelImportJobResponse {
1779
+ /**
1780
+ * <p>The Amazon Resource Name (ARN) of the import job.</p>
1781
+ * @public
1782
+ */
1783
+ jobArn?: string | undefined;
1784
+ /**
1785
+ * <p>The name of the import job.</p>
1786
+ * @public
1787
+ */
1788
+ jobName?: string | undefined;
1789
+ /**
1790
+ * <p>The name of the imported model.</p>
1791
+ * @public
1792
+ */
1793
+ importedModelName?: string | undefined;
1794
+ /**
1795
+ * <p>The Amazon Resource Name (ARN) of the imported model.</p>
1796
+ * @public
1797
+ */
1798
+ importedModelArn?: string | undefined;
1799
+ /**
1800
+ * <p>The Amazon Resource Name (ARN) of the IAM role associated with this job.</p>
1801
+ * @public
1802
+ */
1803
+ roleArn?: string | undefined;
1804
+ /**
1805
+ * <p>The data source for the imported model.</p>
1806
+ * @public
1807
+ */
1808
+ modelDataSource?: ModelDataSource | undefined;
1809
+ /**
1810
+ * <p>The status of the job. A successful job transitions from in-progress to completed when the imported model is ready to use. If the job failed, the failure message contains information about why the job failed.</p>
1811
+ * @public
1812
+ */
1813
+ status?: ModelImportJobStatus | undefined;
1814
+ /**
1815
+ * <p>Information about why the import job failed.</p>
1816
+ * @public
1817
+ */
1818
+ failureMessage?: string | undefined;
1819
+ /**
1820
+ * <p>The time the resource was created.</p>
1821
+ * @public
1822
+ */
1823
+ creationTime?: Date | undefined;
1824
+ /**
1825
+ * <p>Time the resource was last modified.</p>
1826
+ * @public
1827
+ */
1828
+ lastModifiedTime?: Date | undefined;
1829
+ /**
1830
+ * <p>Time that the resource transitioned to terminal state.</p>
1831
+ * @public
1832
+ */
1833
+ endTime?: Date | undefined;
1834
+ /**
1835
+ * <p>The Virtual Private Cloud (VPC) configuration of the import model job.</p>
1836
+ * @public
1837
+ */
1838
+ vpcConfig?: VpcConfig | undefined;
1839
+ /**
1840
+ * <p>The imported model is encrypted at rest using this key.</p>
1841
+ * @public
1842
+ */
1843
+ importedModelKmsKeyArn?: string | undefined;
1844
+ }
1845
+ /**
1846
+ * @public
1847
+ */
1848
+ export interface ListImportedModelsRequest {
1849
+ /**
1850
+ * <p>Return imported models that created before the specified time.</p>
1851
+ * @public
1852
+ */
1853
+ creationTimeBefore?: Date | undefined;
1854
+ /**
1855
+ * <p>Return imported models that were created after the specified time.</p>
1856
+ * @public
1857
+ */
1858
+ creationTimeAfter?: Date | undefined;
1859
+ /**
1860
+ * <p>Return imported models only if the model name contains these characters.</p>
1861
+ * @public
1862
+ */
1863
+ nameContains?: string | undefined;
1864
+ /**
1865
+ * <p>The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the <code>nextToken</code> field when making another request to return the next batch of results.</p>
1866
+ * @public
1867
+ */
1868
+ maxResults?: number | undefined;
1869
+ /**
1870
+ * <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, enter the token returned in the <code>nextToken</code> field in the response in this field to return the next batch of results.</p>
1871
+ * @public
1872
+ */
1873
+ nextToken?: string | undefined;
1874
+ /**
1875
+ * <p>The field to sort by in the returned list of imported models.</p>
1876
+ * @public
1877
+ */
1878
+ sortBy?: SortModelsBy | undefined;
1879
+ /**
1880
+ * <p>Specifies whetehr to sort the results in ascending or descending order.</p>
1881
+ * @public
1882
+ */
1883
+ sortOrder?: SortOrder | undefined;
1884
+ }
1885
+ /**
1886
+ * <p>Information about the imported model.</p>
1887
+ * @public
1888
+ */
1889
+ export interface ImportedModelSummary {
1890
+ /**
1891
+ * <p>The Amazon Resource Name (ARN) of the imported model.</p>
1892
+ * @public
1893
+ */
1894
+ modelArn: string | undefined;
1895
+ /**
1896
+ * <p>Name of the imported model.</p>
1897
+ * @public
1898
+ */
1899
+ modelName: string | undefined;
1900
+ /**
1901
+ * <p>Creation time of the imported model.</p>
1902
+ * @public
1903
+ */
1904
+ creationTime: Date | undefined;
1905
+ /**
1906
+ * <p>Specifies if the imported model supports converse.</p>
1907
+ * @public
1908
+ */
1909
+ instructSupported?: boolean | undefined;
1910
+ /**
1911
+ * <p>The architecture of the imported model.</p>
1912
+ * @public
1913
+ */
1914
+ modelArchitecture?: string | undefined;
1915
+ }
1916
+ /**
1917
+ * @public
1918
+ */
1919
+ export interface ListImportedModelsResponse {
1920
+ /**
1921
+ * <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, use this token when making another request in the <code>nextToken</code> field to return the next batch of results.</p>
1922
+ * @public
1923
+ */
1924
+ nextToken?: string | undefined;
1925
+ /**
1926
+ * <p>Model summaries.</p>
1927
+ * @public
1928
+ */
1929
+ modelSummaries?: ImportedModelSummary[] | undefined;
1930
+ }
1931
+ /**
1932
+ * @public
1933
+ */
1934
+ export interface ListModelImportJobsRequest {
1935
+ /**
1936
+ * <p>Return import jobs that were created after the specified time.</p>
1937
+ * @public
1938
+ */
1939
+ creationTimeAfter?: Date | undefined;
1940
+ /**
1941
+ * <p>Return import jobs that were created before the specified time.</p>
1942
+ * @public
1943
+ */
1944
+ creationTimeBefore?: Date | undefined;
1945
+ /**
1946
+ * <p>Return imported jobs with the specified status.</p>
1947
+ * @public
1948
+ */
1949
+ statusEquals?: ModelImportJobStatus | undefined;
1950
+ /**
1951
+ * <p>Return imported jobs only if the job name contains these characters.</p>
1952
+ * @public
1953
+ */
1954
+ nameContains?: string | undefined;
1955
+ /**
1956
+ * <p>The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the <code>nextToken</code> field when making another request to return the next batch of results.</p>
1957
+ * @public
1958
+ */
1959
+ maxResults?: number | undefined;
1960
+ /**
1961
+ * <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, enter the token returned in the <code>nextToken</code> field in the response in this field to return the next batch of results.</p>
1962
+ * @public
1963
+ */
1964
+ nextToken?: string | undefined;
1965
+ /**
1966
+ * <p>The field to sort by in the returned list of imported jobs.</p>
1967
+ * @public
1968
+ */
1969
+ sortBy?: SortJobsBy | undefined;
1970
+ /**
1971
+ * <p>Specifies whether to sort the results in ascending or descending order.</p>
1972
+ * @public
1973
+ */
1974
+ sortOrder?: SortOrder | undefined;
1975
+ }
1976
+ /**
1977
+ * <p>Information about the import job.</p>
1978
+ * @public
1979
+ */
1980
+ export interface ModelImportJobSummary {
1981
+ /**
1982
+ * <p>The Amazon Resource Name (ARN) of the import job.</p>
1983
+ * @public
1984
+ */
1985
+ jobArn: string | undefined;
1986
+ /**
1987
+ * <p>The name of the import job.</p>
1988
+ * @public
1989
+ */
1990
+ jobName: string | undefined;
1991
+ /**
1992
+ * <p>The status of the imported job. </p>
1993
+ * @public
1994
+ */
1995
+ status: ModelImportJobStatus | undefined;
1996
+ /**
1997
+ * <p>The time when the import job was last modified.</p>
1998
+ * @public
1999
+ */
2000
+ lastModifiedTime?: Date | undefined;
2001
+ /**
2002
+ * <p>The time import job was created.</p>
2003
+ * @public
2004
+ */
2005
+ creationTime: Date | undefined;
2006
+ /**
2007
+ * <p>The time when import job ended.</p>
2008
+ * @public
2009
+ */
2010
+ endTime?: Date | undefined;
2011
+ /**
2012
+ * <p>The Amazon resource Name (ARN) of the imported model.</p>
2013
+ * @public
2014
+ */
2015
+ importedModelArn?: string | undefined;
2016
+ /**
2017
+ * <p>The name of the imported model.</p>
2018
+ * @public
2019
+ */
2020
+ importedModelName?: string | undefined;
2021
+ }
2022
+ /**
2023
+ * @public
2024
+ */
2025
+ export interface ListModelImportJobsResponse {
2026
+ /**
2027
+ * <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, enter the token returned in the <code>nextToken</code> field in the response in this field to return the next batch of results.</p>
2028
+ * @public
2029
+ */
2030
+ nextToken?: string | undefined;
2031
+ /**
2032
+ * <p>Import job summaries.</p>
2033
+ * @public
2034
+ */
2035
+ modelImportJobSummaries?: ModelImportJobSummary[] | undefined;
2036
+ }
2037
+ /**
2038
+ * @public
2039
+ * @enum
2040
+ */
2041
+ export declare const S3InputFormat: {
2042
+ readonly JSONL: "JSONL";
2043
+ };
2044
+ /**
2045
+ * @public
2046
+ */
2047
+ export type S3InputFormat = (typeof S3InputFormat)[keyof typeof S3InputFormat];
2048
+ /**
2049
+ * <p>Contains the configuration of the S3 location of the input data.</p>
2050
+ * @public
2051
+ */
2052
+ export interface ModelInvocationJobS3InputDataConfig {
2053
+ /**
2054
+ * <p>The format of the input data.</p>
2055
+ * @public
2056
+ */
2057
+ s3InputFormat?: S3InputFormat | undefined;
2058
+ /**
2059
+ * <p>The S3 location of the input data.</p>
2060
+ * @public
2061
+ */
2062
+ s3Uri: string | undefined;
2063
+ /**
2064
+ * <p>The ID of the Amazon Web Services account that owns the S3 bucket containing the input data.</p>
2065
+ * @public
2066
+ */
2067
+ s3BucketOwner?: string | undefined;
2068
+ }
2069
+ /**
2070
+ * <p>Details about the location of the input to the batch inference job.</p>
2071
+ * @public
2072
+ */
2073
+ export type ModelInvocationJobInputDataConfig = ModelInvocationJobInputDataConfig.S3InputDataConfigMember | ModelInvocationJobInputDataConfig.$UnknownMember;
2074
+ /**
2075
+ * @public
2076
+ */
2077
+ export declare namespace ModelInvocationJobInputDataConfig {
2078
+ /**
2079
+ * <p>Contains the configuration of the S3 location of the input data.</p>
2080
+ * @public
2081
+ */
2082
+ interface S3InputDataConfigMember {
2083
+ s3InputDataConfig: ModelInvocationJobS3InputDataConfig;
2084
+ $unknown?: never;
2085
+ }
2086
+ /**
2087
+ * @public
2088
+ */
2089
+ interface $UnknownMember {
2090
+ s3InputDataConfig?: never;
2091
+ $unknown: [string, any];
2092
+ }
2093
+ interface Visitor<T> {
2094
+ s3InputDataConfig: (value: ModelInvocationJobS3InputDataConfig) => T;
2095
+ _: (name: string, value: any) => T;
2096
+ }
2097
+ const visit: <T>(value: ModelInvocationJobInputDataConfig, visitor: Visitor<T>) => T;
2098
+ }
2099
+ /**
2100
+ * <p>Contains the configuration of the S3 location of the output data.</p>
2101
+ * @public
2102
+ */
2103
+ export interface ModelInvocationJobS3OutputDataConfig {
2104
+ /**
2105
+ * <p>The S3 location of the output data.</p>
2106
+ * @public
2107
+ */
2108
+ s3Uri: string | undefined;
2109
+ /**
2110
+ * <p>The unique identifier of the key that encrypts the S3 location of the output data.</p>
2111
+ * @public
2112
+ */
2113
+ s3EncryptionKeyId?: string | undefined;
2114
+ /**
2115
+ * <p>The ID of the Amazon Web Services account that owns the S3 bucket containing the output data.</p>
2116
+ * @public
2117
+ */
2118
+ s3BucketOwner?: string | undefined;
2119
+ }
2120
+ /**
2121
+ * <p>Contains the configuration of the S3 location of the output data.</p>
2122
+ * @public
2123
+ */
2124
+ export type ModelInvocationJobOutputDataConfig = ModelInvocationJobOutputDataConfig.S3OutputDataConfigMember | ModelInvocationJobOutputDataConfig.$UnknownMember;
2125
+ /**
2126
+ * @public
2127
+ */
2128
+ export declare namespace ModelInvocationJobOutputDataConfig {
2129
+ /**
2130
+ * <p>Contains the configuration of the S3 location of the output data.</p>
2131
+ * @public
2132
+ */
2133
+ interface S3OutputDataConfigMember {
2134
+ s3OutputDataConfig: ModelInvocationJobS3OutputDataConfig;
2135
+ $unknown?: never;
2136
+ }
2137
+ /**
2138
+ * @public
2139
+ */
2140
+ interface $UnknownMember {
2141
+ s3OutputDataConfig?: never;
2142
+ $unknown: [string, any];
2143
+ }
2144
+ interface Visitor<T> {
2145
+ s3OutputDataConfig: (value: ModelInvocationJobS3OutputDataConfig) => T;
2146
+ _: (name: string, value: any) => T;
2147
+ }
2148
+ const visit: <T>(value: ModelInvocationJobOutputDataConfig, visitor: Visitor<T>) => T;
2149
+ }
2150
+ /**
2151
+ * @public
2152
+ */
2153
+ export interface CreateModelInvocationJobRequest {
2154
+ /**
2155
+ * <p>A name to give the batch inference job.</p>
2156
+ * @public
2157
+ */
2158
+ jobName: string | undefined;
2159
+ /**
2160
+ * <p>The Amazon Resource Name (ARN) of the service role with permissions to carry out and manage batch inference. You can use the console to create a default service role or follow the steps at <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/batch-iam-sr.html">Create a service role for batch inference</a>.</p>
2161
+ * @public
2162
+ */
2163
+ roleArn: string | undefined;
2164
+ /**
2165
+ * <p>A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</p>
2166
+ * @public
2167
+ */
2168
+ clientRequestToken?: string | undefined;
2169
+ /**
2170
+ * <p>The unique identifier of the foundation model to use for the batch inference job.</p>
2171
+ * @public
2172
+ */
2173
+ modelId: string | undefined;
2174
+ /**
2175
+ * <p>Details about the location of the input to the batch inference job.</p>
2176
+ * @public
2177
+ */
2178
+ inputDataConfig: ModelInvocationJobInputDataConfig | undefined;
2179
+ /**
2180
+ * <p>Details about the location of the output of the batch inference job.</p>
2181
+ * @public
2182
+ */
2183
+ outputDataConfig: ModelInvocationJobOutputDataConfig | undefined;
2184
+ /**
2185
+ * <p>The configuration of the Virtual Private Cloud (VPC) for the data in the batch inference job. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/batch-vpc">Protect batch inference jobs using a VPC</a>.</p>
2186
+ * @public
2187
+ */
2188
+ vpcConfig?: VpcConfig | undefined;
2189
+ /**
2190
+ * <p>The number of hours after which to force the batch inference job to time out.</p>
2191
+ * @public
2192
+ */
2193
+ timeoutDurationInHours?: number | undefined;
2194
+ /**
2195
+ * <p>Any tags to associate with the batch inference job. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/tagging.html">Tagging Amazon Bedrock resources</a>.</p>
2196
+ * @public
2197
+ */
2198
+ tags?: Tag[] | undefined;
2199
+ }
2200
+ /**
2201
+ * @public
2202
+ */
2203
+ export interface CreateModelInvocationJobResponse {
2204
+ /**
2205
+ * <p>The Amazon Resource Name (ARN) of the batch inference job.</p>
2206
+ * @public
2207
+ */
2208
+ jobArn: string | undefined;
2209
+ }
2210
+ /**
2211
+ * @public
2212
+ */
2213
+ export interface GetModelInvocationJobRequest {
2214
+ /**
2215
+ * <p>The Amazon Resource Name (ARN) of the batch inference job.</p>
2216
+ * @public
2217
+ */
2218
+ jobIdentifier: string | undefined;
2219
+ }
2220
+ /**
2221
+ * @public
2222
+ * @enum
2223
+ */
2224
+ export declare const ModelInvocationJobStatus: {
2225
+ readonly COMPLETED: "Completed";
2226
+ readonly EXPIRED: "Expired";
2227
+ readonly FAILED: "Failed";
2228
+ readonly IN_PROGRESS: "InProgress";
2229
+ readonly PARTIALLY_COMPLETED: "PartiallyCompleted";
2230
+ readonly SCHEDULED: "Scheduled";
2231
+ readonly STOPPED: "Stopped";
2232
+ readonly STOPPING: "Stopping";
2233
+ readonly SUBMITTED: "Submitted";
2234
+ readonly VALIDATING: "Validating";
2235
+ };
2236
+ /**
2237
+ * @public
2238
+ */
2239
+ export type ModelInvocationJobStatus = (typeof ModelInvocationJobStatus)[keyof typeof ModelInvocationJobStatus];
2240
+ /**
2241
+ * @public
2242
+ */
2243
+ export interface GetModelInvocationJobResponse {
2244
+ /**
2245
+ * <p>The Amazon Resource Name (ARN) of the batch inference job.</p>
2246
+ * @public
2247
+ */
2248
+ jobArn: string | undefined;
2249
+ /**
2250
+ * <p>The name of the batch inference job.</p>
2251
+ * @public
2252
+ */
2253
+ jobName?: string | undefined;
2254
+ /**
2255
+ * <p>The unique identifier of the foundation model used for model inference.</p>
2256
+ * @public
2257
+ */
2258
+ modelId: string | undefined;
2259
+ /**
2260
+ * <p>A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</p>
2261
+ * @public
2262
+ */
2263
+ clientRequestToken?: string | undefined;
2264
+ /**
2265
+ * <p>The Amazon Resource Name (ARN) of the service role with permissions to carry out and manage batch inference. You can use the console to create a default service role or follow the steps at <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/batch-iam-sr.html">Create a service role for batch inference</a>.</p>
2266
+ * @public
2267
+ */
2268
+ roleArn: string | undefined;
2269
+ /**
2270
+ * <p>The status of the batch inference job.</p> <p>The following statuses are possible:</p> <ul> <li> <p>Submitted – This job has been submitted to a queue for validation.</p> </li> <li> <p>Validating – This job is being validated for the requirements described in <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/batch-inference-data.html">Format and upload your batch inference data</a>. The criteria include the following:</p> <ul> <li> <p>Your IAM service role has access to the Amazon S3 buckets containing your files.</p> </li> <li> <p>Your files are .jsonl files and each individual record is a JSON object in the correct format. Note that validation doesn't check if the <code>modelInput</code> value matches the request body for the model.</p> </li> <li> <p>Your files fulfill the requirements for file size and number of records. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/quotas.html">Quotas for Amazon Bedrock</a>.</p> </li> </ul> </li> <li> <p>Scheduled – This job has been validated and is now in a queue. The job will automatically start when it reaches its turn.</p> </li> <li> <p>Expired – This job timed out because it was scheduled but didn't begin before the set timeout duration. Submit a new job request.</p> </li> <li> <p>InProgress – This job has begun. You can start viewing the results in the output S3 location.</p> </li> <li> <p>Completed – This job has successfully completed. View the output files in the output S3 location.</p> </li> <li> <p>PartiallyCompleted – This job has partially completed. Not all of your records could be processed in time. View the output files in the output S3 location.</p> </li> <li> <p>Failed – This job has failed. Check the failure message for any further details. For further assistance, reach out to the <a href="https://console.aws.amazon.com/support/home/">Amazon Web ServicesSupport Center</a>.</p> </li> <li> <p>Stopped – This job was stopped by a user.</p> </li> <li> <p>Stopping – This job is being stopped by a user.</p> </li> </ul>
2271
+ * @public
2272
+ */
2273
+ status?: ModelInvocationJobStatus | undefined;
2274
+ /**
2275
+ * <p>If the batch inference job failed, this field contains a message describing why the job failed.</p>
2276
+ * @public
2277
+ */
2278
+ message?: string | undefined;
2279
+ /**
2280
+ * <p>The time at which the batch inference job was submitted.</p>
2281
+ * @public
2282
+ */
2283
+ submitTime: Date | undefined;
2284
+ /**
2285
+ * <p>The time at which the batch inference job was last modified.</p>
2286
+ * @public
2287
+ */
2288
+ lastModifiedTime?: Date | undefined;
2289
+ /**
2290
+ * <p>The time at which the batch inference job ended.</p>
2291
+ * @public
2292
+ */
2293
+ endTime?: Date | undefined;
2294
+ /**
2295
+ * <p>Details about the location of the input to the batch inference job.</p>
2296
+ * @public
2297
+ */
2298
+ inputDataConfig: ModelInvocationJobInputDataConfig | undefined;
2299
+ /**
2300
+ * <p>Details about the location of the output of the batch inference job.</p>
2301
+ * @public
2302
+ */
2303
+ outputDataConfig: ModelInvocationJobOutputDataConfig | undefined;
2304
+ /**
2305
+ * <p>The configuration of the Virtual Private Cloud (VPC) for the data in the batch inference job. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/batch-vpc">Protect batch inference jobs using a VPC</a>.</p>
2306
+ * @public
2307
+ */
2308
+ vpcConfig?: VpcConfig | undefined;
2309
+ /**
2310
+ * <p>The number of hours after which batch inference job was set to time out.</p>
2311
+ * @public
2312
+ */
2313
+ timeoutDurationInHours?: number | undefined;
2314
+ /**
2315
+ * <p>The time at which the batch inference job times or timed out.</p>
2316
+ * @public
2317
+ */
2318
+ jobExpirationTime?: Date | undefined;
2319
+ }
2320
+ /**
2321
+ * @public
2322
+ */
2323
+ export interface ListModelInvocationJobsRequest {
2324
+ /**
2325
+ * <p>Specify a time to filter for batch inference jobs that were submitted after the time you specify.</p>
2326
+ * @public
2327
+ */
2328
+ submitTimeAfter?: Date | undefined;
2329
+ /**
2330
+ * <p>Specify a time to filter for batch inference jobs that were submitted before the time you specify.</p>
2331
+ * @public
2332
+ */
2333
+ submitTimeBefore?: Date | undefined;
2334
+ /**
2335
+ * <p>Specify a status to filter for batch inference jobs whose statuses match the string you specify.</p> <p>The following statuses are possible:</p> <ul> <li> <p>Submitted – This job has been submitted to a queue for validation.</p> </li> <li> <p>Validating – This job is being validated for the requirements described in <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/batch-inference-data.html">Format and upload your batch inference data</a>. The criteria include the following:</p> <ul> <li> <p>Your IAM service role has access to the Amazon S3 buckets containing your files.</p> </li> <li> <p>Your files are .jsonl files and each individual record is a JSON object in the correct format. Note that validation doesn't check if the <code>modelInput</code> value matches the request body for the model.</p> </li> <li> <p>Your files fulfill the requirements for file size and number of records. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/quotas.html">Quotas for Amazon Bedrock</a>.</p> </li> </ul> </li> <li> <p>Scheduled – This job has been validated and is now in a queue. The job will automatically start when it reaches its turn.</p> </li> <li> <p>Expired – This job timed out because it was scheduled but didn't begin before the set timeout duration. Submit a new job request.</p> </li> <li> <p>InProgress – This job has begun. You can start viewing the results in the output S3 location.</p> </li> <li> <p>Completed – This job has successfully completed. View the output files in the output S3 location.</p> </li> <li> <p>PartiallyCompleted – This job has partially completed. Not all of your records could be processed in time. View the output files in the output S3 location.</p> </li> <li> <p>Failed – This job has failed. Check the failure message for any further details. For further assistance, reach out to the <a href="https://console.aws.amazon.com/support/home/">Amazon Web ServicesSupport Center</a>.</p> </li> <li> <p>Stopped – This job was stopped by a user.</p> </li> <li> <p>Stopping – This job is being stopped by a user.</p> </li> </ul>
2336
+ * @public
2337
+ */
2338
+ statusEquals?: ModelInvocationJobStatus | undefined;
2339
+ /**
2340
+ * <p>Specify a string to filter for batch inference jobs whose names contain the string.</p>
2341
+ * @public
2342
+ */
2343
+ nameContains?: string | undefined;
2344
+ /**
2345
+ * <p>The maximum number of results to return. If there are more results than the number that you specify, a <code>nextToken</code> value is returned. Use the <code>nextToken</code> in a request to return the next batch of results.</p>
2346
+ * @public
2347
+ */
2348
+ maxResults?: number | undefined;
2349
+ /**
2350
+ * <p>If there were more results than the value you specified in the <code>maxResults</code> field in a previous <code>ListModelInvocationJobs</code> request, the response would have returned a <code>nextToken</code> value. To see the next batch of results, send the <code>nextToken</code> value in another request.</p>
2351
+ * @public
2352
+ */
2353
+ nextToken?: string | undefined;
2354
+ /**
2355
+ * <p>An attribute by which to sort the results.</p>
2356
+ * @public
2357
+ */
2358
+ sortBy?: SortJobsBy | undefined;
2359
+ /**
2360
+ * <p>Specifies whether to sort the results by ascending or descending order.</p>
2361
+ * @public
2362
+ */
2363
+ sortOrder?: SortOrder | undefined;
2364
+ }
2365
+ /**
2366
+ * <p>A summary of a batch inference job.</p>
2367
+ * @public
2368
+ */
2369
+ export interface ModelInvocationJobSummary {
2370
+ /**
2371
+ * <p>The Amazon Resource Name (ARN) of the batch inference job.</p>
2372
+ * @public
2373
+ */
2374
+ jobArn: string | undefined;
2375
+ /**
2376
+ * <p>The name of the batch inference job.</p>
2377
+ * @public
2378
+ */
2379
+ jobName: string | undefined;
2380
+ /**
2381
+ * <p>The unique identifier of the foundation model used for model inference.</p>
2382
+ * @public
2383
+ */
2384
+ modelId: string | undefined;
2385
+ /**
2386
+ * <p>A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</p>
2387
+ * @public
2388
+ */
2389
+ clientRequestToken?: string | undefined;
2390
+ /**
2391
+ * <p>The Amazon Resource Name (ARN) of the service role with permissions to carry out and manage batch inference. You can use the console to create a default service role or follow the steps at <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/batch-iam-sr.html">Create a service role for batch inference</a>.</p>
2392
+ * @public
2393
+ */
2394
+ roleArn: string | undefined;
2395
+ /**
2396
+ * <p>The status of the batch inference job.</p> <p>The following statuses are possible:</p> <ul> <li> <p>Submitted – This job has been submitted to a queue for validation.</p> </li> <li> <p>Validating – This job is being validated for the requirements described in <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/batch-inference-data.html">Format and upload your batch inference data</a>. The criteria include the following:</p> <ul> <li> <p>Your IAM service role has access to the Amazon S3 buckets containing your files.</p> </li> <li> <p>Your files are .jsonl files and each individual record is a JSON object in the correct format. Note that validation doesn't check if the <code>modelInput</code> value matches the request body for the model.</p> </li> <li> <p>Your files fulfill the requirements for file size and number of records. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/quotas.html">Quotas for Amazon Bedrock</a>.</p> </li> </ul> </li> <li> <p>Scheduled – This job has been validated and is now in a queue. The job will automatically start when it reaches its turn.</p> </li> <li> <p>Expired – This job timed out because it was scheduled but didn't begin before the set timeout duration. Submit a new job request.</p> </li> <li> <p>InProgress – This job has begun. You can start viewing the results in the output S3 location.</p> </li> <li> <p>Completed – This job has successfully completed. View the output files in the output S3 location.</p> </li> <li> <p>PartiallyCompleted – This job has partially completed. Not all of your records could be processed in time. View the output files in the output S3 location.</p> </li> <li> <p>Failed – This job has failed. Check the failure message for any further details. For further assistance, reach out to the <a href="https://console.aws.amazon.com/support/home/">Amazon Web ServicesSupport Center</a>.</p> </li> <li> <p>Stopped – This job was stopped by a user.</p> </li> <li> <p>Stopping – This job is being stopped by a user.</p> </li> </ul>
2397
+ * @public
2398
+ */
2399
+ status?: ModelInvocationJobStatus | undefined;
2400
+ /**
2401
+ * <p>If the batch inference job failed, this field contains a message describing why the job failed.</p>
2402
+ * @public
2403
+ */
2404
+ message?: string | undefined;
2405
+ /**
2406
+ * <p>The time at which the batch inference job was submitted.</p>
2407
+ * @public
2408
+ */
2409
+ submitTime: Date | undefined;
2410
+ /**
2411
+ * <p>The time at which the batch inference job was last modified.</p>
2412
+ * @public
2413
+ */
2414
+ lastModifiedTime?: Date | undefined;
2415
+ /**
2416
+ * <p>The time at which the batch inference job ended.</p>
2417
+ * @public
2418
+ */
2419
+ endTime?: Date | undefined;
2420
+ /**
2421
+ * <p>Details about the location of the input to the batch inference job.</p>
2422
+ * @public
2423
+ */
2424
+ inputDataConfig: ModelInvocationJobInputDataConfig | undefined;
2425
+ /**
2426
+ * <p>Details about the location of the output of the batch inference job.</p>
2427
+ * @public
2428
+ */
2429
+ outputDataConfig: ModelInvocationJobOutputDataConfig | undefined;
2430
+ /**
2431
+ * <p>The configuration of the Virtual Private Cloud (VPC) for the data in the batch inference job. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/batch-vpc">Protect batch inference jobs using a VPC</a>.</p>
2432
+ * @public
2433
+ */
2434
+ vpcConfig?: VpcConfig | undefined;
2435
+ /**
2436
+ * <p>The number of hours after which the batch inference job was set to time out.</p>
2437
+ * @public
2438
+ */
2439
+ timeoutDurationInHours?: number | undefined;
2440
+ /**
2441
+ * <p>The time at which the batch inference job times or timed out.</p>
2442
+ * @public
2443
+ */
2444
+ jobExpirationTime?: Date | undefined;
2445
+ }
2446
+ /**
2447
+ * @public
2448
+ */
2449
+ export interface ListModelInvocationJobsResponse {
2450
+ /**
2451
+ * <p>If there are more results than can fit in the response, a <code>nextToken</code> is returned. Use the <code>nextToken</code> in a request to return the next batch of results.</p>
2452
+ * @public
2453
+ */
2454
+ nextToken?: string | undefined;
2455
+ /**
2456
+ * <p>A list of items, each of which contains a summary about a batch inference job.</p>
2457
+ * @public
2458
+ */
2459
+ invocationJobSummaries?: ModelInvocationJobSummary[] | undefined;
2460
+ }
2461
+ /**
2462
+ * @public
2463
+ */
2464
+ export interface StopModelInvocationJobRequest {
2465
+ /**
2466
+ * <p>The Amazon Resource Name (ARN) of the batch inference job to stop.</p>
2467
+ * @public
2468
+ */
2469
+ jobIdentifier: string | undefined;
2470
+ }
2471
+ /**
2472
+ * @public
2473
+ */
2474
+ export interface StopModelInvocationJobResponse {
2475
+ }
2476
+ /**
2477
+ * @public
2478
+ */
2479
+ export interface GetFoundationModelRequest {
2480
+ /**
2481
+ * <p>The model identifier. </p>
2482
+ * @public
2483
+ */
2484
+ modelIdentifier: string | undefined;
2485
+ }
2486
+ /**
2487
+ * @public
2488
+ * @enum
2489
+ */
2490
+ export declare const ModelCustomization: {
2491
+ readonly CONTINUED_PRE_TRAINING: "CONTINUED_PRE_TRAINING";
2492
+ readonly DISTILLATION: "DISTILLATION";
2493
+ readonly FINE_TUNING: "FINE_TUNING";
2494
+ };
2495
+ /**
2496
+ * @public
2497
+ */
2498
+ export type ModelCustomization = (typeof ModelCustomization)[keyof typeof ModelCustomization];
2499
+ /**
2500
+ * @public
2501
+ * @enum
2502
+ */
2503
+ export declare const InferenceType: {
2504
+ readonly ON_DEMAND: "ON_DEMAND";
2505
+ readonly PROVISIONED: "PROVISIONED";
2506
+ };
2507
+ /**
2508
+ * @public
2509
+ */
2510
+ export type InferenceType = (typeof InferenceType)[keyof typeof InferenceType];
2511
+ /**
2512
+ * @public
2513
+ * @enum
2514
+ */
2515
+ export declare const ModelModality: {
2516
+ readonly EMBEDDING: "EMBEDDING";
2517
+ readonly IMAGE: "IMAGE";
2518
+ readonly TEXT: "TEXT";
2519
+ };
2520
+ /**
2521
+ * @public
2522
+ */
2523
+ export type ModelModality = (typeof ModelModality)[keyof typeof ModelModality];
2524
+ /**
2525
+ * @public
2526
+ * @enum
2527
+ */
2528
+ export declare const FoundationModelLifecycleStatus: {
2529
+ readonly ACTIVE: "ACTIVE";
2530
+ readonly LEGACY: "LEGACY";
2531
+ };
2532
+ /**
2533
+ * @public
2534
+ */
2535
+ export type FoundationModelLifecycleStatus = (typeof FoundationModelLifecycleStatus)[keyof typeof FoundationModelLifecycleStatus];
2536
+ /**
2537
+ * <p>Details about whether a model version is available or deprecated.</p>
2538
+ * @public
2539
+ */
2540
+ export interface FoundationModelLifecycle {
2541
+ /**
2542
+ * <p>Specifies whether a model version is available (<code>ACTIVE</code>) or deprecated (<code>LEGACY</code>.</p>
2543
+ * @public
2544
+ */
2545
+ status: FoundationModelLifecycleStatus | undefined;
2546
+ }
2547
+ /**
2548
+ * <p>Information about a foundation model.</p>
2549
+ * @public
2550
+ */
2551
+ export interface FoundationModelDetails {
2552
+ /**
2553
+ * <p>The model Amazon Resource Name (ARN).</p>
2554
+ * @public
2555
+ */
2556
+ modelArn: string | undefined;
2557
+ /**
2558
+ * <p>The model identifier.</p>
2559
+ * @public
2560
+ */
2561
+ modelId: string | undefined;
2562
+ /**
2563
+ * <p>The model name.</p>
2564
+ * @public
2565
+ */
2566
+ modelName?: string | undefined;
2567
+ /**
2568
+ * <p>The model's provider name.</p>
2569
+ * @public
2570
+ */
2571
+ providerName?: string | undefined;
2572
+ /**
2573
+ * <p>The input modalities that the model supports.</p>
2574
+ * @public
2575
+ */
2576
+ inputModalities?: ModelModality[] | undefined;
2577
+ /**
2578
+ * <p>The output modalities that the model supports.</p>
2579
+ * @public
2580
+ */
2581
+ outputModalities?: ModelModality[] | undefined;
2582
+ /**
2583
+ * <p>Indicates whether the model supports streaming.</p>
2584
+ * @public
2585
+ */
2586
+ responseStreamingSupported?: boolean | undefined;
2587
+ /**
2588
+ * <p>The customization that the model supports.</p>
2589
+ * @public
2590
+ */
2591
+ customizationsSupported?: ModelCustomization[] | undefined;
2592
+ /**
2593
+ * <p>The inference types that the model supports.</p>
2594
+ * @public
2595
+ */
2596
+ inferenceTypesSupported?: InferenceType[] | undefined;
2597
+ /**
2598
+ * <p>Contains details about whether a model version is available or deprecated</p>
2599
+ * @public
2600
+ */
2601
+ modelLifecycle?: FoundationModelLifecycle | undefined;
2602
+ }
2603
+ /**
2604
+ * @public
2605
+ */
2606
+ export interface GetFoundationModelResponse {
2607
+ /**
2608
+ * <p>Information about the foundation model.</p>
2609
+ * @public
2610
+ */
2611
+ modelDetails?: FoundationModelDetails | undefined;
2612
+ }
2613
+ /**
2614
+ * @public
2615
+ */
2616
+ export interface ListFoundationModelsRequest {
2617
+ /**
2618
+ * <p>Return models belonging to the model provider that you specify.</p>
2619
+ * @public
2620
+ */
2621
+ byProvider?: string | undefined;
2622
+ /**
2623
+ * <p>Return models that support the customization type that you specify. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models.html">Custom models</a> in the <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html">Amazon Bedrock User Guide</a>.</p>
2624
+ * @public
2625
+ */
2626
+ byCustomizationType?: ModelCustomization | undefined;
2627
+ /**
2628
+ * <p>Return models that support the output modality that you specify.</p>
2629
+ * @public
2630
+ */
2631
+ byOutputModality?: ModelModality | undefined;
2632
+ /**
2633
+ * <p>Return models that support the inference type that you specify. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prov-throughput.html">Provisioned Throughput</a> in the <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html">Amazon Bedrock User Guide</a>.</p>
2634
+ * @public
2635
+ */
2636
+ byInferenceType?: InferenceType | undefined;
2637
+ }
2638
+ /**
2639
+ * <p>Summary information for a foundation model.</p>
2640
+ * @public
2641
+ */
2642
+ export interface FoundationModelSummary {
2643
+ /**
2644
+ * <p>The Amazon Resource Name (ARN) of the foundation model.</p>
2645
+ * @public
2646
+ */
2647
+ modelArn: string | undefined;
2648
+ /**
2649
+ * <p>The model ID of the foundation model.</p>
2650
+ * @public
2651
+ */
2652
+ modelId: string | undefined;
2653
+ /**
2654
+ * <p>The name of the model.</p>
2655
+ * @public
2656
+ */
2657
+ modelName?: string | undefined;
2658
+ /**
2659
+ * <p>The model's provider name.</p>
2660
+ * @public
2661
+ */
2662
+ providerName?: string | undefined;
2663
+ /**
2664
+ * <p>The input modalities that the model supports.</p>
2665
+ * @public
2666
+ */
2667
+ inputModalities?: ModelModality[] | undefined;
2668
+ /**
2669
+ * <p>The output modalities that the model supports.</p>
2670
+ * @public
2671
+ */
2672
+ outputModalities?: ModelModality[] | undefined;
2673
+ /**
2674
+ * <p>Indicates whether the model supports streaming.</p>
2675
+ * @public
2676
+ */
2677
+ responseStreamingSupported?: boolean | undefined;
2678
+ /**
2679
+ * <p>Whether the model supports fine-tuning or continual pre-training.</p>
2680
+ * @public
2681
+ */
2682
+ customizationsSupported?: ModelCustomization[] | undefined;
2683
+ /**
2684
+ * <p>The inference types that the model supports.</p>
2685
+ * @public
2686
+ */
2687
+ inferenceTypesSupported?: InferenceType[] | undefined;
2688
+ /**
2689
+ * <p>Contains details about whether a model version is available or deprecated.</p>
2690
+ * @public
2691
+ */
2692
+ modelLifecycle?: FoundationModelLifecycle | undefined;
2693
+ }
2694
+ /**
2695
+ * @public
2696
+ */
2697
+ export interface ListFoundationModelsResponse {
2698
+ /**
2699
+ * <p>A list of Amazon Bedrock foundation models.</p>
2700
+ * @public
2701
+ */
2702
+ modelSummaries?: FoundationModelSummary[] | undefined;
2703
+ }
2704
+ /**
2705
+ * <p>The target model for a prompt router.</p>
2706
+ * @public
2707
+ */
2708
+ export interface PromptRouterTargetModel {
2709
+ /**
2710
+ * <p>The target model's ARN.</p>
2711
+ * @public
2712
+ */
2713
+ modelArn: string | undefined;
2714
+ }
2715
+ /**
2716
+ * <p>Routing criteria for a prompt router.</p>
2717
+ * @public
2718
+ */
2719
+ export interface RoutingCriteria {
2720
+ /**
2721
+ * <p>The criteria's response quality difference.</p>
2722
+ * @public
2723
+ */
2724
+ responseQualityDifference: number | undefined;
2725
+ }
2726
+ /**
2727
+ * @public
2728
+ */
2729
+ export interface CreatePromptRouterRequest {
2730
+ /**
2731
+ * <p>A unique, case-sensitive identifier that you provide to ensure idempotency of your requests. If not specified, the Amazon Web Services SDK automatically generates one for you.</p>
2732
+ * @public
2733
+ */
2734
+ clientRequestToken?: string | undefined;
2735
+ /**
2736
+ * <p>The name of the prompt router. The name must be unique within your Amazon Web Services account in the current region.</p>
2737
+ * @public
2738
+ */
2739
+ promptRouterName: string | undefined;
2740
+ /**
2741
+ * <p>A list of foundation models that the prompt router can route requests to. At least one model must be specified.</p>
2742
+ * @public
2743
+ */
2744
+ models: PromptRouterTargetModel[] | undefined;
2745
+ /**
2746
+ * <p>An optional description of the prompt router to help identify its purpose.</p>
2747
+ * @public
2748
+ */
2749
+ description?: string | undefined;
2750
+ /**
2751
+ * <p>The criteria, which is the response quality difference, used to determine how incoming requests are routed to different models.</p>
2752
+ * @public
2753
+ */
2754
+ routingCriteria: RoutingCriteria | undefined;
2755
+ /**
2756
+ * <p>The default model to use when the routing criteria is not met.</p>
2757
+ * @public
2758
+ */
2759
+ fallbackModel: PromptRouterTargetModel | undefined;
2760
+ /**
2761
+ * <p>An array of key-value pairs to apply to this resource as tags. You can use tags to categorize and manage your Amazon Web Services resources.</p>
2762
+ * @public
2763
+ */
2764
+ tags?: Tag[] | undefined;
2765
+ }
2766
+ /**
2767
+ * @public
2768
+ */
2769
+ export interface CreatePromptRouterResponse {
2770
+ /**
2771
+ * <p>The Amazon Resource Name (ARN) that uniquely identifies the prompt router.</p>
2772
+ * @public
2773
+ */
2774
+ promptRouterArn?: string | undefined;
2775
+ }
2776
+ /**
2777
+ * @public
2778
+ */
2779
+ export interface DeletePromptRouterRequest {
2780
+ /**
2781
+ * <p>The Amazon Resource Name (ARN) of the prompt router to delete.</p>
2782
+ * @public
2783
+ */
2784
+ promptRouterArn: string | undefined;
2785
+ }
2786
+ /**
2787
+ * @public
2788
+ */
2789
+ export interface DeletePromptRouterResponse {
2790
+ }
2791
+ /**
2792
+ * @public
2793
+ */
2794
+ export interface GetPromptRouterRequest {
2795
+ /**
2796
+ * <p>The prompt router's ARN</p>
2797
+ * @public
2798
+ */
2799
+ promptRouterArn: string | undefined;
2800
+ }
2801
+ /**
2802
+ * @public
2803
+ * @enum
2804
+ */
2805
+ export declare const PromptRouterStatus: {
2806
+ readonly AVAILABLE: "AVAILABLE";
2807
+ };
2808
+ /**
2809
+ * @public
2810
+ */
2811
+ export type PromptRouterStatus = (typeof PromptRouterStatus)[keyof typeof PromptRouterStatus];
2812
+ /**
2813
+ * @public
2814
+ * @enum
2815
+ */
2816
+ export declare const PromptRouterType: {
2817
+ readonly CUSTOM: "custom";
2818
+ readonly DEFAULT: "default";
2819
+ };
2820
+ /**
2821
+ * @public
2822
+ */
2823
+ export type PromptRouterType = (typeof PromptRouterType)[keyof typeof PromptRouterType];
2824
+ /**
2825
+ * @public
2826
+ */
2827
+ export interface GetPromptRouterResponse {
2828
+ /**
2829
+ * <p>The router's name.</p>
2830
+ * @public
2831
+ */
2832
+ promptRouterName: string | undefined;
2833
+ /**
2834
+ * <p>The router's routing criteria.</p>
2835
+ * @public
2836
+ */
2837
+ routingCriteria: RoutingCriteria | undefined;
2838
+ /**
2839
+ * <p>The router's description.</p>
2840
+ * @public
2841
+ */
2842
+ description?: string | undefined;
2843
+ /**
2844
+ * <p>When the router was created.</p>
2845
+ * @public
2846
+ */
2847
+ createdAt?: Date | undefined;
2848
+ /**
2849
+ * <p>When the router was updated.</p>
2850
+ * @public
2851
+ */
2852
+ updatedAt?: Date | undefined;
2853
+ /**
2854
+ * <p>The prompt router's ARN</p>
2855
+ * @public
2856
+ */
2857
+ promptRouterArn: string | undefined;
2858
+ /**
2859
+ * <p>The router's models.</p>
2860
+ * @public
2861
+ */
2862
+ models: PromptRouterTargetModel[] | undefined;
2863
+ /**
2864
+ * <p>The router's fallback model.</p>
2865
+ * @public
2866
+ */
2867
+ fallbackModel: PromptRouterTargetModel | undefined;
2868
+ /**
2869
+ * <p>The router's status.</p>
2870
+ * @public
2871
+ */
2872
+ status: PromptRouterStatus | undefined;
2873
+ /**
2874
+ * <p>The router's type.</p>
2875
+ * @public
2876
+ */
2877
+ type: PromptRouterType | undefined;
2878
+ }
2879
+ /**
2880
+ * @public
2881
+ */
2882
+ export interface ListPromptRoutersRequest {
2883
+ /**
2884
+ * <p>The maximum number of prompt routers to return in one page of results.</p>
2885
+ * @public
2886
+ */
2887
+ maxResults?: number | undefined;
2888
+ /**
2889
+ * <p>Specify the pagination token from a previous request to retrieve the next page of results.</p>
2890
+ * @public
2891
+ */
2892
+ nextToken?: string | undefined;
2893
+ /**
2894
+ * <p>The type of the prompt routers, such as whether it's default or custom.</p>
2895
+ * @public
2896
+ */
2897
+ type?: PromptRouterType | undefined;
2898
+ }
2899
+ /**
2900
+ * <p>Details about a prompt router.</p>
2901
+ * @public
2902
+ */
2903
+ export interface PromptRouterSummary {
2904
+ /**
2905
+ * <p>The router's name.</p>
2906
+ * @public
2907
+ */
2908
+ promptRouterName: string | undefined;
2909
+ /**
2910
+ * <p>The router's routing criteria.</p>
2911
+ * @public
2912
+ */
2913
+ routingCriteria: RoutingCriteria | undefined;
2914
+ /**
2915
+ * <p>The router's description.</p>
2916
+ * @public
2917
+ */
2918
+ description?: string | undefined;
2919
+ /**
2920
+ * <p>When the router was created.</p>
2921
+ * @public
2922
+ */
2923
+ createdAt?: Date | undefined;
2924
+ /**
2925
+ * <p>When the router was updated.</p>
2926
+ * @public
2927
+ */
2928
+ updatedAt?: Date | undefined;
2929
+ /**
2930
+ * <p>The router's ARN.</p>
2931
+ * @public
2932
+ */
2933
+ promptRouterArn: string | undefined;
2934
+ /**
2935
+ * <p>The router's models.</p>
2936
+ * @public
2937
+ */
2938
+ models: PromptRouterTargetModel[] | undefined;
2939
+ /**
2940
+ * <p>The router's fallback model.</p>
2941
+ * @public
2942
+ */
2943
+ fallbackModel: PromptRouterTargetModel | undefined;
2944
+ /**
2945
+ * <p>The router's status.</p>
2946
+ * @public
2947
+ */
2948
+ status: PromptRouterStatus | undefined;
2949
+ /**
2950
+ * <p>The summary's type.</p>
2951
+ * @public
2952
+ */
2953
+ type: PromptRouterType | undefined;
2954
+ }
2955
+ /**
2956
+ * @public
2957
+ */
2958
+ export interface ListPromptRoutersResponse {
2959
+ /**
2960
+ * <p>A list of prompt router summaries.</p>
2961
+ * @public
2962
+ */
2963
+ promptRouterSummaries?: PromptRouterSummary[] | undefined;
2964
+ /**
2965
+ * <p>Specify the pagination token from a previous request to retrieve the next page of results.</p>
2966
+ * @public
2967
+ */
2968
+ nextToken?: string | undefined;
2969
+ }
2970
+ /**
2971
+ * @public
2972
+ * @enum
2973
+ */
2974
+ export declare const CommitmentDuration: {
2975
+ readonly ONE_MONTH: "OneMonth";
2976
+ readonly SIX_MONTHS: "SixMonths";
2977
+ };
2978
+ /**
2979
+ * @public
2980
+ */
2981
+ export type CommitmentDuration = (typeof CommitmentDuration)[keyof typeof CommitmentDuration];
2982
+ /**
2983
+ * @public
2984
+ */
2985
+ export interface CreateProvisionedModelThroughputRequest {
2986
+ /**
2987
+ * <p>A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a> in the Amazon S3 User Guide.</p>
2988
+ * @public
2989
+ */
2990
+ clientRequestToken?: string | undefined;
2991
+ /**
2992
+ * <p>Number of model units to allocate. A model unit delivers a specific throughput level for the specified model. The throughput level of a model unit specifies the total number of input and output tokens that it can process and generate within a span of one minute. By default, your account has no model units for purchasing Provisioned Throughputs with commitment. You must first visit the <a href="https://console.aws.amazon.com/support/home#/case/create?issueType=service-limit-increase">Amazon Web Services support center</a> to request MUs.</p> <p>For model unit quotas, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/quotas.html#prov-thru-quotas">Provisioned Throughput quotas</a> in the <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html">Amazon Bedrock User Guide</a>.</p> <p>For more information about what an MU specifies, contact your Amazon Web Services account manager.</p>
2993
+ * @public
2994
+ */
2995
+ modelUnits: number | undefined;
2996
+ /**
2997
+ * <p>The name for this Provisioned Throughput.</p>
2998
+ * @public
2999
+ */
3000
+ provisionedModelName: string | undefined;
3001
+ /**
3002
+ * <p>The Amazon Resource Name (ARN) or name of the model to associate with this Provisioned Throughput. For a list of models for which you can purchase Provisioned Throughput, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-ids.html#prov-throughput-models">Amazon Bedrock model IDs for purchasing Provisioned Throughput</a> in the <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html">Amazon Bedrock User Guide</a>.</p>
3003
+ * @public
3004
+ */
3005
+ modelId: string | undefined;
3006
+ /**
3007
+ * <p>The commitment duration requested for the Provisioned Throughput. Billing occurs hourly and is discounted for longer commitment terms. To request a no-commit Provisioned Throughput, omit this field.</p> <p>Custom models support all levels of commitment. To see which base models support no commitment, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/pt-supported.html">Supported regions and models for Provisioned Throughput</a> in the <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html">Amazon Bedrock User Guide</a> </p>
3008
+ * @public
3009
+ */
3010
+ commitmentDuration?: CommitmentDuration | undefined;
3011
+ /**
3012
+ * <p>Tags to associate with this Provisioned Throughput.</p>
3013
+ * @public
3014
+ */
3015
+ tags?: Tag[] | undefined;
3016
+ }
3017
+ /**
3018
+ * @public
3019
+ */
3020
+ export interface CreateProvisionedModelThroughputResponse {
3021
+ /**
3022
+ * <p>The Amazon Resource Name (ARN) for this Provisioned Throughput.</p>
3023
+ * @public
3024
+ */
3025
+ provisionedModelArn: string | undefined;
3026
+ }
3027
+ /**
3028
+ * @public
3029
+ */
3030
+ export interface DeleteProvisionedModelThroughputRequest {
3031
+ /**
3032
+ * <p>The Amazon Resource Name (ARN) or name of the Provisioned Throughput.</p>
3033
+ * @public
3034
+ */
3035
+ provisionedModelId: string | undefined;
3036
+ }
3037
+ /**
3038
+ * @public
3039
+ */
3040
+ export interface DeleteProvisionedModelThroughputResponse {
3041
+ }
3042
+ /**
3043
+ * @public
3044
+ */
3045
+ export interface GetProvisionedModelThroughputRequest {
3046
+ /**
3047
+ * <p>The Amazon Resource Name (ARN) or name of the Provisioned Throughput.</p>
3048
+ * @public
3049
+ */
3050
+ provisionedModelId: string | undefined;
3051
+ }
3052
+ /**
3053
+ * @public
3054
+ * @enum
3055
+ */
3056
+ export declare const ProvisionedModelStatus: {
3057
+ readonly CREATING: "Creating";
3058
+ readonly FAILED: "Failed";
3059
+ readonly IN_SERVICE: "InService";
3060
+ readonly UPDATING: "Updating";
3061
+ };
3062
+ /**
3063
+ * @public
3064
+ */
3065
+ export type ProvisionedModelStatus = (typeof ProvisionedModelStatus)[keyof typeof ProvisionedModelStatus];
3066
+ /**
3067
+ * @public
3068
+ */
3069
+ export interface GetProvisionedModelThroughputResponse {
3070
+ /**
3071
+ * <p>The number of model units allocated to this Provisioned Throughput.</p>
3072
+ * @public
3073
+ */
3074
+ modelUnits: number | undefined;
3075
+ /**
3076
+ * <p>The number of model units that was requested for this Provisioned Throughput.</p>
3077
+ * @public
3078
+ */
3079
+ desiredModelUnits: number | undefined;
3080
+ /**
3081
+ * <p>The name of the Provisioned Throughput.</p>
3082
+ * @public
3083
+ */
3084
+ provisionedModelName: string | undefined;
3085
+ /**
3086
+ * <p>The Amazon Resource Name (ARN) of the Provisioned Throughput.</p>
3087
+ * @public
3088
+ */
3089
+ provisionedModelArn: string | undefined;
3090
+ /**
3091
+ * <p>The Amazon Resource Name (ARN) of the model associated with this Provisioned Throughput.</p>
3092
+ * @public
3093
+ */
3094
+ modelArn: string | undefined;
3095
+ /**
3096
+ * <p>The Amazon Resource Name (ARN) of the model requested to be associated to this Provisioned Throughput. This value differs from the <code>modelArn</code> if updating hasn't completed.</p>
3097
+ * @public
3098
+ */
3099
+ desiredModelArn: string | undefined;
3100
+ /**
3101
+ * <p>The Amazon Resource Name (ARN) of the base model for which the Provisioned Throughput was created, or of the base model that the custom model for which the Provisioned Throughput was created was customized.</p>
3102
+ * @public
3103
+ */
3104
+ foundationModelArn: string | undefined;
3105
+ /**
3106
+ * <p>The status of the Provisioned Throughput. </p>
3107
+ * @public
3108
+ */
3109
+ status: ProvisionedModelStatus | undefined;
3110
+ /**
3111
+ * <p>The timestamp of the creation time for this Provisioned Throughput. </p>
3112
+ * @public
3113
+ */
3114
+ creationTime: Date | undefined;
3115
+ /**
3116
+ * <p>The timestamp of the last time that this Provisioned Throughput was modified. </p>
3117
+ * @public
3118
+ */
3119
+ lastModifiedTime: Date | undefined;
3120
+ /**
3121
+ * <p>A failure message for any issues that occurred during creation, updating, or deletion of the Provisioned Throughput.</p>
3122
+ * @public
3123
+ */
3124
+ failureMessage?: string | undefined;
3125
+ /**
3126
+ * <p>Commitment duration of the Provisioned Throughput.</p>
3127
+ * @public
3128
+ */
3129
+ commitmentDuration?: CommitmentDuration | undefined;
3130
+ /**
3131
+ * <p>The timestamp for when the commitment term for the Provisioned Throughput expires.</p>
3132
+ * @public
3133
+ */
3134
+ commitmentExpirationTime?: Date | undefined;
3135
+ }
3136
+ /**
3137
+ * @public
3138
+ * @enum
3139
+ */
3140
+ export declare const SortByProvisionedModels: {
3141
+ readonly CREATION_TIME: "CreationTime";
3142
+ };
3143
+ /**
3144
+ * @public
3145
+ */
3146
+ export type SortByProvisionedModels = (typeof SortByProvisionedModels)[keyof typeof SortByProvisionedModels];
3147
+ /**
3148
+ * @public
3149
+ */
3150
+ export interface ListProvisionedModelThroughputsRequest {
3151
+ /**
3152
+ * <p>A filter that returns Provisioned Throughputs created after the specified time. </p>
3153
+ * @public
3154
+ */
3155
+ creationTimeAfter?: Date | undefined;
3156
+ /**
3157
+ * <p>A filter that returns Provisioned Throughputs created before the specified time. </p>
3158
+ * @public
3159
+ */
3160
+ creationTimeBefore?: Date | undefined;
3161
+ /**
3162
+ * <p>A filter that returns Provisioned Throughputs if their statuses matches the value that you specify.</p>
3163
+ * @public
3164
+ */
3165
+ statusEquals?: ProvisionedModelStatus | undefined;
3166
+ /**
3167
+ * <p>A filter that returns Provisioned Throughputs whose model Amazon Resource Name (ARN) is equal to the value that you specify.</p>
3168
+ * @public
3169
+ */
3170
+ modelArnEquals?: string | undefined;
3171
+ /**
3172
+ * <p>A filter that returns Provisioned Throughputs if their name contains the expression that you specify.</p>
3173
+ * @public
3174
+ */
3175
+ nameContains?: string | undefined;
3176
+ /**
3177
+ * <p>THe maximum number of results to return in the response. If there are more results than the number you specified, the response returns a <code>nextToken</code> value. To see the next batch of results, send the <code>nextToken</code> value in another list request.</p>
3178
+ * @public
3179
+ */
3180
+ maxResults?: number | undefined;
3181
+ /**
3182
+ * <p>If there are more results than the number you specified in the <code>maxResults</code> field, the response returns a <code>nextToken</code> value. To see the next batch of results, specify the <code>nextToken</code> value in this field.</p>
3183
+ * @public
3184
+ */
3185
+ nextToken?: string | undefined;
3186
+ /**
3187
+ * <p>The field by which to sort the returned list of Provisioned Throughputs.</p>
3188
+ * @public
3189
+ */
3190
+ sortBy?: SortByProvisionedModels | undefined;
3191
+ /**
3192
+ * <p>The sort order of the results.</p>
3193
+ * @public
3194
+ */
3195
+ sortOrder?: SortOrder | undefined;
3196
+ }
2
3197
  /**
3
3198
  * <p>A summary of information about a Provisioned Throughput.</p> <p>This data type is used in the following API operations:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_ListProvisionedModelThroughputs.html#API_ListProvisionedModelThroughputs_ResponseSyntax">ListProvisionedThroughputs response</a> </p> </li> </ul>
4
3199
  * @public
@@ -1598,6 +4793,130 @@ export interface GetEvaluationJobResponse {
1598
4793
  */
1599
4794
  failureMessages?: string[] | undefined;
1600
4795
  }
4796
+ /**
4797
+ * @internal
4798
+ */
4799
+ export declare const GuardrailManagedWordsConfigFilterSensitiveLog: (obj: GuardrailManagedWordsConfig) => any;
4800
+ /**
4801
+ * @internal
4802
+ */
4803
+ export declare const GuardrailWordConfigFilterSensitiveLog: (obj: GuardrailWordConfig) => any;
4804
+ /**
4805
+ * @internal
4806
+ */
4807
+ export declare const GuardrailWordPolicyConfigFilterSensitiveLog: (obj: GuardrailWordPolicyConfig) => any;
4808
+ /**
4809
+ * @internal
4810
+ */
4811
+ export declare const CreateGuardrailRequestFilterSensitiveLog: (obj: CreateGuardrailRequest) => any;
4812
+ /**
4813
+ * @internal
4814
+ */
4815
+ export declare const CreateGuardrailVersionRequestFilterSensitiveLog: (obj: CreateGuardrailVersionRequest) => any;
4816
+ /**
4817
+ * @internal
4818
+ */
4819
+ export declare const GuardrailContentFilterFilterSensitiveLog: (obj: GuardrailContentFilter) => any;
4820
+ /**
4821
+ * @internal
4822
+ */
4823
+ export declare const GuardrailContentFiltersTierFilterSensitiveLog: (obj: GuardrailContentFiltersTier) => any;
4824
+ /**
4825
+ * @internal
4826
+ */
4827
+ export declare const GuardrailContentPolicyFilterSensitiveLog: (obj: GuardrailContentPolicy) => any;
4828
+ /**
4829
+ * @internal
4830
+ */
4831
+ export declare const GuardrailContextualGroundingFilterFilterSensitiveLog: (obj: GuardrailContextualGroundingFilter) => any;
4832
+ /**
4833
+ * @internal
4834
+ */
4835
+ export declare const GuardrailContextualGroundingPolicyFilterSensitiveLog: (obj: GuardrailContextualGroundingPolicy) => any;
4836
+ /**
4837
+ * @internal
4838
+ */
4839
+ export declare const GuardrailTopicsTierFilterSensitiveLog: (obj: GuardrailTopicsTier) => any;
4840
+ /**
4841
+ * @internal
4842
+ */
4843
+ export declare const GuardrailTopicFilterSensitiveLog: (obj: GuardrailTopic) => any;
4844
+ /**
4845
+ * @internal
4846
+ */
4847
+ export declare const GuardrailTopicPolicyFilterSensitiveLog: (obj: GuardrailTopicPolicy) => any;
4848
+ /**
4849
+ * @internal
4850
+ */
4851
+ export declare const GuardrailManagedWordsFilterSensitiveLog: (obj: GuardrailManagedWords) => any;
4852
+ /**
4853
+ * @internal
4854
+ */
4855
+ export declare const GuardrailWordFilterSensitiveLog: (obj: GuardrailWord) => any;
4856
+ /**
4857
+ * @internal
4858
+ */
4859
+ export declare const GuardrailWordPolicyFilterSensitiveLog: (obj: GuardrailWordPolicy) => any;
4860
+ /**
4861
+ * @internal
4862
+ */
4863
+ export declare const GetGuardrailResponseFilterSensitiveLog: (obj: GetGuardrailResponse) => any;
4864
+ /**
4865
+ * @internal
4866
+ */
4867
+ export declare const GuardrailSummaryFilterSensitiveLog: (obj: GuardrailSummary) => any;
4868
+ /**
4869
+ * @internal
4870
+ */
4871
+ export declare const ListGuardrailsResponseFilterSensitiveLog: (obj: ListGuardrailsResponse) => any;
4872
+ /**
4873
+ * @internal
4874
+ */
4875
+ export declare const UpdateGuardrailRequestFilterSensitiveLog: (obj: UpdateGuardrailRequest) => any;
4876
+ /**
4877
+ * @internal
4878
+ */
4879
+ export declare const CreateInferenceProfileRequestFilterSensitiveLog: (obj: CreateInferenceProfileRequest) => any;
4880
+ /**
4881
+ * @internal
4882
+ */
4883
+ export declare const GetInferenceProfileResponseFilterSensitiveLog: (obj: GetInferenceProfileResponse) => any;
4884
+ /**
4885
+ * @internal
4886
+ */
4887
+ export declare const InferenceProfileSummaryFilterSensitiveLog: (obj: InferenceProfileSummary) => any;
4888
+ /**
4889
+ * @internal
4890
+ */
4891
+ export declare const ListInferenceProfilesResponseFilterSensitiveLog: (obj: ListInferenceProfilesResponse) => any;
4892
+ /**
4893
+ * @internal
4894
+ */
4895
+ export declare const GetModelInvocationJobResponseFilterSensitiveLog: (obj: GetModelInvocationJobResponse) => any;
4896
+ /**
4897
+ * @internal
4898
+ */
4899
+ export declare const ModelInvocationJobSummaryFilterSensitiveLog: (obj: ModelInvocationJobSummary) => any;
4900
+ /**
4901
+ * @internal
4902
+ */
4903
+ export declare const ListModelInvocationJobsResponseFilterSensitiveLog: (obj: ListModelInvocationJobsResponse) => any;
4904
+ /**
4905
+ * @internal
4906
+ */
4907
+ export declare const CreatePromptRouterRequestFilterSensitiveLog: (obj: CreatePromptRouterRequest) => any;
4908
+ /**
4909
+ * @internal
4910
+ */
4911
+ export declare const GetPromptRouterResponseFilterSensitiveLog: (obj: GetPromptRouterResponse) => any;
4912
+ /**
4913
+ * @internal
4914
+ */
4915
+ export declare const PromptRouterSummaryFilterSensitiveLog: (obj: PromptRouterSummary) => any;
4916
+ /**
4917
+ * @internal
4918
+ */
4919
+ export declare const ListPromptRoutersResponseFilterSensitiveLog: (obj: ListPromptRoutersResponse) => any;
1601
4920
  /**
1602
4921
  * @internal
1603
4922
  */