AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon Elastic Compute Cloud (EC2) DescribeScheduledInstanceAvailability API operation.

Syntax

Get-EC2ScheduledInstanceAvailability
-FirstSlotStartTimeRange_UtcEarliestTime <DateTime>
-Filter <Filter[]>
-Recurrence_Frequency <String>
-Recurrence_Interval <Int32>
-FirstSlotStartTimeRange_UtcLatestTime <DateTime>
-MaxSlotDurationInHour <Int32>
-MinSlotDurationInHour <Int32>
-Recurrence_OccurrenceDay <Int32[]>
-Recurrence_OccurrenceRelativeToEnd <Boolean>
-Recurrence_OccurrenceUnit <String>
-FirstSlotStartTimeRange_EarliestTime <DateTime>
-FirstSlotStartTimeRange_LatestTime <DateTime>
-MaxResult <Int32>
-NextToken <String>
-Select <String>
-NoAutoIteration <SwitchParameter>
-ClientConfig <AmazonEC2Config>

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.

This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration.

Parameters

-ClientConfig <AmazonEC2Config>
Amazon.PowerShell.Cmdlets.EC2.AmazonEC2ClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Filter <Filter[]>
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).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFilters
-FirstSlotStartTimeRange_EarliestTime <DateTime>
This property is deprecated. Setting this property results in non-UTC DateTimes not being marshalled correctly. Use EarliestTimeUtc instead. Setting either EarliestTime or EarliestTimeUtc results in both EarliestTime and EarliestTimeUtc being assigned, the latest assignment to either one of the two property is reflected in the value of both. EarliestTime is provided for backwards compatibility only and assigning a non-Utc DateTime to it results in the wrong timestamp being passed to the service.The earliest date and time, in UTC, for the Scheduled Instance to start.This parameter is deprecated.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-FirstSlotStartTimeRange_LatestTime <DateTime>
This property is deprecated. Setting this property results in non-UTC DateTimes not being marshalled correctly. Use LatestTimeUtc instead. Setting either LatestTime or LatestTimeUtc results in both LatestTime and LatestTimeUtc being assigned, the latest assignment to either one of the two property is reflected in the value of both. LatestTime is provided for backwards compatibility only and assigning a non-Utc DateTime to it results in the wrong timestamp being passed to the service.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.This parameter is deprecated.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-FirstSlotStartTimeRange_UtcEarliestTime <DateTime>
The earliest date and time, in UTC, for the Scheduled Instance to start.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-FirstSlotStartTimeRange_UtcLatestTime <DateTime>
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.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-MaxResult <Int32>
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.
Note: In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet.
In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call.
Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMaxItems, MaxResults
-MaxSlotDurationInHour <Int32>
The maximum available duration, in hours. This value must be greater than MinSlotDurationInHours and less than 1,720.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMaxSlotDurationInHours
-MinSlotDurationInHour <Int32>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMinSlotDurationInHours
-NextToken <String>
The token for the next set of results.
Note: This parameter is only used if you are manually controlling output pagination of the service API call.
In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NoAutoIteration <SwitchParameter>
By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Recurrence_Frequency <String>
The frequency (Daily, Weekly, or Monthly).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Recurrence_Interval <Int32>
The interval quantity. The interval unit depends on the value of Frequency. For example, every 2 weeks or every 2 months.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Recurrence_OccurrenceDay <Int32[]>
The days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is one or more days of the week (1-7, where 1 is Sunday). You can't specify this value with a daily schedule. If the occurrence is relative to the end of the month, you can specify only a single day.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRecurrence_OccurrenceDays
-Recurrence_OccurrenceRelativeToEnd <Boolean>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Recurrence_OccurrenceUnit <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'ScheduledInstanceAvailabilitySet'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EC2.Model.DescribeScheduledInstanceAvailabilityResponse). Specifying the name of a property of type Amazon.EC2.Model.DescribeScheduledInstanceAvailabilityResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.EC2.Model.ScheduledInstanceAvailability or Amazon.EC2.Model.DescribeScheduledInstanceAvailabilityResponse
This cmdlet returns a collection of Amazon.EC2.Model.ScheduledInstanceAvailability objects. The service call response (type Amazon.EC2.Model.DescribeScheduledInstanceAvailabilityResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Examples

Example 1

Get-EC2ScheduledInstanceAvailability -Recurrence_Frequency Weekly -Recurrence_Interval 1 -Recurrence_OccurrenceDay 1 -FirstSlotStartTimeRange_EarliestTime 2016-01-31T00:00:00Z -FirstSlotStartTimeRange_LatestTime 2016-01-31T04:00:00Z
    
AvailabilityZone            : us-west-2b
AvailableInstanceCount      : 20
FirstSlotStartTime          : 1/31/2016 8:00:00 AM
HourlyPrice                 : 0.095
InstanceType                : c4.large
MaxTermDurationInDays       : 366
MinTermDurationInDays       : 366
NetworkPlatform             : EC2-VPC
Platform                    : Linux/UNIX
PurchaseToken               : eyJ2IjoiMSIsInMiOjEsImMiOi...
Recurrence                  : Amazon.EC2.Model.ScheduledInstanceRecurrence
SlotDurationInHours         : 23
TotalScheduledInstanceHours : 1219

...
This example describes a schedule that occurs every week on Sunday, starting on the specified date.

Example 2

-Filter @{ Name="platform";Values="Linux/UNIX" },@{ Name="network-platform";Values="EC2-VPC" },@{ Name="instance-type";Values="c4.large" }
To narrow the results, you can add filters for criteria such as operating system, network, and instance type.
User Guide
Service API Reference
Microsoft Windows Guide
VPC User Guide
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z