From 9e6d60d0d26333dc6f4b01c65b1607793d4bfcbd Mon Sep 17 00:00:00 2001
From: awstools S3Uri
always ends
* with a forward slash (/).
If you choose S3Object, S3Uri identifies an object that is the ML model data to - * deploy.
+ *If you choose S3Object
, S3Uri
identifies an object that is
+ * the ML model data to deploy.
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).
+ * 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 @@ -7912,7 +7912,7 @@ export interface ContainerDefinition { /** *
Specifies the location of ML model data to deploy.
*Currently you cannot use ModelDataSource
in conjuction with
+ *
Currently you cannot use ModelDataSource
in conjunction with
* SageMaker batch transform, SageMaker serverless endpoints, SageMaker multi-model endpoints, and SageMaker
* Marketplace.
Time to live duration, where the record is hard deleted after the expiration time is
+ * reached; ExpiresAt
= EventTime
+ TtlDuration
. For
+ * information on HardDelete, see the DeleteRecord API in the Amazon SageMaker API Reference guide.
+ * TtlDuration
time unit.
+ * TtlDuration
time value.
Use this to specify the Amazon Web Services Key Management Service (KMS) Key ID, or @@ -1170,6 +1207,13 @@ export interface OnlineStoreConfig { *
The default value is False
.
Time to live duration, where the record is hard deleted after the expiration time is
+ * reached; ExpiresAt
= EventTime
+ TtlDuration
. For
+ * information on HardDelete, see the DeleteRecord API in the Amazon SageMaker API Reference guide.
The name of the model to delete.
- */ - ModelName: string | undefined; -} - -/** - * @public - */ -export interface DeleteModelBiasJobDefinitionRequest { - /** - *The name of the model bias job definition to delete.
- */ - JobDefinitionName: string | undefined; -} - /** * @internal */ diff --git a/clients/client-sagemaker/src/models/models_2.ts b/clients/client-sagemaker/src/models/models_2.ts index 3fcab597efa7..afb5a7822a8f 100644 --- a/clients/client-sagemaker/src/models/models_2.ts +++ b/clients/client-sagemaker/src/models/models_2.ts @@ -177,6 +177,26 @@ import { VendorGuidance, } from "./models_1"; +/** + * @public + */ +export interface DeleteModelInput { + /** + *The name of the model to delete.
+ */ + ModelName: string | undefined; +} + +/** + * @public + */ +export interface DeleteModelBiasJobDefinitionRequest { + /** + *The name of the model bias job definition to delete.
+ */ + JobDefinitionName: string | undefined; +} + /** * @public */ @@ -10150,67 +10170,6 @@ export interface HubContentInfo { CreationTime: Date | undefined; } -/** - * @public - * @enum - */ -export const HubContentSortBy = { - CREATION_TIME: "CreationTime", - HUB_CONTENT_NAME: "HubContentName", - HUB_CONTENT_STATUS: "HubContentStatus", -} as const; - -/** - * @public - */ -export type HubContentSortBy = (typeof HubContentSortBy)[keyof typeof HubContentSortBy]; - -/** - * @public - *Information about a hub.
- */ -export interface HubInfo { - /** - *The name of the hub.
- */ - HubName: string | undefined; - - /** - *The Amazon Resource Name (ARN) of the hub.
- */ - HubArn: string | undefined; - - /** - *The display name of the hub.
- */ - HubDisplayName?: string; - - /** - *A description of the hub.
- */ - HubDescription?: string; - - /** - *The searchable keywords for the hub.
- */ - HubSearchKeywords?: string[]; - - /** - *The status of the hub.
- */ - HubStatus: HubStatus | string | undefined; - - /** - *The date and time that the hub was created.
- */ - CreationTime: Date | undefined; - - /** - *The date and time that the hub was last modified.
- */ - LastModifiedTime: Date | undefined; -} - /** * @internal */ diff --git a/clients/client-sagemaker/src/models/models_3.ts b/clients/client-sagemaker/src/models/models_3.ts index 6448f1f8e2b0..a23dd14482dd 100644 --- a/clients/client-sagemaker/src/models/models_3.ts +++ b/clients/client-sagemaker/src/models/models_3.ts @@ -92,6 +92,7 @@ import { TrialComponentArtifact, TrialComponentParameterValue, TrialComponentStatus, + TtlDuration, UiTemplate, } from "./models_1"; import { @@ -127,8 +128,7 @@ import { Filter, FlowDefinitionSummary, HubContentInfo, - HubContentSortBy, - HubInfo, + HubStatus, HyperParameterTrainingJobSummary, HyperParameterTuningJobCompletionDetails, HyperParameterTuningJobConsumedResources, @@ -177,6 +177,67 @@ import { Workteam, } from "./models_2"; +/** + * @public + * @enum + */ +export const HubContentSortBy = { + CREATION_TIME: "CreationTime", + HUB_CONTENT_NAME: "HubContentName", + HUB_CONTENT_STATUS: "HubContentStatus", +} as const; + +/** + * @public + */ +export type HubContentSortBy = (typeof HubContentSortBy)[keyof typeof HubContentSortBy]; + +/** + * @public + *Information about a hub.
+ */ +export interface HubInfo { + /** + *The name of the hub.
+ */ + HubName: string | undefined; + + /** + *The Amazon Resource Name (ARN) of the hub.
+ */ + HubArn: string | undefined; + + /** + *The display name of the hub.
+ */ + HubDisplayName?: string; + + /** + *A description of the hub.
+ */ + HubDescription?: string; + + /** + *The searchable keywords for the hub.
+ */ + HubSearchKeywords?: string[]; + + /** + *The status of the hub.
+ */ + HubStatus: HubStatus | string | undefined; + + /** + *The date and time that the hub was created.
+ */ + CreationTime: Date | undefined; + + /** + *The date and time that the hub was last modified.
+ */ + LastModifiedTime: Date | undefined; +} + /** * @public * @enum @@ -8589,6 +8650,19 @@ export interface NestedFilters { Filters: Filter[] | undefined; } +/** + * @public + *Updates the feature group online store configuration.
+ */ +export interface OnlineStoreConfigUpdate { + /** + *Time to live duration, where the record is hard deleted after the expiration time is
+ * reached; ExpiresAt
= EventTime
+ TtlDuration
. For
+ * information on HardDelete, see the DeleteRecord API in the Amazon SageMaker API Reference guide.
The trial that a trial component is associated with and the experiment the trial is part @@ -10113,41 +10187,6 @@ export interface SendPipelineExecutionStepSuccessResponse { PipelineExecutionArn?: string; } -/** - * @public - */ -export interface StartEdgeDeploymentStageRequest { - /** - *
The name of the edge deployment plan to start.
- */ - EdgeDeploymentPlanName: string | undefined; - - /** - *The name of the stage to start.
- */ - StageName: string | undefined; -} - -/** - * @public - */ -export interface StartInferenceExperimentRequest { - /** - *The name of the inference experiment to start.
- */ - Name: string | undefined; -} - -/** - * @public - */ -export interface StartInferenceExperimentResponse { - /** - *The ARN of the started inference experiment to start.
- */ - InferenceExperimentArn: string | undefined; -} - /** * @internal */ diff --git a/clients/client-sagemaker/src/models/models_4.ts b/clients/client-sagemaker/src/models/models_4.ts index 7fd32fe40172..fac0ea3b330a 100644 --- a/clients/client-sagemaker/src/models/models_4.ts +++ b/clients/client-sagemaker/src/models/models_4.ts @@ -61,12 +61,48 @@ import { InferenceExperimentStopDesiredState, ModelVariantAction, NestedFilters, + OnlineStoreConfigUpdate, Parameter, ProfilerConfigForUpdate, ResourceConfigForUpdate, SearchSortOrder, } from "./models_3"; +/** + * @public + */ +export interface StartEdgeDeploymentStageRequest { + /** + *The name of the edge deployment plan to start.
+ */ + EdgeDeploymentPlanName: string | undefined; + + /** + *The name of the stage to start.
+ */ + StageName: string | undefined; +} + +/** + * @public + */ +export interface StartInferenceExperimentRequest { + /** + *The name of the inference experiment to start.
+ */ + Name: string | undefined; +} + +/** + * @public + */ +export interface StartInferenceExperimentResponse { + /** + *The ARN of the started inference experiment to start.
+ */ + InferenceExperimentArn: string | undefined; +} + /** * @public */ @@ -800,6 +836,11 @@ export interface UpdateFeatureGroupRequest { * made a valid request for Feature Store to update the feature group. */ FeatureAdditions?: FeatureDefinition[]; + + /** + *Updates the feature group online store configuration.
+ */ + OnlineStoreConfig?: OnlineStoreConfigUpdate; } /** diff --git a/clients/client-sagemaker/src/protocols/Aws_json1_1.ts b/clients/client-sagemaker/src/protocols/Aws_json1_1.ts index b8ba108397d6..ca434b5ac9c8 100644 --- a/clients/client-sagemaker/src/protocols/Aws_json1_1.ts +++ b/clients/client-sagemaker/src/protocols/Aws_json1_1.ts @@ -1042,8 +1042,6 @@ import { DeleteImageRequest, DeleteImageVersionRequest, DeleteInferenceExperimentRequest, - DeleteModelBiasJobDefinitionRequest, - DeleteModelInput, DeploymentConfig, DeploymentStage, DeviceSelectionConfig, @@ -1177,6 +1175,7 @@ import { TrialComponentArtifact, TrialComponentParameterValue, TrialComponentStatus, + TtlDuration, TuningJobCompletionCriteria, UiConfig, UiTemplate, @@ -1184,8 +1183,10 @@ import { WorkforceVpcConfigRequest, } from "../models/models_1"; import { + DeleteModelBiasJobDefinitionRequest, DeleteModelCardRequest, DeleteModelExplainabilityJobDefinitionRequest, + DeleteModelInput, DeleteModelPackageGroupInput, DeleteModelPackageGroupPolicyInput, DeleteModelPackageInput, @@ -1355,7 +1356,6 @@ import { GetSearchSuggestionsRequest, GitConfigForUpdate, HubContentInfo, - HubInfo, HyperParameterTrainingJobSummary, HyperParameterTuningJobCompletionDetails, InferenceRecommendation, @@ -1380,6 +1380,7 @@ import { Workteam, } from "../models/models_2"; import { + HubInfo, HumanTaskUiSummary, HyperParameterTuningJobSearchEntity, HyperParameterTuningJobSummary, @@ -1554,6 +1555,7 @@ import { NestedFilters, NotebookInstanceLifecycleConfigSummary, NotebookInstanceSummary, + OnlineStoreConfigUpdate, Parameter, Pipeline, PipelineExecution, @@ -1579,8 +1581,6 @@ import { SendPipelineExecutionStepFailureRequest, SendPipelineExecutionStepSuccessRequest, SpaceDetails, - StartEdgeDeploymentStageRequest, - StartInferenceExperimentRequest, StudioLifecycleConfigDetails, TrainingJob, TrainingJobSummary, @@ -1598,6 +1598,8 @@ import { SearchExpression, SearchRequest, ServiceCatalogProvisioningUpdateDetails, + StartEdgeDeploymentStageRequest, + StartInferenceExperimentRequest, StartMonitoringScheduleRequest, StartNotebookInstanceInput, StartPipelineExecutionRequest, @@ -21378,6 +21380,8 @@ const se_MonitoringScheduleConfig = (input: MonitoringScheduleConfig, context: _ // se_OnlineStoreConfig omitted. +// se_OnlineStoreConfigUpdate omitted. + // se_OnlineStoreSecurityConfig omitted. // se_OutputConfig omitted. @@ -21863,6 +21867,8 @@ const se_TrialComponentParameterValue = (input: TrialComponentParameterValue, co // se_TrialComponentStatus omitted. +// se_TtlDuration omitted. + /** * serializeAws_json1_1TuningJobCompletionCriteria */ @@ -28061,6 +28067,8 @@ const de_TrialSummary = (output: any, context: __SerdeContext): TrialSummary => }) as any; }; +// de_TtlDuration omitted. + /** * deserializeAws_json1_1TuningJobCompletionCriteria */ diff --git a/codegen/sdk-codegen/aws-models/sagemaker.json b/codegen/sdk-codegen/aws-models/sagemaker.json index 641f3ff2cf35..9278f75a6ca0 100644 --- a/codegen/sdk-codegen/aws-models/sagemaker.json +++ b/codegen/sdk-codegen/aws-models/sagemaker.json @@ -5998,7 +5998,7 @@ "ModelDataSource": { "target": "com.amazonaws.sagemaker#ModelDataSource", "traits": { - "smithy.api#documentation": "Specifies the location of ML model data to deploy.
\nCurrently you cannot use ModelDataSource
in conjuction with\n SageMaker batch transform, SageMaker serverless endpoints, SageMaker multi-model endpoints, and SageMaker\n Marketplace.
Specifies the location of ML model data to deploy.
\nCurrently you cannot use ModelDataSource
in conjunction with\n SageMaker batch transform, SageMaker serverless endpoints, SageMaker multi-model endpoints, and SageMaker\n Marketplace.
Turn OnlineStore
off by specifying False
\n for the EnableOnlineStore
flag. Turn OnlineStore
\n on by specifying True
\n for the EnableOnlineStore
flag.
The default value is False
.
Time to live duration, where the record is hard deleted after the expiration time is\n reached; ExpiresAt
= EventTime
+ TtlDuration
. For\n information on HardDelete, see the DeleteRecord API in the Amazon SageMaker API Reference guide.
Use this to specify the Amazon Web Services Key Management Service (KMS) Key ID, or\n KMSKeyId
, for at rest data encryption. You can turn\n OnlineStore
on or off by specifying the EnableOnlineStore
flag\n at General Assembly.
The default value is False
.
Time to live duration, where the record is hard deleted after the expiration time is\n reached; ExpiresAt
= EventTime
+ TtlDuration
. For\n information on HardDelete, see the DeleteRecord API in the Amazon SageMaker API Reference guide.
Updates the feature group online store configuration.
" + } + }, "com.amazonaws.sagemaker#OnlineStoreSecurityConfig": { "type": "structure", "members": { @@ -47830,14 +47850,14 @@ "S3DataType": { "target": "com.amazonaws.sagemaker#S3ModelDataType", "traits": { - "smithy.api#documentation": "Specifies the type of ML model data to deploy.
\nIf you choose S3Prefix
, S3Uri
identifies a key name prefix.\n SageMaker uses all objects that match the specified key name prefix as part of the ML model\n data to deploy. A valid key name prefix identified by S3Uri
always ends\n with a forward slash (/).
If you choose S3Object, S3Uri identifies an object that is the ML model data to\n deploy.
", + "smithy.api#documentation": "Specifies the type of ML model data to deploy.
\nIf you choose S3Prefix
, S3Uri
identifies a key name prefix.\n SageMaker uses all objects that match the specified key name prefix as part of the ML model\n data to deploy. A valid key name prefix identified by S3Uri
always ends\n with a forward slash (/).
If you choose S3Object
, S3Uri
identifies an object that is\n the ML model data to deploy.
Specifies how the ML model data is prepared.
\nIf you choose Gzip
and choose S3Object
as the value of\n S3DataType
, S3Uri
identifies an object that is a\n gzip-compressed TAR archive. SageMaker will attempt to decompress and untar the object\n during model deployment.
If you choose None
and chooose S3Object
as the value of\n S3DataType
, S3Uri
identifies an object that represents an\n uncompressed ML model to deploy.
If you choose None and choose S3Prefix
as the value of\n S3DataType
, S3Uri
identifies a key name prefix, under which\n all objects represents the uncompressed ML model to deploy.
If you choose None, then SageMaker will follow rules below when creating model data files\n under /opt/ml/model directory for use by your inference code:
\nIf you choose S3Object
as the value of S3DataType
,\n then SageMaker will split the key of the S3 object referenced by S3Uri
by\n slash (/), and use the last part as the filename of the file holding the content\n of the S3 object.
If you choose S3Prefix
as the value of S3DataType
,\n then for each S3 object under the key name pefix referenced by S3Uri
,\n SageMaker will trim its key by the prefix, and use the remainder as the path\n (relative to /opt/ml/model
) of the file holding the content of the\n S3 object. SageMaker will split the remainder by slash (/), using intermediate parts as\n directory names and the last part as filename of the file holding the content of\n the S3 object.
Do not use any of the following as file names or directory names:
\nAn empty or blank string
\nA string which contains null bytes
\nA string longer than 255 bytes
\nA single dot (.
)
A double dot (..
)
Ambiguous file names will result in model deployment failure. For example,\n if your uncompressed ML model consists of two S3 objects\n s3://mybucket/model/weights
and s3://mybucket/model/weights/part1
\n and you specify s3://mybucket/model/
as the value of S3Uri
and\n S3Prefix
as the value of S3DataType, then it will result in name clash between\n /opt/ml/model/weights
(a regular file) and /opt/ml/model/weights/
\n (a directory).
Do not organize the model artifacts in\n S3 console using folders.\n When you create a folder in S3 console, S3 creates a 0-byte object with a key set to the\n folder name you provide. They key of the 0-byte object ends with a slash (/) which violates\n SageMaker restrictions on model artifact file names, leading to model deployment failure.\n
\nSpecifies how the ML model data is prepared.
\nIf you choose Gzip
and choose S3Object
as the value of\n S3DataType
, S3Uri
identifies an object that is a\n gzip-compressed TAR archive. SageMaker will attempt to decompress and untar the object\n during model deployment.
If you choose None
and chooose S3Object
as the value of\n S3DataType
, S3Uri
identifies an object that represents an\n uncompressed ML model to deploy.
If you choose None and choose S3Prefix
as the value of\n S3DataType
, S3Uri
identifies a key name prefix, under which\n all objects represents the uncompressed ML model to deploy.
If you choose None, then SageMaker will follow rules below when creating model data files\n under /opt/ml/model directory for use by your inference code:
\nIf you choose S3Object
as the value of S3DataType
,\n then SageMaker will split the key of the S3 object referenced by S3Uri
by\n slash (/), and use the last part as the filename of the file holding the content\n of the S3 object.
If you choose S3Prefix
as the value of S3DataType
,\n then for each S3 object under the key name pefix referenced by S3Uri
,\n SageMaker will trim its key by the prefix, and use the remainder as the path\n (relative to /opt/ml/model
) of the file holding the content of the\n S3 object. SageMaker will split the remainder by slash (/), using intermediate parts as\n directory names and the last part as filename of the file holding the content of\n the S3 object.
Do not use any of the following as file names or directory names:
\nAn empty or blank string
\nA string which contains null bytes
\nA string longer than 255 bytes
\nA single dot (.
)
A double dot (..
)
Ambiguous file names will result in model deployment failure. For example,\n if your uncompressed ML model consists of two S3 objects\n s3://mybucket/model/weights
and s3://mybucket/model/weights/part1
\n and you specify s3://mybucket/model/
as the value of S3Uri
and\n S3Prefix
as the value of S3DataType
, then it will result in name\n clash between /opt/ml/model/weights
(a regular file) and\n /opt/ml/model/weights/
(a directory).
Do not organize the model artifacts in\n S3 console using folders.\n When you create a folder in S3 console, S3 creates a 0-byte object with a key set to the\n folder name you provide. They key of the 0-byte object ends with a slash (/) which violates\n SageMaker restrictions on model artifact file names, leading to model deployment failure.\n
\nA summary of the properties of a trial. To get the complete set of properties, call the\n DescribeTrial API and provide the TrialName
.
\n TtlDuration
time unit.
\n TtlDuration
time value.
Time to live duration, where the record is hard deleted after the expiration time is\n reached; ExpiresAt
= EventTime
+ TtlDuration
. For\n information on HardDelete, see the DeleteRecord API in the Amazon SageMaker API Reference guide.
Updates the feature group. Updating a feature group is an asynchronous operation. When\n you get an HTTP 200 response, you've made a valid request. It takes some time after you've\n made a valid request for Feature Store to update the feature group.
" } + }, + "OnlineStoreConfig": { + "target": "com.amazonaws.sagemaker#OnlineStoreConfigUpdate", + "traits": { + "smithy.api#documentation": "Updates the feature group online store configuration.
" + } } }, "traits": {