aws-sdk-sagemaker 1.370.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 +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-sagemaker/client.rb +59 -4
- data/lib/aws-sdk-sagemaker/client_api.rb +21 -0
- data/lib/aws-sdk-sagemaker/types.rb +188 -4
- data/lib/aws-sdk-sagemaker.rb +1 -1
- data/sig/client.rbs +6 -4
- data/sig/types.rbs +23 -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,11 @@
|
|
|
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
|
+
|
|
4
9
|
1.370.0 (2026-06-02)
|
|
5
10
|
------------------
|
|
6
11
|
|
data/VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
1.
|
|
1
|
+
1.371.0
|
|
@@ -18334,6 +18334,12 @@ module Aws::SageMaker
|
|
|
18334
18334
|
# Describes the content, creation time, and security configuration of an
|
|
18335
18335
|
# Amazon SageMaker Model Card.
|
|
18336
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
|
+
#
|
|
18337
18343
|
# @option params [required, String] :model_card_name
|
|
18338
18344
|
# The name or Amazon Resource Name (ARN) of the model card to describe.
|
|
18339
18345
|
#
|
|
@@ -18341,6 +18347,23 @@ module Aws::SageMaker
|
|
|
18341
18347
|
# The version of the model card to describe. If a version is not
|
|
18342
18348
|
# provided, then the latest version of the model card is described.
|
|
18343
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
|
+
#
|
|
18344
18367
|
# @return [Types::DescribeModelCardResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
18345
18368
|
#
|
|
18346
18369
|
# * {Types::DescribeModelCardResponse#model_card_arn #model_card_arn} => String
|
|
@@ -18360,6 +18383,7 @@ module Aws::SageMaker
|
|
|
18360
18383
|
# resp = client.describe_model_card({
|
|
18361
18384
|
# model_card_name: "ModelCardNameOrArn", # required
|
|
18362
18385
|
# model_card_version: 1,
|
|
18386
|
+
# included_data: "AllData", # accepts AllData, MetadataOnly
|
|
18363
18387
|
# })
|
|
18364
18388
|
#
|
|
18365
18389
|
# @example Response structure
|
|
@@ -18537,7 +18561,10 @@ module Aws::SageMaker
|
|
|
18537
18561
|
#
|
|
18538
18562
|
# If you provided a KMS Key ID when you created your model package, you
|
|
18539
18563
|
# will see the [KMS Decrypt][1] API call in your CloudTrail logs when
|
|
18540
|
-
# 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.
|
|
18541
18568
|
#
|
|
18542
18569
|
# To create models in SageMaker, buyers can subscribe to model packages
|
|
18543
18570
|
# listed on Amazon Web Services Marketplace.
|
|
@@ -18553,6 +18580,33 @@ module Aws::SageMaker
|
|
|
18553
18580
|
# When you specify a name, the name must have 1 to 63 characters. Valid
|
|
18554
18581
|
# characters are a-z, A-Z, 0-9, and - (hyphen).
|
|
18555
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
|
+
#
|
|
18556
18610
|
# @return [Types::DescribeModelPackageOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
18557
18611
|
#
|
|
18558
18612
|
# * {Types::DescribeModelPackageOutput#model_package_name #model_package_name} => String
|
|
@@ -18592,6 +18646,7 @@ module Aws::SageMaker
|
|
|
18592
18646
|
#
|
|
18593
18647
|
# resp = client.describe_model_package({
|
|
18594
18648
|
# model_package_name: "VersionedArnOrName", # required
|
|
18649
|
+
# included_data: "AllData", # accepts AllData, MetadataOnly
|
|
18595
18650
|
# })
|
|
18596
18651
|
#
|
|
18597
18652
|
# @example Response structure
|
|
@@ -21330,7 +21385,7 @@ module Aws::SageMaker
|
|
|
21330
21385
|
# @example Request syntax with placeholder values
|
|
21331
21386
|
#
|
|
21332
21387
|
# resp = client.get_search_suggestions({
|
|
21333
|
-
# 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
|
|
21334
21389
|
# suggestion_query: {
|
|
21335
21390
|
# property_name_query: {
|
|
21336
21391
|
# property_name_hint: "PropertyNameHint", # required
|
|
@@ -28846,7 +28901,7 @@ module Aws::SageMaker
|
|
|
28846
28901
|
# @example Request syntax with placeholder values
|
|
28847
28902
|
#
|
|
28848
28903
|
# resp = client.search({
|
|
28849
|
-
# 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
|
|
28850
28905
|
# search_expression: {
|
|
28851
28906
|
# filters: [
|
|
28852
28907
|
# {
|
|
@@ -34308,7 +34363,7 @@ module Aws::SageMaker
|
|
|
34308
34363
|
tracer: tracer
|
|
34309
34364
|
)
|
|
34310
34365
|
context[:gem_name] = 'aws-sdk-sagemaker'
|
|
34311
|
-
context[:gem_version] = '1.
|
|
34366
|
+
context[:gem_version] = '1.371.0'
|
|
34312
34367
|
Seahorse::Client::Request.new(handlers, context)
|
|
34313
34368
|
end
|
|
34314
34369
|
|
|
@@ -1443,6 +1443,7 @@ module Aws::SageMaker
|
|
|
1443
1443
|
ImportHubContentResponse = Shapes::StructureShape.new(name: 'ImportHubContentResponse')
|
|
1444
1444
|
InUseInstanceCount = Shapes::IntegerShape.new(name: 'InUseInstanceCount')
|
|
1445
1445
|
IncludeNodeLogicalIdsBoolean = Shapes::BooleanShape.new(name: 'IncludeNodeLogicalIdsBoolean')
|
|
1446
|
+
IncludedData = Shapes::StringShape.new(name: 'IncludedData')
|
|
1446
1447
|
InferenceComponentArn = Shapes::StringShape.new(name: 'InferenceComponentArn')
|
|
1447
1448
|
InferenceComponentAvailabilityZoneBalance = Shapes::StructureShape.new(name: 'InferenceComponentAvailabilityZoneBalance')
|
|
1448
1449
|
InferenceComponentCapacitySize = Shapes::StructureShape.new(name: 'InferenceComponentCapacitySize')
|
|
@@ -1538,6 +1539,7 @@ module Aws::SageMaker
|
|
|
1538
1539
|
IotRoleAlias = Shapes::StringShape.new(name: 'IotRoleAlias')
|
|
1539
1540
|
IsTrackingServerActive = Shapes::StringShape.new(name: 'IsTrackingServerActive')
|
|
1540
1541
|
ItemIdentifierAttributeName = Shapes::StringShape.new(name: 'ItemIdentifierAttributeName')
|
|
1542
|
+
Job = Shapes::StructureShape.new(name: 'Job')
|
|
1541
1543
|
JobArn = Shapes::StringShape.new(name: 'JobArn')
|
|
1542
1544
|
JobCategory = Shapes::StringShape.new(name: 'JobCategory')
|
|
1543
1545
|
JobConfigDocument = Shapes::StringShape.new(name: 'JobConfigDocument')
|
|
@@ -6733,6 +6735,7 @@ module Aws::SageMaker
|
|
|
6733
6735
|
|
|
6734
6736
|
DescribeModelCardRequest.add_member(:model_card_name, Shapes::ShapeRef.new(shape: ModelCardNameOrArn, required: true, location_name: "ModelCardName"))
|
|
6735
6737
|
DescribeModelCardRequest.add_member(:model_card_version, Shapes::ShapeRef.new(shape: Integer, location_name: "ModelCardVersion", metadata: {"box" => true}))
|
|
6738
|
+
DescribeModelCardRequest.add_member(:included_data, Shapes::ShapeRef.new(shape: IncludedData, location_name: "IncludedData"))
|
|
6736
6739
|
DescribeModelCardRequest.struct_class = Types::DescribeModelCardRequest
|
|
6737
6740
|
|
|
6738
6741
|
DescribeModelCardResponse.add_member(:model_card_arn, Shapes::ShapeRef.new(shape: ModelCardArn, required: true, location_name: "ModelCardArn"))
|
|
@@ -6792,6 +6795,7 @@ module Aws::SageMaker
|
|
|
6792
6795
|
DescribeModelPackageGroupOutput.struct_class = Types::DescribeModelPackageGroupOutput
|
|
6793
6796
|
|
|
6794
6797
|
DescribeModelPackageInput.add_member(:model_package_name, Shapes::ShapeRef.new(shape: VersionedArnOrName, required: true, location_name: "ModelPackageName"))
|
|
6798
|
+
DescribeModelPackageInput.add_member(:included_data, Shapes::ShapeRef.new(shape: IncludedData, location_name: "IncludedData"))
|
|
6795
6799
|
DescribeModelPackageInput.struct_class = Types::DescribeModelPackageInput
|
|
6796
6800
|
|
|
6797
6801
|
DescribeModelPackageOutput.add_member(:model_package_name, Shapes::ShapeRef.new(shape: EntityName, required: true, location_name: "ModelPackageName"))
|
|
@@ -8514,6 +8518,22 @@ module Aws::SageMaker
|
|
|
8514
8518
|
|
|
8515
8519
|
IntegerParameterRanges.member = Shapes::ShapeRef.new(shape: IntegerParameterRange)
|
|
8516
8520
|
|
|
8521
|
+
Job.add_member(:job_name, Shapes::ShapeRef.new(shape: JobName, location_name: "JobName"))
|
|
8522
|
+
Job.add_member(:job_arn, Shapes::ShapeRef.new(shape: JobArn, location_name: "JobArn"))
|
|
8523
|
+
Job.add_member(:role_arn, Shapes::ShapeRef.new(shape: RoleArn, location_name: "RoleArn"))
|
|
8524
|
+
Job.add_member(:job_category, Shapes::ShapeRef.new(shape: JobCategory, location_name: "JobCategory"))
|
|
8525
|
+
Job.add_member(:job_config_schema_version, Shapes::ShapeRef.new(shape: JobSchemaVersion, location_name: "JobConfigSchemaVersion"))
|
|
8526
|
+
Job.add_member(:job_config_document, Shapes::ShapeRef.new(shape: JobConfigDocument, location_name: "JobConfigDocument"))
|
|
8527
|
+
Job.add_member(:creation_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "CreationTime"))
|
|
8528
|
+
Job.add_member(:last_modified_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "LastModifiedTime"))
|
|
8529
|
+
Job.add_member(:end_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "EndTime"))
|
|
8530
|
+
Job.add_member(:job_status, Shapes::ShapeRef.new(shape: JobStatus, location_name: "JobStatus"))
|
|
8531
|
+
Job.add_member(:secondary_status, Shapes::ShapeRef.new(shape: JobSecondaryStatus, location_name: "SecondaryStatus"))
|
|
8532
|
+
Job.add_member(:secondary_status_transitions, Shapes::ShapeRef.new(shape: JobSecondaryStatusTransitions, location_name: "SecondaryStatusTransitions"))
|
|
8533
|
+
Job.add_member(:failure_reason, Shapes::ShapeRef.new(shape: FailureReason, location_name: "FailureReason"))
|
|
8534
|
+
Job.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "Tags"))
|
|
8535
|
+
Job.struct_class = Types::Job
|
|
8536
|
+
|
|
8517
8537
|
JobConfigSchemaVersionSummary.add_member(:job_config_schema_version, Shapes::ShapeRef.new(shape: JobSchemaVersion, required: true, location_name: "JobConfigSchemaVersion"))
|
|
8518
8538
|
JobConfigSchemaVersionSummary.struct_class = Types::JobConfigSchemaVersionSummary
|
|
8519
8539
|
|
|
@@ -11710,6 +11730,7 @@ module Aws::SageMaker
|
|
|
11710
11730
|
SearchRecord.add_member(:hyper_parameter_tuning_job, Shapes::ShapeRef.new(shape: HyperParameterTuningJobSearchEntity, location_name: "HyperParameterTuningJob"))
|
|
11711
11731
|
SearchRecord.add_member(:model_card, Shapes::ShapeRef.new(shape: ModelCard, location_name: "ModelCard"))
|
|
11712
11732
|
SearchRecord.add_member(:model, Shapes::ShapeRef.new(shape: ModelDashboardModel, location_name: "Model"))
|
|
11733
|
+
SearchRecord.add_member(:job, Shapes::ShapeRef.new(shape: Job, location_name: "Job"))
|
|
11713
11734
|
SearchRecord.struct_class = Types::SearchRecord
|
|
11714
11735
|
|
|
11715
11736
|
SearchRequest.add_member(:resource, Shapes::ShapeRef.new(shape: ResourceType, required: true, location_name: "Resource"))
|
|
@@ -21331,11 +21331,30 @@ module Aws::SageMaker
|
|
|
21331
21331
|
# provided, then the latest version of the model card is described.
|
|
21332
21332
|
# @return [Integer]
|
|
21333
21333
|
#
|
|
21334
|
+
# @!attribute [rw] included_data
|
|
21335
|
+
# Specifies the level of model card data to include in the response.
|
|
21336
|
+
# Use this parameter to call `DescribeModelCard` without requiring
|
|
21337
|
+
# `kms:Decrypt` permission on the customer-managed Amazon Web Services
|
|
21338
|
+
# KMS key.
|
|
21339
|
+
#
|
|
21340
|
+
# * `AllData`: Returns the full model card `Content`. This option
|
|
21341
|
+
# requires `kms:Decrypt` permission on the customer-managed key, if
|
|
21342
|
+
# one is associated with the model card. This is the default.
|
|
21343
|
+
#
|
|
21344
|
+
# * `MetadataOnly`: Returns the model card with sanitized `Content`
|
|
21345
|
+
# that includes only a small set of unencrypted metadata fields.
|
|
21346
|
+
# This option does not require `kms:Decrypt` permission. For the
|
|
21347
|
+
# list of fields preserved in the response, see `Content`.
|
|
21348
|
+
#
|
|
21349
|
+
# If you don't specify a value, SageMaker returns `AllData`.
|
|
21350
|
+
# @return [String]
|
|
21351
|
+
#
|
|
21334
21352
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DescribeModelCardRequest AWS API Documentation
|
|
21335
21353
|
#
|
|
21336
21354
|
class DescribeModelCardRequest < Struct.new(
|
|
21337
21355
|
:model_card_name,
|
|
21338
|
-
:model_card_version
|
|
21356
|
+
:model_card_version,
|
|
21357
|
+
:included_data)
|
|
21339
21358
|
SENSITIVE = []
|
|
21340
21359
|
include Aws::Structure
|
|
21341
21360
|
end
|
|
@@ -21353,7 +21372,32 @@ module Aws::SageMaker
|
|
|
21353
21372
|
# @return [Integer]
|
|
21354
21373
|
#
|
|
21355
21374
|
# @!attribute [rw] content
|
|
21356
|
-
# The content of the model card.
|
|
21375
|
+
# The content of the model card. Content is provided as a string in
|
|
21376
|
+
# the [model card JSON schema][1].
|
|
21377
|
+
#
|
|
21378
|
+
# When you set `IncludedData` to `MetadataOnly` in the request,
|
|
21379
|
+
# SageMaker returns a sanitized version of `Content` that includes
|
|
21380
|
+
# only the following JSON paths, when present in the model card:
|
|
21381
|
+
#
|
|
21382
|
+
# * `model_overview.model_id`
|
|
21383
|
+
#
|
|
21384
|
+
# * `model_overview.model_name`
|
|
21385
|
+
#
|
|
21386
|
+
# * `intended_uses.risk_rating`
|
|
21387
|
+
#
|
|
21388
|
+
# * `model_package_details.model_package_group_name`
|
|
21389
|
+
#
|
|
21390
|
+
# * `model_package_details.model_package_arn`
|
|
21391
|
+
#
|
|
21392
|
+
# All other fields are removed from `Content` when `IncludedData` is
|
|
21393
|
+
# `MetadataOnly`, including model description, training details,
|
|
21394
|
+
# evaluation details, business details, and additional information. To
|
|
21395
|
+
# retrieve the complete `Content`, set `IncludedData` to `AllData` or
|
|
21396
|
+
# omit the parameter.
|
|
21397
|
+
#
|
|
21398
|
+
#
|
|
21399
|
+
#
|
|
21400
|
+
# [1]: https://docs.aws.amazon.com/sagemaker/latest/dg/model-cards.html#model-cards-json-schema
|
|
21357
21401
|
# @return [String]
|
|
21358
21402
|
#
|
|
21359
21403
|
# @!attribute [rw] model_card_status
|
|
@@ -21656,10 +21700,39 @@ module Aws::SageMaker
|
|
|
21656
21700
|
# Valid characters are a-z, A-Z, 0-9, and - (hyphen).
|
|
21657
21701
|
# @return [String]
|
|
21658
21702
|
#
|
|
21703
|
+
# @!attribute [rw] included_data
|
|
21704
|
+
# Specifies the level of model package data to include in the
|
|
21705
|
+
# response. Use this parameter to call `DescribeModelPackage` on a
|
|
21706
|
+
# model package that has an associated model card without requiring
|
|
21707
|
+
# `kms:Decrypt` permission on the customer-managed KMS key associated
|
|
21708
|
+
# with the embedded model card.
|
|
21709
|
+
#
|
|
21710
|
+
# * `AllData`: Returns the full model package response, including the
|
|
21711
|
+
# unredacted `ModelCard.ModelCardContent`. This option requires
|
|
21712
|
+
# `kms:Decrypt` permission on the customer-managed key, if one is
|
|
21713
|
+
# associated with the embedded model card. This is the default.
|
|
21714
|
+
#
|
|
21715
|
+
# * `MetadataOnly`: Returns the full model package response, but with
|
|
21716
|
+
# the embedded `ModelCard.ModelCardContent` sanitized to include
|
|
21717
|
+
# only a small set of unencrypted metadata fields. This option does
|
|
21718
|
+
# not require `kms:Decrypt` permission. All other top-level response
|
|
21719
|
+
# fields, including `InferenceSpecification`, `ModelMetrics`,
|
|
21720
|
+
# `DriftCheckBaselines`, and `SecurityConfig`, are returned
|
|
21721
|
+
# unchanged. For the list of fields preserved within
|
|
21722
|
+
# `ModelCardContent`, see [ModelCard][1].
|
|
21723
|
+
#
|
|
21724
|
+
# If you don't specify a value, SageMaker returns `AllData`.
|
|
21725
|
+
#
|
|
21726
|
+
#
|
|
21727
|
+
#
|
|
21728
|
+
# [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeModelPackage.html#sagemaker-DescribeModelPackage-response-ModelCard
|
|
21729
|
+
# @return [String]
|
|
21730
|
+
#
|
|
21659
21731
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DescribeModelPackageInput AWS API Documentation
|
|
21660
21732
|
#
|
|
21661
21733
|
class DescribeModelPackageInput < Struct.new(
|
|
21662
|
-
:model_package_name
|
|
21734
|
+
:model_package_name,
|
|
21735
|
+
:included_data)
|
|
21663
21736
|
SENSITIVE = []
|
|
21664
21737
|
include Aws::Structure
|
|
21665
21738
|
end
|
|
@@ -21817,6 +21890,29 @@ module Aws::SageMaker
|
|
|
21817
21890
|
# card associated with the model package, see [View the Details of a
|
|
21818
21891
|
# Model Version][2].
|
|
21819
21892
|
#
|
|
21893
|
+
# When you set `IncludedData` to `MetadataOnly` in the request,
|
|
21894
|
+
# `ModelCardStatus` is preserved and `ModelCardContent` is sanitized
|
|
21895
|
+
# to include only the following JSON paths, when present in the model
|
|
21896
|
+
# card:
|
|
21897
|
+
#
|
|
21898
|
+
# * `model_overview.model_id`
|
|
21899
|
+
#
|
|
21900
|
+
# * `model_overview.model_name`
|
|
21901
|
+
#
|
|
21902
|
+
# * `intended_uses.risk_rating`
|
|
21903
|
+
#
|
|
21904
|
+
# * `model_package_details.model_package_group_name`
|
|
21905
|
+
#
|
|
21906
|
+
# * `model_package_details.model_package_arn`
|
|
21907
|
+
#
|
|
21908
|
+
# Because the `ModelPackageModelCard` schema does not include
|
|
21909
|
+
# `model_package_details` and limits `model_overview` to
|
|
21910
|
+
# `model_creator` and `model_artifact`, the sanitized
|
|
21911
|
+
# `ModelCardContent` for a model package typically contains only
|
|
21912
|
+
# `intended_uses.risk_rating` if it was provided when the model card
|
|
21913
|
+
# was created. To retrieve the complete `ModelCardContent`, set
|
|
21914
|
+
# `IncludedData` to `AllData` or omit the parameter.
|
|
21915
|
+
#
|
|
21820
21916
|
#
|
|
21821
21917
|
#
|
|
21822
21918
|
# [1]: https://docs.aws.amazon.com/sagemaker/latest/dg/model-registry-details.html#model-card-schema
|
|
@@ -32179,6 +32275,88 @@ module Aws::SageMaker
|
|
|
32179
32275
|
include Aws::Structure
|
|
32180
32276
|
end
|
|
32181
32277
|
|
|
32278
|
+
# Search shape for Job. Mirrors DescribeJobResponse fields. If you
|
|
32279
|
+
# update DescribeJobResponse, update this structure as well.
|
|
32280
|
+
#
|
|
32281
|
+
# @!attribute [rw] job_name
|
|
32282
|
+
# The name of the job.
|
|
32283
|
+
# @return [String]
|
|
32284
|
+
#
|
|
32285
|
+
# @!attribute [rw] job_arn
|
|
32286
|
+
# The Amazon Resource Name (ARN) of the job.
|
|
32287
|
+
# @return [String]
|
|
32288
|
+
#
|
|
32289
|
+
# @!attribute [rw] role_arn
|
|
32290
|
+
# The ARN of the IAM role associated with the job.
|
|
32291
|
+
# @return [String]
|
|
32292
|
+
#
|
|
32293
|
+
# @!attribute [rw] job_category
|
|
32294
|
+
# The category of the job.
|
|
32295
|
+
# @return [String]
|
|
32296
|
+
#
|
|
32297
|
+
# @!attribute [rw] job_config_schema_version
|
|
32298
|
+
# The schema version used for the job configuration document.
|
|
32299
|
+
# @return [String]
|
|
32300
|
+
#
|
|
32301
|
+
# @!attribute [rw] job_config_document
|
|
32302
|
+
# The JSON configuration document for the job.
|
|
32303
|
+
# @return [String]
|
|
32304
|
+
#
|
|
32305
|
+
# @!attribute [rw] creation_time
|
|
32306
|
+
# The date and time that the job was created.
|
|
32307
|
+
# @return [Time]
|
|
32308
|
+
#
|
|
32309
|
+
# @!attribute [rw] last_modified_time
|
|
32310
|
+
# The date and time that the job was last modified.
|
|
32311
|
+
# @return [Time]
|
|
32312
|
+
#
|
|
32313
|
+
# @!attribute [rw] end_time
|
|
32314
|
+
# The date and time that the job ended.
|
|
32315
|
+
# @return [Time]
|
|
32316
|
+
#
|
|
32317
|
+
# @!attribute [rw] job_status
|
|
32318
|
+
# The current status of the job.
|
|
32319
|
+
# @return [String]
|
|
32320
|
+
#
|
|
32321
|
+
# @!attribute [rw] secondary_status
|
|
32322
|
+
# The detailed secondary status of the job, providing more granular
|
|
32323
|
+
# information about the job's progress.
|
|
32324
|
+
# @return [String]
|
|
32325
|
+
#
|
|
32326
|
+
# @!attribute [rw] secondary_status_transitions
|
|
32327
|
+
# A list of secondary status transitions for the job, with timestamps
|
|
32328
|
+
# and optional status messages.
|
|
32329
|
+
# @return [Array<Types::JobSecondaryStatusTransition>]
|
|
32330
|
+
#
|
|
32331
|
+
# @!attribute [rw] failure_reason
|
|
32332
|
+
# If the job failed, the reason it failed.
|
|
32333
|
+
# @return [String]
|
|
32334
|
+
#
|
|
32335
|
+
# @!attribute [rw] tags
|
|
32336
|
+
# The tags associated with the job.
|
|
32337
|
+
# @return [Array<Types::Tag>]
|
|
32338
|
+
#
|
|
32339
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/Job AWS API Documentation
|
|
32340
|
+
#
|
|
32341
|
+
class Job < Struct.new(
|
|
32342
|
+
:job_name,
|
|
32343
|
+
:job_arn,
|
|
32344
|
+
:role_arn,
|
|
32345
|
+
:job_category,
|
|
32346
|
+
:job_config_schema_version,
|
|
32347
|
+
:job_config_document,
|
|
32348
|
+
:creation_time,
|
|
32349
|
+
:last_modified_time,
|
|
32350
|
+
:end_time,
|
|
32351
|
+
:job_status,
|
|
32352
|
+
:secondary_status,
|
|
32353
|
+
:secondary_status_transitions,
|
|
32354
|
+
:failure_reason,
|
|
32355
|
+
:tags)
|
|
32356
|
+
SENSITIVE = []
|
|
32357
|
+
include Aws::Structure
|
|
32358
|
+
end
|
|
32359
|
+
|
|
32182
32360
|
# Provides summary information about a job configuration schema version.
|
|
32183
32361
|
#
|
|
32184
32362
|
# @!attribute [rw] job_config_schema_version
|
|
@@ -49884,6 +50062,11 @@ module Aws::SageMaker
|
|
|
49884
50062
|
# A model displayed in the Amazon SageMaker Model Dashboard.
|
|
49885
50063
|
# @return [Types::ModelDashboardModel]
|
|
49886
50064
|
#
|
|
50065
|
+
# @!attribute [rw] job
|
|
50066
|
+
# Search shape for Job. Mirrors DescribeJobResponse fields. If you
|
|
50067
|
+
# update DescribeJobResponse, update this structure as well.
|
|
50068
|
+
# @return [Types::Job]
|
|
50069
|
+
#
|
|
49887
50070
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/SearchRecord AWS API Documentation
|
|
49888
50071
|
#
|
|
49889
50072
|
class SearchRecord < Struct.new(
|
|
@@ -49902,7 +50085,8 @@ module Aws::SageMaker
|
|
|
49902
50085
|
:project,
|
|
49903
50086
|
:hyper_parameter_tuning_job,
|
|
49904
50087
|
:model_card,
|
|
49905
|
-
:model
|
|
50088
|
+
:model,
|
|
50089
|
+
:job)
|
|
49906
50090
|
SENSITIVE = []
|
|
49907
50091
|
include Aws::Structure
|
|
49908
50092
|
end
|
data/lib/aws-sdk-sagemaker.rb
CHANGED
data/sig/client.rbs
CHANGED
|
@@ -4535,7 +4535,8 @@ module Aws
|
|
|
4535
4535
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SageMaker/Client.html#describe_model_card-instance_method
|
|
4536
4536
|
def describe_model_card: (
|
|
4537
4537
|
model_card_name: ::String,
|
|
4538
|
-
?model_card_version: ::Integer
|
|
4538
|
+
?model_card_version: ::Integer,
|
|
4539
|
+
?included_data: ("AllData" | "MetadataOnly")
|
|
4539
4540
|
) -> _DescribeModelCardResponseSuccess
|
|
4540
4541
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribeModelCardResponseSuccess
|
|
4541
4542
|
|
|
@@ -4615,7 +4616,8 @@ module Aws
|
|
|
4615
4616
|
end
|
|
4616
4617
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SageMaker/Client.html#describe_model_package-instance_method
|
|
4617
4618
|
def describe_model_package: (
|
|
4618
|
-
model_package_name: ::String
|
|
4619
|
+
model_package_name: ::String,
|
|
4620
|
+
?included_data: ("AllData" | "MetadataOnly")
|
|
4619
4621
|
) -> _DescribeModelPackageResponseSuccess
|
|
4620
4622
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribeModelPackageResponseSuccess
|
|
4621
4623
|
|
|
@@ -5304,7 +5306,7 @@ module Aws
|
|
|
5304
5306
|
end
|
|
5305
5307
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SageMaker/Client.html#get_search_suggestions-instance_method
|
|
5306
5308
|
def get_search_suggestions: (
|
|
5307
|
-
resource: ("TrainingJob" | "Experiment" | "ExperimentTrial" | "ExperimentTrialComponent" | "Endpoint" | "Model" | "ModelPackage" | "ModelPackageGroup" | "Pipeline" | "PipelineExecution" | "FeatureGroup" | "FeatureMetadata" | "Image" | "ImageVersion" | "Project" | "HyperParameterTuningJob" | "ModelCard" | "PipelineVersion"),
|
|
5309
|
+
resource: ("TrainingJob" | "Experiment" | "ExperimentTrial" | "ExperimentTrialComponent" | "Endpoint" | "Model" | "ModelPackage" | "ModelPackageGroup" | "Pipeline" | "PipelineExecution" | "FeatureGroup" | "FeatureMetadata" | "Image" | "ImageVersion" | "Project" | "HyperParameterTuningJob" | "ModelCard" | "PipelineVersion" | "Job"),
|
|
5308
5310
|
?suggestion_query: {
|
|
5309
5311
|
property_name_query: {
|
|
5310
5312
|
property_name_hint: ::String
|
|
@@ -7058,7 +7060,7 @@ module Aws
|
|
|
7058
7060
|
end
|
|
7059
7061
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SageMaker/Client.html#search-instance_method
|
|
7060
7062
|
def search: (
|
|
7061
|
-
resource: ("TrainingJob" | "Experiment" | "ExperimentTrial" | "ExperimentTrialComponent" | "Endpoint" | "Model" | "ModelPackage" | "ModelPackageGroup" | "Pipeline" | "PipelineExecution" | "FeatureGroup" | "FeatureMetadata" | "Image" | "ImageVersion" | "Project" | "HyperParameterTuningJob" | "ModelCard" | "PipelineVersion"),
|
|
7063
|
+
resource: ("TrainingJob" | "Experiment" | "ExperimentTrial" | "ExperimentTrialComponent" | "Endpoint" | "Model" | "ModelPackage" | "ModelPackageGroup" | "Pipeline" | "PipelineExecution" | "FeatureGroup" | "FeatureMetadata" | "Image" | "ImageVersion" | "Project" | "HyperParameterTuningJob" | "ModelCard" | "PipelineVersion" | "Job"),
|
|
7062
7064
|
?search_expression: Params::search_expression,
|
|
7063
7065
|
?sort_by: ::String,
|
|
7064
7066
|
?sort_order: ("Ascending" | "Descending"),
|
data/sig/types.rbs
CHANGED
|
@@ -4640,6 +4640,7 @@ module Aws::SageMaker
|
|
|
4640
4640
|
class DescribeModelCardRequest
|
|
4641
4641
|
attr_accessor model_card_name: ::String
|
|
4642
4642
|
attr_accessor model_card_version: ::Integer
|
|
4643
|
+
attr_accessor included_data: ("AllData" | "MetadataOnly")
|
|
4643
4644
|
SENSITIVE: []
|
|
4644
4645
|
end
|
|
4645
4646
|
|
|
@@ -4715,6 +4716,7 @@ module Aws::SageMaker
|
|
|
4715
4716
|
|
|
4716
4717
|
class DescribeModelPackageInput
|
|
4717
4718
|
attr_accessor model_package_name: ::String
|
|
4719
|
+
attr_accessor included_data: ("AllData" | "MetadataOnly")
|
|
4718
4720
|
SENSITIVE: []
|
|
4719
4721
|
end
|
|
4720
4722
|
|
|
@@ -6042,7 +6044,7 @@ module Aws::SageMaker
|
|
|
6042
6044
|
end
|
|
6043
6045
|
|
|
6044
6046
|
class GetSearchSuggestionsRequest
|
|
6045
|
-
attr_accessor resource: ("TrainingJob" | "Experiment" | "ExperimentTrial" | "ExperimentTrialComponent" | "Endpoint" | "Model" | "ModelPackage" | "ModelPackageGroup" | "Pipeline" | "PipelineExecution" | "FeatureGroup" | "FeatureMetadata" | "Image" | "ImageVersion" | "Project" | "HyperParameterTuningJob" | "ModelCard" | "PipelineVersion")
|
|
6047
|
+
attr_accessor resource: ("TrainingJob" | "Experiment" | "ExperimentTrial" | "ExperimentTrialComponent" | "Endpoint" | "Model" | "ModelPackage" | "ModelPackageGroup" | "Pipeline" | "PipelineExecution" | "FeatureGroup" | "FeatureMetadata" | "Image" | "ImageVersion" | "Project" | "HyperParameterTuningJob" | "ModelCard" | "PipelineVersion" | "Job")
|
|
6046
6048
|
attr_accessor suggestion_query: Types::SuggestionQuery
|
|
6047
6049
|
SENSITIVE: []
|
|
6048
6050
|
end
|
|
@@ -6727,6 +6729,24 @@ module Aws::SageMaker
|
|
|
6727
6729
|
SENSITIVE: []
|
|
6728
6730
|
end
|
|
6729
6731
|
|
|
6732
|
+
class Job
|
|
6733
|
+
attr_accessor job_name: ::String
|
|
6734
|
+
attr_accessor job_arn: ::String
|
|
6735
|
+
attr_accessor role_arn: ::String
|
|
6736
|
+
attr_accessor job_category: ("AgentRFT" | "AgentRFTEvaluation")
|
|
6737
|
+
attr_accessor job_config_schema_version: ::String
|
|
6738
|
+
attr_accessor job_config_document: ::String
|
|
6739
|
+
attr_accessor creation_time: ::Time
|
|
6740
|
+
attr_accessor last_modified_time: ::Time
|
|
6741
|
+
attr_accessor end_time: ::Time
|
|
6742
|
+
attr_accessor job_status: ("InProgress" | "Completed" | "Failed" | "Stopping" | "Stopped" | "Deleting" | "DeleteFailed")
|
|
6743
|
+
attr_accessor secondary_status: ("Starting" | "Downloading" | "Training" | "Uploading" | "Stopping" | "Stopped" | "MaxRuntimeExceeded" | "Interrupted" | "Failed" | "Completed" | "Restarting" | "Pending" | "Evaluating" | "Deleting" | "DeleteFailed")
|
|
6744
|
+
attr_accessor secondary_status_transitions: ::Array[Types::JobSecondaryStatusTransition]
|
|
6745
|
+
attr_accessor failure_reason: ::String
|
|
6746
|
+
attr_accessor tags: ::Array[Types::Tag]
|
|
6747
|
+
SENSITIVE: []
|
|
6748
|
+
end
|
|
6749
|
+
|
|
6730
6750
|
class JobConfigSchemaVersionSummary
|
|
6731
6751
|
attr_accessor job_config_schema_version: ::String
|
|
6732
6752
|
SENSITIVE: []
|
|
@@ -10627,11 +10647,12 @@ module Aws::SageMaker
|
|
|
10627
10647
|
attr_accessor hyper_parameter_tuning_job: Types::HyperParameterTuningJobSearchEntity
|
|
10628
10648
|
attr_accessor model_card: Types::ModelCard
|
|
10629
10649
|
attr_accessor model: Types::ModelDashboardModel
|
|
10650
|
+
attr_accessor job: Types::Job
|
|
10630
10651
|
SENSITIVE: []
|
|
10631
10652
|
end
|
|
10632
10653
|
|
|
10633
10654
|
class SearchRequest
|
|
10634
|
-
attr_accessor resource: ("TrainingJob" | "Experiment" | "ExperimentTrial" | "ExperimentTrialComponent" | "Endpoint" | "Model" | "ModelPackage" | "ModelPackageGroup" | "Pipeline" | "PipelineExecution" | "FeatureGroup" | "FeatureMetadata" | "Image" | "ImageVersion" | "Project" | "HyperParameterTuningJob" | "ModelCard" | "PipelineVersion")
|
|
10655
|
+
attr_accessor resource: ("TrainingJob" | "Experiment" | "ExperimentTrial" | "ExperimentTrialComponent" | "Endpoint" | "Model" | "ModelPackage" | "ModelPackageGroup" | "Pipeline" | "PipelineExecution" | "FeatureGroup" | "FeatureMetadata" | "Image" | "ImageVersion" | "Project" | "HyperParameterTuningJob" | "ModelCard" | "PipelineVersion" | "Job")
|
|
10635
10656
|
attr_accessor search_expression: Types::SearchExpression
|
|
10636
10657
|
attr_accessor sort_by: ::String
|
|
10637
10658
|
attr_accessor sort_order: ("Ascending" | "Descending")
|