| Column Name | Column Data Type |
|---|
model_name Required Input Column
Name of the SageMaker model. | VARCHAR |
_aws_profile Input Column
The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role. | STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
) |
Show child fields- _aws_profile.account_id
The AWS account id - _aws_profile.assumed_role_arn
The ARN of the assumed role - _aws_profile.name
The unique name of the profile. - _aws_profile.organization
Information about this profile's membership in the AWS organization. Show child fields- _aws_profile.organization.account_name
The name of account speciifed by the organization - _aws_profile.organization.id
The organization id - _aws_profile.organization.master_account
Show child fields- _aws_profile.organization.master_account.email
The organization master account email address - _aws_profile.organization.master_account.id
The organization master account id
- _aws_profile.organization.parents[]
Show child fields- _aws_profile.organization.parents[].id
The id of the parent - _aws_profile.organization.parents[].name
The name of the parent - _aws_profile.organization.parents[].tags[]
Show child fields- _aws_profile.organization.parents[].tags[].key
- _aws_profile.organization.parents[].tags[].value
- _aws_profile.organization.parents[].type
The type of parent can be an organization unit or a root
- _aws_profile.organization.tags[]
Show child fields- _aws_profile.organization.tags[].key
- _aws_profile.organization.tags[].value
- _aws_profile.type
The type of profile, either 'credentials' or 'assumed_role' - _aws_profile.via_profile_name
This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.
|
containers
The containers in the inference pipeline. | STRUCT(
"container_hostname" VARCHAR,
"image" VARCHAR,
"image_config" STRUCT(
"repository_access_mode" VARCHAR,
"repository_auth_config" STRUCT(
"repository_credentials_provider_arn" VARCHAR
)
),
"mode" VARCHAR,
"model_data_url" VARCHAR,
"model_data_source" STRUCT(
"s3_data_source" STRUCT(
"s3_uri" VARCHAR,
"s3_data_type" VARCHAR,
"compression_type" VARCHAR,
"model_access_config" STRUCT(
"accept_eula" BOOLEAN
),
"hub_access_config" STRUCT(
"hub_content_arn" VARCHAR
)
)
),
"additional_model_data_sources" STRUCT(
"channel_name" VARCHAR,
"s3_data_source" STRUCT(
"s3_uri" VARCHAR,
"s3_data_type" VARCHAR,
"compression_type" VARCHAR,
"model_access_config" STRUCT(
"accept_eula" BOOLEAN
),
"hub_access_config" STRUCT(
"hub_content_arn" VARCHAR
)
)
)[],
"environment" MAP(VARCHAR, VARCHAR),
"model_package_name" VARCHAR,
"inference_specification_name" VARCHAR,
"multi_model_config" STRUCT(
"model_cache_setting" VARCHAR
)
)[] |
Show child fields- containers[]
Show child fields- containers[].additional_model_data_sources[]
Show child fields- containers[].additional_model_data_sources[].channel_name
A custom name for this AdditionalModelDataSource object. - containers[].additional_model_data_sources[].s3_data_source
Specifies the S3 location of ML model data to deploy. Show child fields- containers[].additional_model_data_sources[].s3_data_source.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: -
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. - containers[].additional_model_data_sources[].s3_data_source.hub_access_config
Configuration information for hub access. Show child fields- containers[].additional_model_data_sources[].s3_data_source.hub_access_config.hub_content_arn
The ARN of the hub content for which deployment access is allowed.
- containers[].additional_model_data_sources[].s3_data_source.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. Show child fields- containers[].additional_model_data_sources[].s3_data_source.model_access_config.accept_eula
Specifies agreement to the model end-user license agreement (EULA). The AcceptEula value must be explicitly defined as True in order to accept the EULA that this model requires. 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.
- containers[].additional_model_data_sources[].s3_data_source.s3_data_type
Specifies the type of ML model data to deploy. If you choose S3Prefix, S3Uri identifies a key name prefix. SageMaker uses all objects that match the specified key name prefix as part of the ML model data to deploy. A valid key name prefix identified by S3Uri always ends with a forward slash (/). If you choose S3Object, S3Uri identifies an object that is the ML model data to deploy. - containers[].additional_model_data_sources[].s3_data_source.s3_uri
Specifies the S3 path of ML model data to deploy.
- containers[].container_hostname
This parameter is ignored for models that contain only a PrimaryContainer. When a ContainerDefinition is part of an inference pipeline, the value of the parameter uniquely identifies the container for the purposes of logging and metrics. For information, see Use Logs and Metrics to Monitor an Inference Pipeline. If you don't specify a value for this parameter for a ContainerDefinition that is part of an inference pipeline, a unique name is automatically assigned based on the position of the ContainerDefinition in the pipeline. If you specify a value for the ContainerHostName for any ContainerDefinition that is part of an inference pipeline, you must specify a value for the ContainerHostName parameter of every ContainerDefinition in that pipeline. - containers[].environment
The environment variables to set in the Docker container. The maximum length of each key and value in the Environment map is 1024 bytes. The maximum length of all keys and values in the map, combined, is 32 KB. If you pass multiple containers to a CreateModel request, then the maximum length of all of their maps, combined, is also 32 KB. - containers[].image
The path where inference code is stored. This can be either in Amazon EC2 Container Registry or in a Docker registry that is accessible from the same VPC that you configure for your endpoint. If you are using your own custom algorithm instead of an algorithm provided by SageMaker, the inference code must meet SageMaker requirements. SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker. The model artifacts in an Amazon S3 bucket and the Docker image for inference container in Amazon EC2 Container Registry must be in the same region as the model or endpoint you are creating. - containers[].image_config
Specifies whether the model container is in Amazon ECR or a private Docker registry accessible from your Amazon Virtual Private Cloud (VPC). For information about storing containers in a private Docker registry, see Use a Private Docker Registry for Real-Time Inference Containers. The model artifacts in an Amazon S3 bucket and the Docker image for inference container in Amazon EC2 Container Registry must be in the same region as the model or endpoint you are creating. Show child fields- containers[].image_config.repository_access_mode
Set this to one of the following values: - containers[].image_config.repository_auth_config
(Optional) Specifies an authentication configuration for the private docker registry where your model image is hosted. Specify a value for this property only if you specified Vpc as the value for the RepositoryAccessMode field, and the private Docker registry where the model image is hosted requires authentication. Show child fields- containers[].image_config.repository_auth_config.repository_credentials_provider_arn
The Amazon Resource Name (ARN) of an Amazon Web Services Lambda function that provides credentials to authenticate to the private Docker registry where your model image is hosted. For information about how to create an Amazon Web Services Lambda function, see Create a Lambda function with the console in the Amazon Web Services Lambda Developer Guide.
- containers[].inference_specification_name
The inference specification name in the model package version. - containers[].mode
Whether the container hosts a single model or multiple models. - containers[].model_data_source
Specifies the location of ML model data to deploy. Currently you cannot use ModelDataSource in conjunction with SageMaker batch transform, SageMaker serverless endpoints, SageMaker multi-model endpoints, and SageMaker Marketplace. Show child fields- containers[].model_data_source.s3_data_source
Specifies the S3 location of ML model data to deploy. Show child fields- containers[].model_data_source.s3_data_source.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: -
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. - containers[].model_data_source.s3_data_source.hub_access_config
Configuration information for hub access. Show child fields- containers[].model_data_source.s3_data_source.hub_access_config.hub_content_arn
The ARN of the hub content for which deployment access is allowed.
- containers[].model_data_source.s3_data_source.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. Show child fields- containers[].model_data_source.s3_data_source.model_access_config.accept_eula
Specifies agreement to the model end-user license agreement (EULA). The AcceptEula value must be explicitly defined as True in order to accept the EULA that this model requires. 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.
- containers[].model_data_source.s3_data_source.s3_data_type
Specifies the type of ML model data to deploy. If you choose S3Prefix, S3Uri identifies a key name prefix. SageMaker uses all objects that match the specified key name prefix as part of the ML model data to deploy. A valid key name prefix identified by S3Uri always ends with a forward slash (/). If you choose S3Object, S3Uri identifies an object that is the ML model data to deploy. - containers[].model_data_source.s3_data_source.s3_uri
Specifies the S3 path of ML model data to deploy.
- containers[].model_data_url
The S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix). The S3 path is required for SageMaker built-in algorithms, but not if you use your own algorithms. For more information on built-in algorithms, see Common Parameters. The model artifacts must be in an S3 bucket that is in the same region as the model or endpoint you are creating. If you provide a value for this parameter, SageMaker uses Amazon Web Services Security Token Service to download model artifacts from the S3 path you provide. Amazon Web Services STS is activated in your Amazon Web Services account by default. If you previously deactivated Amazon Web Services STS for a region, you need to reactivate Amazon Web Services STS for that region. For more information, see Activating and Deactivating Amazon Web Services STS in an Amazon Web Services Region in the Amazon Web Services Identity and Access Management User Guide. If you use a built-in algorithm to create a model, SageMaker requires that you provide a S3 path to the model artifacts in ModelDataUrl. - containers[].model_package_name
The name or Amazon Resource Name (ARN) of the model package to use to create the model. - containers[].multi_model_config
Specifies additional configuration for multi-model endpoints. Show child fields- containers[].multi_model_config.model_cache_setting
Whether to cache models for a multi-model endpoint. By default, multi-model endpoints cache models so that a model does not have to be loaded into memory each time it is invoked. Some use cases do not benefit from model caching. For example, if an endpoint hosts a large number of models that are each invoked infrequently, the endpoint might perform better if you disable model caching. To disable model caching, set the value of this parameter to Disabled.
|
creation_time
A timestamp that shows when the model was created. | TIMESTAMP_S |
deployment_recommendation
A set of recommended deployment configurations for the model. | STRUCT(
"recommendation_status" VARCHAR,
"real_time_inference_recommendations" STRUCT(
"recommendation_id" VARCHAR,
"instance_type" VARCHAR,
"environment" MAP(VARCHAR, VARCHAR)
)[]
) |
Show child fields- deployment_recommendation.real_time_inference_recommendations[]
Show child fields- deployment_recommendation.real_time_inference_recommendations[].environment
The recommended environment variables to set in the model container for Real-Time Inference. - deployment_recommendation.real_time_inference_recommendations[].instance_type
The recommended instance type for Real-Time Inference. - deployment_recommendation.real_time_inference_recommendations[].recommendation_id
The recommendation ID which uniquely identifies each recommendation.
- deployment_recommendation.recommendation_status
Status of the deployment recommendation. The status NOT_APPLICABLE means that SageMaker is unable to provide a default recommendation for the model using the information provided. If the deployment status is IN_PROGRESS, retry your API call after a few seconds to get a COMPLETED deployment recommendation.
|
enable_network_isolation
If True, no inbound or outbound network calls can be made to or from the model container. | BOOLEAN |
execution_role_arn
The Amazon Resource Name (ARN) of the IAM role that you specified for the model. | VARCHAR |
inference_execution_config
Specifies details of how containers in a multi-container endpoint are called. | STRUCT(
"mode" VARCHAR
) |
Show child fields- inference_execution_config.mode
How containers in a multi-container are run. The following values are valid.
|
model_arn
The Amazon Resource Name (ARN) of the model. | VARCHAR |
primary_container
The location of the primary inference code, associated artifacts, and custom environment map that the inference code uses when it is deployed in production. | STRUCT(
"container_hostname" VARCHAR,
"image" VARCHAR,
"image_config" STRUCT(
"repository_access_mode" VARCHAR,
"repository_auth_config" STRUCT(
"repository_credentials_provider_arn" VARCHAR
)
),
"mode" VARCHAR,
"model_data_url" VARCHAR,
"model_data_source" STRUCT(
"s3_data_source" STRUCT(
"s3_uri" VARCHAR,
"s3_data_type" VARCHAR,
"compression_type" VARCHAR,
"model_access_config" STRUCT(
"accept_eula" BOOLEAN
),
"hub_access_config" STRUCT(
"hub_content_arn" VARCHAR
)
)
),
"additional_model_data_sources" STRUCT(
"channel_name" VARCHAR,
"s3_data_source" STRUCT(
"s3_uri" VARCHAR,
"s3_data_type" VARCHAR,
"compression_type" VARCHAR,
"model_access_config" STRUCT(
"accept_eula" BOOLEAN
),
"hub_access_config" STRUCT(
"hub_content_arn" VARCHAR
)
)
)[],
"environment" MAP(VARCHAR, VARCHAR),
"model_package_name" VARCHAR,
"inference_specification_name" VARCHAR,
"multi_model_config" STRUCT(
"model_cache_setting" VARCHAR
)
) |
Show child fields- primary_container.additional_model_data_sources[]
Show child fields- primary_container.additional_model_data_sources[].channel_name
A custom name for this AdditionalModelDataSource object. - primary_container.additional_model_data_sources[].s3_data_source
Specifies the S3 location of ML model data to deploy. Show child fields- primary_container.additional_model_data_sources[].s3_data_source.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: -
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. - primary_container.additional_model_data_sources[].s3_data_source.hub_access_config
Configuration information for hub access. Show child fields- primary_container.additional_model_data_sources[].s3_data_source.hub_access_config.hub_content_arn
The ARN of the hub content for which deployment access is allowed.
- primary_container.additional_model_data_sources[].s3_data_source.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. Show child fields- primary_container.additional_model_data_sources[].s3_data_source.model_access_config.accept_eula
Specifies agreement to the model end-user license agreement (EULA). The AcceptEula value must be explicitly defined as True in order to accept the EULA that this model requires. 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.
- primary_container.additional_model_data_sources[].s3_data_source.s3_data_type
Specifies the type of ML model data to deploy. If you choose S3Prefix, S3Uri identifies a key name prefix. SageMaker uses all objects that match the specified key name prefix as part of the ML model data to deploy. A valid key name prefix identified by S3Uri always ends with a forward slash (/). If you choose S3Object, S3Uri identifies an object that is the ML model data to deploy. - primary_container.additional_model_data_sources[].s3_data_source.s3_uri
Specifies the S3 path of ML model data to deploy.
- primary_container.container_hostname
This parameter is ignored for models that contain only a PrimaryContainer. When a ContainerDefinition is part of an inference pipeline, the value of the parameter uniquely identifies the container for the purposes of logging and metrics. For information, see Use Logs and Metrics to Monitor an Inference Pipeline. If you don't specify a value for this parameter for a ContainerDefinition that is part of an inference pipeline, a unique name is automatically assigned based on the position of the ContainerDefinition in the pipeline. If you specify a value for the ContainerHostName for any ContainerDefinition that is part of an inference pipeline, you must specify a value for the ContainerHostName parameter of every ContainerDefinition in that pipeline. - primary_container.environment
The environment variables to set in the Docker container. The maximum length of each key and value in the Environment map is 1024 bytes. The maximum length of all keys and values in the map, combined, is 32 KB. If you pass multiple containers to a CreateModel request, then the maximum length of all of their maps, combined, is also 32 KB. - primary_container.image
The path where inference code is stored. This can be either in Amazon EC2 Container Registry or in a Docker registry that is accessible from the same VPC that you configure for your endpoint. If you are using your own custom algorithm instead of an algorithm provided by SageMaker, the inference code must meet SageMaker requirements. SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker. The model artifacts in an Amazon S3 bucket and the Docker image for inference container in Amazon EC2 Container Registry must be in the same region as the model or endpoint you are creating. - primary_container.image_config
Specifies whether the model container is in Amazon ECR or a private Docker registry accessible from your Amazon Virtual Private Cloud (VPC). For information about storing containers in a private Docker registry, see Use a Private Docker Registry for Real-Time Inference Containers. The model artifacts in an Amazon S3 bucket and the Docker image for inference container in Amazon EC2 Container Registry must be in the same region as the model or endpoint you are creating. Show child fields- primary_container.image_config.repository_access_mode
Set this to one of the following values: - primary_container.image_config.repository_auth_config
(Optional) Specifies an authentication configuration for the private docker registry where your model image is hosted. Specify a value for this property only if you specified Vpc as the value for the RepositoryAccessMode field, and the private Docker registry where the model image is hosted requires authentication. Show child fields- primary_container.image_config.repository_auth_config.repository_credentials_provider_arn
The Amazon Resource Name (ARN) of an Amazon Web Services Lambda function that provides credentials to authenticate to the private Docker registry where your model image is hosted. For information about how to create an Amazon Web Services Lambda function, see Create a Lambda function with the console in the Amazon Web Services Lambda Developer Guide.
- primary_container.inference_specification_name
The inference specification name in the model package version. - primary_container.mode
Whether the container hosts a single model or multiple models. - primary_container.model_data_source
Specifies the location of ML model data to deploy. Currently you cannot use ModelDataSource in conjunction with SageMaker batch transform, SageMaker serverless endpoints, SageMaker multi-model endpoints, and SageMaker Marketplace. Show child fields- primary_container.model_data_source.s3_data_source
Specifies the S3 location of ML model data to deploy. Show child fields- primary_container.model_data_source.s3_data_source.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: -
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. - primary_container.model_data_source.s3_data_source.hub_access_config
Configuration information for hub access. Show child fields- primary_container.model_data_source.s3_data_source.hub_access_config.hub_content_arn
The ARN of the hub content for which deployment access is allowed.
- primary_container.model_data_source.s3_data_source.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. Show child fields- primary_container.model_data_source.s3_data_source.model_access_config.accept_eula
Specifies agreement to the model end-user license agreement (EULA). The AcceptEula value must be explicitly defined as True in order to accept the EULA that this model requires. 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.
- primary_container.model_data_source.s3_data_source.s3_data_type
Specifies the type of ML model data to deploy. If you choose S3Prefix, S3Uri identifies a key name prefix. SageMaker uses all objects that match the specified key name prefix as part of the ML model data to deploy. A valid key name prefix identified by S3Uri always ends with a forward slash (/). If you choose S3Object, S3Uri identifies an object that is the ML model data to deploy. - primary_container.model_data_source.s3_data_source.s3_uri
Specifies the S3 path of ML model data to deploy.
- primary_container.model_data_url
The S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix). The S3 path is required for SageMaker built-in algorithms, but not if you use your own algorithms. For more information on built-in algorithms, see Common Parameters. The model artifacts must be in an S3 bucket that is in the same region as the model or endpoint you are creating. If you provide a value for this parameter, SageMaker uses Amazon Web Services Security Token Service to download model artifacts from the S3 path you provide. Amazon Web Services STS is activated in your Amazon Web Services account by default. If you previously deactivated Amazon Web Services STS for a region, you need to reactivate Amazon Web Services STS for that region. For more information, see Activating and Deactivating Amazon Web Services STS in an Amazon Web Services Region in the Amazon Web Services Identity and Access Management User Guide. If you use a built-in algorithm to create a model, SageMaker requires that you provide a S3 path to the model artifacts in ModelDataUrl. - primary_container.model_package_name
The name or Amazon Resource Name (ARN) of the model package to use to create the model. - primary_container.multi_model_config
Specifies additional configuration for multi-model endpoints. Show child fields- primary_container.multi_model_config.model_cache_setting
Whether to cache models for a multi-model endpoint. By default, multi-model endpoints cache models so that a model does not have to be loaded into memory each time it is invoked. Some use cases do not benefit from model caching. For example, if an endpoint hosts a large number of models that are each invoked infrequently, the endpoint might perform better if you disable model caching. To disable model caching, set the value of this parameter to Disabled.
|
vpc_config
A VpcConfig object that specifies the VPC that this model has access to. For more information, see Protect Endpoints by Using an Amazon Virtual Private Cloud | STRUCT(
"security_group_ids" VARCHAR[],
"subnets" VARCHAR[]
) |
Show child fields- vpc_config.security_group_ids[]
- vpc_config.subnets[]
|