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.
To perform batch transformations, you create a transform job and use the data that you have readily available.
In the request body, you provide the following:
TransformJobName - Identifies the transform job. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account.
ModelName - Identifies the model to use. ModelName 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 CreateModel.
TransformInput - Describes the dataset to be transformed and the Amazon S3 location where it is stored.
TransformOutput - Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.
TransformResources - Identifies the ML compute instances for the transform job.
For more information about how batch transformation works, see Batch Transform.
" + "documentation":"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.
To perform batch transformations, you create a transform job and use the data that you have readily available.
In the request body, you provide the following:
TransformJobName - Identifies the transform job. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account.
ModelName - Identifies the model to use. ModelName 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 CreateModel.
TransformInput - Describes the dataset to be transformed and the Amazon S3 location where it is stored.
TransformOutput - Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.
TransformResources - Identifies the ML compute instances and AMI image versions for the transform job.
For more information about how batch transformation works, see Batch Transform.
" }, "CreateTrial":{ "name":"CreateTrial", @@ -9161,6 +9161,10 @@ "ResourceSpec":{ "shape":"ResourceSpec", "documentation":"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.
Indicates whether the application is launched in recovery mode.
" } } }, @@ -13888,6 +13892,10 @@ "shape":"AppStatus", "documentation":"The status.
" }, + "RecoveryMode":{ + "shape":"Boolean", + "documentation":"Indicates whether the application is launched in recovery mode.
" + }, "LastHealthCheckTimestamp":{ "shape":"Timestamp", "documentation":"The timestamp of the last health check.
" @@ -35366,6 +35374,13 @@ }, "documentation":"Metadata for a register model job step.
" }, + "Relation":{ + "type":"string", + "enum":[ + "EqualTo", + "GreaterThanOrEqualTo" + ] + }, "ReleaseNotes":{ "type":"string", "max":255, @@ -36455,6 +36470,10 @@ "NextToken":{ "shape":"NextToken", "documentation":"If the result of the previous Search request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request.
The total number of matching results.
" } } }, @@ -38451,6 +38470,20 @@ "max":256, "min":1 }, + "TotalHits":{ + "type":"structure", + "members":{ + "Value":{ + "shape":"Long", + "documentation":"The total number of matching results. This value may be exact or an estimate, depending on the Relation field.
Indicates the relationship between the returned Value and the actual total number of matching results. Possible values are:
EqualTo: The Value is the exact count of matching results.
GreaterThanOrEqualTo: The Value is a lower bound of the actual count of matching results.
Represents the total number of matching results and indicates how accurate that count is.
The Value field provides the count, which may be exact or estimated. The Relation 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.
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.
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 VolumeKmsKeyId when using an instance type with local storage.
For a list of instance types that support local instance storage, see Instance Store Volumes.
For more information about local instance storage encryption, see SSD Instance Store Volumes.
The VolumeKmsKeyId can be any of the following formats:
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
Alias name: alias/ExampleAlias
Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias
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.
Accelerator: GPU
NVIDIA driver version: 470
Accelerator: GPU
NVIDIA driver version: 535
Describes the resources, including ML instance types and ML instance count, to use for transform job.
" diff --git a/src/sagemaker_core/main/code_injection/shape_dag.py b/src/sagemaker_core/main/code_injection/shape_dag.py index 6e3a9f4..1902534 100644 --- a/src/sagemaker_core/main/code_injection/shape_dag.py +++ b/src/sagemaker_core/main/code_injection/shape_dag.py @@ -1817,6 +1817,7 @@ {"name": "AppName", "shape": "AppName", "type": "string"}, {"name": "Tags", "shape": "TagList", "type": "list"}, {"name": "ResourceSpec", "shape": "ResourceSpec", "type": "structure"}, + {"name": "RecoveryMode", "shape": "Boolean", "type": "boolean"}, ], "type": "structure", }, @@ -4053,6 +4054,7 @@ {"name": "UserProfileName", "shape": "UserProfileName", "type": "string"}, {"name": "SpaceName", "shape": "SpaceName", "type": "string"}, {"name": "Status", "shape": "AppStatus", "type": "string"}, + {"name": "RecoveryMode", "shape": "Boolean", "type": "boolean"}, {"name": "LastHealthCheckTimestamp", "shape": "Timestamp", "type": "timestamp"}, {"name": "LastUserActivityTimestamp", "shape": "Timestamp", "type": "timestamp"}, {"name": "CreationTime", "shape": "Timestamp", "type": "timestamp"}, @@ -13337,6 +13339,7 @@ "members": [ {"name": "Results", "shape": "SearchResultsList", "type": "list"}, {"name": "NextToken", "shape": "NextToken", "type": "string"}, + {"name": "TotalHits", "shape": "TotalHits", "type": "structure"}, ], "type": "structure", }, @@ -14088,6 +14091,13 @@ ], "type": "structure", }, + "TotalHits": { + "members": [ + {"name": "Value", "shape": "Long", "type": "long"}, + {"name": "Relation", "shape": "Relation", "type": "string"}, + ], + "type": "structure", + }, "TrackingServerSummary": { "members": [ {"name": "TrackingServerArn", "shape": "TrackingServerArn", "type": "string"}, @@ -14488,6 +14498,7 @@ {"name": "InstanceType", "shape": "TransformInstanceType", "type": "string"}, {"name": "InstanceCount", "shape": "TransformInstanceCount", "type": "integer"}, {"name": "VolumeKmsKeyId", "shape": "KmsKeyId", "type": "string"}, + {"name": "TransformAmiVersion", "shape": "TransformAmiVersion", "type": "string"}, ], "type": "structure", }, diff --git a/src/sagemaker_core/main/resources.py b/src/sagemaker_core/main/resources.py index 5e5a0ae..9eb0755 100644 --- a/src/sagemaker_core/main/resources.py +++ b/src/sagemaker_core/main/resources.py @@ -974,6 +974,7 @@ class App(Base): user_profile_name: The user profile name. space_name: The name of the space. If this value is not set, then UserProfileName must be set. status: The status. + recovery_mode: Indicates whether the application is launched in recovery mode. last_health_check_timestamp: The timestamp of the last health check. 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. 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. @@ -990,6 +991,7 @@ class App(Base): user_profile_name: Optional[str] = Unassigned() space_name: Optional[str] = Unassigned() status: Optional[str] = Unassigned() + recovery_mode: Optional[bool] = Unassigned() last_health_check_timestamp: Optional[datetime.datetime] = Unassigned() last_user_activity_timestamp: Optional[datetime.datetime] = Unassigned() creation_time: Optional[datetime.datetime] = Unassigned() @@ -1024,6 +1026,7 @@ def create( space_name: Optional[Union[str, object]] = Unassigned(), tags: Optional[List[Tag]] = Unassigned(), resource_spec: Optional[ResourceSpec] = Unassigned(), + recovery_mode: Optional[bool] = Unassigned(), session: Optional[Session] = None, region: Optional[str] = None, ) -> Optional["App"]: @@ -1038,6 +1041,7 @@ def create( space_name: The name of the space. If this value is not set, then UserProfileName must be set. tags: Each tag consists of a key and an optional value. Tag keys must be unique per resource. 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. + recovery_mode: Indicates whether the application is launched in recovery mode. session: Boto3 session. region: Region name. @@ -1074,6 +1078,7 @@ def create( "AppName": app_name, "Tags": tags, "ResourceSpec": resource_spec, + "RecoveryMode": recovery_mode, } operation_input_args = Base.populate_chained_attributes( @@ -23690,7 +23695,10 @@ def get_name(self) -> str: def populate_inputs_decorator(create_func): @functools.wraps(create_func) def wrapper(*args, **kwargs): - config_schema_for_resource = {"execution_role_arn": {"type": "string"}} + config_schema_for_resource = { + "execution_role_arn": {"type": "string"}, + "kms_key_id": {"type": "string"}, + } return create_func( *args, **Base.get_updated_kwargs_with_configured_attributes( diff --git a/src/sagemaker_core/main/shapes.py b/src/sagemaker_core/main/shapes.py index a1a9621..d680b7f 100644 --- a/src/sagemaker_core/main/shapes.py +++ b/src/sagemaker_core/main/shapes.py @@ -1120,11 +1120,13 @@ class TransformResources(Base): instance_type: The ML compute instance type for the transform job. If you are using built-in algorithms to transform moderately sized datasets, we recommend using ml.m4.xlarge or ml.m5.largeinstance types. instance_count: The number of ML compute instances to use in the transform job. The default value is 1, and the maximum is 100. For distributed transform jobs, specify a value greater than 1. volume_kms_key_id: 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. 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 VolumeKmsKeyId when using an instance type with local storage. For a list of instance types that support local instance storage, see Instance Store Volumes. For more information about local instance storage encryption, see SSD Instance Store Volumes. The VolumeKmsKeyId can be any of the following formats: Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab Alias name: alias/ExampleAlias Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias + transform_ami_version: 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. al2-ami-sagemaker-batch-gpu-470 Accelerator: GPU NVIDIA driver version: 470 al2-ami-sagemaker-batch-gpu-535 Accelerator: GPU NVIDIA driver version: 535 """ instance_type: str instance_count: int volume_kms_key_id: Optional[str] = Unassigned() + transform_ami_version: Optional[str] = Unassigned() class TransformJobDefinition(Base): @@ -12520,6 +12522,21 @@ class VisibilityConditions(Base): value: Optional[str] = Unassigned() +class TotalHits(Base): + """ + TotalHits + Represents the total number of matching results and indicates how accurate that count is. The Value field provides the count, which may be exact or estimated. The Relation 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. + + Attributes + ---------------------- + value: The total number of matching results. This value may be exact or an estimate, depending on the Relation field. + relation: Indicates the relationship between the returned Value and the actual total number of matching results. Possible values are: EqualTo: The Value is the exact count of matching results. GreaterThanOrEqualTo: The Value is a lower bound of the actual count of matching results. + """ + + value: Optional[int] = Unassigned() + relation: Optional[str] = Unassigned() + + class TrainingPlanOffering(Base): """ TrainingPlanOffering