Skip to content

Commit 53697e9

Browse files
author
AWS
committed
Amazon SageMaker Service Update: This release allows customers to describe one or more versioned model packages through BatchDescribeModelPackage, update project via UpdateProject, modify and read customer metadata properties using Create, Update and Describe ModelPackage and enables cross account registration of model packages.
1 parent 94cccd2 commit 53697e9

File tree

2 files changed

+236
-12
lines changed

2 files changed

+236
-12
lines changed

‎.changes/next-release/feature-AmazonSageMakerService-1eb131e.json

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"type": "feature",
3+
"category": "Amazon SageMaker Service",
4+
"contributor": "",
5+
"description": "This release allows customers to describe one or more versioned model packages through BatchDescribeModelPackage, update project via UpdateProject, modify and read customer metadata properties using Create, Update and Describe ModelPackage and enables cross account registration of model packages."
6+
}

‎services/sagemaker/src/main/resources/codegen-resources/service-2.json

+230-12
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,16 @@
5252
],
5353
"documentation":"<p>Associates a trial component with a trial. A trial component can be associated with multiple trials. To disassociate a trial component from a trial, call the <a>DisassociateTrialComponent</a> API.</p>"
5454
},
55+
"BatchDescribeModelPackage":{
56+
"name":"BatchDescribeModelPackage",
57+
"http":{
58+
"method":"POST",
59+
"requestUri":"/"
60+
},
61+
"input":{"shape":"BatchDescribeModelPackageInput"},
62+
"output":{"shape":"BatchDescribeModelPackageOutput"},
63+
"documentation":"<p>This action batch describes a list of versioned model packages</p>"
64+
},
5565
"CreateAction":{
5666
"name":"CreateAction",
5767
"http":{
@@ -1453,7 +1463,7 @@
14531463
},
14541464
"input":{"shape":"DescribeModelPackageInput"},
14551465
"output":{"shape":"DescribeModelPackageOutput"},
1456-
"documentation":"<p>Returns a description of the specified model package, which is used to create Amazon SageMaker models or list them on Amazon Web Services Marketplace.</p> <p>To create models in Amazon SageMaker, buyers can subscribe to model packages listed on Amazon Web Services Marketplace.</p>"
1466+
"documentation":"<p>Returns a description of the specified model package, which is used to create SageMaker models or list them on Amazon Web Services Marketplace.</p> <p>To create models in SageMaker, buyers can subscribe to model packages listed on Amazon Web Services Marketplace.</p>"
14571467
},
14581468
"DescribeModelPackageGroup":{
14591469
"name":"DescribeModelPackageGroup",
@@ -2820,6 +2830,16 @@
28202830
],
28212831
"documentation":"<p>Updates a pipeline execution.</p>"
28222832
},
2833+
"UpdateProject":{
2834+
"name":"UpdateProject",
2835+
"http":{
2836+
"method":"POST",
2837+
"requestUri":"/"
2838+
},
2839+
"input":{"shape":"UpdateProjectInput"},
2840+
"output":{"shape":"UpdateProjectOutput"},
2841+
"documentation":"<p>Updates a machine learning (ML) project that is created from a template that sets up an ML pipeline from training to deploying an approved model.</p> <note> <p>You must not update a project that is in use. If you update the <code>ServiceCatalogProvisioningUpdateDetails</code> of a project that is active or being created, or updated, you may lose resources already created by the project.</p> </note>"
2842+
},
28232843
"UpdateTrainingJob":{
28242844
"name":"UpdateTrainingJob",
28252845
"http":{
@@ -4256,6 +4276,94 @@
42564276
"AWS/Textract/AnalyzeDocument/Forms/V1"
42574277
]
42584278
},
4279+
"BatchDescribeModelPackageError":{
4280+
"type":"structure",
4281+
"required":[
4282+
"ErrorCode",
4283+
"ErrorResponse"
4284+
],
4285+
"members":{
4286+
"ErrorCode":{
4287+
"shape":"String",
4288+
"documentation":"<p/>"
4289+
},
4290+
"ErrorResponse":{
4291+
"shape":"String",
4292+
"documentation":"<p/>"
4293+
}
4294+
},
4295+
"documentation":"<p>The error code and error description associated with the resource.</p>"
4296+
},
4297+
"BatchDescribeModelPackageErrorMap":{
4298+
"type":"map",
4299+
"key":{"shape":"ModelPackageArn"},
4300+
"value":{"shape":"BatchDescribeModelPackageError"}
4301+
},
4302+
"BatchDescribeModelPackageInput":{
4303+
"type":"structure",
4304+
"required":["ModelPackageArnList"],
4305+
"members":{
4306+
"ModelPackageArnList":{
4307+
"shape":"ModelPackageArnList",
4308+
"documentation":"<p>The list of Amazon Resource Name (ARN) of the model package groups.</p>"
4309+
}
4310+
}
4311+
},
4312+
"BatchDescribeModelPackageOutput":{
4313+
"type":"structure",
4314+
"members":{
4315+
"ModelPackageSummaries":{
4316+
"shape":"ModelPackageSummaries",
4317+
"documentation":"<p>The summaries for the model package versions</p>"
4318+
},
4319+
"BatchDescribeModelPackageErrorMap":{
4320+
"shape":"BatchDescribeModelPackageErrorMap",
4321+
"documentation":"<p>A map of the resource and BatchDescribeModelPackageError objects reporting the error associated with describing the model package.</p>"
4322+
}
4323+
}
4324+
},
4325+
"BatchDescribeModelPackageSummary":{
4326+
"type":"structure",
4327+
"required":[
4328+
"ModelPackageGroupName",
4329+
"ModelPackageArn",
4330+
"CreationTime",
4331+
"InferenceSpecification",
4332+
"ModelPackageStatus"
4333+
],
4334+
"members":{
4335+
"ModelPackageGroupName":{
4336+
"shape":"EntityName",
4337+
"documentation":"<p>The group name for the model package</p>"
4338+
},
4339+
"ModelPackageVersion":{
4340+
"shape":"ModelPackageVersion",
4341+
"documentation":"<p>The version number of a versioned model.</p>"
4342+
},
4343+
"ModelPackageArn":{
4344+
"shape":"ModelPackageArn",
4345+
"documentation":"<p>The Amazon Resource Name (ARN) of the model package.</p>"
4346+
},
4347+
"ModelPackageDescription":{
4348+
"shape":"EntityDescription",
4349+
"documentation":"<p>The description of the model package.</p>"
4350+
},
4351+
"CreationTime":{
4352+
"shape":"CreationTime",
4353+
"documentation":"<p>The creation time of the mortgage package summary.</p>"
4354+
},
4355+
"InferenceSpecification":{"shape":"InferenceSpecification"},
4356+
"ModelPackageStatus":{
4357+
"shape":"ModelPackageStatus",
4358+
"documentation":"<p>The status of the mortgage package.</p>"
4359+
},
4360+
"ModelApprovalStatus":{
4361+
"shape":"ModelApprovalStatus",
4362+
"documentation":"<p>The approval status of the model.</p>"
4363+
}
4364+
},
4365+
"documentation":"<p>Provides summary information about the model package.</p>"
4366+
},
42594367
"BatchStrategy":{
42604368
"type":"string",
42614369
"enum":[
@@ -6370,8 +6478,8 @@
63706478
"documentation":"<p>The name of the model package. The name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).</p> <p>This parameter is required for unversioned models. It is not applicable to versioned models.</p>"
63716479
},
63726480
"ModelPackageGroupName":{
6373-
"shape":"EntityName",
6374-
"documentation":"<p>The name of the model group that this model version belongs to.</p> <p>This parameter is required for versioned models, and does not apply to unversioned models.</p>"
6481+
"shape":"ArnOrName",
6482+
"documentation":"<p>The name or Amazon Resource Name (ARN) of the model package group that this model version belongs to.</p> <p>This parameter is required for versioned models, and does not apply to unversioned models.</p>"
63756483
},
63766484
"ModelPackageDescription":{
63776485
"shape":"EntityDescription",
@@ -6410,6 +6518,10 @@
64106518
"shape":"ClientToken",
64116519
"documentation":"<p>A unique token that guarantees that the call to this API is idempotent.</p>",
64126520
"idempotencyToken":true
6521+
},
6522+
"CustomerMetadataProperties":{
6523+
"shape":"CustomerMetadataMap",
6524+
"documentation":"<p>The metadata properties associated with the model package versions.</p>"
64136525
}
64146526
}
64156527
},
@@ -7275,6 +7387,29 @@
72757387
"member":{"shape":"CustomImage"},
72767388
"max":30
72777389
},
7390+
"CustomerMetadataKey":{
7391+
"type":"string",
7392+
"max":128,
7393+
"min":1,
7394+
"pattern":"^([\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@]*)${1,128}"
7395+
},
7396+
"CustomerMetadataKeyList":{
7397+
"type":"list",
7398+
"member":{"shape":"CustomerMetadataKey"}
7399+
},
7400+
"CustomerMetadataMap":{
7401+
"type":"map",
7402+
"key":{"shape":"CustomerMetadataKey"},
7403+
"value":{"shape":"CustomerMetadataValue"},
7404+
"max":50,
7405+
"min":1
7406+
},
7407+
"CustomerMetadataValue":{
7408+
"type":"string",
7409+
"max":256,
7410+
"min":1,
7411+
"pattern":"^([\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@]*)${1,256}"
7412+
},
72787413
"DataCaptureConfig":{
72797414
"type":"structure",
72807415
"required":[
@@ -10042,7 +10177,7 @@
1004210177
},
1004310178
"ValidationSpecification":{
1004410179
"shape":"ModelPackageValidationSpecification",
10045-
"documentation":"<p>Configurations for one or more transform jobs that Amazon SageMaker runs to test the model package.</p>"
10180+
"documentation":"<p>Configurations for one or more transform jobs that SageMaker runs to test the model package.</p>"
1004610181
},
1004710182
"ModelPackageStatus":{
1004810183
"shape":"ModelPackageStatus",
@@ -10074,6 +10209,10 @@
1007410209
"ApprovalDescription":{
1007510210
"shape":"ApprovalDescription",
1007610211
"documentation":"<p>A description provided for the model approval.</p>"
10212+
},
10213+
"CustomerMetadataProperties":{
10214+
"shape":"CustomerMetadataMap",
10215+
"documentation":"<p>The metadata properties associated with the model package versions.</p>"
1007710216
}
1007810217
}
1007910218
},
@@ -10628,7 +10767,12 @@
1062810767
"CreationTime":{
1062910768
"shape":"Timestamp",
1063010769
"documentation":"<p>The time when the project was created.</p>"
10631-
}
10770+
},
10771+
"LastModifiedTime":{
10772+
"shape":"Timestamp",
10773+
"documentation":"<p>The timestamp when project was last modified.</p>"
10774+
},
10775+
"LastModifiedBy":{"shape":"UserContext"}
1063210776
}
1063310777
},
1063410778
"DescribeStudioLifecycleConfigRequest":{
@@ -17652,6 +17796,10 @@
1765217796
"Tags":{
1765317797
"shape":"TagList",
1765417798
"documentation":"<p>A list of the tags associated with the model package. For more information, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html\">Tagging Amazon Web Services resources</a> in the <i>Amazon Web Services General Reference Guide</i>.</p>"
17799+
},
17800+
"CustomerMetadataProperties":{
17801+
"shape":"CustomerMetadataMap",
17802+
"documentation":"<p>The metadata properties for the model package. </p>"
1765517803
}
1765617804
},
1765717805
"documentation":"<p>A versioned model that can be deployed for SageMaker inference.</p>"
@@ -17662,6 +17810,12 @@
1766217810
"min":1,
1766317811
"pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:model-package/.*"
1766417812
},
17813+
"ModelPackageArnList":{
17814+
"type":"list",
17815+
"member":{"shape":"ModelPackageArn"},
17816+
"max":100,
17817+
"min":1
17818+
},
1766517819
"ModelPackageContainerDefinition":{
1766617820
"type":"structure",
1766717821
"required":["Image"],
@@ -17848,6 +18002,11 @@
1784818002
"type":"list",
1784918003
"member":{"shape":"ModelPackageStatusItem"}
1785018004
},
18005+
"ModelPackageSummaries":{
18006+
"type":"map",
18007+
"key":{"shape":"ModelPackageArn"},
18008+
"value":{"shape":"BatchDescribeModelPackageSummary"}
18009+
},
1785118010
"ModelPackageSummary":{
1785218011
"type":"structure",
1785318012
"required":[
@@ -20542,7 +20701,12 @@
2054220701
"Tags":{
2054320702
"shape":"TagList",
2054420703
"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/general/latest/gr/aws_tagging.html\">Tagging Amazon Web Services Resources</a>.</p>"
20545-
}
20704+
},
20705+
"LastModifiedTime":{
20706+
"shape":"Timestamp",
20707+
"documentation":"<p>A timestamp container for when the project was last modified.</p>"
20708+
},
20709+
"LastModifiedBy":{"shape":"UserContext"}
2054620710
},
2054720711
"documentation":"<p>The properties of a project as returned by the Search API.</p>"
2054820712
},
@@ -20587,7 +20751,10 @@
2058720751
"CreateFailed",
2058820752
"DeleteInProgress",
2058920753
"DeleteFailed",
20590-
"DeleteCompleted"
20754+
"DeleteCompleted",
20755+
"UpdateInProgress",
20756+
"UpdateCompleted",
20757+
"UpdateFailed"
2059120758
]
2059220759
},
2059320760
"ProjectSummary":{
@@ -21572,6 +21739,20 @@
2157221739
},
2157321740
"documentation":"<p>Details that you specify to provision a service catalog product. For information about service catalog, see <a href=\"https://docs.aws.amazon.com/servicecatalog/latest/adminguide/introduction.html\">What is Amazon Web Services Service Catalog</a>.</p>"
2157421741
},
21742+
"ServiceCatalogProvisioningUpdateDetails":{
21743+
"type":"structure",
21744+
"members":{
21745+
"ProvisioningArtifactId":{
21746+
"shape":"ServiceCatalogEntityId",
21747+
"documentation":"<p>The ID of the provisioning artifact.</p>"
21748+
},
21749+
"ProvisioningParameters":{
21750+
"shape":"ProvisioningParameters",
21751+
"documentation":"<p>A list of key value pairs that you specify when you provision a product.</p>"
21752+
}
21753+
},
21754+
"documentation":"<p>Details that you specify to provision a service catalog product. For information about service catalog, see <a href=\"https://docs.aws.amazon.com/servicecatalog/latest/adminguide/introduction.html\">What is AWS Service Catalog</a>. </p>"
21755+
},
2157521756
"SessionExpirationDurationInSeconds":{
2157621757
"type":"integer",
2157721758
"max":43200,
@@ -23992,14 +24173,11 @@
2399224173
},
2399324174
"UpdateModelPackageInput":{
2399424175
"type":"structure",
23995-
"required":[
23996-
"ModelPackageArn",
23997-
"ModelApprovalStatus"
23998-
],
24176+
"required":["ModelPackageArn"],
2399924177
"members":{
2400024178
"ModelPackageArn":{
2400124179
"shape":"ModelPackageArn",
24002-
"documentation":"<p>The Amazon Resource Name (ARN) of the model.</p>"
24180+
"documentation":"<p>The Amazon Resource Name (ARN) of the model package.</p>"
2400324181
},
2400424182
"ModelApprovalStatus":{
2400524183
"shape":"ModelApprovalStatus",
@@ -24008,6 +24186,14 @@
2400824186
"ApprovalDescription":{
2400924187
"shape":"ApprovalDescription",
2401024188
"documentation":"<p>A description for the approval status of the model.</p>"
24189+
},
24190+
"CustomerMetadataProperties":{
24191+
"shape":"CustomerMetadataMap",
24192+
"documentation":"<p>The metadata properties associated with the model package versions.</p>"
24193+
},
24194+
"CustomerMetadataPropertiesToRemove":{
24195+
"shape":"CustomerMetadataKeyList",
24196+
"documentation":"<p>The metadata properties associated with the model package versions to remove.</p>"
2401124197
}
2401224198
}
2401324199
},
@@ -24196,6 +24382,38 @@
2419624382
}
2419724383
}
2419824384
},
24385+
"UpdateProjectInput":{
24386+
"type":"structure",
24387+
"required":["ProjectName"],
24388+
"members":{
24389+
"ProjectName":{
24390+
"shape":"ProjectEntityName",
24391+
"documentation":"<p>The name of the project.</p>"
24392+
},
24393+
"ProjectDescription":{
24394+
"shape":"EntityDescription",
24395+
"documentation":"<p>The description for the project.</p>"
24396+
},
24397+
"ServiceCatalogProvisioningUpdateDetails":{
24398+
"shape":"ServiceCatalogProvisioningUpdateDetails",
24399+
"documentation":"<p>The product ID and provisioning artifact ID to provision a service catalog. The provisioning artifact ID will default to the latest provisioning artifact ID of the product, if you don't provide the provisioning artifact ID. For more information, see <a href=\"https://docs.aws.amazon.com/servicecatalog/latest/adminguide/introduction.html\">What is AWS Service Catalog</a>. </p>"
24400+
},
24401+
"Tags":{
24402+
"shape":"TagList",
24403+
"documentation":"<p>An array of key-value pairs. You can use tags to categorize your AWS resources in different ways, for example, by purpose, owner, or environment. For more information, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html\">Tagging AWS Resources</a>.</p>"
24404+
}
24405+
}
24406+
},
24407+
"UpdateProjectOutput":{
24408+
"type":"structure",
24409+
"required":["ProjectArn"],
24410+
"members":{
24411+
"ProjectArn":{
24412+
"shape":"ProjectArn",
24413+
"documentation":"<p>The Amazon Resource Name (ARN) of the project.</p>"
24414+
}
24415+
}
24416+
},
2419924417
"UpdateTrainingJobRequest":{
2420024418
"type":"structure",
2420124419
"required":["TrainingJobName"],

0 commit comments

Comments
 (0)