aws_sdk_cognitoidentityprovider/client/
update_terms.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 [`UpdateTerms`](crate::operation::update_terms::builders::UpdateTermsFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`terms_id(impl Into<String>)`](crate::operation::update_terms::builders::UpdateTermsFluentBuilder::terms_id) / [`set_terms_id(Option<String>)`](crate::operation::update_terms::builders::UpdateTermsFluentBuilder::set_terms_id):<br>required: **true**<br><p>The ID of the terms document that you want to update.</p><br>
7    ///   - [`user_pool_id(impl Into<String>)`](crate::operation::update_terms::builders::UpdateTermsFluentBuilder::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::operation::update_terms::builders::UpdateTermsFluentBuilder::set_user_pool_id):<br>required: **true**<br><p>The ID of the user pool that contains the terms that you want to update.</p><br>
8    ///   - [`terms_name(impl Into<String>)`](crate::operation::update_terms::builders::UpdateTermsFluentBuilder::terms_name) / [`set_terms_name(Option<String>)`](crate::operation::update_terms::builders::UpdateTermsFluentBuilder::set_terms_name):<br>required: **false**<br><p>The new name that you want to apply to the requested terms documents.</p><br>
9    ///   - [`terms_source(TermsSourceType)`](crate::operation::update_terms::builders::UpdateTermsFluentBuilder::terms_source) / [`set_terms_source(Option<TermsSourceType>)`](crate::operation::update_terms::builders::UpdateTermsFluentBuilder::set_terms_source):<br>required: **false**<br><p>This parameter is reserved for future use and currently accepts only one value.</p><br>
10    ///   - [`enforcement(TermsEnforcementType)`](crate::operation::update_terms::builders::UpdateTermsFluentBuilder::enforcement) / [`set_enforcement(Option<TermsEnforcementType>)`](crate::operation::update_terms::builders::UpdateTermsFluentBuilder::set_enforcement):<br>required: **false**<br><p>This parameter is reserved for future use and currently accepts only one value.</p><br>
11    ///   - [`links(impl Into<String>, impl Into<String>)`](crate::operation::update_terms::builders::UpdateTermsFluentBuilder::links) / [`set_links(Option<HashMap::<String, String>>)`](crate::operation::update_terms::builders::UpdateTermsFluentBuilder::set_links):<br>required: **false**<br><p>A map of URLs to languages. For each localized language that will view the requested <code>TermsName</code>, assign a URL. A selection of <code>cognito:default</code> displays for all languages that don't have a language-specific URL.</p> <p>For example, <code>"cognito:default": "https://terms.example.com", "cognito:spanish": "https://terms.example.com/es"</code>.</p><br>
12    /// - On success, responds with [`UpdateTermsOutput`](crate::operation::update_terms::UpdateTermsOutput) with field(s):
13    ///   - [`terms(Option<TermsType>)`](crate::operation::update_terms::UpdateTermsOutput::terms): <p>A summary of the updates to your terms documents.</p>
14    /// - On failure, responds with [`SdkError<UpdateTermsError>`](crate::operation::update_terms::UpdateTermsError)
15    pub fn update_terms(&self) -> crate::operation::update_terms::builders::UpdateTermsFluentBuilder {
16        crate::operation::update_terms::builders::UpdateTermsFluentBuilder::new(self.handle.clone())
17    }
18}
aws_sdk_cognitoidentityprovider/client/update_terms.rs

aws_sdk_cognitoidentityprovider/client/
update_terms.rs
