You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::EC2::Types::DescribeScheduledInstancesRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing DescribeScheduledInstancesRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  dry_run: false,
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  max_results: 1,
  next_token: "String",
  scheduled_instance_ids: ["String"],
  slot_start_time_range: {
    earliest_time: Time.now,
    latest_time: Time.now,
  },
}

Contains the parameters for DescribeScheduledInstances.

Instance Attribute Summary collapse

Instance Attribute Details

#dry_runBoolean

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.

Returns:

  • (Boolean)

    Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.

#filtersArray<Types::Filter>

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

Returns:

#max_resultsInteger

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.

Returns:

  • (Integer)

    The maximum number of results to return in a single call.

#next_tokenString

The token for the next set of results.

Returns:

  • (String)

    The token for the next set of results.

#scheduled_instance_idsArray<String>

One or more Scheduled Instance IDs.

Returns:

  • (Array<String>)

    One or more Scheduled Instance IDs.

#slot_start_time_rangeTypes::SlotStartTimeRangeRequest

The time period for the first schedule to start.

Returns: