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
|
@@ -11551,6 +11551,69 @@ module Aws::SageMaker
|
|
|
11551
11551
|
include Aws::Structure
|
|
11552
11552
|
end
|
|
11553
11553
|
|
|
11554
|
+
# @!attribute [rw] job_name
|
|
11555
|
+
# The name of the job. The name must be unique within your account and
|
|
11556
|
+
# Amazon Web Services Region.
|
|
11557
|
+
# @return [String]
|
|
11558
|
+
#
|
|
11559
|
+
# @!attribute [rw] role_arn
|
|
11560
|
+
# The Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker
|
|
11561
|
+
# assumes to perform the job. The role must have the necessary
|
|
11562
|
+
# permissions to access the resources required by the job
|
|
11563
|
+
# configuration.
|
|
11564
|
+
# @return [String]
|
|
11565
|
+
#
|
|
11566
|
+
# @!attribute [rw] job_category
|
|
11567
|
+
# The category of the job. The category determines the type of
|
|
11568
|
+
# workload that the job runs.
|
|
11569
|
+
# @return [String]
|
|
11570
|
+
#
|
|
11571
|
+
# @!attribute [rw] job_config_schema_version
|
|
11572
|
+
# The version of the configuration schema to use for the job
|
|
11573
|
+
# configuration document. Use `ListJobSchemaVersions` to get available
|
|
11574
|
+
# schema versions for a job category.
|
|
11575
|
+
# @return [String]
|
|
11576
|
+
#
|
|
11577
|
+
# @!attribute [rw] job_config_document
|
|
11578
|
+
# The JSON configuration document for the job. The document must
|
|
11579
|
+
# conform to the schema specified by `JobConfigSchemaVersion`. Use
|
|
11580
|
+
# `DescribeJobSchemaVersion` to retrieve the schema for validation.
|
|
11581
|
+
# @return [String]
|
|
11582
|
+
#
|
|
11583
|
+
# @!attribute [rw] tags
|
|
11584
|
+
# An array of key-value pairs to apply to the job as tags. For more
|
|
11585
|
+
# information, see [Tagging Amazon Web Services Resources][1].
|
|
11586
|
+
#
|
|
11587
|
+
#
|
|
11588
|
+
#
|
|
11589
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
|
|
11590
|
+
# @return [Array<Types::Tag>]
|
|
11591
|
+
#
|
|
11592
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/CreateJobRequest AWS API Documentation
|
|
11593
|
+
#
|
|
11594
|
+
class CreateJobRequest < Struct.new(
|
|
11595
|
+
:job_name,
|
|
11596
|
+
:role_arn,
|
|
11597
|
+
:job_category,
|
|
11598
|
+
:job_config_schema_version,
|
|
11599
|
+
:job_config_document,
|
|
11600
|
+
:tags)
|
|
11601
|
+
SENSITIVE = []
|
|
11602
|
+
include Aws::Structure
|
|
11603
|
+
end
|
|
11604
|
+
|
|
11605
|
+
# @!attribute [rw] job_arn
|
|
11606
|
+
# The Amazon Resource Name (ARN) of the job.
|
|
11607
|
+
# @return [String]
|
|
11608
|
+
#
|
|
11609
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/CreateJobResponse AWS API Documentation
|
|
11610
|
+
#
|
|
11611
|
+
class CreateJobResponse < Struct.new(
|
|
11612
|
+
:job_arn)
|
|
11613
|
+
SENSITIVE = []
|
|
11614
|
+
include Aws::Structure
|
|
11615
|
+
end
|
|
11616
|
+
|
|
11554
11617
|
# @!attribute [rw] labeling_job_name
|
|
11555
11618
|
# The name of the labeling job. This name is used to identify the job
|
|
11556
11619
|
# in a list of labeling jobs. Labeling job names must be unique within
|
|
@@ -16040,6 +16103,27 @@ module Aws::SageMaker
|
|
|
16040
16103
|
include Aws::Structure
|
|
16041
16104
|
end
|
|
16042
16105
|
|
|
16106
|
+
# @!attribute [rw] job_name
|
|
16107
|
+
# The name of the job to delete.
|
|
16108
|
+
# @return [String]
|
|
16109
|
+
#
|
|
16110
|
+
# @!attribute [rw] job_category
|
|
16111
|
+
# The category of the job to delete.
|
|
16112
|
+
# @return [String]
|
|
16113
|
+
#
|
|
16114
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DeleteJobRequest AWS API Documentation
|
|
16115
|
+
#
|
|
16116
|
+
class DeleteJobRequest < Struct.new(
|
|
16117
|
+
:job_name,
|
|
16118
|
+
:job_category)
|
|
16119
|
+
SENSITIVE = []
|
|
16120
|
+
include Aws::Structure
|
|
16121
|
+
end
|
|
16122
|
+
|
|
16123
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DeleteJobResponse AWS API Documentation
|
|
16124
|
+
#
|
|
16125
|
+
class DeleteJobResponse < Aws::EmptyStructure; end
|
|
16126
|
+
|
|
16043
16127
|
# @!attribute [rw] arn
|
|
16044
16128
|
# The ARN of the MLflow App to delete.
|
|
16045
16129
|
# @return [String]
|
|
@@ -20491,6 +20575,144 @@ module Aws::SageMaker
|
|
|
20491
20575
|
include Aws::Structure
|
|
20492
20576
|
end
|
|
20493
20577
|
|
|
20578
|
+
# @!attribute [rw] job_name
|
|
20579
|
+
# The name of the job to describe.
|
|
20580
|
+
# @return [String]
|
|
20581
|
+
#
|
|
20582
|
+
# @!attribute [rw] job_category
|
|
20583
|
+
# The category of the job.
|
|
20584
|
+
# @return [String]
|
|
20585
|
+
#
|
|
20586
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DescribeJobRequest AWS API Documentation
|
|
20587
|
+
#
|
|
20588
|
+
class DescribeJobRequest < Struct.new(
|
|
20589
|
+
:job_name,
|
|
20590
|
+
:job_category)
|
|
20591
|
+
SENSITIVE = []
|
|
20592
|
+
include Aws::Structure
|
|
20593
|
+
end
|
|
20594
|
+
|
|
20595
|
+
# @!attribute [rw] job_name
|
|
20596
|
+
# The name of the job.
|
|
20597
|
+
# @return [String]
|
|
20598
|
+
#
|
|
20599
|
+
# @!attribute [rw] job_arn
|
|
20600
|
+
# The Amazon Resource Name (ARN) of the job.
|
|
20601
|
+
# @return [String]
|
|
20602
|
+
#
|
|
20603
|
+
# @!attribute [rw] role_arn
|
|
20604
|
+
# The ARN of the IAM role associated with the job.
|
|
20605
|
+
# @return [String]
|
|
20606
|
+
#
|
|
20607
|
+
# @!attribute [rw] job_category
|
|
20608
|
+
# The category of the job.
|
|
20609
|
+
# @return [String]
|
|
20610
|
+
#
|
|
20611
|
+
# @!attribute [rw] job_config_schema_version
|
|
20612
|
+
# The schema version used for the job configuration document.
|
|
20613
|
+
# @return [String]
|
|
20614
|
+
#
|
|
20615
|
+
# @!attribute [rw] job_config_document
|
|
20616
|
+
# The JSON configuration document for the job.
|
|
20617
|
+
# @return [String]
|
|
20618
|
+
#
|
|
20619
|
+
# @!attribute [rw] creation_time
|
|
20620
|
+
# The date and time that the job was created.
|
|
20621
|
+
# @return [Time]
|
|
20622
|
+
#
|
|
20623
|
+
# @!attribute [rw] last_modified_time
|
|
20624
|
+
# The date and time that the job was last modified.
|
|
20625
|
+
# @return [Time]
|
|
20626
|
+
#
|
|
20627
|
+
# @!attribute [rw] end_time
|
|
20628
|
+
# The date and time that the job ended.
|
|
20629
|
+
# @return [Time]
|
|
20630
|
+
#
|
|
20631
|
+
# @!attribute [rw] job_status
|
|
20632
|
+
# The current status of the job.
|
|
20633
|
+
# @return [String]
|
|
20634
|
+
#
|
|
20635
|
+
# @!attribute [rw] secondary_status
|
|
20636
|
+
# The detailed secondary status of the job, providing more granular
|
|
20637
|
+
# information about the job's progress. Secondary statuses may change
|
|
20638
|
+
# between releases.
|
|
20639
|
+
# @return [String]
|
|
20640
|
+
#
|
|
20641
|
+
# @!attribute [rw] secondary_status_transitions
|
|
20642
|
+
# A list of secondary status transitions for the job, with timestamps
|
|
20643
|
+
# and optional status messages.
|
|
20644
|
+
# @return [Array<Types::JobSecondaryStatusTransition>]
|
|
20645
|
+
#
|
|
20646
|
+
# @!attribute [rw] failure_reason
|
|
20647
|
+
# If the job failed, the reason it failed.
|
|
20648
|
+
# @return [String]
|
|
20649
|
+
#
|
|
20650
|
+
# @!attribute [rw] tags
|
|
20651
|
+
# The tags associated with the job.
|
|
20652
|
+
# @return [Array<Types::Tag>]
|
|
20653
|
+
#
|
|
20654
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DescribeJobResponse AWS API Documentation
|
|
20655
|
+
#
|
|
20656
|
+
class DescribeJobResponse < Struct.new(
|
|
20657
|
+
:job_name,
|
|
20658
|
+
:job_arn,
|
|
20659
|
+
:role_arn,
|
|
20660
|
+
:job_category,
|
|
20661
|
+
:job_config_schema_version,
|
|
20662
|
+
:job_config_document,
|
|
20663
|
+
:creation_time,
|
|
20664
|
+
:last_modified_time,
|
|
20665
|
+
:end_time,
|
|
20666
|
+
:job_status,
|
|
20667
|
+
:secondary_status,
|
|
20668
|
+
:secondary_status_transitions,
|
|
20669
|
+
:failure_reason,
|
|
20670
|
+
:tags)
|
|
20671
|
+
SENSITIVE = []
|
|
20672
|
+
include Aws::Structure
|
|
20673
|
+
end
|
|
20674
|
+
|
|
20675
|
+
# @!attribute [rw] job_category
|
|
20676
|
+
# The category of the job schema to describe.
|
|
20677
|
+
# @return [String]
|
|
20678
|
+
#
|
|
20679
|
+
# @!attribute [rw] job_config_schema_version
|
|
20680
|
+
# The version of the schema to retrieve. If not specified, the latest
|
|
20681
|
+
# version is returned.
|
|
20682
|
+
# @return [String]
|
|
20683
|
+
#
|
|
20684
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DescribeJobSchemaVersionRequest AWS API Documentation
|
|
20685
|
+
#
|
|
20686
|
+
class DescribeJobSchemaVersionRequest < Struct.new(
|
|
20687
|
+
:job_category,
|
|
20688
|
+
:job_config_schema_version)
|
|
20689
|
+
SENSITIVE = []
|
|
20690
|
+
include Aws::Structure
|
|
20691
|
+
end
|
|
20692
|
+
|
|
20693
|
+
# @!attribute [rw] job_category
|
|
20694
|
+
# The category of the job schema.
|
|
20695
|
+
# @return [String]
|
|
20696
|
+
#
|
|
20697
|
+
# @!attribute [rw] job_config_schema_version
|
|
20698
|
+
# The version of the schema.
|
|
20699
|
+
# @return [String]
|
|
20700
|
+
#
|
|
20701
|
+
# @!attribute [rw] job_config_schema
|
|
20702
|
+
# The JSON schema document that defines the structure of the job
|
|
20703
|
+
# configuration.
|
|
20704
|
+
# @return [String]
|
|
20705
|
+
#
|
|
20706
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DescribeJobSchemaVersionResponse AWS API Documentation
|
|
20707
|
+
#
|
|
20708
|
+
class DescribeJobSchemaVersionResponse < Struct.new(
|
|
20709
|
+
:job_category,
|
|
20710
|
+
:job_config_schema_version,
|
|
20711
|
+
:job_config_schema)
|
|
20712
|
+
SENSITIVE = []
|
|
20713
|
+
include Aws::Structure
|
|
20714
|
+
end
|
|
20715
|
+
|
|
20494
20716
|
# @!attribute [rw] labeling_job_name
|
|
20495
20717
|
# The name of the labeling job to return information for.
|
|
20496
20718
|
# @return [String]
|
|
@@ -21109,11 +21331,30 @@ module Aws::SageMaker
|
|
|
21109
21331
|
# provided, then the latest version of the model card is described.
|
|
21110
21332
|
# @return [Integer]
|
|
21111
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
|
+
#
|
|
21112
21352
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DescribeModelCardRequest AWS API Documentation
|
|
21113
21353
|
#
|
|
21114
21354
|
class DescribeModelCardRequest < Struct.new(
|
|
21115
21355
|
:model_card_name,
|
|
21116
|
-
:model_card_version
|
|
21356
|
+
:model_card_version,
|
|
21357
|
+
:included_data)
|
|
21117
21358
|
SENSITIVE = []
|
|
21118
21359
|
include Aws::Structure
|
|
21119
21360
|
end
|
|
@@ -21131,7 +21372,32 @@ module Aws::SageMaker
|
|
|
21131
21372
|
# @return [Integer]
|
|
21132
21373
|
#
|
|
21133
21374
|
# @!attribute [rw] content
|
|
21134
|
-
# 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
|
|
21135
21401
|
# @return [String]
|
|
21136
21402
|
#
|
|
21137
21403
|
# @!attribute [rw] model_card_status
|
|
@@ -21434,10 +21700,39 @@ module Aws::SageMaker
|
|
|
21434
21700
|
# Valid characters are a-z, A-Z, 0-9, and - (hyphen).
|
|
21435
21701
|
# @return [String]
|
|
21436
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
|
+
#
|
|
21437
21731
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DescribeModelPackageInput AWS API Documentation
|
|
21438
21732
|
#
|
|
21439
21733
|
class DescribeModelPackageInput < Struct.new(
|
|
21440
|
-
:model_package_name
|
|
21734
|
+
:model_package_name,
|
|
21735
|
+
:included_data)
|
|
21441
21736
|
SENSITIVE = []
|
|
21442
21737
|
include Aws::Structure
|
|
21443
21738
|
end
|
|
@@ -21595,6 +21890,29 @@ module Aws::SageMaker
|
|
|
21595
21890
|
# card associated with the model package, see [View the Details of a
|
|
21596
21891
|
# Model Version][2].
|
|
21597
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
|
+
#
|
|
21598
21916
|
#
|
|
21599
21917
|
#
|
|
21600
21918
|
# [1]: https://docs.aws.amazon.com/sagemaker/latest/dg/model-registry-details.html#model-card-schema
|
|
@@ -31957,6 +32275,201 @@ module Aws::SageMaker
|
|
|
31957
32275
|
include Aws::Structure
|
|
31958
32276
|
end
|
|
31959
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
|
+
|
|
32360
|
+
# Provides summary information about a job configuration schema version.
|
|
32361
|
+
#
|
|
32362
|
+
# @!attribute [rw] job_config_schema_version
|
|
32363
|
+
# The version of the job configuration schema.
|
|
32364
|
+
# @return [String]
|
|
32365
|
+
#
|
|
32366
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/JobConfigSchemaVersionSummary AWS API Documentation
|
|
32367
|
+
#
|
|
32368
|
+
class JobConfigSchemaVersionSummary < Struct.new(
|
|
32369
|
+
:job_config_schema_version)
|
|
32370
|
+
SENSITIVE = []
|
|
32371
|
+
include Aws::Structure
|
|
32372
|
+
end
|
|
32373
|
+
|
|
32374
|
+
# Represents a secondary status transition for a job. Jobs progress
|
|
32375
|
+
# through multiple secondary statuses during execution. Each transition
|
|
32376
|
+
# records the status, start time, optional end time, and an optional
|
|
32377
|
+
# message with additional details.
|
|
32378
|
+
#
|
|
32379
|
+
# @!attribute [rw] status
|
|
32380
|
+
# The secondary status of the job at this transition point.
|
|
32381
|
+
# @return [String]
|
|
32382
|
+
#
|
|
32383
|
+
# @!attribute [rw] start_time
|
|
32384
|
+
# The date and time that the status transition started.
|
|
32385
|
+
# @return [Time]
|
|
32386
|
+
#
|
|
32387
|
+
# @!attribute [rw] end_time
|
|
32388
|
+
# The date and time that the status transition ended.
|
|
32389
|
+
# @return [Time]
|
|
32390
|
+
#
|
|
32391
|
+
# @!attribute [rw] status_message
|
|
32392
|
+
# A detailed message about the status transition.
|
|
32393
|
+
# @return [String]
|
|
32394
|
+
#
|
|
32395
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/JobSecondaryStatusTransition AWS API Documentation
|
|
32396
|
+
#
|
|
32397
|
+
class JobSecondaryStatusTransition < Struct.new(
|
|
32398
|
+
:status,
|
|
32399
|
+
:start_time,
|
|
32400
|
+
:end_time,
|
|
32401
|
+
:status_message)
|
|
32402
|
+
SENSITIVE = []
|
|
32403
|
+
include Aws::Structure
|
|
32404
|
+
end
|
|
32405
|
+
|
|
32406
|
+
# Metadata for a SageMaker job step.
|
|
32407
|
+
#
|
|
32408
|
+
# @!attribute [rw] arn
|
|
32409
|
+
# The Amazon Resource Name (ARN) of the SageMaker job that was run by
|
|
32410
|
+
# this step execution.
|
|
32411
|
+
# @return [String]
|
|
32412
|
+
#
|
|
32413
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/JobStepMetadata AWS API Documentation
|
|
32414
|
+
#
|
|
32415
|
+
class JobStepMetadata < Struct.new(
|
|
32416
|
+
:arn)
|
|
32417
|
+
SENSITIVE = []
|
|
32418
|
+
include Aws::Structure
|
|
32419
|
+
end
|
|
32420
|
+
|
|
32421
|
+
# Provides summary information about a job, returned by the `ListJobs`
|
|
32422
|
+
# operation. Use `DescribeJob` to get full details for a specific job.
|
|
32423
|
+
#
|
|
32424
|
+
# @!attribute [rw] job_arn
|
|
32425
|
+
# The Amazon Resource Name (ARN) of the job.
|
|
32426
|
+
# @return [String]
|
|
32427
|
+
#
|
|
32428
|
+
# @!attribute [rw] job_name
|
|
32429
|
+
# The name of the job.
|
|
32430
|
+
# @return [String]
|
|
32431
|
+
#
|
|
32432
|
+
# @!attribute [rw] job_category
|
|
32433
|
+
# The category of the job.
|
|
32434
|
+
# @return [String]
|
|
32435
|
+
#
|
|
32436
|
+
# @!attribute [rw] job_status
|
|
32437
|
+
# The current status of the job.
|
|
32438
|
+
# @return [String]
|
|
32439
|
+
#
|
|
32440
|
+
# @!attribute [rw] job_secondary_status
|
|
32441
|
+
# The secondary status of the job, providing more granular information
|
|
32442
|
+
# about the job's progress. Secondary statuses may change between
|
|
32443
|
+
# releases.
|
|
32444
|
+
# @return [String]
|
|
32445
|
+
#
|
|
32446
|
+
# @!attribute [rw] creation_time
|
|
32447
|
+
# The date and time that the job was created.
|
|
32448
|
+
# @return [Time]
|
|
32449
|
+
#
|
|
32450
|
+
# @!attribute [rw] last_modified_time
|
|
32451
|
+
# The date and time that the job was last modified.
|
|
32452
|
+
# @return [Time]
|
|
32453
|
+
#
|
|
32454
|
+
# @!attribute [rw] end_time
|
|
32455
|
+
# The date and time that the job ended.
|
|
32456
|
+
# @return [Time]
|
|
32457
|
+
#
|
|
32458
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/JobSummary AWS API Documentation
|
|
32459
|
+
#
|
|
32460
|
+
class JobSummary < Struct.new(
|
|
32461
|
+
:job_arn,
|
|
32462
|
+
:job_name,
|
|
32463
|
+
:job_category,
|
|
32464
|
+
:job_status,
|
|
32465
|
+
:job_secondary_status,
|
|
32466
|
+
:creation_time,
|
|
32467
|
+
:last_modified_time,
|
|
32468
|
+
:end_time)
|
|
32469
|
+
SENSITIVE = []
|
|
32470
|
+
include Aws::Structure
|
|
32471
|
+
end
|
|
32472
|
+
|
|
31960
32473
|
# The configuration for the file system and kernels in a SageMaker AI
|
|
31961
32474
|
# image running as a JupyterLab app. The `FileSystemConfig` object is
|
|
31962
32475
|
# not supported.
|
|
@@ -35991,6 +36504,134 @@ module Aws::SageMaker
|
|
|
35991
36504
|
include Aws::Structure
|
|
35992
36505
|
end
|
|
35993
36506
|
|
|
36507
|
+
# @!attribute [rw] job_category
|
|
36508
|
+
# The category of job schemas to list.
|
|
36509
|
+
# @return [String]
|
|
36510
|
+
#
|
|
36511
|
+
# @!attribute [rw] next_token
|
|
36512
|
+
# If the previous response was truncated, this token retrieves the
|
|
36513
|
+
# next set of results.
|
|
36514
|
+
# @return [String]
|
|
36515
|
+
#
|
|
36516
|
+
# @!attribute [rw] max_results
|
|
36517
|
+
# The maximum number of schema versions to return in the response. The
|
|
36518
|
+
# default value is 5.
|
|
36519
|
+
# @return [Integer]
|
|
36520
|
+
#
|
|
36521
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/ListJobSchemaVersionsRequest AWS API Documentation
|
|
36522
|
+
#
|
|
36523
|
+
class ListJobSchemaVersionsRequest < Struct.new(
|
|
36524
|
+
:job_category,
|
|
36525
|
+
:next_token,
|
|
36526
|
+
:max_results)
|
|
36527
|
+
SENSITIVE = []
|
|
36528
|
+
include Aws::Structure
|
|
36529
|
+
end
|
|
36530
|
+
|
|
36531
|
+
# @!attribute [rw] next_token
|
|
36532
|
+
# If the response is truncated, this token retrieves the next set of
|
|
36533
|
+
# results.
|
|
36534
|
+
# @return [String]
|
|
36535
|
+
#
|
|
36536
|
+
# @!attribute [rw] job_config_schemas
|
|
36537
|
+
# An array of `JobConfigSchemaVersionSummary` objects listing the
|
|
36538
|
+
# available schema versions.
|
|
36539
|
+
# @return [Array<Types::JobConfigSchemaVersionSummary>]
|
|
36540
|
+
#
|
|
36541
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/ListJobSchemaVersionsResponse AWS API Documentation
|
|
36542
|
+
#
|
|
36543
|
+
class ListJobSchemaVersionsResponse < Struct.new(
|
|
36544
|
+
:next_token,
|
|
36545
|
+
:job_config_schemas)
|
|
36546
|
+
SENSITIVE = []
|
|
36547
|
+
include Aws::Structure
|
|
36548
|
+
end
|
|
36549
|
+
|
|
36550
|
+
# @!attribute [rw] job_category
|
|
36551
|
+
# The category of jobs to list.
|
|
36552
|
+
# @return [String]
|
|
36553
|
+
#
|
|
36554
|
+
# @!attribute [rw] next_token
|
|
36555
|
+
# If the previous response was truncated, this token retrieves the
|
|
36556
|
+
# next set of results.
|
|
36557
|
+
# @return [String]
|
|
36558
|
+
#
|
|
36559
|
+
# @!attribute [rw] max_results
|
|
36560
|
+
# The maximum number of jobs to return in the response. The default
|
|
36561
|
+
# value is 50.
|
|
36562
|
+
# @return [Integer]
|
|
36563
|
+
#
|
|
36564
|
+
# @!attribute [rw] creation_time_after
|
|
36565
|
+
# A filter that returns only jobs created after the specified time.
|
|
36566
|
+
# @return [Time]
|
|
36567
|
+
#
|
|
36568
|
+
# @!attribute [rw] creation_time_before
|
|
36569
|
+
# A filter that returns only jobs created before the specified time.
|
|
36570
|
+
# @return [Time]
|
|
36571
|
+
#
|
|
36572
|
+
# @!attribute [rw] last_modified_time_after
|
|
36573
|
+
# A filter that returns only jobs modified after the specified time.
|
|
36574
|
+
# @return [Time]
|
|
36575
|
+
#
|
|
36576
|
+
# @!attribute [rw] last_modified_time_before
|
|
36577
|
+
# A filter that returns only jobs modified before the specified time.
|
|
36578
|
+
# @return [Time]
|
|
36579
|
+
#
|
|
36580
|
+
# @!attribute [rw] name_contains
|
|
36581
|
+
# A string in the job name to filter results. Only jobs whose name
|
|
36582
|
+
# contains the specified string are returned.
|
|
36583
|
+
# @return [String]
|
|
36584
|
+
#
|
|
36585
|
+
# @!attribute [rw] sort_by
|
|
36586
|
+
# The field to sort results by.
|
|
36587
|
+
# @return [String]
|
|
36588
|
+
#
|
|
36589
|
+
# @!attribute [rw] sort_order
|
|
36590
|
+
# The sort order for results. Valid values are `Ascending` and
|
|
36591
|
+
# `Descending`.
|
|
36592
|
+
# @return [String]
|
|
36593
|
+
#
|
|
36594
|
+
# @!attribute [rw] status_equals
|
|
36595
|
+
# A filter that returns only jobs with the specified status.
|
|
36596
|
+
# @return [String]
|
|
36597
|
+
#
|
|
36598
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/ListJobsRequest AWS API Documentation
|
|
36599
|
+
#
|
|
36600
|
+
class ListJobsRequest < Struct.new(
|
|
36601
|
+
:job_category,
|
|
36602
|
+
:next_token,
|
|
36603
|
+
:max_results,
|
|
36604
|
+
:creation_time_after,
|
|
36605
|
+
:creation_time_before,
|
|
36606
|
+
:last_modified_time_after,
|
|
36607
|
+
:last_modified_time_before,
|
|
36608
|
+
:name_contains,
|
|
36609
|
+
:sort_by,
|
|
36610
|
+
:sort_order,
|
|
36611
|
+
:status_equals)
|
|
36612
|
+
SENSITIVE = []
|
|
36613
|
+
include Aws::Structure
|
|
36614
|
+
end
|
|
36615
|
+
|
|
36616
|
+
# @!attribute [rw] next_token
|
|
36617
|
+
# If the response is truncated, this token retrieves the next set of
|
|
36618
|
+
# results.
|
|
36619
|
+
# @return [String]
|
|
36620
|
+
#
|
|
36621
|
+
# @!attribute [rw] job_summaries
|
|
36622
|
+
# An array of `JobSummary` objects that provide summary information
|
|
36623
|
+
# about the jobs.
|
|
36624
|
+
# @return [Array<Types::JobSummary>]
|
|
36625
|
+
#
|
|
36626
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/ListJobsResponse AWS API Documentation
|
|
36627
|
+
#
|
|
36628
|
+
class ListJobsResponse < Struct.new(
|
|
36629
|
+
:next_token,
|
|
36630
|
+
:job_summaries)
|
|
36631
|
+
SENSITIVE = []
|
|
36632
|
+
include Aws::Structure
|
|
36633
|
+
end
|
|
36634
|
+
|
|
35994
36635
|
# @!attribute [rw] workteam_arn
|
|
35995
36636
|
# The Amazon Resource Name (ARN) of the work team for which you want
|
|
35996
36637
|
# to see labeling jobs for.
|
|
@@ -44757,6 +45398,10 @@ module Aws::SageMaker
|
|
|
44757
45398
|
# The metadata of the lineage used in pipeline execution step.
|
|
44758
45399
|
# @return [Types::LineageMetadata]
|
|
44759
45400
|
#
|
|
45401
|
+
# @!attribute [rw] job
|
|
45402
|
+
# The metadata for a SageMaker job used in a pipeline execution step.
|
|
45403
|
+
# @return [Types::JobStepMetadata]
|
|
45404
|
+
#
|
|
44760
45405
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/PipelineExecutionStepMetadata AWS API Documentation
|
|
44761
45406
|
#
|
|
44762
45407
|
class PipelineExecutionStepMetadata < Struct.new(
|
|
@@ -44781,7 +45426,8 @@ module Aws::SageMaker
|
|
|
44781
45426
|
:bedrock_provisioned_model_throughput,
|
|
44782
45427
|
:bedrock_model_import,
|
|
44783
45428
|
:inference_component,
|
|
44784
|
-
:lineage
|
|
45429
|
+
:lineage,
|
|
45430
|
+
:job)
|
|
44785
45431
|
SENSITIVE = []
|
|
44786
45432
|
include Aws::Structure
|
|
44787
45433
|
end
|
|
@@ -49416,6 +50062,11 @@ module Aws::SageMaker
|
|
|
49416
50062
|
# A model displayed in the Amazon SageMaker Model Dashboard.
|
|
49417
50063
|
# @return [Types::ModelDashboardModel]
|
|
49418
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
|
+
#
|
|
49419
50070
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/SearchRecord AWS API Documentation
|
|
49420
50071
|
#
|
|
49421
50072
|
class SearchRecord < Struct.new(
|
|
@@ -49434,7 +50085,8 @@ module Aws::SageMaker
|
|
|
49434
50085
|
:project,
|
|
49435
50086
|
:hyper_parameter_tuning_job,
|
|
49436
50087
|
:model_card,
|
|
49437
|
-
:model
|
|
50088
|
+
:model,
|
|
50089
|
+
:job)
|
|
49438
50090
|
SENSITIVE = []
|
|
49439
50091
|
include Aws::Structure
|
|
49440
50092
|
end
|
|
@@ -51026,6 +51678,27 @@ module Aws::SageMaker
|
|
|
51026
51678
|
include Aws::Structure
|
|
51027
51679
|
end
|
|
51028
51680
|
|
|
51681
|
+
# @!attribute [rw] job_name
|
|
51682
|
+
# The name of the job to stop.
|
|
51683
|
+
# @return [String]
|
|
51684
|
+
#
|
|
51685
|
+
# @!attribute [rw] job_category
|
|
51686
|
+
# The category of the job to stop.
|
|
51687
|
+
# @return [String]
|
|
51688
|
+
#
|
|
51689
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/StopJobRequest AWS API Documentation
|
|
51690
|
+
#
|
|
51691
|
+
class StopJobRequest < Struct.new(
|
|
51692
|
+
:job_name,
|
|
51693
|
+
:job_category)
|
|
51694
|
+
SENSITIVE = []
|
|
51695
|
+
include Aws::Structure
|
|
51696
|
+
end
|
|
51697
|
+
|
|
51698
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/StopJobResponse AWS API Documentation
|
|
51699
|
+
#
|
|
51700
|
+
class StopJobResponse < Aws::EmptyStructure; end
|
|
51701
|
+
|
|
51029
51702
|
# @!attribute [rw] labeling_job_name
|
|
51030
51703
|
# The name of the labeling job to stop.
|
|
51031
51704
|
# @return [String]
|