@pgarbe/cdk-ecr-sync 0.5.27 → 0.5.30
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.
- package/.jsii +5 -5
- package/.projenrc.ts +5 -0
- package/API.md +106 -50
- package/CHANGELOG.md +1 -1
- package/lib/ecr-sync.d.ts +1 -0
- package/lib/ecr-sync.d.ts.map +1 -0
- package/lib/ecr-sync.js +1 -1
- package/lib/image.d.ts +1 -0
- package/lib/image.d.ts.map +1 -0
- package/lib/index.d.ts +1 -0
- package/lib/index.d.ts.map +1 -0
- package/lib/lambda/docker-adapter.d.ts +1 -0
- package/lib/lambda/docker-adapter.d.ts.map +1 -0
- package/lib/lambda/ecr-adapter.d.ts +1 -0
- package/lib/lambda/ecr-adapter.d.ts.map +1 -0
- package/lib/lambda/get-image-tags-handler.d.ts +1 -0
- package/lib/lambda/get-image-tags-handler.d.ts.map +1 -0
- package/node_modules/aws-sdk/CHANGELOG.md +153 -1
- package/node_modules/aws-sdk/README.md +1 -1
- package/node_modules/aws-sdk/apis/appflow-2020-08-23.min.json +76 -70
- package/node_modules/aws-sdk/apis/appmesh-2019-01-25.min.json +129 -121
- package/node_modules/aws-sdk/apis/backup-2018-11-15.min.json +30 -0
- package/node_modules/aws-sdk/apis/backup-2018-11-15.paginators.json +22 -11
- package/node_modules/aws-sdk/apis/braket-2019-09-01.min.json +30 -27
- package/node_modules/aws-sdk/apis/chime-sdk-media-pipelines-2021-07-15.examples.json +5 -0
- package/node_modules/aws-sdk/apis/chime-sdk-media-pipelines-2021-07-15.min.json +330 -0
- package/node_modules/aws-sdk/apis/chime-sdk-media-pipelines-2021-07-15.paginators.json +9 -0
- package/node_modules/aws-sdk/apis/cloudcontrol-2021-09-30.paginators.json +4 -2
- package/node_modules/aws-sdk/apis/cloudcontrol-2021-09-30.waiters2.json +23 -27
- package/node_modules/aws-sdk/apis/cloudformation-2010-05-15.min.json +10 -8
- package/node_modules/aws-sdk/apis/cloudfront-2020-05-31.min.json +42 -28
- package/node_modules/aws-sdk/apis/cloudtrail-2013-11-01.min.json +19 -2
- package/node_modules/aws-sdk/apis/codeguru-reviewer-2019-09-19.min.json +15 -8
- package/node_modules/aws-sdk/apis/cognito-idp-2016-04-18.min.json +155 -127
- package/node_modules/aws-sdk/apis/connect-2017-08-08.min.json +162 -9
- package/node_modules/aws-sdk/apis/connect-2017-08-08.paginators.json +9 -0
- package/node_modules/aws-sdk/apis/datasync-2018-11-09.min.json +82 -75
- package/node_modules/aws-sdk/apis/datasync-2018-11-09.paginators.json +10 -5
- package/node_modules/aws-sdk/apis/discovery-2015-11-01.min.json +67 -32
- package/node_modules/aws-sdk/apis/drs-2020-02-26.min.json +332 -205
- package/node_modules/aws-sdk/apis/drs-2020-02-26.paginators.json +12 -0
- package/node_modules/aws-sdk/apis/ec2-2016-11-15.min.json +988 -853
- package/node_modules/aws-sdk/apis/ec2-2016-11-15.waiters2.json +18 -0
- package/node_modules/aws-sdk/apis/elasticache-2015-02-02.min.json +3 -0
- package/node_modules/aws-sdk/apis/elasticmapreduce-2009-03-31.min.json +47 -35
- package/node_modules/aws-sdk/apis/emr-serverless-2021-07-13.examples.json +5 -0
- package/node_modules/aws-sdk/apis/emr-serverless-2021-07-13.min.json +860 -0
- package/node_modules/aws-sdk/apis/emr-serverless-2021-07-13.paginators.json +16 -0
- package/node_modules/aws-sdk/apis/evidently-2021-02-01.min.json +1 -0
- package/node_modules/aws-sdk/apis/forecast-2018-06-26.min.json +316 -61
- package/node_modules/aws-sdk/apis/forecast-2018-06-26.paginators.json +24 -0
- package/node_modules/aws-sdk/apis/fsx-2018-03-01.min.json +135 -116
- package/node_modules/aws-sdk/apis/gamesparks-2021-08-17.min.json +13 -0
- package/node_modules/aws-sdk/apis/glue-2017-03-31.min.json +1858 -495
- package/node_modules/aws-sdk/apis/grafana-2020-08-18.min.json +92 -15
- package/node_modules/aws-sdk/apis/greengrassv2-2020-11-30.min.json +37 -18
- package/node_modules/aws-sdk/apis/iot-2015-05-28.min.json +74 -68
- package/node_modules/aws-sdk/apis/iotevents-data-2018-10-23.min.json +45 -0
- package/node_modules/aws-sdk/apis/iotsecuretunneling-2018-10-05.min.json +28 -0
- package/node_modules/aws-sdk/apis/iotsitewise-2019-12-02.min.json +20 -15
- package/node_modules/aws-sdk/apis/iotwireless-2020-11-22.min.json +401 -80
- package/node_modules/aws-sdk/apis/iotwireless-2020-11-22.paginators.json +5 -0
- package/node_modules/aws-sdk/apis/ivschat-2020-07-14.examples.json +5 -0
- package/node_modules/aws-sdk/apis/ivschat-2020-07-14.min.json +443 -0
- package/node_modules/aws-sdk/apis/ivschat-2020-07-14.paginators.json +9 -0
- package/node_modules/aws-sdk/apis/kendra-2019-02-03.min.json +153 -84
- package/node_modules/aws-sdk/apis/kendra-2019-02-03.paginators.json +20 -0
- package/node_modules/aws-sdk/apis/kinesis-video-archived-media-2017-09-30.min.json +64 -0
- package/node_modules/aws-sdk/apis/kinesis-video-archived-media-2017-09-30.paginators.json +6 -0
- package/node_modules/aws-sdk/apis/kinesisvideo-2017-09-30.min.json +145 -8
- package/node_modules/aws-sdk/apis/lightsail-2016-11-28.min.json +199 -125
- package/node_modules/aws-sdk/apis/location-2020-11-19.min.json +17 -12
- package/node_modules/aws-sdk/apis/location-2020-11-19.paginators.json +1 -0
- package/node_modules/aws-sdk/apis/lookoutequipment-2020-12-15.min.json +274 -12
- package/node_modules/aws-sdk/apis/lookoutequipment-2020-12-15.paginators.json +5 -0
- package/node_modules/aws-sdk/apis/lookoutmetrics-2017-07-25.min.json +84 -55
- package/node_modules/aws-sdk/apis/mediaconvert-2017-08-29.min.json +213 -120
- package/node_modules/aws-sdk/apis/metadata.json +11 -0
- package/node_modules/aws-sdk/apis/mq-2017-11-27.min.json +22 -7
- package/node_modules/aws-sdk/apis/network-firewall-2020-11-12.min.json +139 -53
- package/node_modules/aws-sdk/apis/networkmanager-2019-07-05.min.json +72 -3
- package/node_modules/aws-sdk/apis/outposts-2019-12-03.min.json +56 -0
- package/node_modules/aws-sdk/apis/outposts-2019-12-03.paginators.json +10 -0
- package/node_modules/aws-sdk/apis/personalize-2018-05-22.min.json +14 -8
- package/node_modules/aws-sdk/apis/quicksight-2018-04-01.min.json +35 -1
- package/node_modules/aws-sdk/apis/rds-2014-10-31.min.json +20 -7
- package/node_modules/aws-sdk/apis/rds-data-2018-08-01.min.json +4 -1
- package/node_modules/aws-sdk/apis/redshift-2012-12-01.min.json +2 -1
- package/node_modules/aws-sdk/apis/rekognition-2016-06-27.min.json +247 -111
- package/node_modules/aws-sdk/apis/resiliencehub-2020-04-30.min.json +125 -74
- package/node_modules/aws-sdk/apis/s3-2006-03-01.examples.json +124 -124
- package/node_modules/aws-sdk/apis/sagemaker-2017-07-24.min.json +749 -692
- package/node_modules/aws-sdk/apis/secretsmanager-2017-10-17.examples.json +3 -3
- package/node_modules/aws-sdk/apis/securityhub-2018-10-26.min.json +20 -18
- package/node_modules/aws-sdk/apis/ssm-2014-11-06.min.json +160 -139
- package/node_modules/aws-sdk/apis/ssm-contacts-2021-05-03.examples.json +1 -1
- package/node_modules/aws-sdk/apis/ssm-incidents-2018-05-10.min.json +48 -37
- package/node_modules/aws-sdk/apis/synthetics-2017-10-11.min.json +8 -3
- package/node_modules/aws-sdk/apis/transcribe-2017-10-26.min.json +37 -11
- package/node_modules/aws-sdk/apis/transfer-2018-11-05.min.json +37 -36
- package/node_modules/aws-sdk/apis/voice-id-2021-09-27.min.json +6 -0
- package/node_modules/aws-sdk/apis/voice-id-2021-09-27.paginators.json +8 -4
- package/node_modules/aws-sdk/apis/wafv2-2019-07-29.min.json +196 -130
- package/node_modules/aws-sdk/apis/workspaces-web-2020-07-08.min.json +107 -36
- package/node_modules/aws-sdk/clients/all.d.ts +3 -0
- package/node_modules/aws-sdk/clients/all.js +4 -1
- package/node_modules/aws-sdk/clients/amplify.d.ts +5 -5
- package/node_modules/aws-sdk/clients/apigateway.d.ts +327 -324
- package/node_modules/aws-sdk/clients/appflow.d.ts +17 -7
- package/node_modules/aws-sdk/clients/appmesh.d.ts +70 -51
- package/node_modules/aws-sdk/clients/apprunner.d.ts +2 -2
- package/node_modules/aws-sdk/clients/auditmanager.d.ts +4 -4
- package/node_modules/aws-sdk/clients/backup.d.ts +25 -1
- package/node_modules/aws-sdk/clients/batch.d.ts +4 -4
- package/node_modules/aws-sdk/clients/braket.d.ts +7 -2
- package/node_modules/aws-sdk/clients/chimesdkmediapipelines.d.ts +348 -0
- package/node_modules/aws-sdk/clients/chimesdkmediapipelines.js +18 -0
- package/node_modules/aws-sdk/clients/cloudcontrol.d.ts +3 -3
- package/node_modules/aws-sdk/clients/cloudformation.d.ts +62 -53
- package/node_modules/aws-sdk/clients/cloudfront.d.ts +15 -0
- package/node_modules/aws-sdk/clients/cloudtrail.d.ts +17 -17
- package/node_modules/aws-sdk/clients/cloudwatchlogs.d.ts +4 -4
- package/node_modules/aws-sdk/clients/codegurureviewer.d.ts +18 -5
- package/node_modules/aws-sdk/clients/cognitoidentityserviceprovider.d.ts +197 -162
- package/node_modules/aws-sdk/clients/comprehend.d.ts +22 -22
- package/node_modules/aws-sdk/clients/computeoptimizer.d.ts +3 -3
- package/node_modules/aws-sdk/clients/connect.d.ts +200 -9
- package/node_modules/aws-sdk/clients/datasync.d.ts +48 -17
- package/node_modules/aws-sdk/clients/discovery.d.ts +63 -26
- package/node_modules/aws-sdk/clients/drs.d.ts +173 -6
- package/node_modules/aws-sdk/clients/ec2.d.ts +236 -56
- package/node_modules/aws-sdk/clients/eks.d.ts +13 -13
- package/node_modules/aws-sdk/clients/elasticache.d.ts +12 -8
- package/node_modules/aws-sdk/clients/emr.d.ts +24 -0
- package/node_modules/aws-sdk/clients/emrserverless.d.ts +890 -0
- package/node_modules/aws-sdk/clients/emrserverless.js +18 -0
- package/node_modules/aws-sdk/clients/eventbridge.js +1 -0
- package/node_modules/aws-sdk/clients/evidently.d.ts +8 -4
- package/node_modules/aws-sdk/clients/forecastservice.d.ts +391 -18
- package/node_modules/aws-sdk/clients/fsx.d.ts +28 -3
- package/node_modules/aws-sdk/clients/gamelift.d.ts +67 -67
- package/node_modules/aws-sdk/clients/gamesparks.d.ts +20 -0
- package/node_modules/aws-sdk/clients/glue.d.ts +2082 -217
- package/node_modules/aws-sdk/clients/grafana.d.ts +72 -1
- package/node_modules/aws-sdk/clients/greengrassv2.d.ts +49 -18
- package/node_modules/aws-sdk/clients/guardduty.d.ts +6 -3
- package/node_modules/aws-sdk/clients/iot.d.ts +12 -9
- package/node_modules/aws-sdk/clients/ioteventsdata.d.ts +50 -0
- package/node_modules/aws-sdk/clients/iotsecuretunneling.d.ts +52 -18
- package/node_modules/aws-sdk/clients/iotsitewise.d.ts +23 -3
- package/node_modules/aws-sdk/clients/iotwireless.d.ts +356 -25
- package/node_modules/aws-sdk/clients/ivschat.d.ts +523 -0
- package/node_modules/aws-sdk/clients/ivschat.js +18 -0
- package/node_modules/aws-sdk/clients/kendra.d.ts +99 -14
- package/node_modules/aws-sdk/clients/kinesisvideo.d.ts +177 -10
- package/node_modules/aws-sdk/clients/kinesisvideoarchivedmedia.d.ts +94 -0
- package/node_modules/aws-sdk/clients/kms.d.ts +22 -22
- package/node_modules/aws-sdk/clients/lambda.d.ts +4 -4
- package/node_modules/aws-sdk/clients/lightsail.d.ts +162 -47
- package/node_modules/aws-sdk/clients/location.d.ts +20 -16
- package/node_modules/aws-sdk/clients/lookoutequipment.d.ts +295 -9
- package/node_modules/aws-sdk/clients/lookoutmetrics.d.ts +58 -4
- package/node_modules/aws-sdk/clients/mediaconvert.d.ts +104 -8
- package/node_modules/aws-sdk/clients/mediapackage.d.ts +4 -4
- package/node_modules/aws-sdk/clients/mq.d.ts +16 -1
- package/node_modules/aws-sdk/clients/networkfirewall.d.ts +151 -21
- package/node_modules/aws-sdk/clients/networkmanager.d.ts +56 -10
- package/node_modules/aws-sdk/clients/organizations.d.ts +5 -5
- package/node_modules/aws-sdk/clients/outposts.d.ts +79 -22
- package/node_modules/aws-sdk/clients/personalize.d.ts +12 -8
- package/node_modules/aws-sdk/clients/pricing.d.ts +3 -3
- package/node_modules/aws-sdk/clients/quicksight.d.ts +37 -5
- package/node_modules/aws-sdk/clients/rds.d.ts +37 -1
- package/node_modules/aws-sdk/clients/rdsdataservice.d.ts +22 -7
- package/node_modules/aws-sdk/clients/redshift.d.ts +16 -12
- package/node_modules/aws-sdk/clients/rekognition.d.ts +209 -53
- package/node_modules/aws-sdk/clients/resiliencehub.d.ts +138 -58
- package/node_modules/aws-sdk/clients/s3.d.ts +8 -8
- package/node_modules/aws-sdk/clients/sagemaker.d.ts +273 -194
- package/node_modules/aws-sdk/clients/secretsmanager.d.ts +9 -9
- package/node_modules/aws-sdk/clients/securityhub.d.ts +15 -6
- package/node_modules/aws-sdk/clients/servicecatalog.d.ts +4 -4
- package/node_modules/aws-sdk/clients/ssm.d.ts +29 -1
- package/node_modules/aws-sdk/clients/ssmcontacts.d.ts +2 -2
- package/node_modules/aws-sdk/clients/ssmincidents.d.ts +19 -6
- package/node_modules/aws-sdk/clients/sts.d.ts +2 -2
- package/node_modules/aws-sdk/clients/synthetics.d.ts +7 -3
- package/node_modules/aws-sdk/clients/transcribeservice.d.ts +479 -447
- package/node_modules/aws-sdk/clients/transfer.d.ts +7 -2
- package/node_modules/aws-sdk/clients/voiceid.d.ts +9 -1
- package/node_modules/aws-sdk/clients/wafv2.d.ts +104 -27
- package/node_modules/aws-sdk/clients/workspacesweb.d.ts +38 -4
- package/node_modules/aws-sdk/dist/aws-sdk-core-react-native.js +702 -233
- package/node_modules/aws-sdk/dist/aws-sdk-react-native.js +2644 -1816
- package/node_modules/aws-sdk/dist/aws-sdk.js +3131 -1600
- package/node_modules/aws-sdk/dist/aws-sdk.min.js +90 -89
- package/node_modules/aws-sdk/lib/config_service_placeholders.d.ts +6 -0
- package/node_modules/aws-sdk/lib/core.js +1 -1
- package/node_modules/aws-sdk/lib/services/eventbridge.js +19 -0
- package/node_modules/aws-sdk/lib/services/s3util.js +6 -1
- package/node_modules/aws-sdk/package.json +2 -2
- package/node_modules/jszip/.github/workflows/pr.yaml +5 -6
- package/node_modules/jszip/CHANGES.md +5 -0
- package/node_modules/jszip/README.markdown +1 -3
- package/node_modules/jszip/dist/jszip.js +194 -13
- package/node_modules/jszip/dist/jszip.min.js +4 -4
- package/node_modules/jszip/index.d.ts +1 -1
- package/node_modules/jszip/lib/index.js +1 -1
- package/node_modules/jszip/lib/license_header.js +2 -2
- package/node_modules/jszip/lib/utils.js +1 -1
- package/node_modules/jszip/package.json +2 -2
- package/node_modules/jszip/vendor/FileSaver.js +1 -1
- package/node_modules/setimmediate/LICENSE.txt +20 -0
- package/node_modules/setimmediate/package.json +30 -0
- package/node_modules/setimmediate/setImmediate.js +186 -0
- package/node_modules/uuid/CHANGELOG.md +132 -44
- package/node_modules/uuid/CONTRIBUTING.md +20 -0
- package/node_modules/uuid/LICENSE.md +1 -1
- package/node_modules/uuid/README.md +298 -152
- package/node_modules/uuid/dist/bin/uuid +2 -0
- package/node_modules/uuid/dist/bytesToUuid.js +26 -0
- package/node_modules/uuid/dist/esm-browser/bytesToUuid.js +18 -0
- package/node_modules/uuid/dist/esm-browser/index.js +4 -0
- package/node_modules/uuid/dist/esm-browser/md5.js +218 -0
- package/node_modules/uuid/dist/esm-browser/rng.js +15 -0
- package/node_modules/uuid/dist/esm-browser/sha1.js +91 -0
- package/node_modules/uuid/{v1.js → dist/esm-browser/v1.js} +34 -48
- package/node_modules/uuid/dist/esm-browser/v3.js +4 -0
- package/node_modules/uuid/dist/esm-browser/v35.js +56 -0
- package/node_modules/uuid/dist/esm-browser/v4.js +27 -0
- package/node_modules/uuid/dist/esm-browser/v5.js +4 -0
- package/node_modules/uuid/dist/esm-node/bytesToUuid.js +18 -0
- package/node_modules/uuid/dist/esm-node/index.js +4 -0
- package/node_modules/uuid/dist/esm-node/md5.js +13 -0
- package/node_modules/uuid/dist/esm-node/rng.js +4 -0
- package/node_modules/uuid/dist/esm-node/sha1.js +13 -0
- package/node_modules/uuid/dist/esm-node/v1.js +95 -0
- package/node_modules/uuid/dist/esm-node/v3.js +4 -0
- package/node_modules/uuid/{lib → dist/esm-node}/v35.js +21 -22
- package/node_modules/uuid/dist/esm-node/v4.js +27 -0
- package/node_modules/uuid/dist/esm-node/v5.js +4 -0
- package/node_modules/uuid/dist/index.js +39 -0
- package/node_modules/uuid/{lib → dist}/md5-browser.js +58 -50
- package/node_modules/uuid/dist/md5.js +23 -0
- package/node_modules/uuid/dist/rng-browser.js +21 -0
- package/node_modules/uuid/dist/rng.js +14 -0
- package/node_modules/uuid/dist/sha1-browser.js +95 -0
- package/node_modules/uuid/dist/sha1.js +23 -0
- package/node_modules/uuid/dist/umd/uuid.min.js +1 -0
- package/node_modules/uuid/dist/umd/uuidv1.min.js +1 -0
- package/node_modules/uuid/dist/umd/uuidv3.min.js +1 -0
- package/node_modules/uuid/dist/umd/uuidv4.min.js +1 -0
- package/node_modules/uuid/dist/umd/uuidv5.min.js +1 -0
- package/node_modules/uuid/dist/uuid-bin.js +67 -0
- package/node_modules/uuid/dist/v1.js +107 -0
- package/node_modules/uuid/dist/v3.js +16 -0
- package/node_modules/uuid/dist/v35.js +69 -0
- package/node_modules/uuid/dist/v4.js +40 -0
- package/node_modules/uuid/dist/v5.js +16 -0
- package/node_modules/uuid/package.json +92 -19
- package/node_modules/uuid/wrapper.mjs +5 -0
- package/package.json +17 -14
- package/releasetag.txt +1 -1
- package/version.txt +1 -1
- package/node_modules/set-immediate-shim/index.js +0 -7
- package/node_modules/set-immediate-shim/package.json +0 -34
- package/node_modules/set-immediate-shim/readme.md +0 -31
- package/node_modules/uuid/.eslintrc.json +0 -47
- package/node_modules/uuid/AUTHORS +0 -5
- package/node_modules/uuid/README_js.md +0 -280
- package/node_modules/uuid/bin/uuid +0 -65
- package/node_modules/uuid/index.js +0 -8
- package/node_modules/uuid/lib/bytesToUuid.js +0 -24
- package/node_modules/uuid/lib/md5.js +0 -25
- package/node_modules/uuid/lib/rng-browser.js +0 -34
- package/node_modules/uuid/lib/rng.js +0 -8
- package/node_modules/uuid/lib/sha1-browser.js +0 -89
- package/node_modules/uuid/lib/sha1.js +0 -25
- package/node_modules/uuid/v3.js +0 -4
- package/node_modules/uuid/v4.js +0 -29
- package/node_modules/uuid/v5.js +0 -3
|
@@ -21,11 +21,11 @@ declare class SageMaker extends Service {
|
|
|
21
21
|
*/
|
|
22
22
|
addAssociation(callback?: (err: AWSError, data: SageMaker.Types.AddAssociationResponse) => void): Request<SageMaker.Types.AddAssociationResponse, AWSError>;
|
|
23
23
|
/**
|
|
24
|
-
* Adds or overwrites one or more tags for the specified
|
|
24
|
+
* Adds or overwrites one or more tags for the specified SageMaker resource. You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints. Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see For more information, see Amazon Web Services Tagging Strategies. Tags that you add to a hyperparameter tuning job by calling this API are also added to any training jobs that the hyperparameter tuning job launches after you call this API, but not to training jobs that the hyperparameter tuning job launched before you called this API. To make sure that the tags associated with a hyperparameter tuning job are also added to all training jobs that the hyperparameter tuning job launches, add the tags when you first create the tuning job by specifying them in the Tags parameter of CreateHyperParameterTuningJob Tags that you add to a SageMaker Studio Domain or User Profile by calling this API are also added to any Apps that the Domain or User Profile launches after you call this API, but not to Apps that the Domain or User Profile launched before you called this API. To make sure that the tags associated with a Domain or User Profile are also added to all Apps that the Domain or User Profile launches, add the tags when you first create the Domain or User Profile by specifying them in the Tags parameter of CreateDomain or CreateUserProfile.
|
|
25
25
|
*/
|
|
26
26
|
addTags(params: SageMaker.Types.AddTagsInput, callback?: (err: AWSError, data: SageMaker.Types.AddTagsOutput) => void): Request<SageMaker.Types.AddTagsOutput, AWSError>;
|
|
27
27
|
/**
|
|
28
|
-
* Adds or overwrites one or more tags for the specified
|
|
28
|
+
* Adds or overwrites one or more tags for the specified SageMaker resource. You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints. Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see For more information, see Amazon Web Services Tagging Strategies. Tags that you add to a hyperparameter tuning job by calling this API are also added to any training jobs that the hyperparameter tuning job launches after you call this API, but not to training jobs that the hyperparameter tuning job launched before you called this API. To make sure that the tags associated with a hyperparameter tuning job are also added to all training jobs that the hyperparameter tuning job launches, add the tags when you first create the tuning job by specifying them in the Tags parameter of CreateHyperParameterTuningJob Tags that you add to a SageMaker Studio Domain or User Profile by calling this API are also added to any Apps that the Domain or User Profile launches after you call this API, but not to Apps that the Domain or User Profile launched before you called this API. To make sure that the tags associated with a Domain or User Profile are also added to all Apps that the Domain or User Profile launches, add the tags when you first create the Domain or User Profile by specifying them in the Tags parameter of CreateDomain or CreateUserProfile.
|
|
29
29
|
*/
|
|
30
30
|
addTags(callback?: (err: AWSError, data: SageMaker.Types.AddTagsOutput) => void): Request<SageMaker.Types.AddTagsOutput, AWSError>;
|
|
31
31
|
/**
|
|
@@ -53,11 +53,11 @@ declare class SageMaker extends Service {
|
|
|
53
53
|
*/
|
|
54
54
|
createAction(callback?: (err: AWSError, data: SageMaker.Types.CreateActionResponse) => void): Request<SageMaker.Types.CreateActionResponse, AWSError>;
|
|
55
55
|
/**
|
|
56
|
-
* Create a machine learning algorithm that you can use in
|
|
56
|
+
* Create a machine learning algorithm that you can use in SageMaker and list in the Amazon Web Services Marketplace.
|
|
57
57
|
*/
|
|
58
58
|
createAlgorithm(params: SageMaker.Types.CreateAlgorithmInput, callback?: (err: AWSError, data: SageMaker.Types.CreateAlgorithmOutput) => void): Request<SageMaker.Types.CreateAlgorithmOutput, AWSError>;
|
|
59
59
|
/**
|
|
60
|
-
* Create a machine learning algorithm that you can use in
|
|
60
|
+
* Create a machine learning algorithm that you can use in SageMaker and list in the Amazon Web Services Marketplace.
|
|
61
61
|
*/
|
|
62
62
|
createAlgorithm(callback?: (err: AWSError, data: SageMaker.Types.CreateAlgorithmOutput) => void): Request<SageMaker.Types.CreateAlgorithmOutput, AWSError>;
|
|
63
63
|
/**
|
|
@@ -93,11 +93,11 @@ declare class SageMaker extends Service {
|
|
|
93
93
|
*/
|
|
94
94
|
createAutoMLJob(callback?: (err: AWSError, data: SageMaker.Types.CreateAutoMLJobResponse) => void): Request<SageMaker.Types.CreateAutoMLJobResponse, AWSError>;
|
|
95
95
|
/**
|
|
96
|
-
* Creates a Git repository as a resource in your
|
|
96
|
+
* Creates a Git repository as a resource in your SageMaker account. You can associate the repository with notebook instances so that you can use Git source control for the notebooks you create. The Git repository is a resource in your SageMaker account, so it can be associated with more than one notebook instance, and it persists independently from the lifecycle of any notebook instances it is associated with. The repository can be hosted either in Amazon Web Services CodeCommit or in any other Git repository.
|
|
97
97
|
*/
|
|
98
98
|
createCodeRepository(params: SageMaker.Types.CreateCodeRepositoryInput, callback?: (err: AWSError, data: SageMaker.Types.CreateCodeRepositoryOutput) => void): Request<SageMaker.Types.CreateCodeRepositoryOutput, AWSError>;
|
|
99
99
|
/**
|
|
100
|
-
* Creates a Git repository as a resource in your
|
|
100
|
+
* Creates a Git repository as a resource in your SageMaker account. You can associate the repository with notebook instances so that you can use Git source control for the notebooks you create. The Git repository is a resource in your SageMaker account, so it can be associated with more than one notebook instance, and it persists independently from the lifecycle of any notebook instances it is associated with. The repository can be hosted either in Amazon Web Services CodeCommit or in any other Git repository.
|
|
101
101
|
*/
|
|
102
102
|
createCodeRepository(callback?: (err: AWSError, data: SageMaker.Types.CreateCodeRepositoryOutput) => void): Request<SageMaker.Types.CreateCodeRepositoryOutput, AWSError>;
|
|
103
103
|
/**
|
|
@@ -149,19 +149,19 @@ declare class SageMaker extends Service {
|
|
|
149
149
|
*/
|
|
150
150
|
createEdgePackagingJob(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
151
151
|
/**
|
|
152
|
-
* Creates an endpoint using the endpoint configuration specified in the request.
|
|
152
|
+
* Creates an endpoint using the endpoint configuration specified in the request. SageMaker uses the endpoint to provision resources and deploy models. You create the endpoint configuration with the CreateEndpointConfig API. Use this API to deploy models using SageMaker hosting services. For an example that calls this method when deploying a model to SageMaker hosting services, see the Create Endpoint example notebook. You must not delete an EndpointConfig that is in use by an endpoint that is live or while the UpdateEndpoint or CreateEndpoint operations are being performed on the endpoint. To update an endpoint, you must create a new EndpointConfig. The endpoint name must be unique within an Amazon Web Services Region in your Amazon Web Services account. When it receives the request, SageMaker creates the endpoint, launches the resources (ML compute instances), and deploys the model(s) on them. When you call CreateEndpoint, a load call is made to DynamoDB to verify that your endpoint configuration exists. When you read data from a DynamoDB table supporting Eventually Consistent Reads , the response might not reflect the results of a recently completed write operation. The response might include some stale data. If the dependent entities are not yet in DynamoDB, this causes a validation error. If you repeat your read request after a short time, the response should return the latest data. So retry logic is recommended to handle these possible issues. We also recommend that customers call DescribeEndpointConfig before calling CreateEndpoint to minimize the potential impact of a DynamoDB eventually consistent read. When SageMaker receives the request, it sets the endpoint status to Creating. After it creates the endpoint, it sets the status to InService. SageMaker can then process incoming requests for inferences. To check the status of an endpoint, use the DescribeEndpoint API. If any of the models hosted at this endpoint get model data from an Amazon S3 location, SageMaker uses Amazon Web Services Security Token Service to download model artifacts from the S3 path you provided. Amazon Web Services STS is activated in your IAM user account by default. If you previously deactivated Amazon Web Services STS for a region, you need to reactivate Amazon Web Services STS for that region. For more information, see Activating and Deactivating Amazon Web Services STS in an Amazon Web Services Region in the Amazon Web Services Identity and Access Management User Guide. To add the IAM role policies for using this API operation, go to the IAM console, and choose Roles in the left navigation pane. Search the IAM role that you want to grant access to use the CreateEndpoint and CreateEndpointConfig API operations, add the following policies to the role. Option 1: For a full SageMaker access, search and attach the AmazonSageMakerFullAccess policy. Option 2: For granting a limited access to an IAM role, paste the following Action elements manually into the JSON file of the IAM role: "Action": ["sagemaker:CreateEndpoint", "sagemaker:CreateEndpointConfig"] "Resource": [ "arn:aws:sagemaker:region:account-id:endpoint/endpointName" "arn:aws:sagemaker:region:account-id:endpoint-config/endpointConfigName" ] For more information, see SageMaker API Permissions: Actions, Permissions, and Resources Reference.
|
|
153
153
|
*/
|
|
154
154
|
createEndpoint(params: SageMaker.Types.CreateEndpointInput, callback?: (err: AWSError, data: SageMaker.Types.CreateEndpointOutput) => void): Request<SageMaker.Types.CreateEndpointOutput, AWSError>;
|
|
155
155
|
/**
|
|
156
|
-
* Creates an endpoint using the endpoint configuration specified in the request.
|
|
156
|
+
* Creates an endpoint using the endpoint configuration specified in the request. SageMaker uses the endpoint to provision resources and deploy models. You create the endpoint configuration with the CreateEndpointConfig API. Use this API to deploy models using SageMaker hosting services. For an example that calls this method when deploying a model to SageMaker hosting services, see the Create Endpoint example notebook. You must not delete an EndpointConfig that is in use by an endpoint that is live or while the UpdateEndpoint or CreateEndpoint operations are being performed on the endpoint. To update an endpoint, you must create a new EndpointConfig. The endpoint name must be unique within an Amazon Web Services Region in your Amazon Web Services account. When it receives the request, SageMaker creates the endpoint, launches the resources (ML compute instances), and deploys the model(s) on them. When you call CreateEndpoint, a load call is made to DynamoDB to verify that your endpoint configuration exists. When you read data from a DynamoDB table supporting Eventually Consistent Reads , the response might not reflect the results of a recently completed write operation. The response might include some stale data. If the dependent entities are not yet in DynamoDB, this causes a validation error. If you repeat your read request after a short time, the response should return the latest data. So retry logic is recommended to handle these possible issues. We also recommend that customers call DescribeEndpointConfig before calling CreateEndpoint to minimize the potential impact of a DynamoDB eventually consistent read. When SageMaker receives the request, it sets the endpoint status to Creating. After it creates the endpoint, it sets the status to InService. SageMaker can then process incoming requests for inferences. To check the status of an endpoint, use the DescribeEndpoint API. If any of the models hosted at this endpoint get model data from an Amazon S3 location, SageMaker uses Amazon Web Services Security Token Service to download model artifacts from the S3 path you provided. Amazon Web Services STS is activated in your IAM user account by default. If you previously deactivated Amazon Web Services STS for a region, you need to reactivate Amazon Web Services STS for that region. For more information, see Activating and Deactivating Amazon Web Services STS in an Amazon Web Services Region in the Amazon Web Services Identity and Access Management User Guide. To add the IAM role policies for using this API operation, go to the IAM console, and choose Roles in the left navigation pane. Search the IAM role that you want to grant access to use the CreateEndpoint and CreateEndpointConfig API operations, add the following policies to the role. Option 1: For a full SageMaker access, search and attach the AmazonSageMakerFullAccess policy. Option 2: For granting a limited access to an IAM role, paste the following Action elements manually into the JSON file of the IAM role: "Action": ["sagemaker:CreateEndpoint", "sagemaker:CreateEndpointConfig"] "Resource": [ "arn:aws:sagemaker:region:account-id:endpoint/endpointName" "arn:aws:sagemaker:region:account-id:endpoint-config/endpointConfigName" ] For more information, see SageMaker API Permissions: Actions, Permissions, and Resources Reference.
|
|
157
157
|
*/
|
|
158
158
|
createEndpoint(callback?: (err: AWSError, data: SageMaker.Types.CreateEndpointOutput) => void): Request<SageMaker.Types.CreateEndpointOutput, AWSError>;
|
|
159
159
|
/**
|
|
160
|
-
* Creates an endpoint configuration that
|
|
160
|
+
* Creates an endpoint configuration that SageMaker hosting services uses to deploy models. In the configuration, you identify one or more models, created using the CreateModel API, to deploy and the resources that you want SageMaker to provision. Then you call the CreateEndpoint API. Use this API if you want to use SageMaker hosting services to deploy models into production. In the request, you define a ProductionVariant, for each model that you want to deploy. Each ProductionVariant parameter also describes the resources that you want SageMaker to provision. This includes the number and type of ML compute instances to deploy. If you are hosting multiple models, you also assign a VariantWeight to specify how much traffic you want to allocate to each model. For example, suppose that you want to host two models, A and B, and you assign traffic weight 2 for model A and 1 for model B. SageMaker distributes two-thirds of the traffic to Model A, and one-third to model B. When you call CreateEndpoint, a load call is made to DynamoDB to verify that your endpoint configuration exists. When you read data from a DynamoDB table supporting Eventually Consistent Reads , the response might not reflect the results of a recently completed write operation. The response might include some stale data. If the dependent entities are not yet in DynamoDB, this causes a validation error. If you repeat your read request after a short time, the response should return the latest data. So retry logic is recommended to handle these possible issues. We also recommend that customers call DescribeEndpointConfig before calling CreateEndpoint to minimize the potential impact of a DynamoDB eventually consistent read.
|
|
161
161
|
*/
|
|
162
162
|
createEndpointConfig(params: SageMaker.Types.CreateEndpointConfigInput, callback?: (err: AWSError, data: SageMaker.Types.CreateEndpointConfigOutput) => void): Request<SageMaker.Types.CreateEndpointConfigOutput, AWSError>;
|
|
163
163
|
/**
|
|
164
|
-
* Creates an endpoint configuration that
|
|
164
|
+
* Creates an endpoint configuration that SageMaker hosting services uses to deploy models. In the configuration, you identify one or more models, created using the CreateModel API, to deploy and the resources that you want SageMaker to provision. Then you call the CreateEndpoint API. Use this API if you want to use SageMaker hosting services to deploy models into production. In the request, you define a ProductionVariant, for each model that you want to deploy. Each ProductionVariant parameter also describes the resources that you want SageMaker to provision. This includes the number and type of ML compute instances to deploy. If you are hosting multiple models, you also assign a VariantWeight to specify how much traffic you want to allocate to each model. For example, suppose that you want to host two models, A and B, and you assign traffic weight 2 for model A and 1 for model B. SageMaker distributes two-thirds of the traffic to Model A, and one-third to model B. When you call CreateEndpoint, a load call is made to DynamoDB to verify that your endpoint configuration exists. When you read data from a DynamoDB table supporting Eventually Consistent Reads , the response might not reflect the results of a recently completed write operation. The response might include some stale data. If the dependent entities are not yet in DynamoDB, this causes a validation error. If you repeat your read request after a short time, the response should return the latest data. So retry logic is recommended to handle these possible issues. We also recommend that customers call DescribeEndpointConfig before calling CreateEndpoint to minimize the potential impact of a DynamoDB eventually consistent read.
|
|
165
165
|
*/
|
|
166
166
|
createEndpointConfig(callback?: (err: AWSError, data: SageMaker.Types.CreateEndpointConfigOutput) => void): Request<SageMaker.Types.CreateEndpointConfigOutput, AWSError>;
|
|
167
167
|
/**
|
|
@@ -205,19 +205,19 @@ declare class SageMaker extends Service {
|
|
|
205
205
|
*/
|
|
206
206
|
createHyperParameterTuningJob(callback?: (err: AWSError, data: SageMaker.Types.CreateHyperParameterTuningJobResponse) => void): Request<SageMaker.Types.CreateHyperParameterTuningJobResponse, AWSError>;
|
|
207
207
|
/**
|
|
208
|
-
* Creates a custom SageMaker image. A SageMaker image is a set of image versions. Each image version represents a container image stored in Amazon Container Registry (ECR). For more information, see Bring your own SageMaker image.
|
|
208
|
+
* Creates a custom SageMaker image. A SageMaker image is a set of image versions. Each image version represents a container image stored in Amazon Elastic Container Registry (ECR). For more information, see Bring your own SageMaker image.
|
|
209
209
|
*/
|
|
210
210
|
createImage(params: SageMaker.Types.CreateImageRequest, callback?: (err: AWSError, data: SageMaker.Types.CreateImageResponse) => void): Request<SageMaker.Types.CreateImageResponse, AWSError>;
|
|
211
211
|
/**
|
|
212
|
-
* Creates a custom SageMaker image. A SageMaker image is a set of image versions. Each image version represents a container image stored in Amazon Container Registry (ECR). For more information, see Bring your own SageMaker image.
|
|
212
|
+
* Creates a custom SageMaker image. A SageMaker image is a set of image versions. Each image version represents a container image stored in Amazon Elastic Container Registry (ECR). For more information, see Bring your own SageMaker image.
|
|
213
213
|
*/
|
|
214
214
|
createImage(callback?: (err: AWSError, data: SageMaker.Types.CreateImageResponse) => void): Request<SageMaker.Types.CreateImageResponse, AWSError>;
|
|
215
215
|
/**
|
|
216
|
-
* Creates a version of the SageMaker image specified by ImageName. The version represents the Amazon Container Registry (ECR) container image specified by BaseImage.
|
|
216
|
+
* Creates a version of the SageMaker image specified by ImageName. The version represents the Amazon Elastic Container Registry (ECR) container image specified by BaseImage.
|
|
217
217
|
*/
|
|
218
218
|
createImageVersion(params: SageMaker.Types.CreateImageVersionRequest, callback?: (err: AWSError, data: SageMaker.Types.CreateImageVersionResponse) => void): Request<SageMaker.Types.CreateImageVersionResponse, AWSError>;
|
|
219
219
|
/**
|
|
220
|
-
* Creates a version of the SageMaker image specified by ImageName. The version represents the Amazon Container Registry (ECR) container image specified by BaseImage.
|
|
220
|
+
* Creates a version of the SageMaker image specified by ImageName. The version represents the Amazon Elastic Container Registry (ECR) container image specified by BaseImage.
|
|
221
221
|
*/
|
|
222
222
|
createImageVersion(callback?: (err: AWSError, data: SageMaker.Types.CreateImageVersionResponse) => void): Request<SageMaker.Types.CreateImageVersionResponse, AWSError>;
|
|
223
223
|
/**
|
|
@@ -237,11 +237,11 @@ declare class SageMaker extends Service {
|
|
|
237
237
|
*/
|
|
238
238
|
createLabelingJob(callback?: (err: AWSError, data: SageMaker.Types.CreateLabelingJobResponse) => void): Request<SageMaker.Types.CreateLabelingJobResponse, AWSError>;
|
|
239
239
|
/**
|
|
240
|
-
* Creates a model in
|
|
240
|
+
* Creates a model in SageMaker. In the request, you name the model and describe a primary container. For the primary container, you specify the Docker image that contains inference code, artifacts (from prior training), and a custom environment map that the inference code uses when you deploy the model for predictions. Use this API to create a model if you want to use SageMaker hosting services or run a batch transform job. To host your model, you create an endpoint configuration with the CreateEndpointConfig API, and then create an endpoint with the CreateEndpoint API. SageMaker then deploys all of the containers that you defined for the model in the hosting environment. For an example that calls this method when deploying a model to SageMaker hosting services, see Deploy the Model to Amazon SageMaker Hosting Services (Amazon Web Services SDK for Python (Boto 3)). To run a batch transform using your model, you start a job with the CreateTransformJob API. SageMaker uses your model and your dataset to get inferences which are then saved to a specified S3 location. In the request, you also provide an IAM role that SageMaker can assume to access model artifacts and docker image for deployment on ML compute hosting instances or for batch transform jobs. In addition, you also use the IAM role to manage permissions the inference code needs. For example, if the inference code access any other Amazon Web Services resources, you grant necessary permissions via this role.
|
|
241
241
|
*/
|
|
242
242
|
createModel(params: SageMaker.Types.CreateModelInput, callback?: (err: AWSError, data: SageMaker.Types.CreateModelOutput) => void): Request<SageMaker.Types.CreateModelOutput, AWSError>;
|
|
243
243
|
/**
|
|
244
|
-
* Creates a model in
|
|
244
|
+
* Creates a model in SageMaker. In the request, you name the model and describe a primary container. For the primary container, you specify the Docker image that contains inference code, artifacts (from prior training), and a custom environment map that the inference code uses when you deploy the model for predictions. Use this API to create a model if you want to use SageMaker hosting services or run a batch transform job. To host your model, you create an endpoint configuration with the CreateEndpointConfig API, and then create an endpoint with the CreateEndpoint API. SageMaker then deploys all of the containers that you defined for the model in the hosting environment. For an example that calls this method when deploying a model to SageMaker hosting services, see Deploy the Model to Amazon SageMaker Hosting Services (Amazon Web Services SDK for Python (Boto 3)). To run a batch transform using your model, you start a job with the CreateTransformJob API. SageMaker uses your model and your dataset to get inferences which are then saved to a specified S3 location. In the request, you also provide an IAM role that SageMaker can assume to access model artifacts and docker image for deployment on ML compute hosting instances or for batch transform jobs. In addition, you also use the IAM role to manage permissions the inference code needs. For example, if the inference code access any other Amazon Web Services resources, you grant necessary permissions via this role.
|
|
245
245
|
*/
|
|
246
246
|
createModel(callback?: (err: AWSError, data: SageMaker.Types.CreateModelOutput) => void): Request<SageMaker.Types.CreateModelOutput, AWSError>;
|
|
247
247
|
/**
|
|
@@ -261,11 +261,11 @@ declare class SageMaker extends Service {
|
|
|
261
261
|
*/
|
|
262
262
|
createModelExplainabilityJobDefinition(callback?: (err: AWSError, data: SageMaker.Types.CreateModelExplainabilityJobDefinitionResponse) => void): Request<SageMaker.Types.CreateModelExplainabilityJobDefinitionResponse, AWSError>;
|
|
263
263
|
/**
|
|
264
|
-
* Creates a model package that you can use to create
|
|
264
|
+
* Creates a model package that you can use to create SageMaker models or list on Amazon Web Services Marketplace, or a versioned model that is part of a model group. Buyers can subscribe to model packages listed on Amazon Web Services Marketplace to create models in SageMaker. To create a model package by specifying a Docker container that contains your inference code and the Amazon S3 location of your model artifacts, provide values for InferenceSpecification. To create a model from an algorithm resource that you created or subscribed to in Amazon Web Services Marketplace, provide a value for SourceAlgorithmSpecification. There are two types of model packages: Versioned - a model that is part of a model group in the model registry. Unversioned - a model package that is not part of a model group.
|
|
265
265
|
*/
|
|
266
266
|
createModelPackage(params: SageMaker.Types.CreateModelPackageInput, callback?: (err: AWSError, data: SageMaker.Types.CreateModelPackageOutput) => void): Request<SageMaker.Types.CreateModelPackageOutput, AWSError>;
|
|
267
267
|
/**
|
|
268
|
-
* Creates a model package that you can use to create
|
|
268
|
+
* Creates a model package that you can use to create SageMaker models or list on Amazon Web Services Marketplace, or a versioned model that is part of a model group. Buyers can subscribe to model packages listed on Amazon Web Services Marketplace to create models in SageMaker. To create a model package by specifying a Docker container that contains your inference code and the Amazon S3 location of your model artifacts, provide values for InferenceSpecification. To create a model from an algorithm resource that you created or subscribed to in Amazon Web Services Marketplace, provide a value for SourceAlgorithmSpecification. There are two types of model packages: Versioned - a model that is part of a model group in the model registry. Unversioned - a model package that is not part of a model group.
|
|
269
269
|
*/
|
|
270
270
|
createModelPackage(callback?: (err: AWSError, data: SageMaker.Types.CreateModelPackageOutput) => void): Request<SageMaker.Types.CreateModelPackageOutput, AWSError>;
|
|
271
271
|
/**
|
|
@@ -293,11 +293,11 @@ declare class SageMaker extends Service {
|
|
|
293
293
|
*/
|
|
294
294
|
createMonitoringSchedule(callback?: (err: AWSError, data: SageMaker.Types.CreateMonitoringScheduleResponse) => void): Request<SageMaker.Types.CreateMonitoringScheduleResponse, AWSError>;
|
|
295
295
|
/**
|
|
296
|
-
* Creates an
|
|
296
|
+
* Creates an SageMaker notebook instance. A notebook instance is a machine learning (ML) compute instance running on a Jupyter notebook. In a CreateNotebookInstance request, specify the type of ML compute instance that you want to run. SageMaker launches the instance, installs common libraries that you can use to explore datasets for model training, and attaches an ML storage volume to the notebook instance. SageMaker also provides a set of example notebooks. Each notebook demonstrates how to use SageMaker with a specific algorithm or with a machine learning framework. After receiving the request, SageMaker does the following: Creates a network interface in the SageMaker VPC. (Option) If you specified SubnetId, SageMaker creates a network interface in your own VPC, which is inferred from the subnet ID that you provide in the input. When creating this network interface, SageMaker attaches the security group that you specified in the request to the network interface that it creates in your VPC. Launches an EC2 instance of the type specified in the request in the SageMaker VPC. If you specified SubnetId of your VPC, SageMaker specifies both network interfaces when launching this instance. This enables inbound traffic from your own VPC to the notebook instance, assuming that the security groups allow it. After creating the notebook instance, SageMaker returns its Amazon Resource Name (ARN). You can't change the name of a notebook instance after you create it. After SageMaker creates the notebook instance, you can connect to the Jupyter server and work in Jupyter notebooks. For example, you can write code to explore a dataset that you can use for model training, train a model, host models by creating SageMaker endpoints, and validate hosted models. For more information, see How It Works.
|
|
297
297
|
*/
|
|
298
298
|
createNotebookInstance(params: SageMaker.Types.CreateNotebookInstanceInput, callback?: (err: AWSError, data: SageMaker.Types.CreateNotebookInstanceOutput) => void): Request<SageMaker.Types.CreateNotebookInstanceOutput, AWSError>;
|
|
299
299
|
/**
|
|
300
|
-
* Creates an
|
|
300
|
+
* Creates an SageMaker notebook instance. A notebook instance is a machine learning (ML) compute instance running on a Jupyter notebook. In a CreateNotebookInstance request, specify the type of ML compute instance that you want to run. SageMaker launches the instance, installs common libraries that you can use to explore datasets for model training, and attaches an ML storage volume to the notebook instance. SageMaker also provides a set of example notebooks. Each notebook demonstrates how to use SageMaker with a specific algorithm or with a machine learning framework. After receiving the request, SageMaker does the following: Creates a network interface in the SageMaker VPC. (Option) If you specified SubnetId, SageMaker creates a network interface in your own VPC, which is inferred from the subnet ID that you provide in the input. When creating this network interface, SageMaker attaches the security group that you specified in the request to the network interface that it creates in your VPC. Launches an EC2 instance of the type specified in the request in the SageMaker VPC. If you specified SubnetId of your VPC, SageMaker specifies both network interfaces when launching this instance. This enables inbound traffic from your own VPC to the notebook instance, assuming that the security groups allow it. After creating the notebook instance, SageMaker returns its Amazon Resource Name (ARN). You can't change the name of a notebook instance after you create it. After SageMaker creates the notebook instance, you can connect to the Jupyter server and work in Jupyter notebooks. For example, you can write code to explore a dataset that you can use for model training, train a model, host models by creating SageMaker endpoints, and validate hosted models. For more information, see How It Works.
|
|
301
301
|
*/
|
|
302
302
|
createNotebookInstance(callback?: (err: AWSError, data: SageMaker.Types.CreateNotebookInstanceOutput) => void): Request<SageMaker.Types.CreateNotebookInstanceOutput, AWSError>;
|
|
303
303
|
/**
|
|
@@ -325,11 +325,11 @@ declare class SageMaker extends Service {
|
|
|
325
325
|
*/
|
|
326
326
|
createPresignedDomainUrl(callback?: (err: AWSError, data: SageMaker.Types.CreatePresignedDomainUrlResponse) => void): Request<SageMaker.Types.CreatePresignedDomainUrlResponse, AWSError>;
|
|
327
327
|
/**
|
|
328
|
-
* Returns a URL that you can use to connect to the Jupyter server from a notebook instance. In the
|
|
328
|
+
* Returns a URL that you can use to connect to the Jupyter server from a notebook instance. In the SageMaker console, when you choose Open next to a notebook instance, SageMaker opens a new tab showing the Jupyter server home page from the notebook instance. The console uses this API to get the URL and show the page. The IAM role or user used to call this API defines the permissions to access the notebook instance. Once the presigned URL is created, no additional permission is required to access this URL. IAM authorization policies for this API are also enforced for every HTTP request and WebSocket frame that attempts to connect to the notebook instance. You can restrict access to this API and to the URL that it returns to a list of IP addresses that you specify. Use the NotIpAddress condition operator and the aws:SourceIP condition context key to specify the list of IP addresses that you want to have access to the notebook instance. For more information, see Limit Access to a Notebook Instance by IP Address. The URL that you get from a call to CreatePresignedNotebookInstanceUrl is valid only for 5 minutes. If you try to use the URL after the 5-minute limit expires, you are directed to the Amazon Web Services console sign-in page.
|
|
329
329
|
*/
|
|
330
330
|
createPresignedNotebookInstanceUrl(params: SageMaker.Types.CreatePresignedNotebookInstanceUrlInput, callback?: (err: AWSError, data: SageMaker.Types.CreatePresignedNotebookInstanceUrlOutput) => void): Request<SageMaker.Types.CreatePresignedNotebookInstanceUrlOutput, AWSError>;
|
|
331
331
|
/**
|
|
332
|
-
* Returns a URL that you can use to connect to the Jupyter server from a notebook instance. In the
|
|
332
|
+
* Returns a URL that you can use to connect to the Jupyter server from a notebook instance. In the SageMaker console, when you choose Open next to a notebook instance, SageMaker opens a new tab showing the Jupyter server home page from the notebook instance. The console uses this API to get the URL and show the page. The IAM role or user used to call this API defines the permissions to access the notebook instance. Once the presigned URL is created, no additional permission is required to access this URL. IAM authorization policies for this API are also enforced for every HTTP request and WebSocket frame that attempts to connect to the notebook instance. You can restrict access to this API and to the URL that it returns to a list of IP addresses that you specify. Use the NotIpAddress condition operator and the aws:SourceIP condition context key to specify the list of IP addresses that you want to have access to the notebook instance. For more information, see Limit Access to a Notebook Instance by IP Address. The URL that you get from a call to CreatePresignedNotebookInstanceUrl is valid only for 5 minutes. If you try to use the URL after the 5-minute limit expires, you are directed to the Amazon Web Services console sign-in page.
|
|
333
333
|
*/
|
|
334
334
|
createPresignedNotebookInstanceUrl(callback?: (err: AWSError, data: SageMaker.Types.CreatePresignedNotebookInstanceUrlOutput) => void): Request<SageMaker.Types.CreatePresignedNotebookInstanceUrlOutput, AWSError>;
|
|
335
335
|
/**
|
|
@@ -357,11 +357,11 @@ declare class SageMaker extends Service {
|
|
|
357
357
|
*/
|
|
358
358
|
createStudioLifecycleConfig(callback?: (err: AWSError, data: SageMaker.Types.CreateStudioLifecycleConfigResponse) => void): Request<SageMaker.Types.CreateStudioLifecycleConfigResponse, AWSError>;
|
|
359
359
|
/**
|
|
360
|
-
* Starts a model training job. After training completes,
|
|
360
|
+
* Starts a model training job. After training completes, SageMaker saves the resulting model artifacts to an Amazon S3 location that you specify. If you choose to host your model using SageMaker hosting services, you can use the resulting model artifacts as part of the model. You can also use the artifacts in a machine learning service other than SageMaker, provided that you know how to use them for inference. In the request body, you provide the following: AlgorithmSpecification - Identifies the training algorithm to use. HyperParameters - Specify these algorithm-specific parameters to enable the estimation of model parameters during training. Hyperparameters can be tuned to optimize this learning process. For a list of hyperparameters for each training algorithm provided by SageMaker, see Algorithms. InputDataConfig - Describes the training dataset and the Amazon S3, EFS, or FSx location where it is stored. OutputDataConfig - Identifies the Amazon S3 bucket where you want SageMaker to save the results of model training. ResourceConfig - Identifies the resources, ML compute instances, and ML storage volumes to deploy for model training. In distributed training, you specify more than one instance. EnableManagedSpotTraining - Optimize the cost of training machine learning models by up to 80% by using Amazon EC2 Spot instances. For more information, see Managed Spot Training. RoleArn - The Amazon Resource Name (ARN) that SageMaker assumes to perform tasks on your behalf during model training. You must grant this role the necessary permissions so that SageMaker can successfully complete model training. StoppingCondition - To help cap training costs, use MaxRuntimeInSeconds to set a time limit for training. Use MaxWaitTimeInSeconds to specify how long a managed spot training job has to complete. Environment - The environment variables to set in the Docker container. RetryStrategy - The number of times to retry the job when the job fails due to an InternalServerError. For more information about SageMaker, see How It Works.
|
|
361
361
|
*/
|
|
362
362
|
createTrainingJob(params: SageMaker.Types.CreateTrainingJobRequest, callback?: (err: AWSError, data: SageMaker.Types.CreateTrainingJobResponse) => void): Request<SageMaker.Types.CreateTrainingJobResponse, AWSError>;
|
|
363
363
|
/**
|
|
364
|
-
* Starts a model training job. After training completes,
|
|
364
|
+
* Starts a model training job. After training completes, SageMaker saves the resulting model artifacts to an Amazon S3 location that you specify. If you choose to host your model using SageMaker hosting services, you can use the resulting model artifacts as part of the model. You can also use the artifacts in a machine learning service other than SageMaker, provided that you know how to use them for inference. In the request body, you provide the following: AlgorithmSpecification - Identifies the training algorithm to use. HyperParameters - Specify these algorithm-specific parameters to enable the estimation of model parameters during training. Hyperparameters can be tuned to optimize this learning process. For a list of hyperparameters for each training algorithm provided by SageMaker, see Algorithms. InputDataConfig - Describes the training dataset and the Amazon S3, EFS, or FSx location where it is stored. OutputDataConfig - Identifies the Amazon S3 bucket where you want SageMaker to save the results of model training. ResourceConfig - Identifies the resources, ML compute instances, and ML storage volumes to deploy for model training. In distributed training, you specify more than one instance. EnableManagedSpotTraining - Optimize the cost of training machine learning models by up to 80% by using Amazon EC2 Spot instances. For more information, see Managed Spot Training. RoleArn - The Amazon Resource Name (ARN) that SageMaker assumes to perform tasks on your behalf during model training. You must grant this role the necessary permissions so that SageMaker can successfully complete model training. StoppingCondition - To help cap training costs, use MaxRuntimeInSeconds to set a time limit for training. Use MaxWaitTimeInSeconds to specify how long a managed spot training job has to complete. Environment - The environment variables to set in the Docker container. RetryStrategy - The number of times to retry the job when the job fails due to an InternalServerError. For more information about SageMaker, see How It Works.
|
|
365
365
|
*/
|
|
366
366
|
createTrainingJob(callback?: (err: AWSError, data: SageMaker.Types.CreateTrainingJobResponse) => void): Request<SageMaker.Types.CreateTrainingJobResponse, AWSError>;
|
|
367
367
|
/**
|
|
@@ -501,11 +501,11 @@ declare class SageMaker extends Service {
|
|
|
501
501
|
*/
|
|
502
502
|
deleteDomain(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
503
503
|
/**
|
|
504
|
-
* Deletes an endpoint.
|
|
504
|
+
* Deletes an endpoint. SageMaker frees up all of the resources that were deployed when the endpoint was created. SageMaker retires any custom KMS key grants associated with the endpoint, meaning you don't need to use the RevokeGrant API call. When you delete your endpoint, SageMaker asynchronously deletes associated endpoint resources such as KMS key grants. You might still see these resources in your account for a few minutes after deleting your endpoint. Do not delete or revoke the permissions for your ExecutionRoleArn , otherwise SageMaker cannot delete these resources.
|
|
505
505
|
*/
|
|
506
506
|
deleteEndpoint(params: SageMaker.Types.DeleteEndpointInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
507
507
|
/**
|
|
508
|
-
* Deletes an endpoint.
|
|
508
|
+
* Deletes an endpoint. SageMaker frees up all of the resources that were deployed when the endpoint was created. SageMaker retires any custom KMS key grants associated with the endpoint, meaning you don't need to use the RevokeGrant API call. When you delete your endpoint, SageMaker asynchronously deletes associated endpoint resources such as KMS key grants. You might still see these resources in your account for a few minutes after deleting your endpoint. Do not delete or revoke the permissions for your ExecutionRoleArn , otherwise SageMaker cannot delete these resources.
|
|
509
509
|
*/
|
|
510
510
|
deleteEndpoint(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
511
511
|
/**
|
|
@@ -565,11 +565,11 @@ declare class SageMaker extends Service {
|
|
|
565
565
|
*/
|
|
566
566
|
deleteImageVersion(callback?: (err: AWSError, data: SageMaker.Types.DeleteImageVersionResponse) => void): Request<SageMaker.Types.DeleteImageVersionResponse, AWSError>;
|
|
567
567
|
/**
|
|
568
|
-
* Deletes a model. The DeleteModel API deletes only the model entry that was created in
|
|
568
|
+
* Deletes a model. The DeleteModel API deletes only the model entry that was created in SageMaker when you called the CreateModel API. It does not delete model artifacts, inference code, or the IAM role that you specified when creating the model.
|
|
569
569
|
*/
|
|
570
570
|
deleteModel(params: SageMaker.Types.DeleteModelInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
571
571
|
/**
|
|
572
|
-
* Deletes a model. The DeleteModel API deletes only the model entry that was created in
|
|
572
|
+
* Deletes a model. The DeleteModel API deletes only the model entry that was created in SageMaker when you called the CreateModel API. It does not delete model artifacts, inference code, or the IAM role that you specified when creating the model.
|
|
573
573
|
*/
|
|
574
574
|
deleteModel(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
575
575
|
/**
|
|
@@ -589,11 +589,11 @@ declare class SageMaker extends Service {
|
|
|
589
589
|
*/
|
|
590
590
|
deleteModelExplainabilityJobDefinition(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
591
591
|
/**
|
|
592
|
-
* Deletes a model package. A model package is used to create
|
|
592
|
+
* Deletes a model package. A model package is used to create SageMaker models or list on Amazon Web Services Marketplace. Buyers can subscribe to model packages listed on Amazon Web Services Marketplace to create models in SageMaker.
|
|
593
593
|
*/
|
|
594
594
|
deleteModelPackage(params: SageMaker.Types.DeleteModelPackageInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
595
595
|
/**
|
|
596
|
-
* Deletes a model package. A model package is used to create
|
|
596
|
+
* Deletes a model package. A model package is used to create SageMaker models or list on Amazon Web Services Marketplace. Buyers can subscribe to model packages listed on Amazon Web Services Marketplace to create models in SageMaker.
|
|
597
597
|
*/
|
|
598
598
|
deleteModelPackage(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
599
599
|
/**
|
|
@@ -629,11 +629,11 @@ declare class SageMaker extends Service {
|
|
|
629
629
|
*/
|
|
630
630
|
deleteMonitoringSchedule(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
631
631
|
/**
|
|
632
|
-
* Deletes an
|
|
632
|
+
* Deletes an SageMaker notebook instance. Before you can delete a notebook instance, you must call the StopNotebookInstance API. When you delete a notebook instance, you lose all of your data. SageMaker removes the ML compute instance, and deletes the ML storage volume and the network interface associated with the notebook instance.
|
|
633
633
|
*/
|
|
634
634
|
deleteNotebookInstance(params: SageMaker.Types.DeleteNotebookInstanceInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
635
635
|
/**
|
|
636
|
-
* Deletes an
|
|
636
|
+
* Deletes an SageMaker notebook instance. Before you can delete a notebook instance, you must call the StopNotebookInstance API. When you delete a notebook instance, you lose all of your data. SageMaker removes the ML compute instance, and deletes the ML storage volume and the network interface associated with the notebook instance.
|
|
637
637
|
*/
|
|
638
638
|
deleteNotebookInstance(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
639
639
|
/**
|
|
@@ -669,11 +669,11 @@ declare class SageMaker extends Service {
|
|
|
669
669
|
*/
|
|
670
670
|
deleteStudioLifecycleConfig(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
671
671
|
/**
|
|
672
|
-
* Deletes the specified tags from an
|
|
672
|
+
* Deletes the specified tags from an SageMaker resource. To list a resource's tags, use the ListTags API. When you call this API to delete tags from a hyperparameter tuning job, the deleted tags are not removed from training jobs that the hyperparameter tuning job launched before you called this API. When you call this API to delete tags from a SageMaker Studio Domain or User Profile, the deleted tags are not removed from Apps that the SageMaker Studio Domain or User Profile launched before you called this API.
|
|
673
673
|
*/
|
|
674
674
|
deleteTags(params: SageMaker.Types.DeleteTagsInput, callback?: (err: AWSError, data: SageMaker.Types.DeleteTagsOutput) => void): Request<SageMaker.Types.DeleteTagsOutput, AWSError>;
|
|
675
675
|
/**
|
|
676
|
-
* Deletes the specified tags from an
|
|
676
|
+
* Deletes the specified tags from an SageMaker resource. To list a resource's tags, use the ListTags API. When you call this API to delete tags from a hyperparameter tuning job, the deleted tags are not removed from training jobs that the hyperparameter tuning job launched before you called this API. When you call this API to delete tags from a SageMaker Studio Domain or User Profile, the deleted tags are not removed from Apps that the SageMaker Studio Domain or User Profile launched before you called this API.
|
|
677
677
|
*/
|
|
678
678
|
deleteTags(callback?: (err: AWSError, data: SageMaker.Types.DeleteTagsOutput) => void): Request<SageMaker.Types.DeleteTagsOutput, AWSError>;
|
|
679
679
|
/**
|
|
@@ -1493,11 +1493,11 @@ declare class SageMaker extends Service {
|
|
|
1493
1493
|
*/
|
|
1494
1494
|
listNotebookInstanceLifecycleConfigs(callback?: (err: AWSError, data: SageMaker.Types.ListNotebookInstanceLifecycleConfigsOutput) => void): Request<SageMaker.Types.ListNotebookInstanceLifecycleConfigsOutput, AWSError>;
|
|
1495
1495
|
/**
|
|
1496
|
-
* Returns a list of the
|
|
1496
|
+
* Returns a list of the SageMaker notebook instances in the requester's account in an Amazon Web Services Region.
|
|
1497
1497
|
*/
|
|
1498
1498
|
listNotebookInstances(params: SageMaker.Types.ListNotebookInstancesInput, callback?: (err: AWSError, data: SageMaker.Types.ListNotebookInstancesOutput) => void): Request<SageMaker.Types.ListNotebookInstancesOutput, AWSError>;
|
|
1499
1499
|
/**
|
|
1500
|
-
* Returns a list of the
|
|
1500
|
+
* Returns a list of the SageMaker notebook instances in the requester's account in an Amazon Web Services Region.
|
|
1501
1501
|
*/
|
|
1502
1502
|
listNotebookInstances(callback?: (err: AWSError, data: SageMaker.Types.ListNotebookInstancesOutput) => void): Request<SageMaker.Types.ListNotebookInstancesOutput, AWSError>;
|
|
1503
1503
|
/**
|
|
@@ -1565,11 +1565,11 @@ declare class SageMaker extends Service {
|
|
|
1565
1565
|
*/
|
|
1566
1566
|
listSubscribedWorkteams(callback?: (err: AWSError, data: SageMaker.Types.ListSubscribedWorkteamsResponse) => void): Request<SageMaker.Types.ListSubscribedWorkteamsResponse, AWSError>;
|
|
1567
1567
|
/**
|
|
1568
|
-
* Returns the tags for the specified
|
|
1568
|
+
* Returns the tags for the specified SageMaker resource.
|
|
1569
1569
|
*/
|
|
1570
1570
|
listTags(params: SageMaker.Types.ListTagsInput, callback?: (err: AWSError, data: SageMaker.Types.ListTagsOutput) => void): Request<SageMaker.Types.ListTagsOutput, AWSError>;
|
|
1571
1571
|
/**
|
|
1572
|
-
* Returns the tags for the specified
|
|
1572
|
+
* Returns the tags for the specified SageMaker resource.
|
|
1573
1573
|
*/
|
|
1574
1574
|
listTags(callback?: (err: AWSError, data: SageMaker.Types.ListTagsOutput) => void): Request<SageMaker.Types.ListTagsOutput, AWSError>;
|
|
1575
1575
|
/**
|
|
@@ -1709,11 +1709,11 @@ declare class SageMaker extends Service {
|
|
|
1709
1709
|
*/
|
|
1710
1710
|
startMonitoringSchedule(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
1711
1711
|
/**
|
|
1712
|
-
* Launches an ML compute instance with the latest version of the libraries and attaches your ML storage volume. After configuring the notebook instance,
|
|
1712
|
+
* Launches an ML compute instance with the latest version of the libraries and attaches your ML storage volume. After configuring the notebook instance, SageMaker sets the notebook instance status to InService. A notebook instance's status must be InService before you can connect to your Jupyter notebook.
|
|
1713
1713
|
*/
|
|
1714
1714
|
startNotebookInstance(params: SageMaker.Types.StartNotebookInstanceInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
1715
1715
|
/**
|
|
1716
|
-
* Launches an ML compute instance with the latest version of the libraries and attaches your ML storage volume. After configuring the notebook instance,
|
|
1716
|
+
* Launches an ML compute instance with the latest version of the libraries and attaches your ML storage volume. After configuring the notebook instance, SageMaker sets the notebook instance status to InService. A notebook instance's status must be InService before you can connect to your Jupyter notebook.
|
|
1717
1717
|
*/
|
|
1718
1718
|
startNotebookInstance(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
1719
1719
|
/**
|
|
@@ -1781,11 +1781,11 @@ declare class SageMaker extends Service {
|
|
|
1781
1781
|
*/
|
|
1782
1782
|
stopMonitoringSchedule(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
1783
1783
|
/**
|
|
1784
|
-
* Terminates the ML compute instance. Before terminating the instance,
|
|
1784
|
+
* Terminates the ML compute instance. Before terminating the instance, SageMaker disconnects the ML storage volume from it. SageMaker preserves the ML storage volume. SageMaker stops charging you for the ML compute instance when you call StopNotebookInstance. To access data on the ML storage volume for a notebook instance that has been terminated, call the StartNotebookInstance API. StartNotebookInstance launches another ML compute instance, configures it, and attaches the preserved ML storage volume so you can continue your work.
|
|
1785
1785
|
*/
|
|
1786
1786
|
stopNotebookInstance(params: SageMaker.Types.StopNotebookInstanceInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
1787
1787
|
/**
|
|
1788
|
-
* Terminates the ML compute instance. Before terminating the instance,
|
|
1788
|
+
* Terminates the ML compute instance. Before terminating the instance, SageMaker disconnects the ML storage volume from it. SageMaker preserves the ML storage volume. SageMaker stops charging you for the ML compute instance when you call StopNotebookInstance. To access data on the ML storage volume for a notebook instance that has been terminated, call the StartNotebookInstance API. StartNotebookInstance launches another ML compute instance, configures it, and attaches the preserved ML storage volume so you can continue your work.
|
|
1789
1789
|
*/
|
|
1790
1790
|
stopNotebookInstance(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
1791
1791
|
/**
|
|
@@ -1805,11 +1805,11 @@ declare class SageMaker extends Service {
|
|
|
1805
1805
|
*/
|
|
1806
1806
|
stopProcessingJob(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
1807
1807
|
/**
|
|
1808
|
-
* Stops a training job. To stop a job,
|
|
1808
|
+
* Stops a training job. To stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms might use this 120-second window to save the model artifacts, so the results of the training is not lost. When it receives a StopTrainingJob request, SageMaker changes the status of the job to Stopping. After SageMaker stops the job, it sets the status to Stopped.
|
|
1809
1809
|
*/
|
|
1810
1810
|
stopTrainingJob(params: SageMaker.Types.StopTrainingJobRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
1811
1811
|
/**
|
|
1812
|
-
* Stops a training job. To stop a job,
|
|
1812
|
+
* Stops a training job. To stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms might use this 120-second window to save the model artifacts, so the results of the training is not lost. When it receives a StopTrainingJob request, SageMaker changes the status of the job to Stopping. After SageMaker stops the job, it sets the status to Stopped.
|
|
1813
1813
|
*/
|
|
1814
1814
|
stopTrainingJob(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
1815
1815
|
/**
|
|
@@ -1885,19 +1885,19 @@ declare class SageMaker extends Service {
|
|
|
1885
1885
|
*/
|
|
1886
1886
|
updateDomain(callback?: (err: AWSError, data: SageMaker.Types.UpdateDomainResponse) => void): Request<SageMaker.Types.UpdateDomainResponse, AWSError>;
|
|
1887
1887
|
/**
|
|
1888
|
-
* Deploys the new EndpointConfig specified in the request, switches to using newly created endpoint, and then deletes resources provisioned for the endpoint using the previous EndpointConfig (there is no availability loss). When
|
|
1888
|
+
* Deploys the new EndpointConfig specified in the request, switches to using newly created endpoint, and then deletes resources provisioned for the endpoint using the previous EndpointConfig (there is no availability loss). When SageMaker receives the request, it sets the endpoint status to Updating. After updating the endpoint, it sets the status to InService. To check the status of an endpoint, use the DescribeEndpoint API. You must not delete an EndpointConfig in use by an endpoint that is live or while the UpdateEndpoint or CreateEndpoint operations are being performed on the endpoint. To update an endpoint, you must create a new EndpointConfig. If you delete the EndpointConfig of an endpoint that is active or being created or updated you may lose visibility into the instance type the endpoint is using. The endpoint must be deleted in order to stop incurring charges.
|
|
1889
1889
|
*/
|
|
1890
1890
|
updateEndpoint(params: SageMaker.Types.UpdateEndpointInput, callback?: (err: AWSError, data: SageMaker.Types.UpdateEndpointOutput) => void): Request<SageMaker.Types.UpdateEndpointOutput, AWSError>;
|
|
1891
1891
|
/**
|
|
1892
|
-
* Deploys the new EndpointConfig specified in the request, switches to using newly created endpoint, and then deletes resources provisioned for the endpoint using the previous EndpointConfig (there is no availability loss). When
|
|
1892
|
+
* Deploys the new EndpointConfig specified in the request, switches to using newly created endpoint, and then deletes resources provisioned for the endpoint using the previous EndpointConfig (there is no availability loss). When SageMaker receives the request, it sets the endpoint status to Updating. After updating the endpoint, it sets the status to InService. To check the status of an endpoint, use the DescribeEndpoint API. You must not delete an EndpointConfig in use by an endpoint that is live or while the UpdateEndpoint or CreateEndpoint operations are being performed on the endpoint. To update an endpoint, you must create a new EndpointConfig. If you delete the EndpointConfig of an endpoint that is active or being created or updated you may lose visibility into the instance type the endpoint is using. The endpoint must be deleted in order to stop incurring charges.
|
|
1893
1893
|
*/
|
|
1894
1894
|
updateEndpoint(callback?: (err: AWSError, data: SageMaker.Types.UpdateEndpointOutput) => void): Request<SageMaker.Types.UpdateEndpointOutput, AWSError>;
|
|
1895
1895
|
/**
|
|
1896
|
-
* Updates variant weight of one or more variants associated with an existing endpoint, or capacity of one variant associated with an existing endpoint. When it receives the request,
|
|
1896
|
+
* Updates variant weight of one or more variants associated with an existing endpoint, or capacity of one variant associated with an existing endpoint. When it receives the request, SageMaker sets the endpoint status to Updating. After updating the endpoint, it sets the status to InService. To check the status of an endpoint, use the DescribeEndpoint API.
|
|
1897
1897
|
*/
|
|
1898
1898
|
updateEndpointWeightsAndCapacities(params: SageMaker.Types.UpdateEndpointWeightsAndCapacitiesInput, callback?: (err: AWSError, data: SageMaker.Types.UpdateEndpointWeightsAndCapacitiesOutput) => void): Request<SageMaker.Types.UpdateEndpointWeightsAndCapacitiesOutput, AWSError>;
|
|
1899
1899
|
/**
|
|
1900
|
-
* Updates variant weight of one or more variants associated with an existing endpoint, or capacity of one variant associated with an existing endpoint. When it receives the request,
|
|
1900
|
+
* Updates variant weight of one or more variants associated with an existing endpoint, or capacity of one variant associated with an existing endpoint. When it receives the request, SageMaker sets the endpoint status to Updating. After updating the endpoint, it sets the status to InService. To check the status of an endpoint, use the DescribeEndpoint API.
|
|
1901
1901
|
*/
|
|
1902
1902
|
updateEndpointWeightsAndCapacities(callback?: (err: AWSError, data: SageMaker.Types.UpdateEndpointWeightsAndCapacitiesOutput) => void): Request<SageMaker.Types.UpdateEndpointWeightsAndCapacitiesOutput, AWSError>;
|
|
1903
1903
|
/**
|
|
@@ -2211,7 +2211,7 @@ declare namespace SageMaker {
|
|
|
2211
2211
|
}
|
|
2212
2212
|
export interface AddTagsOutput {
|
|
2213
2213
|
/**
|
|
2214
|
-
* A list of tags associated with the
|
|
2214
|
+
* A list of tags associated with the SageMaker resource.
|
|
2215
2215
|
*/
|
|
2216
2216
|
Tags?: TagList;
|
|
2217
2217
|
}
|
|
@@ -2271,20 +2271,20 @@ declare namespace SageMaker {
|
|
|
2271
2271
|
export type AlgorithmSortBy = "Name"|"CreationTime"|string;
|
|
2272
2272
|
export interface AlgorithmSpecification {
|
|
2273
2273
|
/**
|
|
2274
|
-
* The registry path of the Docker image that contains the training algorithm. For information about docker registry paths for built-in algorithms, see
|
|
2274
|
+
* The registry path of the Docker image that contains the training algorithm. For information about docker registry paths for SageMaker built-in algorithms, see Docker Registry Paths and Example Code in the Amazon SageMaker developer guide. SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information about using your custom training container, see Using Your Own Algorithms with Amazon SageMaker. You must specify either the algorithm name to the AlgorithmName parameter or the image URI of the algorithm container to the TrainingImage parameter. For more information, see the note in the AlgorithmName parameter description.
|
|
2275
2275
|
*/
|
|
2276
2276
|
TrainingImage?: AlgorithmImage;
|
|
2277
2277
|
/**
|
|
2278
|
-
* The name of the algorithm resource to use for the training job. This must be an algorithm resource that you created or subscribe to on Amazon Web Services Marketplace. If you specify a value for
|
|
2278
|
+
* The name of the algorithm resource to use for the training job. This must be an algorithm resource that you created or subscribe to on Amazon Web Services Marketplace. You must specify either the algorithm name to the AlgorithmName parameter or the image URI of the algorithm container to the TrainingImage parameter. Note that the AlgorithmName parameter is mutually exclusive with the TrainingImage parameter. If you specify a value for the AlgorithmName parameter, you can't specify a value for TrainingImage, and vice versa. If you specify values for both parameters, the training job might break; if you don't specify any value for both parameters, the training job might raise a null error.
|
|
2279
2279
|
*/
|
|
2280
2280
|
AlgorithmName?: ArnOrName;
|
|
2281
2281
|
TrainingInputMode: TrainingInputMode;
|
|
2282
2282
|
/**
|
|
2283
|
-
* A list of metric definition objects. Each object specifies the metric name and regular expressions used to parse algorithm logs.
|
|
2283
|
+
* A list of metric definition objects. Each object specifies the metric name and regular expressions used to parse algorithm logs. SageMaker publishes each metric to Amazon CloudWatch.
|
|
2284
2284
|
*/
|
|
2285
2285
|
MetricDefinitions?: MetricDefinitionList;
|
|
2286
2286
|
/**
|
|
2287
|
-
* To generate and save time-series metrics during training, set to true. The default is false and time-series metrics aren't generated except in the following cases: You use one of the
|
|
2287
|
+
* To generate and save time-series metrics during training, set to true. The default is false and time-series metrics aren't generated except in the following cases: You use one of the SageMaker built-in algorithms You use one of the following Prebuilt SageMaker Docker Images: Tensorflow (version >= 1.15) MXNet (version >= 1.6) PyTorch (version >= 1.3) You specify at least one MetricDefinition
|
|
2288
2288
|
*/
|
|
2289
2289
|
EnableSageMakerMetricsTimeSeries?: Boolean;
|
|
2290
2290
|
}
|
|
@@ -2343,22 +2343,22 @@ declare namespace SageMaker {
|
|
|
2343
2343
|
*/
|
|
2344
2344
|
ProfileName: EntityName;
|
|
2345
2345
|
/**
|
|
2346
|
-
* The TrainingJobDefinition object that describes the training job that
|
|
2346
|
+
* The TrainingJobDefinition object that describes the training job that SageMaker runs to validate your algorithm.
|
|
2347
2347
|
*/
|
|
2348
2348
|
TrainingJobDefinition: TrainingJobDefinition;
|
|
2349
2349
|
/**
|
|
2350
|
-
* The TransformJobDefinition object that describes the transform job that
|
|
2350
|
+
* The TransformJobDefinition object that describes the transform job that SageMaker runs to validate your algorithm.
|
|
2351
2351
|
*/
|
|
2352
2352
|
TransformJobDefinition?: TransformJobDefinition;
|
|
2353
2353
|
}
|
|
2354
2354
|
export type AlgorithmValidationProfiles = AlgorithmValidationProfile[];
|
|
2355
2355
|
export interface AlgorithmValidationSpecification {
|
|
2356
2356
|
/**
|
|
2357
|
-
* The IAM roles that
|
|
2357
|
+
* The IAM roles that SageMaker uses to run the training jobs.
|
|
2358
2358
|
*/
|
|
2359
2359
|
ValidationRole: RoleArn;
|
|
2360
2360
|
/**
|
|
2361
|
-
* An array of AlgorithmValidationProfile objects, each of which specifies a training job and batch transform job that
|
|
2361
|
+
* An array of AlgorithmValidationProfile objects, each of which specifies a training job and batch transform job that SageMaker runs to validate your algorithm.
|
|
2362
2362
|
*/
|
|
2363
2363
|
ValidationProfiles: AlgorithmValidationProfiles;
|
|
2364
2364
|
}
|
|
@@ -2421,7 +2421,7 @@ declare namespace SageMaker {
|
|
|
2421
2421
|
export type AppImageConfigList = AppImageConfigDetails[];
|
|
2422
2422
|
export type AppImageConfigName = string;
|
|
2423
2423
|
export type AppImageConfigSortKey = "CreationTime"|"LastModifiedTime"|"Name"|string;
|
|
2424
|
-
export type AppInstanceType = "system"|"ml.t3.micro"|"ml.t3.small"|"ml.t3.medium"|"ml.t3.large"|"ml.t3.xlarge"|"ml.t3.2xlarge"|"ml.m5.large"|"ml.m5.xlarge"|"ml.m5.2xlarge"|"ml.m5.4xlarge"|"ml.m5.8xlarge"|"ml.m5.12xlarge"|"ml.m5.16xlarge"|"ml.m5.24xlarge"|"ml.m5d.large"|"ml.m5d.xlarge"|"ml.m5d.2xlarge"|"ml.m5d.4xlarge"|"ml.m5d.8xlarge"|"ml.m5d.12xlarge"|"ml.m5d.16xlarge"|"ml.m5d.24xlarge"|"ml.c5.large"|"ml.c5.xlarge"|"ml.c5.2xlarge"|"ml.c5.4xlarge"|"ml.c5.9xlarge"|"ml.c5.12xlarge"|"ml.c5.18xlarge"|"ml.c5.24xlarge"|"ml.p3.2xlarge"|"ml.p3.8xlarge"|"ml.p3.16xlarge"|"ml.p3dn.24xlarge"|"ml.g4dn.xlarge"|"ml.g4dn.2xlarge"|"ml.g4dn.4xlarge"|"ml.g4dn.8xlarge"|"ml.g4dn.12xlarge"|"ml.g4dn.16xlarge"|"ml.r5.large"|"ml.r5.xlarge"|"ml.r5.2xlarge"|"ml.r5.4xlarge"|"ml.r5.8xlarge"|"ml.r5.12xlarge"|"ml.r5.16xlarge"|"ml.r5.24xlarge"|string;
|
|
2424
|
+
export type AppInstanceType = "system"|"ml.t3.micro"|"ml.t3.small"|"ml.t3.medium"|"ml.t3.large"|"ml.t3.xlarge"|"ml.t3.2xlarge"|"ml.m5.large"|"ml.m5.xlarge"|"ml.m5.2xlarge"|"ml.m5.4xlarge"|"ml.m5.8xlarge"|"ml.m5.12xlarge"|"ml.m5.16xlarge"|"ml.m5.24xlarge"|"ml.m5d.large"|"ml.m5d.xlarge"|"ml.m5d.2xlarge"|"ml.m5d.4xlarge"|"ml.m5d.8xlarge"|"ml.m5d.12xlarge"|"ml.m5d.16xlarge"|"ml.m5d.24xlarge"|"ml.c5.large"|"ml.c5.xlarge"|"ml.c5.2xlarge"|"ml.c5.4xlarge"|"ml.c5.9xlarge"|"ml.c5.12xlarge"|"ml.c5.18xlarge"|"ml.c5.24xlarge"|"ml.p3.2xlarge"|"ml.p3.8xlarge"|"ml.p3.16xlarge"|"ml.p3dn.24xlarge"|"ml.g4dn.xlarge"|"ml.g4dn.2xlarge"|"ml.g4dn.4xlarge"|"ml.g4dn.8xlarge"|"ml.g4dn.12xlarge"|"ml.g4dn.16xlarge"|"ml.r5.large"|"ml.r5.xlarge"|"ml.r5.2xlarge"|"ml.r5.4xlarge"|"ml.r5.8xlarge"|"ml.r5.12xlarge"|"ml.r5.16xlarge"|"ml.r5.24xlarge"|"ml.g5.xlarge"|"ml.g5.2xlarge"|"ml.g5.4xlarge"|"ml.g5.8xlarge"|"ml.g5.16xlarge"|"ml.g5.12xlarge"|"ml.g5.24xlarge"|"ml.g5.48xlarge"|string;
|
|
2425
2425
|
export type AppList = AppDetails[];
|
|
2426
2426
|
export type AppManaged = boolean;
|
|
2427
2427
|
export type AppName = string;
|
|
@@ -2558,13 +2558,13 @@ declare namespace SageMaker {
|
|
|
2558
2558
|
}
|
|
2559
2559
|
export interface AsyncInferenceClientConfig {
|
|
2560
2560
|
/**
|
|
2561
|
-
* The maximum number of concurrent requests sent by the SageMaker client to the model container. If no value is provided,
|
|
2561
|
+
* The maximum number of concurrent requests sent by the SageMaker client to the model container. If no value is provided, SageMaker chooses an optimal value.
|
|
2562
2562
|
*/
|
|
2563
2563
|
MaxConcurrentInvocationsPerInstance?: MaxConcurrentInvocationsPerInstance;
|
|
2564
2564
|
}
|
|
2565
2565
|
export interface AsyncInferenceConfig {
|
|
2566
2566
|
/**
|
|
2567
|
-
* Configures the behavior of the client used by
|
|
2567
|
+
* Configures the behavior of the client used by SageMaker to interact with the model container during asynchronous inference.
|
|
2568
2568
|
*/
|
|
2569
2569
|
ClientConfig?: AsyncInferenceClientConfig;
|
|
2570
2570
|
/**
|
|
@@ -2584,7 +2584,7 @@ declare namespace SageMaker {
|
|
|
2584
2584
|
}
|
|
2585
2585
|
export interface AsyncInferenceOutputConfig {
|
|
2586
2586
|
/**
|
|
2587
|
-
* The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that
|
|
2587
|
+
* The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that SageMaker uses to encrypt the asynchronous inference output in Amazon S3.
|
|
2588
2588
|
*/
|
|
2589
2589
|
KmsKeyId?: KmsKeyId;
|
|
2590
2590
|
/**
|
|
@@ -2665,6 +2665,12 @@ declare namespace SageMaker {
|
|
|
2665
2665
|
*/
|
|
2666
2666
|
CandidateProperties?: CandidateProperties;
|
|
2667
2667
|
}
|
|
2668
|
+
export interface AutoMLCandidateGenerationConfig {
|
|
2669
|
+
/**
|
|
2670
|
+
* A URL to the Amazon S3 data source containing selected features from the input data source to run an Autopilot job (optional). This file should be in json format as shown below: { "FeatureAttributeNames":["col1", "col2", ...] }. The key name FeatureAttributeNames is fixed. The values listed in ["col1", "col2", ...] is case sensitive and should be a list of strings containing unique values that are a subset of the column names in the input data. The list of columns provided must not include the target column.
|
|
2671
|
+
*/
|
|
2672
|
+
FeatureSpecificationS3Uri?: S3Uri;
|
|
2673
|
+
}
|
|
2668
2674
|
export interface AutoMLCandidateStep {
|
|
2669
2675
|
/**
|
|
2670
2676
|
* Whether the candidate is at the transform, training, or processing step.
|
|
@@ -2697,7 +2703,12 @@ declare namespace SageMaker {
|
|
|
2697
2703
|
* The content type of the data from the input source. You can use text/csv;header=present or x-application/vnd.amazon+parquet. The default value is text/csv;header=present.
|
|
2698
2704
|
*/
|
|
2699
2705
|
ContentType?: ContentType;
|
|
2706
|
+
/**
|
|
2707
|
+
* The channel type (optional) is an enum string. The default value is training. Channels for training and validation must share the same ContentType and TargetAttributeName. For information on specifying training and validation channel types, see How to specify training and validation datasets .
|
|
2708
|
+
*/
|
|
2709
|
+
ChannelType?: AutoMLChannelType;
|
|
2700
2710
|
}
|
|
2711
|
+
export type AutoMLChannelType = "training"|"validation"|string;
|
|
2701
2712
|
export interface AutoMLContainerDefinition {
|
|
2702
2713
|
/**
|
|
2703
2714
|
* The Amazon Elastic Container Registry (Amazon ECR) path of the container. For more information, see .
|
|
@@ -2719,6 +2730,12 @@ declare namespace SageMaker {
|
|
|
2719
2730
|
*/
|
|
2720
2731
|
S3DataSource: AutoMLS3DataSource;
|
|
2721
2732
|
}
|
|
2733
|
+
export interface AutoMLDataSplitConfig {
|
|
2734
|
+
/**
|
|
2735
|
+
* The validation fraction (optional) is a float that specifies the portion of the training dataset to be used for validation. The default value is 0.2, and values must be greater than 0 and less than 1. We recommend setting this value to be less than 0.5.
|
|
2736
|
+
*/
|
|
2737
|
+
ValidationFraction?: ValidationFraction;
|
|
2738
|
+
}
|
|
2722
2739
|
export type AutoMLFailureReason = string;
|
|
2723
2740
|
export type AutoMLInputDataConfig = AutoMLChannel[];
|
|
2724
2741
|
export type AutoMLJobArn = string;
|
|
@@ -2755,6 +2772,14 @@ declare namespace SageMaker {
|
|
|
2755
2772
|
* The security configuration for traffic encryption or Amazon VPC settings.
|
|
2756
2773
|
*/
|
|
2757
2774
|
SecurityConfig?: AutoMLSecurityConfig;
|
|
2775
|
+
/**
|
|
2776
|
+
* The configuration for splitting the input training dataset. Type: AutoMLDataSplitConfig
|
|
2777
|
+
*/
|
|
2778
|
+
DataSplitConfig?: AutoMLDataSplitConfig;
|
|
2779
|
+
/**
|
|
2780
|
+
* The configuration for generating a candidate for an AutoML job (optional).
|
|
2781
|
+
*/
|
|
2782
|
+
CandidateGenerationConfig?: AutoMLCandidateGenerationConfig;
|
|
2758
2783
|
}
|
|
2759
2784
|
export type AutoMLJobName = string;
|
|
2760
2785
|
export interface AutoMLJobObjective {
|
|
@@ -2807,6 +2832,7 @@ declare namespace SageMaker {
|
|
|
2807
2832
|
}
|
|
2808
2833
|
export type AutoMLMaxResults = number;
|
|
2809
2834
|
export type AutoMLMetricEnum = "Accuracy"|"MSE"|"F1"|"F1macro"|"AUC"|string;
|
|
2835
|
+
export type AutoMLMetricExtendedEnum = "Accuracy"|"MSE"|"F1"|"F1macro"|"AUC"|"RMSE"|"MAE"|"R2"|"BalancedAccuracy"|"Precision"|"PrecisionMacro"|"Recall"|"RecallMacro"|"LogLoss"|string;
|
|
2810
2836
|
export type AutoMLNameContains = string;
|
|
2811
2837
|
export interface AutoMLOutputDataConfig {
|
|
2812
2838
|
/**
|
|
@@ -3009,18 +3035,18 @@ declare namespace SageMaker {
|
|
|
3009
3035
|
export type CapacitySizeValue = number;
|
|
3010
3036
|
export interface CaptureContentTypeHeader {
|
|
3011
3037
|
/**
|
|
3012
|
-
*
|
|
3038
|
+
* The list of all content type headers that SageMaker will treat as CSV and capture accordingly.
|
|
3013
3039
|
*/
|
|
3014
3040
|
CsvContentTypes?: CsvContentTypes;
|
|
3015
3041
|
/**
|
|
3016
|
-
*
|
|
3042
|
+
* The list of all content type headers that SageMaker will treat as JSON and capture accordingly.
|
|
3017
3043
|
*/
|
|
3018
3044
|
JsonContentTypes?: JsonContentTypes;
|
|
3019
3045
|
}
|
|
3020
3046
|
export type CaptureMode = "Input"|"Output"|string;
|
|
3021
3047
|
export interface CaptureOption {
|
|
3022
3048
|
/**
|
|
3023
|
-
*
|
|
3049
|
+
* Specify the boundary of data to capture.
|
|
3024
3050
|
*/
|
|
3025
3051
|
CaptureMode: CaptureMode;
|
|
3026
3052
|
}
|
|
@@ -3076,11 +3102,11 @@ declare namespace SageMaker {
|
|
|
3076
3102
|
*/
|
|
3077
3103
|
CompressionType?: CompressionType;
|
|
3078
3104
|
/**
|
|
3079
|
-
* Specify RecordIO as the value when input data is in raw format but the training algorithm requires the RecordIO format. In this case,
|
|
3105
|
+
* Specify RecordIO as the value when input data is in raw format but the training algorithm requires the RecordIO format. In this case, SageMaker wraps each individual S3 object in a RecordIO record. If the input data is already in RecordIO format, you don't need to set this attribute. For more information, see Create a Dataset Using RecordIO. In File mode, leave this field unset or set it to None.
|
|
3080
3106
|
*/
|
|
3081
3107
|
RecordWrapperType?: RecordWrapper;
|
|
3082
3108
|
/**
|
|
3083
|
-
* (Optional) The input mode to use for the data channel in a training job. If you don't set a value for InputMode,
|
|
3109
|
+
* (Optional) The input mode to use for the data channel in a training job. If you don't set a value for InputMode, SageMaker uses the value set for TrainingInputMode. Use this parameter to override the TrainingInputMode setting in a AlgorithmSpecification request when you have a channel that needs a different input mode from the training job's general setting. To download the data from Amazon Simple Storage Service (Amazon S3) to the provisioned ML storage volume, and mount the directory to a Docker volume, use File input mode. To stream data directly from Amazon S3 to the container, choose Pipe input mode. To use a model for incremental training, choose File input model.
|
|
3084
3110
|
*/
|
|
3085
3111
|
InputMode?: TrainingInputMode;
|
|
3086
3112
|
/**
|
|
@@ -3118,7 +3144,7 @@ declare namespace SageMaker {
|
|
|
3118
3144
|
export type ChannelSpecifications = ChannelSpecification[];
|
|
3119
3145
|
export interface CheckpointConfig {
|
|
3120
3146
|
/**
|
|
3121
|
-
* Identifies the S3 path where you want
|
|
3147
|
+
* Identifies the S3 path where you want SageMaker to store checkpoints. For example, s3://bucket-name/key-name-prefix.
|
|
3122
3148
|
*/
|
|
3123
3149
|
S3Uri: S3Uri;
|
|
3124
3150
|
/**
|
|
@@ -3302,7 +3328,7 @@ declare namespace SageMaker {
|
|
|
3302
3328
|
*/
|
|
3303
3329
|
ContainerHostname?: ContainerHostname;
|
|
3304
3330
|
/**
|
|
3305
|
-
* The path where inference code is stored. This can be either in Amazon EC2 Container Registry or in a Docker registry that is accessible from the same VPC that you configure for your endpoint. If you are using your own custom algorithm instead of an algorithm provided by
|
|
3331
|
+
* The path where inference code is stored. This can be either in Amazon EC2 Container Registry or in a Docker registry that is accessible from the same VPC that you configure for your endpoint. If you are using your own custom algorithm instead of an algorithm provided by SageMaker, the inference code must meet SageMaker requirements. SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker
|
|
3306
3332
|
*/
|
|
3307
3333
|
Image?: ContainerImage;
|
|
3308
3334
|
/**
|
|
@@ -3314,7 +3340,7 @@ declare namespace SageMaker {
|
|
|
3314
3340
|
*/
|
|
3315
3341
|
Mode?: ContainerMode;
|
|
3316
3342
|
/**
|
|
3317
|
-
* The S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix). The S3 path is required for
|
|
3343
|
+
* The S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix). The S3 path is required for SageMaker built-in algorithms, but not if you use your own algorithms. For more information on built-in algorithms, see Common Parameters. The model artifacts must be in an S3 bucket that is in the same region as the model or endpoint you are creating. If you provide a value for this parameter, SageMaker uses Amazon Web Services Security Token Service to download model artifacts from the S3 path you provide. Amazon Web Services STS is activated in your IAM user account by default. If you previously deactivated Amazon Web Services STS for a region, you need to reactivate Amazon Web Services STS for that region. For more information, see Activating and Deactivating Amazon Web Services STS in an Amazon Web Services Region in the Amazon Web Services Identity and Access Management User Guide. If you use a built-in algorithm to create a model, SageMaker requires that you provide a S3 path to the model artifacts in ModelDataUrl.
|
|
3318
3344
|
*/
|
|
3319
3345
|
ModelDataUrl?: Url;
|
|
3320
3346
|
/**
|
|
@@ -3401,7 +3427,7 @@ declare namespace SageMaker {
|
|
|
3401
3427
|
*/
|
|
3402
3428
|
MaxValue: ParameterValue;
|
|
3403
3429
|
/**
|
|
3404
|
-
* The scale that hyperparameter tuning uses to search the hyperparameter range. For information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values: Auto
|
|
3430
|
+
* The scale that hyperparameter tuning uses to search the hyperparameter range. For information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values: Auto SageMaker hyperparameter tuning chooses the best scale for the hyperparameter. Linear Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale. Logarithmic Hyperparameter tuning searches the values in the hyperparameter range by using a logarithmic scale. Logarithmic scaling works only for ranges that have only values greater than 0. ReverseLogarithmic Hyperparameter tuning searches the values in the hyperparameter range by using a reverse logarithmic scale. Reverse logarithmic scaling works only for ranges that are entirely within the range 0<=x<1.0.
|
|
3405
3431
|
*/
|
|
3406
3432
|
ScalingType?: HyperParameterScalingType;
|
|
3407
3433
|
}
|
|
@@ -3471,7 +3497,7 @@ declare namespace SageMaker {
|
|
|
3471
3497
|
*/
|
|
3472
3498
|
InferenceSpecification?: InferenceSpecification;
|
|
3473
3499
|
/**
|
|
3474
|
-
* Specifies configurations for one or more training jobs and that
|
|
3500
|
+
* Specifies configurations for one or more training jobs and that SageMaker runs to test the algorithm's training code and, optionally, one or more batch transform jobs that SageMaker runs to test the algorithm's inference code.
|
|
3475
3501
|
*/
|
|
3476
3502
|
ValidationSpecification?: AlgorithmValidationSpecification;
|
|
3477
3503
|
/**
|
|
@@ -3576,7 +3602,7 @@ declare namespace SageMaker {
|
|
|
3576
3602
|
*/
|
|
3577
3603
|
AutoMLJobName: AutoMLJobName;
|
|
3578
3604
|
/**
|
|
3579
|
-
* An array of channel objects that describes the input data and its location. Each channel is a named input source. Similar to InputDataConfig supported by . Format(s) supported: CSV.
|
|
3605
|
+
* An array of channel objects that describes the input data and its location. Each channel is a named input source. Similar to InputDataConfig supported by . Format(s) supported: CSV, Parquet. A minimum of 500 rows is required for the training dataset. There is not a minimum number of rows required for the validation dataset.
|
|
3580
3606
|
*/
|
|
3581
3607
|
InputDataConfig: AutoMLInputDataConfig;
|
|
3582
3608
|
/**
|
|
@@ -3584,7 +3610,7 @@ declare namespace SageMaker {
|
|
|
3584
3610
|
*/
|
|
3585
3611
|
OutputDataConfig: AutoMLOutputDataConfig;
|
|
3586
3612
|
/**
|
|
3587
|
-
* Defines the type of supervised learning available for the candidates.
|
|
3613
|
+
* Defines the type of supervised learning available for the candidates. For more information, see Amazon SageMaker Autopilot problem types and algorithm support.
|
|
3588
3614
|
*/
|
|
3589
3615
|
ProblemType?: ProblemType;
|
|
3590
3616
|
/**
|
|
@@ -3592,7 +3618,7 @@ declare namespace SageMaker {
|
|
|
3592
3618
|
*/
|
|
3593
3619
|
AutoMLJobObjective?: AutoMLJobObjective;
|
|
3594
3620
|
/**
|
|
3595
|
-
*
|
|
3621
|
+
* A collection of settings used to configure an AutoML job.
|
|
3596
3622
|
*/
|
|
3597
3623
|
AutoMLJobConfig?: AutoMLJobConfig;
|
|
3598
3624
|
/**
|
|
@@ -3880,7 +3906,7 @@ declare namespace SageMaker {
|
|
|
3880
3906
|
*/
|
|
3881
3907
|
Tags?: TagList;
|
|
3882
3908
|
/**
|
|
3883
|
-
* The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that
|
|
3909
|
+
* The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint. The KmsKeyId can be any of the following formats: Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab Alias name: alias/ExampleAlias Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias The KMS key policy must grant permission to the IAM role that you specify in your CreateEndpoint, UpdateEndpoint requests. For more information, refer to the Amazon Web Services Key Management Service section Using Key Policies in Amazon Web Services KMS Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can't request a KmsKeyId when using an instance type with local storage. If any of the models that you specify in the ProductionVariants parameter use nitro-based instances with local storage, do not specify a value for the KmsKeyId parameter. If you specify a value for KmsKeyId when using any nitro-based instances with local storage, the call to CreateEndpointConfig fails. For a list of instance types that support local instance storage, see Instance Store Volumes. For more information about local instance storage encryption, see SSD Instance Store Volumes.
|
|
3884
3910
|
*/
|
|
3885
3911
|
KmsKeyId?: KmsKeyId;
|
|
3886
3912
|
/**
|
|
@@ -4064,7 +4090,7 @@ declare namespace SageMaker {
|
|
|
4064
4090
|
}
|
|
4065
4091
|
export interface CreateHyperParameterTuningJobResponse {
|
|
4066
4092
|
/**
|
|
4067
|
-
* The Amazon Resource Name (ARN) of the tuning job.
|
|
4093
|
+
* The Amazon Resource Name (ARN) of the tuning job. SageMaker assigns an ARN to a hyperparameter tuning job when you create it.
|
|
4068
4094
|
*/
|
|
4069
4095
|
HyperParameterTuningJobArn: HyperParameterTuningJobArn;
|
|
4070
4096
|
}
|
|
@@ -4098,7 +4124,7 @@ declare namespace SageMaker {
|
|
|
4098
4124
|
}
|
|
4099
4125
|
export interface CreateImageVersionRequest {
|
|
4100
4126
|
/**
|
|
4101
|
-
* The registry path of the container image to use as the starting point for this version. The path is an Amazon Container Registry (ECR) URI in the following format: <acct-id>.dkr.ecr.<region>.amazonaws.com/<repo-name[:tag] or [@digest]>
|
|
4127
|
+
* The registry path of the container image to use as the starting point for this version. The path is an Amazon Elastic Container Registry (ECR) URI in the following format: <acct-id>.dkr.ecr.<region>.amazonaws.com/<repo-name[:tag] or [@digest]>
|
|
4102
4128
|
*/
|
|
4103
4129
|
BaseImage: ImageBaseImage;
|
|
4104
4130
|
/**
|
|
@@ -4141,6 +4167,10 @@ declare namespace SageMaker {
|
|
|
4141
4167
|
* A set of conditions for stopping a recommendation job. If any of the conditions are met, the job is automatically stopped.
|
|
4142
4168
|
*/
|
|
4143
4169
|
StoppingConditions?: RecommendationJobStoppingConditions;
|
|
4170
|
+
/**
|
|
4171
|
+
* Provides information about the output artifacts and the KMS key to use for Amazon S3 server-side encryption.
|
|
4172
|
+
*/
|
|
4173
|
+
OutputConfig?: RecommendationJobOutputConfig;
|
|
4144
4174
|
/**
|
|
4145
4175
|
* The metadata that you apply to Amazon Web Services resources to help you categorize and organize them. Each tag consists of a key and a value, both of which you define. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.
|
|
4146
4176
|
*/
|
|
@@ -4296,7 +4326,7 @@ declare namespace SageMaker {
|
|
|
4296
4326
|
*/
|
|
4297
4327
|
InferenceExecutionConfig?: InferenceExecutionConfig;
|
|
4298
4328
|
/**
|
|
4299
|
-
* The Amazon Resource Name (ARN) of the IAM role that
|
|
4329
|
+
* The Amazon Resource Name (ARN) of the IAM role that SageMaker can assume to access model artifacts and docker image for deployment on ML compute instances or for batch transform jobs. Deploying on ML compute instances is part of model hosting. For more information, see SageMaker Roles. To be able to pass this role to SageMaker, the caller of this API must have the iam:PassRole permission.
|
|
4300
4330
|
*/
|
|
4301
4331
|
ExecutionRoleArn: RoleArn;
|
|
4302
4332
|
/**
|
|
@@ -4314,7 +4344,7 @@ declare namespace SageMaker {
|
|
|
4314
4344
|
}
|
|
4315
4345
|
export interface CreateModelOutput {
|
|
4316
4346
|
/**
|
|
4317
|
-
* The ARN of the model created in
|
|
4347
|
+
* The ARN of the model created in SageMaker.
|
|
4318
4348
|
*/
|
|
4319
4349
|
ModelArn: ModelArn;
|
|
4320
4350
|
}
|
|
@@ -4356,7 +4386,7 @@ declare namespace SageMaker {
|
|
|
4356
4386
|
*/
|
|
4357
4387
|
InferenceSpecification?: InferenceSpecification;
|
|
4358
4388
|
/**
|
|
4359
|
-
* Specifies configurations for one or more transform jobs that
|
|
4389
|
+
* Specifies configurations for one or more transform jobs that SageMaker runs to test the model package.
|
|
4360
4390
|
*/
|
|
4361
4391
|
ValidationSpecification?: ModelPackageValidationSpecification;
|
|
4362
4392
|
/**
|
|
@@ -4397,7 +4427,7 @@ declare namespace SageMaker {
|
|
|
4397
4427
|
*/
|
|
4398
4428
|
Domain?: String;
|
|
4399
4429
|
/**
|
|
4400
|
-
* The machine learning task your model package accomplishes. Common machine learning tasks include object detection and image classification.
|
|
4430
|
+
* The machine learning task your model package accomplishes. Common machine learning tasks include object detection and image classification. The following tasks are supported by Inference Recommender: "IMAGE_CLASSIFICATION" | "OBJECT_DETECTION" | "TEXT_GENERATION" |"IMAGE_SEGMENTATION" | "FILL_MASK" | "CLASSIFICATION" | "REGRESSION" | "OTHER". Specify "OTHER" if none of the tasks listed fit your use case.
|
|
4401
4431
|
*/
|
|
4402
4432
|
Task?: String;
|
|
4403
4433
|
/**
|
|
@@ -4492,11 +4522,11 @@ declare namespace SageMaker {
|
|
|
4492
4522
|
*/
|
|
4493
4523
|
SecurityGroupIds?: SecurityGroupIds;
|
|
4494
4524
|
/**
|
|
4495
|
-
* When you send any requests to Amazon Web Services resources from the notebook instance,
|
|
4525
|
+
* When you send any requests to Amazon Web Services resources from the notebook instance, SageMaker assumes this role to perform tasks on your behalf. You must grant this role necessary permissions so SageMaker can perform these tasks. The policy must allow the SageMaker service principal (sagemaker.amazonaws.com) permissions to assume this role. For more information, see SageMaker Roles. To be able to pass this role to SageMaker, the caller of this API must have the iam:PassRole permission.
|
|
4496
4526
|
*/
|
|
4497
4527
|
RoleArn: RoleArn;
|
|
4498
4528
|
/**
|
|
4499
|
-
* The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that
|
|
4529
|
+
* The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that SageMaker uses to encrypt data on the storage volume attached to your notebook instance. The KMS key you provide must be enabled. For information, see Enabling and Disabling Keys in the Amazon Web Services Key Management Service Developer Guide.
|
|
4500
4530
|
*/
|
|
4501
4531
|
KmsKeyId?: KmsKeyId;
|
|
4502
4532
|
/**
|
|
@@ -4508,7 +4538,7 @@ declare namespace SageMaker {
|
|
|
4508
4538
|
*/
|
|
4509
4539
|
LifecycleConfigName?: NotebookInstanceLifecycleConfigName;
|
|
4510
4540
|
/**
|
|
4511
|
-
* Sets whether
|
|
4541
|
+
* Sets whether SageMaker provides internet access to the notebook instance. If you set this to Disabled this notebook instance is able to access resources only in your VPC, and is not be able to connect to SageMaker training and endpoint services unless you configure a NAT Gateway in your VPC. For more information, see Notebook Instances Are Internet-Enabled by Default. You can set the value of this parameter to Disabled only if you set a value for the SubnetId parameter.
|
|
4512
4542
|
*/
|
|
4513
4543
|
DirectInternetAccess?: DirectInternetAccess;
|
|
4514
4544
|
/**
|
|
@@ -4520,11 +4550,11 @@ declare namespace SageMaker {
|
|
|
4520
4550
|
*/
|
|
4521
4551
|
AcceleratorTypes?: NotebookInstanceAcceleratorTypes;
|
|
4522
4552
|
/**
|
|
4523
|
-
* A Git repository to associate with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in Amazon Web Services CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git Repositories with
|
|
4553
|
+
* A Git repository to associate with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in Amazon Web Services CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git Repositories with SageMaker Notebook Instances.
|
|
4524
4554
|
*/
|
|
4525
4555
|
DefaultCodeRepository?: CodeRepositoryNameOrUrl;
|
|
4526
4556
|
/**
|
|
4527
|
-
* An array of up to three Git repositories to associate with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in Amazon Web Services CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with
|
|
4557
|
+
* An array of up to three Git repositories to associate with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in Amazon Web Services CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with SageMaker Notebook Instances.
|
|
4528
4558
|
*/
|
|
4529
4559
|
AdditionalCodeRepositories?: AdditionalCodeRepositoryNamesOrUrls;
|
|
4530
4560
|
/**
|
|
@@ -4535,6 +4565,10 @@ declare namespace SageMaker {
|
|
|
4535
4565
|
* The platform identifier of the notebook instance runtime environment.
|
|
4536
4566
|
*/
|
|
4537
4567
|
PlatformIdentifier?: PlatformIdentifier;
|
|
4568
|
+
/**
|
|
4569
|
+
* Information on the IMDS configuration of the notebook instance
|
|
4570
|
+
*/
|
|
4571
|
+
InstanceMetadataServiceConfiguration?: InstanceMetadataServiceConfiguration;
|
|
4538
4572
|
}
|
|
4539
4573
|
export interface CreateNotebookInstanceLifecycleConfigInput {
|
|
4540
4574
|
/**
|
|
@@ -4753,27 +4787,27 @@ declare namespace SageMaker {
|
|
|
4753
4787
|
*/
|
|
4754
4788
|
TrainingJobName: TrainingJobName;
|
|
4755
4789
|
/**
|
|
4756
|
-
* Algorithm-specific parameters that influence the quality of the model. You set hyperparameters before you start the learning process. For a list of hyperparameters for each training algorithm provided by
|
|
4790
|
+
* Algorithm-specific parameters that influence the quality of the model. You set hyperparameters before you start the learning process. For a list of hyperparameters for each training algorithm provided by SageMaker, see Algorithms. You can specify a maximum of 100 hyperparameters. Each hyperparameter is a key-value pair. Each key and value is limited to 256 characters, as specified by the Length Constraint.
|
|
4757
4791
|
*/
|
|
4758
4792
|
HyperParameters?: HyperParameters;
|
|
4759
4793
|
/**
|
|
4760
|
-
* The registry path of the Docker image that contains the training algorithm and algorithm-specific metadata, including the input mode. For more information about algorithms provided by
|
|
4794
|
+
* The registry path of the Docker image that contains the training algorithm and algorithm-specific metadata, including the input mode. For more information about algorithms provided by SageMaker, see Algorithms. For information about providing your own algorithms, see Using Your Own Algorithms with Amazon SageMaker.
|
|
4761
4795
|
*/
|
|
4762
4796
|
AlgorithmSpecification: AlgorithmSpecification;
|
|
4763
4797
|
/**
|
|
4764
|
-
* The Amazon Resource Name (ARN) of an IAM role that
|
|
4798
|
+
* The Amazon Resource Name (ARN) of an IAM role that SageMaker can assume to perform tasks on your behalf. During model training, SageMaker needs your permission to read input data from an S3 bucket, download a Docker image that contains training code, write model artifacts to an S3 bucket, write logs to Amazon CloudWatch Logs, and publish metrics to Amazon CloudWatch. You grant permissions for all of these tasks to an IAM role. For more information, see SageMaker Roles. To be able to pass this role to SageMaker, the caller of this API must have the iam:PassRole permission.
|
|
4765
4799
|
*/
|
|
4766
4800
|
RoleArn: RoleArn;
|
|
4767
4801
|
/**
|
|
4768
|
-
* An array of Channel objects. Each channel is a named input source. InputDataConfig describes the input data and its location. Algorithms can accept input data from one or more channels. For example, an algorithm might have two channels of input data, training_data and validation_data. The configuration for each channel provides the S3, EFS, or FSx location where the input data is stored. It also provides information about the stored data: the MIME type, compression method, and whether the data is wrapped in RecordIO format. Depending on the input mode that the algorithm supports,
|
|
4802
|
+
* An array of Channel objects. Each channel is a named input source. InputDataConfig describes the input data and its location. Algorithms can accept input data from one or more channels. For example, an algorithm might have two channels of input data, training_data and validation_data. The configuration for each channel provides the S3, EFS, or FSx location where the input data is stored. It also provides information about the stored data: the MIME type, compression method, and whether the data is wrapped in RecordIO format. Depending on the input mode that the algorithm supports, SageMaker either copies input data files from an S3 bucket to a local directory in the Docker container, or makes it available as input streams. For example, if you specify an EFS location, input data files are available as input streams. They do not need to be downloaded.
|
|
4769
4803
|
*/
|
|
4770
4804
|
InputDataConfig?: InputDataConfig;
|
|
4771
4805
|
/**
|
|
4772
|
-
* Specifies the path to the S3 location where you want to store model artifacts.
|
|
4806
|
+
* Specifies the path to the S3 location where you want to store model artifacts. SageMaker creates subfolders for the artifacts.
|
|
4773
4807
|
*/
|
|
4774
4808
|
OutputDataConfig: OutputDataConfig;
|
|
4775
4809
|
/**
|
|
4776
|
-
* The resources, including the ML compute instances and ML storage volumes, to use for model training. ML storage volumes store model artifacts and incremental states. Training algorithms might also use ML storage volumes for scratch space. If you want
|
|
4810
|
+
* The resources, including the ML compute instances and ML storage volumes, to use for model training. ML storage volumes store model artifacts and incremental states. Training algorithms might also use ML storage volumes for scratch space. If you want SageMaker to use the ML storage volume to store the training data, choose File as the TrainingInputMode in the algorithm specification. For distributed training algorithms, specify an instance count greater than 1.
|
|
4777
4811
|
*/
|
|
4778
4812
|
ResourceConfig: ResourceConfig;
|
|
4779
4813
|
/**
|
|
@@ -4781,7 +4815,7 @@ declare namespace SageMaker {
|
|
|
4781
4815
|
*/
|
|
4782
4816
|
VpcConfig?: VpcConfig;
|
|
4783
4817
|
/**
|
|
4784
|
-
* Specifies a limit to how long a model training job can run. It also specifies how long a managed Spot training job has to complete. When the job reaches the time limit,
|
|
4818
|
+
* Specifies a limit to how long a model training job can run. It also specifies how long a managed Spot training job has to complete. When the job reaches the time limit, SageMaker ends the training job. Use this API to cap model training costs. To stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.
|
|
4785
4819
|
*/
|
|
4786
4820
|
StoppingCondition: StoppingCondition;
|
|
4787
4821
|
/**
|
|
@@ -4789,7 +4823,7 @@ declare namespace SageMaker {
|
|
|
4789
4823
|
*/
|
|
4790
4824
|
Tags?: TagList;
|
|
4791
4825
|
/**
|
|
4792
|
-
* Isolates the training container. No inbound or outbound network calls can be made, except for calls between peers within a training cluster for distributed training. If you enable network isolation for training jobs that are configured to use a VPC,
|
|
4826
|
+
* Isolates the training container. No inbound or outbound network calls can be made, except for calls between peers within a training cluster for distributed training. If you enable network isolation for training jobs that are configured to use a VPC, SageMaker downloads and uploads customer data and model artifacts through the specified VPC, but the training container does not have network access.
|
|
4793
4827
|
*/
|
|
4794
4828
|
EnableNetworkIsolation?: Boolean;
|
|
4795
4829
|
/**
|
|
@@ -4849,7 +4883,7 @@ declare namespace SageMaker {
|
|
|
4849
4883
|
*/
|
|
4850
4884
|
ModelClientConfig?: ModelClientConfig;
|
|
4851
4885
|
/**
|
|
4852
|
-
* The maximum allowed size of the payload, in MB. A payload is the data portion of a record (without metadata). The value in MaxPayloadInMB must be greater than, or equal to, the size of a single record. To estimate the size of a record in MB, divide the size of your dataset by the number of records. To ensure that the records fit within the maximum payload size, we recommend using a slightly larger value. The default value is 6 MB. For cases where the payload might be arbitrarily large and is transmitted using HTTP chunked encoding, set the value to 0. This feature works only in supported algorithms. Currently, Amazon SageMaker built-in algorithms do not support HTTP chunked encoding.
|
|
4886
|
+
* The maximum allowed size of the payload, in MB. A payload is the data portion of a record (without metadata). The value in MaxPayloadInMB must be greater than, or equal to, the size of a single record. To estimate the size of a record in MB, divide the size of your dataset by the number of records. To ensure that the records fit within the maximum payload size, we recommend using a slightly larger value. The default value is 6 MB. The value of MaxPayloadInMB cannot be greater than 100 MB. If you specify the MaxConcurrentTransforms parameter, the value of (MaxConcurrentTransforms * MaxPayloadInMB) also cannot exceed 100 MB. For cases where the payload might be arbitrarily large and is transmitted using HTTP chunked encoding, set the value to 0. This feature works only in supported algorithms. Currently, Amazon SageMaker built-in algorithms do not support HTTP chunked encoding.
|
|
4853
4887
|
*/
|
|
4854
4888
|
MaxPayloadInMB?: MaxPayloadInMB;
|
|
4855
4889
|
/**
|
|
@@ -5071,49 +5105,49 @@ declare namespace SageMaker {
|
|
|
5071
5105
|
export type CustomerMetadataValue = string;
|
|
5072
5106
|
export interface DataCaptureConfig {
|
|
5073
5107
|
/**
|
|
5074
|
-
*
|
|
5108
|
+
* Whether data capture should be enabled or disabled (defaults to enabled).
|
|
5075
5109
|
*/
|
|
5076
5110
|
EnableCapture?: EnableCapture;
|
|
5077
5111
|
/**
|
|
5078
|
-
*
|
|
5112
|
+
* The percentage of requests SageMaker will capture. A lower value is recommended for Endpoints with high traffic.
|
|
5079
5113
|
*/
|
|
5080
5114
|
InitialSamplingPercentage: SamplingPercentage;
|
|
5081
5115
|
/**
|
|
5082
|
-
*
|
|
5116
|
+
* The Amazon S3 location used to capture the data.
|
|
5083
5117
|
*/
|
|
5084
5118
|
DestinationS3Uri: DestinationS3Uri;
|
|
5085
5119
|
/**
|
|
5086
|
-
*
|
|
5120
|
+
* The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint. The KmsKeyId can be any of the following formats: Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab Alias name: alias/ExampleAlias Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias
|
|
5087
5121
|
*/
|
|
5088
5122
|
KmsKeyId?: KmsKeyId;
|
|
5089
5123
|
/**
|
|
5090
|
-
*
|
|
5124
|
+
* Specifies data Model Monitor will capture. You can configure whether to collect only input, only output, or both
|
|
5091
5125
|
*/
|
|
5092
5126
|
CaptureOptions: CaptureOptionList;
|
|
5093
5127
|
/**
|
|
5094
|
-
*
|
|
5128
|
+
* Configuration specifying how to treat different headers. If no headers are specified SageMaker will by default base64 encode when capturing the data.
|
|
5095
5129
|
*/
|
|
5096
5130
|
CaptureContentTypeHeader?: CaptureContentTypeHeader;
|
|
5097
5131
|
}
|
|
5098
5132
|
export interface DataCaptureConfigSummary {
|
|
5099
5133
|
/**
|
|
5100
|
-
*
|
|
5134
|
+
* Whether data capture is enabled or disabled.
|
|
5101
5135
|
*/
|
|
5102
5136
|
EnableCapture: EnableCapture;
|
|
5103
5137
|
/**
|
|
5104
|
-
*
|
|
5138
|
+
* Whether data capture is currently functional.
|
|
5105
5139
|
*/
|
|
5106
5140
|
CaptureStatus: CaptureStatus;
|
|
5107
5141
|
/**
|
|
5108
|
-
*
|
|
5142
|
+
* The percentage of requests being captured by your Endpoint.
|
|
5109
5143
|
*/
|
|
5110
5144
|
CurrentSamplingPercentage: SamplingPercentage;
|
|
5111
5145
|
/**
|
|
5112
|
-
*
|
|
5146
|
+
* The Amazon S3 location being used to capture the data.
|
|
5113
5147
|
*/
|
|
5114
5148
|
DestinationS3Uri: DestinationS3Uri;
|
|
5115
5149
|
/**
|
|
5116
|
-
*
|
|
5150
|
+
* The KMS key being used to encrypt the data in Amazon S3.
|
|
5117
5151
|
*/
|
|
5118
5152
|
KmsKeyId: KmsKeyId;
|
|
5119
5153
|
}
|
|
@@ -5136,11 +5170,11 @@ declare namespace SageMaker {
|
|
|
5136
5170
|
export type DataInputConfig = string;
|
|
5137
5171
|
export interface DataProcessing {
|
|
5138
5172
|
/**
|
|
5139
|
-
* A JSONPath expression used to select a portion of the input data to pass to the algorithm. Use the InputFilter parameter to exclude fields, such as an ID column, from the input. If you want
|
|
5173
|
+
* A JSONPath expression used to select a portion of the input data to pass to the algorithm. Use the InputFilter parameter to exclude fields, such as an ID column, from the input. If you want SageMaker to pass the entire input dataset to the algorithm, accept the default value $. Examples: "$", "$[1:]", "$.features"
|
|
5140
5174
|
*/
|
|
5141
5175
|
InputFilter?: JsonPath;
|
|
5142
5176
|
/**
|
|
5143
|
-
* A JSONPath expression used to select a portion of the joined dataset to save in the output file for a batch transform job. If you want
|
|
5177
|
+
* A JSONPath expression used to select a portion of the joined dataset to save in the output file for a batch transform job. If you want SageMaker to store the entire input dataset in the output file, leave the default value, $. If you specify indexes that aren't within the dimension size of the joined dataset, you get an error. Examples: "$", "$[0,5:]", "$['id','SageMakerOutput']"
|
|
5144
5178
|
*/
|
|
5145
5179
|
OutputFilter?: JsonPath;
|
|
5146
5180
|
/**
|
|
@@ -5520,7 +5554,7 @@ declare namespace SageMaker {
|
|
|
5520
5554
|
}
|
|
5521
5555
|
export interface DeleteNotebookInstanceInput {
|
|
5522
5556
|
/**
|
|
5523
|
-
* The name of the
|
|
5557
|
+
* The name of the SageMaker notebook instance to delete.
|
|
5524
5558
|
*/
|
|
5525
5559
|
NotebookInstanceName: NotebookInstanceName;
|
|
5526
5560
|
}
|
|
@@ -5742,7 +5776,7 @@ declare namespace SageMaker {
|
|
|
5742
5776
|
*/
|
|
5743
5777
|
InferenceSpecification?: InferenceSpecification;
|
|
5744
5778
|
/**
|
|
5745
|
-
* Details about configurations for one or more training jobs that
|
|
5779
|
+
* Details about configurations for one or more training jobs that SageMaker runs to test the algorithm.
|
|
5746
5780
|
*/
|
|
5747
5781
|
ValidationSpecification?: AlgorithmValidationSpecification;
|
|
5748
5782
|
/**
|
|
@@ -6446,7 +6480,7 @@ declare namespace SageMaker {
|
|
|
6446
6480
|
}
|
|
6447
6481
|
export interface DescribeEndpointConfigOutput {
|
|
6448
6482
|
/**
|
|
6449
|
-
* Name of the
|
|
6483
|
+
* Name of the SageMaker endpoint configuration.
|
|
6450
6484
|
*/
|
|
6451
6485
|
EndpointConfigName: EndpointConfigName;
|
|
6452
6486
|
/**
|
|
@@ -6981,7 +7015,7 @@ declare namespace SageMaker {
|
|
|
6981
7015
|
*/
|
|
6982
7016
|
OutputConfig: LabelingJobOutputConfig;
|
|
6983
7017
|
/**
|
|
6984
|
-
* The Amazon Resource Name (ARN) that
|
|
7018
|
+
* The Amazon Resource Name (ARN) that SageMaker assumes to perform tasks on your behalf during data labeling.
|
|
6985
7019
|
*/
|
|
6986
7020
|
RoleArn: RoleArn;
|
|
6987
7021
|
/**
|
|
@@ -7137,7 +7171,7 @@ declare namespace SageMaker {
|
|
|
7137
7171
|
}
|
|
7138
7172
|
export interface DescribeModelOutput {
|
|
7139
7173
|
/**
|
|
7140
|
-
* Name of the
|
|
7174
|
+
* Name of the SageMaker model.
|
|
7141
7175
|
*/
|
|
7142
7176
|
ModelName: ModelName;
|
|
7143
7177
|
/**
|
|
@@ -7175,7 +7209,7 @@ declare namespace SageMaker {
|
|
|
7175
7209
|
}
|
|
7176
7210
|
export interface DescribeModelPackageGroupInput {
|
|
7177
7211
|
/**
|
|
7178
|
-
* The name of
|
|
7212
|
+
* The name of gthe model group to describe.
|
|
7179
7213
|
*/
|
|
7180
7214
|
ModelPackageGroupName: ArnOrName;
|
|
7181
7215
|
}
|
|
@@ -7268,7 +7302,7 @@ declare namespace SageMaker {
|
|
|
7268
7302
|
*/
|
|
7269
7303
|
ModelMetrics?: ModelMetrics;
|
|
7270
7304
|
/**
|
|
7271
|
-
* The last time the model package was modified.
|
|
7305
|
+
* The last time that the model package was modified.
|
|
7272
7306
|
*/
|
|
7273
7307
|
LastModifiedTime?: Timestamp;
|
|
7274
7308
|
LastModifiedBy?: UserContext;
|
|
@@ -7436,7 +7470,7 @@ declare namespace SageMaker {
|
|
|
7436
7470
|
*/
|
|
7437
7471
|
NotebookInstanceArn?: NotebookInstanceArn;
|
|
7438
7472
|
/**
|
|
7439
|
-
* The name of the
|
|
7473
|
+
* The name of the SageMaker notebook instance.
|
|
7440
7474
|
*/
|
|
7441
7475
|
NotebookInstanceName?: NotebookInstanceName;
|
|
7442
7476
|
/**
|
|
@@ -7468,11 +7502,11 @@ declare namespace SageMaker {
|
|
|
7468
7502
|
*/
|
|
7469
7503
|
RoleArn?: RoleArn;
|
|
7470
7504
|
/**
|
|
7471
|
-
* The Amazon Web Services KMS key ID
|
|
7505
|
+
* The Amazon Web Services KMS key ID SageMaker uses to encrypt data when storing it on the ML storage volume attached to the instance.
|
|
7472
7506
|
*/
|
|
7473
7507
|
KmsKeyId?: KmsKeyId;
|
|
7474
7508
|
/**
|
|
7475
|
-
* The network interface IDs that
|
|
7509
|
+
* The network interface IDs that SageMaker created at the time of creating the instance.
|
|
7476
7510
|
*/
|
|
7477
7511
|
NetworkInterfaceId?: NetworkInterfaceId;
|
|
7478
7512
|
/**
|
|
@@ -7488,7 +7522,7 @@ declare namespace SageMaker {
|
|
|
7488
7522
|
*/
|
|
7489
7523
|
NotebookInstanceLifecycleConfigName?: NotebookInstanceLifecycleConfigName;
|
|
7490
7524
|
/**
|
|
7491
|
-
* Describes whether
|
|
7525
|
+
* Describes whether SageMaker provides internet access to the notebook instance. If this value is set to Disabled, the notebook instance does not have internet access, and cannot connect to SageMaker training and endpoint services. For more information, see Notebook Instances Are Internet-Enabled by Default.
|
|
7492
7526
|
*/
|
|
7493
7527
|
DirectInternetAccess?: DirectInternetAccess;
|
|
7494
7528
|
/**
|
|
@@ -7500,11 +7534,11 @@ declare namespace SageMaker {
|
|
|
7500
7534
|
*/
|
|
7501
7535
|
AcceleratorTypes?: NotebookInstanceAcceleratorTypes;
|
|
7502
7536
|
/**
|
|
7503
|
-
* The Git repository associated with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in Amazon Web Services CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git Repositories with
|
|
7537
|
+
* The Git repository associated with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in Amazon Web Services CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git Repositories with SageMaker Notebook Instances.
|
|
7504
7538
|
*/
|
|
7505
7539
|
DefaultCodeRepository?: CodeRepositoryNameOrUrl;
|
|
7506
7540
|
/**
|
|
7507
|
-
* An array of up to three Git repositories associated with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in Amazon Web Services CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with
|
|
7541
|
+
* An array of up to three Git repositories associated with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in Amazon Web Services CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with SageMaker Notebook Instances.
|
|
7508
7542
|
*/
|
|
7509
7543
|
AdditionalCodeRepositories?: AdditionalCodeRepositoryNamesOrUrls;
|
|
7510
7544
|
/**
|
|
@@ -7515,6 +7549,10 @@ declare namespace SageMaker {
|
|
|
7515
7549
|
* The platform identifier of the notebook instance runtime environment.
|
|
7516
7550
|
*/
|
|
7517
7551
|
PlatformIdentifier?: PlatformIdentifier;
|
|
7552
|
+
/**
|
|
7553
|
+
* Information on the IMDS configuration of the notebook instance
|
|
7554
|
+
*/
|
|
7555
|
+
InstanceMetadataServiceConfiguration?: InstanceMetadataServiceConfiguration;
|
|
7518
7556
|
}
|
|
7519
7557
|
export interface DescribePipelineDefinitionForExecutionRequest {
|
|
7520
7558
|
/**
|
|
@@ -7835,7 +7873,7 @@ declare namespace SageMaker {
|
|
|
7835
7873
|
*/
|
|
7836
7874
|
TuningJobArn?: HyperParameterTuningJobArn;
|
|
7837
7875
|
/**
|
|
7838
|
-
* The Amazon Resource Name (ARN) of the
|
|
7876
|
+
* The Amazon Resource Name (ARN) of the SageMaker Ground Truth labeling job that created the transform or training job.
|
|
7839
7877
|
*/
|
|
7840
7878
|
LabelingJobArn?: LabelingJobArn;
|
|
7841
7879
|
/**
|
|
@@ -7847,11 +7885,11 @@ declare namespace SageMaker {
|
|
|
7847
7885
|
*/
|
|
7848
7886
|
ModelArtifacts: ModelArtifacts;
|
|
7849
7887
|
/**
|
|
7850
|
-
* The status of the training job.
|
|
7888
|
+
* The status of the training job. SageMaker provides the following training job statuses: InProgress - The training is in progress. Completed - The training job has completed. Failed - The training job has failed. To see the reason for the failure, see the FailureReason field in the response to a DescribeTrainingJobResponse call. Stopping - The training job is stopping. Stopped - The training job has stopped. For more detailed information, see SecondaryStatus.
|
|
7851
7889
|
*/
|
|
7852
7890
|
TrainingJobStatus: TrainingJobStatus;
|
|
7853
7891
|
/**
|
|
7854
|
-
* Provides detailed information about the state of the training job. For detailed information on the secondary status of the training job, see StatusMessage under SecondaryStatusTransition.
|
|
7892
|
+
* Provides detailed information about the state of the training job. For detailed information on the secondary status of the training job, see StatusMessage under SecondaryStatusTransition. SageMaker provides primary statuses and secondary statuses that apply to each of them: InProgress Starting - Starting the training job. Downloading - An optional stage for algorithms that support File training input mode. It indicates that data is being downloaded to the ML storage volumes. Training - Training is in progress. Interrupted - The job stopped because the managed spot training instances were interrupted. Uploading - Training is complete and the model artifacts are being uploaded to the S3 location. Completed Completed - The training job has completed. Failed Failed - The training job has failed. The reason for the failure is returned in the FailureReason field of DescribeTrainingJobResponse. Stopped MaxRuntimeExceeded - The job stopped because it exceeded the maximum allowed runtime. MaxWaitTimeExceeded - The job stopped because it exceeded the maximum allowed wait time. Stopped - The training job has stopped. Stopping Stopping - Stopping the training job. Valid values for SecondaryStatus are subject to change. We no longer support the following secondary statuses: LaunchingMLInstances PreparingTraining DownloadingTrainingImage
|
|
7855
7893
|
*/
|
|
7856
7894
|
SecondaryStatus: SecondaryStatus;
|
|
7857
7895
|
/**
|
|
@@ -7875,7 +7913,7 @@ declare namespace SageMaker {
|
|
|
7875
7913
|
*/
|
|
7876
7914
|
InputDataConfig?: InputDataConfig;
|
|
7877
7915
|
/**
|
|
7878
|
-
* The S3 path where model artifacts that you configured when creating the job are stored.
|
|
7916
|
+
* The S3 path where model artifacts that you configured when creating the job are stored. SageMaker creates subfolders for model artifacts.
|
|
7879
7917
|
*/
|
|
7880
7918
|
OutputDataConfig?: OutputDataConfig;
|
|
7881
7919
|
/**
|
|
@@ -7887,7 +7925,7 @@ declare namespace SageMaker {
|
|
|
7887
7925
|
*/
|
|
7888
7926
|
VpcConfig?: VpcConfig;
|
|
7889
7927
|
/**
|
|
7890
|
-
* Specifies a limit to how long a model training job can run. It also specifies how long a managed Spot training job has to complete. When the job reaches the time limit,
|
|
7928
|
+
* Specifies a limit to how long a model training job can run. It also specifies how long a managed Spot training job has to complete. When the job reaches the time limit, SageMaker ends the training job. Use this API to cap model training costs. To stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.
|
|
7891
7929
|
*/
|
|
7892
7930
|
StoppingCondition: StoppingCondition;
|
|
7893
7931
|
/**
|
|
@@ -7899,7 +7937,7 @@ declare namespace SageMaker {
|
|
|
7899
7937
|
*/
|
|
7900
7938
|
TrainingStartTime?: Timestamp;
|
|
7901
7939
|
/**
|
|
7902
|
-
* Indicates the time when the training job ends on training instances. You are billed for the time interval between the value of TrainingStartTime and this time. For successful jobs and stopped jobs, this is the time after model artifacts are uploaded. For failed jobs, this is the time when
|
|
7940
|
+
* Indicates the time when the training job ends on training instances. You are billed for the time interval between the value of TrainingStartTime and this time. For successful jobs and stopped jobs, this is the time after model artifacts are uploaded. For failed jobs, this is the time when SageMaker detects a job failure.
|
|
7903
7941
|
*/
|
|
7904
7942
|
TrainingEndTime?: Timestamp;
|
|
7905
7943
|
/**
|
|
@@ -7915,7 +7953,7 @@ declare namespace SageMaker {
|
|
|
7915
7953
|
*/
|
|
7916
7954
|
FinalMetricDataList?: FinalMetricDataList;
|
|
7917
7955
|
/**
|
|
7918
|
-
* If you want to allow inbound or outbound network calls, except for calls between peers within a training cluster for distributed training, choose True. If you enable network isolation for training jobs that are configured to use a VPC,
|
|
7956
|
+
* If you want to allow inbound or outbound network calls, except for calls between peers within a training cluster for distributed training, choose True. If you enable network isolation for training jobs that are configured to use a VPC, SageMaker downloads and uploads customer data and model artifacts through the specified VPC, but the training container does not have network access.
|
|
7919
7957
|
*/
|
|
7920
7958
|
EnableNetworkIsolation?: Boolean;
|
|
7921
7959
|
/**
|
|
@@ -7932,7 +7970,7 @@ declare namespace SageMaker {
|
|
|
7932
7970
|
*/
|
|
7933
7971
|
TrainingTimeInSeconds?: TrainingTimeInSeconds;
|
|
7934
7972
|
/**
|
|
7935
|
-
* The billable time in seconds. Billable time refers to the absolute wall-clock time. Multiply BillableTimeInSeconds by the number of instances (InstanceCount) in your training cluster to get the total compute time SageMaker
|
|
7973
|
+
* The billable time in seconds. Billable time refers to the absolute wall-clock time. Multiply BillableTimeInSeconds by the number of instances (InstanceCount) in your training cluster to get the total compute time SageMaker bills you if you run distributed training. The formula is as follows: BillableTimeInSeconds * InstanceCount . You can calculate the savings from using managed spot training using the formula (1 - BillableTimeInSeconds / TrainingTimeInSeconds) * 100. For example, if BillableTimeInSeconds is 100 and TrainingTimeInSeconds is 500, the savings is 80%.
|
|
7936
7974
|
*/
|
|
7937
7975
|
BillableTimeInSeconds?: BillableTimeInSeconds;
|
|
7938
7976
|
DebugHookConfig?: DebugHookConfig;
|
|
@@ -9427,7 +9465,7 @@ declare namespace SageMaker {
|
|
|
9427
9465
|
}
|
|
9428
9466
|
export interface HyperParameterAlgorithmSpecification {
|
|
9429
9467
|
/**
|
|
9430
|
-
* The registry path of the Docker image that contains the training algorithm. For information about Docker registry paths for built-in algorithms, see Algorithms Provided by Amazon SageMaker: Common Parameters.
|
|
9468
|
+
* The registry path of the Docker image that contains the training algorithm. For information about Docker registry paths for built-in algorithms, see Algorithms Provided by Amazon SageMaker: Common Parameters. SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.
|
|
9431
9469
|
*/
|
|
9432
9470
|
TrainingImage?: AlgorithmImage;
|
|
9433
9471
|
TrainingInputMode: TrainingInputMode;
|
|
@@ -9505,15 +9543,15 @@ declare namespace SageMaker {
|
|
|
9505
9543
|
*/
|
|
9506
9544
|
OutputDataConfig: OutputDataConfig;
|
|
9507
9545
|
/**
|
|
9508
|
-
* The resources, including the compute instances and storage volumes, to use for the training jobs that the tuning job launches. Storage volumes store model artifacts and incremental states. Training algorithms might also use storage volumes for scratch space. If you want
|
|
9546
|
+
* The resources, including the compute instances and storage volumes, to use for the training jobs that the tuning job launches. Storage volumes store model artifacts and incremental states. Training algorithms might also use storage volumes for scratch space. If you want SageMaker to use the storage volume to store the training data, choose File as the TrainingInputMode in the algorithm specification. For distributed training algorithms, specify an instance count greater than 1.
|
|
9509
9547
|
*/
|
|
9510
9548
|
ResourceConfig: ResourceConfig;
|
|
9511
9549
|
/**
|
|
9512
|
-
* Specifies a limit to how long a model hyperparameter training job can run. It also specifies how long a managed spot training job has to complete. When the job reaches the time limit,
|
|
9550
|
+
* Specifies a limit to how long a model hyperparameter training job can run. It also specifies how long a managed spot training job has to complete. When the job reaches the time limit, SageMaker ends the training job. Use this API to cap model training costs.
|
|
9513
9551
|
*/
|
|
9514
9552
|
StoppingCondition: StoppingCondition;
|
|
9515
9553
|
/**
|
|
9516
|
-
* Isolates the training container. No inbound or outbound network calls can be made, except for calls between peers within a training cluster for distributed training. If network isolation is used for training jobs that are configured to use a VPC,
|
|
9554
|
+
* Isolates the training container. No inbound or outbound network calls can be made, except for calls between peers within a training cluster for distributed training. If network isolation is used for training jobs that are configured to use a VPC, SageMaker downloads and uploads customer data and model artifacts through the specified VPC, but the training container does not have network access.
|
|
9517
9555
|
*/
|
|
9518
9556
|
EnableNetworkIsolation?: Boolean;
|
|
9519
9557
|
/**
|
|
@@ -9559,7 +9597,7 @@ declare namespace SageMaker {
|
|
|
9559
9597
|
*/
|
|
9560
9598
|
TrainingStartTime?: Timestamp;
|
|
9561
9599
|
/**
|
|
9562
|
-
* Specifies the time when the training job ends on training instances. You are billed for the time interval between the value of TrainingStartTime and this time. For successful jobs and stopped jobs, this is the time after model artifacts are uploaded. For failed jobs, this is the time when
|
|
9600
|
+
* Specifies the time when the training job ends on training instances. You are billed for the time interval between the value of TrainingStartTime and this time. For successful jobs and stopped jobs, this is the time after model artifacts are uploaded. For failed jobs, this is the time when SageMaker detects a job failure.
|
|
9563
9601
|
*/
|
|
9564
9602
|
TrainingEndTime?: Timestamp;
|
|
9565
9603
|
/**
|
|
@@ -9602,7 +9640,7 @@ declare namespace SageMaker {
|
|
|
9602
9640
|
*/
|
|
9603
9641
|
ParameterRanges?: ParameterRanges;
|
|
9604
9642
|
/**
|
|
9605
|
-
* Specifies whether to use early stopping for training jobs launched by the hyperparameter tuning job. This can be one of the following values (the default value is OFF): OFF Training jobs launched by the hyperparameter tuning job do not use early stopping. AUTO
|
|
9643
|
+
* Specifies whether to use early stopping for training jobs launched by the hyperparameter tuning job. This can be one of the following values (the default value is OFF): OFF Training jobs launched by the hyperparameter tuning job do not use early stopping. AUTO SageMaker stops training jobs launched by the hyperparameter tuning job when they are unlikely to perform better than previously completed training jobs. For more information, see Stop Training Jobs Early.
|
|
9606
9644
|
*/
|
|
9607
9645
|
TrainingJobEarlyStoppingType?: TrainingJobEarlyStoppingType;
|
|
9608
9646
|
/**
|
|
@@ -9890,6 +9928,12 @@ declare namespace SageMaker {
|
|
|
9890
9928
|
export type InputDataConfig = Channel[];
|
|
9891
9929
|
export type InputMode = "Pipe"|"File"|string;
|
|
9892
9930
|
export type InputModes = TrainingInputMode[];
|
|
9931
|
+
export interface InstanceMetadataServiceConfiguration {
|
|
9932
|
+
/**
|
|
9933
|
+
* Indicates the minimum IMDS version that the notebook instance supports. When passed as part of CreateNotebookInstance, if no value is selected, then it defaults to IMDSv1. This means that both IMDSv1 and IMDSv2 are supported. If passed as part of UpdateNotebookInstance, there is no default.
|
|
9934
|
+
*/
|
|
9935
|
+
MinimumInstanceMetadataServiceVersion: MinimumInstanceMetadataServiceVersion;
|
|
9936
|
+
}
|
|
9893
9937
|
export type InstanceType = "ml.t2.medium"|"ml.t2.large"|"ml.t2.xlarge"|"ml.t2.2xlarge"|"ml.t3.medium"|"ml.t3.large"|"ml.t3.xlarge"|"ml.t3.2xlarge"|"ml.m4.xlarge"|"ml.m4.2xlarge"|"ml.m4.4xlarge"|"ml.m4.10xlarge"|"ml.m4.16xlarge"|"ml.m5.xlarge"|"ml.m5.2xlarge"|"ml.m5.4xlarge"|"ml.m5.12xlarge"|"ml.m5.24xlarge"|"ml.m5d.large"|"ml.m5d.xlarge"|"ml.m5d.2xlarge"|"ml.m5d.4xlarge"|"ml.m5d.8xlarge"|"ml.m5d.12xlarge"|"ml.m5d.16xlarge"|"ml.m5d.24xlarge"|"ml.c4.xlarge"|"ml.c4.2xlarge"|"ml.c4.4xlarge"|"ml.c4.8xlarge"|"ml.c5.xlarge"|"ml.c5.2xlarge"|"ml.c5.4xlarge"|"ml.c5.9xlarge"|"ml.c5.18xlarge"|"ml.c5d.xlarge"|"ml.c5d.2xlarge"|"ml.c5d.4xlarge"|"ml.c5d.9xlarge"|"ml.c5d.18xlarge"|"ml.p2.xlarge"|"ml.p2.8xlarge"|"ml.p2.16xlarge"|"ml.p3.2xlarge"|"ml.p3.8xlarge"|"ml.p3.16xlarge"|"ml.p3dn.24xlarge"|"ml.g4dn.xlarge"|"ml.g4dn.2xlarge"|"ml.g4dn.4xlarge"|"ml.g4dn.8xlarge"|"ml.g4dn.12xlarge"|"ml.g4dn.16xlarge"|"ml.r5.large"|"ml.r5.xlarge"|"ml.r5.2xlarge"|"ml.r5.4xlarge"|"ml.r5.8xlarge"|"ml.r5.12xlarge"|"ml.r5.16xlarge"|"ml.r5.24xlarge"|"ml.g5.xlarge"|"ml.g5.2xlarge"|"ml.g5.4xlarge"|"ml.g5.8xlarge"|"ml.g5.16xlarge"|"ml.g5.12xlarge"|"ml.g5.24xlarge"|"ml.g5.48xlarge"|string;
|
|
9894
9938
|
export type Integer = number;
|
|
9895
9939
|
export interface IntegerParameterRange {
|
|
@@ -9906,7 +9950,7 @@ declare namespace SageMaker {
|
|
|
9906
9950
|
*/
|
|
9907
9951
|
MaxValue: ParameterValue;
|
|
9908
9952
|
/**
|
|
9909
|
-
* The scale that hyperparameter tuning uses to search the hyperparameter range. For information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values: Auto
|
|
9953
|
+
* The scale that hyperparameter tuning uses to search the hyperparameter range. For information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values: Auto SageMaker hyperparameter tuning chooses the best scale for the hyperparameter. Linear Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale. Logarithmic Hyperparameter tuning searches the values in the hyperparameter range by using a logarithmic scale. Logarithmic scaling works only for ranges that have only values greater than 0.
|
|
9910
9954
|
*/
|
|
9911
9955
|
ScalingType?: HyperParameterScalingType;
|
|
9912
9956
|
}
|
|
@@ -9934,18 +9978,18 @@ declare namespace SageMaker {
|
|
|
9934
9978
|
export type JsonPath = string;
|
|
9935
9979
|
export interface JupyterServerAppSettings {
|
|
9936
9980
|
/**
|
|
9937
|
-
* The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the JupyterServer app.
|
|
9981
|
+
* The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the JupyterServer app. If you use the LifecycleConfigArns parameter, then this parameter is also required.
|
|
9938
9982
|
*/
|
|
9939
9983
|
DefaultResourceSpec?: ResourceSpec;
|
|
9940
9984
|
/**
|
|
9941
|
-
* The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the JupyterServerApp.
|
|
9985
|
+
* The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the JupyterServerApp. If you use this parameter, the DefaultResourceSpec parameter is also required. To remove a Lifecycle Config, you must set LifecycleConfigArns to an empty list.
|
|
9942
9986
|
*/
|
|
9943
9987
|
LifecycleConfigArns?: LifecycleConfigArns;
|
|
9944
9988
|
}
|
|
9945
9989
|
export type KernelDisplayName = string;
|
|
9946
9990
|
export interface KernelGatewayAppSettings {
|
|
9947
9991
|
/**
|
|
9948
|
-
* The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the KernelGateway app.
|
|
9992
|
+
* The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the KernelGateway app. The Amazon SageMaker Studio UI does not use the default instance type value set here. The default instance type set here is used when Apps are created using the Amazon Web Services Command Line Interface or Amazon Web Services CloudFormation and the instance type parameter value is not passed.
|
|
9949
9993
|
*/
|
|
9950
9994
|
DefaultResourceSpec?: ResourceSpec;
|
|
9951
9995
|
/**
|
|
@@ -9953,7 +9997,7 @@ declare namespace SageMaker {
|
|
|
9953
9997
|
*/
|
|
9954
9998
|
CustomImages?: CustomImages;
|
|
9955
9999
|
/**
|
|
9956
|
-
* The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the the user profile or domain.
|
|
10000
|
+
* The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the the user profile or domain. To remove a Lifecycle Config, you must set LifecycleConfigArns to an empty list.
|
|
9957
10001
|
*/
|
|
9958
10002
|
LifecycleConfigArns?: LifecycleConfigArns;
|
|
9959
10003
|
}
|
|
@@ -10037,7 +10081,7 @@ declare namespace SageMaker {
|
|
|
10037
10081
|
export type LabelingJobArn = string;
|
|
10038
10082
|
export interface LabelingJobDataAttributes {
|
|
10039
10083
|
/**
|
|
10040
|
-
* Declares that your content is free of personally identifiable information or adult content.
|
|
10084
|
+
* Declares that your content is free of personally identifiable information or adult content. SageMaker may restrict the Amazon Mechanical Turk workers that can view your task based on this information.
|
|
10041
10085
|
*/
|
|
10042
10086
|
ContentClassifiers?: ContentClassifiers;
|
|
10043
10087
|
}
|
|
@@ -10095,7 +10139,7 @@ declare namespace SageMaker {
|
|
|
10095
10139
|
*/
|
|
10096
10140
|
OutputDatasetS3Uri: S3Uri;
|
|
10097
10141
|
/**
|
|
10098
|
-
* The Amazon Resource Name (ARN) for the most recent
|
|
10142
|
+
* The Amazon Resource Name (ARN) for the most recent SageMaker model trained as part of automated data labeling.
|
|
10099
10143
|
*/
|
|
10100
10144
|
FinalActiveLearningModelArn?: ModelArn;
|
|
10101
10145
|
}
|
|
@@ -10313,7 +10357,7 @@ declare namespace SageMaker {
|
|
|
10313
10357
|
*/
|
|
10314
10358
|
AlgorithmSummaryList: AlgorithmSummaryList;
|
|
10315
10359
|
/**
|
|
10316
|
-
* If the response is truncated,
|
|
10360
|
+
* If the response is truncated, SageMaker returns this token. To retrieve the next set of algorithms, use it in the subsequent request.
|
|
10317
10361
|
*/
|
|
10318
10362
|
NextToken?: NextToken;
|
|
10319
10363
|
}
|
|
@@ -10976,7 +11020,7 @@ declare namespace SageMaker {
|
|
|
10976
11020
|
*/
|
|
10977
11021
|
EndpointConfigs: EndpointConfigSummaryList;
|
|
10978
11022
|
/**
|
|
10979
|
-
* If the response is truncated,
|
|
11023
|
+
* If the response is truncated, SageMaker returns this token. To retrieve the next set of endpoint configurations, use it in the subsequent request
|
|
10980
11024
|
*/
|
|
10981
11025
|
NextToken?: PaginationToken;
|
|
10982
11026
|
}
|
|
@@ -11028,7 +11072,7 @@ declare namespace SageMaker {
|
|
|
11028
11072
|
*/
|
|
11029
11073
|
Endpoints: EndpointSummaryList;
|
|
11030
11074
|
/**
|
|
11031
|
-
* If the response is truncated,
|
|
11075
|
+
* If the response is truncated, SageMaker returns this token. To retrieve the next set of training jobs, use it in the subsequent request.
|
|
11032
11076
|
*/
|
|
11033
11077
|
NextToken?: PaginationToken;
|
|
11034
11078
|
}
|
|
@@ -11421,7 +11465,7 @@ declare namespace SageMaker {
|
|
|
11421
11465
|
*/
|
|
11422
11466
|
LabelingJobSummaryList: LabelingJobForWorkteamSummaryList;
|
|
11423
11467
|
/**
|
|
11424
|
-
* If the response is truncated,
|
|
11468
|
+
* If the response is truncated, SageMaker returns this token. To retrieve the next set of labeling jobs, use it in the subsequent request.
|
|
11425
11469
|
*/
|
|
11426
11470
|
NextToken?: NextToken;
|
|
11427
11471
|
}
|
|
@@ -11474,7 +11518,7 @@ declare namespace SageMaker {
|
|
|
11474
11518
|
*/
|
|
11475
11519
|
LabelingJobSummaryList?: LabelingJobSummaryList;
|
|
11476
11520
|
/**
|
|
11477
|
-
* If the response is truncated,
|
|
11521
|
+
* If the response is truncated, SageMaker returns this token. To retrieve the next set of labeling jobs, use it in the subsequent request.
|
|
11478
11522
|
*/
|
|
11479
11523
|
NextToken?: NextToken;
|
|
11480
11524
|
}
|
|
@@ -11716,7 +11760,7 @@ declare namespace SageMaker {
|
|
|
11716
11760
|
*/
|
|
11717
11761
|
ModelPackageSummaryList: ModelPackageSummaryList;
|
|
11718
11762
|
/**
|
|
11719
|
-
* If the response is truncated,
|
|
11763
|
+
* If the response is truncated, SageMaker returns this token. To retrieve the next set of model packages, use it in the subsequent request.
|
|
11720
11764
|
*/
|
|
11721
11765
|
NextToken?: NextToken;
|
|
11722
11766
|
}
|
|
@@ -11800,7 +11844,7 @@ declare namespace SageMaker {
|
|
|
11800
11844
|
*/
|
|
11801
11845
|
Models: ModelSummaryList;
|
|
11802
11846
|
/**
|
|
11803
|
-
* If the response is truncated,
|
|
11847
|
+
* If the response is truncated, SageMaker returns this token. To retrieve the next set of models, use it in the subsequent request.
|
|
11804
11848
|
*/
|
|
11805
11849
|
NextToken?: PaginationToken;
|
|
11806
11850
|
}
|
|
@@ -11980,7 +12024,7 @@ declare namespace SageMaker {
|
|
|
11980
12024
|
}
|
|
11981
12025
|
export interface ListNotebookInstanceLifecycleConfigsOutput {
|
|
11982
12026
|
/**
|
|
11983
|
-
* If the response is truncated,
|
|
12027
|
+
* If the response is truncated, SageMaker returns this token. To get the next set of lifecycle configurations, use it in the next request.
|
|
11984
12028
|
*/
|
|
11985
12029
|
NextToken?: NextToken;
|
|
11986
12030
|
/**
|
|
@@ -12044,7 +12088,7 @@ declare namespace SageMaker {
|
|
|
12044
12088
|
}
|
|
12045
12089
|
export interface ListNotebookInstancesOutput {
|
|
12046
12090
|
/**
|
|
12047
|
-
* If the response to the previous ListNotebookInstances request was truncated,
|
|
12091
|
+
* If the response to the previous ListNotebookInstances request was truncated, SageMaker returns this token. To retrieve the next set of notebook instances, use the token in the next request.
|
|
12048
12092
|
*/
|
|
12049
12093
|
NextToken?: NextToken;
|
|
12050
12094
|
/**
|
|
@@ -12358,7 +12402,7 @@ declare namespace SageMaker {
|
|
|
12358
12402
|
*/
|
|
12359
12403
|
ResourceArn: ResourceArn;
|
|
12360
12404
|
/**
|
|
12361
|
-
* If the response to the previous ListTags request is truncated,
|
|
12405
|
+
* If the response to the previous ListTags request is truncated, SageMaker returns this token. To retrieve the next set of tags, use it in the subsequent request.
|
|
12362
12406
|
*/
|
|
12363
12407
|
NextToken?: NextToken;
|
|
12364
12408
|
/**
|
|
@@ -12373,7 +12417,7 @@ declare namespace SageMaker {
|
|
|
12373
12417
|
*/
|
|
12374
12418
|
Tags?: TagList;
|
|
12375
12419
|
/**
|
|
12376
|
-
* If response is truncated,
|
|
12420
|
+
* If response is truncated, SageMaker includes a token in the response. You can use this token in your subsequent request to fetch next set of tokens.
|
|
12377
12421
|
*/
|
|
12378
12422
|
NextToken?: NextToken;
|
|
12379
12423
|
}
|
|
@@ -12461,7 +12505,7 @@ declare namespace SageMaker {
|
|
|
12461
12505
|
*/
|
|
12462
12506
|
TrainingJobSummaries: TrainingJobSummaries;
|
|
12463
12507
|
/**
|
|
12464
|
-
* If the response is truncated,
|
|
12508
|
+
* If the response is truncated, SageMaker returns this token. To retrieve the next set of training jobs, use it in the subsequent request.
|
|
12465
12509
|
*/
|
|
12466
12510
|
NextToken?: NextToken;
|
|
12467
12511
|
}
|
|
@@ -12791,6 +12835,10 @@ declare namespace SageMaker {
|
|
|
12791
12835
|
* The dataset split from which the AutoML job produced the metric.
|
|
12792
12836
|
*/
|
|
12793
12837
|
Set?: MetricSetSource;
|
|
12838
|
+
/**
|
|
12839
|
+
* The name of the standard metric. For definitions of the standard metrics, see Autopilot candidate metrics .
|
|
12840
|
+
*/
|
|
12841
|
+
StandardMetricName?: AutoMLMetricExtendedEnum;
|
|
12794
12842
|
}
|
|
12795
12843
|
export interface MetricDefinition {
|
|
12796
12844
|
/**
|
|
@@ -12821,6 +12869,7 @@ declare namespace SageMaker {
|
|
|
12821
12869
|
*/
|
|
12822
12870
|
S3Uri: S3Uri;
|
|
12823
12871
|
}
|
|
12872
|
+
export type MinimumInstanceMetadataServiceVersion = string;
|
|
12824
12873
|
export type ModelApprovalStatus = "Approved"|"Rejected"|"PendingManualApproval"|string;
|
|
12825
12874
|
export type ModelArn = string;
|
|
12826
12875
|
export interface ModelArtifacts {
|
|
@@ -12860,11 +12909,11 @@ declare namespace SageMaker {
|
|
|
12860
12909
|
export type ModelCacheSetting = "Enabled"|"Disabled"|string;
|
|
12861
12910
|
export interface ModelClientConfig {
|
|
12862
12911
|
/**
|
|
12863
|
-
* The timeout value in seconds for an invocation request.
|
|
12912
|
+
* The timeout value in seconds for an invocation request. The default value is 600.
|
|
12864
12913
|
*/
|
|
12865
12914
|
InvocationsTimeoutInSeconds?: InvocationsTimeoutInSeconds;
|
|
12866
12915
|
/**
|
|
12867
|
-
* The maximum number of retries when invocation requests are failing.
|
|
12916
|
+
* The maximum number of retries when invocation requests are failing. The default value is 3.
|
|
12868
12917
|
*/
|
|
12869
12918
|
InvocationsMaxRetries?: InvocationsMaxRetries;
|
|
12870
12919
|
}
|
|
@@ -13106,7 +13155,7 @@ declare namespace SageMaker {
|
|
|
13106
13155
|
*/
|
|
13107
13156
|
ContainerHostname?: ContainerHostname;
|
|
13108
13157
|
/**
|
|
13109
|
-
* The Amazon EC2 Container Registry (Amazon ECR) path where inference code is stored. If you are using your own custom algorithm instead of an algorithm provided by
|
|
13158
|
+
* The Amazon EC2 Container Registry (Amazon ECR) path where inference code is stored. If you are using your own custom algorithm instead of an algorithm provided by SageMaker, the inference code must meet SageMaker requirements. SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.
|
|
13110
13159
|
*/
|
|
13111
13160
|
Image: ContainerImage;
|
|
13112
13161
|
/**
|
|
@@ -13277,7 +13326,7 @@ declare namespace SageMaker {
|
|
|
13277
13326
|
*/
|
|
13278
13327
|
ValidationRole: RoleArn;
|
|
13279
13328
|
/**
|
|
13280
|
-
* An array of ModelPackageValidationProfile objects, each of which specifies a batch transform job that
|
|
13329
|
+
* An array of ModelPackageValidationProfile objects, each of which specifies a batch transform job that SageMaker runs to validate your model package.
|
|
13281
13330
|
*/
|
|
13282
13331
|
ValidationProfiles: ModelPackageValidationProfiles;
|
|
13283
13332
|
}
|
|
@@ -13799,7 +13848,7 @@ declare namespace SageMaker {
|
|
|
13799
13848
|
*/
|
|
13800
13849
|
NotebookInstanceStatus?: NotebookInstanceStatus;
|
|
13801
13850
|
/**
|
|
13802
|
-
* The URL that you use to connect to the Jupyter
|
|
13851
|
+
* The URL that you use to connect to the Jupyter notebook running in your notebook instance.
|
|
13803
13852
|
*/
|
|
13804
13853
|
Url?: NotebookInstanceUrl;
|
|
13805
13854
|
/**
|
|
@@ -13819,11 +13868,11 @@ declare namespace SageMaker {
|
|
|
13819
13868
|
*/
|
|
13820
13869
|
NotebookInstanceLifecycleConfigName?: NotebookInstanceLifecycleConfigName;
|
|
13821
13870
|
/**
|
|
13822
|
-
* The Git repository associated with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in Amazon Web Services CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git Repositories with
|
|
13871
|
+
* The Git repository associated with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in Amazon Web Services CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git Repositories with SageMaker Notebook Instances.
|
|
13823
13872
|
*/
|
|
13824
13873
|
DefaultCodeRepository?: CodeRepositoryNameOrUrl;
|
|
13825
13874
|
/**
|
|
13826
|
-
* An array of up to three Git repositories associated with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in Amazon Web Services CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with
|
|
13875
|
+
* An array of up to three Git repositories associated with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in Amazon Web Services CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with SageMaker Notebook Instances.
|
|
13827
13876
|
*/
|
|
13828
13877
|
AdditionalCodeRepositories?: AdditionalCodeRepositoryNamesOrUrls;
|
|
13829
13878
|
}
|
|
@@ -13996,11 +14045,11 @@ declare namespace SageMaker {
|
|
|
13996
14045
|
}
|
|
13997
14046
|
export interface OutputDataConfig {
|
|
13998
14047
|
/**
|
|
13999
|
-
* The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that
|
|
14048
|
+
* The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. The KmsKeyId can be any of the following formats: // KMS Key ID "1234abcd-12ab-34cd-56ef-1234567890ab" // Amazon Resource Name (ARN) of a KMS Key "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" // KMS Key Alias "alias/ExampleAlias" // Amazon Resource Name (ARN) of a KMS Key Alias "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias" If you use a KMS key ID or an alias of your KMS key, the SageMaker execution role must include permissions to call kms:Encrypt. If you don't provide a KMS key ID, SageMaker uses the default KMS key for Amazon S3 for your role's account. SageMaker uses server-side encryption with KMS-managed keys for OutputDataConfig. If you use a bucket policy with an s3:PutObject permission that only allows objects with server-side encryption, set the condition key of s3:x-amz-server-side-encryption to "aws:kms". For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide. The KMS key policy must grant permission to the IAM role that you specify in your CreateTrainingJob, CreateTransformJob, or CreateHyperParameterTuningJob requests. For more information, see Using Key Policies in Amazon Web Services KMS in the Amazon Web Services Key Management Service Developer Guide.
|
|
14000
14049
|
*/
|
|
14001
14050
|
KmsKeyId?: KmsKeyId;
|
|
14002
14051
|
/**
|
|
14003
|
-
* Identifies the S3 path where you want
|
|
14052
|
+
* Identifies the S3 path where you want SageMaker to store the model artifacts. For example, s3://bucket-name/key-name-prefix.
|
|
14004
14053
|
*/
|
|
14005
14054
|
S3OutputPath: S3Uri;
|
|
14006
14055
|
}
|
|
@@ -14136,11 +14185,11 @@ declare namespace SageMaker {
|
|
|
14136
14185
|
*/
|
|
14137
14186
|
VariantStatus?: ProductionVariantStatusList;
|
|
14138
14187
|
/**
|
|
14139
|
-
* The serverless configuration for the endpoint.
|
|
14188
|
+
* The serverless configuration for the endpoint.
|
|
14140
14189
|
*/
|
|
14141
14190
|
CurrentServerlessConfig?: ProductionVariantServerlessConfig;
|
|
14142
14191
|
/**
|
|
14143
|
-
* The serverless configuration requested for this deployment, as specified in the endpoint configuration for the endpoint.
|
|
14192
|
+
* The serverless configuration requested for this deployment, as specified in the endpoint configuration for the endpoint.
|
|
14144
14193
|
*/
|
|
14145
14194
|
DesiredServerlessConfig?: ProductionVariantServerlessConfig;
|
|
14146
14195
|
}
|
|
@@ -14737,7 +14786,7 @@ declare namespace SageMaker {
|
|
|
14737
14786
|
*/
|
|
14738
14787
|
CoreDumpConfig?: ProductionVariantCoreDumpConfig;
|
|
14739
14788
|
/**
|
|
14740
|
-
* The serverless configuration for an endpoint. Specifies a serverless endpoint configuration instead of an instance-based endpoint configuration.
|
|
14789
|
+
* The serverless configuration for an endpoint. Specifies a serverless endpoint configuration instead of an instance-based endpoint configuration.
|
|
14741
14790
|
*/
|
|
14742
14791
|
ServerlessConfig?: ProductionVariantServerlessConfig;
|
|
14743
14792
|
}
|
|
@@ -14748,7 +14797,7 @@ declare namespace SageMaker {
|
|
|
14748
14797
|
*/
|
|
14749
14798
|
DestinationS3Uri: DestinationS3Uri;
|
|
14750
14799
|
/**
|
|
14751
|
-
* The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that
|
|
14800
|
+
* The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that SageMaker uses to encrypt the core dump data at rest using Amazon S3 server-side encryption. The KmsKeyId can be any of the following formats: // KMS Key ID "1234abcd-12ab-34cd-56ef-1234567890ab" // Amazon Resource Name (ARN) of a KMS Key "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" // KMS Key Alias "alias/ExampleAlias" // Amazon Resource Name (ARN) of a KMS Key Alias "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias" If you use a KMS key ID or an alias of your KMS key, the SageMaker execution role must include permissions to call kms:Encrypt. If you don't provide a KMS key ID, SageMaker uses the default KMS key for Amazon S3 for your role's account. SageMaker uses server-side encryption with KMS-managed keys for OutputDataConfig. If you use a bucket policy with an s3:PutObject permission that only allows objects with server-side encryption, set the condition key of s3:x-amz-server-side-encryption to "aws:kms". For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide. The KMS key policy must grant permission to the IAM role that you specify in your CreateEndpoint and UpdateEndpoint requests. For more information, see Using Key Policies in Amazon Web Services KMS in the Amazon Web Services Key Management Service Developer Guide.
|
|
14752
14801
|
*/
|
|
14753
14802
|
KmsKeyId?: KmsKeyId;
|
|
14754
14803
|
}
|
|
@@ -14809,11 +14858,11 @@ declare namespace SageMaker {
|
|
|
14809
14858
|
*/
|
|
14810
14859
|
VariantStatus?: ProductionVariantStatusList;
|
|
14811
14860
|
/**
|
|
14812
|
-
* The serverless configuration for the endpoint.
|
|
14861
|
+
* The serverless configuration for the endpoint.
|
|
14813
14862
|
*/
|
|
14814
14863
|
CurrentServerlessConfig?: ProductionVariantServerlessConfig;
|
|
14815
14864
|
/**
|
|
14816
|
-
* The serverless configuration requested for the endpoint update.
|
|
14865
|
+
* The serverless configuration requested for the endpoint update.
|
|
14817
14866
|
*/
|
|
14818
14867
|
DesiredServerlessConfig?: ProductionVariantServerlessConfig;
|
|
14819
14868
|
}
|
|
@@ -15099,7 +15148,7 @@ declare namespace SageMaker {
|
|
|
15099
15148
|
*/
|
|
15100
15149
|
ModifiedAfter?: Timestamp;
|
|
15101
15150
|
/**
|
|
15102
|
-
* Filter the lineage entities connected to the StartArn(s) by a set if property key value pairs. If multiple pairs are provided, an entity
|
|
15151
|
+
* Filter the lineage entities connected to the StartArn(s) by a set if property key value pairs. If multiple pairs are provided, an entity is included in the results if it matches any of the provided pairs.
|
|
15103
15152
|
*/
|
|
15104
15153
|
Properties?: QueryProperties;
|
|
15105
15154
|
}
|
|
@@ -15111,11 +15160,11 @@ declare namespace SageMaker {
|
|
|
15111
15160
|
*/
|
|
15112
15161
|
StartArns: QueryLineageStartArns;
|
|
15113
15162
|
/**
|
|
15114
|
-
* Associations between lineage entities
|
|
15163
|
+
* Associations between lineage entities have a direction. This parameter determines the direction from the StartArn(s) that the query traverses.
|
|
15115
15164
|
*/
|
|
15116
15165
|
Direction?: Direction;
|
|
15117
15166
|
/**
|
|
15118
|
-
* Setting this value to True
|
|
15167
|
+
* Setting this value to True retrieves not only the entities of interest but also the Associations and lineage entities on the path. Set to False to only return lineage entities that match your query.
|
|
15119
15168
|
*/
|
|
15120
15169
|
IncludeEdges?: Boolean;
|
|
15121
15170
|
/**
|
|
@@ -15123,7 +15172,7 @@ declare namespace SageMaker {
|
|
|
15123
15172
|
*/
|
|
15124
15173
|
Filters?: QueryFilters;
|
|
15125
15174
|
/**
|
|
15126
|
-
* The maximum depth in lineage relationships from the StartArns that
|
|
15175
|
+
* The maximum depth in lineage relationships from the StartArns that are traversed. Depth is a measure of the number of Associations from the StartArn entity to the matched results.
|
|
15127
15176
|
*/
|
|
15128
15177
|
MaxDepth?: QueryLineageMaxDepth;
|
|
15129
15178
|
/**
|
|
@@ -15154,6 +15203,11 @@ declare namespace SageMaker {
|
|
|
15154
15203
|
export type QueryProperties = {[key: string]: String256};
|
|
15155
15204
|
export type QueryTypes = String40[];
|
|
15156
15205
|
export interface RSessionAppSettings {
|
|
15206
|
+
DefaultResourceSpec?: ResourceSpec;
|
|
15207
|
+
/**
|
|
15208
|
+
* A list of custom SageMaker images that are configured to run as a RSession app.
|
|
15209
|
+
*/
|
|
15210
|
+
CustomImages?: CustomImages;
|
|
15157
15211
|
}
|
|
15158
15212
|
export type RStudioServerProAccessStatus = "ENABLED"|"DISABLED"|string;
|
|
15159
15213
|
export interface RStudioServerProAppSettings {
|
|
@@ -15191,6 +15245,12 @@ declare namespace SageMaker {
|
|
|
15191
15245
|
export type RStudioServerProUserGroup = "R_STUDIO_ADMIN"|"R_STUDIO_USER"|string;
|
|
15192
15246
|
export type RealtimeInferenceInstanceTypes = ProductionVariantInstanceType[];
|
|
15193
15247
|
export type RecommendationJobArn = string;
|
|
15248
|
+
export interface RecommendationJobCompiledOutputConfig {
|
|
15249
|
+
/**
|
|
15250
|
+
* Identifies the Amazon S3 bucket where you want SageMaker to store the compiled model artifacts.
|
|
15251
|
+
*/
|
|
15252
|
+
S3OutputUri?: S3Uri;
|
|
15253
|
+
}
|
|
15194
15254
|
export type RecommendationJobDescription = string;
|
|
15195
15255
|
export interface RecommendationJobInputConfig {
|
|
15196
15256
|
/**
|
|
@@ -15213,8 +15273,22 @@ declare namespace SageMaker {
|
|
|
15213
15273
|
* Specifies the endpoint configuration to use for a job.
|
|
15214
15274
|
*/
|
|
15215
15275
|
EndpointConfigurations?: EndpointInputConfigurations;
|
|
15276
|
+
/**
|
|
15277
|
+
* The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint. This key will be passed to SageMaker Hosting for endpoint creation. The SageMaker execution role must have kms:CreateGrant permission in order to encrypt data on the storage volume of the endpoints created for inference recommendation. The inference recommendation job will fail asynchronously during endpoint configuration creation if the role passed does not have kms:CreateGrant permission. The KmsKeyId can be any of the following formats: // KMS Key ID "1234abcd-12ab-34cd-56ef-1234567890ab" // Amazon Resource Name (ARN) of a KMS Key "arn:aws:kms:<region>:<account>:key/<key-id-12ab-34cd-56ef-1234567890ab>" // KMS Key Alias "alias/ExampleAlias" // Amazon Resource Name (ARN) of a KMS Key Alias "arn:aws:kms:<region>:<account>:alias/<ExampleAlias>" For more information about key identifiers, see Key identifiers (KeyID) in the Amazon Web Services Key Management Service (Amazon Web Services KMS) documentation.
|
|
15278
|
+
*/
|
|
15279
|
+
VolumeKmsKeyId?: KmsKeyId;
|
|
15216
15280
|
}
|
|
15217
15281
|
export type RecommendationJobName = string;
|
|
15282
|
+
export interface RecommendationJobOutputConfig {
|
|
15283
|
+
/**
|
|
15284
|
+
* The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt your output artifacts with Amazon S3 server-side encryption. The SageMaker execution role must have kms:GenerateDataKey permission. The KmsKeyId can be any of the following formats: // KMS Key ID "1234abcd-12ab-34cd-56ef-1234567890ab" // Amazon Resource Name (ARN) of a KMS Key "arn:aws:kms:<region>:<account>:key/<key-id-12ab-34cd-56ef-1234567890ab>" // KMS Key Alias "alias/ExampleAlias" // Amazon Resource Name (ARN) of a KMS Key Alias "arn:aws:kms:<region>:<account>:alias/<ExampleAlias>" For more information about key identifiers, see Key identifiers (KeyID) in the Amazon Web Services Key Management Service (Amazon Web Services KMS) documentation.
|
|
15285
|
+
*/
|
|
15286
|
+
KmsKeyId?: KmsKeyId;
|
|
15287
|
+
/**
|
|
15288
|
+
* Provides information about the output configuration for the compiled model.
|
|
15289
|
+
*/
|
|
15290
|
+
CompiledOutputConfig?: RecommendationJobCompiledOutputConfig;
|
|
15291
|
+
}
|
|
15218
15292
|
export interface RecommendationJobResourceLimit {
|
|
15219
15293
|
/**
|
|
15220
15294
|
* Defines the maximum number of load tests.
|
|
@@ -15374,11 +15448,11 @@ declare namespace SageMaker {
|
|
|
15374
15448
|
*/
|
|
15375
15449
|
InstanceCount: TrainingInstanceCount;
|
|
15376
15450
|
/**
|
|
15377
|
-
* The size of the ML storage volume that you want to provision. ML storage volumes store model artifacts and incremental states. Training algorithms might also use the ML storage volume for scratch space. If you want to store the training data in the ML storage volume, choose File as the TrainingInputMode in the algorithm specification. You must specify sufficient ML storage for your scenario.
|
|
15451
|
+
* The size of the ML storage volume that you want to provision. ML storage volumes store model artifacts and incremental states. Training algorithms might also use the ML storage volume for scratch space. If you want to store the training data in the ML storage volume, choose File as the TrainingInputMode in the algorithm specification. You must specify sufficient ML storage for your scenario. SageMaker supports only the General Purpose SSD (gp2) ML storage volume type. Certain Nitro-based instances include local storage with a fixed total size, dependent on the instance type. When using these instances for training, SageMaker mounts the local instance storage instead of Amazon EBS gp2 storage. You can't request a VolumeSizeInGB greater than the total size of the local instance storage. For a list of instance types that support local instance storage, including the total size per instance type, see Instance Store Volumes.
|
|
15378
15452
|
*/
|
|
15379
15453
|
VolumeSizeInGB: VolumeSizeInGB;
|
|
15380
15454
|
/**
|
|
15381
|
-
* The Amazon Web Services KMS key that
|
|
15455
|
+
* The Amazon Web Services KMS key that SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the training job. Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can't request a VolumeKmsKeyId when using an instance type with local storage. For a list of instance types that support local instance storage, see Instance Store Volumes. For more information about local instance storage encryption, see SSD Instance Store Volumes. The VolumeKmsKeyId can be in any of the following formats: // KMS Key ID "1234abcd-12ab-34cd-56ef-1234567890ab" // Amazon Resource Name (ARN) of a KMS Key "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
|
|
15382
15456
|
*/
|
|
15383
15457
|
VolumeKmsKeyId?: KmsKeyId;
|
|
15384
15458
|
}
|
|
@@ -15405,7 +15479,7 @@ declare namespace SageMaker {
|
|
|
15405
15479
|
*/
|
|
15406
15480
|
SageMakerImageVersionArn?: ImageVersionArn;
|
|
15407
15481
|
/**
|
|
15408
|
-
* The instance type that the image version runs on.
|
|
15482
|
+
* The instance type that the image version runs on. JupyterServer Apps only support the system value. KernelGateway Apps do not support the system value, but support all other values for available instance types.
|
|
15409
15483
|
*/
|
|
15410
15484
|
InstanceType?: AppInstanceType;
|
|
15411
15485
|
/**
|
|
@@ -15457,15 +15531,15 @@ declare namespace SageMaker {
|
|
|
15457
15531
|
export type S3DataDistribution = "FullyReplicated"|"ShardedByS3Key"|string;
|
|
15458
15532
|
export interface S3DataSource {
|
|
15459
15533
|
/**
|
|
15460
|
-
* If you choose S3Prefix, S3Uri identifies a key name prefix.
|
|
15534
|
+
* If you choose S3Prefix, S3Uri identifies a key name prefix. SageMaker uses all objects that match the specified key name prefix for model training. If you choose ManifestFile, S3Uri identifies an object that is a manifest file containing a list of object keys that you want SageMaker to use for model training. If you choose AugmentedManifestFile, S3Uri identifies an object that is an augmented manifest file in JSON lines format. This file contains the data you want to use for model training. AugmentedManifestFile can only be used if the Channel's input mode is Pipe.
|
|
15461
15535
|
*/
|
|
15462
15536
|
S3DataType: S3DataType;
|
|
15463
15537
|
/**
|
|
15464
|
-
* Depending on the value specified for the S3DataType, identifies either a key name prefix or a manifest. For example: A key name prefix might look like this: s3://bucketname/exampleprefix A manifest might look like this: s3://bucketname/example.manifest A manifest is an S3 object which is a JSON file consisting of an array of elements. The first element is a prefix which is followed by one or more suffixes. SageMaker appends the suffix elements to the prefix to get a full set of S3Uri. Note that the prefix must be a valid non-empty S3Uri that precludes users from specifying a manifest whose individual S3Uri is sourced from different S3 buckets. The following code example shows a valid manifest format: [ {"prefix": "s3://customer_bucket/some/prefix/"}, "relative/path/to/custdata-1", "relative/path/custdata-2", ... "relative/path/custdata-N" ] This JSON is equivalent to the following S3Uri list: s3://customer_bucket/some/prefix/relative/path/to/custdata-1 s3://customer_bucket/some/prefix/relative/path/custdata-2 ... s3://customer_bucket/some/prefix/relative/path/custdata-N The complete set of S3Uri in this manifest is the input data for the channel for this data source. The object that each S3Uri points to must be readable by the IAM role that
|
|
15538
|
+
* Depending on the value specified for the S3DataType, identifies either a key name prefix or a manifest. For example: A key name prefix might look like this: s3://bucketname/exampleprefix A manifest might look like this: s3://bucketname/example.manifest A manifest is an S3 object which is a JSON file consisting of an array of elements. The first element is a prefix which is followed by one or more suffixes. SageMaker appends the suffix elements to the prefix to get a full set of S3Uri. Note that the prefix must be a valid non-empty S3Uri that precludes users from specifying a manifest whose individual S3Uri is sourced from different S3 buckets. The following code example shows a valid manifest format: [ {"prefix": "s3://customer_bucket/some/prefix/"}, "relative/path/to/custdata-1", "relative/path/custdata-2", ... "relative/path/custdata-N" ] This JSON is equivalent to the following S3Uri list: s3://customer_bucket/some/prefix/relative/path/to/custdata-1 s3://customer_bucket/some/prefix/relative/path/custdata-2 ... s3://customer_bucket/some/prefix/relative/path/custdata-N The complete set of S3Uri in this manifest is the input data for the channel for this data source. The object that each S3Uri points to must be readable by the IAM role that SageMaker uses to perform tasks on your behalf.
|
|
15465
15539
|
*/
|
|
15466
15540
|
S3Uri: S3Uri;
|
|
15467
15541
|
/**
|
|
15468
|
-
* If you want
|
|
15542
|
+
* If you want SageMaker to replicate the entire dataset on each ML compute instance that is launched for model training, specify FullyReplicated. If you want SageMaker to replicate a subset of data on each ML compute instance that is launched for model training, specify ShardedByS3Key. If there are n ML compute instances launched for a training job, each instance gets approximately 1/n of the number of S3 objects. In this case, model training on each machine uses only the subset of training data. Don't choose more ML compute instances for training than available S3 objects. If you do, some nodes won't get any data and you will pay for nodes that aren't getting any training data. This applies in both File and Pipe modes. Keep this in mind when developing algorithms. In distributed training, where you use multiple ML compute EC2 instances, you might choose ShardedByS3Key. If the algorithm requires copying training data to the ML storage volume (when TrainingInputMode is set to File), this copies 1/n of the number of objects.
|
|
15469
15543
|
*/
|
|
15470
15544
|
S3DataDistributionType?: S3DataDistribution;
|
|
15471
15545
|
/**
|
|
@@ -15599,7 +15673,7 @@ declare namespace SageMaker {
|
|
|
15599
15673
|
*/
|
|
15600
15674
|
EndTime?: Timestamp;
|
|
15601
15675
|
/**
|
|
15602
|
-
* A detailed description of the progress within a secondary status.
|
|
15676
|
+
* A detailed description of the progress within a secondary status. SageMaker provides secondary statuses and status messages that apply to each of them: Starting Starting the training job. Launching requested ML instances. Insufficient capacity error from EC2 while launching instances, retrying! Launched instance was unhealthy, replacing it! Preparing the instances for training. Training Downloading the training image. Training image download completed. Training in progress. Status messages are subject to change. Therefore, we recommend not including them in code that programmatically initiates actions. For examples, don't use status messages in if statements. To have an overview of your training job's progress, view TrainingJobStatus and SecondaryStatus in DescribeTrainingJob, and StatusMessage together. For example, at the start of a training job, you might see the following: TrainingJobStatus - InProgress SecondaryStatus - Training StatusMessage - Downloading the training image
|
|
15603
15677
|
*/
|
|
15604
15678
|
StatusMessage?: StatusMessage;
|
|
15605
15679
|
}
|
|
@@ -15730,7 +15804,7 @@ declare namespace SageMaker {
|
|
|
15730
15804
|
*/
|
|
15731
15805
|
ModelDataUrl?: Url;
|
|
15732
15806
|
/**
|
|
15733
|
-
* The name of an algorithm that was used to create the model package. The algorithm must be either an algorithm resource in your
|
|
15807
|
+
* The name of an algorithm that was used to create the model package. The algorithm must be either an algorithm resource in your SageMaker account or an algorithm in Amazon Web Services Marketplace that you are subscribed to.
|
|
15734
15808
|
*/
|
|
15735
15809
|
AlgorithmName: ArnOrName;
|
|
15736
15810
|
}
|
|
@@ -15885,11 +15959,11 @@ declare namespace SageMaker {
|
|
|
15885
15959
|
}
|
|
15886
15960
|
export interface StoppingCondition {
|
|
15887
15961
|
/**
|
|
15888
|
-
* The maximum length of time, in seconds, that a training or compilation job can run. For compilation jobs, if the job does not complete during this time,
|
|
15962
|
+
* The maximum length of time, in seconds, that a training or compilation job can run. For compilation jobs, if the job does not complete during this time, a TimeOut error is generated. We recommend starting with 900 seconds and increasing as necessary based on your model. For all other jobs, if the job does not complete during this time, SageMaker ends the job. When RetryStrategy is specified in the job request, MaxRuntimeInSeconds specifies the maximum time for all of the attempts in total, not each individual attempt. The default value is 1 day. The maximum value is 28 days.
|
|
15889
15963
|
*/
|
|
15890
15964
|
MaxRuntimeInSeconds?: MaxRuntimeInSeconds;
|
|
15891
15965
|
/**
|
|
15892
|
-
* The maximum length of time, in seconds, that a managed Spot training job has to complete. It is the amount of time spent waiting for Spot capacity plus the amount of time the job can run. It must be equal to or greater than MaxRuntimeInSeconds. If the job does not complete during this time,
|
|
15966
|
+
* The maximum length of time, in seconds, that a managed Spot training job has to complete. It is the amount of time spent waiting for Spot capacity plus the amount of time the job can run. It must be equal to or greater than MaxRuntimeInSeconds. If the job does not complete during this time, SageMaker ends the job. When RetryStrategy is specified in the job request, MaxWaitTimeInSeconds specifies the maximum time for all of the attempts in total, not each individual attempt.
|
|
15893
15967
|
*/
|
|
15894
15968
|
MaxWaitTimeInSeconds?: MaxWaitTimeInSeconds;
|
|
15895
15969
|
}
|
|
@@ -16098,7 +16172,7 @@ declare namespace SageMaker {
|
|
|
16098
16172
|
*/
|
|
16099
16173
|
TrainingJobStatus?: TrainingJobStatus;
|
|
16100
16174
|
/**
|
|
16101
|
-
* Provides detailed information about the state of the training job. For detailed information about the secondary status of the training job, see StatusMessage under SecondaryStatusTransition.
|
|
16175
|
+
* Provides detailed information about the state of the training job. For detailed information about the secondary status of the training job, see StatusMessage under SecondaryStatusTransition. SageMaker provides primary statuses and secondary statuses that apply to each of them: InProgress Starting - Starting the training job. Downloading - An optional stage for algorithms that support File training input mode. It indicates that data is being downloaded to the ML storage volumes. Training - Training is in progress. Uploading - Training is complete and the model artifacts are being uploaded to the S3 location. Completed Completed - The training job has completed. Failed Failed - The training job has failed. The reason for the failure is returned in the FailureReason field of DescribeTrainingJobResponse. Stopped MaxRuntimeExceeded - The job stopped because it exceeded the maximum allowed runtime. Stopped - The training job has stopped. Stopping Stopping - Stopping the training job. Valid values for SecondaryStatus are subject to change. We no longer support the following secondary statuses: LaunchingMLInstances PreparingTrainingStack DownloadingTrainingImage
|
|
16102
16176
|
*/
|
|
16103
16177
|
SecondaryStatus?: SecondaryStatus;
|
|
16104
16178
|
/**
|
|
@@ -16122,7 +16196,7 @@ declare namespace SageMaker {
|
|
|
16122
16196
|
*/
|
|
16123
16197
|
InputDataConfig?: InputDataConfig;
|
|
16124
16198
|
/**
|
|
16125
|
-
* The S3 path where model artifacts that you configured when creating the job are stored.
|
|
16199
|
+
* The S3 path where model artifacts that you configured when creating the job are stored. SageMaker creates subfolders for model artifacts.
|
|
16126
16200
|
*/
|
|
16127
16201
|
OutputDataConfig?: OutputDataConfig;
|
|
16128
16202
|
/**
|
|
@@ -16134,7 +16208,7 @@ declare namespace SageMaker {
|
|
|
16134
16208
|
*/
|
|
16135
16209
|
VpcConfig?: VpcConfig;
|
|
16136
16210
|
/**
|
|
16137
|
-
* Specifies a limit to how long a model training job can run. It also specifies how long a managed Spot training job has to complete. When the job reaches the time limit,
|
|
16211
|
+
* Specifies a limit to how long a model training job can run. It also specifies how long a managed Spot training job has to complete. When the job reaches the time limit, SageMaker ends the training job. Use this API to cap model training costs. To stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.
|
|
16138
16212
|
*/
|
|
16139
16213
|
StoppingCondition?: StoppingCondition;
|
|
16140
16214
|
/**
|
|
@@ -16146,7 +16220,7 @@ declare namespace SageMaker {
|
|
|
16146
16220
|
*/
|
|
16147
16221
|
TrainingStartTime?: Timestamp;
|
|
16148
16222
|
/**
|
|
16149
|
-
* Indicates the time when the training job ends on training instances. You are billed for the time interval between the value of TrainingStartTime and this time. For successful jobs and stopped jobs, this is the time after model artifacts are uploaded. For failed jobs, this is the time when
|
|
16223
|
+
* Indicates the time when the training job ends on training instances. You are billed for the time interval between the value of TrainingStartTime and this time. For successful jobs and stopped jobs, this is the time after model artifacts are uploaded. For failed jobs, this is the time when SageMaker detects a job failure.
|
|
16150
16224
|
*/
|
|
16151
16225
|
TrainingEndTime?: Timestamp;
|
|
16152
16226
|
/**
|
|
@@ -16218,7 +16292,7 @@ declare namespace SageMaker {
|
|
|
16218
16292
|
*/
|
|
16219
16293
|
InputDataConfig: InputDataConfig;
|
|
16220
16294
|
/**
|
|
16221
|
-
* the path to the S3 bucket where you want to store model artifacts.
|
|
16295
|
+
* the path to the S3 bucket where you want to store model artifacts. SageMaker creates subfolders for the artifacts.
|
|
16222
16296
|
*/
|
|
16223
16297
|
OutputDataConfig: OutputDataConfig;
|
|
16224
16298
|
/**
|
|
@@ -16226,7 +16300,7 @@ declare namespace SageMaker {
|
|
|
16226
16300
|
*/
|
|
16227
16301
|
ResourceConfig: ResourceConfig;
|
|
16228
16302
|
/**
|
|
16229
|
-
* Specifies a limit to how long a model training job can run. It also specifies how long a managed Spot training job has to complete. When the job reaches the time limit,
|
|
16303
|
+
* Specifies a limit to how long a model training job can run. It also specifies how long a managed Spot training job has to complete. When the job reaches the time limit, SageMaker ends the training job. Use this API to cap model training costs. To stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts.
|
|
16230
16304
|
*/
|
|
16231
16305
|
StoppingCondition: StoppingCondition;
|
|
16232
16306
|
}
|
|
@@ -17098,7 +17172,7 @@ declare namespace SageMaker {
|
|
|
17098
17172
|
}
|
|
17099
17173
|
export interface UpdateEndpointWeightsAndCapacitiesInput {
|
|
17100
17174
|
/**
|
|
17101
|
-
* The name of an existing
|
|
17175
|
+
* The name of an existing SageMaker endpoint.
|
|
17102
17176
|
*/
|
|
17103
17177
|
EndpointName: EndpointName;
|
|
17104
17178
|
/**
|
|
@@ -17218,7 +17292,7 @@ declare namespace SageMaker {
|
|
|
17218
17292
|
*/
|
|
17219
17293
|
InstanceType?: InstanceType;
|
|
17220
17294
|
/**
|
|
17221
|
-
* The Amazon Resource Name (ARN) of the IAM role that
|
|
17295
|
+
* The Amazon Resource Name (ARN) of the IAM role that SageMaker can assume to access the notebook instance. For more information, see SageMaker Roles. To be able to pass this role to SageMaker, the caller of this API must have the iam:PassRole permission.
|
|
17222
17296
|
*/
|
|
17223
17297
|
RoleArn?: RoleArn;
|
|
17224
17298
|
/**
|
|
@@ -17230,15 +17304,15 @@ declare namespace SageMaker {
|
|
|
17230
17304
|
*/
|
|
17231
17305
|
DisassociateLifecycleConfig?: DisassociateNotebookInstanceLifecycleConfig;
|
|
17232
17306
|
/**
|
|
17233
|
-
* The size, in GB, of the ML storage volume to attach to the notebook instance. The default value is 5 GB. ML storage volumes are encrypted, so
|
|
17307
|
+
* The size, in GB, of the ML storage volume to attach to the notebook instance. The default value is 5 GB. ML storage volumes are encrypted, so SageMaker can't determine the amount of available free space on the volume. Because of this, you can increase the volume size when you update a notebook instance, but you can't decrease the volume size. If you want to decrease the size of the ML storage volume in use, create a new notebook instance with the desired size.
|
|
17234
17308
|
*/
|
|
17235
17309
|
VolumeSizeInGB?: NotebookInstanceVolumeSizeInGB;
|
|
17236
17310
|
/**
|
|
17237
|
-
* The Git repository to associate with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in Amazon Web Services CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git Repositories with
|
|
17311
|
+
* The Git repository to associate with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in Amazon Web Services CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git Repositories with SageMaker Notebook Instances.
|
|
17238
17312
|
*/
|
|
17239
17313
|
DefaultCodeRepository?: CodeRepositoryNameOrUrl;
|
|
17240
17314
|
/**
|
|
17241
|
-
* An array of up to three Git repositories to associate with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in Amazon Web Services CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with
|
|
17315
|
+
* An array of up to three Git repositories to associate with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in Amazon Web Services CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with SageMaker Notebook Instances.
|
|
17242
17316
|
*/
|
|
17243
17317
|
AdditionalCodeRepositories?: AdditionalCodeRepositoryNamesOrUrls;
|
|
17244
17318
|
/**
|
|
@@ -17261,6 +17335,10 @@ declare namespace SageMaker {
|
|
|
17261
17335
|
* Whether root access is enabled or disabled for users of the notebook instance. The default value is Enabled. If you set this to Disabled, users don't have root access on the notebook instance, but lifecycle configuration scripts still run with root permissions.
|
|
17262
17336
|
*/
|
|
17263
17337
|
RootAccess?: RootAccess;
|
|
17338
|
+
/**
|
|
17339
|
+
* Information on the IMDS configuration of the notebook instance
|
|
17340
|
+
*/
|
|
17341
|
+
InstanceMetadataServiceConfiguration?: InstanceMetadataServiceConfiguration;
|
|
17264
17342
|
}
|
|
17265
17343
|
export interface UpdateNotebookInstanceLifecycleConfigInput {
|
|
17266
17344
|
/**
|
|
@@ -17592,6 +17670,7 @@ declare namespace SageMaker {
|
|
|
17592
17670
|
*/
|
|
17593
17671
|
RSessionAppSettings?: RSessionAppSettings;
|
|
17594
17672
|
}
|
|
17673
|
+
export type ValidationFraction = number;
|
|
17595
17674
|
export type VariantName = string;
|
|
17596
17675
|
export interface VariantProperty {
|
|
17597
17676
|
/**
|