aws-sdk-sagemaker 1.369.0 → 1.371.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-sagemaker/client.rb +496 -4
- data/lib/aws-sdk-sagemaker/client_api.rb +233 -0
- data/lib/aws-sdk-sagemaker/types.rb +678 -5
- data/lib/aws-sdk-sagemaker.rb +1 -1
- data/sig/client.rbs +117 -4
- data/sig/types.rbs +158 -2
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: bbb9f56b330c8e6b214a2f5db6f1f423a322de62d3a1f6c89b5fd9a3c5c556ce
|
|
4
|
+
data.tar.gz: 294be139ced80cc72549555b70163f39751f0d19f61d093e4eb495a782fd5fda
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz: '
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: '0588d9267f26569baf148d8ea4f8680559f09c54f1a3fbb68cb9b7ca50d7e61c03ba0835370097f73fd8b80adae847cab6801981410465e3d57bef32fc2807c9'
|
|
7
|
+
data.tar.gz: 7618d5e45560fe2e4bd951a31ce7a7f1e76165824096b0a373ba0ff5a7cd33cc0378aa55d014808442fae1af264c04bfc8c9ca5ee14826fdc7f1289c883e7f9e
|
data/CHANGELOG.md
CHANGED
|
@@ -1,6 +1,16 @@
|
|
|
1
1
|
Unreleased Changes
|
|
2
2
|
------------------
|
|
3
3
|
|
|
4
|
+
1.371.0 (2026-06-04)
|
|
5
|
+
------------------
|
|
6
|
+
|
|
7
|
+
* Feature - Adds the IncludedData parameter to DescribeModelCard and DescribeModelPackage. Set it to MetadataOnly to retrieve a model card without decrypt permission on the customer managed AWS KMS key (default AllData returns full content). Adds support for the MTRL Job resource in SageMaker Search.
|
|
8
|
+
|
|
9
|
+
1.370.0 (2026-06-02)
|
|
10
|
+
------------------
|
|
11
|
+
|
|
12
|
+
* Feature - Amazon SageMaker Job is a new service to help you manage various workloads related to model fine tuning, evaluation etc. Two job categories are supported today, AgentRFT for multi-turn agentic reinforcement fine tuning, and AgentRFTEvaluation for evaluating base model or trained model from AgentRFT.
|
|
13
|
+
|
|
4
14
|
1.369.0 (2026-05-27)
|
|
5
15
|
------------------
|
|
6
16
|
|
data/VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
1.
|
|
1
|
+
1.371.0
|
|
@@ -6769,6 +6769,101 @@ module Aws::SageMaker
|
|
|
6769
6769
|
req.send_request(options)
|
|
6770
6770
|
end
|
|
6771
6771
|
|
|
6772
|
+
# Creates a model customization job in Amazon SageMaker. A job runs a
|
|
6773
|
+
# workload based on the job category and configuration you provide. You
|
|
6774
|
+
# specify the job category, a schema-versioned configuration document,
|
|
6775
|
+
# and an IAM role that grants Amazon SageMaker permission to access
|
|
6776
|
+
# resources on your behalf.
|
|
6777
|
+
#
|
|
6778
|
+
# Use the `AgentRFT` category to fine-tune a model using multi-turn
|
|
6779
|
+
# reinforcement learning with reward signals. Use the
|
|
6780
|
+
# `AgentRFTEvaluation` category to evaluate a fine-tuned or base model
|
|
6781
|
+
# by running multi-turn rollouts against a held-out prompt dataset and
|
|
6782
|
+
# computing metrics such as pass@k and mean reward.
|
|
6783
|
+
#
|
|
6784
|
+
# Before creating a job, call `ListJobSchemaVersions` and
|
|
6785
|
+
# `DescribeJobSchemaVersion` to retrieve the configuration schema for
|
|
6786
|
+
# your job category. The `JobConfigDocument` must conform to the schema
|
|
6787
|
+
# specified by `JobConfigSchemaVersion`.
|
|
6788
|
+
#
|
|
6789
|
+
# The following operations are related to `CreateJob`:
|
|
6790
|
+
#
|
|
6791
|
+
# * `DescribeJob`
|
|
6792
|
+
#
|
|
6793
|
+
# * `ListJobs`
|
|
6794
|
+
#
|
|
6795
|
+
# * `StopJob`
|
|
6796
|
+
#
|
|
6797
|
+
# * `DeleteJob`
|
|
6798
|
+
#
|
|
6799
|
+
# * `ListJobSchemaVersions`
|
|
6800
|
+
#
|
|
6801
|
+
# * `DescribeJobSchemaVersion`
|
|
6802
|
+
#
|
|
6803
|
+
# @option params [required, String] :job_name
|
|
6804
|
+
# The name of the job. The name must be unique within your account and
|
|
6805
|
+
# Amazon Web Services Region.
|
|
6806
|
+
#
|
|
6807
|
+
# @option params [required, String] :role_arn
|
|
6808
|
+
# The Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker
|
|
6809
|
+
# assumes to perform the job. The role must have the necessary
|
|
6810
|
+
# permissions to access the resources required by the job configuration.
|
|
6811
|
+
#
|
|
6812
|
+
# @option params [required, String] :job_category
|
|
6813
|
+
# The category of the job. The category determines the type of workload
|
|
6814
|
+
# that the job runs.
|
|
6815
|
+
#
|
|
6816
|
+
# @option params [required, String] :job_config_schema_version
|
|
6817
|
+
# The version of the configuration schema to use for the job
|
|
6818
|
+
# configuration document. Use `ListJobSchemaVersions` to get available
|
|
6819
|
+
# schema versions for a job category.
|
|
6820
|
+
#
|
|
6821
|
+
# @option params [required, String] :job_config_document
|
|
6822
|
+
# The JSON configuration document for the job. The document must conform
|
|
6823
|
+
# to the schema specified by `JobConfigSchemaVersion`. Use
|
|
6824
|
+
# `DescribeJobSchemaVersion` to retrieve the schema for validation.
|
|
6825
|
+
#
|
|
6826
|
+
# @option params [Array<Types::Tag>] :tags
|
|
6827
|
+
# An array of key-value pairs to apply to the job as tags. For more
|
|
6828
|
+
# information, see [Tagging Amazon Web Services Resources][1].
|
|
6829
|
+
#
|
|
6830
|
+
#
|
|
6831
|
+
#
|
|
6832
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
|
|
6833
|
+
#
|
|
6834
|
+
# @return [Types::CreateJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
6835
|
+
#
|
|
6836
|
+
# * {Types::CreateJobResponse#job_arn #job_arn} => String
|
|
6837
|
+
#
|
|
6838
|
+
# @example Request syntax with placeholder values
|
|
6839
|
+
#
|
|
6840
|
+
# resp = client.create_job({
|
|
6841
|
+
# job_name: "JobName", # required
|
|
6842
|
+
# role_arn: "RoleArn", # required
|
|
6843
|
+
# job_category: "AgentRFT", # required, accepts AgentRFT, AgentRFTEvaluation
|
|
6844
|
+
# job_config_schema_version: "JobSchemaVersion", # required
|
|
6845
|
+
# job_config_document: "JobConfigDocument", # required
|
|
6846
|
+
# tags: [
|
|
6847
|
+
# {
|
|
6848
|
+
# key: "TagKey", # required
|
|
6849
|
+
# value: "TagValue", # required
|
|
6850
|
+
# },
|
|
6851
|
+
# ],
|
|
6852
|
+
# })
|
|
6853
|
+
#
|
|
6854
|
+
# @example Response structure
|
|
6855
|
+
#
|
|
6856
|
+
# resp.job_arn #=> String
|
|
6857
|
+
#
|
|
6858
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/CreateJob AWS API Documentation
|
|
6859
|
+
#
|
|
6860
|
+
# @overload create_job(params = {})
|
|
6861
|
+
# @param [Hash] params ({})
|
|
6862
|
+
def create_job(params = {}, options = {})
|
|
6863
|
+
req = build_request(:create_job, params)
|
|
6864
|
+
req.send_request(options)
|
|
6865
|
+
end
|
|
6866
|
+
|
|
6772
6867
|
# Creates a job that uses workers to label the data objects in your
|
|
6773
6868
|
# input dataset. You can use the labeled data to train machine learning
|
|
6774
6869
|
# models.
|
|
@@ -12928,6 +13023,41 @@ module Aws::SageMaker
|
|
|
12928
13023
|
req.send_request(options)
|
|
12929
13024
|
end
|
|
12930
13025
|
|
|
13026
|
+
# Deletes a job. This operation is idempotent. If the job is currently
|
|
13027
|
+
# running, you must stop it before deleting it by calling `StopJob`.
|
|
13028
|
+
#
|
|
13029
|
+
# The following operations are related to `DeleteJob`:
|
|
13030
|
+
#
|
|
13031
|
+
# * `CreateJob`
|
|
13032
|
+
#
|
|
13033
|
+
# * `StopJob`
|
|
13034
|
+
#
|
|
13035
|
+
# * `DescribeJob`
|
|
13036
|
+
#
|
|
13037
|
+
# @option params [required, String] :job_name
|
|
13038
|
+
# The name of the job to delete.
|
|
13039
|
+
#
|
|
13040
|
+
# @option params [required, String] :job_category
|
|
13041
|
+
# The category of the job to delete.
|
|
13042
|
+
#
|
|
13043
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
13044
|
+
#
|
|
13045
|
+
# @example Request syntax with placeholder values
|
|
13046
|
+
#
|
|
13047
|
+
# resp = client.delete_job({
|
|
13048
|
+
# job_name: "JobName", # required
|
|
13049
|
+
# job_category: "AgentRFT", # required, accepts AgentRFT, AgentRFTEvaluation
|
|
13050
|
+
# })
|
|
13051
|
+
#
|
|
13052
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DeleteJob AWS API Documentation
|
|
13053
|
+
#
|
|
13054
|
+
# @overload delete_job(params = {})
|
|
13055
|
+
# @param [Hash] params ({})
|
|
13056
|
+
def delete_job(params = {}, options = {})
|
|
13057
|
+
req = build_request(:delete_job, params)
|
|
13058
|
+
req.send_request(options)
|
|
13059
|
+
end
|
|
13060
|
+
|
|
12931
13061
|
# Deletes an MLflow App.
|
|
12932
13062
|
#
|
|
12933
13063
|
# @option params [required, String] :arn
|
|
@@ -17582,6 +17712,131 @@ module Aws::SageMaker
|
|
|
17582
17712
|
req.send_request(options)
|
|
17583
17713
|
end
|
|
17584
17714
|
|
|
17715
|
+
# Returns detailed information about a job, including its current
|
|
17716
|
+
# status, secondary status, configuration, and timestamps. Use
|
|
17717
|
+
# `SecondaryStatus` for granular progress tracking and
|
|
17718
|
+
# `SecondaryStatusTransitions` to see the full history of status changes
|
|
17719
|
+
# with timestamps.
|
|
17720
|
+
#
|
|
17721
|
+
# The following operations are related to `DescribeJob`:
|
|
17722
|
+
#
|
|
17723
|
+
# * `CreateJob`
|
|
17724
|
+
#
|
|
17725
|
+
# * `ListJobs`
|
|
17726
|
+
#
|
|
17727
|
+
# * `StopJob`
|
|
17728
|
+
#
|
|
17729
|
+
# * `DeleteJob`
|
|
17730
|
+
#
|
|
17731
|
+
# @option params [required, String] :job_name
|
|
17732
|
+
# The name of the job to describe.
|
|
17733
|
+
#
|
|
17734
|
+
# @option params [required, String] :job_category
|
|
17735
|
+
# The category of the job.
|
|
17736
|
+
#
|
|
17737
|
+
# @return [Types::DescribeJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
17738
|
+
#
|
|
17739
|
+
# * {Types::DescribeJobResponse#job_name #job_name} => String
|
|
17740
|
+
# * {Types::DescribeJobResponse#job_arn #job_arn} => String
|
|
17741
|
+
# * {Types::DescribeJobResponse#role_arn #role_arn} => String
|
|
17742
|
+
# * {Types::DescribeJobResponse#job_category #job_category} => String
|
|
17743
|
+
# * {Types::DescribeJobResponse#job_config_schema_version #job_config_schema_version} => String
|
|
17744
|
+
# * {Types::DescribeJobResponse#job_config_document #job_config_document} => String
|
|
17745
|
+
# * {Types::DescribeJobResponse#creation_time #creation_time} => Time
|
|
17746
|
+
# * {Types::DescribeJobResponse#last_modified_time #last_modified_time} => Time
|
|
17747
|
+
# * {Types::DescribeJobResponse#end_time #end_time} => Time
|
|
17748
|
+
# * {Types::DescribeJobResponse#job_status #job_status} => String
|
|
17749
|
+
# * {Types::DescribeJobResponse#secondary_status #secondary_status} => String
|
|
17750
|
+
# * {Types::DescribeJobResponse#secondary_status_transitions #secondary_status_transitions} => Array<Types::JobSecondaryStatusTransition>
|
|
17751
|
+
# * {Types::DescribeJobResponse#failure_reason #failure_reason} => String
|
|
17752
|
+
# * {Types::DescribeJobResponse#tags #tags} => Array<Types::Tag>
|
|
17753
|
+
#
|
|
17754
|
+
# @example Request syntax with placeholder values
|
|
17755
|
+
#
|
|
17756
|
+
# resp = client.describe_job({
|
|
17757
|
+
# job_name: "JobName", # required
|
|
17758
|
+
# job_category: "AgentRFT", # required, accepts AgentRFT, AgentRFTEvaluation
|
|
17759
|
+
# })
|
|
17760
|
+
#
|
|
17761
|
+
# @example Response structure
|
|
17762
|
+
#
|
|
17763
|
+
# resp.job_name #=> String
|
|
17764
|
+
# resp.job_arn #=> String
|
|
17765
|
+
# resp.role_arn #=> String
|
|
17766
|
+
# resp.job_category #=> String, one of "AgentRFT", "AgentRFTEvaluation"
|
|
17767
|
+
# resp.job_config_schema_version #=> String
|
|
17768
|
+
# resp.job_config_document #=> String
|
|
17769
|
+
# resp.creation_time #=> Time
|
|
17770
|
+
# resp.last_modified_time #=> Time
|
|
17771
|
+
# resp.end_time #=> Time
|
|
17772
|
+
# resp.job_status #=> String, one of "InProgress", "Completed", "Failed", "Stopping", "Stopped", "Deleting", "DeleteFailed"
|
|
17773
|
+
# resp.secondary_status #=> String, one of "Starting", "Downloading", "Training", "Uploading", "Stopping", "Stopped", "MaxRuntimeExceeded", "Interrupted", "Failed", "Completed", "Restarting", "Pending", "Evaluating", "Deleting", "DeleteFailed"
|
|
17774
|
+
# resp.secondary_status_transitions #=> Array
|
|
17775
|
+
# resp.secondary_status_transitions[0].status #=> String, one of "Starting", "Downloading", "Training", "Uploading", "Stopping", "Stopped", "MaxRuntimeExceeded", "Interrupted", "Failed", "Completed", "Restarting", "Pending", "Evaluating", "Deleting", "DeleteFailed"
|
|
17776
|
+
# resp.secondary_status_transitions[0].start_time #=> Time
|
|
17777
|
+
# resp.secondary_status_transitions[0].end_time #=> Time
|
|
17778
|
+
# resp.secondary_status_transitions[0].status_message #=> String
|
|
17779
|
+
# resp.failure_reason #=> String
|
|
17780
|
+
# resp.tags #=> Array
|
|
17781
|
+
# resp.tags[0].key #=> String
|
|
17782
|
+
# resp.tags[0].value #=> String
|
|
17783
|
+
#
|
|
17784
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DescribeJob AWS API Documentation
|
|
17785
|
+
#
|
|
17786
|
+
# @overload describe_job(params = {})
|
|
17787
|
+
# @param [Hash] params ({})
|
|
17788
|
+
def describe_job(params = {}, options = {})
|
|
17789
|
+
req = build_request(:describe_job, params)
|
|
17790
|
+
req.send_request(options)
|
|
17791
|
+
end
|
|
17792
|
+
|
|
17793
|
+
# Returns the JSON schema for a specified job category and schema
|
|
17794
|
+
# version. Use this schema to validate your `JobConfigDocument` before
|
|
17795
|
+
# calling `CreateJob`. If you don't specify a schema version, the
|
|
17796
|
+
# latest version is returned. The schema defines required fields,
|
|
17797
|
+
# allowed values, and constraints for the job configuration.
|
|
17798
|
+
#
|
|
17799
|
+
# The following operations are related to `DescribeJobSchemaVersion`:
|
|
17800
|
+
#
|
|
17801
|
+
# * `ListJobSchemaVersions`
|
|
17802
|
+
#
|
|
17803
|
+
# * `CreateJob`
|
|
17804
|
+
#
|
|
17805
|
+
# @option params [required, String] :job_category
|
|
17806
|
+
# The category of the job schema to describe.
|
|
17807
|
+
#
|
|
17808
|
+
# @option params [String] :job_config_schema_version
|
|
17809
|
+
# The version of the schema to retrieve. If not specified, the latest
|
|
17810
|
+
# version is returned.
|
|
17811
|
+
#
|
|
17812
|
+
# @return [Types::DescribeJobSchemaVersionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
17813
|
+
#
|
|
17814
|
+
# * {Types::DescribeJobSchemaVersionResponse#job_category #job_category} => String
|
|
17815
|
+
# * {Types::DescribeJobSchemaVersionResponse#job_config_schema_version #job_config_schema_version} => String
|
|
17816
|
+
# * {Types::DescribeJobSchemaVersionResponse#job_config_schema #job_config_schema} => String
|
|
17817
|
+
#
|
|
17818
|
+
# @example Request syntax with placeholder values
|
|
17819
|
+
#
|
|
17820
|
+
# resp = client.describe_job_schema_version({
|
|
17821
|
+
# job_category: "AgentRFT", # required, accepts AgentRFT, AgentRFTEvaluation
|
|
17822
|
+
# job_config_schema_version: "JobSchemaVersion",
|
|
17823
|
+
# })
|
|
17824
|
+
#
|
|
17825
|
+
# @example Response structure
|
|
17826
|
+
#
|
|
17827
|
+
# resp.job_category #=> String, one of "AgentRFT", "AgentRFTEvaluation"
|
|
17828
|
+
# resp.job_config_schema_version #=> String
|
|
17829
|
+
# resp.job_config_schema #=> String
|
|
17830
|
+
#
|
|
17831
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DescribeJobSchemaVersion AWS API Documentation
|
|
17832
|
+
#
|
|
17833
|
+
# @overload describe_job_schema_version(params = {})
|
|
17834
|
+
# @param [Hash] params ({})
|
|
17835
|
+
def describe_job_schema_version(params = {}, options = {})
|
|
17836
|
+
req = build_request(:describe_job_schema_version, params)
|
|
17837
|
+
req.send_request(options)
|
|
17838
|
+
end
|
|
17839
|
+
|
|
17585
17840
|
# Gets information about a labeling job.
|
|
17586
17841
|
#
|
|
17587
17842
|
# @option params [required, String] :labeling_job_name
|
|
@@ -18079,6 +18334,12 @@ module Aws::SageMaker
|
|
|
18079
18334
|
# Describes the content, creation time, and security configuration of an
|
|
18080
18335
|
# Amazon SageMaker Model Card.
|
|
18081
18336
|
#
|
|
18337
|
+
# To retrieve only metadata about a model card without requiring
|
|
18338
|
+
# `kms:Decrypt` permission on the associated customer-managed Amazon Web
|
|
18339
|
+
# Services KMS key, set `IncludedData` to `MetadataOnly`. The default is
|
|
18340
|
+
# `AllData`, which returns the full model card `Content` and requires
|
|
18341
|
+
# `kms:Decrypt` permission when a customer-managed key is configured.
|
|
18342
|
+
#
|
|
18082
18343
|
# @option params [required, String] :model_card_name
|
|
18083
18344
|
# The name or Amazon Resource Name (ARN) of the model card to describe.
|
|
18084
18345
|
#
|
|
@@ -18086,6 +18347,23 @@ module Aws::SageMaker
|
|
|
18086
18347
|
# The version of the model card to describe. If a version is not
|
|
18087
18348
|
# provided, then the latest version of the model card is described.
|
|
18088
18349
|
#
|
|
18350
|
+
# @option params [String] :included_data
|
|
18351
|
+
# Specifies the level of model card data to include in the response. Use
|
|
18352
|
+
# this parameter to call `DescribeModelCard` without requiring
|
|
18353
|
+
# `kms:Decrypt` permission on the customer-managed Amazon Web Services
|
|
18354
|
+
# KMS key.
|
|
18355
|
+
#
|
|
18356
|
+
# * `AllData`: Returns the full model card `Content`. This option
|
|
18357
|
+
# requires `kms:Decrypt` permission on the customer-managed key, if
|
|
18358
|
+
# one is associated with the model card. This is the default.
|
|
18359
|
+
#
|
|
18360
|
+
# * `MetadataOnly`: Returns the model card with sanitized `Content` that
|
|
18361
|
+
# includes only a small set of unencrypted metadata fields. This
|
|
18362
|
+
# option does not require `kms:Decrypt` permission. For the list of
|
|
18363
|
+
# fields preserved in the response, see `Content`.
|
|
18364
|
+
#
|
|
18365
|
+
# If you don't specify a value, SageMaker returns `AllData`.
|
|
18366
|
+
#
|
|
18089
18367
|
# @return [Types::DescribeModelCardResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
18090
18368
|
#
|
|
18091
18369
|
# * {Types::DescribeModelCardResponse#model_card_arn #model_card_arn} => String
|
|
@@ -18105,6 +18383,7 @@ module Aws::SageMaker
|
|
|
18105
18383
|
# resp = client.describe_model_card({
|
|
18106
18384
|
# model_card_name: "ModelCardNameOrArn", # required
|
|
18107
18385
|
# model_card_version: 1,
|
|
18386
|
+
# included_data: "AllData", # accepts AllData, MetadataOnly
|
|
18108
18387
|
# })
|
|
18109
18388
|
#
|
|
18110
18389
|
# @example Response structure
|
|
@@ -18282,7 +18561,10 @@ module Aws::SageMaker
|
|
|
18282
18561
|
#
|
|
18283
18562
|
# If you provided a KMS Key ID when you created your model package, you
|
|
18284
18563
|
# will see the [KMS Decrypt][1] API call in your CloudTrail logs when
|
|
18285
|
-
# you use this API.
|
|
18564
|
+
# you use this API. To call this operation without requiring
|
|
18565
|
+
# `kms:Decrypt` permission on the customer-managed key, set
|
|
18566
|
+
# `IncludedData` to `MetadataOnly`; the response is returned with the
|
|
18567
|
+
# embedded `ModelCard.ModelCardContent` field sanitized.
|
|
18286
18568
|
#
|
|
18287
18569
|
# To create models in SageMaker, buyers can subscribe to model packages
|
|
18288
18570
|
# listed on Amazon Web Services Marketplace.
|
|
@@ -18298,6 +18580,33 @@ module Aws::SageMaker
|
|
|
18298
18580
|
# When you specify a name, the name must have 1 to 63 characters. Valid
|
|
18299
18581
|
# characters are a-z, A-Z, 0-9, and - (hyphen).
|
|
18300
18582
|
#
|
|
18583
|
+
# @option params [String] :included_data
|
|
18584
|
+
# Specifies the level of model package data to include in the response.
|
|
18585
|
+
# Use this parameter to call `DescribeModelPackage` on a model package
|
|
18586
|
+
# that has an associated model card without requiring `kms:Decrypt`
|
|
18587
|
+
# permission on the customer-managed KMS key associated with the
|
|
18588
|
+
# embedded model card.
|
|
18589
|
+
#
|
|
18590
|
+
# * `AllData`: Returns the full model package response, including the
|
|
18591
|
+
# unredacted `ModelCard.ModelCardContent`. This option requires
|
|
18592
|
+
# `kms:Decrypt` permission on the customer-managed key, if one is
|
|
18593
|
+
# associated with the embedded model card. This is the default.
|
|
18594
|
+
#
|
|
18595
|
+
# * `MetadataOnly`: Returns the full model package response, but with
|
|
18596
|
+
# the embedded `ModelCard.ModelCardContent` sanitized to include only
|
|
18597
|
+
# a small set of unencrypted metadata fields. This option does not
|
|
18598
|
+
# require `kms:Decrypt` permission. All other top-level response
|
|
18599
|
+
# fields, including `InferenceSpecification`, `ModelMetrics`,
|
|
18600
|
+
# `DriftCheckBaselines`, and `SecurityConfig`, are returned unchanged.
|
|
18601
|
+
# For the list of fields preserved within `ModelCardContent`, see
|
|
18602
|
+
# [ModelCard][1].
|
|
18603
|
+
#
|
|
18604
|
+
# If you don't specify a value, SageMaker returns `AllData`.
|
|
18605
|
+
#
|
|
18606
|
+
#
|
|
18607
|
+
#
|
|
18608
|
+
# [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeModelPackage.html#sagemaker-DescribeModelPackage-response-ModelCard
|
|
18609
|
+
#
|
|
18301
18610
|
# @return [Types::DescribeModelPackageOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
18302
18611
|
#
|
|
18303
18612
|
# * {Types::DescribeModelPackageOutput#model_package_name #model_package_name} => String
|
|
@@ -18337,6 +18646,7 @@ module Aws::SageMaker
|
|
|
18337
18646
|
#
|
|
18338
18647
|
# resp = client.describe_model_package({
|
|
18339
18648
|
# model_package_name: "VersionedArnOrName", # required
|
|
18649
|
+
# included_data: "AllData", # accepts AllData, MetadataOnly
|
|
18340
18650
|
# })
|
|
18341
18651
|
#
|
|
18342
18652
|
# @example Response structure
|
|
@@ -21075,7 +21385,7 @@ module Aws::SageMaker
|
|
|
21075
21385
|
# @example Request syntax with placeholder values
|
|
21076
21386
|
#
|
|
21077
21387
|
# resp = client.get_search_suggestions({
|
|
21078
|
-
# resource: "TrainingJob", # required, accepts TrainingJob, Experiment, ExperimentTrial, ExperimentTrialComponent, Endpoint, Model, ModelPackage, ModelPackageGroup, Pipeline, PipelineExecution, FeatureGroup, FeatureMetadata, Image, ImageVersion, Project, HyperParameterTuningJob, ModelCard, PipelineVersion
|
|
21388
|
+
# resource: "TrainingJob", # required, accepts TrainingJob, Experiment, ExperimentTrial, ExperimentTrialComponent, Endpoint, Model, ModelPackage, ModelPackageGroup, Pipeline, PipelineExecution, FeatureGroup, FeatureMetadata, Image, ImageVersion, Project, HyperParameterTuningJob, ModelCard, PipelineVersion, Job
|
|
21079
21389
|
# suggestion_query: {
|
|
21080
21390
|
# property_name_query: {
|
|
21081
21391
|
# property_name_hint: "PropertyNameHint", # required
|
|
@@ -24564,6 +24874,150 @@ module Aws::SageMaker
|
|
|
24564
24874
|
req.send_request(options)
|
|
24565
24875
|
end
|
|
24566
24876
|
|
|
24877
|
+
# Lists available configuration schema versions for a specified job
|
|
24878
|
+
# category. Use the schema versions with `DescribeJobSchemaVersion` to
|
|
24879
|
+
# retrieve the full schema document.
|
|
24880
|
+
#
|
|
24881
|
+
# The following operations are related to `ListJobSchemaVersions`:
|
|
24882
|
+
#
|
|
24883
|
+
# * `DescribeJobSchemaVersion`
|
|
24884
|
+
#
|
|
24885
|
+
# * `CreateJob`
|
|
24886
|
+
#
|
|
24887
|
+
# @option params [required, String] :job_category
|
|
24888
|
+
# The category of job schemas to list.
|
|
24889
|
+
#
|
|
24890
|
+
# @option params [String] :next_token
|
|
24891
|
+
# If the previous response was truncated, this token retrieves the next
|
|
24892
|
+
# set of results.
|
|
24893
|
+
#
|
|
24894
|
+
# @option params [Integer] :max_results
|
|
24895
|
+
# The maximum number of schema versions to return in the response. The
|
|
24896
|
+
# default value is 5.
|
|
24897
|
+
#
|
|
24898
|
+
# @return [Types::ListJobSchemaVersionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
24899
|
+
#
|
|
24900
|
+
# * {Types::ListJobSchemaVersionsResponse#next_token #next_token} => String
|
|
24901
|
+
# * {Types::ListJobSchemaVersionsResponse#job_config_schemas #job_config_schemas} => Array<Types::JobConfigSchemaVersionSummary>
|
|
24902
|
+
#
|
|
24903
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
24904
|
+
#
|
|
24905
|
+
# @example Request syntax with placeholder values
|
|
24906
|
+
#
|
|
24907
|
+
# resp = client.list_job_schema_versions({
|
|
24908
|
+
# job_category: "AgentRFT", # required, accepts AgentRFT, AgentRFTEvaluation
|
|
24909
|
+
# next_token: "NextToken",
|
|
24910
|
+
# max_results: 1,
|
|
24911
|
+
# })
|
|
24912
|
+
#
|
|
24913
|
+
# @example Response structure
|
|
24914
|
+
#
|
|
24915
|
+
# resp.next_token #=> String
|
|
24916
|
+
# resp.job_config_schemas #=> Array
|
|
24917
|
+
# resp.job_config_schemas[0].job_config_schema_version #=> String
|
|
24918
|
+
#
|
|
24919
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/ListJobSchemaVersions AWS API Documentation
|
|
24920
|
+
#
|
|
24921
|
+
# @overload list_job_schema_versions(params = {})
|
|
24922
|
+
# @param [Hash] params ({})
|
|
24923
|
+
def list_job_schema_versions(params = {}, options = {})
|
|
24924
|
+
req = build_request(:list_job_schema_versions, params)
|
|
24925
|
+
req.send_request(options)
|
|
24926
|
+
end
|
|
24927
|
+
|
|
24928
|
+
# Lists jobs in a specified category. You can filter results by creation
|
|
24929
|
+
# time, last modified time, name, and status. Results are sorted by the
|
|
24930
|
+
# field you specify in `SortBy`. Use pagination to retrieve large result
|
|
24931
|
+
# sets efficiently.
|
|
24932
|
+
#
|
|
24933
|
+
# The following operations are related to `ListJobs`:
|
|
24934
|
+
#
|
|
24935
|
+
# * `CreateJob`
|
|
24936
|
+
#
|
|
24937
|
+
# * `DescribeJob`
|
|
24938
|
+
#
|
|
24939
|
+
# @option params [required, String] :job_category
|
|
24940
|
+
# The category of jobs to list.
|
|
24941
|
+
#
|
|
24942
|
+
# @option params [String] :next_token
|
|
24943
|
+
# If the previous response was truncated, this token retrieves the next
|
|
24944
|
+
# set of results.
|
|
24945
|
+
#
|
|
24946
|
+
# @option params [Integer] :max_results
|
|
24947
|
+
# The maximum number of jobs to return in the response. The default
|
|
24948
|
+
# value is 50.
|
|
24949
|
+
#
|
|
24950
|
+
# @option params [Time,DateTime,Date,Integer,String] :creation_time_after
|
|
24951
|
+
# A filter that returns only jobs created after the specified time.
|
|
24952
|
+
#
|
|
24953
|
+
# @option params [Time,DateTime,Date,Integer,String] :creation_time_before
|
|
24954
|
+
# A filter that returns only jobs created before the specified time.
|
|
24955
|
+
#
|
|
24956
|
+
# @option params [Time,DateTime,Date,Integer,String] :last_modified_time_after
|
|
24957
|
+
# A filter that returns only jobs modified after the specified time.
|
|
24958
|
+
#
|
|
24959
|
+
# @option params [Time,DateTime,Date,Integer,String] :last_modified_time_before
|
|
24960
|
+
# A filter that returns only jobs modified before the specified time.
|
|
24961
|
+
#
|
|
24962
|
+
# @option params [String] :name_contains
|
|
24963
|
+
# A string in the job name to filter results. Only jobs whose name
|
|
24964
|
+
# contains the specified string are returned.
|
|
24965
|
+
#
|
|
24966
|
+
# @option params [String] :sort_by
|
|
24967
|
+
# The field to sort results by.
|
|
24968
|
+
#
|
|
24969
|
+
# @option params [String] :sort_order
|
|
24970
|
+
# The sort order for results. Valid values are `Ascending` and
|
|
24971
|
+
# `Descending`.
|
|
24972
|
+
#
|
|
24973
|
+
# @option params [String] :status_equals
|
|
24974
|
+
# A filter that returns only jobs with the specified status.
|
|
24975
|
+
#
|
|
24976
|
+
# @return [Types::ListJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
24977
|
+
#
|
|
24978
|
+
# * {Types::ListJobsResponse#next_token #next_token} => String
|
|
24979
|
+
# * {Types::ListJobsResponse#job_summaries #job_summaries} => Array<Types::JobSummary>
|
|
24980
|
+
#
|
|
24981
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
24982
|
+
#
|
|
24983
|
+
# @example Request syntax with placeholder values
|
|
24984
|
+
#
|
|
24985
|
+
# resp = client.list_jobs({
|
|
24986
|
+
# job_category: "AgentRFT", # required, accepts AgentRFT, AgentRFTEvaluation
|
|
24987
|
+
# next_token: "NextToken",
|
|
24988
|
+
# max_results: 1,
|
|
24989
|
+
# creation_time_after: Time.now,
|
|
24990
|
+
# creation_time_before: Time.now,
|
|
24991
|
+
# last_modified_time_after: Time.now,
|
|
24992
|
+
# last_modified_time_before: Time.now,
|
|
24993
|
+
# name_contains: "NameContains",
|
|
24994
|
+
# sort_by: "Name", # accepts Name, CreationTime, Status
|
|
24995
|
+
# sort_order: "Ascending", # accepts Ascending, Descending
|
|
24996
|
+
# status_equals: "InProgress", # accepts InProgress, Completed, Failed, Stopping, Stopped, Deleting, DeleteFailed
|
|
24997
|
+
# })
|
|
24998
|
+
#
|
|
24999
|
+
# @example Response structure
|
|
25000
|
+
#
|
|
25001
|
+
# resp.next_token #=> String
|
|
25002
|
+
# resp.job_summaries #=> Array
|
|
25003
|
+
# resp.job_summaries[0].job_arn #=> String
|
|
25004
|
+
# resp.job_summaries[0].job_name #=> String
|
|
25005
|
+
# resp.job_summaries[0].job_category #=> String, one of "AgentRFT", "AgentRFTEvaluation"
|
|
25006
|
+
# resp.job_summaries[0].job_status #=> String, one of "InProgress", "Completed", "Failed", "Stopping", "Stopped", "Deleting", "DeleteFailed"
|
|
25007
|
+
# resp.job_summaries[0].job_secondary_status #=> String, one of "Starting", "Downloading", "Training", "Uploading", "Stopping", "Stopped", "MaxRuntimeExceeded", "Interrupted", "Failed", "Completed", "Restarting", "Pending", "Evaluating", "Deleting", "DeleteFailed"
|
|
25008
|
+
# resp.job_summaries[0].creation_time #=> Time
|
|
25009
|
+
# resp.job_summaries[0].last_modified_time #=> Time
|
|
25010
|
+
# resp.job_summaries[0].end_time #=> Time
|
|
25011
|
+
#
|
|
25012
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/ListJobs AWS API Documentation
|
|
25013
|
+
#
|
|
25014
|
+
# @overload list_jobs(params = {})
|
|
25015
|
+
# @param [Hash] params ({})
|
|
25016
|
+
def list_jobs(params = {}, options = {})
|
|
25017
|
+
req = build_request(:list_jobs, params)
|
|
25018
|
+
req.send_request(options)
|
|
25019
|
+
end
|
|
25020
|
+
|
|
24567
25021
|
# Gets a list of labeling jobs.
|
|
24568
25022
|
#
|
|
24569
25023
|
# @option params [Time,DateTime,Date,Integer,String] :creation_time_after
|
|
@@ -26470,6 +26924,7 @@ module Aws::SageMaker
|
|
|
26470
26924
|
# resp.pipeline_execution_steps[0].metadata.lineage.associations #=> Array
|
|
26471
26925
|
# resp.pipeline_execution_steps[0].metadata.lineage.associations[0].source_arn #=> String
|
|
26472
26926
|
# resp.pipeline_execution_steps[0].metadata.lineage.associations[0].destination_arn #=> String
|
|
26927
|
+
# resp.pipeline_execution_steps[0].metadata.job.arn #=> String
|
|
26473
26928
|
# resp.pipeline_execution_steps[0].attempt_count #=> Integer
|
|
26474
26929
|
# resp.pipeline_execution_steps[0].selective_execution_result.source_pipeline_execution_arn #=> String
|
|
26475
26930
|
# resp.next_token #=> String
|
|
@@ -28446,7 +28901,7 @@ module Aws::SageMaker
|
|
|
28446
28901
|
# @example Request syntax with placeholder values
|
|
28447
28902
|
#
|
|
28448
28903
|
# resp = client.search({
|
|
28449
|
-
# resource: "TrainingJob", # required, accepts TrainingJob, Experiment, ExperimentTrial, ExperimentTrialComponent, Endpoint, Model, ModelPackage, ModelPackageGroup, Pipeline, PipelineExecution, FeatureGroup, FeatureMetadata, Image, ImageVersion, Project, HyperParameterTuningJob, ModelCard, PipelineVersion
|
|
28904
|
+
# resource: "TrainingJob", # required, accepts TrainingJob, Experiment, ExperimentTrial, ExperimentTrialComponent, Endpoint, Model, ModelPackage, ModelPackageGroup, Pipeline, PipelineExecution, FeatureGroup, FeatureMetadata, Image, ImageVersion, Project, HyperParameterTuningJob, ModelCard, PipelineVersion, Job
|
|
28450
28905
|
# search_expression: {
|
|
28451
28906
|
# filters: [
|
|
28452
28907
|
# {
|
|
@@ -29302,6 +29757,43 @@ module Aws::SageMaker
|
|
|
29302
29757
|
req.send_request(options)
|
|
29303
29758
|
end
|
|
29304
29759
|
|
|
29760
|
+
# Stops a running job. When you call `StopJob`, Amazon SageMaker sets
|
|
29761
|
+
# the job status to `Stopping`. After the job stops, the status changes
|
|
29762
|
+
# to `Stopped`. Partial results may be available in the output location
|
|
29763
|
+
# if the job was in progress. To delete a stopped job, call `DeleteJob`.
|
|
29764
|
+
#
|
|
29765
|
+
# The following operations are related to `StopJob`:
|
|
29766
|
+
#
|
|
29767
|
+
# * `CreateJob`
|
|
29768
|
+
#
|
|
29769
|
+
# * `DescribeJob`
|
|
29770
|
+
#
|
|
29771
|
+
# * `DeleteJob`
|
|
29772
|
+
#
|
|
29773
|
+
# @option params [required, String] :job_name
|
|
29774
|
+
# The name of the job to stop.
|
|
29775
|
+
#
|
|
29776
|
+
# @option params [required, String] :job_category
|
|
29777
|
+
# The category of the job to stop.
|
|
29778
|
+
#
|
|
29779
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
29780
|
+
#
|
|
29781
|
+
# @example Request syntax with placeholder values
|
|
29782
|
+
#
|
|
29783
|
+
# resp = client.stop_job({
|
|
29784
|
+
# job_name: "JobName", # required
|
|
29785
|
+
# job_category: "AgentRFT", # required, accepts AgentRFT, AgentRFTEvaluation
|
|
29786
|
+
# })
|
|
29787
|
+
#
|
|
29788
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/StopJob AWS API Documentation
|
|
29789
|
+
#
|
|
29790
|
+
# @overload stop_job(params = {})
|
|
29791
|
+
# @param [Hash] params ({})
|
|
29792
|
+
def stop_job(params = {}, options = {})
|
|
29793
|
+
req = build_request(:stop_job, params)
|
|
29794
|
+
req.send_request(options)
|
|
29795
|
+
end
|
|
29796
|
+
|
|
29305
29797
|
# Stops a running labeling job. A job that is stopped cannot be
|
|
29306
29798
|
# restarted. Any results obtained before the job is stopped are placed
|
|
29307
29799
|
# in the Amazon S3 output bucket.
|
|
@@ -33871,7 +34363,7 @@ module Aws::SageMaker
|
|
|
33871
34363
|
tracer: tracer
|
|
33872
34364
|
)
|
|
33873
34365
|
context[:gem_name] = 'aws-sdk-sagemaker'
|
|
33874
|
-
context[:gem_version] = '1.
|
|
34366
|
+
context[:gem_version] = '1.371.0'
|
|
33875
34367
|
Seahorse::Client::Request.new(handlers, context)
|
|
33876
34368
|
end
|
|
33877
34369
|
|