Menu
Amazon Elastic Compute Cloud
API Reference (API Version 2016-11-15)

DescribeScheduledInstances

Describes one or more of your Scheduled Instances.

Request Parameters

The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.

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.

Type: Boolean

Required: No

Filter.N

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

Type: Array of Filter objects

Required: No

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.

Type: Integer

Required: No

NextToken

The token for the next set of results.

Type: String

Required: No

ScheduledInstanceId.N

One or more Scheduled Instance IDs.

Type: Array of strings

Required: No

SlotStartTimeRange

The time period for the first schedule to start.

Type: SlotStartTimeRangeRequest object

Required: No

Response Elements

The following elements are returned by the service.

nextToken

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

Type: String

requestId

The ID of the request.

Type: String

scheduledInstanceSet

Information about the Scheduled Instances.

Type: Array of ScheduledInstance objects

Errors

For information about the errors that are common to all actions, see Common Client Errors.

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: