get_instance_tpm_ek_pub¶
Operation¶
get_instance_tpm_ek_pub
¶
get_instance_tpm_ek_pub(request: GetInstanceTpmEkPubInput | GetInstanceTpmEkPubInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetInstanceTpmEkPubInputDict]) -> GetInstanceTpmEkPubOutput
Gets the public endorsement key associated with the Nitro Trusted Platform Module (NitroTPM) for the specified instance.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
GetInstanceTpmEkPubInput | GetInstanceTpmEkPubInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[GetInstanceTpmEkPubInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetInstanceTpmEkPubOutput
|
An instance of |
get_instance_tpm_ek_pub
async
¶
get_instance_tpm_ek_pub(request: GetInstanceTpmEkPubInput | GetInstanceTpmEkPubInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetInstanceTpmEkPubInputDict]) -> GetInstanceTpmEkPubOutput
Gets the public endorsement key associated with the Nitro Trusted Platform Module (NitroTPM) for the specified instance.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
GetInstanceTpmEkPubInput | GetInstanceTpmEkPubInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[GetInstanceTpmEkPubInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetInstanceTpmEkPubOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
GetInstanceTpmEkPubInputDict
¶
Bases: TypedDict
Dictionary form of GetInstanceTpmEkPubInput.
Attributes¶
dry_run
instance-attribute
¶
dry_run: bool | None
Specify this parameter to verify whether the request will succeed,
without actually making the request. If the request will succeed, the
response is DryRunOperation. Otherwise, the response is
UnauthorizedOperation.
instance_id
instance-attribute
¶
The ID of the instance for which to get the public endorsement key.
key_format
instance-attribute
¶
The required public endorsement key format. Specify der for a
DER-encoded public key that is compatible with OpenSSL. Specify tpmt
for a TPM 2.0 format that is compatible with tpm2-tools. The returned
key is base64 encoded.
GetInstanceTpmEkPubInput
dataclass
¶
Bases: _SerdeShape
Dataclass for GetInstanceTpmEkPubInput structure.
Attributes¶
dry_run
class-attribute
instance-attribute
¶
dry_run: bool | None = ...
Specify this parameter to verify whether the request will succeed,
without actually making the request. If the request will succeed, the
response is DryRunOperation. Otherwise, the response is
UnauthorizedOperation.
instance_id
class-attribute
instance-attribute
¶
instance_id: str | None = ...
The ID of the instance for which to get the public endorsement key.
key_format
class-attribute
instance-attribute
¶
key_format: str | None = ...
The required public endorsement key format. Specify der for a
DER-encoded public key that is compatible with OpenSSL. Specify tpmt
for a TPM 2.0 format that is compatible with tpm2-tools. The returned
key is base64 encoded.
Output¶
GetInstanceTpmEkPubOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for GetInstanceTpmEkPubOutput structure.
Attributes¶
instance_id
class-attribute
instance-attribute
¶
instance_id: str | None = ...
The ID of the instance.
key_format
class-attribute
instance-attribute
¶
key_format: str | None = ...
The public endorsement key format.
key_type
class-attribute
instance-attribute
¶
key_type: str | None = ...
The public endorsement key type.
key_value
class-attribute
instance-attribute
¶
key_value: str | None = ...
The public endorsement key material.
response_metadata
class-attribute
instance-attribute
¶
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.