Amazonka.OpenSearch.GetUpgradeStatus

Returns the most recent status of the last upgrade or upgrade eligibility check performed on an Amazon OpenSearch Service domain.

Creating a Request

data GetUpgradeStatus

Container for the request parameters to the GetUpgradeStatus operation.

See: newGetUpgradeStatus smart constructor.

Constructors

GetUpgradeStatus'

Fields

• domainName :: Text

  The domain of the domain to get upgrade status information for.

Instances

ToHeaders GetUpgradeStatus

Defined in Amazonka.OpenSearch.GetUpgradeStatus

Methods

toHeaders :: GetUpgradeStatus -> [Header]

ToPath GetUpgradeStatus

Defined in Amazonka.OpenSearch.GetUpgradeStatus

Methods

toPath :: GetUpgradeStatus -> ByteString

ToQuery GetUpgradeStatus

Defined in Amazonka.OpenSearch.GetUpgradeStatus

Methods

toQuery :: GetUpgradeStatus -> QueryString

AWSRequest GetUpgradeStatus

Defined in Amazonka.OpenSearch.GetUpgradeStatus

Associated Types

type AWSResponse GetUpgradeStatus

Methods

request :: (Service -> Service) -> GetUpgradeStatus -> Request GetUpgradeStatus

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

Generic GetUpgradeStatus

Defined in Amazonka.OpenSearch.GetUpgradeStatus

Associated Types

type Rep GetUpgradeStatus :: Type -> Type

Methods

from :: GetUpgradeStatus -> Rep GetUpgradeStatus x

to :: Rep GetUpgradeStatus x -> GetUpgradeStatus

Read GetUpgradeStatus

Defined in Amazonka.OpenSearch.GetUpgradeStatus

Methods

readsPrec :: Int -> ReadS GetUpgradeStatus

readList :: ReadS [GetUpgradeStatus]

readPrec :: ReadPrec GetUpgradeStatus

readListPrec :: ReadPrec [GetUpgradeStatus]

Show GetUpgradeStatus

Defined in Amazonka.OpenSearch.GetUpgradeStatus

Methods

showsPrec :: Int -> GetUpgradeStatus -> ShowS

show :: GetUpgradeStatus -> String

showList :: [GetUpgradeStatus] -> ShowS

NFData GetUpgradeStatus

Defined in Amazonka.OpenSearch.GetUpgradeStatus

Methods

rnf :: GetUpgradeStatus -> ()

Eq GetUpgradeStatus

Defined in Amazonka.OpenSearch.GetUpgradeStatus

Methods

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

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

Hashable GetUpgradeStatus

Defined in Amazonka.OpenSearch.GetUpgradeStatus

Methods

hashWithSalt :: Int -> GetUpgradeStatus -> Int

hash :: GetUpgradeStatus -> Int

type AWSResponse GetUpgradeStatus

Defined in Amazonka.OpenSearch.GetUpgradeStatus

type AWSResponse GetUpgradeStatus = GetUpgradeStatusResponse

type Rep GetUpgradeStatus

Defined in Amazonka.OpenSearch.GetUpgradeStatus

type Rep GetUpgradeStatus = D1 ('MetaData "GetUpgradeStatus" "Amazonka.OpenSearch.GetUpgradeStatus" "amazonka-opensearch-2.0-GNoaWlqGXH04P8GBIHM78L" 'False) (C1 ('MetaCons "GetUpgradeStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "domainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newGetUpgradeStatus

Arguments

:: Text

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:

GetUpgradeStatus, getUpgradeStatus_domainName - The domain of the domain to get upgrade status information for.

Request Lenses

getUpgradeStatus_domainName :: Lens' GetUpgradeStatus Text

The domain of the domain to get upgrade status information for.

Destructuring the Response

data GetUpgradeStatusResponse

Container for the response returned by the GetUpgradeStatus operation.

See: newGetUpgradeStatusResponse smart constructor.

Constructors

GetUpgradeStatusResponse'

Fields

• stepStatus :: Maybe UpgradeStatus

  The status of the current step that an upgrade is on.

• upgradeName :: Maybe Text

  A string that describes the update.

• upgradeStep :: Maybe UpgradeStep

  One of three steps that an upgrade or upgrade eligibility check goes through.

• httpStatus :: Int

  The response's http status code.

Instances

Generic GetUpgradeStatusResponse

Defined in Amazonka.OpenSearch.GetUpgradeStatus

Associated Types

type Rep GetUpgradeStatusResponse :: Type -> Type

Methods

from :: GetUpgradeStatusResponse -> Rep GetUpgradeStatusResponse x

to :: Rep GetUpgradeStatusResponse x -> GetUpgradeStatusResponse

Read GetUpgradeStatusResponse

Defined in Amazonka.OpenSearch.GetUpgradeStatus

Methods

readsPrec :: Int -> ReadS GetUpgradeStatusResponse

readList :: ReadS [GetUpgradeStatusResponse]

readPrec :: ReadPrec GetUpgradeStatusResponse

readListPrec :: ReadPrec [GetUpgradeStatusResponse]

Show GetUpgradeStatusResponse

Defined in Amazonka.OpenSearch.GetUpgradeStatus

Methods

showsPrec :: Int -> GetUpgradeStatusResponse -> ShowS

show :: GetUpgradeStatusResponse -> String

showList :: [GetUpgradeStatusResponse] -> ShowS

NFData GetUpgradeStatusResponse

Defined in Amazonka.OpenSearch.GetUpgradeStatus

Methods

rnf :: GetUpgradeStatusResponse -> ()

Eq GetUpgradeStatusResponse

Defined in Amazonka.OpenSearch.GetUpgradeStatus

Methods

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

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

type Rep GetUpgradeStatusResponse

Defined in Amazonka.OpenSearch.GetUpgradeStatus

type Rep GetUpgradeStatusResponse = D1 ('MetaData "GetUpgradeStatusResponse" "Amazonka.OpenSearch.GetUpgradeStatus" "amazonka-opensearch-2.0-GNoaWlqGXH04P8GBIHM78L" '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

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 - The status of the current step that an upgrade is on.

GetUpgradeStatusResponse, getUpgradeStatusResponse_upgradeName - A string that describes the update.

GetUpgradeStatusResponse, getUpgradeStatusResponse_upgradeStep - One of three steps that an upgrade or upgrade eligibility check goes through.

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

Response Lenses

getUpgradeStatusResponse_stepStatus :: Lens' GetUpgradeStatusResponse (Maybe UpgradeStatus)

The status of the current step that an upgrade is on.

getUpgradeStatusResponse_upgradeName :: Lens' GetUpgradeStatusResponse (Maybe Text)

A string that describes the update.

getUpgradeStatusResponse_upgradeStep :: Lens' GetUpgradeStatusResponse (Maybe UpgradeStep)

One of three steps that an upgrade or upgrade eligibility check goes through.

getUpgradeStatusResponse_httpStatus :: Lens' GetUpgradeStatusResponse Int

The response's http status code.