/AWS1/IF_SGM=>CREATEMODELPACKAGE()¶
About CreateModelPackage¶
Creates a model package that you can use to create SageMaker models or list on Amazon Web Services Marketplace, or a versioned model that is part of a model group. Buyers can subscribe to model packages listed on Amazon Web Services Marketplace to create models in SageMaker.
To create a model package by specifying a Docker container that contains your inference code and the Amazon S3 location of your model artifacts, provide values for InferenceSpecification. To create a model from an algorithm resource that you created or subscribed to in Amazon Web Services Marketplace, provide a value for SourceAlgorithmSpecification.
There are two types of model packages:
-
Versioned - a model that is part of a model group in the model registry.
-
Unversioned - a model package that is not part of a model group.
Method Signature¶
METHODS /AWS1/IF_SGM~CREATEMODELPACKAGE
IMPORTING
!IV_MODELPACKAGENAME TYPE /AWS1/SGMENTITYNAME OPTIONAL
!IV_MODELPACKAGEGROUPNAME TYPE /AWS1/SGMARNORNAME OPTIONAL
!IV_MODELPACKAGEDESCRIPTION TYPE /AWS1/SGMENTITYDESCRIPTION OPTIONAL
!IO_INFERENCESPECIFICATION TYPE REF TO /AWS1/CL_SGMINFERENCESPEC OPTIONAL
!IO_VALIDATIONSPECIFICATION TYPE REF TO /AWS1/CL_SGMMDELPACKAGEVALID00 OPTIONAL
!IO_SOURCEALGORITHMSPEC TYPE REF TO /AWS1/CL_SGMSOURCEALGSPEC OPTIONAL
!IV_CERTIFYFORMARKETPLACE TYPE /AWS1/SGMCERTIFYFORMARKETPLACE OPTIONAL
!IT_TAGS TYPE /AWS1/CL_SGMTAG=>TT_TAGLIST OPTIONAL
!IV_MODELAPPROVALSTATUS TYPE /AWS1/SGMMODELAPPROVALSTATUS OPTIONAL
!IO_METADATAPROPERTIES TYPE REF TO /AWS1/CL_SGMMETADATAPROPERTIES OPTIONAL
!IO_MODELMETRICS TYPE REF TO /AWS1/CL_SGMMODELMETRICS OPTIONAL
!IV_CLIENTTOKEN TYPE /AWS1/SGMCLIENTTOKEN OPTIONAL
!IV_DOMAIN TYPE /AWS1/SGMSTRING OPTIONAL
!IV_TASK TYPE /AWS1/SGMSTRING OPTIONAL
!IV_SAMPLEPAYLOADURL TYPE /AWS1/SGMS3URI OPTIONAL
!IT_CUSTOMERMETADATAPRPS TYPE /AWS1/CL_SGMCUSTOMERMETMAP_W=>TT_CUSTOMERMETADATAMAP OPTIONAL
!IO_DRIFTCHECKBASELINES TYPE REF TO /AWS1/CL_SGMDRIFTCHECKBASELI00 OPTIONAL
!IT_ADDITIONALINFERENCESPECS TYPE /AWS1/CL_SGMADDLINFERENCESPE00=>TT_ADDITIONALINFERENCESPECS OPTIONAL
!IV_SKIPMODELVALIDATION TYPE /AWS1/SGMSKIPMODELVALIDATION OPTIONAL
!IV_SOURCEURI TYPE /AWS1/SGMMODELPACKAGESOURCEURI OPTIONAL
!IO_SECURITYCONFIG TYPE REF TO /AWS1/CL_SGMMODELPACKAGESECCFG OPTIONAL
!IO_MODELCARD TYPE REF TO /AWS1/CL_SGMMDELPACKAGEMDELC00 OPTIONAL
!IO_MODELLIFECYCLE TYPE REF TO /AWS1/CL_SGMMODELLIFECYCLE OPTIONAL
RETURNING
VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_sgmcremodelpackageout
RAISING
/AWS1/CX_SGMCONFLICTEXCEPTION
/AWS1/CX_SGMRESOURCELIMITEXCD
/AWS1/CX_SGMCLIENTEXC
/AWS1/CX_SGMSERVEREXC
/AWS1/CX_RT_TECHNICAL_GENERIC
/AWS1/CX_RT_SERVICE_GENERIC.
IMPORTING¶
Optional arguments:¶
iv_modelpackagename TYPE /AWS1/SGMENTITYNAME /AWS1/SGMENTITYNAME¶
The name of the model package. The name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).
This parameter is required for unversioned models. It is not applicable to versioned models.
iv_modelpackagegroupname TYPE /AWS1/SGMARNORNAME /AWS1/SGMARNORNAME¶
The name or Amazon Resource Name (ARN) of the model package group that this model version belongs to.
This parameter is required for versioned models, and does not apply to unversioned models.
iv_modelpackagedescription TYPE /AWS1/SGMENTITYDESCRIPTION /AWS1/SGMENTITYDESCRIPTION¶
A description of the model package.
io_inferencespecification TYPE REF TO /AWS1/CL_SGMINFERENCESPEC /AWS1/CL_SGMINFERENCESPEC¶
Specifies details about inference jobs that you can run with models based on this model package, including the following information:
The Amazon ECR paths of containers that contain the inference code and model artifacts.
The instance types that the model package supports for transform jobs and real-time endpoints used for inference.
The input and output content formats that the model package supports for inference.
io_validationspecification TYPE REF TO /AWS1/CL_SGMMDELPACKAGEVALID00 /AWS1/CL_SGMMDELPACKAGEVALID00¶
Specifies configurations for one or more transform jobs that SageMaker runs to test the model package.
io_sourcealgorithmspec TYPE REF TO /AWS1/CL_SGMSOURCEALGSPEC /AWS1/CL_SGMSOURCEALGSPEC¶
Details about the algorithm that was used to create the model package.
iv_certifyformarketplace TYPE /AWS1/SGMCERTIFYFORMARKETPLACE /AWS1/SGMCERTIFYFORMARKETPLACE¶
Whether to certify the model package for listing on Amazon Web Services Marketplace.
This parameter is optional for unversioned models, and does not apply to versioned models.
it_tags TYPE /AWS1/CL_SGMTAG=>TT_TAGLIST TT_TAGLIST¶
A list of key value pairs associated with the model. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.
If you supply
ModelPackageGroupName, your model package belongs to the model group you specify and uses the tags associated with the model group. In this case, you cannot supply atagargument.
iv_modelapprovalstatus TYPE /AWS1/SGMMODELAPPROVALSTATUS /AWS1/SGMMODELAPPROVALSTATUS¶
Whether the model is approved for deployment.
This parameter is optional for versioned models, and does not apply to unversioned models.
For versioned models, the value of this parameter must be set to
Approvedto deploy the model.
io_metadataproperties TYPE REF TO /AWS1/CL_SGMMETADATAPROPERTIES /AWS1/CL_SGMMETADATAPROPERTIES¶
MetadataProperties
io_modelmetrics TYPE REF TO /AWS1/CL_SGMMODELMETRICS /AWS1/CL_SGMMODELMETRICS¶
A structure that contains model metrics reports.
iv_clienttoken TYPE /AWS1/SGMCLIENTTOKEN /AWS1/SGMCLIENTTOKEN¶
A unique token that guarantees that the call to this API is idempotent.
iv_domain TYPE /AWS1/SGMSTRING /AWS1/SGMSTRING¶
The machine learning domain of your model package and its components. Common machine learning domains include computer vision and natural language processing.
iv_task TYPE /AWS1/SGMSTRING /AWS1/SGMSTRING¶
The machine learning task your model package accomplishes. Common machine learning tasks include object detection and image classification. The following tasks are supported by Inference Recommender:
"IMAGE_CLASSIFICATION"|"OBJECT_DETECTION"|"TEXT_GENERATION"|"IMAGE_SEGMENTATION"|"FILL_MASK"|"CLASSIFICATION"|"REGRESSION"|"OTHER".Specify "OTHER" if none of the tasks listed fit your use case.
iv_samplepayloadurl TYPE /AWS1/SGMS3URI /AWS1/SGMS3URI¶
The Amazon Simple Storage Service (Amazon S3) path where the sample payload is stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix). This archive can hold multiple files that are all equally used in the load test. Each file in the archive must satisfy the size constraints of the InvokeEndpoint call.
it_customermetadataprps TYPE /AWS1/CL_SGMCUSTOMERMETMAP_W=>TT_CUSTOMERMETADATAMAP TT_CUSTOMERMETADATAMAP¶
The metadata properties associated with the model package versions.
io_driftcheckbaselines TYPE REF TO /AWS1/CL_SGMDRIFTCHECKBASELI00 /AWS1/CL_SGMDRIFTCHECKBASELI00¶
Represents the drift check baselines that can be used when the model monitor is set using the model package. For more information, see the topic on Drift Detection against Previous Baselines in SageMaker Pipelines in the Amazon SageMaker Developer Guide.
it_additionalinferencespecs TYPE /AWS1/CL_SGMADDLINFERENCESPE00=>TT_ADDITIONALINFERENCESPECS TT_ADDITIONALINFERENCESPECS¶
An array of additional Inference Specification objects. Each additional Inference Specification specifies artifacts based on this model package that can be used on inference endpoints. Generally used with SageMaker Neo to store the compiled artifacts.
iv_skipmodelvalidation TYPE /AWS1/SGMSKIPMODELVALIDATION /AWS1/SGMSKIPMODELVALIDATION¶
Indicates if you want to skip model validation.
iv_sourceuri TYPE /AWS1/SGMMODELPACKAGESOURCEURI /AWS1/SGMMODELPACKAGESOURCEURI¶
The URI of the source for the model package. If you want to clone a model package, set it to the model package Amazon Resource Name (ARN). If you want to register a model, set it to the model ARN.
io_securityconfig TYPE REF TO /AWS1/CL_SGMMODELPACKAGESECCFG /AWS1/CL_SGMMODELPACKAGESECCFG¶
The KMS Key ID (
KMSKeyId) used for encryption of model package information.
io_modelcard TYPE REF TO /AWS1/CL_SGMMDELPACKAGEMDELC00 /AWS1/CL_SGMMDELPACKAGEMDELC00¶
The model card associated with the model package. Since
ModelPackageModelCardis tied to a model package, it is a specific usage of a model card and its schema is simplified compared to the schema ofModelCard. TheModelPackageModelCardschema does not includemodel_package_details, andmodel_overviewis composed of themodel_creatorandmodel_artifactproperties. For more information about the model package model card schema, see Model package model card schema. For more information about the model card associated with the model package, see View the Details of a Model Version.
io_modellifecycle TYPE REF TO /AWS1/CL_SGMMODELLIFECYCLE /AWS1/CL_SGMMODELLIFECYCLE¶
A structure describing the current state of the model in its life cycle.
RETURNING¶
oo_output TYPE REF TO /aws1/cl_sgmcremodelpackageout /AWS1/CL_SGMCREMODELPACKAGEOUT¶
Domain /AWS1/RT_ACCOUNT_ID Primitive Type NUMC
Examples¶
Syntax Example¶
This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.
DATA(lo_result) = lo_client->createmodelpackage(
io_driftcheckbaselines = new /aws1/cl_sgmdriftcheckbaseli00(
io_bias = new /aws1/cl_sgmdriftcheckbias(
io_configfile = new /aws1/cl_sgmfilesource(
iv_contentdigest = |string|
iv_contenttype = |string|
iv_s3uri = |string|
)
io_posttrainingconstraints = new /aws1/cl_sgmmetricssource(
iv_contentdigest = |string|
iv_contenttype = |string|
iv_s3uri = |string|
)
io_pretrainingconstraints = new /aws1/cl_sgmmetricssource(
iv_contentdigest = |string|
iv_contenttype = |string|
iv_s3uri = |string|
)
)
io_explainability = new /aws1/cl_sgmdriftcheckexplai00(
io_configfile = new /aws1/cl_sgmfilesource(
iv_contentdigest = |string|
iv_contenttype = |string|
iv_s3uri = |string|
)
io_constraints = new /aws1/cl_sgmmetricssource(
iv_contentdigest = |string|
iv_contenttype = |string|
iv_s3uri = |string|
)
)
io_modeldataquality = new /aws1/cl_sgmdriftcheckmdelda00(
io_constraints = new /aws1/cl_sgmmetricssource(
iv_contentdigest = |string|
iv_contenttype = |string|
iv_s3uri = |string|
)
io_statistics = new /aws1/cl_sgmmetricssource(
iv_contentdigest = |string|
iv_contenttype = |string|
iv_s3uri = |string|
)
)
io_modelquality = new /aws1/cl_sgmdriftcheckmdelqu00(
io_constraints = new /aws1/cl_sgmmetricssource(
iv_contentdigest = |string|
iv_contenttype = |string|
iv_s3uri = |string|
)
io_statistics = new /aws1/cl_sgmmetricssource(
iv_contentdigest = |string|
iv_contenttype = |string|
iv_s3uri = |string|
)
)
)
io_inferencespecification = new /aws1/cl_sgminferencespec(
it_containers = VALUE /aws1/cl_sgmmdelpackageconta00=>tt_mdelpackagecontainerdefnlst(
(
new /aws1/cl_sgmmdelpackageconta00(
io_additionals3datasource = new /aws1/cl_sgmaddls3datasource(
iv_compressiontype = |string|
iv_etag = |string|
iv_s3datatype = |string|
iv_s3uri = |string|
)
io_modeldatasource = new /aws1/cl_sgmmodeldatasource(
io_s3datasource = new /aws1/cl_sgms3modeldatasource(
io_hubaccessconfig = new /aws1/cl_sgminferencehubacccfg( |string| )
io_modelaccessconfig = new /aws1/cl_sgmmodelaccessconfig( ABAP_TRUE )
iv_compressiontype = |string|
iv_etag = |string|
iv_manifestetag = |string|
iv_manifests3uri = |string|
iv_s3datatype = |string|
iv_s3uri = |string|
)
)
io_modelinput = new /aws1/cl_sgmmodelinput( |string| )
it_environment = VALUE /aws1/cl_sgmenvironmentmap_w=>tt_environmentmap(
(
VALUE /aws1/cl_sgmenvironmentmap_w=>ts_environmentmap_maprow(
key = |string|
value = new /aws1/cl_sgmenvironmentmap_w( |string| )
)
)
)
iv_containerhostname = |string|
iv_framework = |string|
iv_frameworkversion = |string|
iv_image = |string|
iv_imagedigest = |string|
iv_modeldataetag = |string|
iv_modeldataurl = |string|
iv_nearestmodelname = |string|
iv_productid = |string|
)
)
)
it_suppedrealtimeinference00 = VALUE /aws1/cl_sgmrealtimeinferenc00=>tt_realtimeinferenceinsttypes(
( new /aws1/cl_sgmrealtimeinferenc00( |string| ) )
)
it_suppedtransforminsttypes = VALUE /aws1/cl_sgmtransforminsttyp00=>tt_transforminstancetypes(
( new /aws1/cl_sgmtransforminsttyp00( |string| ) )
)
it_supportedcontenttypes = VALUE /aws1/cl_sgmcontenttypes_w=>tt_contenttypes(
( new /aws1/cl_sgmcontenttypes_w( |string| ) )
)
it_supportedrspmimetypes = VALUE /aws1/cl_sgmrspmimetypes_w=>tt_responsemimetypes(
( new /aws1/cl_sgmrspmimetypes_w( |string| ) )
)
)
io_metadataproperties = new /aws1/cl_sgmmetadataproperties(
iv_commitid = |string|
iv_generatedby = |string|
iv_projectid = |string|
iv_repository = |string|
)
io_modelcard = new /aws1/cl_sgmmdelpackagemdelc00(
iv_modelcardcontent = |string|
iv_modelcardstatus = |string|
)
io_modellifecycle = new /aws1/cl_sgmmodellifecycle(
iv_stage = |string|
iv_stagedescription = |string|
iv_stagestatus = |string|
)
io_modelmetrics = new /aws1/cl_sgmmodelmetrics(
io_bias = new /aws1/cl_sgmbias(
io_posttrainingreport = new /aws1/cl_sgmmetricssource(
iv_contentdigest = |string|
iv_contenttype = |string|
iv_s3uri = |string|
)
io_pretrainingreport = new /aws1/cl_sgmmetricssource(
iv_contentdigest = |string|
iv_contenttype = |string|
iv_s3uri = |string|
)
io_report = new /aws1/cl_sgmmetricssource(
iv_contentdigest = |string|
iv_contenttype = |string|
iv_s3uri = |string|
)
)
io_explainability = new /aws1/cl_sgmexplainability(
io_report = new /aws1/cl_sgmmetricssource(
iv_contentdigest = |string|
iv_contenttype = |string|
iv_s3uri = |string|
)
)
io_modeldataquality = new /aws1/cl_sgmmodeldataquality(
io_constraints = new /aws1/cl_sgmmetricssource(
iv_contentdigest = |string|
iv_contenttype = |string|
iv_s3uri = |string|
)
io_statistics = new /aws1/cl_sgmmetricssource(
iv_contentdigest = |string|
iv_contenttype = |string|
iv_s3uri = |string|
)
)
io_modelquality = new /aws1/cl_sgmmodelquality(
io_constraints = new /aws1/cl_sgmmetricssource(
iv_contentdigest = |string|
iv_contenttype = |string|
iv_s3uri = |string|
)
io_statistics = new /aws1/cl_sgmmetricssource(
iv_contentdigest = |string|
iv_contenttype = |string|
iv_s3uri = |string|
)
)
)
io_securityconfig = new /aws1/cl_sgmmodelpackageseccfg( |string| )
io_sourcealgorithmspec = new /aws1/cl_sgmsourcealgspec(
it_sourcealgorithms = VALUE /aws1/cl_sgmsourcealgorithm=>tt_sourcealgorithmlist(
(
new /aws1/cl_sgmsourcealgorithm(
io_modeldatasource = new /aws1/cl_sgmmodeldatasource(
io_s3datasource = new /aws1/cl_sgms3modeldatasource(
io_hubaccessconfig = new /aws1/cl_sgminferencehubacccfg( |string| )
io_modelaccessconfig = new /aws1/cl_sgmmodelaccessconfig( ABAP_TRUE )
iv_compressiontype = |string|
iv_etag = |string|
iv_manifestetag = |string|
iv_manifests3uri = |string|
iv_s3datatype = |string|
iv_s3uri = |string|
)
)
iv_algorithmname = |string|
iv_modeldataetag = |string|
iv_modeldataurl = |string|
)
)
)
)
io_validationspecification = new /aws1/cl_sgmmdelpackagevalid00(
it_validationprofiles = VALUE /aws1/cl_sgmmdelpackagevalid01=>tt_modelpackagevalidationpfls(
(
new /aws1/cl_sgmmdelpackagevalid01(
io_transformjobdefinition = new /aws1/cl_sgmtransformjobdefn(
io_transforminput = new /aws1/cl_sgmtransforminput(
io_datasource = new /aws1/cl_sgmtransformdatasrc(
io_s3datasource = new /aws1/cl_sgmtransforms3datasrc(
iv_s3datatype = |string|
iv_s3uri = |string|
)
)
iv_compressiontype = |string|
iv_contenttype = |string|
iv_splittype = |string|
)
io_transformoutput = new /aws1/cl_sgmtransformoutput(
iv_accept = |string|
iv_assemblewith = |string|
iv_kmskeyid = |string|
iv_s3outputpath = |string|
)
io_transformresources = new /aws1/cl_sgmtransformresources(
iv_instancecount = 123
iv_instancetype = |string|
iv_transformamiversion = |string|
iv_volumekmskeyid = |string|
)
it_environment = VALUE /aws1/cl_sgmtransformenviron00=>tt_transformenvironmentmap(
(
VALUE /aws1/cl_sgmtransformenviron00=>ts_transformenvironme00_maprow(
value = new /aws1/cl_sgmtransformenviron00( |string| )
key = |string|
)
)
)
iv_batchstrategy = |string|
iv_maxconcurrenttransforms = 123
iv_maxpayloadinmb = 123
)
iv_profilename = |string|
)
)
)
iv_validationrole = |string|
)
it_additionalinferencespecs = VALUE /aws1/cl_sgmaddlinferencespe00=>tt_additionalinferencespecs(
(
new /aws1/cl_sgmaddlinferencespe00(
it_containers = VALUE /aws1/cl_sgmmdelpackageconta00=>tt_mdelpackagecontainerdefnlst(
(
new /aws1/cl_sgmmdelpackageconta00(
io_additionals3datasource = new /aws1/cl_sgmaddls3datasource(
iv_compressiontype = |string|
iv_etag = |string|
iv_s3datatype = |string|
iv_s3uri = |string|
)
io_modeldatasource = new /aws1/cl_sgmmodeldatasource(
io_s3datasource = new /aws1/cl_sgms3modeldatasource(
io_hubaccessconfig = new /aws1/cl_sgminferencehubacccfg( |string| )
io_modelaccessconfig = new /aws1/cl_sgmmodelaccessconfig( ABAP_TRUE )
iv_compressiontype = |string|
iv_etag = |string|
iv_manifestetag = |string|
iv_manifests3uri = |string|
iv_s3datatype = |string|
iv_s3uri = |string|
)
)
io_modelinput = new /aws1/cl_sgmmodelinput( |string| )
it_environment = VALUE /aws1/cl_sgmenvironmentmap_w=>tt_environmentmap(
(
VALUE /aws1/cl_sgmenvironmentmap_w=>ts_environmentmap_maprow(
key = |string|
value = new /aws1/cl_sgmenvironmentmap_w( |string| )
)
)
)
iv_containerhostname = |string|
iv_framework = |string|
iv_frameworkversion = |string|
iv_image = |string|
iv_imagedigest = |string|
iv_modeldataetag = |string|
iv_modeldataurl = |string|
iv_nearestmodelname = |string|
iv_productid = |string|
)
)
)
it_suppedrealtimeinference00 = VALUE /aws1/cl_sgmrealtimeinferenc00=>tt_realtimeinferenceinsttypes(
( new /aws1/cl_sgmrealtimeinferenc00( |string| ) )
)
it_suppedtransforminsttypes = VALUE /aws1/cl_sgmtransforminsttyp00=>tt_transforminstancetypes(
( new /aws1/cl_sgmtransforminsttyp00( |string| ) )
)
it_supportedcontenttypes = VALUE /aws1/cl_sgmcontenttypes_w=>tt_contenttypes(
( new /aws1/cl_sgmcontenttypes_w( |string| ) )
)
it_supportedrspmimetypes = VALUE /aws1/cl_sgmrspmimetypes_w=>tt_responsemimetypes(
( new /aws1/cl_sgmrspmimetypes_w( |string| ) )
)
iv_description = |string|
iv_name = |string|
)
)
)
it_customermetadataprps = VALUE /aws1/cl_sgmcustomermetmap_w=>tt_customermetadatamap(
(
VALUE /aws1/cl_sgmcustomermetmap_w=>ts_customermetadatamap_maprow(
value = new /aws1/cl_sgmcustomermetmap_w( |string| )
key = |string|
)
)
)
it_tags = VALUE /aws1/cl_sgmtag=>tt_taglist(
(
new /aws1/cl_sgmtag(
iv_key = |string|
iv_value = |string|
)
)
)
iv_certifyformarketplace = ABAP_TRUE
iv_clienttoken = |string|
iv_domain = |string|
iv_modelapprovalstatus = |string|
iv_modelpackagedescription = |string|
iv_modelpackagegroupname = |string|
iv_modelpackagename = |string|
iv_samplepayloadurl = |string|
iv_skipmodelvalidation = |string|
iv_sourceuri = |string|
iv_task = |string|
).
This is an example of reading all possible response values
lo_result = lo_result.
IF lo_result IS NOT INITIAL.
lv_modelpackagearn = lo_result->get_modelpackagearn( ).
ENDIF.