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.ElasticSearch.DescribeReservedElasticsearchInstances

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns information about reserved Elasticsearch instances for this account.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeReservedElasticsearchInstances Source #

Container for parameters to DescribeReservedElasticsearchInstances

See: newDescribeReservedElasticsearchInstances smart constructor.

Constructors

DescribeReservedElasticsearchInstances'

Fields

reservedElasticsearchInstanceId :: Maybe Text
The reserved instance identifier filter value. Use this parameter to show only the reservation that matches the specified reserved Elasticsearch instance ID.
nextToken :: Maybe Text
NextToken should be sent in case if earlier API call produced result containing NextToken. It is used for pagination.
maxResults :: Maybe Int
Set this value to limit the number of results returned. If not specified, defaults to 100.

Instances

Instances details

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

newDescribeReservedElasticsearchInstances :: DescribeReservedElasticsearchInstances Source #

Create a value of DescribeReservedElasticsearchInstances 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:reservedElasticsearchInstanceId:DescribeReservedElasticsearchInstances', describeReservedElasticsearchInstances_reservedElasticsearchInstanceId - The reserved instance identifier filter value. Use this parameter to show only the reservation that matches the specified reserved Elasticsearch instance ID.

$sel:nextToken:DescribeReservedElasticsearchInstances', describeReservedElasticsearchInstances_nextToken - NextToken should be sent in case if earlier API call produced result containing NextToken. It is used for pagination.

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

Request Lenses

describeReservedElasticsearchInstances_reservedElasticsearchInstanceId :: Lens' DescribeReservedElasticsearchInstances (Maybe Text) Source #

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

describeReservedElasticsearchInstances_nextToken :: Lens' DescribeReservedElasticsearchInstances (Maybe Text) Source #

NextToken should be sent in case if earlier API call produced result containing NextToken. It is used for pagination.

describeReservedElasticsearchInstances_maxResults :: Lens' DescribeReservedElasticsearchInstances (Maybe Int) Source #

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

Destructuring the Response

data DescribeReservedElasticsearchInstancesResponse Source #

Container for results from DescribeReservedElasticsearchInstances

See: newDescribeReservedElasticsearchInstancesResponse smart constructor.

Constructors

DescribeReservedElasticsearchInstancesResponse'
Fields reservedElasticsearchInstances :: Maybe [ReservedElasticsearchInstance] List of reserved Elasticsearch instances. nextToken :: Maybe Text Provides an identifier to allow retrieval of paginated results. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq DescribeReservedElasticsearchInstancesResponse Source #
Instance details Defined in Amazonka.ElasticSearch.DescribeReservedElasticsearchInstances Methods (==) :: DescribeReservedElasticsearchInstancesResponse -> DescribeReservedElasticsearchInstancesResponse -> Bool # (/=) :: DescribeReservedElasticsearchInstancesResponse -> DescribeReservedElasticsearchInstancesResponse -> Bool #
Read DescribeReservedElasticsearchInstancesResponse Source #
Instance details Defined in Amazonka.ElasticSearch.DescribeReservedElasticsearchInstances Methods readsPrec :: Int -> ReadS DescribeReservedElasticsearchInstancesResponse # readList :: ReadS [DescribeReservedElasticsearchInstancesResponse] # readPrec :: ReadPrec DescribeReservedElasticsearchInstancesResponse # readListPrec :: ReadPrec [DescribeReservedElasticsearchInstancesResponse] #
Show DescribeReservedElasticsearchInstancesResponse Source #
Instance details Defined in Amazonka.ElasticSearch.DescribeReservedElasticsearchInstances Methods showsPrec :: Int -> DescribeReservedElasticsearchInstancesResponse -> ShowS # show :: DescribeReservedElasticsearchInstancesResponse -> String # showList :: [DescribeReservedElasticsearchInstancesResponse] -> ShowS #
Generic DescribeReservedElasticsearchInstancesResponse Source #
Instance details Defined in Amazonka.ElasticSearch.DescribeReservedElasticsearchInstances Associated Types type Rep DescribeReservedElasticsearchInstancesResponse :: Type -> Type # Methods from :: DescribeReservedElasticsearchInstancesResponse -> Rep DescribeReservedElasticsearchInstancesResponse x # to :: Rep DescribeReservedElasticsearchInstancesResponse x -> DescribeReservedElasticsearchInstancesResponse #
NFData DescribeReservedElasticsearchInstancesResponse Source #
Instance details Defined in Amazonka.ElasticSearch.DescribeReservedElasticsearchInstances Methods rnf :: DescribeReservedElasticsearchInstancesResponse -> () #
type Rep DescribeReservedElasticsearchInstancesResponse Source #
Instance details Defined in Amazonka.ElasticSearch.DescribeReservedElasticsearchInstances type Rep DescribeReservedElasticsearchInstancesResponse = D1 ('MetaData "DescribeReservedElasticsearchInstancesResponse" "Amazonka.ElasticSearch.DescribeReservedElasticsearchInstances" "libZSservicesZSamazonka-elasticsearchZSamazonka-elasticsearch" 'False) (C1 ('MetaCons "DescribeReservedElasticsearchInstancesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "reservedElasticsearchInstances") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ReservedElasticsearchInstance])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeReservedElasticsearchInstancesResponse Source #

Arguments

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

Create a value of DescribeReservedElasticsearchInstancesResponse 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:reservedElasticsearchInstances:DescribeReservedElasticsearchInstancesResponse', describeReservedElasticsearchInstancesResponse_reservedElasticsearchInstances - List of reserved Elasticsearch instances.

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

$sel:httpStatus:DescribeReservedElasticsearchInstancesResponse', describeReservedElasticsearchInstancesResponse_httpStatus - The response's http status code.

Response Lenses

describeReservedElasticsearchInstancesResponse_reservedElasticsearchInstances :: Lens' DescribeReservedElasticsearchInstancesResponse (Maybe [ReservedElasticsearchInstance]) Source #

List of reserved Elasticsearch instances.

describeReservedElasticsearchInstancesResponse_nextToken :: Lens' DescribeReservedElasticsearchInstancesResponse (Maybe Text) Source #

Provides an identifier to allow retrieval of paginated results.

describeReservedElasticsearchInstancesResponse_httpStatus :: Lens' DescribeReservedElasticsearchInstancesResponse Int Source #

The response's http status code.