Skip to content

Describe Inference Component

sagemaker_describe_inference_component R Documentation

Returns information about an inference component

Description

Returns information about an inference component.

Usage

sagemaker_describe_inference_component(InferenceComponentName)

Arguments

InferenceComponentName

[required] The name of the inference component.

Value

A list with the following syntax:

list(
  InferenceComponentName = "string",
  InferenceComponentArn = "string",
  EndpointName = "string",
  EndpointArn = "string",
  VariantName = "string",
  FailureReason = "string",
  Specification = list(
    ModelName = "string",
    Container = list(
      DeployedImage = list(
        SpecifiedImage = "string",
        ResolvedImage = "string",
        ResolutionTime = as.POSIXct(
          "2015-01-01"
        )
      ),
      ArtifactUrl = "string",
      Environment = list(
        "string"
      )
    ),
    StartupParameters = list(
      ModelDataDownloadTimeoutInSeconds = 123,
      ContainerStartupHealthCheckTimeoutInSeconds = 123
    ),
    ComputeResourceRequirements = list(
      NumberOfCpuCoresRequired = 123.0,
      NumberOfAcceleratorDevicesRequired = 123.0,
      MinMemoryRequiredInMb = 123,
      MaxMemoryRequiredInMb = 123
    )
  ),
  RuntimeConfig = list(
    DesiredCopyCount = 123,
    CurrentCopyCount = 123
  ),
  CreationTime = as.POSIXct(
    "2015-01-01"
  ),
  LastModifiedTime = as.POSIXct(
    "2015-01-01"
  ),
  InferenceComponentStatus = "InService"|"Creating"|"Updating"|"Failed"|"Deleting"
)

Request syntax

svc$describe_inference_component(
  InferenceComponentName = "string"
)