amazonka-ec2-2.0: Amazon Elastic Compute Cloud SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.EC2.DescribeReservedInstancesOfferings

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 EC2 User Guide.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeReservedInstancesOfferings Source #

Contains the parameters for DescribeReservedInstancesOfferings.

See: newDescribeReservedInstancesOfferings smart constructor.

Constructors

DescribeReservedInstancesOfferings' 

Fields

  • availabilityZone :: Maybe Text

    The Availability Zone in which the Reserved Instance can be used.

  • dryRun :: Maybe Bool

    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.

  • filters :: Maybe [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 to true to show only Reserved Instance Marketplace offerings. When this filter is not used, which is the default behavior, all offerings from both Amazon Web Services 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) | Red Hat Enterprise Linux with HA (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 Zone or Region).
    • usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).
  • includeMarketplace :: Maybe Bool

    Include Reserved Instance Marketplace offerings in the response.

  • instanceTenancy :: Maybe 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

  • instanceType :: Maybe InstanceType

    The instance type that the reservation will cover (for example, m1.small). For more information, see Instance types in the Amazon EC2 User Guide.

  • maxDuration :: Maybe Integer

    The maximum duration (in seconds) to filter when searching for offerings.

    Default: 94608000 (3 years)

  • maxInstanceCount :: Maybe Int

    The maximum number of instances to filter when searching for offerings.

    Default: 20

  • maxResults :: Maybe Int

    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

  • minDuration :: Maybe Integer

    The minimum duration (in seconds) to filter when searching for offerings.

    Default: 2592000 (1 month)

  • nextToken :: Maybe Text

    The token to retrieve the next page of results.

  • offeringClass :: Maybe OfferingClassType

    The offering class of the Reserved Instance. Can be standard or convertible.

  • offeringType :: Maybe 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.

  • productDescription :: Maybe RIProductDescription

    The Reserved Instance product platform description. Instances that include (Amazon VPC) in the description are for use with Amazon VPC.

  • reservedInstancesOfferingIds :: Maybe [Text]

    One or more Reserved Instances offering IDs.

Instances

Instances details
ToHeaders DescribeReservedInstancesOfferings Source # 
Instance details

Defined in Amazonka.EC2.DescribeReservedInstancesOfferings

ToPath DescribeReservedInstancesOfferings Source # 
Instance details

Defined in Amazonka.EC2.DescribeReservedInstancesOfferings

ToQuery DescribeReservedInstancesOfferings Source # 
Instance details

Defined in Amazonka.EC2.DescribeReservedInstancesOfferings

AWSPager DescribeReservedInstancesOfferings Source # 
Instance details

Defined in Amazonka.EC2.DescribeReservedInstancesOfferings

AWSRequest DescribeReservedInstancesOfferings Source # 
Instance details

Defined in Amazonka.EC2.DescribeReservedInstancesOfferings

Generic DescribeReservedInstancesOfferings Source # 
Instance details

Defined in Amazonka.EC2.DescribeReservedInstancesOfferings

Associated Types

type Rep DescribeReservedInstancesOfferings :: Type -> Type #

Read DescribeReservedInstancesOfferings Source # 
Instance details

Defined in Amazonka.EC2.DescribeReservedInstancesOfferings

Show DescribeReservedInstancesOfferings Source # 
Instance details

Defined in Amazonka.EC2.DescribeReservedInstancesOfferings

NFData DescribeReservedInstancesOfferings Source # 
Instance details

Defined in Amazonka.EC2.DescribeReservedInstancesOfferings

Eq DescribeReservedInstancesOfferings Source # 
Instance details

Defined in Amazonka.EC2.DescribeReservedInstancesOfferings

Hashable DescribeReservedInstancesOfferings Source # 
Instance details

Defined in Amazonka.EC2.DescribeReservedInstancesOfferings

type AWSResponse DescribeReservedInstancesOfferings Source # 
Instance details

Defined in Amazonka.EC2.DescribeReservedInstancesOfferings

type Rep DescribeReservedInstancesOfferings Source # 
Instance details

Defined in Amazonka.EC2.DescribeReservedInstancesOfferings

type Rep DescribeReservedInstancesOfferings = D1 ('MetaData "DescribeReservedInstancesOfferings" "Amazonka.EC2.DescribeReservedInstancesOfferings" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeReservedInstancesOfferings'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "availabilityZone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "dryRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter])))) :*: ((S1 ('MetaSel ('Just "includeMarketplace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "instanceTenancy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Tenancy))) :*: (S1 ('MetaSel ('Just "instanceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InstanceType)) :*: S1 ('MetaSel ('Just "maxDuration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer))))) :*: (((S1 ('MetaSel ('Just "maxInstanceCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "minDuration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "offeringClass") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OfferingClassType)) :*: S1 ('MetaSel ('Just "offeringType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OfferingTypeValues))) :*: (S1 ('MetaSel ('Just "productDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RIProductDescription)) :*: S1 ('MetaSel ('Just "reservedInstancesOfferingIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))))))

newDescribeReservedInstancesOfferings :: DescribeReservedInstancesOfferings Source #

Create a value of DescribeReservedInstancesOfferings with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeReservedInstancesOfferings, describeReservedInstancesOfferings_availabilityZone - The Availability Zone in which the Reserved Instance can be used.

$sel:dryRun:DescribeReservedInstancesOfferings', describeReservedInstancesOfferings_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.

$sel:filters:DescribeReservedInstancesOfferings', describeReservedInstancesOfferings_filters - 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 to true to show only Reserved Instance Marketplace offerings. When this filter is not used, which is the default behavior, all offerings from both Amazon Web Services 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) | Red Hat Enterprise Linux with HA (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 Zone or Region).
  • usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).

$sel:includeMarketplace:DescribeReservedInstancesOfferings', describeReservedInstancesOfferings_includeMarketplace - Include Reserved Instance Marketplace offerings in the response.

DescribeReservedInstancesOfferings, describeReservedInstancesOfferings_instanceTenancy - 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

DescribeReservedInstancesOfferings, describeReservedInstancesOfferings_instanceType - The instance type that the reservation will cover (for example, m1.small). For more information, see Instance types in the Amazon EC2 User Guide.

$sel:maxDuration:DescribeReservedInstancesOfferings', describeReservedInstancesOfferings_maxDuration - The maximum duration (in seconds) to filter when searching for offerings.

Default: 94608000 (3 years)

$sel:maxInstanceCount:DescribeReservedInstancesOfferings', describeReservedInstancesOfferings_maxInstanceCount - The maximum number of instances to filter when searching for offerings.

Default: 20

$sel:maxResults:DescribeReservedInstancesOfferings', describeReservedInstancesOfferings_maxResults - 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

$sel:minDuration:DescribeReservedInstancesOfferings', describeReservedInstancesOfferings_minDuration - The minimum duration (in seconds) to filter when searching for offerings.

Default: 2592000 (1 month)

DescribeReservedInstancesOfferings, describeReservedInstancesOfferings_nextToken - The token to retrieve the next page of results.

DescribeReservedInstancesOfferings, describeReservedInstancesOfferings_offeringClass - The offering class of the Reserved Instance. Can be standard or convertible.

DescribeReservedInstancesOfferings, describeReservedInstancesOfferings_offeringType - 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.

DescribeReservedInstancesOfferings, describeReservedInstancesOfferings_productDescription - The Reserved Instance product platform description. Instances that include (Amazon VPC) in the description are for use with Amazon VPC.

$sel:reservedInstancesOfferingIds:DescribeReservedInstancesOfferings', describeReservedInstancesOfferings_reservedInstancesOfferingIds - One or more Reserved Instances offering IDs.

Request Lenses

describeReservedInstancesOfferings_availabilityZone :: Lens' DescribeReservedInstancesOfferings (Maybe Text) Source #

The Availability Zone in which the Reserved Instance can be used.

describeReservedInstancesOfferings_dryRun :: Lens' DescribeReservedInstancesOfferings (Maybe Bool) Source #

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.

describeReservedInstancesOfferings_filters :: Lens' DescribeReservedInstancesOfferings (Maybe [Filter]) Source #

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 to true to show only Reserved Instance Marketplace offerings. When this filter is not used, which is the default behavior, all offerings from both Amazon Web Services 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) | Red Hat Enterprise Linux with HA (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 Zone or Region).
  • usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).

describeReservedInstancesOfferings_includeMarketplace :: Lens' DescribeReservedInstancesOfferings (Maybe Bool) Source #

Include Reserved Instance Marketplace offerings in the response.

describeReservedInstancesOfferings_instanceTenancy :: Lens' DescribeReservedInstancesOfferings (Maybe Tenancy) Source #

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

describeReservedInstancesOfferings_instanceType :: Lens' DescribeReservedInstancesOfferings (Maybe InstanceType) Source #

The instance type that the reservation will cover (for example, m1.small). For more information, see Instance types in the Amazon EC2 User Guide.

describeReservedInstancesOfferings_maxDuration :: Lens' DescribeReservedInstancesOfferings (Maybe Integer) Source #

The maximum duration (in seconds) to filter when searching for offerings.

Default: 94608000 (3 years)

describeReservedInstancesOfferings_maxInstanceCount :: Lens' DescribeReservedInstancesOfferings (Maybe Int) Source #

The maximum number of instances to filter when searching for offerings.

Default: 20

describeReservedInstancesOfferings_maxResults :: Lens' DescribeReservedInstancesOfferings (Maybe Int) Source #

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

describeReservedInstancesOfferings_minDuration :: Lens' DescribeReservedInstancesOfferings (Maybe Integer) Source #

The minimum duration (in seconds) to filter when searching for offerings.

Default: 2592000 (1 month)

describeReservedInstancesOfferings_offeringClass :: Lens' DescribeReservedInstancesOfferings (Maybe OfferingClassType) Source #

The offering class of the Reserved Instance. Can be standard or convertible.

describeReservedInstancesOfferings_offeringType :: Lens' DescribeReservedInstancesOfferings (Maybe OfferingTypeValues) Source #

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.

describeReservedInstancesOfferings_productDescription :: Lens' DescribeReservedInstancesOfferings (Maybe RIProductDescription) Source #

The Reserved Instance product platform description. Instances that include (Amazon VPC) in the description are for use with Amazon VPC.

Destructuring the Response

data DescribeReservedInstancesOfferingsResponse Source #

Contains the output of DescribeReservedInstancesOfferings.

See: newDescribeReservedInstancesOfferingsResponse smart constructor.

Constructors

DescribeReservedInstancesOfferingsResponse' 

Fields

Instances

Instances details
Generic DescribeReservedInstancesOfferingsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeReservedInstancesOfferings

Read DescribeReservedInstancesOfferingsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeReservedInstancesOfferings

Show DescribeReservedInstancesOfferingsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeReservedInstancesOfferings

NFData DescribeReservedInstancesOfferingsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeReservedInstancesOfferings

Eq DescribeReservedInstancesOfferingsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeReservedInstancesOfferings

type Rep DescribeReservedInstancesOfferingsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeReservedInstancesOfferings

type Rep DescribeReservedInstancesOfferingsResponse = D1 ('MetaData "DescribeReservedInstancesOfferingsResponse" "Amazonka.EC2.DescribeReservedInstancesOfferings" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeReservedInstancesOfferingsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "reservedInstancesOfferings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ReservedInstancesOffering])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeReservedInstancesOfferingsResponse Source #

Create a value of DescribeReservedInstancesOfferingsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeReservedInstancesOfferings, describeReservedInstancesOfferingsResponse_nextToken - The token to use to retrieve the next page of results. This value is null when there are no more results to return.

$sel:reservedInstancesOfferings:DescribeReservedInstancesOfferingsResponse', describeReservedInstancesOfferingsResponse_reservedInstancesOfferings - A list of Reserved Instances offerings.

$sel:httpStatus:DescribeReservedInstancesOfferingsResponse', describeReservedInstancesOfferingsResponse_httpStatus - The response's http status code.

Response Lenses

describeReservedInstancesOfferingsResponse_nextToken :: Lens' DescribeReservedInstancesOfferingsResponse (Maybe Text) Source #

The token to use to retrieve the next page of results. This value is null when there are no more results to return.