Skip to content

Describe Reserved Capacity

sagemaker_describe_reserved_capacity R Documentation

Retrieves details about a reserved capacity

Description

Retrieves details about a reserved capacity.

Usage

sagemaker_describe_reserved_capacity(ReservedCapacityArn)

Arguments

ReservedCapacityArn

[required] ARN of the reserved capacity to describe.

Value

A list with the following syntax:

list(
  ReservedCapacityArn = "string",
  ReservedCapacityType = "UltraServer"|"Instance",
  Status = "Pending"|"Active"|"Scheduled"|"Expired"|"Failed",
  AvailabilityZone = "string",
  DurationHours = 123,
  DurationMinutes = 123,
  StartTime = as.POSIXct(
    "2015-01-01"
  ),
  EndTime = as.POSIXct(
    "2015-01-01"
  ),
  InstanceType = "ml.p4d.24xlarge"|"ml.p5.48xlarge"|"ml.p5e.48xlarge"|"ml.p5en.48xlarge"|"ml.trn1.32xlarge"|"ml.trn2.48xlarge"|"ml.p6-b200.48xlarge"|"ml.p4de.24xlarge"|"ml.p6e-gb200.36xlarge"|"ml.p5.4xlarge"|"ml.p6-b300.48xlarge",
  TotalInstanceCount = 123,
  AvailableInstanceCount = 123,
  InUseInstanceCount = 123,
  UltraServerSummary = list(
    UltraServerType = "string",
    InstanceType = "ml.p4d.24xlarge"|"ml.p5.48xlarge"|"ml.p5e.48xlarge"|"ml.p5en.48xlarge"|"ml.trn1.32xlarge"|"ml.trn2.48xlarge"|"ml.p6-b200.48xlarge"|"ml.p4de.24xlarge"|"ml.p6e-gb200.36xlarge"|"ml.p5.4xlarge"|"ml.p6-b300.48xlarge",
    UltraServerCount = 123,
    AvailableSpareInstanceCount = 123,
    UnhealthyInstanceCount = 123
  )
)

Request syntax

svc$describe_reserved_capacity(
  ReservedCapacityArn = "string"
)