Amazonka.OpenSearch.Types.UpgradeStepItem

Documentation

data UpgradeStepItem

Represents a single step of an upgrade or upgrade eligibility check workflow.

See: newUpgradeStepItem smart constructor.

Constructors

UpgradeStepItem'

Fields

• issues :: Maybe [Text]

  A list of strings containing detailed information about the errors encountered in a particular step.

• progressPercent :: Maybe Double

  The floating point value representing the progress percentage of a particular step.

• upgradeStep :: Maybe UpgradeStep

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

  • PreUpgradeCheck
  • Snapshot
  • Upgrade
• upgradeStepStatus :: Maybe UpgradeStatus

  The current status of the upgrade. The status can take one of the following values:

  • In Progress
  • Succeeded
  • Succeeded with Issues
  • Failed

Instances

FromJSON UpgradeStepItem

Defined in Amazonka.OpenSearch.Types.UpgradeStepItem

Methods

parseJSON :: Value -> Parser UpgradeStepItem

parseJSONList :: Value -> Parser [UpgradeStepItem]

Generic UpgradeStepItem

Defined in Amazonka.OpenSearch.Types.UpgradeStepItem

Associated Types

type Rep UpgradeStepItem :: Type -> Type

Methods

from :: UpgradeStepItem -> Rep UpgradeStepItem x

to :: Rep UpgradeStepItem x -> UpgradeStepItem

Read UpgradeStepItem

Defined in Amazonka.OpenSearch.Types.UpgradeStepItem

Methods

readsPrec :: Int -> ReadS UpgradeStepItem

readList :: ReadS [UpgradeStepItem]

readPrec :: ReadPrec UpgradeStepItem

readListPrec :: ReadPrec [UpgradeStepItem]

Show UpgradeStepItem

Defined in Amazonka.OpenSearch.Types.UpgradeStepItem

Methods

showsPrec :: Int -> UpgradeStepItem -> ShowS

show :: UpgradeStepItem -> String

showList :: [UpgradeStepItem] -> ShowS

NFData UpgradeStepItem

Defined in Amazonka.OpenSearch.Types.UpgradeStepItem

Methods

rnf :: UpgradeStepItem -> ()

Eq UpgradeStepItem

Defined in Amazonka.OpenSearch.Types.UpgradeStepItem

Methods

(==) :: UpgradeStepItem -> UpgradeStepItem -> Bool

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

Hashable UpgradeStepItem

Defined in Amazonka.OpenSearch.Types.UpgradeStepItem

Methods

hashWithSalt :: Int -> UpgradeStepItem -> Int

hash :: UpgradeStepItem -> Int

type Rep UpgradeStepItem

Defined in Amazonka.OpenSearch.Types.UpgradeStepItem

type Rep UpgradeStepItem = D1 ('MetaData "UpgradeStepItem" "Amazonka.OpenSearch.Types.UpgradeStepItem" "amazonka-opensearch-2.0-GNoaWlqGXH04P8GBIHM78L" 'False) (C1 ('MetaCons "UpgradeStepItem'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "issues") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "progressPercent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double))) :*: (S1 ('MetaSel ('Just "upgradeStep") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UpgradeStep)) :*: S1 ('MetaSel ('Just "upgradeStepStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UpgradeStatus)))))

newUpgradeStepItem :: UpgradeStepItem

Create a value of UpgradeStepItem 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:issues:UpgradeStepItem', upgradeStepItem_issues - A list of strings containing detailed information about the errors encountered in a particular step.

$sel:progressPercent:UpgradeStepItem', upgradeStepItem_progressPercent - The floating point value representing the progress percentage of a particular step.

$sel:upgradeStep:UpgradeStepItem', upgradeStepItem_upgradeStep - One of three steps that an upgrade or upgrade eligibility check goes through:

• PreUpgradeCheck
• Snapshot
• Upgrade

$sel:upgradeStepStatus:UpgradeStepItem', upgradeStepItem_upgradeStepStatus - The current status of the upgrade. The status can take one of the following values:

• In Progress
• Succeeded
• Succeeded with Issues
• Failed

upgradeStepItem_issues :: Lens' UpgradeStepItem (Maybe [Text])

A list of strings containing detailed information about the errors encountered in a particular step.

upgradeStepItem_progressPercent :: Lens' UpgradeStepItem (Maybe Double)

The floating point value representing the progress percentage of a particular step.

upgradeStepItem_upgradeStep :: Lens' UpgradeStepItem (Maybe UpgradeStep)

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

• PreUpgradeCheck
• Snapshot
• Upgrade

upgradeStepItem_upgradeStepStatus :: Lens' UpgradeStepItem (Maybe UpgradeStatus)

The current status of the upgrade. The status can take one of the following values:

• In Progress
• Succeeded
• Succeeded with Issues
• Failed