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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-ec2/types.rb

Overview

Note:

When making an API call, you may pass DescribeScheduledInstancesRequest data as a 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.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

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

Returns:

  • (Boolean) 


11434
11435
11436
11437
11438
11439
11440
11441
11442
 
# File 'lib/aws-sdk-ec2/types.rb', line 11434

class DescribeScheduledInstancesRequest < Struct.new(
  :dry_run,
  :filters,
  :max_results,
  :next_token,
  :scheduled_instance_ids,
  :slot_start_time_range)
  include Aws::Structure
end

#filters ⇒ Array<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:



11434
11435
11436
11437
11438
11439
11440
11441
11442
 
# File 'lib/aws-sdk-ec2/types.rb', line 11434

class DescribeScheduledInstancesRequest < Struct.new(
  :dry_run,
  :filters,
  :max_results,
  :next_token,
  :scheduled_instance_ids,
  :slot_start_time_range)
  include Aws::Structure
end

#max_results ⇒ Integer

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) 


11434
11435
11436
11437
11438
11439
11440
11441
11442
 
# File 'lib/aws-sdk-ec2/types.rb', line 11434

class DescribeScheduledInstancesRequest < Struct.new(
  :dry_run,
  :filters,
  :max_results,
  :next_token,
  :scheduled_instance_ids,
  :slot_start_time_range)
  include Aws::Structure
end

#next_token ⇒ String

The token for the next set of results.

Returns:

  • (String) 


11434
11435
11436
11437
11438
11439
11440
11441
11442
 
# File 'lib/aws-sdk-ec2/types.rb', line 11434

class DescribeScheduledInstancesRequest < Struct.new(
  :dry_run,
  :filters,
  :max_results,
  :next_token,
  :scheduled_instance_ids,
  :slot_start_time_range)
  include Aws::Structure
end

#scheduled_instance_ids ⇒ Array<String>

One or more Scheduled Instance IDs.

Returns:

  • (Array<String>) 


11434
11435
11436
11437
11438
11439
11440
11441
11442
 
# File 'lib/aws-sdk-ec2/types.rb', line 11434

class DescribeScheduledInstancesRequest < Struct.new(
  :dry_run,
  :filters,
  :max_results,
  :next_token,
  :scheduled_instance_ids,
  :slot_start_time_range)
  include Aws::Structure
end

#slot_start_time_range ⇒ Types::SlotStartTimeRangeRequest

The time period for the first schedule to start.

Returns:



11434
11435
11436
11437
11438
11439
11440
11441
11442
 
# File 'lib/aws-sdk-ec2/types.rb', line 11434

class DescribeScheduledInstancesRequest < Struct.new(
  :dry_run,
  :filters,
  :max_results,
  :next_token,
  :scheduled_instance_ids,
  :slot_start_time_range)
  include Aws::Structure
end