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

Description

Returns the list of optimizations that Auto-Tune has made to an Amazon OpenSearch Service domain. For more information, see Auto-Tune for Amazon OpenSearch Service.

Synopsis

Creating a Request

data DescribeDomainAutoTunes Source #

Container for the parameters to the DescribeDomainAutoTunes operation.

See: newDescribeDomainAutoTunes smart constructor.

Constructors

DescribeDomainAutoTunes' 

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

  • domainName :: Text

    Name of the domain that you want Auto-Tune details about.

Instances

Instances details
ToHeaders DescribeDomainAutoTunes Source # 
Instance details

Defined in Amazonka.OpenSearch.DescribeDomainAutoTunes

ToPath DescribeDomainAutoTunes Source # 
Instance details

Defined in Amazonka.OpenSearch.DescribeDomainAutoTunes

ToQuery DescribeDomainAutoTunes Source # 
Instance details

Defined in Amazonka.OpenSearch.DescribeDomainAutoTunes

AWSRequest DescribeDomainAutoTunes Source # 
Instance details

Defined in Amazonka.OpenSearch.DescribeDomainAutoTunes

Generic DescribeDomainAutoTunes Source # 
Instance details

Defined in Amazonka.OpenSearch.DescribeDomainAutoTunes

Associated Types

type Rep DescribeDomainAutoTunes :: Type -> Type #

Read DescribeDomainAutoTunes Source # 
Instance details

Defined in Amazonka.OpenSearch.DescribeDomainAutoTunes

Show DescribeDomainAutoTunes Source # 
Instance details

Defined in Amazonka.OpenSearch.DescribeDomainAutoTunes

NFData DescribeDomainAutoTunes Source # 
Instance details

Defined in Amazonka.OpenSearch.DescribeDomainAutoTunes

Methods

rnf :: DescribeDomainAutoTunes -> () #

Eq DescribeDomainAutoTunes Source # 
Instance details

Defined in Amazonka.OpenSearch.DescribeDomainAutoTunes

Hashable DescribeDomainAutoTunes Source # 
Instance details

Defined in Amazonka.OpenSearch.DescribeDomainAutoTunes

type AWSResponse DescribeDomainAutoTunes Source # 
Instance details

Defined in Amazonka.OpenSearch.DescribeDomainAutoTunes

type Rep DescribeDomainAutoTunes Source # 
Instance details

Defined in Amazonka.OpenSearch.DescribeDomainAutoTunes

type Rep DescribeDomainAutoTunes = D1 ('MetaData "DescribeDomainAutoTunes" "Amazonka.OpenSearch.DescribeDomainAutoTunes" "amazonka-opensearch-2.0-GNoaWlqGXH04P8GBIHM78L" 'False) (C1 ('MetaCons "DescribeDomainAutoTunes'" '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 "domainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newDescribeDomainAutoTunes Source #

Create a value of DescribeDomainAutoTunes 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:DescribeDomainAutoTunes', describeDomainAutoTunes_maxResults - An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

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

DescribeDomainAutoTunes, describeDomainAutoTunes_domainName - Name of the domain that you want Auto-Tune details about.

Request Lenses

describeDomainAutoTunes_maxResults :: Lens' DescribeDomainAutoTunes (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.

describeDomainAutoTunes_nextToken :: Lens' DescribeDomainAutoTunes (Maybe Text) Source #

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

describeDomainAutoTunes_domainName :: Lens' DescribeDomainAutoTunes Text Source #

Name of the domain that you want Auto-Tune details about.

Destructuring the Response

data DescribeDomainAutoTunesResponse Source #

The result of a DescribeDomainAutoTunes request.

See: newDescribeDomainAutoTunesResponse smart constructor.

Constructors

DescribeDomainAutoTunesResponse' 

Fields

  • autoTunes :: Maybe [AutoTune]

    The list of setting adjustments that Auto-Tune has made to the domain.

  • 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 DescribeDomainAutoTunesResponse Source # 
Instance details

Defined in Amazonka.OpenSearch.DescribeDomainAutoTunes

Associated Types

type Rep DescribeDomainAutoTunesResponse :: Type -> Type #

Read DescribeDomainAutoTunesResponse Source # 
Instance details

Defined in Amazonka.OpenSearch.DescribeDomainAutoTunes

Show DescribeDomainAutoTunesResponse Source # 
Instance details

Defined in Amazonka.OpenSearch.DescribeDomainAutoTunes

NFData DescribeDomainAutoTunesResponse Source # 
Instance details

Defined in Amazonka.OpenSearch.DescribeDomainAutoTunes

Eq DescribeDomainAutoTunesResponse Source # 
Instance details

Defined in Amazonka.OpenSearch.DescribeDomainAutoTunes

type Rep DescribeDomainAutoTunesResponse Source # 
Instance details

Defined in Amazonka.OpenSearch.DescribeDomainAutoTunes

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

newDescribeDomainAutoTunesResponse Source #

Create a value of DescribeDomainAutoTunesResponse 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:autoTunes:DescribeDomainAutoTunesResponse', describeDomainAutoTunesResponse_autoTunes - The list of setting adjustments that Auto-Tune has made to the domain.

DescribeDomainAutoTunes, describeDomainAutoTunesResponse_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:DescribeDomainAutoTunesResponse', describeDomainAutoTunesResponse_httpStatus - The response's http status code.

Response Lenses

describeDomainAutoTunesResponse_autoTunes :: Lens' DescribeDomainAutoTunesResponse (Maybe [AutoTune]) Source #

The list of setting adjustments that Auto-Tune has made to the domain.

describeDomainAutoTunesResponse_nextToken :: Lens' DescribeDomainAutoTunesResponse (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.