Get Trained Model

cleanroomsml_get_trained_model

R Documentation

Returns information about a trained model

Description

Returns information about a trained model.

Usage

cleanroomsml_get_trained_model(trainedModelArn, membershipIdentifier,
  versionIdentifier)

Arguments

trainedModelArn	[required] The Amazon Resource Name (ARN) of the trained model that you are interested in.
membershipIdentifier	[required] The membership ID of the member that created the trained model that you are interested in.
versionIdentifier	The version identifier of the trained model to retrieve. If not specified, the operation returns information about the latest version of the trained model.

Value

A list with the following syntax:

list(
  membershipIdentifier = "string",
  collaborationIdentifier = "string",
  trainedModelArn = "string",
  versionIdentifier = "string",
  incrementalTrainingDataChannels = list(
    list(
      channelName = "string",
      versionIdentifier = "string",
      modelName = "string"
    )
  ),
  name = "string",
  description = "string",
  status = "CREATE_PENDING"|"CREATE_IN_PROGRESS"|"CREATE_FAILED"|"ACTIVE"|"DELETE_PENDING"|"DELETE_IN_PROGRESS"|"DELETE_FAILED"|"INACTIVE"|"CANCEL_PENDING"|"CANCEL_IN_PROGRESS"|"CANCEL_FAILED",
  statusDetails = list(
    statusCode = "string",
    message = "string"
  ),
  configuredModelAlgorithmAssociationArn = "string",
  resourceConfig = list(
    instanceCount = 123,
    instanceType = "ml.m4.xlarge"|"ml.m4.2xlarge"|"ml.m4.4xlarge"|"ml.m4.10xlarge"|"ml.m4.16xlarge"|"ml.g4dn.xlarge"|"ml.g4dn.2xlarge"|"ml.g4dn.4xlarge"|"ml.g4dn.8xlarge"|"ml.g4dn.12xlarge"|"ml.g4dn.16xlarge"|"ml.m5.large"|"ml.m5.xlarge"|"ml.m5.2xlarge"|"ml.m5.4xlarge"|"ml.m5.12xlarge"|"ml.m5.24xlarge"|"ml.c4.xlarge"|"ml.c4.2xlarge"|"ml.c4.4xlarge"|"ml.c4.8xlarge"|"ml.p2.xlarge"|"ml.p2.8xlarge"|"ml.p2.16xlarge"|"ml.p4d.24xlarge"|"ml.p4de.24xlarge"|"ml.p5.48xlarge"|"ml.c5.xlarge"|"ml.c5.2xlarge"|"ml.c5.4xlarge"|"ml.c5.9xlarge"|"ml.c5.18xlarge"|"ml.c5n.xlarge"|"ml.c5n.2xlarge"|"ml.c5n.4xlarge"|"ml.c5n.9xlarge"|"ml.c5n.18xlarge"|"ml.g5.xlarge"|"ml.g5.2xlarge"|"ml.g5.4xlarge"|"ml.g5.8xlarge"|"ml.g5.16xlarge"|"ml.g5.12xlarge"|"ml.g5.24xlarge"|"ml.g5.48xlarge"|"ml.trn1.2xlarge"|"ml.trn1.32xlarge"|"ml.trn1n.32xlarge"|"ml.m6i.large"|"ml.m6i.xlarge"|"ml.m6i.2xlarge"|"ml.m6i.4xlarge"|"ml.m6i.8xlarge"|"ml.m6i.12xlarge"|"ml.m6i.16xlarge"|"ml.m6i.24xlarge"|"ml.m6i.32xlarge"|"ml.c6i.xlarge"|"ml.c6i.2xlarge"|"ml.c6i.8xlarge"|"ml.c6i.4xlarge"|"ml.c6i.12xlarge"|"ml.c6i.16xlarge"|"ml.c6i.24xlarge"|"ml.c6i.32xlarge"|"ml.r5d.large"|"ml.r5d.xlarge"|"ml.r5d.2xlarge"|"ml.r5d.4xlarge"|"ml.r5d.8xlarge"|"ml.r5d.12xlarge"|"ml.r5d.16xlarge"|"ml.r5d.24xlarge"|"ml.t3.medium"|"ml.t3.large"|"ml.t3.xlarge"|"ml.t3.2xlarge"|"ml.r5.large"|"ml.r5.xlarge"|"ml.r5.2xlarge"|"ml.r5.4xlarge"|"ml.r5.8xlarge"|"ml.r5.12xlarge"|"ml.r5.16xlarge"|"ml.r5.24xlarge"|"ml.c7i.large"|"ml.c7i.xlarge"|"ml.c7i.2xlarge"|"ml.c7i.4xlarge"|"ml.c7i.8xlarge"|"ml.c7i.12xlarge"|"ml.c7i.16xlarge"|"ml.c7i.24xlarge"|"ml.c7i.48xlarge"|"ml.m7i.large"|"ml.m7i.xlarge"|"ml.m7i.2xlarge"|"ml.m7i.4xlarge"|"ml.m7i.8xlarge"|"ml.m7i.12xlarge"|"ml.m7i.16xlarge"|"ml.m7i.24xlarge"|"ml.m7i.48xlarge"|"ml.r7i.large"|"ml.r7i.xlarge"|"ml.r7i.2xlarge"|"ml.r7i.4xlarge"|"ml.r7i.8xlarge"|"ml.r7i.12xlarge"|"ml.r7i.16xlarge"|"ml.r7i.24xlarge"|"ml.r7i.48xlarge"|"ml.g6.xlarge"|"ml.g6.2xlarge"|"ml.g6.4xlarge"|"ml.g6.8xlarge"|"ml.g6.12xlarge"|"ml.g6.16xlarge"|"ml.g6.24xlarge"|"ml.g6.48xlarge"|"ml.g6e.xlarge"|"ml.g6e.2xlarge"|"ml.g6e.4xlarge"|"ml.g6e.8xlarge"|"ml.g6e.12xlarge"|"ml.g6e.16xlarge"|"ml.g6e.24xlarge"|"ml.g6e.48xlarge"|"ml.p5en.48xlarge"|"ml.p3.2xlarge"|"ml.p3.8xlarge"|"ml.p3.16xlarge"|"ml.p3dn.24xlarge",
    volumeSizeInGB = 123
  ),
  trainingInputMode = "File"|"FastFile"|"Pipe",
  stoppingCondition = list(
    maxRuntimeInSeconds = 123
  ),
  metricsStatus = "PUBLISH_SUCCEEDED"|"PUBLISH_FAILED",
  metricsStatusDetails = "string",
  logsStatus = "PUBLISH_SUCCEEDED"|"PUBLISH_FAILED",
  logsStatusDetails = "string",
  trainingContainerImageDigest = "string",
  mlModelTrainingPayerAccountId = "string",
  createTime = as.POSIXct(
    "2015-01-01"
  ),
  updateTime = as.POSIXct(
    "2015-01-01"
  ),
  hyperparameters = list(
    "string"
  ),
  environment = list(
    "string"
  ),
  kmsKeyArn = "string",
  tags = list(
    "string"
  ),
  dataChannels = list(
    list(
      mlInputChannelArn = "string",
      channelName = "string",
      s3DataDistributionType = "FullyReplicated"|"ShardedByS3Key"
    )
  )
)

Request syntax

svc$get_trained_model(
  trainedModelArn = "string",
  membershipIdentifier = "string",
  versionIdentifier = "string"
)