amazonka-ec2-2.0: Amazon Elastic Compute Cloud 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.EC2.GetInstanceUefiData

Description

A binary representation of the UEFI variable store. Only non-volatile variables are stored. This is a base64 encoded and zlib compressed binary value that must be properly encoded.

When you use register-image to create an AMI, you can create an exact copy of your variable store by passing the UEFI data in the UefiData parameter. You can modify the UEFI data by using the python-uefivars tool on GitHub. You can use the tool to convert the UEFI data into a human-readable format (JSON), which you can inspect and modify, and then convert back into the binary format to use with register-image.

For more information, see UEFI Secure Boot in the Amazon EC2 User Guide.

Synopsis

Creating a Request

data GetInstanceUefiData Source #

See: newGetInstanceUefiData smart constructor.

Constructors

GetInstanceUefiData' 

Fields

  • dryRun :: Maybe Bool

    Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

  • instanceId :: Text

    The ID of the instance from which to retrieve the UEFI data.

Instances

Instances details
ToHeaders GetInstanceUefiData Source # 
Instance details

Defined in Amazonka.EC2.GetInstanceUefiData

ToPath GetInstanceUefiData Source # 
Instance details

Defined in Amazonka.EC2.GetInstanceUefiData

ToQuery GetInstanceUefiData Source # 
Instance details

Defined in Amazonka.EC2.GetInstanceUefiData

AWSRequest GetInstanceUefiData Source # 
Instance details

Defined in Amazonka.EC2.GetInstanceUefiData

Associated Types

type AWSResponse GetInstanceUefiData #

Generic GetInstanceUefiData Source # 
Instance details

Defined in Amazonka.EC2.GetInstanceUefiData

Associated Types

type Rep GetInstanceUefiData :: Type -> Type #

Read GetInstanceUefiData Source # 
Instance details

Defined in Amazonka.EC2.GetInstanceUefiData

Show GetInstanceUefiData Source # 
Instance details

Defined in Amazonka.EC2.GetInstanceUefiData

NFData GetInstanceUefiData Source # 
Instance details

Defined in Amazonka.EC2.GetInstanceUefiData

Methods

rnf :: GetInstanceUefiData -> () #

Eq GetInstanceUefiData Source # 
Instance details

Defined in Amazonka.EC2.GetInstanceUefiData

Hashable GetInstanceUefiData Source # 
Instance details

Defined in Amazonka.EC2.GetInstanceUefiData

type AWSResponse GetInstanceUefiData Source # 
Instance details

Defined in Amazonka.EC2.GetInstanceUefiData

type Rep GetInstanceUefiData Source # 
Instance details

Defined in Amazonka.EC2.GetInstanceUefiData

type Rep GetInstanceUefiData = D1 ('MetaData "GetInstanceUefiData" "Amazonka.EC2.GetInstanceUefiData" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "GetInstanceUefiData'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dryRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "instanceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newGetInstanceUefiData Source #

Create a value of GetInstanceUefiData 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:dryRun:GetInstanceUefiData', getInstanceUefiData_dryRun - Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

GetInstanceUefiData, getInstanceUefiData_instanceId - The ID of the instance from which to retrieve the UEFI data.

Request Lenses

getInstanceUefiData_dryRun :: Lens' GetInstanceUefiData (Maybe Bool) Source #

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

getInstanceUefiData_instanceId :: Lens' GetInstanceUefiData Text Source #

The ID of the instance from which to retrieve the UEFI data.

Destructuring the Response

data GetInstanceUefiDataResponse Source #

See: newGetInstanceUefiDataResponse smart constructor.

Constructors

GetInstanceUefiDataResponse' 

Fields

Instances

Instances details
Generic GetInstanceUefiDataResponse Source # 
Instance details

Defined in Amazonka.EC2.GetInstanceUefiData

Associated Types

type Rep GetInstanceUefiDataResponse :: Type -> Type #

Read GetInstanceUefiDataResponse Source # 
Instance details

Defined in Amazonka.EC2.GetInstanceUefiData

Show GetInstanceUefiDataResponse Source # 
Instance details

Defined in Amazonka.EC2.GetInstanceUefiData

NFData GetInstanceUefiDataResponse Source # 
Instance details

Defined in Amazonka.EC2.GetInstanceUefiData

Eq GetInstanceUefiDataResponse Source # 
Instance details

Defined in Amazonka.EC2.GetInstanceUefiData

type Rep GetInstanceUefiDataResponse Source # 
Instance details

Defined in Amazonka.EC2.GetInstanceUefiData

type Rep GetInstanceUefiDataResponse = D1 ('MetaData "GetInstanceUefiDataResponse" "Amazonka.EC2.GetInstanceUefiData" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "GetInstanceUefiDataResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "instanceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "uefiData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetInstanceUefiDataResponse Source #

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

GetInstanceUefiData, getInstanceUefiDataResponse_instanceId - The ID of the instance from which to retrieve the UEFI data.

$sel:uefiData:GetInstanceUefiDataResponse', getInstanceUefiDataResponse_uefiData - Base64 representation of the non-volatile UEFI variable store.

$sel:httpStatus:GetInstanceUefiDataResponse', getInstanceUefiDataResponse_httpStatus - The response's http status code.

Response Lenses

getInstanceUefiDataResponse_instanceId :: Lens' GetInstanceUefiDataResponse (Maybe Text) Source #

The ID of the instance from which to retrieve the UEFI data.

getInstanceUefiDataResponse_uefiData :: Lens' GetInstanceUefiDataResponse (Maybe Text) Source #

Base64 representation of the non-volatile UEFI variable store.