You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: sample/sagemaker/2017-07-24/service-2.json
+48-1Lines changed: 48 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -887,7 +887,7 @@
887
887
{"shape":"ResourceLimitExceeded"},
888
888
{"shape":"ResourceNotFound"}
889
889
],
890
-
"documentation":"<p>Starts a transform job. A transform job uses a trained model to get inferences on a dataset and saves these results to an Amazon S3 location that you specify.</p> <p>To perform batch transformations, you create a transform job and use the data that you have readily available.</p> <p>In the request body, you provide the following:</p> <ul> <li> <p> <code>TransformJobName</code> - Identifies the transform job. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account.</p> </li> <li> <p> <code>ModelName</code> - Identifies the model to use. <code>ModelName</code> must be the name of an existing Amazon SageMaker model in the same Amazon Web Services Region and Amazon Web Services account. For information on creating a model, see <a href=\"https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateModel.html\">CreateModel</a>.</p> </li> <li> <p> <code>TransformInput</code> - Describes the dataset to be transformed and the Amazon S3 location where it is stored.</p> </li> <li> <p> <code>TransformOutput</code> - Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.</p> </li> <li> <p> <code>TransformResources</code> - Identifies the ML compute instances for the transform job.</p> </li> </ul> <p>For more information about how batch transformation works, see <a href=\"https://docs.aws.amazon.com/sagemaker/latest/dg/batch-transform.html\">Batch Transform</a>.</p>"
890
+
"documentation":"<p>Starts a transform job. A transform job uses a trained model to get inferences on a dataset and saves these results to an Amazon S3 location that you specify.</p> <p>To perform batch transformations, you create a transform job and use the data that you have readily available.</p> <p>In the request body, you provide the following:</p> <ul> <li> <p> <code>TransformJobName</code> - Identifies the transform job. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account.</p> </li> <li> <p> <code>ModelName</code> - Identifies the model to use. <code>ModelName</code> must be the name of an existing Amazon SageMaker model in the same Amazon Web Services Region and Amazon Web Services account. For information on creating a model, see <a href=\"https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateModel.html\">CreateModel</a>.</p> </li> <li> <p> <code>TransformInput</code> - Describes the dataset to be transformed and the Amazon S3 location where it is stored.</p> </li> <li> <p> <code>TransformOutput</code> - Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.</p> </li> <li> <p> <code>TransformResources</code> - Identifies the ML compute instances and AMI image versions for the transform job.</p> </li> </ul> <p>For more information about how batch transformation works, see <a href=\"https://docs.aws.amazon.com/sagemaker/latest/dg/batch-transform.html\">Batch Transform</a>.</p>"
891
891
},
892
892
"CreateTrial":{
893
893
"name":"CreateTrial",
@@ -9161,6 +9161,10 @@
9161
9161
"ResourceSpec":{
9162
9162
"shape":"ResourceSpec",
9163
9163
"documentation":"<p>The instance type and the Amazon Resource Name (ARN) of the SageMaker AI image created on the instance.</p> <note> <p>The value of <code>InstanceType</code> passed as part of the <code>ResourceSpec</code> in the <code>CreateApp</code> call overrides the value passed as part of the <code>ResourceSpec</code> configured for the user profile or the domain. If <code>InstanceType</code> is not specified in any of those three <code>ResourceSpec</code> values for a <code>KernelGateway</code> app, the <code>CreateApp</code> call fails with a request validation error.</p> </note>"
9164
+
},
9165
+
"RecoveryMode":{
9166
+
"shape":"Boolean",
9167
+
"documentation":"<p> Indicates whether the application is launched in recovery mode. </p>"
9164
9168
}
9165
9169
}
9166
9170
},
@@ -11193,6 +11197,10 @@
11193
11197
"OnStart":{
11194
11198
"shape":"NotebookInstanceLifecycleConfigList",
11195
11199
"documentation":"<p>A shell script that runs every time you start a notebook instance, including when you create the notebook instance. The shell script must be a base64-encoded string.</p>"
11200
+
},
11201
+
"Tags":{
11202
+
"shape":"TagList",
11203
+
"documentation":"<p>An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see <a href=\"https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html\">Tagging Amazon Web Services Resources</a>.</p>"
11196
11204
}
11197
11205
}
11198
11206
},
@@ -13888,6 +13896,10 @@
13888
13896
"shape":"AppStatus",
13889
13897
"documentation":"<p>The status.</p>"
13890
13898
},
13899
+
"RecoveryMode":{
13900
+
"shape":"Boolean",
13901
+
"documentation":"<p> Indicates whether the application is launched in recovery mode. </p>"
13902
+
},
13891
13903
"LastHealthCheckTimestamp":{
13892
13904
"shape":"Timestamp",
13893
13905
"documentation":"<p>The timestamp of the last health check.</p>"
@@ -35366,6 +35378,13 @@
35366
35378
},
35367
35379
"documentation":"<p>Metadata for a register model job step.</p>"
35368
35380
},
35381
+
"Relation":{
35382
+
"type":"string",
35383
+
"enum":[
35384
+
"EqualTo",
35385
+
"GreaterThanOrEqualTo"
35386
+
]
35387
+
},
35369
35388
"ReleaseNotes":{
35370
35389
"type":"string",
35371
35390
"max":255,
@@ -36455,6 +36474,10 @@
36455
36474
"NextToken":{
36456
36475
"shape":"NextToken",
36457
36476
"documentation":"<p>If the result of the previous <code>Search</code> request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request.</p>"
36477
+
},
36478
+
"TotalHits":{
36479
+
"shape":"TotalHits",
36480
+
"documentation":"<p>The total number of matching results.</p>"
36458
36481
}
36459
36482
}
36460
36483
},
@@ -38451,6 +38474,20 @@
38451
38474
"max":256,
38452
38475
"min":1
38453
38476
},
38477
+
"TotalHits":{
38478
+
"type":"structure",
38479
+
"members":{
38480
+
"Value":{
38481
+
"shape":"Long",
38482
+
"documentation":"<p>The total number of matching results. This value may be exact or an estimate, depending on the <code>Relation</code> field.</p>"
38483
+
},
38484
+
"Relation":{
38485
+
"shape":"Relation",
38486
+
"documentation":"<p>Indicates the relationship between the returned <code>Value</code> and the actual total number of matching results. Possible values are:</p> <ul> <li> <p> <code>EqualTo</code>: The <code>Value</code> is the exact count of matching results.</p> </li> <li> <p> <code>GreaterThanOrEqualTo</code>: The <code>Value</code> is a lower bound of the actual count of matching results.</p> </li> </ul>"
38487
+
}
38488
+
},
38489
+
"documentation":"<p>Represents the total number of matching results and indicates how accurate that count is.</p> <p>The <code>Value</code> field provides the count, which may be exact or estimated. The <code>Relation</code> field indicates whether it's an exact figure or a lower bound. This helps understand the full scope of search results, especially when dealing with large result sets.</p>"
38490
+
},
38454
38491
"TotalInstanceCount":{
38455
38492
"type":"integer",
38456
38493
"min":0
@@ -39388,6 +39425,12 @@
39388
39425
"type":"integer",
39389
39426
"min":1
39390
39427
},
39428
+
"TransformAmiVersion":{
39429
+
"type":"string",
39430
+
"max":63,
39431
+
"min":1,
39432
+
"pattern":"^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$"
39433
+
},
39391
39434
"TransformDataSource":{
39392
39435
"type":"structure",
39393
39436
"required":["S3DataSource"],
@@ -39780,6 +39823,10 @@
39780
39823
"VolumeKmsKeyId":{
39781
39824
"shape":"KmsKeyId",
39782
39825
"documentation":"<p>The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt model data on the storage volume attached to the ML compute instance(s) that run the batch transform job.</p> <note> <p>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 <code>VolumeKmsKeyId</code> when using an instance type with local storage.</p> <p>For a list of instance types that support local instance storage, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html#instance-store-volumes\">Instance Store Volumes</a>.</p> <p>For more information about local instance storage encryption, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ssd-instance-store.html\">SSD Instance Store Volumes</a>.</p> </note> <p> The <code>VolumeKmsKeyId</code> can be any of the following formats:</p> <ul> <li> <p>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Key ARN: <code>arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Alias name: <code>alias/ExampleAlias</code> </p> </li> <li> <p>Alias name ARN: <code>arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias</code> </p> </li> </ul>"
39826
+
},
39827
+
"TransformAmiVersion":{
39828
+
"shape":"TransformAmiVersion",
39829
+
"documentation":"<p>Specifies an option from a collection of preconfigured Amazon Machine Image (AMI) images. Each image is configured by Amazon Web Services with a set of software and driver versions.</p> <dl> <dt>al2-ami-sagemaker-batch-gpu-470</dt> <dd> <ul> <li> <p>Accelerator: GPU</p> </li> <li> <p>NVIDIA driver version: 470</p> </li> </ul> </dd> <dt>al2-ami-sagemaker-batch-gpu-535</dt> <dd> <ul> <li> <p>Accelerator: GPU</p> </li> <li> <p>NVIDIA driver version: 535</p> </li> </ul> </dd> </dl>"
39783
39830
}
39784
39831
},
39785
39832
"documentation":"<p>Describes the resources, including ML instance types and ML instance count, to use for transform job.</p>"
Copy file name to clipboardExpand all lines: src/sagemaker_core/main/resources.py
+12-1Lines changed: 12 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -974,6 +974,7 @@ class App(Base):
974
974
user_profile_name: The user profile name.
975
975
space_name: The name of the space. If this value is not set, then UserProfileName must be set.
976
976
status: The status.
977
+
recovery_mode: Indicates whether the application is launched in recovery mode.
977
978
last_health_check_timestamp: The timestamp of the last health check.
978
979
last_user_activity_timestamp: The timestamp of the last user's activity. LastUserActivityTimestamp is also updated when SageMaker AI performs health checks without user activity. As a result, this value is set to the same value as LastHealthCheckTimestamp.
979
980
creation_time: The creation time of the application. After an application has been shut down for 24 hours, SageMaker AI deletes all metadata for the application. To be considered an update and retain application metadata, applications must be restarted within 24 hours after the previous application has been shut down. After this time window, creation of an application is considered a new application rather than an update of the previous application.
space_name: The name of the space. If this value is not set, then UserProfileName must be set.
1039
1042
tags: Each tag consists of a key and an optional value. Tag keys must be unique per resource.
1040
1043
resource_spec: The instance type and the Amazon Resource Name (ARN) of the SageMaker AI image created on the instance. The value of InstanceType passed as part of the ResourceSpec in the CreateApp call overrides the value passed as part of the ResourceSpec configured for the user profile or the domain. If InstanceType is not specified in any of those three ResourceSpec values for a KernelGateway app, the CreateApp call fails with a request validation error.
1044
+
recovery_mode: Indicates whether the application is launched in recovery mode.
notebook_instance_lifecycle_config_name: The name of the lifecycle configuration.
22879
22885
on_create: A shell script that runs only once, when you create a notebook instance. The shell script must be a base64-encoded string.
22880
22886
on_start: A shell script that runs every time you start a notebook instance, including when you create the notebook instance. The shell script must be a base64-encoded string.
22887
+
tags: An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.
0 commit comments