Skip to content

EC2  >  Operations  >  get_ebs_default_kms_key_id

get_ebs_default_kms_key_id

Operation

get_ebs_default_kms_key_id async

get_ebs_default_kms_key_id(request: GetEbsDefaultKmsKeyIdInput | GetEbsDefaultKmsKeyIdInputDict, /, *, plugins: list[Plugin] | None = None) -> GetEbsDefaultKmsKeyIdOutput
get_ebs_default_kms_key_id(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetEbsDefaultKmsKeyIdInputDict]) -> GetEbsDefaultKmsKeyIdOutput

Describes the default KMS key for EBS encryption by default for your account in this Region.

For more information, see Amazon EBS encryption in the Amazon EBS User Guide.

Parameters:

Name Type Description Default
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
GetEbsDefaultKmsKeyIdOutput

An instance of GetEbsDefaultKmsKeyIdOutput.

Input

Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.

Model

GetEbsDefaultKmsKeyIdInput dataclass

Bases: _SerdeShape

Dataclass for GetEbsDefaultKmsKeyIdInput structure.

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

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.

Dictionaries

GetEbsDefaultKmsKeyIdInputDict

Bases: TypedDict

Dictionary form of GetEbsDefaultKmsKeyIdInput.

Attributes
dry_run instance-attribute
dry_run: bool | None

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.

Output

GetEbsDefaultKmsKeyIdOutput dataclass

Bases: _SerdeShape

Dataclass for GetEbsDefaultKmsKeyIdOutput structure.

Attributes

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

The Amazon Resource Name (ARN) of the default KMS key for encryption by default.

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.