Skip to content

Commit 9ae355d

Browse files
rsareddy0329Roja Reddy Sareddy
andauthored
fix(resources): fall back to ARN in ModelPackage.refresh for versioned packages (#6378)
ModelPackage.get_all() over a model package group fails with ParamValidationError: Missing required parameter "ModelPackageName". The ResourceIterator calls refresh() on each constructed ModelPackage, and refresh() built its describe input from self.model_package_name only. For versioned packages ListModelPackages returns only ModelPackageArn, so model_package_name stays Unassigned, serializes to None, is dropped from the request, and the describe call fails (#5606). DescribeModelPackage accepts either the name or the ARN for the ModelPackageName parameter, so refresh() now falls back to model_package_arn when model_package_name is Unassigned. resources.py is generated, so the fix is in the generator: add a scoped REFRESH_IDENTIFIER_FALLBACKS map and emit the fallback in _generate_operation_input_necessary_args, wired in only for refresh. The blast radius is limited to ModelPackage.refresh -- update already excludes identifiers and every other resource is unchanged. resources.py is the regenerated output of this change (ModelPackage.refresh hunk only). Add runtime tests covering the ARN fallback and the name path. Relates-to #5606 Co-authored-by: Roja Reddy Sareddy <rsareddy@amazon.com>
1 parent febee60 commit 9ae355d

3 files changed

Lines changed: 74 additions & 7 deletions

File tree

‎sagemaker-core/src/sagemaker/core/resources.py‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22984,7 +22984,11 @@ def refresh(
2298422984
"""
2298522985

2298622986
operation_input_args = {
22987-
"ModelPackageName": self.model_package_name,
22987+
"ModelPackageName": (
22988+
self.model_package_name
22989+
if not isinstance(self.model_package_name, Unassigned)
22990+
else self.model_package_arn
22991+
),
2298822992
}
2298922993
# serialize the input request
2299022994
operation_input_args = serialize(operation_input_args)

‎sagemaker-core/src/sagemaker/core/tools/resources_codegen.py‎

Lines changed: 32 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,14 @@
9898
REQUIRED = "required"
9999
GLOBAL_DEFAULTS = "GlobalDefaults"
100100

101+
# Some resources do not return their *Name identifier from the List API for certain
102+
# variants (e.g. a versioned ModelPackage returns only ModelPackageArn). Because the
103+
# Describe API accepts either the name or the ARN for the *Name parameter, refresh()
104+
# falls back to the ARN attribute when the name identifier is Unassigned. See issue #5606.
105+
REFRESH_IDENTIFIER_FALLBACKS = {
106+
"ModelPackage": {"ModelPackageName": "model_package_arn"},
107+
}
108+
101109

102110
class ResourcesCodeGen:
103111
"""A class for generating resources based on a service JSON file.
@@ -761,7 +769,10 @@ def _generate_operation_input_args(
761769
return operation_input_args
762770

763771
def _generate_operation_input_necessary_args(
764-
self, resource_operation: dict, resource_attributes: list
772+
self,
773+
resource_operation: dict,
774+
resource_attributes: list,
775+
identifier_fallbacks: dict = None,
765776
) -> str:
766777
"""Generate the operation input arguments string.
767778
@@ -770,20 +781,33 @@ def _generate_operation_input_necessary_args(
770781
771782
Args:
772783
resource_operation (dict): The resource operation dictionary.
773-
is_class_method (bool): Indicates method is class method, else object method.
784+
resource_attributes (list): The resource object attributes available on self.
785+
identifier_fallbacks (dict, optional): Maps an input member name to a resource
786+
attribute to fall back to when the member's own attribute is Unassigned
787+
(e.g. {"ModelPackageName": "model_package_arn"}). See issue #5606.
774788
775789
Returns:
776790
str: The formatted operation input arguments string.
777791
"""
778792
input_shape_name = resource_operation["input"]["shape"]
779793
input_shape_members = list(self.shapes[input_shape_name]["members"].keys())
780794

795+
identifier_fallbacks = identifier_fallbacks or {}
781796
args = list()
782797
for member in input_shape_members:
783-
if convert_to_snake_case(member) in resource_attributes:
784-
args.append(f"'{member}': self.{convert_to_snake_case(member)}")
798+
snake_member = convert_to_snake_case(member)
799+
if snake_member in resource_attributes:
800+
if member in identifier_fallbacks:
801+
fallback_attr = identifier_fallbacks[member]
802+
args.append(
803+
f"'{member}': self.{snake_member} "
804+
f"if not isinstance(self.{snake_member}, Unassigned) "
805+
f"else self.{fallback_attr}"
806+
)
807+
else:
808+
args.append(f"'{member}': self.{snake_member}")
785809
else:
786-
args.append(f"'{member}': {convert_to_snake_case(member)}")
810+
args.append(f"'{member}': {snake_member}")
787811

788812
operation_input_args = ",\n".join(args)
789813
operation_input_args += ","
@@ -1300,7 +1324,9 @@ def generate_refresh_method(self, resource_name: str, **kwargs) -> str:
13001324
)
13011325

13021326
operation_input_args = self._generate_operation_input_necessary_args(
1303-
operation_metadata, kwargs["resource_attributes"]
1327+
operation_metadata,
1328+
kwargs["resource_attributes"],
1329+
identifier_fallbacks=REFRESH_IDENTIFIER_FALLBACKS.get(resource_name),
13041330
)
13051331

13061332
operation = convert_to_snake_case(operation_name)

‎sagemaker-core/tests/unit/generated/test_resources.py‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -935,3 +935,40 @@ def test_no_synthesis_without_output_data_config(self):
935935
)
936936

937937
assert isinstance(job.model_artifacts, Unassigned)
938+
939+
940+
class TestModelPackageRefreshIdentifierFallback(unittest.TestCase):
941+
"""ModelPackage.refresh() must work for versioned packages (issue #5606).
942+
943+
``ListModelPackages`` does not return ``ModelPackageName`` for versioned packages
944+
inside a model package group, only ``ModelPackageArn``. Since ``DescribeModelPackage``
945+
accepts either for the ``ModelPackageName`` parameter, refresh() falls back to the ARN
946+
when the name is ``Unassigned``.
947+
"""
948+
949+
_ARN = "arn:aws:sagemaker:us-west-2:123456789012:model-package/my-group/1"
950+
951+
def _refresh_with(self, **attrs):
952+
from sagemaker.core.resources import ModelPackage
953+
954+
pkg = ModelPackage.model_construct(**attrs)
955+
with (
956+
patch("sagemaker.core.resources.transform", return_value={}),
957+
patch.object(Base, "get_sagemaker_client") as mock_get_client,
958+
):
959+
client = mock_get_client.return_value
960+
client.describe_model_package.return_value = {}
961+
pkg.refresh()
962+
return client
963+
964+
def test_refresh_falls_back_to_arn_when_name_unassigned(self):
965+
from sagemaker.core.utils.utils import Unassigned
966+
967+
client = self._refresh_with(model_package_name=Unassigned(), model_package_arn=self._ARN)
968+
client.describe_model_package.assert_called_once_with(ModelPackageName=self._ARN)
969+
970+
def test_refresh_uses_name_when_present(self):
971+
client = self._refresh_with(
972+
model_package_name="my-model-package", model_package_arn=self._ARN
973+
)
974+
client.describe_model_package.assert_called_once_with(ModelPackageName="my-model-package")

0 commit comments

Comments
 (0)