Skip to content

Describe Scheduled Instances

ec2_describe_scheduled_instances R Documentation

Describes the specified Scheduled Instances or all your Scheduled Instances

Description

Describes the specified Scheduled Instances or all your Scheduled Instances.

Usage

ec2_describe_scheduled_instances(DryRun, Filters, MaxResults, NextToken,
  ScheduledInstanceIds, SlotStartTimeRange)

Arguments

DryRun

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Filters

The filters.

  • availability-zone - The Availability Zone (for example, ⁠us-west-2a⁠).

  • instance-type - The instance type (for example, c4.large).

  • platform - The platform (Linux/UNIX or Windows).

MaxResults

The maximum number of results to return in a single call. This value can be between 5 and 300. The default value is 100. To retrieve the remaining results, make another call with the returned NextToken value.

NextToken

The token for the next set of results.

ScheduledInstanceIds

The Scheduled Instance IDs.

SlotStartTimeRange

The time period for the first schedule to start.

Value

A list with the following syntax: 

list(
  NextToken = "string",
  ScheduledInstanceSet = list(
    list(
      AvailabilityZone = "string",
      CreateDate = as.POSIXct(
        "2015-01-01"
      ),
      HourlyPrice = "string",
      InstanceCount = 123,
      InstanceType = "string",
      NetworkPlatform = "string",
      NextSlotStartTime = as.POSIXct(
        "2015-01-01"
      ),
      Platform = "string",
      PreviousSlotEndTime = as.POSIXct(
        "2015-01-01"
      ),
      Recurrence = list(
        Frequency = "string",
        Interval = 123,
        OccurrenceDaySet = list(
          123
        ),
        OccurrenceRelativeToEnd = TRUE|FALSE,
        OccurrenceUnit = "string"
      ),
      ScheduledInstanceId = "string",
      SlotDurationInHours = 123,
      TermEndDate = as.POSIXct(
        "2015-01-01"
      ),
      TermStartDate = as.POSIXct(
        "2015-01-01"
      ),
      TotalScheduledInstanceHours = 123
    )
  )
)

Request syntax

svc$describe_scheduled_instances(
  DryRun = TRUE|FALSE,
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  MaxResults = 123,
  NextToken = "string",
  ScheduledInstanceIds = list(
    "string"
  ),
  SlotStartTimeRange = list(
    EarliestTime = as.POSIXct(
      "2015-01-01"
    ),
    LatestTime = as.POSIXct(
      "2015-01-01"
    )
  )
)