aws_sdk_paymentcryptography/client/get_parameters_for_export.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3 /// Constructs a fluent builder for the [`GetParametersForExport`](crate::operation::get_parameters_for_export::builders::GetParametersForExportFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`key_material_type(KeyMaterialType)`](crate::operation::get_parameters_for_export::builders::GetParametersForExportFluentBuilder::key_material_type) / [`set_key_material_type(Option<KeyMaterialType>)`](crate::operation::get_parameters_for_export::builders::GetParametersForExportFluentBuilder::set_key_material_type):<br>required: **true**<br><p>The key block format type (for example, TR-34 or TR-31) to use during key material export. Export token is only required for a TR-34 key export, <code>TR34_KEY_BLOCK</code>. Export token is not required for TR-31 key export.</p><br>
7 /// - [`signing_key_algorithm(KeyAlgorithm)`](crate::operation::get_parameters_for_export::builders::GetParametersForExportFluentBuilder::signing_key_algorithm) / [`set_signing_key_algorithm(Option<KeyAlgorithm>)`](crate::operation::get_parameters_for_export::builders::GetParametersForExportFluentBuilder::set_signing_key_algorithm):<br>required: **true**<br><p>The signing key algorithm to generate a signing key certificate. This certificate signs the wrapped key under export within the TR-34 key block. <code>RSA_2048</code> is the only signing key algorithm allowed.</p><br>
8 /// - On success, responds with [`GetParametersForExportOutput`](crate::operation::get_parameters_for_export::GetParametersForExportOutput) with field(s):
9 /// - [`signing_key_certificate(String)`](crate::operation::get_parameters_for_export::GetParametersForExportOutput::signing_key_certificate): <p>The signing key certificate in PEM format (base64 encoded) of the public key for signature within the TR-34 key block. The certificate expires after 30 days.</p>
10 /// - [`signing_key_certificate_chain(String)`](crate::operation::get_parameters_for_export::GetParametersForExportOutput::signing_key_certificate_chain): <p>The root certificate authority (CA) that signed the signing key certificate in PEM format (base64 encoded).</p>
11 /// - [`signing_key_algorithm(KeyAlgorithm)`](crate::operation::get_parameters_for_export::GetParametersForExportOutput::signing_key_algorithm): <p>The algorithm of the signing key certificate for use in TR-34 key block generation. <code>RSA_2048</code> is the only signing key algorithm allowed.</p>
12 /// - [`export_token(String)`](crate::operation::get_parameters_for_export::GetParametersForExportOutput::export_token): <p>The export token to initiate key export from Amazon Web Services Payment Cryptography. The export token expires after 30 days. You can use the same export token to export multiple keys from the same service account.</p>
13 /// - [`parameters_valid_until_timestamp(DateTime)`](crate::operation::get_parameters_for_export::GetParametersForExportOutput::parameters_valid_until_timestamp): <p>The validity period of the export token.</p>
14 /// - On failure, responds with [`SdkError<GetParametersForExportError>`](crate::operation::get_parameters_for_export::GetParametersForExportError)
15 pub fn get_parameters_for_export(&self) -> crate::operation::get_parameters_for_export::builders::GetParametersForExportFluentBuilder {
16 crate::operation::get_parameters_for_export::builders::GetParametersForExportFluentBuilder::new(self.handle.clone())
17 }
18}