aws-sdk-kms 1.106.0

AWS SDK for AWS Key Management Service
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DeleteImportedKeyMaterial`](crate::operation::delete_imported_key_material::builders::DeleteImportedKeyMaterialFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`key_id(impl Into<String>)`](crate::operation::delete_imported_key_material::builders::DeleteImportedKeyMaterialFluentBuilder::key_id) / [`set_key_id(Option<String>)`](crate::operation::delete_imported_key_material::builders::DeleteImportedKeyMaterialFluentBuilder::set_key_id):<br>required: **true**<br><p>Identifies the KMS key from which you are deleting imported key material. The <code>Origin</code> of the KMS key must be <code>EXTERNAL</code>.</p> <p>Specify the key ID or key ARN of the KMS key.</p> <p>For example:</p> <ul>  <li>   <p>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code></p></li>  <li>   <p>Key ARN: <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code></p></li> </ul> <p>To get the key ID and key ARN for a KMS key, use <code>ListKeys</code> or <code>DescribeKey</code>.</p><br>
    ///   - [`key_material_id(impl Into<String>)`](crate::operation::delete_imported_key_material::builders::DeleteImportedKeyMaterialFluentBuilder::key_material_id) / [`set_key_material_id(Option<String>)`](crate::operation::delete_imported_key_material::builders::DeleteImportedKeyMaterialFluentBuilder::set_key_material_id):<br>required: **false**<br><p>Identifies the imported key material you are deleting.</p><important>  <p>If no KeyMaterialId is specified, KMS deletes the current key material.</p> </important> <p>To get the list of key material IDs associated with a KMS key, use <code>ListKeyRotations</code>.</p><br>
    /// - On success, responds with [`DeleteImportedKeyMaterialOutput`](crate::operation::delete_imported_key_material::DeleteImportedKeyMaterialOutput) with field(s):
    ///   - [`key_id(Option<String>)`](crate::operation::delete_imported_key_material::DeleteImportedKeyMaterialOutput::key_id): <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN">key ARN</a>) of the KMS key from which the key material was deleted.</p>
    ///   - [`key_material_id(Option<String>)`](crate::operation::delete_imported_key_material::DeleteImportedKeyMaterialOutput::key_material_id): <p>Identifies the deleted key material.</p>
    /// - On failure, responds with [`SdkError<DeleteImportedKeyMaterialError>`](crate::operation::delete_imported_key_material::DeleteImportedKeyMaterialError)
    pub fn delete_imported_key_material(&self) -> crate::operation::delete_imported_key_material::builders::DeleteImportedKeyMaterialFluentBuilder {
        crate::operation::delete_imported_key_material::builders::DeleteImportedKeyMaterialFluentBuilder::new(self.handle.clone())
    }
}