Skip to content
AWS for Query.Farm

aws.ec2.describe_scheduled_instance_availability

Example SQL Queries

SELECT * FROM
aws.ec2.describe_scheduled_instance_availability
WHERE
"first_slot_start_time_range" = 'VALUE'
AND "recurrence" = 'VALUE';

Description

Finds available schedules that meet the specified criteria.

You can search for an available schedule no more than 3 months in advance. You must meet the minimum required duration of 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.

After you find a schedule that meets your needs, call PurchaseScheduledInstances to purchase Scheduled Instances with that schedule.

Table Definition

Column NameColumn Data Type
first_slot_start_time_range Required Input Column

The time period for the first schedule to start.

STRUCT(
    "earliest_time" TIMESTAMP_S,
    "latest_time" TIMESTAMP_S
)
Show child fields
first_slot_start_time_range.earliest_time

The earliest date and time, in UTC, for the Scheduled Instance to start.

first_slot_start_time_range.latest_time

The latest date and time, in UTC, for the Scheduled Instance to start. This value must be later than or equal to the earliest date and at most three months in the future.

dry_run Input Column

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.

BOOLEAN
filters Input Column

The filters.

  • availability-zone - The Availability Zone (for example, us-west-2a).

  • instance-type - The instance type (for example, c4.large).

  • platform - The platform (Linux/UNIX or Windows).

STRUCT(
    "name" VARCHAR,
    "values" VARCHAR[]
)[]
Show child fields
filters[]
Show child fields
filters[].name

The name of the filter. Filter names are case-sensitive.

filters[].values[]
max_slot_duration_in_hours Input Column

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

BIGINT
min_slot_duration_in_hours Input Column

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.

BIGINT
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
_input_recurrence Input Column
STRUCT(
    "frequency" VARCHAR,
    "interval" BIGINT,
    "occurrence_days" BIGINT[],
    "occurrence_relative_to_end" BOOLEAN,
    "occurrence_unit" VARCHAR
)
Show child fields
_input_recurrence.frequency

The frequency (Daily, Weekly, or Monthly).

_input_recurrence.interval

The interval quantity. The interval unit depends on the value of Frequency. For example, every 2 weeks or every 2 months.

_input_recurrence.occurrence_days[]
_input_recurrence.occurrence_relative_to_end

Indicates whether the occurrence is relative to the end of the specified week or month. You can't specify this value with a daily schedule.

_input_recurrence.occurrence_unit

The unit for OccurrenceDays (DayOfWeek or DayOfMonth). This value is required for a monthly schedule. You can't specify DayOfWeek with a weekly schedule. You can't specify this value with a daily schedule.

recurrence

The schedule recurrence.

STRUCT(
    "frequency" VARCHAR,
    "interval" BIGINT,
    "occurrence_day_set" BIGINT[],
    "occurrence_relative_to_end" BOOLEAN,
    "occurrence_unit" VARCHAR
)
Show child fields
recurrence.frequency

The frequency (Daily, Weekly, or Monthly).

recurrence.interval

The interval quantity. The interval unit depends on the value of frequency. For example, every 2 weeks or every 2 months.

recurrence.occurrence_day_set[]
recurrence.occurrence_relative_to_end

Indicates whether the occurrence is relative to the end of the specified week or month.

recurrence.occurrence_unit

The unit for occurrenceDaySet (DayOfWeek or DayOfMonth).

availability_zone

The Availability Zone.

VARCHAR
available_instance_count

The number of available instances.

BIGINT
first_slot_start_time

The time period for the first schedule to start.

TIMESTAMP_S
hourly_price

The hourly price for a single instance.

VARCHAR
instance_type

The instance type. You can specify one of the C3, C4, M4, or R3 instance types.

VARCHAR
max_term_duration_in_days

The maximum term. The only possible value is 365 days.

BIGINT
min_term_duration_in_days

The minimum term. The only possible value is 365 days.

BIGINT
network_platform

The network platform.

VARCHAR
platform

The platform (Linux/UNIX or Windows).

VARCHAR
purchase_token

The purchase token. This token expires in two hours.

VARCHAR
slot_duration_in_hours

The number of hours in the schedule.

BIGINT
total_scheduled_instance_hours

The total number of hours for a single instance for the entire term.

BIGINT