Synopsis
Calls the Amazon Elastic Compute Cloud DescribeReservedInstancesOfferings API operation.
Syntax
Get-EC2ReservedInstancesOffering-ReservedInstancesOfferingId <String[]>-InstanceType <InstanceType>-AvailabilityZone <String>-Filter <Filter[]>-IncludeMarketplace <Boolean>-InstanceTenancy <Tenancy>-MaxDuration <Int64>-MaxInstanceCount <Int32>-MinDuration <Int64>-OfferingClass <OfferingClassType>-OfferingType <OfferingTypeValues>-ProductDescription <RIProductDescription>-MaxResult <Int32>-NextToken <String>
Description
Describes Reserved Instance offerings that are available for purchase. With Reserved Instances, you purchase the right to launch instances for a period of time. During that time period, you do not receive insufficient capacity errors, and you pay a lower usage rate than the rate charged for On-Demand instances for the actual time used.
If you have listed your own Reserved Instances for sale in the Reserved Instance Marketplace, they will be excluded from these results. This is to ensure that you do not purchase your own Reserved Instances.
For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.
This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output.
This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output.
Parameters
-AvailabilityZone <String>
The Availability Zone in which the Reserved Instance can be used.
| Required? | False |
| Position? | 3 |
| Accept pipeline input? | True (ByPropertyName) |
-Filter <Filter[]>
One or more filters.
availability-zone- The Availability Zone where the Reserved Instance can be used.duration- The duration of the Reserved Instance (for example, one year or three years), in seconds (31536000|94608000).fixed-price- The purchase price of the Reserved Instance (for example, 9800.0).instance-type- The instance type that is covered by the reservation.marketplace- Set totrueto show only Reserved Instance Marketplace offerings. When this filter is not used, which is the default behavior, all offerings from both AWS and the Reserved Instance Marketplace are listed.product-description- The Reserved Instance product platform description. Instances that include(Amazon VPC)in the product platform description will only be displayed to EC2-Classic account holders and are for use with Amazon VPC. (Linux/UNIX|Linux/UNIX (Amazon VPC)|SUSE Linux|SUSE Linux (Amazon VPC)|Red Hat Enterprise Linux|Red Hat Enterprise Linux (Amazon VPC)|Windows|Windows (Amazon VPC)|Windows with SQL Server Standard|Windows with SQL Server Standard (Amazon VPC)|Windows with SQL Server Web|Windows with SQL Server Web (Amazon VPC)|Windows with SQL Server Enterprise|Windows with SQL Server Enterprise (Amazon VPC))reserved-instances-offering-id- The Reserved Instances offering ID.scope- The scope of the Reserved Instance (Availability ZoneorRegion).usage-price- The usage price of the Reserved Instance, per hour (for example, 0.84).
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | Filters |
-IncludeMarketplace <Boolean>
Include Reserved Instance Marketplace offerings in the response.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-InstanceTenancy <Tenancy>
The tenancy of the instances covered by the reservation. A Reserved Instance with a tenancy of
dedicated is applied to instances that run in a VPC on single-tenant hardware (i.e., Dedicated Instances).Important: The host value cannot be used with this parameter. Use the default or dedicated values only.Default: default | Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-InstanceType <InstanceType>
The instance type that the reservation will cover (for example,
m1.small). For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide. | Required? | False |
| Position? | 2 |
| Accept pipeline input? | False |
-MaxDuration <Int64>
The maximum duration (in seconds) to filter when searching for offerings.Default: 94608000 (3 years)
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-MaxInstanceCount <Int32>
The maximum number of instances to filter when searching for offerings.Default: 20
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-MaxResult <Int32>
The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned
NextToken value. The maximum is 100.Default: 100 | Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | MaxItems, MaxResults |
-MinDuration <Int64>
The minimum duration (in seconds) to filter when searching for offerings.Default: 2592000 (1 month)
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-NextToken <String>
The token to retrieve the next page 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, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter.
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, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-OfferingClass <OfferingClassType>
The offering class of the Reserved Instance. Can be
standard or convertible. | Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-OfferingType <OfferingTypeValues>
The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the
Medium Utilization Reserved Instance offering type. | Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-ProductDescription <RIProductDescription>
The Reserved Instance product platform description. Instances that include
(Amazon VPC) in the description are for use with Amazon VPC. | Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-ReservedInstancesOfferingId <String[]>
One or more Reserved Instances offering IDs.
| Required? | False |
| Position? | 1 |
| Accept pipeline input? | True (ByValue, ByPropertyName) |
| Aliases | ReservedInstancesId, ReservedInstancesOfferingIds |
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? | False |
-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? | False |
-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. Note that the encrypted credential file is not supported on all platforms. It will be skipped when searching for profiles on Windows Nano Server, Mac, and Linux platforms.
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? | False |
-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? | False |
-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? | False |
-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? | False |
-SessionToken <String>
The session token if the access and secret keys are temporary session-based
credentials.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-Region <String>
The system name of the AWS region in which the operation should be invoked. For example, us-east-1, eu-west-1 etc.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-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? | False |
Inputs
You can pipe a String[] object to this cmdlet for the ReservedInstancesOfferingId parameter.
Outputs
This cmdlet returns a collection of ReservedInstancesOffering objects.
The service call response (type Amazon.EC2.Model.DescribeReservedInstancesOfferingsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)
Related Links
Supported Version
AWS Tools for PowerShell: 2.x.y.z
