Amazonka.EKS.DescribeUpdate

Returns descriptive information about an update against your Amazon EKS cluster or associated managed node group or Amazon EKS add-on.

When the status of the update is Succeeded, the update is complete. If an update fails, the status is Failed, and an error detail explains the reason for the failure.

Creating a Request

data DescribeUpdate

See: newDescribeUpdate smart constructor.

Constructors

DescribeUpdate'

Fields

• addonName :: Maybe Text

  The name of the add-on. The name must match one of the names returned by ListAddons . This parameter is required if the update is an add-on update.

• nodegroupName :: Maybe Text

  The name of the Amazon EKS node group associated with the update. This parameter is required if the update is a node group update.

• name :: Text

  The name of the Amazon EKS cluster associated with the update.

• updateId :: Text

  The ID of the update to describe.

Instances

ToHeaders DescribeUpdate

Defined in Amazonka.EKS.DescribeUpdate

Methods

toHeaders :: DescribeUpdate -> [Header]

ToPath DescribeUpdate

Defined in Amazonka.EKS.DescribeUpdate

Methods

toPath :: DescribeUpdate -> ByteString

ToQuery DescribeUpdate

Defined in Amazonka.EKS.DescribeUpdate

Methods

toQuery :: DescribeUpdate -> QueryString

AWSRequest DescribeUpdate

Defined in Amazonka.EKS.DescribeUpdate

Associated Types

type AWSResponse DescribeUpdate

Methods

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

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

Generic DescribeUpdate

Defined in Amazonka.EKS.DescribeUpdate

Associated Types

type Rep DescribeUpdate :: Type -> Type

Methods

from :: DescribeUpdate -> Rep DescribeUpdate x

to :: Rep DescribeUpdate x -> DescribeUpdate

Read DescribeUpdate

Defined in Amazonka.EKS.DescribeUpdate

Methods

readsPrec :: Int -> ReadS DescribeUpdate

readList :: ReadS [DescribeUpdate]

readPrec :: ReadPrec DescribeUpdate

readListPrec :: ReadPrec [DescribeUpdate]

Show DescribeUpdate

Defined in Amazonka.EKS.DescribeUpdate

Methods

showsPrec :: Int -> DescribeUpdate -> ShowS

show :: DescribeUpdate -> String

showList :: [DescribeUpdate] -> ShowS

NFData DescribeUpdate

Defined in Amazonka.EKS.DescribeUpdate

Methods

rnf :: DescribeUpdate -> ()

Eq DescribeUpdate

Defined in Amazonka.EKS.DescribeUpdate

Methods

(==) :: DescribeUpdate -> DescribeUpdate -> Bool

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

Hashable DescribeUpdate

Defined in Amazonka.EKS.DescribeUpdate

Methods

hashWithSalt :: Int -> DescribeUpdate -> Int

hash :: DescribeUpdate -> Int

type AWSResponse DescribeUpdate

Defined in Amazonka.EKS.DescribeUpdate

type AWSResponse DescribeUpdate = DescribeUpdateResponse

type Rep DescribeUpdate

Defined in Amazonka.EKS.DescribeUpdate

type Rep DescribeUpdate = D1 ('MetaData "DescribeUpdate" "Amazonka.EKS.DescribeUpdate" "amazonka-eks-2.0-7cAibD4zEbE2zPO6gnUh5m" 'False) (C1 ('MetaCons "DescribeUpdate'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "addonName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "nodegroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "updateId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newDescribeUpdate

Arguments

:: Text

DescribeUpdate

-> Text

$sel:updateId:DescribeUpdate'

-> DescribeUpdate

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

DescribeUpdate, describeUpdate_addonName - The name of the add-on. The name must match one of the names returned by ListAddons . This parameter is required if the update is an add-on update.

DescribeUpdate, describeUpdate_nodegroupName - The name of the Amazon EKS node group associated with the update. This parameter is required if the update is a node group update.

DescribeUpdate, describeUpdate_name - The name of the Amazon EKS cluster associated with the update.

$sel:updateId:DescribeUpdate', describeUpdate_updateId - The ID of the update to describe.

Request Lenses

describeUpdate_addonName :: Lens' DescribeUpdate (Maybe Text)

The name of the add-on. The name must match one of the names returned by ListAddons . This parameter is required if the update is an add-on update.

describeUpdate_nodegroupName :: Lens' DescribeUpdate (Maybe Text)

The name of the Amazon EKS node group associated with the update. This parameter is required if the update is a node group update.

describeUpdate_name :: Lens' DescribeUpdate Text

The name of the Amazon EKS cluster associated with the update.

describeUpdate_updateId :: Lens' DescribeUpdate Text

The ID of the update to describe.

Destructuring the Response

data DescribeUpdateResponse

See: newDescribeUpdateResponse smart constructor.

Constructors

DescribeUpdateResponse'

Fields

• update :: Maybe Update

  The full description of the specified update.

• httpStatus :: Int

  The response's http status code.

Instances

Generic DescribeUpdateResponse

Defined in Amazonka.EKS.DescribeUpdate

Associated Types

type Rep DescribeUpdateResponse :: Type -> Type

Methods

from :: DescribeUpdateResponse -> Rep DescribeUpdateResponse x

to :: Rep DescribeUpdateResponse x -> DescribeUpdateResponse

Read DescribeUpdateResponse

Defined in Amazonka.EKS.DescribeUpdate

Methods

readsPrec :: Int -> ReadS DescribeUpdateResponse

readList :: ReadS [DescribeUpdateResponse]

readPrec :: ReadPrec DescribeUpdateResponse

readListPrec :: ReadPrec [DescribeUpdateResponse]

Show DescribeUpdateResponse

Defined in Amazonka.EKS.DescribeUpdate

Methods

showsPrec :: Int -> DescribeUpdateResponse -> ShowS

show :: DescribeUpdateResponse -> String

showList :: [DescribeUpdateResponse] -> ShowS

NFData DescribeUpdateResponse

Defined in Amazonka.EKS.DescribeUpdate

Methods

rnf :: DescribeUpdateResponse -> ()

Eq DescribeUpdateResponse

Defined in Amazonka.EKS.DescribeUpdate

Methods

(==) :: DescribeUpdateResponse -> DescribeUpdateResponse -> Bool

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

type Rep DescribeUpdateResponse

Defined in Amazonka.EKS.DescribeUpdate

type Rep DescribeUpdateResponse = D1 ('MetaData "DescribeUpdateResponse" "Amazonka.EKS.DescribeUpdate" "amazonka-eks-2.0-7cAibD4zEbE2zPO6gnUh5m" 'False) (C1 ('MetaCons "DescribeUpdateResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "update") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Update)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDescribeUpdateResponse

Arguments

:: Int

$sel:httpStatus:DescribeUpdateResponse'

-> DescribeUpdateResponse

Create a value of DescribeUpdateResponse 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:update:DescribeUpdateResponse', describeUpdateResponse_update - The full description of the specified update.

$sel:httpStatus:DescribeUpdateResponse', describeUpdateResponse_httpStatus - The response's http status code.

Response Lenses

describeUpdateResponse_update :: Lens' DescribeUpdateResponse (Maybe Update)

The full description of the specified update.

describeUpdateResponse_httpStatus :: Lens' DescribeUpdateResponse Int

The response's http status code.