You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::SageMaker::Types::CreateModelPackageInput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb

Overview

Note:

When making an API call, you may pass CreateModelPackageInput data as a hash:

{
  model_package_name: "EntityName", # required
  model_package_description: "EntityDescription",
  inference_specification: {
    containers: [ # required
      {
        container_hostname: "ContainerHostname",
        image: "Image", # required
        image_digest: "ImageDigest",
        model_data_url: "Url",
        product_id: "ProductId",
      },
    ],
    supported_transform_instance_types: ["ml.m4.xlarge"], # required, accepts ml.m4.xlarge, ml.m4.2xlarge, ml.m4.4xlarge, ml.m4.10xlarge, ml.m4.16xlarge, ml.c4.xlarge, ml.c4.2xlarge, ml.c4.4xlarge, ml.c4.8xlarge, ml.p2.xlarge, ml.p2.8xlarge, ml.p2.16xlarge, ml.p3.2xlarge, ml.p3.8xlarge, ml.p3.16xlarge, ml.c5.xlarge, ml.c5.2xlarge, ml.c5.4xlarge, ml.c5.9xlarge, ml.c5.18xlarge, ml.m5.large, ml.m5.xlarge, ml.m5.2xlarge, ml.m5.4xlarge, ml.m5.12xlarge, ml.m5.24xlarge
    supported_realtime_inference_instance_types: ["ml.t2.medium"], # required, accepts ml.t2.medium, ml.t2.large, ml.t2.xlarge, ml.t2.2xlarge, ml.m4.xlarge, ml.m4.2xlarge, ml.m4.4xlarge, ml.m4.10xlarge, ml.m4.16xlarge, ml.m5.large, ml.m5.xlarge, ml.m5.2xlarge, ml.m5.4xlarge, ml.m5.12xlarge, ml.m5.24xlarge, ml.m5d.large, ml.m5d.xlarge, ml.m5d.2xlarge, ml.m5d.4xlarge, ml.m5d.12xlarge, ml.m5d.24xlarge, ml.c4.large, ml.c4.xlarge, ml.c4.2xlarge, ml.c4.4xlarge, ml.c4.8xlarge, ml.p2.xlarge, ml.p2.8xlarge, ml.p2.16xlarge, ml.p3.2xlarge, ml.p3.8xlarge, ml.p3.16xlarge, ml.c5.large, ml.c5.xlarge, ml.c5.2xlarge, ml.c5.4xlarge, ml.c5.9xlarge, ml.c5.18xlarge, ml.c5d.large, ml.c5d.xlarge, ml.c5d.2xlarge, ml.c5d.4xlarge, ml.c5d.9xlarge, ml.c5d.18xlarge, ml.g4dn.xlarge, ml.g4dn.2xlarge, ml.g4dn.4xlarge, ml.g4dn.8xlarge, ml.g4dn.12xlarge, ml.g4dn.16xlarge, ml.r5.large, ml.r5.xlarge, ml.r5.2xlarge, ml.r5.4xlarge, ml.r5.12xlarge, ml.r5.24xlarge, ml.r5d.large, ml.r5d.xlarge, ml.r5d.2xlarge, ml.r5d.4xlarge, ml.r5d.12xlarge, ml.r5d.24xlarge
    supported_content_types: ["ContentType"], # required
    supported_response_mime_types: ["ResponseMIMEType"], # required
  },
  validation_specification: {
    validation_role: "RoleArn", # required
    validation_profiles: [ # required
      {
        profile_name: "EntityName", # required
        transform_job_definition: { # required
          max_concurrent_transforms: 1,
          max_payload_in_mb: 1,
          batch_strategy: "MultiRecord", # accepts MultiRecord, SingleRecord
          environment: {
            "TransformEnvironmentKey" => "TransformEnvironmentValue",
          },
          transform_input: { # required
            data_source: { # required
              s3_data_source: { # required
                s3_data_type: "ManifestFile", # required, accepts ManifestFile, S3Prefix, AugmentedManifestFile
                s3_uri: "S3Uri", # required
              },
            },
            content_type: "ContentType",
            compression_type: "None", # accepts None, Gzip
            split_type: "None", # accepts None, Line, RecordIO, TFRecord
          },
          transform_output: { # required
            s3_output_path: "S3Uri", # required
            accept: "Accept",
            assemble_with: "None", # accepts None, Line
            kms_key_id: "KmsKeyId",
          },
          transform_resources: { # required
            instance_type: "ml.m4.xlarge", # required, accepts ml.m4.xlarge, ml.m4.2xlarge, ml.m4.4xlarge, ml.m4.10xlarge, ml.m4.16xlarge, ml.c4.xlarge, ml.c4.2xlarge, ml.c4.4xlarge, ml.c4.8xlarge, ml.p2.xlarge, ml.p2.8xlarge, ml.p2.16xlarge, ml.p3.2xlarge, ml.p3.8xlarge, ml.p3.16xlarge, ml.c5.xlarge, ml.c5.2xlarge, ml.c5.4xlarge, ml.c5.9xlarge, ml.c5.18xlarge, ml.m5.large, ml.m5.xlarge, ml.m5.2xlarge, ml.m5.4xlarge, ml.m5.12xlarge, ml.m5.24xlarge
            instance_count: 1, # required
            volume_kms_key_id: "KmsKeyId",
          },
        },
      },
    ],
  },
  source_algorithm_specification: {
    source_algorithms: [ # required
      {
        model_data_url: "Url",
        algorithm_name: "ArnOrName", # required
      },
    ],
  },
  certify_for_marketplace: false,
}

Instance Attribute Summary collapse

Instance Attribute Details

#certify_for_marketplaceBoolean

Whether to certify the model package for listing on AWS Marketplace.

Returns:

  • (Boolean)


2339
2340
2341
2342
2343
2344
2345
2346
2347
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 2339

class CreateModelPackageInput < Struct.new(
  :model_package_name,
  :model_package_description,
  :inference_specification,
  :validation_specification,
  :source_algorithm_specification,
  :certify_for_marketplace)
  include Aws::Structure
end

#inference_specificationTypes::InferenceSpecification

Specifies details about inference jobs that can be run with models based on this model package, including the following:

  • 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.



2339
2340
2341
2342
2343
2344
2345
2346
2347
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 2339

class CreateModelPackageInput < Struct.new(
  :model_package_name,
  :model_package_description,
  :inference_specification,
  :validation_specification,
  :source_algorithm_specification,
  :certify_for_marketplace)
  include Aws::Structure
end

#model_package_descriptionString

A description of the model package.

Returns:

  • (String)


2339
2340
2341
2342
2343
2344
2345
2346
2347
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 2339

class CreateModelPackageInput < Struct.new(
  :model_package_name,
  :model_package_description,
  :inference_specification,
  :validation_specification,
  :source_algorithm_specification,
  :certify_for_marketplace)
  include Aws::Structure
end

#model_package_nameString

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).

Returns:

  • (String)


2339
2340
2341
2342
2343
2344
2345
2346
2347
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 2339

class CreateModelPackageInput < Struct.new(
  :model_package_name,
  :model_package_description,
  :inference_specification,
  :validation_specification,
  :source_algorithm_specification,
  :certify_for_marketplace)
  include Aws::Structure
end

#source_algorithm_specificationTypes::SourceAlgorithmSpecification

Details about the algorithm that was used to create the model package.



2339
2340
2341
2342
2343
2344
2345
2346
2347
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 2339

class CreateModelPackageInput < Struct.new(
  :model_package_name,
  :model_package_description,
  :inference_specification,
  :validation_specification,
  :source_algorithm_specification,
  :certify_for_marketplace)
  include Aws::Structure
end

#validation_specificationTypes::ModelPackageValidationSpecification

Specifies configurations for one or more transform jobs that Amazon SageMaker runs to test the model package.



2339
2340
2341
2342
2343
2344
2345
2346
2347
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 2339

class CreateModelPackageInput < Struct.new(
  :model_package_name,
  :model_package_description,
  :inference_specification,
  :validation_specification,
  :source_algorithm_specification,
  :certify_for_marketplace)
  include Aws::Structure
end