sagemaker-core 1.0.6__py3-none-any.whl → 1.0.8__py3-none-any.whl

sagemaker_core/main/code_injection/shape_dag.py

@@ -797,6 +797,16 @@ SHAPE_DAG = {
         ],
         "type": "structure",
     },
+    "BatchGetMetricsRequest": {
+        "members": [{"name": "MetricQueries", "shape": "MetricQueryList", "type": "list"}],
+        "type": "structure",
+    },
+    "BatchGetMetricsResponse": {
+        "members": [
+            {"name": "MetricQueryResults", "shape": "MetricQueryResultList", "type": "list"}
+        ],
+        "type": "structure",
+    },
     "BatchGetRecordError": {
         "members": [
             {"name": "FeatureGroupName", "shape": "ValueAsString", "type": "string"},
@@ -6563,7 +6573,24 @@ SHAPE_DAG = {
     },
     "Groups": {"member_shape": "Group", "member_type": "string", "type": "list"},
     "HiddenAppTypesList": {"member_shape": "AppType", "member_type": "string", "type": "list"},
+    "HiddenInstanceTypesList": {
+        "member_shape": "AppInstanceType",
+        "member_type": "string",
+        "type": "list",
+    },
     "HiddenMlToolsList": {"member_shape": "MlTools", "member_type": "string", "type": "list"},
+    "HiddenSageMakerImage": {
+        "members": [
+            {"name": "SageMakerImageName", "shape": "SageMakerImageName", "type": "string"},
+            {"name": "VersionAliases", "shape": "VersionAliasesList", "type": "list"},
+        ],
+        "type": "structure",
+    },
+    "HiddenSageMakerImageVersionAliasesList": {
+        "member_shape": "HiddenSageMakerImage",
+        "member_type": "structure",
+        "type": "list",
+    },
     "HolidayConfig": {
         "member_shape": "HolidayConfigAttributes",
         "member_type": "structure",
@@ -9659,6 +9686,33 @@ SHAPE_DAG = {
         "member_type": "structure",
         "type": "list",
     },
+    "MetricQuery": {
+        "members": [
+            {"name": "MetricName", "shape": "MetricName", "type": "string"},
+            {"name": "ResourceArn", "shape": "SageMakerResourceArn", "type": "string"},
+            {"name": "MetricStat", "shape": "MetricStatistic", "type": "string"},
+            {"name": "Period", "shape": "Period", "type": "string"},
+            {"name": "XAxisType", "shape": "XAxisType", "type": "string"},
+            {"name": "Start", "shape": "Long", "type": "long"},
+            {"name": "End", "shape": "Long", "type": "long"},
+        ],
+        "type": "structure",
+    },
+    "MetricQueryList": {"member_shape": "MetricQuery", "member_type": "structure", "type": "list"},
+    "MetricQueryResult": {
+        "members": [
+            {"name": "Status", "shape": "MetricQueryResultStatus", "type": "string"},
+            {"name": "Message", "shape": "Message", "type": "string"},
+            {"name": "XAxisValues", "shape": "XAxisValues", "type": "list"},
+            {"name": "MetricValues", "shape": "MetricValues", "type": "list"},
+        ],
+        "type": "structure",
+    },
+    "MetricQueryResultList": {
+        "member_shape": "MetricQueryResult",
+        "member_type": "structure",
+        "type": "list",
+    },
     "MetricSpecification": {
         "members": [
             {"name": "Predefined", "shape": "PredefinedMetricSpecification", "type": "structure"},
@@ -9666,6 +9720,7 @@ SHAPE_DAG = {
         ],
         "type": "structure",
     },
+    "MetricValues": {"member_shape": "Double", "member_type": "double", "type": "list"},
     "MetricsSource": {
         "members": [
             {"name": "ContentType", "shape": "ContentType", "type": "string"},
@@ -12459,6 +12514,7 @@ SHAPE_DAG = {
             {"name": "CompressionType", "shape": "ModelCompressionType", "type": "string"},
             {"name": "ModelAccessConfig", "shape": "ModelAccessConfig", "type": "structure"},
             {"name": "HubAccessConfig", "shape": "InferenceHubAccessConfig", "type": "structure"},
+            {"name": "ManifestS3Uri", "shape": "S3ModelUri", "type": "string"},
         ],
         "type": "structure",
     },
@@ -13096,6 +13152,12 @@ SHAPE_DAG = {
         "members": [
             {"name": "HiddenMlTools", "shape": "HiddenMlToolsList", "type": "list"},
             {"name": "HiddenAppTypes", "shape": "HiddenAppTypesList", "type": "list"},
+            {"name": "HiddenInstanceTypes", "shape": "HiddenInstanceTypesList", "type": "list"},
+            {
+                "name": "HiddenSageMakerImageVersionAliases",
+                "shape": "HiddenSageMakerImageVersionAliasesList",
+                "type": "list",
+            },
         ],
         "type": "structure",
     },
@@ -14662,6 +14724,11 @@ SHAPE_DAG = {
         "members": [{"name": "Dimension", "shape": "Dimension", "type": "integer"}],
         "type": "structure",
     },
+    "VersionAliasesList": {
+        "member_shape": "ImageVersionAliasPattern",
+        "member_type": "string",
+        "type": "list",
+    },
     "Vertex": {
         "members": [
             {"name": "Arn", "shape": "AssociationEntityArn", "type": "string"},
@@ -14796,4 +14863,5 @@ SHAPE_DAG = {
         "type": "structure",
     },
     "Workteams": {"member_shape": "Workteam", "member_type": "structure", "type": "list"},
+    "XAxisValues": {"member_shape": "Long", "member_type": "long", "type": "list"},
 }

sagemaker_core/main/config_schema.py

@@ -469,6 +469,7 @@ SAGEMAKER_PYTHON_SDK_CONFIG_SCHEMA = {
                                                 "s3_data_source": {
                                                     "s3_uri": {"type": "string"},
                                                     "s3_data_type": {"type": "string"},
+                                                    "manifest_s3_uri": {"type": "string"},
                                                 }
                                             }
                                         },

sagemaker_core/main/resources.py

@@ -16518,6 +16518,7 @@ class Model(Base):
                         "s3_data_source": {
                             "s3_uri": {"type": "string"},
                             "s3_data_type": {"type": "string"},
+                            "manifest_s3_uri": {"type": "string"},
                         }
                     }
                 },
@@ -27953,6 +27954,55 @@ class TrialComponent(Base):
         response = client.batch_put_metrics(**operation_input_args)
         logger.debug(f"Response: {response}")
 
+    @classmethod
+    @Base.add_validate_call
+    def batch_get_metrics(
+        cls,
+        metric_queries: List[MetricQuery],
+        session: Optional[Session] = None,
+        region: Optional[str] = None,
+    ) -> Optional[BatchGetMetricsResponse]:
+        """
+        Used to retrieve training metrics from SageMaker.
+
+        Parameters:
+            metric_queries: Queries made to retrieve training metrics from SageMaker.
+            session: Boto3 session.
+            region: Region name.
+
+        Returns:
+            BatchGetMetricsResponse
+
+        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']
+                ```
+        """
+
+        operation_input_args = {
+            "MetricQueries": metric_queries,
+        }
+        # serialize the input request
+        operation_input_args = serialize(operation_input_args)
+        logger.debug(f"Serialized input request: {operation_input_args}")
+
+        client = Base.get_sagemaker_client(
+            session=session, region_name=region, service_name="sagemaker-metrics"
+        )
+
+        logger.debug(f"Calling batch_get_metrics API")
+        response = client.batch_get_metrics(**operation_input_args)
+        logger.debug(f"Response: {response}")
+
+        transformed_response = transform(response, "BatchGetMetricsResponse")
+        return BatchGetMetricsResponse(**transformed_response)
+
 
 class UserProfile(Base):
     """

sagemaker_core/main/shapes.py

@@ -362,6 +362,62 @@ class ResourceNotFound(Base):
     message: Optional[str] = Unassigned()
 
 
+class MetricQuery(Base):
+    """
+    MetricQuery
+      Specifies a query to retrieve training metrics from SageMaker.
+
+    Attributes
+    ----------------------
+    metric_name: The name of the metric to retrieve.
+    resource_arn: The ARN of the SageMaker resource to retrieve metrics for.
+    metric_stat: The metrics stat type of metrics to retrieve.
+    period: The time period of metrics to retrieve.
+    x_axis_type: The x-axis type of metrics to retrieve.
+    start: The start time of metrics to retrieve.
+    end: The end time of metrics to retrieve.
+    """
+
+    metric_name: str
+    resource_arn: str
+    metric_stat: str
+    period: str
+    x_axis_type: str
+    start: Optional[int] = Unassigned()
+    end: Optional[int] = Unassigned()
+
+
+class MetricQueryResult(Base):
+    """
+    MetricQueryResult
+      The result of a query to retrieve training metrics from SageMaker.
+
+    Attributes
+    ----------------------
+    status: The status of the metric query.
+    message: A message describing the status of the metric query.
+    x_axis_values: The values for the x-axis of the metrics.
+    metric_values: The metric values retrieved by the query.
+    """
+
+    status: str
+    x_axis_values: List[int]
+    metric_values: List[float]
+    message: Optional[str] = Unassigned()
+
+
+class BatchGetMetricsResponse(Base):
+    """
+    BatchGetMetricsResponse
+
+    Attributes
+    ----------------------
+    metric_query_results: The results of a query to retrieve training metrics from SageMaker.
+    """
+
+    metric_query_results: Optional[List[MetricQueryResult]] = Unassigned()
+
+
 class BatchPutMetricsError(Base):
     """
     BatchPutMetricsError
@@ -491,6 +547,7 @@ class S3ModelDataSource(Base):
     compression_type: Specifies how the ML model data is prepared. If you choose Gzip and choose S3Object as the value of S3DataType, S3Uri identifies an object that is a gzip-compressed TAR archive. SageMaker will attempt to decompress and untar the object during model deployment. If you choose None and chooose S3Object as the value of S3DataType, S3Uri identifies an object that represents an uncompressed ML model to deploy. If you choose None and choose S3Prefix as the value of S3DataType, S3Uri identifies a key name prefix, under which all objects represents the uncompressed ML model to deploy. If you choose None, then SageMaker will follow rules below when creating model data files under /opt/ml/model directory for use by your inference code:   If you choose S3Object as the value of S3DataType, then SageMaker will split the key of the S3 object referenced by S3Uri by slash (/), and use the last part as the filename of the file holding the content of the S3 object.   If you choose S3Prefix as the value of S3DataType, then for each S3 object under the key name pefix referenced by S3Uri, SageMaker will trim its key by the prefix, and use the remainder as the path (relative to /opt/ml/model) of the file holding the content of the S3 object. SageMaker will split the remainder by slash (/), using intermediate parts as directory names and the last part as filename of the file holding the content of the S3 object.   Do not use any of the following as file names or directory names:   An empty or blank string   A string which contains null bytes   A string longer than 255 bytes   A single dot (.)   A double dot (..)     Ambiguous file names will result in model deployment failure. For example, if your uncompressed ML model consists of two S3 objects s3://mybucket/model/weights and s3://mybucket/model/weights/part1 and you specify s3://mybucket/model/ as the value of S3Uri and S3Prefix as the value of S3DataType, then it will result in name clash between /opt/ml/model/weights (a regular file) and /opt/ml/model/weights/ (a directory).   Do not organize the model artifacts in S3 console using folders. When you create a folder in S3 console, S3 creates a 0-byte object with a key set to the folder name you provide. They key of the 0-byte object ends with a slash (/) which violates SageMaker restrictions on model artifact file names, leading to model deployment failure.
     model_access_config: Specifies the access configuration file for the ML model. You can explicitly accept the model end-user license agreement (EULA) within the ModelAccessConfig. You are responsible for reviewing and complying with any applicable license terms and making sure they are acceptable for your use case before downloading or using a model.
     hub_access_config: Configuration information for hub access.
+    manifest_s3_uri: The Amazon S3 URI of the manifest file. The manifest file is a CSV file that stores the artifact locations.
     """
 
     s3_uri: str
@@ -498,6 +555,7 @@ class S3ModelDataSource(Base):
     compression_type: str
     model_access_config: Optional[ModelAccessConfig] = Unassigned()
     hub_access_config: Optional[InferenceHubAccessConfig] = Unassigned()
+    manifest_s3_uri: Optional[str] = Unassigned()
 
 
 class ModelDataSource(Base):
@@ -4258,6 +4316,21 @@ class CustomFileSystemConfig(Base):
     efs_file_system_config: Optional[EFSFileSystemConfig] = Unassigned()
 
 
+class HiddenSageMakerImage(Base):
+    """
+    HiddenSageMakerImage
+      The SageMaker images that are hidden from the Studio user interface. You must specify the SageMaker image name and version aliases.
+
+    Attributes
+    ----------------------
+    sage_maker_image_name:  The SageMaker image name that you are hiding from the Studio user interface.
+    version_aliases:  The version aliases you are hiding from the Studio user interface.
+    """
+
+    sage_maker_image_name: Optional[str] = Unassigned()
+    version_aliases: Optional[List[str]] = Unassigned()
+
+
 class StudioWebPortalSettings(Base):
     """
     StudioWebPortalSettings
@@ -4267,10 +4340,14 @@ class StudioWebPortalSettings(Base):
     ----------------------
     hidden_ml_tools: The machine learning tools that are hidden from the Studio left navigation pane.
     hidden_app_types: The Applications supported in Studio that are hidden from the Studio left navigation pane.
+    hidden_instance_types:  The instance types you are hiding from the Studio user interface.
+    hidden_sage_maker_image_version_aliases:  The version aliases you are hiding from the Studio user interface.
     """
 
     hidden_ml_tools: Optional[List[str]] = Unassigned()
     hidden_app_types: Optional[List[str]] = Unassigned()
+    hidden_instance_types: Optional[List[str]] = Unassigned()
+    hidden_sage_maker_image_version_aliases: Optional[List[HiddenSageMakerImage]] = Unassigned()
 
 
 class UserSettings(Base):
@@ -5803,15 +5880,15 @@ class HumanTaskConfig(Base):
 
     workteam_arn: str
     ui_config: UiConfig
-    pre_human_task_lambda_arn: str
     task_title: str
     task_description: str
     number_of_human_workers_per_data_object: int
     task_time_limit_in_seconds: int
-    annotation_consolidation_config: AnnotationConsolidationConfig
+    pre_human_task_lambda_arn: Optional[str] = Unassigned()
     task_keywords: Optional[List[str]] = Unassigned()
     task_availability_lifetime_in_seconds: Optional[int] = Unassigned()
     max_concurrent_task_count: Optional[int] = Unassigned()
+    annotation_consolidation_config: Optional[AnnotationConsolidationConfig] = Unassigned()
     public_workforce_task_price: Optional[PublicWorkforceTaskPrice] = Unassigned()
 
 
@@ -9933,7 +10010,7 @@ class LabelingJobSummary(Base):
     labeling_job_status: str
     label_counters: LabelCounters
     workteam_arn: str
-    pre_human_task_lambda_arn: str
+    pre_human_task_lambda_arn: Optional[str] = Unassigned()
     annotation_consolidation_lambda_arn: Optional[str] = Unassigned()
     failure_reason: Optional[str] = Unassigned()
     labeling_job_output: Optional[LabelingJobOutput] = Unassigned()

{sagemaker_core-1.0.6.dist-info → sagemaker_core-1.0.8.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: sagemaker-core
-Version: 1.0.6
+Version: 1.0.8
 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

{sagemaker_core-1.0.6.dist-info → sagemaker_core-1.0.8.dist-info}/RECORD

@@ -3,18 +3,18 @@ sagemaker_core/_version.py,sha256=t-XEKT8_pvKkl5z_UrfcIU256c_NxaI16qGWMuNVpbM,32
 sagemaker_core/helper/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 sagemaker_core/helper/session_helper.py,sha256=GO1UJgpN1L9a25nYlVb-KWk4KvmFzVkLqFMqw-VaI4c,33126
 sagemaker_core/main/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-sagemaker_core/main/config_schema.py,sha256=IDvL1YuMOwVg4nb0D4ysU51tc1UjlQASyz1QZoncs7I,56907
+sagemaker_core/main/config_schema.py,sha256=TeGoTobT4yotEVyfguLF0IdKYlOymsDZ45ySxXiCDuw,56998
 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/resources.py,sha256=S4wuM705rkah3cFO-kfWAXPgYq7SI3PG2Qh6ZHtfTfk,1314805
-sagemaker_core/main/shapes.py,sha256=kuefQBAgOogQynQikMq-6RxNezaVXE3ChwJedvVMAFw,693437
+sagemaker_core/main/resources.py,sha256=VjjmTLzPcjjg3c8-1g9Fv88Gpwimd9KuNq02378B6cE,1316658
+sagemaker_core/main/shapes.py,sha256=Groaj8psouJwQpRljmZIDeRM6fyU6p2J3wgjzcvQ_5k,696205
 sagemaker_core/main/user_agent.py,sha256=4sZybDXkzRoZnOnVDQ8p8zFTfiRJdsH7amDWInVQ4xU,2708
 sagemaker_core/main/utils.py,sha256=lXkJyiCow5uf32l0EmkimB0RKVk2BS7OM2fYoLsOfD4,18346
 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=2DjmeD2uND307UqDefvVEpE0rZ8yfFU3Bi3TvQCQveI,7658
 sagemaker_core/main/code_injection/constants.py,sha256=2ICExGge8vAWx7lSTW0JGh-bH1korkvpOpDu5M63eI4,980
-sagemaker_core/main/code_injection/shape_dag.py,sha256=iIkfDlMpNdzeLY958ZB3VTD55BJC1sid3qry-YOG-rM,655019
+sagemaker_core/main/code_injection/shape_dag.py,sha256=0OoQzH_r_TAYR2-KUKGQnGMD4U9Cb-NRMxc_SORIOdw,657895
 sagemaker_core/resources/__init__.py,sha256=EAYTFMN-nPjnPjjBbhIUeaL67FLKNPd7qbcbl9VIrws,31
 sagemaker_core/shapes/__init__.py,sha256=RnbIu9eTxKt-DNsOFJabrWIgrrtS9_SdAozP9JBl_ic,28
 sagemaker_core/tools/__init__.py,sha256=xX79JImxCVzrWMnjgntLCve2G5I-R4pRar5s20kT9Rs,56
@@ -27,8 +27,8 @@ sagemaker_core/tools/resources_extractor.py,sha256=hN61ehZbPnhFW-2FIVDi7NsEz4rLv
 sagemaker_core/tools/shapes_codegen.py,sha256=_ve959bwH8usZ6dPlpXxi2on9t0hLpcmhRWnaWHCWMQ,11745
 sagemaker_core/tools/shapes_extractor.py,sha256=4KjgDmhlPM4G1f1NeYbORKlXs1s7Q_sm_NK31S_ROQ0,11950
 sagemaker_core/tools/templates.py,sha256=nze_A01EpegYUwoR_gRv2qBNKNFruBY8L3RiIX5lz3M,22458
-sagemaker_core-1.0.6.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-sagemaker_core-1.0.6.dist-info/METADATA,sha256=yoth9VivBfunXlVEWY3wT575kCh-QM4zZn44LjSn3UQ,4877
-sagemaker_core-1.0.6.dist-info/WHEEL,sha256=GV9aMThwP_4oNCtvEC2ec3qUYutgWeAzklro_0m4WJQ,91
-sagemaker_core-1.0.6.dist-info/top_level.txt,sha256=R3GAZZ1zC5JxqdE_0x2Lu_WYi2Xfke7VsiP3L5zngfA,15
-sagemaker_core-1.0.6.dist-info/RECORD,,
+sagemaker_core-1.0.8.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+sagemaker_core-1.0.8.dist-info/METADATA,sha256=MvlRWwl72_MVfsHjlrirz1RooJ1vJBuyCrZe_HDJr9s,4877
+sagemaker_core-1.0.8.dist-info/WHEEL,sha256=GV9aMThwP_4oNCtvEC2ec3qUYutgWeAzklro_0m4WJQ,91
+sagemaker_core-1.0.8.dist-info/top_level.txt,sha256=R3GAZZ1zC5JxqdE_0x2Lu_WYi2Xfke7VsiP3L5zngfA,15
+sagemaker_core-1.0.8.dist-info/RECORD,,