get_instance_uefi_data `async` ¶

get_instance_uefi_data(
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    instance_id: Optional[InstanceId] = None,
    dry_run: Optional[Boolean] = None,
) -> GetInstanceUefiDataResult

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:

instance_id (Optional[InstanceId], default: None ) –

The ID of the instance from which to retrieve the UEFI data.
dry_run (Optional[Boolean], default: 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.

Raises:

UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_ec2/_services/async_ec2.py

async def get_instance_uefi_data(
    self,
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    instance_id: Optional["capo_ec2.types.instance_id.InstanceId"] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
) -> "capo_ec2.types.get_instance_uefi_data_result.GetInstanceUefiDataResult":
    """<p>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.</p> <p>When you use <a href="https://docs.aws.amazon.com/cli/latest/reference/ec2/register-image.html">register-image</a> to create an AMI, you can create an exact copy of your variable store by passing the UEFI data in the <code>UefiData</code> parameter. You can modify the UEFI data by using the <a href="https://github.com/awslabs/python-uefivars">python-uefivars tool</a> 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.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/uefi-secure-boot.html">UEFI Secure Boot</a> in the <i>Amazon EC2 User Guide</i>.</p>

    Args:
        instance_id: <p>The ID of the instance from which to retrieve the UEFI data.</p>
        dry_run: <p>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 <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>

    Raises:
        capo_ec2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_ec2.types.get_instance_uefi_data_request.GetInstanceUefiDataRequest]",
    ) -> AsyncOperationResponse[
        "capo_ec2.types.get_instance_uefi_data_result.GetInstanceUefiDataResult"
    ]:
        import capo_ec2._operations.amazon_ec2.get_instance_uefi_data

        (
            output,
            http_response,
        ) = await capo_ec2._operations.amazon_ec2.get_instance_uefi_data.async_get_instance_uefi_data(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_ec2.types.get_instance_uefi_data_result.GetInstanceUefiDataResult",
    ) -> dict[str, Any]:
        import capo_ec2.types.get_instance_uefi_data_result

        return capo_ec2.types.get_instance_uefi_data_result.redact_sensitive(output)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("GetInstanceUefiData", redact_output=_redact_output),
    )
    input_: capo_ec2.types.get_instance_uefi_data_request.GetInstanceUefiDataRequest = {}
    if instance_id is not None:
        input_["instance_id"] = instance_id
    if dry_run is not None:
        input_["dry_run"] = dry_run

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

get_instance_uefi_data async ¶

get_instance_uefi_data `async` ¶