amazonka-ec2-1.4.5: gen/Network/AWS/EC2/DescribeReservedInstances.hs
{-# LANGUAGE DeriveDataTypeable #-}
{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE TypeFamilies #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
{-# OPTIONS_GHC -fno-warn-unused-binds #-}
{-# OPTIONS_GHC -fno-warn-unused-matches #-}
-- Derived from AWS service descriptions, licensed under Apache 2.0.
-- |
-- Module : Network.AWS.EC2.DescribeReservedInstances
-- Copyright : (c) 2013-2016 Brendan Hay
-- License : Mozilla Public License, v. 2.0.
-- Maintainer : Brendan Hay <brendan.g.hay@gmail.com>
-- Stability : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Describes one or more of the Reserved Instances that you purchased.
--
--
-- For more information about Reserved Instances, see <http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/concepts-on-demand-reserved-instances.html Reserved Instances> in the /Amazon Elastic Compute Cloud User Guide/ .
--
module Network.AWS.EC2.DescribeReservedInstances
(
-- * Creating a Request
describeReservedInstances
, DescribeReservedInstances
-- * Request Lenses
, driFilters
, driReservedInstancesIds
, driOfferingType
, driOfferingClass
, driDryRun
-- * Destructuring the Response
, describeReservedInstancesResponse
, DescribeReservedInstancesResponse
-- * Response Lenses
, drirsReservedInstances
, drirsResponseStatus
) where
import Network.AWS.EC2.Types
import Network.AWS.EC2.Types.Product
import Network.AWS.Lens
import Network.AWS.Prelude
import Network.AWS.Request
import Network.AWS.Response
-- | Contains the parameters for DescribeReservedInstances.
--
--
--
-- /See:/ 'describeReservedInstances' smart constructor.
data DescribeReservedInstances = DescribeReservedInstances'
{ _driFilters :: !(Maybe [Filter])
, _driReservedInstancesIds :: !(Maybe [Text])
, _driOfferingType :: !(Maybe OfferingTypeValues)
, _driOfferingClass :: !(Maybe OfferingClassType)
, _driDryRun :: !(Maybe Bool)
} deriving (Eq,Read,Show,Data,Typeable,Generic)
-- | Creates a value of 'DescribeReservedInstances' with the minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
-- * 'driFilters' - One or more filters. * @availability-zone@ - The Availability Zone where the Reserved Instance can be used. * @duration@ - The duration of the Reserved Instance (one year or three years), in seconds (@31536000@ | @94608000@ ). * @end@ - The time when the Reserved Instance expires (for example, 2015-08-07T11:54:42.000Z). * @fixed-price@ - The purchase price of the Reserved Instance (for example, 9800.0). * @instance-type@ - The instance type that is covered by the reservation. * @scope@ - The scope of the Reserved Instance (@Region@ or @Availability Zone@ ). * @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-id@ - The ID of the Reserved Instance. * @start@ - The time at which the Reserved Instance purchase request was placed (for example, 2014-08-07T11:54:42.000Z). * @state@ - The state of the Reserved Instance (@payment-pending@ | @active@ | @payment-failed@ | @retired@ ). * @tag@ :/key/ =/value/ - The key/value combination of a tag assigned to the resource. * @tag-key@ - The key of a tag assigned to the resource. This filter is independent of the @tag-value@ filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the @tag@ :/key/ =/value/ filter. * @tag-value@ - The value of a tag assigned to the resource. This filter is independent of the @tag-key@ filter. * @usage-price@ - The usage price of the Reserved Instance, per hour (for example, 0.84).
--
-- * 'driReservedInstancesIds' - One or more Reserved Instance IDs. Default: Describes all your Reserved Instances, or only those otherwise specified.
--
-- * 'driOfferingType' - 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.
--
-- * 'driOfferingClass' - Describes whether the Reserved Instance is Standard or Convertible.
--
-- * 'driDryRun' - 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@ .
describeReservedInstances
:: DescribeReservedInstances
describeReservedInstances =
DescribeReservedInstances'
{ _driFilters = Nothing
, _driReservedInstancesIds = Nothing
, _driOfferingType = Nothing
, _driOfferingClass = Nothing
, _driDryRun = Nothing
}
-- | One or more filters. * @availability-zone@ - The Availability Zone where the Reserved Instance can be used. * @duration@ - The duration of the Reserved Instance (one year or three years), in seconds (@31536000@ | @94608000@ ). * @end@ - The time when the Reserved Instance expires (for example, 2015-08-07T11:54:42.000Z). * @fixed-price@ - The purchase price of the Reserved Instance (for example, 9800.0). * @instance-type@ - The instance type that is covered by the reservation. * @scope@ - The scope of the Reserved Instance (@Region@ or @Availability Zone@ ). * @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-id@ - The ID of the Reserved Instance. * @start@ - The time at which the Reserved Instance purchase request was placed (for example, 2014-08-07T11:54:42.000Z). * @state@ - The state of the Reserved Instance (@payment-pending@ | @active@ | @payment-failed@ | @retired@ ). * @tag@ :/key/ =/value/ - The key/value combination of a tag assigned to the resource. * @tag-key@ - The key of a tag assigned to the resource. This filter is independent of the @tag-value@ filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the @tag@ :/key/ =/value/ filter. * @tag-value@ - The value of a tag assigned to the resource. This filter is independent of the @tag-key@ filter. * @usage-price@ - The usage price of the Reserved Instance, per hour (for example, 0.84).
driFilters :: Lens' DescribeReservedInstances [Filter]
driFilters = lens _driFilters (\ s a -> s{_driFilters = a}) . _Default . _Coerce;
-- | One or more Reserved Instance IDs. Default: Describes all your Reserved Instances, or only those otherwise specified.
driReservedInstancesIds :: Lens' DescribeReservedInstances [Text]
driReservedInstancesIds = lens _driReservedInstancesIds (\ s a -> s{_driReservedInstancesIds = a}) . _Default . _Coerce;
-- | 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.
driOfferingType :: Lens' DescribeReservedInstances (Maybe OfferingTypeValues)
driOfferingType = lens _driOfferingType (\ s a -> s{_driOfferingType = a});
-- | Describes whether the Reserved Instance is Standard or Convertible.
driOfferingClass :: Lens' DescribeReservedInstances (Maybe OfferingClassType)
driOfferingClass = lens _driOfferingClass (\ s a -> s{_driOfferingClass = a});
-- | 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@ .
driDryRun :: Lens' DescribeReservedInstances (Maybe Bool)
driDryRun = lens _driDryRun (\ s a -> s{_driDryRun = a});
instance AWSRequest DescribeReservedInstances where
type Rs DescribeReservedInstances =
DescribeReservedInstancesResponse
request = postQuery ec2
response
= receiveXML
(\ s h x ->
DescribeReservedInstancesResponse' <$>
(x .@? "reservedInstancesSet" .!@ mempty >>=
may (parseXMLList "item"))
<*> (pure (fromEnum s)))
instance Hashable DescribeReservedInstances
instance NFData DescribeReservedInstances
instance ToHeaders DescribeReservedInstances where
toHeaders = const mempty
instance ToPath DescribeReservedInstances where
toPath = const "/"
instance ToQuery DescribeReservedInstances where
toQuery DescribeReservedInstances'{..}
= mconcat
["Action" =:
("DescribeReservedInstances" :: ByteString),
"Version" =: ("2016-11-15" :: ByteString),
toQuery (toQueryList "Filter" <$> _driFilters),
toQuery
(toQueryList "ReservedInstancesId" <$>
_driReservedInstancesIds),
"OfferingType" =: _driOfferingType,
"OfferingClass" =: _driOfferingClass,
"DryRun" =: _driDryRun]
-- | Contains the output for DescribeReservedInstances.
--
--
--
-- /See:/ 'describeReservedInstancesResponse' smart constructor.
data DescribeReservedInstancesResponse = DescribeReservedInstancesResponse'
{ _drirsReservedInstances :: !(Maybe [ReservedInstances])
, _drirsResponseStatus :: !Int
} deriving (Eq,Read,Show,Data,Typeable,Generic)
-- | Creates a value of 'DescribeReservedInstancesResponse' with the minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
-- * 'drirsReservedInstances' - A list of Reserved Instances.
--
-- * 'drirsResponseStatus' - -- | The response status code.
describeReservedInstancesResponse
:: Int -- ^ 'drirsResponseStatus'
-> DescribeReservedInstancesResponse
describeReservedInstancesResponse pResponseStatus_ =
DescribeReservedInstancesResponse'
{ _drirsReservedInstances = Nothing
, _drirsResponseStatus = pResponseStatus_
}
-- | A list of Reserved Instances.
drirsReservedInstances :: Lens' DescribeReservedInstancesResponse [ReservedInstances]
drirsReservedInstances = lens _drirsReservedInstances (\ s a -> s{_drirsReservedInstances = a}) . _Default . _Coerce;
-- | -- | The response status code.
drirsResponseStatus :: Lens' DescribeReservedInstancesResponse Int
drirsResponseStatus = lens _drirsResponseStatus (\ s a -> s{_drirsResponseStatus = a});
instance NFData DescribeReservedInstancesResponse