aws_sdk_iam/client/update_saml_provider.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 [`UpdateSAMLProvider`](crate::operation::update_saml_provider::builders::UpdateSAMLProviderFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`saml_metadata_document(impl Into<String>)`](crate::operation::update_saml_provider::builders::UpdateSAMLProviderFluentBuilder::saml_metadata_document) / [`set_saml_metadata_document(Option<String>)`](crate::operation::update_saml_provider::builders::UpdateSAMLProviderFluentBuilder::set_saml_metadata_document):<br>required: **false**<br><p>An XML document generated by an identity provider (IdP) that supports SAML 2.0. The document includes the issuer's name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that are received from the IdP. You must generate the metadata document using the identity management software that is used as your IdP.</p><br>
7 /// - [`saml_provider_arn(impl Into<String>)`](crate::operation::update_saml_provider::builders::UpdateSAMLProviderFluentBuilder::saml_provider_arn) / [`set_saml_provider_arn(Option<String>)`](crate::operation::update_saml_provider::builders::UpdateSAMLProviderFluentBuilder::set_saml_provider_arn):<br>required: **true**<br><p>The Amazon Resource Name (ARN) of the SAML provider to update.</p> <p>For more information about ARNs, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> in the <i>Amazon Web Services General Reference</i>.</p><br>
8 /// - [`assertion_encryption_mode(AssertionEncryptionModeType)`](crate::operation::update_saml_provider::builders::UpdateSAMLProviderFluentBuilder::assertion_encryption_mode) / [`set_assertion_encryption_mode(Option<AssertionEncryptionModeType>)`](crate::operation::update_saml_provider::builders::UpdateSAMLProviderFluentBuilder::set_assertion_encryption_mode):<br>required: **false**<br><p>Specifies the encryption setting for the SAML provider.</p><br>
9 /// - [`add_private_key(impl Into<String>)`](crate::operation::update_saml_provider::builders::UpdateSAMLProviderFluentBuilder::add_private_key) / [`set_add_private_key(Option<String>)`](crate::operation::update_saml_provider::builders::UpdateSAMLProviderFluentBuilder::set_add_private_key):<br>required: **false**<br><p>Specifies the new private key from your external identity provider. The private key must be a .pem file that uses AES-GCM or AES-CBC encryption algorithm to decrypt SAML assertions.</p><br>
10 /// - [`remove_private_key(impl Into<String>)`](crate::operation::update_saml_provider::builders::UpdateSAMLProviderFluentBuilder::remove_private_key) / [`set_remove_private_key(Option<String>)`](crate::operation::update_saml_provider::builders::UpdateSAMLProviderFluentBuilder::set_remove_private_key):<br>required: **false**<br><p>The Key ID of the private key to remove.</p><br>
11 /// - On success, responds with [`UpdateSamlProviderOutput`](crate::operation::update_saml_provider::UpdateSamlProviderOutput) with field(s):
12 /// - [`saml_provider_arn(Option<String>)`](crate::operation::update_saml_provider::UpdateSamlProviderOutput::saml_provider_arn): <p>The Amazon Resource Name (ARN) of the SAML provider that was updated.</p>
13 /// - On failure, responds with [`SdkError<UpdateSAMLProviderError>`](crate::operation::update_saml_provider::UpdateSAMLProviderError)
14 pub fn update_saml_provider(&self) -> crate::operation::update_saml_provider::builders::UpdateSAMLProviderFluentBuilder {
15 crate::operation::update_saml_provider::builders::UpdateSAMLProviderFluentBuilder::new(self.handle.clone())
16 }
17}