Skip to content

EC2  >  Operations  >  get_instance_uefi_data

get_instance_uefi_data

Operation

get_instance_uefi_data async

get_instance_uefi_data(input: GetInstanceUefiDataInput, plugins: list[Plugin] | None = None) -> GetInstanceUefiDataOutput

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.

Parameters:

Name Type Description Default
input GetInstanceUefiDataInput

An instance of GetInstanceUefiDataInput.

required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
GetInstanceUefiDataOutput

An instance of GetInstanceUefiDataOutput.

Input

GetInstanceUefiDataInput dataclass

Bases: _SerdeShape

Dataclass for GetInstanceUefiDataInput structure.

Attributes

dry_run class-attribute instance-attribute
dry_run: bool | None = ...

Checks whether you have the required permissions for the operation, 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.

instance_id class-attribute instance-attribute
instance_id: str | None = ...

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

Output

GetInstanceUefiDataOutput dataclass

Bases: _SerdeShape

Dataclass for GetInstanceUefiDataOutput structure.

Attributes

instance_id class-attribute instance-attribute
instance_id: str | None = ...

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

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

uefi_data class-attribute instance-attribute
uefi_data: str | None = ...

Base64 representation of the non-volatile UEFI variable store.