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

Description

Retrieves the complete history of the last 10 upgrades performed on an Amazon OpenSearch Service domain.

Synopsis

Creating a Request

data GetUpgradeHistory Source #

Container for the request parameters to the GetUpgradeHistory operation.

See: newGetUpgradeHistory smart constructor.

Constructors

GetUpgradeHistory' 

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

  • domainName :: Text

    The name of an existing domain.

Instances

Instances details
ToHeaders GetUpgradeHistory Source # 
Instance details

Defined in Amazonka.OpenSearch.GetUpgradeHistory

ToPath GetUpgradeHistory Source # 
Instance details

Defined in Amazonka.OpenSearch.GetUpgradeHistory

ToQuery GetUpgradeHistory Source # 
Instance details

Defined in Amazonka.OpenSearch.GetUpgradeHistory

AWSRequest GetUpgradeHistory Source # 
Instance details

Defined in Amazonka.OpenSearch.GetUpgradeHistory

Associated Types

type AWSResponse GetUpgradeHistory #

Generic GetUpgradeHistory Source # 
Instance details

Defined in Amazonka.OpenSearch.GetUpgradeHistory

Associated Types

type Rep GetUpgradeHistory :: Type -> Type #

Read GetUpgradeHistory Source # 
Instance details

Defined in Amazonka.OpenSearch.GetUpgradeHistory

Show GetUpgradeHistory Source # 
Instance details

Defined in Amazonka.OpenSearch.GetUpgradeHistory

NFData GetUpgradeHistory Source # 
Instance details

Defined in Amazonka.OpenSearch.GetUpgradeHistory

Methods

rnf :: GetUpgradeHistory -> () #

Eq GetUpgradeHistory Source # 
Instance details

Defined in Amazonka.OpenSearch.GetUpgradeHistory

Hashable GetUpgradeHistory Source # 
Instance details

Defined in Amazonka.OpenSearch.GetUpgradeHistory

type AWSResponse GetUpgradeHistory Source # 
Instance details

Defined in Amazonka.OpenSearch.GetUpgradeHistory

type Rep GetUpgradeHistory Source # 
Instance details

Defined in Amazonka.OpenSearch.GetUpgradeHistory

type Rep GetUpgradeHistory = D1 ('MetaData "GetUpgradeHistory" "Amazonka.OpenSearch.GetUpgradeHistory" "amazonka-opensearch-2.0-GNoaWlqGXH04P8GBIHM78L" 'False) (C1 ('MetaCons "GetUpgradeHistory'" '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))))

newGetUpgradeHistory Source #

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

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

GetUpgradeHistory, getUpgradeHistory_domainName - The name of an existing domain.

Request Lenses

getUpgradeHistory_maxResults :: Lens' GetUpgradeHistory (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.

getUpgradeHistory_nextToken :: Lens' GetUpgradeHistory (Maybe Text) Source #

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

Destructuring the Response

data GetUpgradeHistoryResponse Source #

Container for the response returned by the GetUpgradeHistory operation.

See: newGetUpgradeHistoryResponse smart constructor.

Constructors

GetUpgradeHistoryResponse' 

Fields

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

  • upgradeHistories :: Maybe [UpgradeHistory]

    A list of objects corresponding to each upgrade or upgrade eligibility check performed on a domain.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic GetUpgradeHistoryResponse Source # 
Instance details

Defined in Amazonka.OpenSearch.GetUpgradeHistory

Associated Types

type Rep GetUpgradeHistoryResponse :: Type -> Type #

Read GetUpgradeHistoryResponse Source # 
Instance details

Defined in Amazonka.OpenSearch.GetUpgradeHistory

Show GetUpgradeHistoryResponse Source # 
Instance details

Defined in Amazonka.OpenSearch.GetUpgradeHistory

NFData GetUpgradeHistoryResponse Source # 
Instance details

Defined in Amazonka.OpenSearch.GetUpgradeHistory

Eq GetUpgradeHistoryResponse Source # 
Instance details

Defined in Amazonka.OpenSearch.GetUpgradeHistory

type Rep GetUpgradeHistoryResponse Source # 
Instance details

Defined in Amazonka.OpenSearch.GetUpgradeHistory

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

newGetUpgradeHistoryResponse Source #

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

GetUpgradeHistory, getUpgradeHistoryResponse_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:upgradeHistories:GetUpgradeHistoryResponse', getUpgradeHistoryResponse_upgradeHistories - A list of objects corresponding to each upgrade or upgrade eligibility check performed on a domain.

$sel:httpStatus:GetUpgradeHistoryResponse', getUpgradeHistoryResponse_httpStatus - The response's http status code.

Response Lenses

getUpgradeHistoryResponse_nextToken :: Lens' GetUpgradeHistoryResponse (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.

getUpgradeHistoryResponse_upgradeHistories :: Lens' GetUpgradeHistoryResponse (Maybe [UpgradeHistory]) Source #

A list of objects corresponding to each upgrade or upgrade eligibility check performed on a domain.