EC2 / Client / get_instance_uefi_data

get_instance_uefi_data#

EC2.Client.get_instance_uefi_data(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.get_instance_uefi_data(
    InstanceId='string',
    DryRun=True|False
)
Parameters:

  • InstanceId (string) –

    [REQUIRED]

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

  • DryRun (boolean) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'InstanceId': 'string',
    'UefiData': 'string'
}

Response Structure

  • (dict) –

    • InstanceId (string) –

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

    • UefiData (string) –

      Base64 representation of the non-volatile UEFI variable store.