aws-sdk-bedrock 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,1169 @@
1
+ # frozen_string_literal: true
2
+
3
+ # WARNING ABOUT GENERATED CODE
4
+ #
5
+ # This file is generated. See the contributing guide for more information:
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
+ #
8
+ # WARNING ABOUT GENERATED CODE
9
+
10
+ module Aws::Bedrock
11
+ module Types
12
+
13
+ # The request is denied because of missing access permissions.
14
+ #
15
+ # @!attribute [rw] message
16
+ # @return [String]
17
+ #
18
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/AccessDeniedException AWS API Documentation
19
+ #
20
+ class AccessDeniedException < Struct.new(
21
+ :message)
22
+ SENSITIVE = []
23
+ include Aws::Structure
24
+ end
25
+
26
+ # CloudWatch logging configuration.
27
+ #
28
+ # @!attribute [rw] large_data_delivery_s3_config
29
+ # S3 configuration for delivering a large amount of data.
30
+ # @return [Types::S3Config]
31
+ #
32
+ # @!attribute [rw] log_group_name
33
+ # The log group name.
34
+ # @return [String]
35
+ #
36
+ # @!attribute [rw] role_arn
37
+ # The role ARN.
38
+ # @return [String]
39
+ #
40
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/CloudWatchConfig AWS API Documentation
41
+ #
42
+ class CloudWatchConfig < Struct.new(
43
+ :large_data_delivery_s3_config,
44
+ :log_group_name,
45
+ :role_arn)
46
+ SENSITIVE = []
47
+ include Aws::Structure
48
+ end
49
+
50
+ # Error occurred because of a conflict while performing an operation.
51
+ #
52
+ # @!attribute [rw] message
53
+ # @return [String]
54
+ #
55
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ConflictException AWS API Documentation
56
+ #
57
+ class ConflictException < Struct.new(
58
+ :message)
59
+ SENSITIVE = []
60
+ include Aws::Structure
61
+ end
62
+
63
+ # @!attribute [rw] base_model_identifier
64
+ # Name of the base model.
65
+ # @return [String]
66
+ #
67
+ # @!attribute [rw] client_request_token
68
+ # Unique token value that you can provide. The
69
+ # GetModelCustomizationJob response includes the same token value.
70
+ #
71
+ # **A suitable default value is auto-generated.** You should normally
72
+ # not need to pass this option.
73
+ # @return [String]
74
+ #
75
+ # @!attribute [rw] custom_model_kms_key_id
76
+ # The custom model is encrypted at rest using this key.
77
+ # @return [String]
78
+ #
79
+ # @!attribute [rw] custom_model_name
80
+ # Enter a name for the custom model.
81
+ # @return [String]
82
+ #
83
+ # @!attribute [rw] custom_model_tags
84
+ # Assign tags to the custom model.
85
+ # @return [Array<Types::Tag>]
86
+ #
87
+ # @!attribute [rw] hyper_parameters
88
+ # Parameters related to tuning the model.
89
+ # @return [Hash<String,String>]
90
+ #
91
+ # @!attribute [rw] job_name
92
+ # Enter a unique name for the fine-tuning job.
93
+ # @return [String]
94
+ #
95
+ # @!attribute [rw] job_tags
96
+ # Assign tags to the job.
97
+ # @return [Array<Types::Tag>]
98
+ #
99
+ # @!attribute [rw] output_data_config
100
+ # S3 location for the output data.
101
+ # @return [Types::OutputDataConfig]
102
+ #
103
+ # @!attribute [rw] role_arn
104
+ # The Amazon Resource Name (ARN) of an IAM role that Bedrock can
105
+ # assume to perform tasks on your behalf. For example, during model
106
+ # training, Bedrock needs your permission to read input data from an
107
+ # S3 bucket, write model artifacts to an S3 bucket. To pass this role
108
+ # to Bedrock, the caller of this API must have the `iam:PassRole`
109
+ # permission.
110
+ # @return [String]
111
+ #
112
+ # @!attribute [rw] training_data_config
113
+ # Information about the training dataset.
114
+ # @return [Types::TrainingDataConfig]
115
+ #
116
+ # @!attribute [rw] validation_data_config
117
+ # Information about the validation dataset.
118
+ # @return [Types::ValidationDataConfig]
119
+ #
120
+ # @!attribute [rw] vpc_config
121
+ # VPC configuration (optional). Configuration parameters for the
122
+ # private Virtual Private Cloud (VPC) that contains the resources you
123
+ # are using for this job.
124
+ # @return [Types::VpcConfig]
125
+ #
126
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/CreateModelCustomizationJobRequest AWS API Documentation
127
+ #
128
+ class CreateModelCustomizationJobRequest < Struct.new(
129
+ :base_model_identifier,
130
+ :client_request_token,
131
+ :custom_model_kms_key_id,
132
+ :custom_model_name,
133
+ :custom_model_tags,
134
+ :hyper_parameters,
135
+ :job_name,
136
+ :job_tags,
137
+ :output_data_config,
138
+ :role_arn,
139
+ :training_data_config,
140
+ :validation_data_config,
141
+ :vpc_config)
142
+ SENSITIVE = []
143
+ include Aws::Structure
144
+ end
145
+
146
+ # @!attribute [rw] job_arn
147
+ # ARN of the fine tuning job
148
+ # @return [String]
149
+ #
150
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/CreateModelCustomizationJobResponse AWS API Documentation
151
+ #
152
+ class CreateModelCustomizationJobResponse < Struct.new(
153
+ :job_arn)
154
+ SENSITIVE = []
155
+ include Aws::Structure
156
+ end
157
+
158
+ # Summary information for a custom model.
159
+ #
160
+ # @!attribute [rw] base_model_arn
161
+ # The base model ARN.
162
+ # @return [String]
163
+ #
164
+ # @!attribute [rw] base_model_name
165
+ # The base model name.
166
+ # @return [String]
167
+ #
168
+ # @!attribute [rw] creation_time
169
+ # Creation time of the model.
170
+ # @return [Time]
171
+ #
172
+ # @!attribute [rw] model_arn
173
+ # The ARN of the custom model.
174
+ # @return [String]
175
+ #
176
+ # @!attribute [rw] model_name
177
+ # The name of the custom model.
178
+ # @return [String]
179
+ #
180
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/CustomModelSummary AWS API Documentation
181
+ #
182
+ class CustomModelSummary < Struct.new(
183
+ :base_model_arn,
184
+ :base_model_name,
185
+ :creation_time,
186
+ :model_arn,
187
+ :model_name)
188
+ SENSITIVE = []
189
+ include Aws::Structure
190
+ end
191
+
192
+ # @!attribute [rw] model_identifier
193
+ # Name of the model to delete.
194
+ # @return [String]
195
+ #
196
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/DeleteCustomModelRequest AWS API Documentation
197
+ #
198
+ class DeleteCustomModelRequest < Struct.new(
199
+ :model_identifier)
200
+ SENSITIVE = []
201
+ include Aws::Structure
202
+ end
203
+
204
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/DeleteCustomModelResponse AWS API Documentation
205
+ #
206
+ class DeleteCustomModelResponse < Aws::EmptyStructure; end
207
+
208
+ # @api private
209
+ #
210
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/DeleteModelInvocationLoggingConfigurationRequest AWS API Documentation
211
+ #
212
+ class DeleteModelInvocationLoggingConfigurationRequest < Aws::EmptyStructure; end
213
+
214
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/DeleteModelInvocationLoggingConfigurationResponse AWS API Documentation
215
+ #
216
+ class DeleteModelInvocationLoggingConfigurationResponse < Aws::EmptyStructure; end
217
+
218
+ # Information about a foundation model.
219
+ #
220
+ # @!attribute [rw] customizations_supported
221
+ # The customization that the model supports.
222
+ # @return [Array<String>]
223
+ #
224
+ # @!attribute [rw] inference_types_supported
225
+ # The inference types that the model supports.
226
+ # @return [Array<String>]
227
+ #
228
+ # @!attribute [rw] input_modalities
229
+ # The input modalities that the model supports.
230
+ # @return [Array<String>]
231
+ #
232
+ # @!attribute [rw] model_arn
233
+ # The model ARN.
234
+ # @return [String]
235
+ #
236
+ # @!attribute [rw] model_id
237
+ # The model identifier.
238
+ # @return [String]
239
+ #
240
+ # @!attribute [rw] model_name
241
+ # The model name.
242
+ # @return [String]
243
+ #
244
+ # @!attribute [rw] output_modalities
245
+ # The output modalities that the model supports.
246
+ # @return [Array<String>]
247
+ #
248
+ # @!attribute [rw] provider_name
249
+ # he model's provider name.
250
+ # @return [String]
251
+ #
252
+ # @!attribute [rw] response_streaming_supported
253
+ # Indicates whether the model supports streaming.
254
+ # @return [Boolean]
255
+ #
256
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/FoundationModelDetails AWS API Documentation
257
+ #
258
+ class FoundationModelDetails < Struct.new(
259
+ :customizations_supported,
260
+ :inference_types_supported,
261
+ :input_modalities,
262
+ :model_arn,
263
+ :model_id,
264
+ :model_name,
265
+ :output_modalities,
266
+ :provider_name,
267
+ :response_streaming_supported)
268
+ SENSITIVE = []
269
+ include Aws::Structure
270
+ end
271
+
272
+ # Summary information for a foundation model.
273
+ #
274
+ # @!attribute [rw] customizations_supported
275
+ # Whether the model supports fine-tuning or continual pre-training.
276
+ # @return [Array<String>]
277
+ #
278
+ # @!attribute [rw] inference_types_supported
279
+ # The inference types that the model supports.
280
+ # @return [Array<String>]
281
+ #
282
+ # @!attribute [rw] input_modalities
283
+ # The input modalities that the model supports.
284
+ # @return [Array<String>]
285
+ #
286
+ # @!attribute [rw] model_arn
287
+ # The ARN of the foundation model.
288
+ # @return [String]
289
+ #
290
+ # @!attribute [rw] model_id
291
+ # The model Id of the foundation model.
292
+ # @return [String]
293
+ #
294
+ # @!attribute [rw] model_name
295
+ # The name of the model.
296
+ # @return [String]
297
+ #
298
+ # @!attribute [rw] output_modalities
299
+ # The output modalities that the model supports.
300
+ # @return [Array<String>]
301
+ #
302
+ # @!attribute [rw] provider_name
303
+ # The model's provider name.
304
+ # @return [String]
305
+ #
306
+ # @!attribute [rw] response_streaming_supported
307
+ # Indicates whether the model supports streaming.
308
+ # @return [Boolean]
309
+ #
310
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/FoundationModelSummary AWS API Documentation
311
+ #
312
+ class FoundationModelSummary < Struct.new(
313
+ :customizations_supported,
314
+ :inference_types_supported,
315
+ :input_modalities,
316
+ :model_arn,
317
+ :model_id,
318
+ :model_name,
319
+ :output_modalities,
320
+ :provider_name,
321
+ :response_streaming_supported)
322
+ SENSITIVE = []
323
+ include Aws::Structure
324
+ end
325
+
326
+ # @!attribute [rw] model_identifier
327
+ # Name or ARN of the custom model.
328
+ # @return [String]
329
+ #
330
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GetCustomModelRequest AWS API Documentation
331
+ #
332
+ class GetCustomModelRequest < Struct.new(
333
+ :model_identifier)
334
+ SENSITIVE = []
335
+ include Aws::Structure
336
+ end
337
+
338
+ # @!attribute [rw] base_model_arn
339
+ # ARN of the base model.
340
+ # @return [String]
341
+ #
342
+ # @!attribute [rw] creation_time
343
+ # Creation time of the model.
344
+ # @return [Time]
345
+ #
346
+ # @!attribute [rw] hyper_parameters
347
+ # Hyperparameter values associated with this model.
348
+ # @return [Hash<String,String>]
349
+ #
350
+ # @!attribute [rw] job_arn
351
+ # Job ARN associated with this model.
352
+ # @return [String]
353
+ #
354
+ # @!attribute [rw] job_name
355
+ # Job name associated with this model.
356
+ # @return [String]
357
+ #
358
+ # @!attribute [rw] model_arn
359
+ # ARN associated with this model.
360
+ # @return [String]
361
+ #
362
+ # @!attribute [rw] model_kms_key_arn
363
+ # The custom model is encrypted at rest using this key.
364
+ # @return [String]
365
+ #
366
+ # @!attribute [rw] model_name
367
+ # Model name associated with this model.
368
+ # @return [String]
369
+ #
370
+ # @!attribute [rw] output_data_config
371
+ # Output data configuration associated with this custom model.
372
+ # @return [Types::OutputDataConfig]
373
+ #
374
+ # @!attribute [rw] training_data_config
375
+ # Information about the training dataset.
376
+ # @return [Types::TrainingDataConfig]
377
+ #
378
+ # @!attribute [rw] training_metrics
379
+ # The training metrics from the job creation.
380
+ # @return [Types::TrainingMetrics]
381
+ #
382
+ # @!attribute [rw] validation_data_config
383
+ # Array of up to 10 validators.
384
+ # @return [Types::ValidationDataConfig]
385
+ #
386
+ # @!attribute [rw] validation_metrics
387
+ # The validation metrics from the job creation.
388
+ # @return [Array<Types::ValidatorMetric>]
389
+ #
390
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GetCustomModelResponse AWS API Documentation
391
+ #
392
+ class GetCustomModelResponse < Struct.new(
393
+ :base_model_arn,
394
+ :creation_time,
395
+ :hyper_parameters,
396
+ :job_arn,
397
+ :job_name,
398
+ :model_arn,
399
+ :model_kms_key_arn,
400
+ :model_name,
401
+ :output_data_config,
402
+ :training_data_config,
403
+ :training_metrics,
404
+ :validation_data_config,
405
+ :validation_metrics)
406
+ SENSITIVE = []
407
+ include Aws::Structure
408
+ end
409
+
410
+ # @!attribute [rw] model_identifier
411
+ # The model identifier.
412
+ # @return [String]
413
+ #
414
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GetFoundationModelRequest AWS API Documentation
415
+ #
416
+ class GetFoundationModelRequest < Struct.new(
417
+ :model_identifier)
418
+ SENSITIVE = []
419
+ include Aws::Structure
420
+ end
421
+
422
+ # @!attribute [rw] model_details
423
+ # Information about the foundation model.
424
+ # @return [Types::FoundationModelDetails]
425
+ #
426
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GetFoundationModelResponse AWS API Documentation
427
+ #
428
+ class GetFoundationModelResponse < Struct.new(
429
+ :model_details)
430
+ SENSITIVE = []
431
+ include Aws::Structure
432
+ end
433
+
434
+ # @!attribute [rw] job_identifier
435
+ # Identifier for the customization job.
436
+ # @return [String]
437
+ #
438
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GetModelCustomizationJobRequest AWS API Documentation
439
+ #
440
+ class GetModelCustomizationJobRequest < Struct.new(
441
+ :job_identifier)
442
+ SENSITIVE = []
443
+ include Aws::Structure
444
+ end
445
+
446
+ # @!attribute [rw] base_model_arn
447
+ # ARN of the base model.
448
+ # @return [String]
449
+ #
450
+ # @!attribute [rw] client_request_token
451
+ # The token that you specified in the CreateCustomizationJob request.
452
+ # @return [String]
453
+ #
454
+ # @!attribute [rw] creation_time
455
+ # Time that the resource was created.
456
+ # @return [Time]
457
+ #
458
+ # @!attribute [rw] end_time
459
+ # Time that the resource transitioned to terminal state.
460
+ # @return [Time]
461
+ #
462
+ # @!attribute [rw] failure_message
463
+ # Information about why the job failed.
464
+ # @return [String]
465
+ #
466
+ # @!attribute [rw] hyper_parameters
467
+ # The hyperparameter values for the job.
468
+ # @return [Hash<String,String>]
469
+ #
470
+ # @!attribute [rw] job_arn
471
+ # The ARN of the customization job.
472
+ # @return [String]
473
+ #
474
+ # @!attribute [rw] job_name
475
+ # The name of the customization job.
476
+ # @return [String]
477
+ #
478
+ # @!attribute [rw] last_modified_time
479
+ # Time that the resource was last modified.
480
+ # @return [Time]
481
+ #
482
+ # @!attribute [rw] output_data_config
483
+ # Output data configuration
484
+ # @return [Types::OutputDataConfig]
485
+ #
486
+ # @!attribute [rw] output_model_arn
487
+ # The ARN of the output model.
488
+ # @return [String]
489
+ #
490
+ # @!attribute [rw] output_model_kms_key_arn
491
+ # The custom model is encrypted at rest using this key.
492
+ # @return [String]
493
+ #
494
+ # @!attribute [rw] output_model_name
495
+ # The name of the output model.
496
+ # @return [String]
497
+ #
498
+ # @!attribute [rw] role_arn
499
+ # The ARN of the IAM role.
500
+ # @return [String]
501
+ #
502
+ # @!attribute [rw] status
503
+ # The status of the job. A successful job transitions from in-progress
504
+ # to completed when the output model is ready to use. If the job
505
+ # failed, the failure message contains information about why the job
506
+ # failed.
507
+ # @return [String]
508
+ #
509
+ # @!attribute [rw] training_data_config
510
+ # S3 Location of the training data.
511
+ # @return [Types::TrainingDataConfig]
512
+ #
513
+ # @!attribute [rw] training_metrics
514
+ # Metrics associated with the custom job.
515
+ # @return [Types::TrainingMetrics]
516
+ #
517
+ # @!attribute [rw] validation_data_config
518
+ # Array of up to 10 validators.
519
+ # @return [Types::ValidationDataConfig]
520
+ #
521
+ # @!attribute [rw] validation_metrics
522
+ # The loss metric for each validator that you provided in the
523
+ # createjob request.
524
+ # @return [Array<Types::ValidatorMetric>]
525
+ #
526
+ # @!attribute [rw] vpc_config
527
+ # VPC configuration for the custom model job.
528
+ # @return [Types::VpcConfig]
529
+ #
530
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GetModelCustomizationJobResponse AWS API Documentation
531
+ #
532
+ class GetModelCustomizationJobResponse < Struct.new(
533
+ :base_model_arn,
534
+ :client_request_token,
535
+ :creation_time,
536
+ :end_time,
537
+ :failure_message,
538
+ :hyper_parameters,
539
+ :job_arn,
540
+ :job_name,
541
+ :last_modified_time,
542
+ :output_data_config,
543
+ :output_model_arn,
544
+ :output_model_kms_key_arn,
545
+ :output_model_name,
546
+ :role_arn,
547
+ :status,
548
+ :training_data_config,
549
+ :training_metrics,
550
+ :validation_data_config,
551
+ :validation_metrics,
552
+ :vpc_config)
553
+ SENSITIVE = []
554
+ include Aws::Structure
555
+ end
556
+
557
+ # @api private
558
+ #
559
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GetModelInvocationLoggingConfigurationRequest AWS API Documentation
560
+ #
561
+ class GetModelInvocationLoggingConfigurationRequest < Aws::EmptyStructure; end
562
+
563
+ # @!attribute [rw] logging_config
564
+ # The current configuration values.
565
+ # @return [Types::LoggingConfig]
566
+ #
567
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GetModelInvocationLoggingConfigurationResponse AWS API Documentation
568
+ #
569
+ class GetModelInvocationLoggingConfigurationResponse < Struct.new(
570
+ :logging_config)
571
+ SENSITIVE = []
572
+ include Aws::Structure
573
+ end
574
+
575
+ # An internal server error occurred. Retry your request.
576
+ #
577
+ # @!attribute [rw] message
578
+ # @return [String]
579
+ #
580
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/InternalServerException AWS API Documentation
581
+ #
582
+ class InternalServerException < Struct.new(
583
+ :message)
584
+ SENSITIVE = []
585
+ include Aws::Structure
586
+ end
587
+
588
+ # @!attribute [rw] base_model_arn_equals
589
+ # Return custom models only if the base model ARN matches this
590
+ # parameter.
591
+ # @return [String]
592
+ #
593
+ # @!attribute [rw] creation_time_after
594
+ # Return custom models created after the specified time.
595
+ # @return [Time]
596
+ #
597
+ # @!attribute [rw] creation_time_before
598
+ # Return custom models created before the specified time.
599
+ # @return [Time]
600
+ #
601
+ # @!attribute [rw] foundation_model_arn_equals
602
+ # Return custom models only if the foundation model ARN matches this
603
+ # parameter.
604
+ # @return [String]
605
+ #
606
+ # @!attribute [rw] max_results
607
+ # Maximum number of results to return in the response.
608
+ # @return [Integer]
609
+ #
610
+ # @!attribute [rw] name_contains
611
+ # Return custom models only if the job name contains these characters.
612
+ # @return [String]
613
+ #
614
+ # @!attribute [rw] next_token
615
+ # Continuation token from the previous response, for Bedrock to list
616
+ # the next set of results.
617
+ # @return [String]
618
+ #
619
+ # @!attribute [rw] sort_by
620
+ # The field to sort by in the returned list of models.
621
+ # @return [String]
622
+ #
623
+ # @!attribute [rw] sort_order
624
+ # The sort order of the results.
625
+ # @return [String]
626
+ #
627
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ListCustomModelsRequest AWS API Documentation
628
+ #
629
+ class ListCustomModelsRequest < Struct.new(
630
+ :base_model_arn_equals,
631
+ :creation_time_after,
632
+ :creation_time_before,
633
+ :foundation_model_arn_equals,
634
+ :max_results,
635
+ :name_contains,
636
+ :next_token,
637
+ :sort_by,
638
+ :sort_order)
639
+ SENSITIVE = []
640
+ include Aws::Structure
641
+ end
642
+
643
+ # @!attribute [rw] model_summaries
644
+ # Model summaries.
645
+ # @return [Array<Types::CustomModelSummary>]
646
+ #
647
+ # @!attribute [rw] next_token
648
+ # Continuation token for the next request to list the next set of
649
+ # results.
650
+ # @return [String]
651
+ #
652
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ListCustomModelsResponse AWS API Documentation
653
+ #
654
+ class ListCustomModelsResponse < Struct.new(
655
+ :model_summaries,
656
+ :next_token)
657
+ SENSITIVE = []
658
+ include Aws::Structure
659
+ end
660
+
661
+ # @!attribute [rw] by_customization_type
662
+ # List by customization type.
663
+ # @return [String]
664
+ #
665
+ # @!attribute [rw] by_inference_type
666
+ # List by inference type.
667
+ # @return [String]
668
+ #
669
+ # @!attribute [rw] by_output_modality
670
+ # List by output modality type.
671
+ # @return [String]
672
+ #
673
+ # @!attribute [rw] by_provider
674
+ # A Bedrock model provider.
675
+ # @return [String]
676
+ #
677
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ListFoundationModelsRequest AWS API Documentation
678
+ #
679
+ class ListFoundationModelsRequest < Struct.new(
680
+ :by_customization_type,
681
+ :by_inference_type,
682
+ :by_output_modality,
683
+ :by_provider)
684
+ SENSITIVE = []
685
+ include Aws::Structure
686
+ end
687
+
688
+ # @!attribute [rw] model_summaries
689
+ # A list of bedrock foundation models.
690
+ # @return [Array<Types::FoundationModelSummary>]
691
+ #
692
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ListFoundationModelsResponse AWS API Documentation
693
+ #
694
+ class ListFoundationModelsResponse < Struct.new(
695
+ :model_summaries)
696
+ SENSITIVE = []
697
+ include Aws::Structure
698
+ end
699
+
700
+ # @!attribute [rw] creation_time_after
701
+ # Return customization jobs created after the specified time.
702
+ # @return [Time]
703
+ #
704
+ # @!attribute [rw] creation_time_before
705
+ # Return customization jobs created before the specified time.
706
+ # @return [Time]
707
+ #
708
+ # @!attribute [rw] max_results
709
+ # Maximum number of results to return in the response.
710
+ # @return [Integer]
711
+ #
712
+ # @!attribute [rw] name_contains
713
+ # Return customization jobs only if the job name contains these
714
+ # characters.
715
+ # @return [String]
716
+ #
717
+ # @!attribute [rw] next_token
718
+ # Continuation token from the previous response, for Bedrock to list
719
+ # the next set of results.
720
+ # @return [String]
721
+ #
722
+ # @!attribute [rw] sort_by
723
+ # The field to sort by in the returned list of jobs.
724
+ # @return [String]
725
+ #
726
+ # @!attribute [rw] sort_order
727
+ # The sort order of the results.
728
+ # @return [String]
729
+ #
730
+ # @!attribute [rw] status_equals
731
+ # Return customization jobs with the specified status.
732
+ # @return [String]
733
+ #
734
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ListModelCustomizationJobsRequest AWS API Documentation
735
+ #
736
+ class ListModelCustomizationJobsRequest < Struct.new(
737
+ :creation_time_after,
738
+ :creation_time_before,
739
+ :max_results,
740
+ :name_contains,
741
+ :next_token,
742
+ :sort_by,
743
+ :sort_order,
744
+ :status_equals)
745
+ SENSITIVE = []
746
+ include Aws::Structure
747
+ end
748
+
749
+ # @!attribute [rw] model_customization_job_summaries
750
+ # Job summaries.
751
+ # @return [Array<Types::ModelCustomizationJobSummary>]
752
+ #
753
+ # @!attribute [rw] next_token
754
+ # Page continuation token to use in the next request.
755
+ # @return [String]
756
+ #
757
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ListModelCustomizationJobsResponse AWS API Documentation
758
+ #
759
+ class ListModelCustomizationJobsResponse < Struct.new(
760
+ :model_customization_job_summaries,
761
+ :next_token)
762
+ SENSITIVE = []
763
+ include Aws::Structure
764
+ end
765
+
766
+ # @!attribute [rw] resource_arn
767
+ # The ARN of the resource.
768
+ # @return [String]
769
+ #
770
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ListTagsForResourceRequest AWS API Documentation
771
+ #
772
+ class ListTagsForResourceRequest < Struct.new(
773
+ :resource_arn)
774
+ SENSITIVE = []
775
+ include Aws::Structure
776
+ end
777
+
778
+ # @!attribute [rw] tags
779
+ # An array of the tags associated with this resource.
780
+ # @return [Array<Types::Tag>]
781
+ #
782
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ListTagsForResourceResponse AWS API Documentation
783
+ #
784
+ class ListTagsForResourceResponse < Struct.new(
785
+ :tags)
786
+ SENSITIVE = []
787
+ include Aws::Structure
788
+ end
789
+
790
+ # Configuration fields for invokation logging.
791
+ #
792
+ # @!attribute [rw] cloud_watch_config
793
+ # CloudWatch logging configuration.
794
+ # @return [Types::CloudWatchConfig]
795
+ #
796
+ # @!attribute [rw] embedding_data_delivery_enabled
797
+ # Set to include embeddings data in the log delivery.
798
+ # @return [Boolean]
799
+ #
800
+ # @!attribute [rw] image_data_delivery_enabled
801
+ # Set to include image data in the log delivery.
802
+ # @return [Boolean]
803
+ #
804
+ # @!attribute [rw] s3_config
805
+ # S3 configuration for storing log data.
806
+ # @return [Types::S3Config]
807
+ #
808
+ # @!attribute [rw] text_data_delivery_enabled
809
+ # Set to include text data in the log delivery.
810
+ # @return [Boolean]
811
+ #
812
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/LoggingConfig AWS API Documentation
813
+ #
814
+ class LoggingConfig < Struct.new(
815
+ :cloud_watch_config,
816
+ :embedding_data_delivery_enabled,
817
+ :image_data_delivery_enabled,
818
+ :s3_config,
819
+ :text_data_delivery_enabled)
820
+ SENSITIVE = []
821
+ include Aws::Structure
822
+ end
823
+
824
+ # Information about one customization job
825
+ #
826
+ # @!attribute [rw] base_model_arn
827
+ # ARN of the base model.
828
+ # @return [String]
829
+ #
830
+ # @!attribute [rw] creation_time
831
+ # Creation time of the custom model.
832
+ # @return [Time]
833
+ #
834
+ # @!attribute [rw] custom_model_arn
835
+ # ARN of the custom model.
836
+ # @return [String]
837
+ #
838
+ # @!attribute [rw] custom_model_name
839
+ # Name of the custom model.
840
+ # @return [String]
841
+ #
842
+ # @!attribute [rw] end_time
843
+ # Time that the customization job ended.
844
+ # @return [Time]
845
+ #
846
+ # @!attribute [rw] job_arn
847
+ # ARN of the customization job.
848
+ # @return [String]
849
+ #
850
+ # @!attribute [rw] job_name
851
+ # Name of the customization job.
852
+ # @return [String]
853
+ #
854
+ # @!attribute [rw] last_modified_time
855
+ # Time that the customization job was last modified.
856
+ # @return [Time]
857
+ #
858
+ # @!attribute [rw] status
859
+ # Status of the customization job.
860
+ # @return [String]
861
+ #
862
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ModelCustomizationJobSummary AWS API Documentation
863
+ #
864
+ class ModelCustomizationJobSummary < Struct.new(
865
+ :base_model_arn,
866
+ :creation_time,
867
+ :custom_model_arn,
868
+ :custom_model_name,
869
+ :end_time,
870
+ :job_arn,
871
+ :job_name,
872
+ :last_modified_time,
873
+ :status)
874
+ SENSITIVE = []
875
+ include Aws::Structure
876
+ end
877
+
878
+ # S3 Location of the output data.
879
+ #
880
+ # @!attribute [rw] s3_uri
881
+ # The S3 URI where the output data is stored.
882
+ # @return [String]
883
+ #
884
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/OutputDataConfig AWS API Documentation
885
+ #
886
+ class OutputDataConfig < Struct.new(
887
+ :s3_uri)
888
+ SENSITIVE = []
889
+ include Aws::Structure
890
+ end
891
+
892
+ # @!attribute [rw] logging_config
893
+ # The logging configuration values to set.
894
+ # @return [Types::LoggingConfig]
895
+ #
896
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/PutModelInvocationLoggingConfigurationRequest AWS API Documentation
897
+ #
898
+ class PutModelInvocationLoggingConfigurationRequest < Struct.new(
899
+ :logging_config)
900
+ SENSITIVE = []
901
+ include Aws::Structure
902
+ end
903
+
904
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/PutModelInvocationLoggingConfigurationResponse AWS API Documentation
905
+ #
906
+ class PutModelInvocationLoggingConfigurationResponse < Aws::EmptyStructure; end
907
+
908
+ # The specified resource ARN was not found. Check the ARN and try your
909
+ # request again.
910
+ #
911
+ # @!attribute [rw] message
912
+ # @return [String]
913
+ #
914
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ResourceNotFoundException AWS API Documentation
915
+ #
916
+ class ResourceNotFoundException < Struct.new(
917
+ :message)
918
+ SENSITIVE = []
919
+ include Aws::Structure
920
+ end
921
+
922
+ # S3 configuration for storing log data.
923
+ #
924
+ # @!attribute [rw] bucket_name
925
+ # S3 bucket name.
926
+ # @return [String]
927
+ #
928
+ # @!attribute [rw] key_prefix
929
+ # S3 prefix.
930
+ # @return [String]
931
+ #
932
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/S3Config AWS API Documentation
933
+ #
934
+ class S3Config < Struct.new(
935
+ :bucket_name,
936
+ :key_prefix)
937
+ SENSITIVE = []
938
+ include Aws::Structure
939
+ end
940
+
941
+ # The number of requests exceeds the service quota. Resubmit your
942
+ # request later.
943
+ #
944
+ # @!attribute [rw] message
945
+ # @return [String]
946
+ #
947
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ServiceQuotaExceededException AWS API Documentation
948
+ #
949
+ class ServiceQuotaExceededException < Struct.new(
950
+ :message)
951
+ SENSITIVE = []
952
+ include Aws::Structure
953
+ end
954
+
955
+ # @!attribute [rw] job_identifier
956
+ # Job identifier of the job to stop.
957
+ # @return [String]
958
+ #
959
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/StopModelCustomizationJobRequest AWS API Documentation
960
+ #
961
+ class StopModelCustomizationJobRequest < Struct.new(
962
+ :job_identifier)
963
+ SENSITIVE = []
964
+ include Aws::Structure
965
+ end
966
+
967
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/StopModelCustomizationJobResponse AWS API Documentation
968
+ #
969
+ class StopModelCustomizationJobResponse < Aws::EmptyStructure; end
970
+
971
+ # Definition of the key/value pair for a tag.
972
+ #
973
+ # @!attribute [rw] key
974
+ # Key for the tag.
975
+ # @return [String]
976
+ #
977
+ # @!attribute [rw] value
978
+ # Value for the tag.
979
+ # @return [String]
980
+ #
981
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/Tag AWS API Documentation
982
+ #
983
+ class Tag < Struct.new(
984
+ :key,
985
+ :value)
986
+ SENSITIVE = []
987
+ include Aws::Structure
988
+ end
989
+
990
+ # @!attribute [rw] resource_arn
991
+ # The ARN of the resource to tag.
992
+ # @return [String]
993
+ #
994
+ # @!attribute [rw] tags
995
+ # Tags to associate with the resource.
996
+ # @return [Array<Types::Tag>]
997
+ #
998
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/TagResourceRequest AWS API Documentation
999
+ #
1000
+ class TagResourceRequest < Struct.new(
1001
+ :resource_arn,
1002
+ :tags)
1003
+ SENSITIVE = []
1004
+ include Aws::Structure
1005
+ end
1006
+
1007
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/TagResourceResponse AWS API Documentation
1008
+ #
1009
+ class TagResourceResponse < Aws::EmptyStructure; end
1010
+
1011
+ # The number of requests exceeds the limit. Resubmit your request later.
1012
+ #
1013
+ # @!attribute [rw] message
1014
+ # @return [String]
1015
+ #
1016
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ThrottlingException AWS API Documentation
1017
+ #
1018
+ class ThrottlingException < Struct.new(
1019
+ :message)
1020
+ SENSITIVE = []
1021
+ include Aws::Structure
1022
+ end
1023
+
1024
+ # The request contains more tags than can be associated with a resource
1025
+ # (50 tags per resource). The maximum number of tags includes both
1026
+ # existing tags and those included in your current request.
1027
+ #
1028
+ # @!attribute [rw] message
1029
+ # @return [String]
1030
+ #
1031
+ # @!attribute [rw] resource_name
1032
+ # The name of the resource with too many tags.
1033
+ # @return [String]
1034
+ #
1035
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/TooManyTagsException AWS API Documentation
1036
+ #
1037
+ class TooManyTagsException < Struct.new(
1038
+ :message,
1039
+ :resource_name)
1040
+ SENSITIVE = []
1041
+ include Aws::Structure
1042
+ end
1043
+
1044
+ # S3 Location of the training data.
1045
+ #
1046
+ # @!attribute [rw] s3_uri
1047
+ # The S3 URI where the training data is stored.
1048
+ # @return [String]
1049
+ #
1050
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/TrainingDataConfig AWS API Documentation
1051
+ #
1052
+ class TrainingDataConfig < Struct.new(
1053
+ :s3_uri)
1054
+ SENSITIVE = []
1055
+ include Aws::Structure
1056
+ end
1057
+
1058
+ # Metrics associated with the custom job.
1059
+ #
1060
+ # @!attribute [rw] training_loss
1061
+ # Loss metric associated with the custom job.
1062
+ # @return [Float]
1063
+ #
1064
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/TrainingMetrics AWS API Documentation
1065
+ #
1066
+ class TrainingMetrics < Struct.new(
1067
+ :training_loss)
1068
+ SENSITIVE = []
1069
+ include Aws::Structure
1070
+ end
1071
+
1072
+ # @!attribute [rw] resource_arn
1073
+ # The ARN of the resource to untag.
1074
+ # @return [String]
1075
+ #
1076
+ # @!attribute [rw] tag_keys
1077
+ # Tag keys of the tags to remove from the resource.
1078
+ # @return [Array<String>]
1079
+ #
1080
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/UntagResourceRequest AWS API Documentation
1081
+ #
1082
+ class UntagResourceRequest < Struct.new(
1083
+ :resource_arn,
1084
+ :tag_keys)
1085
+ SENSITIVE = []
1086
+ include Aws::Structure
1087
+ end
1088
+
1089
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/UntagResourceResponse AWS API Documentation
1090
+ #
1091
+ class UntagResourceResponse < Aws::EmptyStructure; end
1092
+
1093
+ # Array of up to 10 validators.
1094
+ #
1095
+ # @!attribute [rw] validators
1096
+ # Information about the validators.
1097
+ # @return [Array<Types::Validator>]
1098
+ #
1099
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ValidationDataConfig AWS API Documentation
1100
+ #
1101
+ class ValidationDataConfig < Struct.new(
1102
+ :validators)
1103
+ SENSITIVE = []
1104
+ include Aws::Structure
1105
+ end
1106
+
1107
+ # Input validation failed. Check your request parameters and retry the
1108
+ # request.
1109
+ #
1110
+ # @!attribute [rw] message
1111
+ # @return [String]
1112
+ #
1113
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ValidationException AWS API Documentation
1114
+ #
1115
+ class ValidationException < Struct.new(
1116
+ :message)
1117
+ SENSITIVE = []
1118
+ include Aws::Structure
1119
+ end
1120
+
1121
+ # Information about a validator.
1122
+ #
1123
+ # @!attribute [rw] s3_uri
1124
+ # The S3 URI where the validation data is stored.
1125
+ # @return [String]
1126
+ #
1127
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/Validator AWS API Documentation
1128
+ #
1129
+ class Validator < Struct.new(
1130
+ :s3_uri)
1131
+ SENSITIVE = []
1132
+ include Aws::Structure
1133
+ end
1134
+
1135
+ # The metric for the validator.
1136
+ #
1137
+ # @!attribute [rw] validation_loss
1138
+ # The validation loss associated with this validator.
1139
+ # @return [Float]
1140
+ #
1141
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ValidatorMetric AWS API Documentation
1142
+ #
1143
+ class ValidatorMetric < Struct.new(
1144
+ :validation_loss)
1145
+ SENSITIVE = []
1146
+ include Aws::Structure
1147
+ end
1148
+
1149
+ # VPC configuration.
1150
+ #
1151
+ # @!attribute [rw] security_group_ids
1152
+ # VPC configuration security group Ids.
1153
+ # @return [Array<String>]
1154
+ #
1155
+ # @!attribute [rw] subnet_ids
1156
+ # VPC configuration subnets.
1157
+ # @return [Array<String>]
1158
+ #
1159
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/VpcConfig AWS API Documentation
1160
+ #
1161
+ class VpcConfig < Struct.new(
1162
+ :security_group_ids,
1163
+ :subnet_ids)
1164
+ SENSITIVE = []
1165
+ include Aws::Structure
1166
+ end
1167
+
1168
+ end
1169
+ end