ec2_describe_scheduled_instance_availability {aws.ecx}

Describe Scheduled Instance Availability

Description

Describe Scheduled Instance Availability

Usage

ec2_describe_scheduled_instance_availability(
  FirstSlotStartTimeRange,
  Recurrence,
  DryRun = NULL,
  Filter = NULL,
  MaxResults = NULL,
  MaxSlotDurationInHours = NULL,
  MinSlotDurationInHours = NULL,
  NextToken = NULL,
  simplify = TRUE,
  others = list(),
  print_on_error = aws_get_print_on_error(),
  retry_time = aws_get_retry_time(),
  network_timeout = aws_get_network_timeout(),
  region = aws_get_region()
)

Arguments

FirstSlotStartTimeRange

Object. The time period for the first schedule to start.

Recurrence

Object. The schedule recurrence.

DryRun

Logical. Checks whether you have the required permissions for the action, without actually making the request,...[optional]

Filter

Named list where the name is the filter name and the value is the filter's value. The value can be a vector or a list object (see below)[optional]

MaxResults

Integer. The maximum number of results to return in a single call.[optional]

MaxSlotDurationInHours

Integer. The maximum available duration, in hours.[optional]

MinSlotDurationInHours

Integer. The minimum available duration, in hours.[optional]

NextToken

Characters. The token for the next page of results[optional]

simplify

Logical. Whether to simplify the result and handle nextToken in the response[optional]

others

Named list. The parameters that are not included in the function parameters and need to be added into the request[optional]

print_on_error

Logical. Whether to show an error message when a network error occurs.

retry_time

Integer. Number of retries for a REST request when encounter the network issue. If the request has been sent retry_time times but still not be able to get the response, an error will be thrown.

network_timeout

Numeric. Number of seconds to wait for a REST response until giving up. Can not be less than 1 ms.

region

Character. The region of the AWS service.

Value

A list object or a character vector

FirstSlotStartTimeRange

The time period for the first schedule to start.

Recurrence

The schedule recurrence.

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.

Filter

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

MaxResults

The maximum number of results to return in a single call. This value can be between 5 and 300. The default value is 300. To retrieve the remaining results, make another call with the returned NextToken value.

MaxSlotDurationInHours

The maximum available duration, in hours. This value must be greater than MinSlotDurationInHours and less than 1,720.

MinSlotDurationInHours

The minimum available duration, in hours. The minimum required duration is 1,200 hours per year. For example, the minimum daily schedule is 4 hours, the minimum weekly schedule is 24 hours, and the minimum monthly schedule is 100 hours.