aws-sdk-sagemaker 1.252.0 → 1.254.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -223,6 +223,27 @@ module Aws::SageMaker
223
223
  include Aws::Structure
224
224
  end
225
225
 
226
+ # Data sources that are available to your model in addition to the one
227
+ # that you specify for `ModelDataSource` when you use the `CreateModel`
228
+ # action.
229
+ #
230
+ # @!attribute [rw] channel_name
231
+ # A custom name for this `AdditionalModelDataSource` object.
232
+ # @return [String]
233
+ #
234
+ # @!attribute [rw] s3_data_source
235
+ # Specifies the S3 location of ML model data to deploy.
236
+ # @return [Types::S3ModelDataSource]
237
+ #
238
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/AdditionalModelDataSource AWS API Documentation
239
+ #
240
+ class AdditionalModelDataSource < Struct.new(
241
+ :channel_name,
242
+ :s3_data_source)
243
+ SENSITIVE = []
244
+ include Aws::Structure
245
+ end
246
+
226
247
  # A data source used for training or inference that is in addition to
227
248
  # the input dataset or model data.
228
249
  #
@@ -593,6 +614,26 @@ module Aws::SageMaker
593
614
  include Aws::Structure
594
615
  end
595
616
 
617
+ # A collection of settings that configure the Amazon Q experience within
618
+ # the domain.
619
+ #
620
+ # @!attribute [rw] status
621
+ # Whether Amazon Q has been enabled within the domain.
622
+ # @return [String]
623
+ #
624
+ # @!attribute [rw] q_profile_arn
625
+ # The ARN of the Amazon Q profile used within the domain.
626
+ # @return [String]
627
+ #
628
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/AmazonQSettings AWS API Documentation
629
+ #
630
+ class AmazonQSettings < Struct.new(
631
+ :status,
632
+ :q_profile_arn)
633
+ SENSITIVE = []
634
+ include Aws::Structure
635
+ end
636
+
596
637
  # Configures how labels are consolidated across human workers and
597
638
  # processes output data.
598
639
  #
@@ -4812,6 +4853,12 @@ module Aws::SageMaker
4812
4853
  # </note>
4813
4854
  # @return [Types::ModelDataSource]
4814
4855
  #
4856
+ # @!attribute [rw] additional_model_data_sources
4857
+ # Data sources that are available to your model in addition to the one
4858
+ # that you specify for `ModelDataSource` when you use the
4859
+ # `CreateModel` action.
4860
+ # @return [Array<Types::AdditionalModelDataSource>]
4861
+ #
4815
4862
  # @!attribute [rw] environment
4816
4863
  # The environment variables to set in the Docker container.
4817
4864
  #
@@ -4844,6 +4891,7 @@ module Aws::SageMaker
4844
4891
  :mode,
4845
4892
  :model_data_url,
4846
4893
  :model_data_source,
4894
+ :additional_model_data_sources,
4847
4895
  :environment,
4848
4896
  :model_package_name,
4849
4897
  :inference_specification_name,
@@ -8674,6 +8722,126 @@ module Aws::SageMaker
8674
8722
  include Aws::Structure
8675
8723
  end
8676
8724
 
8725
+ # @!attribute [rw] optimization_job_name
8726
+ # A custom name for the new optimization job.
8727
+ # @return [String]
8728
+ #
8729
+ # @!attribute [rw] role_arn
8730
+ # The Amazon Resource Name (ARN) of an IAM role that enables Amazon
8731
+ # SageMaker to perform tasks on your behalf.
8732
+ #
8733
+ # During model optimization, Amazon SageMaker needs your permission
8734
+ # to:
8735
+ #
8736
+ # * Read input data from an S3 bucket
8737
+ #
8738
+ # * Write model artifacts to an S3 bucket
8739
+ #
8740
+ # * Write logs to Amazon CloudWatch Logs
8741
+ #
8742
+ # * Publish metrics to Amazon CloudWatch
8743
+ #
8744
+ # You grant permissions for all of these tasks to an IAM role. To pass
8745
+ # this role to Amazon SageMaker, the caller of this API must have the
8746
+ # `iam:PassRole` permission. For more information, see [Amazon
8747
+ # SageMaker Roles.][1]
8748
+ #
8749
+ #
8750
+ #
8751
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html
8752
+ # @return [String]
8753
+ #
8754
+ # @!attribute [rw] model_source
8755
+ # The location of the source model to optimize with an optimization
8756
+ # job.
8757
+ # @return [Types::OptimizationJobModelSource]
8758
+ #
8759
+ # @!attribute [rw] deployment_instance_type
8760
+ # The type of instance that hosts the optimized model that you create
8761
+ # with the optimization job.
8762
+ # @return [String]
8763
+ #
8764
+ # @!attribute [rw] optimization_environment
8765
+ # The environment variables to set in the model container.
8766
+ # @return [Hash<String,String>]
8767
+ #
8768
+ # @!attribute [rw] optimization_configs
8769
+ # Settings for each of the optimization techniques that the job
8770
+ # applies.
8771
+ # @return [Array<Types::OptimizationConfig>]
8772
+ #
8773
+ # @!attribute [rw] output_config
8774
+ # Details for where to store the optimized model that you create with
8775
+ # the optimization job.
8776
+ # @return [Types::OptimizationJobOutputConfig]
8777
+ #
8778
+ # @!attribute [rw] stopping_condition
8779
+ # Specifies a limit to how long a job can run. When the job reaches
8780
+ # the time limit, SageMaker ends the job. Use this API to cap costs.
8781
+ #
8782
+ # To stop a training job, SageMaker sends the algorithm the `SIGTERM`
8783
+ # signal, which delays job termination for 120 seconds. Algorithms can
8784
+ # use this 120-second window to save the model artifacts, so the
8785
+ # results of training are not lost.
8786
+ #
8787
+ # The training algorithms provided by SageMaker automatically save the
8788
+ # intermediate results of a model training job when possible. This
8789
+ # attempt to save artifacts is only a best effort case as model might
8790
+ # not be in a state from which it can be saved. For example, if
8791
+ # training has just started, the model might not be ready to save.
8792
+ # When saved, this intermediate data is a valid model artifact. You
8793
+ # can use it to create a model with `CreateModel`.
8794
+ #
8795
+ # <note markdown="1"> The Neural Topic Model (NTM) currently does not support saving
8796
+ # intermediate model artifacts. When training NTMs, make sure that the
8797
+ # maximum runtime is sufficient for the training job to complete.
8798
+ #
8799
+ # </note>
8800
+ # @return [Types::StoppingCondition]
8801
+ #
8802
+ # @!attribute [rw] tags
8803
+ # A list of key-value pairs associated with the optimization job. For
8804
+ # more information, see [Tagging Amazon Web Services resources][1] in
8805
+ # the *Amazon Web Services General Reference Guide*.
8806
+ #
8807
+ #
8808
+ #
8809
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
8810
+ # @return [Array<Types::Tag>]
8811
+ #
8812
+ # @!attribute [rw] vpc_config
8813
+ # A VPC in Amazon VPC that your optimized model has access to.
8814
+ # @return [Types::OptimizationVpcConfig]
8815
+ #
8816
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/CreateOptimizationJobRequest AWS API Documentation
8817
+ #
8818
+ class CreateOptimizationJobRequest < Struct.new(
8819
+ :optimization_job_name,
8820
+ :role_arn,
8821
+ :model_source,
8822
+ :deployment_instance_type,
8823
+ :optimization_environment,
8824
+ :optimization_configs,
8825
+ :output_config,
8826
+ :stopping_condition,
8827
+ :tags,
8828
+ :vpc_config)
8829
+ SENSITIVE = []
8830
+ include Aws::Structure
8831
+ end
8832
+
8833
+ # @!attribute [rw] optimization_job_arn
8834
+ # The Amazon Resource Name (ARN) of the optimization job.
8835
+ # @return [String]
8836
+ #
8837
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/CreateOptimizationJobResponse AWS API Documentation
8838
+ #
8839
+ class CreateOptimizationJobResponse < Struct.new(
8840
+ :optimization_job_arn)
8841
+ SENSITIVE = []
8842
+ include Aws::Structure
8843
+ end
8844
+
8677
8845
  # @!attribute [rw] pipeline_name
8678
8846
  # The name of the pipeline.
8679
8847
  # @return [String]
@@ -11386,6 +11554,18 @@ module Aws::SageMaker
11386
11554
  include Aws::Structure
11387
11555
  end
11388
11556
 
11557
+ # @!attribute [rw] optimization_job_name
11558
+ # The name that you assigned to the optimization job.
11559
+ # @return [String]
11560
+ #
11561
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DeleteOptimizationJobRequest AWS API Documentation
11562
+ #
11563
+ class DeleteOptimizationJobRequest < Struct.new(
11564
+ :optimization_job_name)
11565
+ SENSITIVE = []
11566
+ include Aws::Structure
11567
+ end
11568
+
11389
11569
  # @!attribute [rw] pipeline_name
11390
11570
  # The name of the pipeline to delete.
11391
11571
  # @return [String]
@@ -16373,6 +16553,135 @@ module Aws::SageMaker
16373
16553
  include Aws::Structure
16374
16554
  end
16375
16555
 
16556
+ # @!attribute [rw] optimization_job_name
16557
+ # The name that you assigned to the optimization job.
16558
+ # @return [String]
16559
+ #
16560
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DescribeOptimizationJobRequest AWS API Documentation
16561
+ #
16562
+ class DescribeOptimizationJobRequest < Struct.new(
16563
+ :optimization_job_name)
16564
+ SENSITIVE = []
16565
+ include Aws::Structure
16566
+ end
16567
+
16568
+ # @!attribute [rw] optimization_job_arn
16569
+ # The Amazon Resource Name (ARN) of the optimization job.
16570
+ # @return [String]
16571
+ #
16572
+ # @!attribute [rw] optimization_job_status
16573
+ # The current status of the optimization job.
16574
+ # @return [String]
16575
+ #
16576
+ # @!attribute [rw] optimization_start_time
16577
+ # The time when the optimization job started.
16578
+ # @return [Time]
16579
+ #
16580
+ # @!attribute [rw] optimization_end_time
16581
+ # The time when the optimization job finished processing.
16582
+ # @return [Time]
16583
+ #
16584
+ # @!attribute [rw] creation_time
16585
+ # The time when you created the optimization job.
16586
+ # @return [Time]
16587
+ #
16588
+ # @!attribute [rw] last_modified_time
16589
+ # The time when the optimization job was last updated.
16590
+ # @return [Time]
16591
+ #
16592
+ # @!attribute [rw] failure_reason
16593
+ # If the optimization job status is `FAILED`, the reason for the
16594
+ # failure.
16595
+ # @return [String]
16596
+ #
16597
+ # @!attribute [rw] optimization_job_name
16598
+ # The name that you assigned to the optimization job.
16599
+ # @return [String]
16600
+ #
16601
+ # @!attribute [rw] model_source
16602
+ # The location of the source model to optimize with an optimization
16603
+ # job.
16604
+ # @return [Types::OptimizationJobModelSource]
16605
+ #
16606
+ # @!attribute [rw] optimization_environment
16607
+ # The environment variables to set in the model container.
16608
+ # @return [Hash<String,String>]
16609
+ #
16610
+ # @!attribute [rw] deployment_instance_type
16611
+ # The type of instance that hosts the optimized model that you create
16612
+ # with the optimization job.
16613
+ # @return [String]
16614
+ #
16615
+ # @!attribute [rw] optimization_configs
16616
+ # Settings for each of the optimization techniques that the job
16617
+ # applies.
16618
+ # @return [Array<Types::OptimizationConfig>]
16619
+ #
16620
+ # @!attribute [rw] output_config
16621
+ # Details for where to store the optimized model that you create with
16622
+ # the optimization job.
16623
+ # @return [Types::OptimizationJobOutputConfig]
16624
+ #
16625
+ # @!attribute [rw] optimization_output
16626
+ # Output values produced by an optimization job.
16627
+ # @return [Types::OptimizationOutput]
16628
+ #
16629
+ # @!attribute [rw] role_arn
16630
+ # The ARN of the IAM role that you assigned to the optimization job.
16631
+ # @return [String]
16632
+ #
16633
+ # @!attribute [rw] stopping_condition
16634
+ # Specifies a limit to how long a job can run. When the job reaches
16635
+ # the time limit, SageMaker ends the job. Use this API to cap costs.
16636
+ #
16637
+ # To stop a training job, SageMaker sends the algorithm the `SIGTERM`
16638
+ # signal, which delays job termination for 120 seconds. Algorithms can
16639
+ # use this 120-second window to save the model artifacts, so the
16640
+ # results of training are not lost.
16641
+ #
16642
+ # The training algorithms provided by SageMaker automatically save the
16643
+ # intermediate results of a model training job when possible. This
16644
+ # attempt to save artifacts is only a best effort case as model might
16645
+ # not be in a state from which it can be saved. For example, if
16646
+ # training has just started, the model might not be ready to save.
16647
+ # When saved, this intermediate data is a valid model artifact. You
16648
+ # can use it to create a model with `CreateModel`.
16649
+ #
16650
+ # <note markdown="1"> The Neural Topic Model (NTM) currently does not support saving
16651
+ # intermediate model artifacts. When training NTMs, make sure that the
16652
+ # maximum runtime is sufficient for the training job to complete.
16653
+ #
16654
+ # </note>
16655
+ # @return [Types::StoppingCondition]
16656
+ #
16657
+ # @!attribute [rw] vpc_config
16658
+ # A VPC in Amazon VPC that your optimized model has access to.
16659
+ # @return [Types::OptimizationVpcConfig]
16660
+ #
16661
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DescribeOptimizationJobResponse AWS API Documentation
16662
+ #
16663
+ class DescribeOptimizationJobResponse < Struct.new(
16664
+ :optimization_job_arn,
16665
+ :optimization_job_status,
16666
+ :optimization_start_time,
16667
+ :optimization_end_time,
16668
+ :creation_time,
16669
+ :last_modified_time,
16670
+ :failure_reason,
16671
+ :optimization_job_name,
16672
+ :model_source,
16673
+ :optimization_environment,
16674
+ :deployment_instance_type,
16675
+ :optimization_configs,
16676
+ :output_config,
16677
+ :optimization_output,
16678
+ :role_arn,
16679
+ :stopping_condition,
16680
+ :vpc_config)
16681
+ SENSITIVE = []
16682
+ include Aws::Structure
16683
+ end
16684
+
16376
16685
  # @!attribute [rw] pipeline_execution_arn
16377
16686
  # The Amazon Resource Name (ARN) of the pipeline execution.
16378
16687
  # @return [String]
@@ -18292,13 +18601,20 @@ module Aws::SageMaker
18292
18601
  # interaction.
18293
18602
  # @return [Types::DockerSettings]
18294
18603
  #
18604
+ # @!attribute [rw] amazon_q_settings
18605
+ # A collection of settings that configure the Amazon Q experience
18606
+ # within the domain. The `AuthMode` that you use to create the domain
18607
+ # must be `SSO`.
18608
+ # @return [Types::AmazonQSettings]
18609
+ #
18295
18610
  # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DomainSettings AWS API Documentation
18296
18611
  #
18297
18612
  class DomainSettings < Struct.new(
18298
18613
  :security_group_ids,
18299
18614
  :r_studio_server_pro_domain_settings,
18300
18615
  :execution_role_identity_config,
18301
- :docker_settings)
18616
+ :docker_settings,
18617
+ :amazon_q_settings)
18302
18618
  SENSITIVE = []
18303
18619
  include Aws::Structure
18304
18620
  end
@@ -18333,13 +18649,19 @@ module Aws::SageMaker
18333
18649
  # interaction.
18334
18650
  # @return [Types::DockerSettings]
18335
18651
  #
18652
+ # @!attribute [rw] amazon_q_settings
18653
+ # A collection of settings that configure the Amazon Q experience
18654
+ # within the domain.
18655
+ # @return [Types::AmazonQSettings]
18656
+ #
18336
18657
  # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DomainSettingsForUpdate AWS API Documentation
18337
18658
  #
18338
18659
  class DomainSettingsForUpdate < Struct.new(
18339
18660
  :r_studio_server_pro_domain_settings_for_update,
18340
18661
  :execution_role_identity_config,
18341
18662
  :security_group_ids,
18342
- :docker_settings)
18663
+ :docker_settings,
18664
+ :amazon_q_settings)
18343
18665
  SENSITIVE = []
18344
18666
  include Aws::Structure
18345
18667
  end
@@ -29506,6 +29828,99 @@ module Aws::SageMaker
29506
29828
  include Aws::Structure
29507
29829
  end
29508
29830
 
29831
+ # @!attribute [rw] next_token
29832
+ # A token that you use to get the next set of results following a
29833
+ # truncated response. If the response to the previous request was
29834
+ # truncated, that response provides the value for this token.
29835
+ # @return [String]
29836
+ #
29837
+ # @!attribute [rw] max_results
29838
+ # The maximum number of optimization jobs to return in the response.
29839
+ # The default is 50.
29840
+ # @return [Integer]
29841
+ #
29842
+ # @!attribute [rw] creation_time_after
29843
+ # Filters the results to only those optimization jobs that were
29844
+ # created after the specified time.
29845
+ # @return [Time]
29846
+ #
29847
+ # @!attribute [rw] creation_time_before
29848
+ # Filters the results to only those optimization jobs that were
29849
+ # created before the specified time.
29850
+ # @return [Time]
29851
+ #
29852
+ # @!attribute [rw] last_modified_time_after
29853
+ # Filters the results to only those optimization jobs that were
29854
+ # updated after the specified time.
29855
+ # @return [Time]
29856
+ #
29857
+ # @!attribute [rw] last_modified_time_before
29858
+ # Filters the results to only those optimization jobs that were
29859
+ # updated before the specified time.
29860
+ # @return [Time]
29861
+ #
29862
+ # @!attribute [rw] optimization_contains
29863
+ # Filters the results to only those optimization jobs that apply the
29864
+ # specified optimization techniques. You can specify either
29865
+ # `Quantization` or `Compilation`.
29866
+ # @return [String]
29867
+ #
29868
+ # @!attribute [rw] name_contains
29869
+ # Filters the results to only those optimization jobs with a name that
29870
+ # contains the specified string.
29871
+ # @return [String]
29872
+ #
29873
+ # @!attribute [rw] status_equals
29874
+ # Filters the results to only those optimization jobs with the
29875
+ # specified status.
29876
+ # @return [String]
29877
+ #
29878
+ # @!attribute [rw] sort_by
29879
+ # The field by which to sort the optimization jobs in the response.
29880
+ # The default is `CreationTime`
29881
+ # @return [String]
29882
+ #
29883
+ # @!attribute [rw] sort_order
29884
+ # The sort order for results. The default is `Ascending`
29885
+ # @return [String]
29886
+ #
29887
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/ListOptimizationJobsRequest AWS API Documentation
29888
+ #
29889
+ class ListOptimizationJobsRequest < Struct.new(
29890
+ :next_token,
29891
+ :max_results,
29892
+ :creation_time_after,
29893
+ :creation_time_before,
29894
+ :last_modified_time_after,
29895
+ :last_modified_time_before,
29896
+ :optimization_contains,
29897
+ :name_contains,
29898
+ :status_equals,
29899
+ :sort_by,
29900
+ :sort_order)
29901
+ SENSITIVE = []
29902
+ include Aws::Structure
29903
+ end
29904
+
29905
+ # @!attribute [rw] optimization_job_summaries
29906
+ # A list of optimization jobs and their properties that matches any of
29907
+ # the filters you specified in the request.
29908
+ # @return [Array<Types::OptimizationJobSummary>]
29909
+ #
29910
+ # @!attribute [rw] next_token
29911
+ # The token to use in a subsequent request to get the next set of
29912
+ # results following a truncated response.
29913
+ # @return [String]
29914
+ #
29915
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/ListOptimizationJobsResponse AWS API Documentation
29916
+ #
29917
+ class ListOptimizationJobsResponse < Struct.new(
29918
+ :optimization_job_summaries,
29919
+ :next_token)
29920
+ SENSITIVE = []
29921
+ include Aws::Structure
29922
+ end
29923
+
29509
29924
  # @!attribute [rw] pipeline_execution_arn
29510
29925
  # The Amazon Resource Name (ARN) of the pipeline execution.
29511
29926
  # @return [String]
@@ -31544,6 +31959,28 @@ module Aws::SageMaker
31544
31959
  include Aws::Structure
31545
31960
  end
31546
31961
 
31962
+ # Settings for the model compilation technique that's applied by a
31963
+ # model optimization job.
31964
+ #
31965
+ # @!attribute [rw] image
31966
+ # The URI of an LMI DLC in Amazon ECR. SageMaker uses this image to
31967
+ # run the optimization.
31968
+ # @return [String]
31969
+ #
31970
+ # @!attribute [rw] override_environment
31971
+ # Environment variables that override the default ones in the model
31972
+ # container.
31973
+ # @return [Hash<String,String>]
31974
+ #
31975
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/ModelCompilationConfig AWS API Documentation
31976
+ #
31977
+ class ModelCompilationConfig < Struct.new(
31978
+ :image,
31979
+ :override_environment)
31980
+ SENSITIVE = []
31981
+ include Aws::Structure
31982
+ end
31983
+
31547
31984
  # Defines the model configuration. Includes the specification name and
31548
31985
  # environment parameters.
31549
31986
  #
@@ -32887,6 +33324,28 @@ module Aws::SageMaker
32887
33324
  include Aws::Structure
32888
33325
  end
32889
33326
 
33327
+ # Settings for the model quantization technique that's applied by a
33328
+ # model optimization job.
33329
+ #
33330
+ # @!attribute [rw] image
33331
+ # The URI of an LMI DLC in Amazon ECR. SageMaker uses this image to
33332
+ # run the optimization.
33333
+ # @return [String]
33334
+ #
33335
+ # @!attribute [rw] override_environment
33336
+ # Environment variables that override the default ones in the model
33337
+ # container.
33338
+ # @return [Hash<String,String>]
33339
+ #
33340
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/ModelQuantizationConfig AWS API Documentation
33341
+ #
33342
+ class ModelQuantizationConfig < Struct.new(
33343
+ :image,
33344
+ :override_environment)
33345
+ SENSITIVE = []
33346
+ include Aws::Structure
33347
+ end
33348
+
32890
33349
  # The model registry settings for the SageMaker Canvas application.
32891
33350
  #
32892
33351
  # @!attribute [rw] status
@@ -34473,6 +34932,221 @@ module Aws::SageMaker
34473
34932
  include Aws::Structure
34474
34933
  end
34475
34934
 
34935
+ # Settings for an optimization technique that you apply with a model
34936
+ # optimization job.
34937
+ #
34938
+ # @note OptimizationConfig is a union - when making an API calls you must set exactly one of the members.
34939
+ #
34940
+ # @note OptimizationConfig is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of OptimizationConfig corresponding to the set member.
34941
+ #
34942
+ # @!attribute [rw] model_quantization_config
34943
+ # Settings for the model quantization technique that's applied by a
34944
+ # model optimization job.
34945
+ # @return [Types::ModelQuantizationConfig]
34946
+ #
34947
+ # @!attribute [rw] model_compilation_config
34948
+ # Settings for the model compilation technique that's applied by a
34949
+ # model optimization job.
34950
+ # @return [Types::ModelCompilationConfig]
34951
+ #
34952
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/OptimizationConfig AWS API Documentation
34953
+ #
34954
+ class OptimizationConfig < Struct.new(
34955
+ :model_quantization_config,
34956
+ :model_compilation_config,
34957
+ :unknown)
34958
+ SENSITIVE = []
34959
+ include Aws::Structure
34960
+ include Aws::Structure::Union
34961
+
34962
+ class ModelQuantizationConfig < OptimizationConfig; end
34963
+ class ModelCompilationConfig < OptimizationConfig; end
34964
+ class Unknown < OptimizationConfig; end
34965
+ end
34966
+
34967
+ # The location of the source model to optimize with an optimization job.
34968
+ #
34969
+ # @!attribute [rw] s3
34970
+ # The Amazon S3 location of a source model to optimize with an
34971
+ # optimization job.
34972
+ # @return [Types::OptimizationJobModelSourceS3]
34973
+ #
34974
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/OptimizationJobModelSource AWS API Documentation
34975
+ #
34976
+ class OptimizationJobModelSource < Struct.new(
34977
+ :s3)
34978
+ SENSITIVE = []
34979
+ include Aws::Structure
34980
+ end
34981
+
34982
+ # The Amazon S3 location of a source model to optimize with an
34983
+ # optimization job.
34984
+ #
34985
+ # @!attribute [rw] s3_uri
34986
+ # An Amazon S3 URI that locates a source model to optimize with an
34987
+ # optimization job.
34988
+ # @return [String]
34989
+ #
34990
+ # @!attribute [rw] model_access_config
34991
+ # The access configuration settings for the source ML model for an
34992
+ # optimization job, where you can accept the model end-user license
34993
+ # agreement (EULA).
34994
+ # @return [Types::OptimizationModelAccessConfig]
34995
+ #
34996
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/OptimizationJobModelSourceS3 AWS API Documentation
34997
+ #
34998
+ class OptimizationJobModelSourceS3 < Struct.new(
34999
+ :s3_uri,
35000
+ :model_access_config)
35001
+ SENSITIVE = []
35002
+ include Aws::Structure
35003
+ end
35004
+
35005
+ # Details for where to store the optimized model that you create with
35006
+ # the optimization job.
35007
+ #
35008
+ # @!attribute [rw] kms_key_id
35009
+ # The Amazon Resource Name (ARN) of a key in Amazon Web Services KMS.
35010
+ # SageMaker uses they key to encrypt the artifacts of the optimized
35011
+ # model when SageMaker uploads the model to Amazon S3.
35012
+ # @return [String]
35013
+ #
35014
+ # @!attribute [rw] s3_output_location
35015
+ # The Amazon S3 URI for where to store the optimized model that you
35016
+ # create with an optimization job.
35017
+ # @return [String]
35018
+ #
35019
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/OptimizationJobOutputConfig AWS API Documentation
35020
+ #
35021
+ class OptimizationJobOutputConfig < Struct.new(
35022
+ :kms_key_id,
35023
+ :s3_output_location)
35024
+ SENSITIVE = []
35025
+ include Aws::Structure
35026
+ end
35027
+
35028
+ # Summarizes an optimization job by providing some of its key
35029
+ # properties.
35030
+ #
35031
+ # @!attribute [rw] optimization_job_name
35032
+ # The name that you assigned to the optimization job.
35033
+ # @return [String]
35034
+ #
35035
+ # @!attribute [rw] optimization_job_arn
35036
+ # The Amazon Resource Name (ARN) of the optimization job.
35037
+ # @return [String]
35038
+ #
35039
+ # @!attribute [rw] creation_time
35040
+ # The time when you created the optimization job.
35041
+ # @return [Time]
35042
+ #
35043
+ # @!attribute [rw] optimization_job_status
35044
+ # The current status of the optimization job.
35045
+ # @return [String]
35046
+ #
35047
+ # @!attribute [rw] optimization_start_time
35048
+ # The time when the optimization job started.
35049
+ # @return [Time]
35050
+ #
35051
+ # @!attribute [rw] optimization_end_time
35052
+ # The time when the optimization job finished processing.
35053
+ # @return [Time]
35054
+ #
35055
+ # @!attribute [rw] last_modified_time
35056
+ # The time when the optimization job was last updated.
35057
+ # @return [Time]
35058
+ #
35059
+ # @!attribute [rw] deployment_instance_type
35060
+ # The type of instance that hosts the optimized model that you create
35061
+ # with the optimization job.
35062
+ # @return [String]
35063
+ #
35064
+ # @!attribute [rw] optimization_types
35065
+ # The optimization techniques that are applied by the optimization
35066
+ # job.
35067
+ # @return [Array<String>]
35068
+ #
35069
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/OptimizationJobSummary AWS API Documentation
35070
+ #
35071
+ class OptimizationJobSummary < Struct.new(
35072
+ :optimization_job_name,
35073
+ :optimization_job_arn,
35074
+ :creation_time,
35075
+ :optimization_job_status,
35076
+ :optimization_start_time,
35077
+ :optimization_end_time,
35078
+ :last_modified_time,
35079
+ :deployment_instance_type,
35080
+ :optimization_types)
35081
+ SENSITIVE = []
35082
+ include Aws::Structure
35083
+ end
35084
+
35085
+ # The access configuration settings for the source ML model for an
35086
+ # optimization job, where you can accept the model end-user license
35087
+ # agreement (EULA).
35088
+ #
35089
+ # @!attribute [rw] accept_eula
35090
+ # Specifies agreement to the model end-user license agreement (EULA).
35091
+ # The `AcceptEula` value must be explicitly defined as `True` in order
35092
+ # to accept the EULA that this model requires. You are responsible for
35093
+ # reviewing and complying with any applicable license terms and making
35094
+ # sure they are acceptable for your use case before downloading or
35095
+ # using a model.
35096
+ # @return [Boolean]
35097
+ #
35098
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/OptimizationModelAccessConfig AWS API Documentation
35099
+ #
35100
+ class OptimizationModelAccessConfig < Struct.new(
35101
+ :accept_eula)
35102
+ SENSITIVE = []
35103
+ include Aws::Structure
35104
+ end
35105
+
35106
+ # Output values produced by an optimization job.
35107
+ #
35108
+ # @!attribute [rw] recommended_inference_image
35109
+ # The image that SageMaker recommends that you use to host the
35110
+ # optimized model that you created with an optimization job.
35111
+ # @return [String]
35112
+ #
35113
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/OptimizationOutput AWS API Documentation
35114
+ #
35115
+ class OptimizationOutput < Struct.new(
35116
+ :recommended_inference_image)
35117
+ SENSITIVE = []
35118
+ include Aws::Structure
35119
+ end
35120
+
35121
+ # A VPC in Amazon VPC that's accessible to an optimized that you create
35122
+ # with an optimization job. You can control access to and from your
35123
+ # resources by configuring a VPC. For more information, see [Give
35124
+ # SageMaker Access to Resources in your Amazon VPC][1].
35125
+ #
35126
+ #
35127
+ #
35128
+ # [1]: https://docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html
35129
+ #
35130
+ # @!attribute [rw] security_group_ids
35131
+ # The VPC security group IDs, in the form `sg-xxxxxxxx`. Specify the
35132
+ # security groups for the VPC that is specified in the `Subnets`
35133
+ # field.
35134
+ # @return [Array<String>]
35135
+ #
35136
+ # @!attribute [rw] subnets
35137
+ # The ID of the subnets in the VPC to which you want to connect your
35138
+ # optimized model.
35139
+ # @return [Array<String>]
35140
+ #
35141
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/OptimizationVpcConfig AWS API Documentation
35142
+ #
35143
+ class OptimizationVpcConfig < Struct.new(
35144
+ :security_group_ids,
35145
+ :subnets)
35146
+ SENSITIVE = []
35147
+ include Aws::Structure
35148
+ end
35149
+
34476
35150
  # Contains information about the output location for the compiled model
34477
35151
  # and the target device that the model runs on. `TargetDevice` and
34478
35152
  # `TargetPlatform` are mutually exclusive, so you need to choose one
@@ -40597,6 +41271,18 @@ module Aws::SageMaker
40597
41271
  include Aws::Structure
40598
41272
  end
40599
41273
 
41274
+ # @!attribute [rw] optimization_job_name
41275
+ # The name that you assigned to the optimization job.
41276
+ # @return [String]
41277
+ #
41278
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/StopOptimizationJobRequest AWS API Documentation
41279
+ #
41280
+ class StopOptimizationJobRequest < Struct.new(
41281
+ :optimization_job_name)
41282
+ SENSITIVE = []
41283
+ include Aws::Structure
41284
+ end
41285
+
40600
41286
  # @!attribute [rw] pipeline_execution_arn
40601
41287
  # The Amazon Resource Name (ARN) of the pipeline execution.
40602
41288
  # @return [String]
@@ -40667,11 +41353,8 @@ module Aws::SageMaker
40667
41353
  include Aws::Structure
40668
41354
  end
40669
41355
 
40670
- # Specifies a limit to how long a model training job or model
40671
- # compilation job can run. It also specifies how long a managed spot
40672
- # training job has to complete. When the job reaches the time limit,
40673
- # SageMaker ends the training or compilation job. Use this API to cap
40674
- # model training costs.
41356
+ # Specifies a limit to how long a job can run. When the job reaches the
41357
+ # time limit, SageMaker ends the job. Use this API to cap costs.
40675
41358
  #
40676
41359
  # To stop a training job, SageMaker sends the algorithm the `SIGTERM`
40677
41360
  # signal, which delays job termination for 120 seconds. Algorithms can