Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . ec2 ]

describe-scheduled-instances

Description

Describes one or more of your Scheduled Instances.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

describe-scheduled-instances is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: ScheduledInstanceSet

Synopsis

  describe-scheduled-instances
[--dry-run | --no-dry-run]
[--filters <value>]
[--scheduled-instance-ids <value>]
[--slot-start-time-range <value>]
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--dry-run | --no-dry-run (boolean)

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 (list)

One or more filters.

  • availability-zone - The Availability Zone (for example, us-west-2a ).
  • instance-type - The instance type (for example, c4.large ).
  • network-platform - The network platform (EC2-Classic or EC2-VPC ).
  • platform - The platform (Linux/UNIX or Windows ).

Shorthand Syntax:

Name=string,Values=string,string ...

JSON Syntax:

[
  {
    "Name": "string",
    "Values": ["string", ...]
  }
  ...
]

--scheduled-instance-ids (list)

One or more Scheduled Instance IDs.

Syntax:

"string" "string" ...

--slot-start-time-range (structure)

The time period for the first schedule to start.

Shorthand Syntax:

EarliestTime=timestamp,LatestTime=timestamp

JSON Syntax:

{
  "EarliestTime": timestamp,
  "LatestTime": timestamp
}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command's output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command's output. If the total number of items available is more than the value specified, a NextToken is provided in the command's output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Examples

To describe your Scheduled Instances

This example describes the specified Scheduled Instance.

Command:

aws ec2 describe-scheduled-instances --scheduled-instance-ids sci-1234-1234-1234-1234-123456789012

Output:

{
  "ScheduledInstanceSet": [
      {
          "AvailabilityZone": "us-west-2b",
          "ScheduledInstanceId": "sci-1234-1234-1234-1234-123456789012",
          "HourlyPrice": "0.095",
          "CreateDate": "2016-01-25T21:43:38.612Z",
          "Recurrence": {
              "OccurrenceDaySet": [
                  1
              ],
              "Interval": 1,
              "Frequency": "Weekly",
              "OccurrenceRelativeToEnd": false,
              "OccurrenceUnit": ""
          },
          "Platform": "Linux/UNIX",
          "TermEndDate": "2017-01-31T09:00:00Z",
          "InstanceCount": 1,
          "SlotDurationInHours": 32,
          "TermStartDate": "2016-01-31T09:00:00Z",
          "NetworkPlatform": "EC2-VPC",
          "TotalScheduledInstanceHours": 1696,
          "NextSlotStartTime": "2016-01-31T09:00:00Z",
          "InstanceType": "c4.large"
      }
  ]
}

This example describes all your Scheduled Instances.

Command:

aws ec2 describe-scheduled-instances

Output

NextToken -> (string)

The token required to retrieve the next set of results. This value is null when there are no more results to return.

ScheduledInstanceSet -> (list)

Information about the Scheduled Instances.

(structure)

Describes a Scheduled Instance.

AvailabilityZone -> (string)

The Availability Zone.

CreateDate -> (timestamp)

The date when the Scheduled Instance was purchased.

HourlyPrice -> (string)

The hourly price for a single instance.

InstanceCount -> (integer)

The number of instances.

InstanceType -> (string)

The instance type.

NetworkPlatform -> (string)

The network platform (EC2-Classic or EC2-VPC ).

NextSlotStartTime -> (timestamp)

The time for the next schedule to start.

Platform -> (string)

The platform (Linux/UNIX or Windows ).

PreviousSlotEndTime -> (timestamp)

The time that the previous schedule ended or will end.

Recurrence -> (structure)

The schedule recurrence.

Frequency -> (string)

The frequency (Daily , Weekly , or Monthly ).

Interval -> (integer)

The interval quantity. The interval unit depends on the value of frequency . For example, every 2 weeks or every 2 months.

OccurrenceDaySet -> (list)

The days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is one or more days of the week (1-7, where 1 is Sunday).

(integer)

OccurrenceRelativeToEnd -> (boolean)

Indicates whether the occurrence is relative to the end of the specified week or month.

OccurrenceUnit -> (string)

The unit for occurrenceDaySet (DayOfWeek or DayOfMonth ).

ScheduledInstanceId -> (string)

The Scheduled Instance ID.

SlotDurationInHours -> (integer)

The number of hours in the schedule.

TermEndDate -> (timestamp)

The end date for the Scheduled Instance.

TermStartDate -> (timestamp)

The start date for the Scheduled Instance.

TotalScheduledInstanceHours -> (integer)

The total number of hours for a single instance for the entire term.