sagemaker-core 1.0.32__py3-none-any.whl → 1.0.33__py3-none-any.whl

sagemaker_core/main/resources.py

@@ -6471,10 +6471,12 @@ class DataQualityJobDefinition(Base):
             "CreationTimeBefore": creation_time_before,
             "CreationTimeAfter": creation_time_after,
         }
+
         custom_key_mapping = {
             "monitoring_job_definition_name": "job_definition_name",
             "monitoring_job_definition_arn": "job_definition_arn",
         }
+
         # serialize the input request
         operation_input_args = serialize(operation_input_args)
         logger.debug(f"Serialized input request: {operation_input_args}")
@@ -12613,6 +12615,84 @@ class HubContent(Base):
             region=region,
         )
 
+    @classmethod
+    @Base.add_validate_call
+    def get_all(
+        cls,
+        hub_name: str,
+        hub_content_type: str,
+        name_contains: Optional[str] = Unassigned(),
+        max_schema_version: Optional[str] = Unassigned(),
+        creation_time_before: Optional[datetime.datetime] = Unassigned(),
+        creation_time_after: Optional[datetime.datetime] = Unassigned(),
+        sort_by: Optional[str] = Unassigned(),
+        sort_order: Optional[str] = Unassigned(),
+        session: Optional[Session] = None,
+        region: Optional[str] = None,
+    ) -> ResourceIterator["HubContent"]:
+        """
+        Get all HubContent resources
+
+        Parameters:
+            hub_name: The name of the hub to list the contents of.
+            hub_content_type: The type of hub content to list.
+            name_contains: Only list hub content if the name contains the specified string.
+            max_schema_version: The upper bound of the hub content schema verion.
+            creation_time_before: Only list hub content that was created before the time specified.
+            creation_time_after: Only list hub content that was created after the time specified.
+            sort_by: Sort hub content versions by either name or creation time.
+            sort_order: Sort hubs by ascending or descending order.
+            max_results: The maximum amount of hub content to list.
+            next_token: If the response to a previous ListHubContents request was truncated, the response includes a NextToken. To retrieve the next set of hub content, use the token in the next request.
+            session: Boto3 session.
+            region: Region name.
+
+        Returns:
+            Iterator for listed HubContent resources.
+
+        Raises:
+            botocore.exceptions.ClientError: This exception is raised for AWS service related errors.
+                The error message and error code can be parsed from the exception as follows:
+                ```
+                try:
+                    # AWS service call here
+                except botocore.exceptions.ClientError as e:
+                    error_message = e.response['Error']['Message']
+                    error_code = e.response['Error']['Code']
+                ```
+            ResourceNotFound: Resource being access is not found.
+        """
+
+        client = Base.get_sagemaker_client(
+            session=session, region_name=region, service_name="sagemaker"
+        )
+
+        operation_input_args = {
+            "HubName": hub_name,
+            "HubContentType": hub_content_type,
+            "NameContains": name_contains,
+            "MaxSchemaVersion": max_schema_version,
+            "CreationTimeBefore": creation_time_before,
+            "CreationTimeAfter": creation_time_after,
+            "SortBy": sort_by,
+            "SortOrder": sort_order,
+        }
+        extract_name_mapping = {"hub_content_arn": ["hub-content/", "hub_name"]}
+
+        # serialize the input request
+        operation_input_args = serialize(operation_input_args)
+        logger.debug(f"Serialized input request: {operation_input_args}")
+
+        return ResourceIterator(
+            client=client,
+            list_method="list_hub_contents",
+            summaries_key="HubContentSummaries",
+            summary_name="HubContentInfo",
+            resource_cls=HubContent,
+            extract_name_mapping=extract_name_mapping,
+            list_method_kwargs=operation_input_args,
+        )
+
     @Base.add_validate_call
     def get_all_versions(
         self,
@@ -14915,6 +14995,81 @@ class ImageVersion(Base):
                     raise e
                 time.sleep(poll)
 
+    @classmethod
+    @Base.add_validate_call
+    def get_all(
+        cls,
+        image_name: str,
+        creation_time_after: Optional[datetime.datetime] = Unassigned(),
+        creation_time_before: Optional[datetime.datetime] = Unassigned(),
+        last_modified_time_after: Optional[datetime.datetime] = Unassigned(),
+        last_modified_time_before: Optional[datetime.datetime] = Unassigned(),
+        sort_by: Optional[str] = Unassigned(),
+        sort_order: Optional[str] = Unassigned(),
+        session: Optional[Session] = None,
+        region: Optional[str] = None,
+    ) -> ResourceIterator["ImageVersion"]:
+        """
+        Get all ImageVersion resources
+
+        Parameters:
+            image_name: The name of the image to list the versions of.
+            creation_time_after: A filter that returns only versions created on or after the specified time.
+            creation_time_before: A filter that returns only versions created on or before the specified time.
+            last_modified_time_after: A filter that returns only versions modified on or after the specified time.
+            last_modified_time_before: A filter that returns only versions modified on or before the specified time.
+            max_results: The maximum number of versions to return in the response. The default value is 10.
+            next_token: If the previous call to ListImageVersions didn't return the full set of versions, the call returns a token for getting the next set of versions.
+            sort_by: The property used to sort results. The default value is CREATION_TIME.
+            sort_order: The sort order. The default value is DESCENDING.
+            session: Boto3 session.
+            region: Region name.
+
+        Returns:
+            Iterator for listed ImageVersion resources.
+
+        Raises:
+            botocore.exceptions.ClientError: This exception is raised for AWS service related errors.
+                The error message and error code can be parsed from the exception as follows:
+                ```
+                try:
+                    # AWS service call here
+                except botocore.exceptions.ClientError as e:
+                    error_message = e.response['Error']['Message']
+                    error_code = e.response['Error']['Code']
+                ```
+            ResourceNotFound: Resource being access is not found.
+        """
+
+        client = Base.get_sagemaker_client(
+            session=session, region_name=region, service_name="sagemaker"
+        )
+
+        operation_input_args = {
+            "CreationTimeAfter": creation_time_after,
+            "CreationTimeBefore": creation_time_before,
+            "ImageName": image_name,
+            "LastModifiedTimeAfter": last_modified_time_after,
+            "LastModifiedTimeBefore": last_modified_time_before,
+            "SortBy": sort_by,
+            "SortOrder": sort_order,
+        }
+        extract_name_mapping = {"image_version_arn": ["image-version/", "image_name"]}
+
+        # serialize the input request
+        operation_input_args = serialize(operation_input_args)
+        logger.debug(f"Serialized input request: {operation_input_args}")
+
+        return ResourceIterator(
+            client=client,
+            list_method="list_image_versions",
+            summaries_key="ImageVersions",
+            summary_name="ImageVersion",
+            resource_cls=ImageVersion,
+            extract_name_mapping=extract_name_mapping,
+            list_method_kwargs=operation_input_args,
+        )
+
 
 class InferenceComponent(Base):
     """
@@ -18504,10 +18659,12 @@ class ModelBiasJobDefinition(Base):
             "CreationTimeBefore": creation_time_before,
             "CreationTimeAfter": creation_time_after,
         }
+
         custom_key_mapping = {
             "monitoring_job_definition_name": "job_definition_name",
             "monitoring_job_definition_arn": "job_definition_arn",
         }
+
         # serialize the input request
         operation_input_args = serialize(operation_input_args)
         logger.debug(f"Serialized input request: {operation_input_args}")
@@ -19733,10 +19890,12 @@ class ModelExplainabilityJobDefinition(Base):
             "CreationTimeBefore": creation_time_before,
             "CreationTimeAfter": creation_time_after,
         }
+
         custom_key_mapping = {
             "monitoring_job_definition_name": "job_definition_name",
             "monitoring_job_definition_arn": "job_definition_arn",
         }
+
         # serialize the input request
         operation_input_args = serialize(operation_input_args)
         logger.debug(f"Serialized input request: {operation_input_args}")
@@ -21350,10 +21509,12 @@ class ModelQualityJobDefinition(Base):
             "CreationTimeBefore": creation_time_before,
             "CreationTimeAfter": creation_time_after,
         }
+
         custom_key_mapping = {
             "monitoring_job_definition_name": "job_definition_name",
             "monitoring_job_definition_arn": "job_definition_arn",
         }
+
         # serialize the input request
         operation_input_args = serialize(operation_input_args)
         logger.debug(f"Serialized input request: {operation_input_args}")

sagemaker_core/main/utils.py

@@ -387,6 +387,7 @@ class ResourceIterator(Generic[T]):
         list_method: str,
         list_method_kwargs: dict = {},
         custom_key_mapping: dict = None,
+        extract_name_mapping: dict = None,
     ):
         """Initialize a ResourceIterator object
 
@@ -398,6 +399,7 @@ class ResourceIterator(Generic[T]):
             list_method (str): The list method string used to make list calls to the client.
             list_method_kwargs (dict, optional): The kwargs used to make list method calls. Defaults to {}.
             custom_key_mapping (dict, optional): The custom key mapping used to map keys from summary object to those expected from resource object during initialization. Defaults to None.
+            extract_name_mapping (dict, optional): The extract name mapping used to extract names from arn in summary object and map to those expected from resource object during initialization. Defaults to None.
         """
         self.summaries_key = summaries_key
         self.summary_name = summary_name
@@ -405,6 +407,7 @@ class ResourceIterator(Generic[T]):
         self.list_method = list_method
         self.list_method_kwargs = list_method_kwargs
         self.custom_key_mapping = custom_key_mapping
+        self.extract_name_mapping = extract_name_mapping
 
         self.resource_cls = resource_cls
         self.index = 0
@@ -433,6 +436,12 @@ class ResourceIterator(Generic[T]):
                 if self.custom_key_mapping:
                     init_data = {self.custom_key_mapping.get(k, k): v for k, v in init_data.items()}
 
+                # Extract name from arn. Currently implemented for HubContent and ImageVersion
+                if self.extract_name_mapping:
+                    for arn, target in self.extract_name_mapping.items():
+                        name = init_data[arn].split(target[0])[1].split("/")[0]
+                        init_data.update({target[1]: name})
+
                 # Filter out the fields that are not in the resource class
                 fields = self.resource_cls.__annotations__
                 init_data = {k: v for k, v in init_data.items() if k in fields}

sagemaker_core/tools/resources_codegen.py

@@ -1754,14 +1754,27 @@ class ResourcesCodeGen:
             get_operation_required_input = []
 
         custom_key_mapping_str = ""
+        custom_key_mapping = {}
+        extract_name_mapping_str = ""
+        extract_name_mapping = {}
         if any(member not in summary_members for member in get_operation_required_input):
-            if "MonitoringJobDefinitionSummary" == summary_name:
+            if summary_name == "MonitoringJobDefinitionSummary":
                 custom_key_mapping = {
                     "monitoring_job_definition_name": "job_definition_name",
                     "monitoring_job_definition_arn": "job_definition_arn",
                 }
-                custom_key_mapping_str = f"custom_key_mapping = {json.dumps(custom_key_mapping)}"
-                custom_key_mapping_str = add_indent(custom_key_mapping_str, 4)
+            elif summary_name == "HubContentInfo":
+                # HubContentArn -- arn:<partition>:sagemaker:<region>:<account-id>:hub-content/<hub-name>/<type>/<name>/<version>
+                # {source key from input: (target label in arn, target key in output)}
+                extract_name_mapping = {
+                    "hub_content_arn": ("hub-content/", "hub_name"),
+                }
+            elif summary_name == "ImageVersion":
+                # ImageVersionArn -- arn:aws:sagemaker:<region>:<account>:image-version/<image-name>/<version-number>
+                # {source key from input: (target label in arn, target key in output)}
+                extract_name_mapping = {
+                    "image_version_arn": ("image-version/", "image_name"),
+                }
             else:
                 log.warning(
                     f"Resource {resource_name} summaries do not have required members to create object instance. Resource may require custom key mapping for get_all().\n"
@@ -1769,6 +1782,15 @@ class ResourcesCodeGen:
                 )
                 return ""
 
+            if custom_key_mapping:
+                custom_key_mapping_str = add_indent(
+                    f"custom_key_mapping = {json.dumps(custom_key_mapping)}", 4
+                )
+            if extract_name_mapping:
+                extract_name_mapping_str = add_indent(
+                    f"extract_name_mapping = {json.dumps(extract_name_mapping)}", 4
+                )
+
         resource_iterator_args_list = [
             "client=client",
             f"list_method='{operation}'",
@@ -1780,6 +1802,9 @@ class ResourcesCodeGen:
         if custom_key_mapping_str:
             resource_iterator_args_list.append(f"custom_key_mapping=custom_key_mapping")
 
+        if extract_name_mapping_str:
+            resource_iterator_args_list.append(f"extract_name_mapping=extract_name_mapping")
+
         exclude_list = ["next_token", "max_results"]
         get_all_args = self._generate_method_args(operation_input_shape_name, exclude_list)
 
@@ -1792,6 +1817,7 @@ class ResourcesCodeGen:
                 resource=resource_name,
                 operation=operation,
                 custom_key_mapping=custom_key_mapping_str,
+                extract_name_mapping=extract_name_mapping_str,
                 resource_iterator_args=resource_iterator_args,
             )
             return formatted_method
@@ -1822,6 +1848,7 @@ class ResourcesCodeGen:
             get_all_args=get_all_args,
             operation_input_args=operation_input_args,
             custom_key_mapping=custom_key_mapping_str,
+            extract_name_mapping=extract_name_mapping_str,
             resource_iterator_args=resource_iterator_args,
         )
         return formatted_method

sagemaker_core/tools/templates.py

@@ -512,6 +512,7 @@ def get_all(
     operation_input_args = {{
 {operation_input_args}
     }}
+{extract_name_mapping}
 {custom_key_mapping}
     # serialize the input request
     operation_input_args = serialize(operation_input_args)
@@ -542,6 +543,7 @@ def get_all(
 
     """
     client = Base.get_sagemaker_client(session=session, region_name=region, service_name="{service_name}")
+{extract_name_mapping}
 {custom_key_mapping}
     return ResourceIterator(
 {resource_iterator_args}

{sagemaker_core-1.0.32.dist-info → sagemaker_core-1.0.33.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sagemaker-core
-Version: 1.0.32
+Version: 1.0.33
 Summary: An python package for sagemaker core functionalities
 Author-email: AWS <sagemaker-interests@amazon.com>
 Project-URL: Repository, https://github.com/aws/sagemaker-core.git
@@ -20,7 +20,7 @@ Requires-Dist: pydantic<3.0.0,>=2.0.0
 Requires-Dist: PyYAML<7.0,>=6.0
 Requires-Dist: jsonschema<5.0.0
 Requires-Dist: platformdirs<5.0.0,>=4.0.0
-Requires-Dist: rich<14.0.0,>=13.0.0
+Requires-Dist: rich<15.0.0,>=14.0.0
 Requires-Dist: mock<5.0,>4.0
 Requires-Dist: importlib-metadata<7.0,>=1.4.0
 Provides-Extra: codegen

{sagemaker_core-1.0.32.dist-info → sagemaker_core-1.0.33.dist-info}/RECORD

@@ -7,10 +7,10 @@ sagemaker_core/main/config_schema.py,sha256=Wxe2gJash1rrxBomGhSYmII1LmJ3E70LIuSW
 sagemaker_core/main/exceptions.py,sha256=87DUlrmHxaWoiYNlpNY9ixxFMPRk_dIGPsA2e_xdVwQ,5602
 sagemaker_core/main/intelligent_defaults_helper.py,sha256=5SDM6UavZtp-k5LhqRL7GRIDgzFB5UsC_p7YuiSPK9A,8334
 sagemaker_core/main/logs.py,sha256=yfEH7uP91nbE1lefymOlBr81ziBzsDSIOF2Qyd54FJE,6241
-sagemaker_core/main/resources.py,sha256=jNX5jp5tmwa0t8PYPxWrRRBAGIn0G-iq3C-7TvBxEPw,1420815
+sagemaker_core/main/resources.py,sha256=jtD_9MUoyJkTDGAAnvEVpaconzPF6kRFBdio_mN_3zs,1427804
 sagemaker_core/main/shapes.py,sha256=YfcsZIpYetJPZHNo-VfajMCaqT6eGYXI_1EvCLr0dGg,739047
 sagemaker_core/main/user_agent.py,sha256=BPYDAfDd70ObP-VAjl7aDHALHyGknkpRP21ktVr_LDw,2744
-sagemaker_core/main/utils.py,sha256=qTGJDcZwrAQSsdyg8A78x4PKU4Wu1rY6Cn3OIbIspaA,18546
+sagemaker_core/main/utils.py,sha256=tJyHjHFwwmz8LHMlOLf5_Exu4h-kFVnAxvXkbChkuHQ,19215
 sagemaker_core/main/code_injection/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 sagemaker_core/main/code_injection/base.py,sha256=11_Jif0nOzfbLGlXaacKf-wcizzfS64U0OSZGoVffFU,1733
 sagemaker_core/main/code_injection/codec.py,sha256=nA51E9iNWHyKou1G23rKSRL4WitdkFRbMuFkyrGHzKU,8428
@@ -23,13 +23,13 @@ sagemaker_core/tools/codegen.py,sha256=mKWVi2pWnPxyIoWUEPYjEc9Gw7D9bCOrHqa00yzIZ
 sagemaker_core/tools/constants.py,sha256=XEwsUJ4w952mpnk-K0TS7R2uJhZyVPjcR47nrzgVXtg,3483
 sagemaker_core/tools/data_extractor.py,sha256=pNfmTA0NUA96IgfLrla7a36Qjc1NljbwgZYaOhouKqQ,2113
 sagemaker_core/tools/method.py,sha256=Ud2YeH2SPkj7xtIxBuUdRfQwCmovMUzGGkcIvzhpQeQ,805
-sagemaker_core/tools/resources_codegen.py,sha256=wz9HU_crbHeZUp5ylMqgfWbHCCgVLfD31hFBGBSuW_A,85100
+sagemaker_core/tools/resources_codegen.py,sha256=jYhbGQ0X5xuQGgIJp6UOHY_RU-PsLFe4JfpdjL1lPCk,86445
 sagemaker_core/tools/resources_extractor.py,sha256=hN61ehZbPnhFW-2FIVDi7NsEz4rLvGr-WoglHQGfrug,14523
 sagemaker_core/tools/shapes_codegen.py,sha256=4lsePZpjk7M6RpJs5yar_m4z5MzwGHFrvCkdS_-R12c,12172
 sagemaker_core/tools/shapes_extractor.py,sha256=vxVKjXD3lmjrkoKiexjUnOt8ITbFxQSeiDtx7P6Qtkw,14226
-sagemaker_core/tools/templates.py,sha256=vIgRWConRGAQ-Mri6LwfkArqWHlL3KXcvbbYa-t_MV4,23414
-sagemaker_core-1.0.32.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-sagemaker_core-1.0.32.dist-info/METADATA,sha256=N-vlVke2GuSZYAnC04SYBHYOuDIMaGbWBgBYXcqVNgM,4885
-sagemaker_core-1.0.32.dist-info/WHEEL,sha256=0CuiUZ_p9E4cD6NyLD6UG80LBXYyiSYZOKDm5lp32xk,91
-sagemaker_core-1.0.32.dist-info/top_level.txt,sha256=R3GAZZ1zC5JxqdE_0x2Lu_WYi2Xfke7VsiP3L5zngfA,15
-sagemaker_core-1.0.32.dist-info/RECORD,,
+sagemaker_core/tools/templates.py,sha256=0lOIH3Rq2CXWkQhK6VenN_TE_v5p852s2kQyb_BeQxA,23460
+sagemaker_core-1.0.33.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+sagemaker_core-1.0.33.dist-info/METADATA,sha256=0AkeGwVa8WdSOps6dTQQZh0_KmS3uRLV_NWmH0PkuEM,4885
+sagemaker_core-1.0.33.dist-info/WHEEL,sha256=0CuiUZ_p9E4cD6NyLD6UG80LBXYyiSYZOKDm5lp32xk,91
+sagemaker_core-1.0.33.dist-info/top_level.txt,sha256=R3GAZZ1zC5JxqdE_0x2Lu_WYi2Xfke7VsiP3L5zngfA,15
+sagemaker_core-1.0.33.dist-info/RECORD,,