libZSservicesZSamazonka-opensearchZSamazonka-opensearch
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.OpenSearch.GetUpgradeStatus

Description

Retrieves the latest status of the last upgrade or upgrade eligibility check performed on the domain.

Synopsis

Creating a Request

data GetUpgradeStatus Source #

Container for the request parameters to the GetUpgradeStatus operation.

See: newGetUpgradeStatus smart constructor.

Constructors

GetUpgradeStatus' 

Fields

Instances

Instances details
Eq GetUpgradeStatus Source # 
Instance details

Defined in Amazonka.OpenSearch.GetUpgradeStatus

Methods

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

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

Read GetUpgradeStatus Source # 
Instance details

Defined in Amazonka.OpenSearch.GetUpgradeStatus

Methods

readsPrec :: Int -> ReadS GetUpgradeStatus #

readList :: ReadS [GetUpgradeStatus] #

readPrec :: ReadPrec GetUpgradeStatus #

readListPrec :: ReadPrec [GetUpgradeStatus] #

Show GetUpgradeStatus Source # 
Instance details

Defined in Amazonka.OpenSearch.GetUpgradeStatus

Methods

showsPrec :: Int -> GetUpgradeStatus -> ShowS #

show :: GetUpgradeStatus -> String #

showList :: [GetUpgradeStatus] -> ShowS #

Generic GetUpgradeStatus Source # 
Instance details

Defined in Amazonka.OpenSearch.GetUpgradeStatus

Associated Types

type Rep GetUpgradeStatus :: Type -> Type #

Methods

from :: GetUpgradeStatus -> Rep GetUpgradeStatus x #

to :: Rep GetUpgradeStatus x -> GetUpgradeStatus #

NFData GetUpgradeStatus Source # 
Instance details

Defined in Amazonka.OpenSearch.GetUpgradeStatus

Methods

rnf :: GetUpgradeStatus -> () #

Hashable GetUpgradeStatus Source # 
Instance details

Defined in Amazonka.OpenSearch.GetUpgradeStatus

Methods

hashWithSalt :: Int -> GetUpgradeStatus -> Int #

hash :: GetUpgradeStatus -> Int #

AWSRequest GetUpgradeStatus Source # 
Instance details

Defined in Amazonka.OpenSearch.GetUpgradeStatus

Associated Types

type AWSResponse GetUpgradeStatus #

Methods

request :: GetUpgradeStatus -> Request GetUpgradeStatus #

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

ToHeaders GetUpgradeStatus Source # 
Instance details

Defined in Amazonka.OpenSearch.GetUpgradeStatus

Methods

toHeaders :: GetUpgradeStatus -> [Header] #

ToPath GetUpgradeStatus Source # 
Instance details

Defined in Amazonka.OpenSearch.GetUpgradeStatus

Methods

toPath :: GetUpgradeStatus -> ByteString #

ToQuery GetUpgradeStatus Source # 
Instance details

Defined in Amazonka.OpenSearch.GetUpgradeStatus

Methods

toQuery :: GetUpgradeStatus -> QueryString #

type Rep GetUpgradeStatus Source # 
Instance details

Defined in Amazonka.OpenSearch.GetUpgradeStatus

type Rep GetUpgradeStatus = D1 ('MetaData "GetUpgradeStatus" "Amazonka.OpenSearch.GetUpgradeStatus" "libZSservicesZSamazonka-opensearchZSamazonka-opensearch" 'False) (C1 ('MetaCons "GetUpgradeStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "domainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse GetUpgradeStatus Source # 
Instance details

Defined in Amazonka.OpenSearch.GetUpgradeStatus

type AWSResponse GetUpgradeStatus = GetUpgradeStatusResponse

newGetUpgradeStatus Source #

Arguments

:: Text

$sel:domainName:GetUpgradeStatus'

-> GetUpgradeStatus 

Create a value of GetUpgradeStatus 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:domainName:GetUpgradeStatus', getUpgradeStatus_domainName - Undocumented member.

Request Lenses

getUpgradeStatus_domainName :: Lens' GetUpgradeStatus Text Source #

Undocumented member.

Destructuring the Response

data GetUpgradeStatusResponse Source #

Container for the response returned by the GetUpgradeStatus operation.

See: newGetUpgradeStatusResponse smart constructor.

Constructors

GetUpgradeStatusResponse' 

Fields

  • stepStatus :: Maybe UpgradeStatus

    One of four statuses an upgrade have, returned as part of the GetUpgradeStatusResponse object. The status can take one of the following values:

    • In Progress
    • Succeeded
    • Succeeded with Issues
    • Failed
  • upgradeName :: Maybe Text

    A string that briefly describes the update.

  • upgradeStep :: Maybe UpgradeStep

    One of three steps an upgrade or upgrade eligibility check goes through:

    • PreUpgradeCheck
    • Snapshot
    • Upgrade
  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq GetUpgradeStatusResponse Source # 
Instance details

Defined in Amazonka.OpenSearch.GetUpgradeStatus

Methods

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

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

Read GetUpgradeStatusResponse Source # 
Instance details

Defined in Amazonka.OpenSearch.GetUpgradeStatus

Methods

readsPrec :: Int -> ReadS GetUpgradeStatusResponse #

readList :: ReadS [GetUpgradeStatusResponse] #

readPrec :: ReadPrec GetUpgradeStatusResponse #

readListPrec :: ReadPrec [GetUpgradeStatusResponse] #

Show GetUpgradeStatusResponse Source # 
Instance details

Defined in Amazonka.OpenSearch.GetUpgradeStatus

Methods

showsPrec :: Int -> GetUpgradeStatusResponse -> ShowS #

show :: GetUpgradeStatusResponse -> String #

showList :: [GetUpgradeStatusResponse] -> ShowS #

Generic GetUpgradeStatusResponse Source # 
Instance details

Defined in Amazonka.OpenSearch.GetUpgradeStatus

Associated Types

type Rep GetUpgradeStatusResponse :: Type -> Type #

Methods

from :: GetUpgradeStatusResponse -> Rep GetUpgradeStatusResponse x #

to :: Rep GetUpgradeStatusResponse x -> GetUpgradeStatusResponse #

NFData GetUpgradeStatusResponse Source # 
Instance details

Defined in Amazonka.OpenSearch.GetUpgradeStatus

Methods

rnf :: GetUpgradeStatusResponse -> () #

type Rep GetUpgradeStatusResponse Source # 
Instance details

Defined in Amazonka.OpenSearch.GetUpgradeStatus

type Rep GetUpgradeStatusResponse = D1 ('MetaData "GetUpgradeStatusResponse" "Amazonka.OpenSearch.GetUpgradeStatus" "libZSservicesZSamazonka-opensearchZSamazonka-opensearch" 'False) (C1 ('MetaCons "GetUpgradeStatusResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "stepStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UpgradeStatus)) :*: S1 ('MetaSel ('Just "upgradeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "upgradeStep") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UpgradeStep)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetUpgradeStatusResponse Source #

Arguments

:: Int

$sel:httpStatus:GetUpgradeStatusResponse'

-> GetUpgradeStatusResponse 

Create a value of GetUpgradeStatusResponse 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:stepStatus:GetUpgradeStatusResponse', getUpgradeStatusResponse_stepStatus - One of four statuses an upgrade have, returned as part of the GetUpgradeStatusResponse object. The status can take one of the following values:

  • In Progress
  • Succeeded
  • Succeeded with Issues
  • Failed

$sel:upgradeName:GetUpgradeStatusResponse', getUpgradeStatusResponse_upgradeName - A string that briefly describes the update.

$sel:upgradeStep:GetUpgradeStatusResponse', getUpgradeStatusResponse_upgradeStep - One of three steps an upgrade or upgrade eligibility check goes through:

  • PreUpgradeCheck
  • Snapshot
  • Upgrade

$sel:httpStatus:GetUpgradeStatusResponse', getUpgradeStatusResponse_httpStatus - The response's http status code.

Response Lenses

getUpgradeStatusResponse_stepStatus :: Lens' GetUpgradeStatusResponse (Maybe UpgradeStatus) Source #

One of four statuses an upgrade have, returned as part of the GetUpgradeStatusResponse object. The status can take one of the following values:

  • In Progress
  • Succeeded
  • Succeeded with Issues
  • Failed

getUpgradeStatusResponse_upgradeName :: Lens' GetUpgradeStatusResponse (Maybe Text) Source #

A string that briefly describes the update.

getUpgradeStatusResponse_upgradeStep :: Lens' GetUpgradeStatusResponse (Maybe UpgradeStep) Source #

One of three steps an upgrade or upgrade eligibility check goes through:

  • PreUpgradeCheck
  • Snapshot
  • Upgrade

getUpgradeStatusResponse_httpStatus :: Lens' GetUpgradeStatusResponse Int Source #

The response's http status code.