aws-sdk-bedrock 1.13.0 → 1.15.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.
@@ -325,6 +325,66 @@ module Aws::Bedrock
325
325
  include Aws::Structure
326
326
  end
327
327
 
328
+ # @!attribute [rw] source_model_arn
329
+ # The Amazon Resource Name (ARN) of the model to be copied.
330
+ # @return [String]
331
+ #
332
+ # @!attribute [rw] target_model_name
333
+ # A name for the copied model.
334
+ # @return [String]
335
+ #
336
+ # @!attribute [rw] model_kms_key_id
337
+ # The ARN of the KMS key that you use to encrypt the model copy.
338
+ # @return [String]
339
+ #
340
+ # @!attribute [rw] target_model_tags
341
+ # Tags to associate with the target model. For more information, see
342
+ # [Tag resources][1] in the [Amazon Bedrock User Guide][2].
343
+ #
344
+ #
345
+ #
346
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/tagging.html
347
+ # [2]: https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html
348
+ # @return [Array<Types::Tag>]
349
+ #
350
+ # @!attribute [rw] client_request_token
351
+ # A unique, case-sensitive identifier to ensure that the API request
352
+ # completes no more than one time. If this token matches a previous
353
+ # request, Amazon Bedrock ignores the request, but does not return an
354
+ # error. For more information, see [Ensuring idempotency][1].
355
+ #
356
+ # **A suitable default value is auto-generated.** You should normally
357
+ # not need to pass this option.
358
+ #
359
+ #
360
+ #
361
+ # [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
362
+ # @return [String]
363
+ #
364
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/CreateModelCopyJobRequest AWS API Documentation
365
+ #
366
+ class CreateModelCopyJobRequest < Struct.new(
367
+ :source_model_arn,
368
+ :target_model_name,
369
+ :model_kms_key_id,
370
+ :target_model_tags,
371
+ :client_request_token)
372
+ SENSITIVE = []
373
+ include Aws::Structure
374
+ end
375
+
376
+ # @!attribute [rw] job_arn
377
+ # The Amazon Resource Name (ARN) of the model copy job.
378
+ # @return [String]
379
+ #
380
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/CreateModelCopyJobResponse AWS API Documentation
381
+ #
382
+ class CreateModelCopyJobResponse < Struct.new(
383
+ :job_arn)
384
+ SENSITIVE = []
385
+ include Aws::Structure
386
+ end
387
+
328
388
  # @!attribute [rw] job_name
329
389
  # A name for the fine-tuning job.
330
390
  # @return [String]
@@ -436,6 +496,89 @@ module Aws::Bedrock
436
496
  include Aws::Structure
437
497
  end
438
498
 
499
+ # @!attribute [rw] job_name
500
+ # A name to give the batch inference job.
501
+ # @return [String]
502
+ #
503
+ # @!attribute [rw] role_arn
504
+ # The Amazon Resource Name (ARN) of the service role with permissions
505
+ # to carry out and manage batch inference. You can use the console to
506
+ # create a default service role or follow the steps at [Create a
507
+ # service role for batch inference][1].
508
+ #
509
+ #
510
+ #
511
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/batch-iam-sr.html
512
+ # @return [String]
513
+ #
514
+ # @!attribute [rw] client_request_token
515
+ # A unique, case-sensitive identifier to ensure that the API request
516
+ # completes no more than one time. If this token matches a previous
517
+ # request, Amazon Bedrock ignores the request, but does not return an
518
+ # error. For more information, see [Ensuring idempotency][1].
519
+ #
520
+ # **A suitable default value is auto-generated.** You should normally
521
+ # not need to pass this option.
522
+ #
523
+ #
524
+ #
525
+ # [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
526
+ # @return [String]
527
+ #
528
+ # @!attribute [rw] model_id
529
+ # The unique identifier of the foundation model to use for the batch
530
+ # inference job.
531
+ # @return [String]
532
+ #
533
+ # @!attribute [rw] input_data_config
534
+ # Details about the location of the input to the batch inference job.
535
+ # @return [Types::ModelInvocationJobInputDataConfig]
536
+ #
537
+ # @!attribute [rw] output_data_config
538
+ # Details about the location of the output of the batch inference job.
539
+ # @return [Types::ModelInvocationJobOutputDataConfig]
540
+ #
541
+ # @!attribute [rw] timeout_duration_in_hours
542
+ # The number of hours after which to force the batch inference job to
543
+ # time out.
544
+ # @return [Integer]
545
+ #
546
+ # @!attribute [rw] tags
547
+ # Any tags to associate with the batch inference job. For more
548
+ # information, see [Tagging Amazon Bedrock resources][1].
549
+ #
550
+ #
551
+ #
552
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/tagging.html
553
+ # @return [Array<Types::Tag>]
554
+ #
555
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/CreateModelInvocationJobRequest AWS API Documentation
556
+ #
557
+ class CreateModelInvocationJobRequest < Struct.new(
558
+ :job_name,
559
+ :role_arn,
560
+ :client_request_token,
561
+ :model_id,
562
+ :input_data_config,
563
+ :output_data_config,
564
+ :timeout_duration_in_hours,
565
+ :tags)
566
+ SENSITIVE = []
567
+ include Aws::Structure
568
+ end
569
+
570
+ # @!attribute [rw] job_arn
571
+ # The Amazon Resource Name (ARN) of the batch inference job.
572
+ # @return [String]
573
+ #
574
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/CreateModelInvocationJobResponse AWS API Documentation
575
+ #
576
+ class CreateModelInvocationJobResponse < Struct.new(
577
+ :job_arn)
578
+ SENSITIVE = []
579
+ include Aws::Structure
580
+ end
581
+
439
582
  # @!attribute [rw] client_request_token
440
583
  # A unique, case-sensitive identifier to ensure that the API request
441
584
  # completes no more than one time. If this token matches a previous
@@ -461,7 +604,7 @@ module Aws::Bedrock
461
604
  # Services support center][1] to request MUs.
462
605
  #
463
606
  # For model unit quotas, see [Provisioned Throughput quotas][2] in the
464
- # Amazon Bedrock User Guide.
607
+ # [Amazon Bedrock User Guide][3].
465
608
  #
466
609
  # For more information about what an MU specifies, contact your Amazon
467
610
  # Web Services account manager.
@@ -470,6 +613,7 @@ module Aws::Bedrock
470
613
  #
471
614
  # [1]: https://console.aws.amazon.com/support/home#/case/create?issueType=service-limit-increase
472
615
  # [2]: https://docs.aws.amazon.com/bedrock/latest/userguide/quotas.html#prov-thru-quotas
616
+ # [3]: https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html
473
617
  # @return [Integer]
474
618
  #
475
619
  # @!attribute [rw] provisioned_model_name
@@ -480,12 +624,13 @@ module Aws::Bedrock
480
624
  # The Amazon Resource Name (ARN) or name of the model to associate
481
625
  # with this Provisioned Throughput. For a list of models for which you
482
626
  # can purchase Provisioned Throughput, see [Amazon Bedrock model IDs
483
- # for purchasing Provisioned Throughput][1] in the Amazon Bedrock User
484
- # Guide.
627
+ # for purchasing Provisioned Throughput][1] in the [Amazon Bedrock
628
+ # User Guide][2].
485
629
  #
486
630
  #
487
631
  #
488
632
  # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/model-ids.html#prov-throughput-models
633
+ # [2]: https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html
489
634
  # @return [String]
490
635
  #
491
636
  # @!attribute [rw] commitment_duration
@@ -495,11 +640,12 @@ module Aws::Bedrock
495
640
  #
496
641
  # Custom models support all levels of commitment. To see which base
497
642
  # models support no commitment, see [Supported regions and models for
498
- # Provisioned Throughput][1] in the Amazon Bedrock User Guide
643
+ # Provisioned Throughput][1] in the [Amazon Bedrock User Guide][2]
499
644
  #
500
645
  #
501
646
  #
502
647
  # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/pt-supported.html
648
+ # [2]: https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html
503
649
  # @return [String]
504
650
  #
505
651
  # @!attribute [rw] tags
@@ -563,6 +709,10 @@ module Aws::Bedrock
563
709
  # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models.html
564
710
  # @return [String]
565
711
  #
712
+ # @!attribute [rw] owner_account_id
713
+ # The unique identifier of the account that owns the model.
714
+ # @return [String]
715
+ #
566
716
  # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/CustomModelSummary AWS API Documentation
567
717
  #
568
718
  class CustomModelSummary < Struct.new(
@@ -571,7 +721,8 @@ module Aws::Bedrock
571
721
  :creation_time,
572
722
  :base_model_arn,
573
723
  :base_model_name,
574
- :customization_type)
724
+ :customization_type,
725
+ :owner_account_id)
575
726
  SENSITIVE = []
576
727
  include Aws::Structure
577
728
  end
@@ -1358,6 +1509,82 @@ module Aws::Bedrock
1358
1509
  include Aws::Structure
1359
1510
  end
1360
1511
 
1512
+ # @!attribute [rw] job_arn
1513
+ # The Amazon Resource Name (ARN) of the model copy job.
1514
+ # @return [String]
1515
+ #
1516
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GetModelCopyJobRequest AWS API Documentation
1517
+ #
1518
+ class GetModelCopyJobRequest < Struct.new(
1519
+ :job_arn)
1520
+ SENSITIVE = []
1521
+ include Aws::Structure
1522
+ end
1523
+
1524
+ # @!attribute [rw] job_arn
1525
+ # The Amazon Resource Name (ARN) of the model copy job.
1526
+ # @return [String]
1527
+ #
1528
+ # @!attribute [rw] status
1529
+ # The status of the model copy job.
1530
+ # @return [String]
1531
+ #
1532
+ # @!attribute [rw] creation_time
1533
+ # The time at which the model copy job was created.
1534
+ # @return [Time]
1535
+ #
1536
+ # @!attribute [rw] target_model_arn
1537
+ # The Amazon Resource Name (ARN) of the copied model.
1538
+ # @return [String]
1539
+ #
1540
+ # @!attribute [rw] target_model_name
1541
+ # The name of the copied model.
1542
+ # @return [String]
1543
+ #
1544
+ # @!attribute [rw] source_account_id
1545
+ # The unique identifier of the account that the model being copied
1546
+ # originated from.
1547
+ # @return [String]
1548
+ #
1549
+ # @!attribute [rw] source_model_arn
1550
+ # The Amazon Resource Name (ARN) of the original model being copied.
1551
+ # @return [String]
1552
+ #
1553
+ # @!attribute [rw] target_model_kms_key_arn
1554
+ # The Amazon Resource Name (ARN) of the KMS key encrypting the copied
1555
+ # model.
1556
+ # @return [String]
1557
+ #
1558
+ # @!attribute [rw] target_model_tags
1559
+ # The tags associated with the copied model.
1560
+ # @return [Array<Types::Tag>]
1561
+ #
1562
+ # @!attribute [rw] failure_message
1563
+ # An error message for why the model copy job failed.
1564
+ # @return [String]
1565
+ #
1566
+ # @!attribute [rw] source_model_name
1567
+ # The name of the original model being copied.
1568
+ # @return [String]
1569
+ #
1570
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GetModelCopyJobResponse AWS API Documentation
1571
+ #
1572
+ class GetModelCopyJobResponse < Struct.new(
1573
+ :job_arn,
1574
+ :status,
1575
+ :creation_time,
1576
+ :target_model_arn,
1577
+ :target_model_name,
1578
+ :source_account_id,
1579
+ :source_model_arn,
1580
+ :target_model_kms_key_arn,
1581
+ :target_model_tags,
1582
+ :failure_message,
1583
+ :source_model_name)
1584
+ SENSITIVE = []
1585
+ include Aws::Structure
1586
+ end
1587
+
1361
1588
  # @!attribute [rw] job_identifier
1362
1589
  # Identifier for the customization job.
1363
1590
  # @return [String]
@@ -1492,6 +1719,112 @@ module Aws::Bedrock
1492
1719
  include Aws::Structure
1493
1720
  end
1494
1721
 
1722
+ # @!attribute [rw] job_identifier
1723
+ # The Amazon Resource Name (ARN) of the batch inference job.
1724
+ # @return [String]
1725
+ #
1726
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GetModelInvocationJobRequest AWS API Documentation
1727
+ #
1728
+ class GetModelInvocationJobRequest < Struct.new(
1729
+ :job_identifier)
1730
+ SENSITIVE = []
1731
+ include Aws::Structure
1732
+ end
1733
+
1734
+ # @!attribute [rw] job_arn
1735
+ # The Amazon Resource Name (ARN) of the batch inference job.
1736
+ # @return [String]
1737
+ #
1738
+ # @!attribute [rw] job_name
1739
+ # The name of the batch inference job.
1740
+ # @return [String]
1741
+ #
1742
+ # @!attribute [rw] model_id
1743
+ # The unique identifier of the foundation model used for model
1744
+ # inference.
1745
+ # @return [String]
1746
+ #
1747
+ # @!attribute [rw] client_request_token
1748
+ # A unique, case-sensitive identifier to ensure that the API request
1749
+ # completes no more than one time. If this token matches a previous
1750
+ # request, Amazon Bedrock ignores the request, but does not return an
1751
+ # error. For more information, see [Ensuring idempotency][1].
1752
+ #
1753
+ #
1754
+ #
1755
+ # [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
1756
+ # @return [String]
1757
+ #
1758
+ # @!attribute [rw] role_arn
1759
+ # The Amazon Resource Name (ARN) of the service role with permissions
1760
+ # to carry out and manage batch inference. You can use the console to
1761
+ # create a default service role or follow the steps at [Create a
1762
+ # service role for batch inference][1].
1763
+ #
1764
+ #
1765
+ #
1766
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/batch-iam-sr.html
1767
+ # @return [String]
1768
+ #
1769
+ # @!attribute [rw] status
1770
+ # The status of the batch inference job.
1771
+ # @return [String]
1772
+ #
1773
+ # @!attribute [rw] message
1774
+ # If the batch inference job failed, this field contains a message
1775
+ # describing why the job failed.
1776
+ # @return [String]
1777
+ #
1778
+ # @!attribute [rw] submit_time
1779
+ # The time at which the batch inference job was submitted.
1780
+ # @return [Time]
1781
+ #
1782
+ # @!attribute [rw] last_modified_time
1783
+ # The time at which the batch inference job was last modified.
1784
+ # @return [Time]
1785
+ #
1786
+ # @!attribute [rw] end_time
1787
+ # The time at which the batch inference job ended.
1788
+ # @return [Time]
1789
+ #
1790
+ # @!attribute [rw] input_data_config
1791
+ # Details about the location of the input to the batch inference job.
1792
+ # @return [Types::ModelInvocationJobInputDataConfig]
1793
+ #
1794
+ # @!attribute [rw] output_data_config
1795
+ # Details about the location of the output of the batch inference job.
1796
+ # @return [Types::ModelInvocationJobOutputDataConfig]
1797
+ #
1798
+ # @!attribute [rw] timeout_duration_in_hours
1799
+ # The number of hours after which batch inference job was set to time
1800
+ # out.
1801
+ # @return [Integer]
1802
+ #
1803
+ # @!attribute [rw] job_expiration_time
1804
+ # The time at which the batch inference job times or timed out.
1805
+ # @return [Time]
1806
+ #
1807
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GetModelInvocationJobResponse AWS API Documentation
1808
+ #
1809
+ class GetModelInvocationJobResponse < Struct.new(
1810
+ :job_arn,
1811
+ :job_name,
1812
+ :model_id,
1813
+ :client_request_token,
1814
+ :role_arn,
1815
+ :status,
1816
+ :message,
1817
+ :submit_time,
1818
+ :last_modified_time,
1819
+ :end_time,
1820
+ :input_data_config,
1821
+ :output_data_config,
1822
+ :timeout_duration_in_hours,
1823
+ :job_expiration_time)
1824
+ SENSITIVE = [:message]
1825
+ include Aws::Structure
1826
+ end
1827
+
1495
1828
  # @api private
1496
1829
  #
1497
1830
  # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GetModelInvocationLoggingConfigurationRequest AWS API Documentation
@@ -1891,7 +2224,7 @@ module Aws::Bedrock
1891
2224
  # The PII entity configured for the guardrail.
1892
2225
  #
1893
2226
  # @!attribute [rw] type
1894
- # The type of PII entity. For example, Social Security Number.
2227
+ # The type of PII entity. For exampvle, Social Security Number.
1895
2228
  # @return [String]
1896
2229
  #
1897
2230
  # @!attribute [rw] action
@@ -2619,12 +2952,17 @@ module Aws::Bedrock
2619
2952
  # @return [String]
2620
2953
  #
2621
2954
  # @!attribute [rw] max_results
2622
- # Maximum number of results to return in the response.
2955
+ # The maximum number of results to return in the response. If the
2956
+ # total number of results is greater than this value, use the token
2957
+ # returned in the response in the `nextToken` field when making
2958
+ # another request to return the next batch of results.
2623
2959
  # @return [Integer]
2624
2960
  #
2625
2961
  # @!attribute [rw] next_token
2626
- # Continuation token from the previous response, for Amazon Bedrock to
2627
- # list the next set of results.
2962
+ # If the total number of results is greater than the `maxResults`
2963
+ # value provided in the request, enter the token returned in the
2964
+ # `nextToken` field in the response in this field to return the next
2965
+ # batch of results.
2628
2966
  # @return [String]
2629
2967
  #
2630
2968
  # @!attribute [rw] sort_by
@@ -2635,6 +2973,11 @@ module Aws::Bedrock
2635
2973
  # The sort order of the results.
2636
2974
  # @return [String]
2637
2975
  #
2976
+ # @!attribute [rw] is_owned
2977
+ # Return custom models depending on if the current account owns them
2978
+ # (`true`) or if they were shared with the current account (`false`).
2979
+ # @return [Boolean]
2980
+ #
2638
2981
  # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ListCustomModelsRequest AWS API Documentation
2639
2982
  #
2640
2983
  class ListCustomModelsRequest < Struct.new(
@@ -2646,13 +2989,16 @@ module Aws::Bedrock
2646
2989
  :max_results,
2647
2990
  :next_token,
2648
2991
  :sort_by,
2649
- :sort_order)
2992
+ :sort_order,
2993
+ :is_owned)
2650
2994
  SENSITIVE = []
2651
2995
  include Aws::Structure
2652
2996
  end
2653
2997
 
2654
2998
  # @!attribute [rw] next_token
2655
- # Continuation token for the next request to list the next set of
2999
+ # If the total number of results is greater than the `maxResults`
3000
+ # value provided in the request, use this token when making another
3001
+ # request in the `nextToken` field to return the next batch of
2656
3002
  # results.
2657
3003
  # @return [String]
2658
3004
  #
@@ -2743,12 +3089,13 @@ module Aws::Bedrock
2743
3089
  #
2744
3090
  # @!attribute [rw] by_customization_type
2745
3091
  # Return models that support the customization type that you specify.
2746
- # For more information, see [Custom models][1] in the Amazon Bedrock
2747
- # User Guide.
3092
+ # For more information, see [Custom models][1] in the [Amazon Bedrock
3093
+ # User Guide][2].
2748
3094
  #
2749
3095
  #
2750
3096
  #
2751
3097
  # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models.html
3098
+ # [2]: https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html
2752
3099
  # @return [String]
2753
3100
  #
2754
3101
  # @!attribute [rw] by_output_modality
@@ -2757,12 +3104,13 @@ module Aws::Bedrock
2757
3104
  #
2758
3105
  # @!attribute [rw] by_inference_type
2759
3106
  # Return models that support the inference type that you specify. For
2760
- # more information, see [Provisioned Throughput][1] in the Amazon
2761
- # Bedrock User Guide.
3107
+ # more information, see [Provisioned Throughput][1] in the [Amazon
3108
+ # Bedrock User Guide][2].
2762
3109
  #
2763
3110
  #
2764
3111
  #
2765
3112
  # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/prov-throughput.html
3113
+ # [2]: https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html
2766
3114
  # @return [String]
2767
3115
  #
2768
3116
  # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ListFoundationModelsRequest AWS API Documentation
@@ -2832,6 +3180,94 @@ module Aws::Bedrock
2832
3180
  include Aws::Structure
2833
3181
  end
2834
3182
 
3183
+ # @!attribute [rw] creation_time_after
3184
+ # Filters for model copy jobs created after the specified time.
3185
+ # @return [Time]
3186
+ #
3187
+ # @!attribute [rw] creation_time_before
3188
+ # Filters for model copy jobs created before the specified time.
3189
+ # @return [Time]
3190
+ #
3191
+ # @!attribute [rw] status_equals
3192
+ # Filters for model copy jobs whose status matches the value that you
3193
+ # specify.
3194
+ # @return [String]
3195
+ #
3196
+ # @!attribute [rw] source_account_equals
3197
+ # Filters for model copy jobs in which the account that the source
3198
+ # model belongs to is equal to the value that you specify.
3199
+ # @return [String]
3200
+ #
3201
+ # @!attribute [rw] source_model_arn_equals
3202
+ # Filters for model copy jobs in which the Amazon Resource Name (ARN)
3203
+ # of the source model to is equal to the value that you specify.
3204
+ # @return [String]
3205
+ #
3206
+ # @!attribute [rw] target_model_name_contains
3207
+ # Filters for model copy jobs in which the name of the copied model
3208
+ # contains the string that you specify.
3209
+ # @return [String]
3210
+ #
3211
+ # @!attribute [rw] max_results
3212
+ # The maximum number of results to return in the response. If the
3213
+ # total number of results is greater than this value, use the token
3214
+ # returned in the response in the `nextToken` field when making
3215
+ # another request to return the next batch of results.
3216
+ # @return [Integer]
3217
+ #
3218
+ # @!attribute [rw] next_token
3219
+ # If the total number of results is greater than the `maxResults`
3220
+ # value provided in the request, enter the token returned in the
3221
+ # `nextToken` field in the response in this field to return the next
3222
+ # batch of results.
3223
+ # @return [String]
3224
+ #
3225
+ # @!attribute [rw] sort_by
3226
+ # The field to sort by in the returned list of model copy jobs.
3227
+ # @return [String]
3228
+ #
3229
+ # @!attribute [rw] sort_order
3230
+ # Specifies whether to sort the results in ascending or descending
3231
+ # order.
3232
+ # @return [String]
3233
+ #
3234
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ListModelCopyJobsRequest AWS API Documentation
3235
+ #
3236
+ class ListModelCopyJobsRequest < Struct.new(
3237
+ :creation_time_after,
3238
+ :creation_time_before,
3239
+ :status_equals,
3240
+ :source_account_equals,
3241
+ :source_model_arn_equals,
3242
+ :target_model_name_contains,
3243
+ :max_results,
3244
+ :next_token,
3245
+ :sort_by,
3246
+ :sort_order)
3247
+ SENSITIVE = []
3248
+ include Aws::Structure
3249
+ end
3250
+
3251
+ # @!attribute [rw] next_token
3252
+ # If the total number of results is greater than the `maxResults`
3253
+ # value provided in the request, use this token when making another
3254
+ # request in the `nextToken` field to return the next batch of
3255
+ # results.
3256
+ # @return [String]
3257
+ #
3258
+ # @!attribute [rw] model_copy_job_summaries
3259
+ # A list of information about each model copy job.
3260
+ # @return [Array<Types::ModelCopyJobSummary>]
3261
+ #
3262
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ListModelCopyJobsResponse AWS API Documentation
3263
+ #
3264
+ class ListModelCopyJobsResponse < Struct.new(
3265
+ :next_token,
3266
+ :model_copy_job_summaries)
3267
+ SENSITIVE = []
3268
+ include Aws::Structure
3269
+ end
3270
+
2835
3271
  # @!attribute [rw] creation_time_after
2836
3272
  # Return customization jobs created after the specified time.
2837
3273
  # @return [Time]
@@ -2850,12 +3286,17 @@ module Aws::Bedrock
2850
3286
  # @return [String]
2851
3287
  #
2852
3288
  # @!attribute [rw] max_results
2853
- # Maximum number of results to return in the response.
3289
+ # The maximum number of results to return in the response. If the
3290
+ # total number of results is greater than this value, use the token
3291
+ # returned in the response in the `nextToken` field when making
3292
+ # another request to return the next batch of results.
2854
3293
  # @return [Integer]
2855
3294
  #
2856
3295
  # @!attribute [rw] next_token
2857
- # Continuation token from the previous response, for Amazon Bedrock to
2858
- # list the next set of results.
3296
+ # If the total number of results is greater than the `maxResults`
3297
+ # value provided in the request, enter the token returned in the
3298
+ # `nextToken` field in the response in this field to return the next
3299
+ # batch of results.
2859
3300
  # @return [String]
2860
3301
  #
2861
3302
  # @!attribute [rw] sort_by
@@ -2882,7 +3323,10 @@ module Aws::Bedrock
2882
3323
  end
2883
3324
 
2884
3325
  # @!attribute [rw] next_token
2885
- # Page continuation token to use in the next request.
3326
+ # If the total number of results is greater than the `maxResults`
3327
+ # value provided in the request, use this token when making another
3328
+ # request in the `nextToken` field to return the next batch of
3329
+ # results.
2886
3330
  # @return [String]
2887
3331
  #
2888
3332
  # @!attribute [rw] model_customization_job_summaries
@@ -2898,6 +3342,85 @@ module Aws::Bedrock
2898
3342
  include Aws::Structure
2899
3343
  end
2900
3344
 
3345
+ # @!attribute [rw] submit_time_after
3346
+ # Specify a time to filter for batch inference jobs that were
3347
+ # submitted after the time you specify.
3348
+ # @return [Time]
3349
+ #
3350
+ # @!attribute [rw] submit_time_before
3351
+ # Specify a time to filter for batch inference jobs that were
3352
+ # submitted before the time you specify.
3353
+ # @return [Time]
3354
+ #
3355
+ # @!attribute [rw] status_equals
3356
+ # Specify a status to filter for batch inference jobs whose statuses
3357
+ # match the string you specify.
3358
+ # @return [String]
3359
+ #
3360
+ # @!attribute [rw] name_contains
3361
+ # Specify a string to filter for batch inference jobs whose names
3362
+ # contain the string.
3363
+ # @return [String]
3364
+ #
3365
+ # @!attribute [rw] max_results
3366
+ # The maximum number of results to return. If there are more results
3367
+ # than the number that you specify, a `nextToken` value is returned.
3368
+ # Use the `nextToken` in a request to return the next batch of
3369
+ # results.
3370
+ # @return [Integer]
3371
+ #
3372
+ # @!attribute [rw] next_token
3373
+ # If there were more results than the value you specified in the
3374
+ # `maxResults` field in a previous `ListModelInvocationJobs` request,
3375
+ # the response would have returned a `nextToken` value. To see the
3376
+ # next batch of results, send the `nextToken` value in another
3377
+ # request.
3378
+ # @return [String]
3379
+ #
3380
+ # @!attribute [rw] sort_by
3381
+ # An attribute by which to sort the results.
3382
+ # @return [String]
3383
+ #
3384
+ # @!attribute [rw] sort_order
3385
+ # Specifies whether to sort the results by ascending or descending
3386
+ # order.
3387
+ # @return [String]
3388
+ #
3389
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ListModelInvocationJobsRequest AWS API Documentation
3390
+ #
3391
+ class ListModelInvocationJobsRequest < Struct.new(
3392
+ :submit_time_after,
3393
+ :submit_time_before,
3394
+ :status_equals,
3395
+ :name_contains,
3396
+ :max_results,
3397
+ :next_token,
3398
+ :sort_by,
3399
+ :sort_order)
3400
+ SENSITIVE = []
3401
+ include Aws::Structure
3402
+ end
3403
+
3404
+ # @!attribute [rw] next_token
3405
+ # If there are more results than can fit in the response, a
3406
+ # `nextToken` is returned. Use the `nextToken` in a request to return
3407
+ # the next batch of results.
3408
+ # @return [String]
3409
+ #
3410
+ # @!attribute [rw] invocation_job_summaries
3411
+ # A list of items, each of which contains a summary about a batch
3412
+ # inference job.
3413
+ # @return [Array<Types::ModelInvocationJobSummary>]
3414
+ #
3415
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ListModelInvocationJobsResponse AWS API Documentation
3416
+ #
3417
+ class ListModelInvocationJobsResponse < Struct.new(
3418
+ :next_token,
3419
+ :invocation_job_summaries)
3420
+ SENSITIVE = []
3421
+ include Aws::Structure
3422
+ end
3423
+
2901
3424
  # @!attribute [rw] creation_time_after
2902
3425
  # A filter that returns Provisioned Throughputs created after the
2903
3426
  # specified time.
@@ -3041,6 +3564,83 @@ module Aws::Bedrock
3041
3564
  include Aws::Structure
3042
3565
  end
3043
3566
 
3567
+ # Contains details about each model copy job.
3568
+ #
3569
+ # This data type is used in the following API operations:
3570
+ #
3571
+ # * [ListModelCopyJobs response][1]
3572
+ #
3573
+ # ^
3574
+ #
3575
+ #
3576
+ #
3577
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_ListModelCopyJobs.html#API_ListModelCopyJobs_ResponseSyntax
3578
+ #
3579
+ # @!attribute [rw] job_arn
3580
+ # The Amazon Resoource Name (ARN) of the model copy job.
3581
+ # @return [String]
3582
+ #
3583
+ # @!attribute [rw] status
3584
+ # The status of the model copy job.
3585
+ # @return [String]
3586
+ #
3587
+ # @!attribute [rw] creation_time
3588
+ # The time that the model copy job was created.
3589
+ # @return [Time]
3590
+ #
3591
+ # @!attribute [rw] target_model_arn
3592
+ # The Amazon Resource Name (ARN) of the copied model.
3593
+ # @return [String]
3594
+ #
3595
+ # @!attribute [rw] target_model_name
3596
+ # The name of the copied model.
3597
+ # @return [String]
3598
+ #
3599
+ # @!attribute [rw] source_account_id
3600
+ # The unique identifier of the account that the model being copied
3601
+ # originated from.
3602
+ # @return [String]
3603
+ #
3604
+ # @!attribute [rw] source_model_arn
3605
+ # The Amazon Resource Name (ARN) of the original model being copied.
3606
+ # @return [String]
3607
+ #
3608
+ # @!attribute [rw] target_model_kms_key_arn
3609
+ # The Amazon Resource Name (ARN) of the KMS key used to encrypt the
3610
+ # copied model.
3611
+ # @return [String]
3612
+ #
3613
+ # @!attribute [rw] target_model_tags
3614
+ # Tags associated with the copied model.
3615
+ # @return [Array<Types::Tag>]
3616
+ #
3617
+ # @!attribute [rw] failure_message
3618
+ # If a model fails to be copied, a message describing why the job
3619
+ # failed is included here.
3620
+ # @return [String]
3621
+ #
3622
+ # @!attribute [rw] source_model_name
3623
+ # The name of the original model being copied.
3624
+ # @return [String]
3625
+ #
3626
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ModelCopyJobSummary AWS API Documentation
3627
+ #
3628
+ class ModelCopyJobSummary < Struct.new(
3629
+ :job_arn,
3630
+ :status,
3631
+ :creation_time,
3632
+ :target_model_arn,
3633
+ :target_model_name,
3634
+ :source_account_id,
3635
+ :source_model_arn,
3636
+ :target_model_kms_key_arn,
3637
+ :target_model_tags,
3638
+ :failure_message,
3639
+ :source_model_name)
3640
+ SENSITIVE = []
3641
+ include Aws::Structure
3642
+ end
3643
+
3044
3644
  # Information about one customization job
3045
3645
  #
3046
3646
  # @!attribute [rw] job_arn
@@ -3106,6 +3706,187 @@ module Aws::Bedrock
3106
3706
  include Aws::Structure
3107
3707
  end
3108
3708
 
3709
+ # Details about the location of the input to the batch inference job.
3710
+ #
3711
+ # @note ModelInvocationJobInputDataConfig is a union - when making an API calls you must set exactly one of the members.
3712
+ #
3713
+ # @note ModelInvocationJobInputDataConfig is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of ModelInvocationJobInputDataConfig corresponding to the set member.
3714
+ #
3715
+ # @!attribute [rw] s3_input_data_config
3716
+ # Contains the configuration of the S3 location of the input data.
3717
+ # @return [Types::ModelInvocationJobS3InputDataConfig]
3718
+ #
3719
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ModelInvocationJobInputDataConfig AWS API Documentation
3720
+ #
3721
+ class ModelInvocationJobInputDataConfig < Struct.new(
3722
+ :s3_input_data_config,
3723
+ :unknown)
3724
+ SENSITIVE = []
3725
+ include Aws::Structure
3726
+ include Aws::Structure::Union
3727
+
3728
+ class S3InputDataConfig < ModelInvocationJobInputDataConfig; end
3729
+ class Unknown < ModelInvocationJobInputDataConfig; end
3730
+ end
3731
+
3732
+ # Contains the configuration of the S3 location of the output data.
3733
+ #
3734
+ # @note ModelInvocationJobOutputDataConfig is a union - when making an API calls you must set exactly one of the members.
3735
+ #
3736
+ # @note ModelInvocationJobOutputDataConfig is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of ModelInvocationJobOutputDataConfig corresponding to the set member.
3737
+ #
3738
+ # @!attribute [rw] s3_output_data_config
3739
+ # Contains the configuration of the S3 location of the output data.
3740
+ # @return [Types::ModelInvocationJobS3OutputDataConfig]
3741
+ #
3742
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ModelInvocationJobOutputDataConfig AWS API Documentation
3743
+ #
3744
+ class ModelInvocationJobOutputDataConfig < Struct.new(
3745
+ :s3_output_data_config,
3746
+ :unknown)
3747
+ SENSITIVE = []
3748
+ include Aws::Structure
3749
+ include Aws::Structure::Union
3750
+
3751
+ class S3OutputDataConfig < ModelInvocationJobOutputDataConfig; end
3752
+ class Unknown < ModelInvocationJobOutputDataConfig; end
3753
+ end
3754
+
3755
+ # Contains the configuration of the S3 location of the output data.
3756
+ #
3757
+ # @!attribute [rw] s3_input_format
3758
+ # The format of the input data.
3759
+ # @return [String]
3760
+ #
3761
+ # @!attribute [rw] s3_uri
3762
+ # The S3 location of the input data.
3763
+ # @return [String]
3764
+ #
3765
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ModelInvocationJobS3InputDataConfig AWS API Documentation
3766
+ #
3767
+ class ModelInvocationJobS3InputDataConfig < Struct.new(
3768
+ :s3_input_format,
3769
+ :s3_uri)
3770
+ SENSITIVE = []
3771
+ include Aws::Structure
3772
+ end
3773
+
3774
+ # Contains the configuration of the S3 location of the output data.
3775
+ #
3776
+ # @!attribute [rw] s3_uri
3777
+ # The S3 location of the output data.
3778
+ # @return [String]
3779
+ #
3780
+ # @!attribute [rw] s3_encryption_key_id
3781
+ # The unique identifier of the key that encrypts the S3 location of
3782
+ # the output data.
3783
+ # @return [String]
3784
+ #
3785
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ModelInvocationJobS3OutputDataConfig AWS API Documentation
3786
+ #
3787
+ class ModelInvocationJobS3OutputDataConfig < Struct.new(
3788
+ :s3_uri,
3789
+ :s3_encryption_key_id)
3790
+ SENSITIVE = []
3791
+ include Aws::Structure
3792
+ end
3793
+
3794
+ # A summary of a batch inference job.
3795
+ #
3796
+ # @!attribute [rw] job_arn
3797
+ # The Amazon Resource Name (ARN) of the batch inference job.
3798
+ # @return [String]
3799
+ #
3800
+ # @!attribute [rw] job_name
3801
+ # The name of the batch inference job.
3802
+ # @return [String]
3803
+ #
3804
+ # @!attribute [rw] model_id
3805
+ # The unique identifier of the foundation model used for model
3806
+ # inference.
3807
+ # @return [String]
3808
+ #
3809
+ # @!attribute [rw] client_request_token
3810
+ # A unique, case-sensitive identifier to ensure that the API request
3811
+ # completes no more than one time. If this token matches a previous
3812
+ # request, Amazon Bedrock ignores the request, but does not return an
3813
+ # error. For more information, see [Ensuring idempotency][1].
3814
+ #
3815
+ #
3816
+ #
3817
+ # [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
3818
+ # @return [String]
3819
+ #
3820
+ # @!attribute [rw] role_arn
3821
+ # The Amazon Resource Name (ARN) of the service role with permissions
3822
+ # to carry out and manage batch inference. You can use the console to
3823
+ # create a default service role or follow the steps at [Create a
3824
+ # service role for batch inference][1].
3825
+ #
3826
+ #
3827
+ #
3828
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/batch-iam-sr.html
3829
+ # @return [String]
3830
+ #
3831
+ # @!attribute [rw] status
3832
+ # The status of the batch inference job.
3833
+ # @return [String]
3834
+ #
3835
+ # @!attribute [rw] message
3836
+ # If the batch inference job failed, this field contains a message
3837
+ # describing why the job failed.
3838
+ # @return [String]
3839
+ #
3840
+ # @!attribute [rw] submit_time
3841
+ # The time at which the batch inference job was submitted.
3842
+ # @return [Time]
3843
+ #
3844
+ # @!attribute [rw] last_modified_time
3845
+ # The time at which the batch inference job was last modified.
3846
+ # @return [Time]
3847
+ #
3848
+ # @!attribute [rw] end_time
3849
+ # The time at which the batch inference job ended.
3850
+ # @return [Time]
3851
+ #
3852
+ # @!attribute [rw] input_data_config
3853
+ # Details about the location of the input to the batch inference job.
3854
+ # @return [Types::ModelInvocationJobInputDataConfig]
3855
+ #
3856
+ # @!attribute [rw] output_data_config
3857
+ # Details about the location of the output of the batch inference job.
3858
+ # @return [Types::ModelInvocationJobOutputDataConfig]
3859
+ #
3860
+ # @!attribute [rw] timeout_duration_in_hours
3861
+ # The number of hours after which the batch inference job was set to
3862
+ # time out.
3863
+ # @return [Integer]
3864
+ #
3865
+ # @!attribute [rw] job_expiration_time
3866
+ # The time at which the batch inference job times or timed out.
3867
+ # @return [Time]
3868
+ #
3869
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ModelInvocationJobSummary AWS API Documentation
3870
+ #
3871
+ class ModelInvocationJobSummary < Struct.new(
3872
+ :job_arn,
3873
+ :job_name,
3874
+ :model_id,
3875
+ :client_request_token,
3876
+ :role_arn,
3877
+ :status,
3878
+ :message,
3879
+ :submit_time,
3880
+ :last_modified_time,
3881
+ :end_time,
3882
+ :input_data_config,
3883
+ :output_data_config,
3884
+ :timeout_duration_in_hours,
3885
+ :job_expiration_time)
3886
+ SENSITIVE = [:message]
3887
+ include Aws::Structure
3888
+ end
3889
+
3109
3890
  # S3 Location of the output data.
3110
3891
  #
3111
3892
  # @!attribute [rw] s3_uri
@@ -3302,6 +4083,22 @@ module Aws::Bedrock
3302
4083
  #
3303
4084
  class StopModelCustomizationJobResponse < Aws::EmptyStructure; end
3304
4085
 
4086
+ # @!attribute [rw] job_identifier
4087
+ # The Amazon Resource Name (ARN) of the batch inference job to stop.
4088
+ # @return [String]
4089
+ #
4090
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/StopModelInvocationJobRequest AWS API Documentation
4091
+ #
4092
+ class StopModelInvocationJobRequest < Struct.new(
4093
+ :job_identifier)
4094
+ SENSITIVE = []
4095
+ include Aws::Structure
4096
+ end
4097
+
4098
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/StopModelInvocationJobResponse AWS API Documentation
4099
+ #
4100
+ class StopModelInvocationJobResponse < Aws::EmptyStructure; end
4101
+
3305
4102
  # Definition of the key/value pair for a tag.
3306
4103
  #
3307
4104
  # @!attribute [rw] key