amazonka-opensearch-2.0: Amazon OpenSearch Service SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.OpenSearch.ListInstanceTypeDetails

Description

Lists all instance types and available features for a given OpenSearch or Elasticsearch version.

Synopsis

Creating a Request

data ListInstanceTypeDetails Source #

See: newListInstanceTypeDetails smart constructor.

Constructors

ListInstanceTypeDetails' 

Fields

  • domainName :: Maybe Text

    Name of the domain to list instance type details for.

  • 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 ListInstanceTypeDetails operation returns a nextToken, you can include the returned nextToken in subsequent ListInstanceTypeDetails operations, which returns results in the next page.

  • engineVersion :: Text

    Version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y. Defaults to the latest version of OpenSearch.

Instances

Instances details
ToHeaders ListInstanceTypeDetails Source # 
Instance details

Defined in Amazonka.OpenSearch.ListInstanceTypeDetails

ToPath ListInstanceTypeDetails Source # 
Instance details

Defined in Amazonka.OpenSearch.ListInstanceTypeDetails

ToQuery ListInstanceTypeDetails Source # 
Instance details

Defined in Amazonka.OpenSearch.ListInstanceTypeDetails

AWSRequest ListInstanceTypeDetails Source # 
Instance details

Defined in Amazonka.OpenSearch.ListInstanceTypeDetails

Generic ListInstanceTypeDetails Source # 
Instance details

Defined in Amazonka.OpenSearch.ListInstanceTypeDetails

Associated Types

type Rep ListInstanceTypeDetails :: Type -> Type #

Read ListInstanceTypeDetails Source # 
Instance details

Defined in Amazonka.OpenSearch.ListInstanceTypeDetails

Show ListInstanceTypeDetails Source # 
Instance details

Defined in Amazonka.OpenSearch.ListInstanceTypeDetails

NFData ListInstanceTypeDetails Source # 
Instance details

Defined in Amazonka.OpenSearch.ListInstanceTypeDetails

Methods

rnf :: ListInstanceTypeDetails -> () #

Eq ListInstanceTypeDetails Source # 
Instance details

Defined in Amazonka.OpenSearch.ListInstanceTypeDetails

Hashable ListInstanceTypeDetails Source # 
Instance details

Defined in Amazonka.OpenSearch.ListInstanceTypeDetails

type AWSResponse ListInstanceTypeDetails Source # 
Instance details

Defined in Amazonka.OpenSearch.ListInstanceTypeDetails

type Rep ListInstanceTypeDetails Source # 
Instance details

Defined in Amazonka.OpenSearch.ListInstanceTypeDetails

type Rep ListInstanceTypeDetails = D1 ('MetaData "ListInstanceTypeDetails" "Amazonka.OpenSearch.ListInstanceTypeDetails" "amazonka-opensearch-2.0-GNoaWlqGXH04P8GBIHM78L" 'False) (C1 ('MetaCons "ListInstanceTypeDetails'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "domainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "engineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListInstanceTypeDetails Source #

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

ListInstanceTypeDetails, listInstanceTypeDetails_domainName - Name of the domain to list instance type details for.

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

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

ListInstanceTypeDetails, listInstanceTypeDetails_engineVersion - Version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y. Defaults to the latest version of OpenSearch.

Request Lenses

listInstanceTypeDetails_domainName :: Lens' ListInstanceTypeDetails (Maybe Text) Source #

Name of the domain to list instance type details for.

listInstanceTypeDetails_maxResults :: Lens' ListInstanceTypeDetails (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.

listInstanceTypeDetails_nextToken :: Lens' ListInstanceTypeDetails (Maybe Text) Source #

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

listInstanceTypeDetails_engineVersion :: Lens' ListInstanceTypeDetails Text Source #

Version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y. Defaults to the latest version of OpenSearch.

Destructuring the Response

data ListInstanceTypeDetailsResponse Source #

See: newListInstanceTypeDetailsResponse smart constructor.

Constructors

ListInstanceTypeDetailsResponse' 

Fields

  • instanceTypeDetails :: Maybe [InstanceTypeDetails]

    Lists all supported instance types and features for the given OpenSearch or Elasticsearch version.

  • 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.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic ListInstanceTypeDetailsResponse Source # 
Instance details

Defined in Amazonka.OpenSearch.ListInstanceTypeDetails

Associated Types

type Rep ListInstanceTypeDetailsResponse :: Type -> Type #

Read ListInstanceTypeDetailsResponse Source # 
Instance details

Defined in Amazonka.OpenSearch.ListInstanceTypeDetails

Show ListInstanceTypeDetailsResponse Source # 
Instance details

Defined in Amazonka.OpenSearch.ListInstanceTypeDetails

NFData ListInstanceTypeDetailsResponse Source # 
Instance details

Defined in Amazonka.OpenSearch.ListInstanceTypeDetails

Eq ListInstanceTypeDetailsResponse Source # 
Instance details

Defined in Amazonka.OpenSearch.ListInstanceTypeDetails

type Rep ListInstanceTypeDetailsResponse Source # 
Instance details

Defined in Amazonka.OpenSearch.ListInstanceTypeDetails

type Rep ListInstanceTypeDetailsResponse = D1 ('MetaData "ListInstanceTypeDetailsResponse" "Amazonka.OpenSearch.ListInstanceTypeDetails" "amazonka-opensearch-2.0-GNoaWlqGXH04P8GBIHM78L" 'False) (C1 ('MetaCons "ListInstanceTypeDetailsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "instanceTypeDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [InstanceTypeDetails])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListInstanceTypeDetailsResponse Source #

Create a value of ListInstanceTypeDetailsResponse 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:instanceTypeDetails:ListInstanceTypeDetailsResponse', listInstanceTypeDetailsResponse_instanceTypeDetails - Lists all supported instance types and features for the given OpenSearch or Elasticsearch version.

ListInstanceTypeDetails, listInstanceTypeDetailsResponse_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:httpStatus:ListInstanceTypeDetailsResponse', listInstanceTypeDetailsResponse_httpStatus - The response's http status code.

Response Lenses

listInstanceTypeDetailsResponse_instanceTypeDetails :: Lens' ListInstanceTypeDetailsResponse (Maybe [InstanceTypeDetails]) Source #

Lists all supported instance types and features for the given OpenSearch or Elasticsearch version.

listInstanceTypeDetailsResponse_nextToken :: Lens' ListInstanceTypeDetailsResponse (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.