Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.OpenSearch.DescribeReservedInstances

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns information about reserved OpenSearch instances for this account.

Synopsis

Creating a Request

data DescribeReservedInstances Source #

Container for parameters to DescribeReservedInstances

See: newDescribeReservedInstances smart constructor.

Constructors

DescribeReservedInstances'
Fields nextToken :: Maybe Text Provides an identifier to allow retrieval of paginated results. 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. maxResults :: Maybe Int Set this value to limit the number of results returned. If not specified, defaults to 100.

Instances

Instances details

Eq DescribeReservedInstances Source #
Instance details Defined in Amazonka.OpenSearch.DescribeReservedInstances Methods (==) :: DescribeReservedInstances -> DescribeReservedInstances -> Bool # (/=) :: DescribeReservedInstances -> DescribeReservedInstances -> Bool #
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 #
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 #
NFData DescribeReservedInstances Source #
Instance details Defined in Amazonka.OpenSearch.DescribeReservedInstances Methods rnf :: DescribeReservedInstances -> () #
Hashable DescribeReservedInstances Source #
Instance details Defined in Amazonka.OpenSearch.DescribeReservedInstances Methods hashWithSalt :: Int -> DescribeReservedInstances -> Int # hash :: DescribeReservedInstances -> Int #
AWSRequest DescribeReservedInstances Source #
Instance details Defined in Amazonka.OpenSearch.DescribeReservedInstances Associated Types type AWSResponse DescribeReservedInstances # Methods request :: DescribeReservedInstances -> Request DescribeReservedInstances # response :: MonadResource m => Logger -> Service -> Proxy DescribeReservedInstances -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeReservedInstances))) #
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 #
type Rep DescribeReservedInstances Source #
Instance details Defined in Amazonka.OpenSearch.DescribeReservedInstances type Rep DescribeReservedInstances = D1 ('MetaData "DescribeReservedInstances" "Amazonka.OpenSearch.DescribeReservedInstances" "libZSservicesZSamazonka-opensearchZSamazonka-opensearch" 'False) (C1 ('MetaCons "DescribeReservedInstances'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "reservedInstanceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))))
type AWSResponse DescribeReservedInstances Source #
Instance details Defined in Amazonka.OpenSearch.DescribeReservedInstances type AWSResponse DescribeReservedInstances = DescribeReservedInstancesResponse

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:nextToken:DescribeReservedInstances', describeReservedInstances_nextToken - Provides an identifier to allow retrieval of paginated results.

$sel:reservedInstanceId: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.

$sel:maxResults:DescribeReservedInstances', describeReservedInstances_maxResults - Set this value to limit the number of results returned. If not specified, defaults to 100.

Request Lenses

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

Provides an identifier to allow retrieval of paginated results.

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.

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

Set this value to limit the number of results returned. If not specified, defaults to 100.

Destructuring the Response

data DescribeReservedInstancesResponse Source #

Container for results from DescribeReservedInstances

See: newDescribeReservedInstancesResponse smart constructor.

Constructors

DescribeReservedInstancesResponse'
Fields nextToken :: Maybe Text Provides an identifier to allow retrieval of paginated results. reservedInstances :: Maybe [ReservedInstance] List of reserved OpenSearch instances. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq DescribeReservedInstancesResponse Source #
Instance details Defined in Amazonka.OpenSearch.DescribeReservedInstances Methods (==) :: DescribeReservedInstancesResponse -> DescribeReservedInstancesResponse -> Bool # (/=) :: DescribeReservedInstancesResponse -> DescribeReservedInstancesResponse -> Bool #
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 #
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 #
NFData DescribeReservedInstancesResponse Source #
Instance details Defined in Amazonka.OpenSearch.DescribeReservedInstances Methods rnf :: DescribeReservedInstancesResponse -> () #
type Rep DescribeReservedInstancesResponse Source #
Instance details Defined in Amazonka.OpenSearch.DescribeReservedInstances type Rep DescribeReservedInstancesResponse = D1 ('MetaData "DescribeReservedInstancesResponse" "Amazonka.OpenSearch.DescribeReservedInstances" "libZSservicesZSamazonka-opensearchZSamazonka-opensearch" '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:

$sel:nextToken:DescribeReservedInstances', describeReservedInstancesResponse_nextToken - Provides an identifier to allow retrieval of paginated results.

$sel:reservedInstances:DescribeReservedInstancesResponse', describeReservedInstancesResponse_reservedInstances - List of reserved OpenSearch instances.

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

Response Lenses

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

Provides an identifier to allow retrieval of paginated results.

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

List of reserved OpenSearch instances.

describeReservedInstancesResponse_httpStatus :: Lens' DescribeReservedInstancesResponse Int Source #

The response's http status code.