amazonka-eks-2.0: Amazon Elastic Kubernetes 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.EKS.DescribeUpdate

Description

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.

Synopsis

Creating a Request

data DescribeUpdate Source #

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

Instances details
ToHeaders DescribeUpdate Source # 
Instance details

Defined in Amazonka.EKS.DescribeUpdate

ToPath DescribeUpdate Source # 
Instance details

Defined in Amazonka.EKS.DescribeUpdate

ToQuery DescribeUpdate Source # 
Instance details

Defined in Amazonka.EKS.DescribeUpdate

AWSRequest DescribeUpdate Source # 
Instance details

Defined in Amazonka.EKS.DescribeUpdate

Associated Types

type AWSResponse DescribeUpdate #

Generic DescribeUpdate Source # 
Instance details

Defined in Amazonka.EKS.DescribeUpdate

Associated Types

type Rep DescribeUpdate :: Type -> Type #

Read DescribeUpdate Source # 
Instance details

Defined in Amazonka.EKS.DescribeUpdate

Show DescribeUpdate Source # 
Instance details

Defined in Amazonka.EKS.DescribeUpdate

NFData DescribeUpdate Source # 
Instance details

Defined in Amazonka.EKS.DescribeUpdate

Methods

rnf :: DescribeUpdate -> () #

Eq DescribeUpdate Source # 
Instance details

Defined in Amazonka.EKS.DescribeUpdate

Hashable DescribeUpdate Source # 
Instance details

Defined in Amazonka.EKS.DescribeUpdate

type AWSResponse DescribeUpdate Source # 
Instance details

Defined in Amazonka.EKS.DescribeUpdate

type Rep DescribeUpdate Source # 
Instance details

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 Source #

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) Source #

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) Source #

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 Source #

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

describeUpdate_updateId :: Lens' DescribeUpdate Text Source #

The ID of the update to describe.

Destructuring the Response

data DescribeUpdateResponse Source #

See: newDescribeUpdateResponse smart constructor.

Constructors

DescribeUpdateResponse' 

Fields

Instances

Instances details
Generic DescribeUpdateResponse Source # 
Instance details

Defined in Amazonka.EKS.DescribeUpdate

Associated Types

type Rep DescribeUpdateResponse :: Type -> Type #

Read DescribeUpdateResponse Source # 
Instance details

Defined in Amazonka.EKS.DescribeUpdate

Show DescribeUpdateResponse Source # 
Instance details

Defined in Amazonka.EKS.DescribeUpdate

NFData DescribeUpdateResponse Source # 
Instance details

Defined in Amazonka.EKS.DescribeUpdate

Methods

rnf :: DescribeUpdateResponse -> () #

Eq DescribeUpdateResponse Source # 
Instance details

Defined in Amazonka.EKS.DescribeUpdate

type Rep DescribeUpdateResponse Source # 
Instance details

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 Source #

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) Source #

The full description of the specified update.