libZSservicesZSamazonka-elasticsearchZSamazonka-elasticsearch
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.ElasticSearch.ListElasticsearchInstanceTypes

Description

List all Elasticsearch instance types that are supported for given ElasticsearchVersion

This operation returns paginated results.

Synopsis

Creating a Request

data ListElasticsearchInstanceTypes Source #

Container for the parameters to the ListElasticsearchInstanceTypes operation.

See: newListElasticsearchInstanceTypes smart constructor.

Constructors

ListElasticsearchInstanceTypes' 

Fields

  • nextToken :: Maybe Text

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

  • domainName :: Maybe Text

    DomainName represents the name of the Domain that we are trying to modify. This should be present only if we are querying for list of available Elasticsearch instance types when modifying existing domain.

  • maxResults :: Maybe Int

    Set this value to limit the number of results returned. Value provided must be greater than 30 else it wont be honored.

  • elasticsearchVersion :: Text

    Version of Elasticsearch for which list of supported elasticsearch instance types are needed.

Instances

Instances details
Eq ListElasticsearchInstanceTypes Source # 
Instance details

Defined in Amazonka.ElasticSearch.ListElasticsearchInstanceTypes

Methods

(==) :: ListElasticsearchInstanceTypes -> ListElasticsearchInstanceTypes -> Bool #

(/=) :: ListElasticsearchInstanceTypes -> ListElasticsearchInstanceTypes -> Bool #

Read ListElasticsearchInstanceTypes Source # 
Instance details

Defined in Amazonka.ElasticSearch.ListElasticsearchInstanceTypes

Methods

readsPrec :: Int -> ReadS ListElasticsearchInstanceTypes #

readList :: ReadS [ListElasticsearchInstanceTypes] #

readPrec :: ReadPrec ListElasticsearchInstanceTypes #

readListPrec :: ReadPrec [ListElasticsearchInstanceTypes] #

Show ListElasticsearchInstanceTypes Source # 
Instance details

Defined in Amazonka.ElasticSearch.ListElasticsearchInstanceTypes

Methods

showsPrec :: Int -> ListElasticsearchInstanceTypes -> ShowS #

show :: ListElasticsearchInstanceTypes -> String #

showList :: [ListElasticsearchInstanceTypes] -> ShowS #

Generic ListElasticsearchInstanceTypes Source # 
Instance details

Defined in Amazonka.ElasticSearch.ListElasticsearchInstanceTypes

Associated Types

type Rep ListElasticsearchInstanceTypes :: Type -> Type #

Methods

from :: ListElasticsearchInstanceTypes -> Rep ListElasticsearchInstanceTypes x #

to :: Rep ListElasticsearchInstanceTypes x -> ListElasticsearchInstanceTypes #

NFData ListElasticsearchInstanceTypes Source # 
Instance details

Defined in Amazonka.ElasticSearch.ListElasticsearchInstanceTypes

Methods

rnf :: ListElasticsearchInstanceTypes -> () #

Hashable ListElasticsearchInstanceTypes Source # 
Instance details

Defined in Amazonka.ElasticSearch.ListElasticsearchInstanceTypes

Methods

hashWithSalt :: Int -> ListElasticsearchInstanceTypes -> Int #

hash :: ListElasticsearchInstanceTypes -> Int #

AWSPager ListElasticsearchInstanceTypes Source # 
Instance details

Defined in Amazonka.ElasticSearch.ListElasticsearchInstanceTypes

Methods

page :: ListElasticsearchInstanceTypes -> AWSResponse ListElasticsearchInstanceTypes -> Maybe ListElasticsearchInstanceTypes #

AWSRequest ListElasticsearchInstanceTypes Source # 
Instance details

Defined in Amazonka.ElasticSearch.ListElasticsearchInstanceTypes

Associated Types

type AWSResponse ListElasticsearchInstanceTypes #

Methods

request :: ListElasticsearchInstanceTypes -> Request ListElasticsearchInstanceTypes #

response :: MonadResource m => Logger -> Service -> Proxy ListElasticsearchInstanceTypes -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListElasticsearchInstanceTypes))) #

ToHeaders ListElasticsearchInstanceTypes Source # 
Instance details

Defined in Amazonka.ElasticSearch.ListElasticsearchInstanceTypes

Methods

toHeaders :: ListElasticsearchInstanceTypes -> [Header] #

ToPath ListElasticsearchInstanceTypes Source # 
Instance details

Defined in Amazonka.ElasticSearch.ListElasticsearchInstanceTypes

Methods

toPath :: ListElasticsearchInstanceTypes -> ByteString #

ToQuery ListElasticsearchInstanceTypes Source # 
Instance details

Defined in Amazonka.ElasticSearch.ListElasticsearchInstanceTypes

Methods

toQuery :: ListElasticsearchInstanceTypes -> QueryString #

type Rep ListElasticsearchInstanceTypes Source # 
Instance details

Defined in Amazonka.ElasticSearch.ListElasticsearchInstanceTypes

type Rep ListElasticsearchInstanceTypes = D1 ('MetaData "ListElasticsearchInstanceTypes" "Amazonka.ElasticSearch.ListElasticsearchInstanceTypes" "libZSservicesZSamazonka-elasticsearchZSamazonka-elasticsearch" 'False) (C1 ('MetaCons "ListElasticsearchInstanceTypes'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "domainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "elasticsearchVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse ListElasticsearchInstanceTypes Source # 
Instance details

Defined in Amazonka.ElasticSearch.ListElasticsearchInstanceTypes

type AWSResponse ListElasticsearchInstanceTypes = ListElasticsearchInstanceTypesResponse

newListElasticsearchInstanceTypes Source #

Arguments

:: Text

$sel:elasticsearchVersion:ListElasticsearchInstanceTypes'

-> ListElasticsearchInstanceTypes 

Create a value of ListElasticsearchInstanceTypes 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:ListElasticsearchInstanceTypes', listElasticsearchInstanceTypes_nextToken - NextToken should be sent in case if earlier API call produced result containing NextToken. It is used for pagination.

$sel:domainName:ListElasticsearchInstanceTypes', listElasticsearchInstanceTypes_domainName - DomainName represents the name of the Domain that we are trying to modify. This should be present only if we are querying for list of available Elasticsearch instance types when modifying existing domain.

$sel:maxResults:ListElasticsearchInstanceTypes', listElasticsearchInstanceTypes_maxResults - Set this value to limit the number of results returned. Value provided must be greater than 30 else it wont be honored.

$sel:elasticsearchVersion:ListElasticsearchInstanceTypes', listElasticsearchInstanceTypes_elasticsearchVersion - Version of Elasticsearch for which list of supported elasticsearch instance types are needed.

Request Lenses

listElasticsearchInstanceTypes_nextToken :: Lens' ListElasticsearchInstanceTypes (Maybe Text) Source #

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

listElasticsearchInstanceTypes_domainName :: Lens' ListElasticsearchInstanceTypes (Maybe Text) Source #

DomainName represents the name of the Domain that we are trying to modify. This should be present only if we are querying for list of available Elasticsearch instance types when modifying existing domain.

listElasticsearchInstanceTypes_maxResults :: Lens' ListElasticsearchInstanceTypes (Maybe Int) Source #

Set this value to limit the number of results returned. Value provided must be greater than 30 else it wont be honored.

listElasticsearchInstanceTypes_elasticsearchVersion :: Lens' ListElasticsearchInstanceTypes Text Source #

Version of Elasticsearch for which list of supported elasticsearch instance types are needed.

Destructuring the Response

data ListElasticsearchInstanceTypesResponse Source #

Container for the parameters returned by ListElasticsearchInstanceTypes operation.

See: newListElasticsearchInstanceTypesResponse smart constructor.

Constructors

ListElasticsearchInstanceTypesResponse' 

Fields

Instances

Instances details
Eq ListElasticsearchInstanceTypesResponse Source # 
Instance details

Defined in Amazonka.ElasticSearch.ListElasticsearchInstanceTypes

Methods

(==) :: ListElasticsearchInstanceTypesResponse -> ListElasticsearchInstanceTypesResponse -> Bool #

(/=) :: ListElasticsearchInstanceTypesResponse -> ListElasticsearchInstanceTypesResponse -> Bool #

Read ListElasticsearchInstanceTypesResponse Source # 
Instance details

Defined in Amazonka.ElasticSearch.ListElasticsearchInstanceTypes

Methods

readsPrec :: Int -> ReadS ListElasticsearchInstanceTypesResponse #

readList :: ReadS [ListElasticsearchInstanceTypesResponse] #

readPrec :: ReadPrec ListElasticsearchInstanceTypesResponse #

readListPrec :: ReadPrec [ListElasticsearchInstanceTypesResponse] #

Show ListElasticsearchInstanceTypesResponse Source # 
Instance details

Defined in Amazonka.ElasticSearch.ListElasticsearchInstanceTypes

Methods

showsPrec :: Int -> ListElasticsearchInstanceTypesResponse -> ShowS #

show :: ListElasticsearchInstanceTypesResponse -> String #

showList :: [ListElasticsearchInstanceTypesResponse] -> ShowS #

Generic ListElasticsearchInstanceTypesResponse Source # 
Instance details

Defined in Amazonka.ElasticSearch.ListElasticsearchInstanceTypes

Associated Types

type Rep ListElasticsearchInstanceTypesResponse :: Type -> Type #

Methods

from :: ListElasticsearchInstanceTypesResponse -> Rep ListElasticsearchInstanceTypesResponse x #

to :: Rep ListElasticsearchInstanceTypesResponse x -> ListElasticsearchInstanceTypesResponse #

NFData ListElasticsearchInstanceTypesResponse Source # 
Instance details

Defined in Amazonka.ElasticSearch.ListElasticsearchInstanceTypes

Methods

rnf :: ListElasticsearchInstanceTypesResponse -> () #

type Rep ListElasticsearchInstanceTypesResponse Source # 
Instance details

Defined in Amazonka.ElasticSearch.ListElasticsearchInstanceTypes

type Rep ListElasticsearchInstanceTypesResponse = D1 ('MetaData "ListElasticsearchInstanceTypesResponse" "Amazonka.ElasticSearch.ListElasticsearchInstanceTypes" "libZSservicesZSamazonka-elasticsearchZSamazonka-elasticsearch" 'False) (C1 ('MetaCons "ListElasticsearchInstanceTypesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "elasticsearchInstanceTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ESPartitionInstanceType])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListElasticsearchInstanceTypesResponse Source #

Arguments

:: Int

$sel:httpStatus:ListElasticsearchInstanceTypesResponse'

-> ListElasticsearchInstanceTypesResponse 

Create a value of ListElasticsearchInstanceTypesResponse 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:elasticsearchInstanceTypes:ListElasticsearchInstanceTypesResponse', listElasticsearchInstanceTypesResponse_elasticsearchInstanceTypes - List of instance types supported by Amazon Elasticsearch service for given ElasticsearchVersion

$sel:nextToken:ListElasticsearchInstanceTypes', listElasticsearchInstanceTypesResponse_nextToken - In case if there are more results available NextToken would be present, make further request to the same API with received NextToken to paginate remaining results.

$sel:httpStatus:ListElasticsearchInstanceTypesResponse', listElasticsearchInstanceTypesResponse_httpStatus - The response's http status code.

Response Lenses

listElasticsearchInstanceTypesResponse_elasticsearchInstanceTypes :: Lens' ListElasticsearchInstanceTypesResponse (Maybe [ESPartitionInstanceType]) Source #

List of instance types supported by Amazon Elasticsearch service for given ElasticsearchVersion

listElasticsearchInstanceTypesResponse_nextToken :: Lens' ListElasticsearchInstanceTypesResponse (Maybe Text) Source #

In case if there are more results available NextToken would be present, make further request to the same API with received NextToken to paginate remaining results.

listElasticsearchInstanceTypesResponse_httpStatus :: Lens' ListElasticsearchInstanceTypesResponse Int Source #

The response's http status code.