Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.OpenSearch.DescribeReservedInstances

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes the Amazon OpenSearch Service instances that you have reserved in a given Region. For more information, see Reserved Instances in Amazon OpenSearch Service.

Synopsis

Creating a Request

data DescribeReservedInstances Source #

Container for the request parameters to the DescribeReservedInstances operation.

See: newDescribeReservedInstances smart constructor.

Constructors

DescribeReservedInstances'

Fields

maxResults :: Maybe Int
An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
nextToken :: Maybe Text
If your initial DescribeReservedInstances operation returns a nextToken, you can include the returned nextToken in subsequent DescribeReservedInstances operations, which returns results in the next page.
reservedInstanceId :: Maybe Text
The reserved instance identifier filter value. Use this parameter to show only the reservation that matches the specified reserved OpenSearch instance ID.

Instances

Instances details

ToHeaders DescribeReservedInstances Source #
Instance details Defined in Amazonka.OpenSearch.DescribeReservedInstances Methods toHeaders :: DescribeReservedInstances -> [Header] #
ToPath DescribeReservedInstances Source #
Instance details Defined in Amazonka.OpenSearch.DescribeReservedInstances Methods toPath :: DescribeReservedInstances -> ByteString #
ToQuery DescribeReservedInstances Source #
Instance details Defined in Amazonka.OpenSearch.DescribeReservedInstances Methods toQuery :: DescribeReservedInstances -> QueryString #
AWSRequest DescribeReservedInstances Source #
Instance details Defined in Amazonka.OpenSearch.DescribeReservedInstances Associated Types type AWSResponse DescribeReservedInstances # Methods request :: (Service -> Service) -> DescribeReservedInstances -> Request DescribeReservedInstances # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeReservedInstances -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeReservedInstances))) #
Generic DescribeReservedInstances Source #
Instance details Defined in Amazonka.OpenSearch.DescribeReservedInstances Associated Types type Rep DescribeReservedInstances :: Type -> Type # Methods from :: DescribeReservedInstances -> Rep DescribeReservedInstances x # to :: Rep DescribeReservedInstances x -> DescribeReservedInstances #
Read DescribeReservedInstances Source #
Instance details Defined in Amazonka.OpenSearch.DescribeReservedInstances Methods readsPrec :: Int -> ReadS DescribeReservedInstances # readList :: ReadS [DescribeReservedInstances] # readPrec :: ReadPrec DescribeReservedInstances # readListPrec :: ReadPrec [DescribeReservedInstances] #
Show DescribeReservedInstances Source #
Instance details Defined in Amazonka.OpenSearch.DescribeReservedInstances Methods showsPrec :: Int -> DescribeReservedInstances -> ShowS # show :: DescribeReservedInstances -> String # showList :: [DescribeReservedInstances] -> ShowS #
NFData DescribeReservedInstances Source #
Instance details Defined in Amazonka.OpenSearch.DescribeReservedInstances Methods rnf :: DescribeReservedInstances -> () #
Eq DescribeReservedInstances Source #
Instance details Defined in Amazonka.OpenSearch.DescribeReservedInstances Methods (==) :: DescribeReservedInstances -> DescribeReservedInstances -> Bool # (/=) :: DescribeReservedInstances -> DescribeReservedInstances -> Bool #
Hashable DescribeReservedInstances Source #
Instance details Defined in Amazonka.OpenSearch.DescribeReservedInstances Methods hashWithSalt :: Int -> DescribeReservedInstances -> Int # hash :: DescribeReservedInstances -> Int #
type AWSResponse DescribeReservedInstances Source #
Instance details Defined in Amazonka.OpenSearch.DescribeReservedInstances type AWSResponse DescribeReservedInstances = DescribeReservedInstancesResponse
type Rep DescribeReservedInstances Source #
Instance details Defined in Amazonka.OpenSearch.DescribeReservedInstances type Rep DescribeReservedInstances = D1 ('MetaData "DescribeReservedInstances" "Amazonka.OpenSearch.DescribeReservedInstances" "amazonka-opensearch-2.0-GNoaWlqGXH04P8GBIHM78L" 'False) (C1 ('MetaCons "DescribeReservedInstances'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "reservedInstanceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newDescribeReservedInstances :: DescribeReservedInstances Source #

Create a value of DescribeReservedInstances 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:

$sel:maxResults:DescribeReservedInstances', describeReservedInstances_maxResults - An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

DescribeReservedInstances, describeReservedInstances_nextToken - If your initial DescribeReservedInstances operation returns a nextToken, you can include the returned nextToken in subsequent DescribeReservedInstances operations, which returns results in the next page.

DescribeReservedInstances, describeReservedInstances_reservedInstanceId - The reserved instance identifier filter value. Use this parameter to show only the reservation that matches the specified reserved OpenSearch instance ID.

Request Lenses

describeReservedInstances_maxResults :: Lens' DescribeReservedInstances (Maybe Int) Source #

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

describeReservedInstances_nextToken :: Lens' DescribeReservedInstances (Maybe Text) Source #

If your initial DescribeReservedInstances operation returns a nextToken, you can include the returned nextToken in subsequent DescribeReservedInstances operations, which returns results in the next page.

describeReservedInstances_reservedInstanceId :: Lens' DescribeReservedInstances (Maybe Text) Source #

The reserved instance identifier filter value. Use this parameter to show only the reservation that matches the specified reserved OpenSearch instance ID.

Destructuring the Response

data DescribeReservedInstancesResponse Source #

Container for results from DescribeReservedInstances

See: newDescribeReservedInstancesResponse smart constructor.

Constructors

DescribeReservedInstancesResponse'
Fields nextToken :: Maybe Text When `nextToken` is returned, there are more results available. The value of `nextToken` is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. reservedInstances :: Maybe [ReservedInstance] List of Reserved Instances in the current Region. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic DescribeReservedInstancesResponse Source #
Instance details Defined in Amazonka.OpenSearch.DescribeReservedInstances Associated Types type Rep DescribeReservedInstancesResponse :: Type -> Type # Methods from :: DescribeReservedInstancesResponse -> Rep DescribeReservedInstancesResponse x # to :: Rep DescribeReservedInstancesResponse x -> DescribeReservedInstancesResponse #
Read DescribeReservedInstancesResponse Source #
Instance details Defined in Amazonka.OpenSearch.DescribeReservedInstances Methods readsPrec :: Int -> ReadS DescribeReservedInstancesResponse # readList :: ReadS [DescribeReservedInstancesResponse] # readPrec :: ReadPrec DescribeReservedInstancesResponse # readListPrec :: ReadPrec [DescribeReservedInstancesResponse] #
Show DescribeReservedInstancesResponse Source #
Instance details Defined in Amazonka.OpenSearch.DescribeReservedInstances Methods showsPrec :: Int -> DescribeReservedInstancesResponse -> ShowS # show :: DescribeReservedInstancesResponse -> String # showList :: [DescribeReservedInstancesResponse] -> ShowS #
NFData DescribeReservedInstancesResponse Source #
Instance details Defined in Amazonka.OpenSearch.DescribeReservedInstances Methods rnf :: DescribeReservedInstancesResponse -> () #
Eq DescribeReservedInstancesResponse Source #
Instance details Defined in Amazonka.OpenSearch.DescribeReservedInstances Methods (==) :: DescribeReservedInstancesResponse -> DescribeReservedInstancesResponse -> Bool # (/=) :: DescribeReservedInstancesResponse -> DescribeReservedInstancesResponse -> Bool #
type Rep DescribeReservedInstancesResponse Source #
Instance details Defined in Amazonka.OpenSearch.DescribeReservedInstances type Rep DescribeReservedInstancesResponse = D1 ('MetaData "DescribeReservedInstancesResponse" "Amazonka.OpenSearch.DescribeReservedInstances" "amazonka-opensearch-2.0-GNoaWlqGXH04P8GBIHM78L" 'False) (C1 ('MetaCons "DescribeReservedInstancesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "reservedInstances") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ReservedInstance])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeReservedInstancesResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeReservedInstancesResponse'`
-> DescribeReservedInstancesResponse

Create a value of DescribeReservedInstancesResponse 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:

DescribeReservedInstances, describeReservedInstancesResponse_nextToken - When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

$sel:reservedInstances:DescribeReservedInstancesResponse', describeReservedInstancesResponse_reservedInstances - List of Reserved Instances in the current Region.

$sel:httpStatus:DescribeReservedInstancesResponse', describeReservedInstancesResponse_httpStatus - The response's http status code.

Response Lenses

describeReservedInstancesResponse_nextToken :: Lens' DescribeReservedInstancesResponse (Maybe Text) Source #

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

describeReservedInstancesResponse_reservedInstances :: Lens' DescribeReservedInstancesResponse (Maybe [ReservedInstance]) Source #

List of Reserved Instances in the current Region.

describeReservedInstancesResponse_httpStatus :: Lens' DescribeReservedInstancesResponse Int Source #

The response's http status code.