[ aws . ec2 ]

purchase-scheduled-instances

Description

Purchases the Scheduled Instances with the specified schedule.

Scheduled Instances enable you to purchase Amazon EC2 compute capacity by the hour for a one-year term. Before you can purchase a Scheduled Instance, you must call DescribeScheduledInstanceAvailability to check for available schedules and obtain a purchase token. After you purchase a Scheduled Instance, you must call RunScheduledInstances during each scheduled time period.

After you purchase a Scheduled Instance, you can’t cancel, modify, or resell your purchase.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  purchase-scheduled-instances
[--client-token <value>]
[--dry-run | --no-dry-run]
--purchase-requests <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--client-token (string)

Unique, case-sensitive identifier that ensures the idempotency of the request. For more information, see Ensuring Idempotency .

--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 .

--purchase-requests (list)

The purchase requests.

(structure)

Describes a request to purchase Scheduled Instances.

InstanceCount -> (integer)

The number of instances.

PurchaseToken -> (string)

The purchase token.

Shorthand Syntax:

InstanceCount=integer,PurchaseToken=string ...

JSON Syntax:

[
  {
    "InstanceCount": integer,
    "PurchaseToken": "string"
  }
  ...
]

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Examples

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To purchase a Scheduled Instance

This example purchases a Scheduled Instance.

Command:

aws ec2 purchase-scheduled-instances --purchase-requests file://purchase-request.json

Purchase-request.json:

[
    {
        "PurchaseToken": "eyJ2IjoiMSIsInMiOjEsImMiOi...",
        "InstanceCount": 1
    }
]

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"
      }
  ]
}

Output

ScheduledInstanceSet -> (list)

Information about the Scheduled Instances.

(structure)

Describes a Scheduled Instance.

Note

We are retiring EC2-Classic on August 15, 2022. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide .

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.