aws_sdk_cognitoidentityprovider/client/
set_ui_customization.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 [`SetUICustomization`](crate::operation::set_ui_customization::builders::SetUICustomizationFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`user_pool_id(impl Into<String>)`](crate::operation::set_ui_customization::builders::SetUICustomizationFluentBuilder::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::operation::set_ui_customization::builders::SetUICustomizationFluentBuilder::set_user_pool_id):<br>required: **true**<br><p>The ID of the user pool where you want to apply branding to the classic hosted UI.</p><br>
7    ///   - [`client_id(impl Into<String>)`](crate::operation::set_ui_customization::builders::SetUICustomizationFluentBuilder::client_id) / [`set_client_id(Option<String>)`](crate::operation::set_ui_customization::builders::SetUICustomizationFluentBuilder::set_client_id):<br>required: **false**<br><p>The ID of the app client that you want to customize. To apply a default style to all app clients not configured with client-level branding, set this parameter value to <code>ALL</code>.</p><br>
8    ///   - [`css(impl Into<String>)`](crate::operation::set_ui_customization::builders::SetUICustomizationFluentBuilder::css) / [`set_css(Option<String>)`](crate::operation::set_ui_customization::builders::SetUICustomizationFluentBuilder::set_css):<br>required: **false**<br><p>A plaintext CSS file that contains the custom fields that you want to apply to your user pool or app client. To download a template, go to the Amazon Cognito console. Navigate to your user pool <i>App clients</i> tab, select <i>Login pages</i>, edit <i>Hosted UI (classic) style</i>, and select the link to <code>CSS template.css</code>.</p><br>
9    ///   - [`image_file(Blob)`](crate::operation::set_ui_customization::builders::SetUICustomizationFluentBuilder::image_file) / [`set_image_file(Option<Blob>)`](crate::operation::set_ui_customization::builders::SetUICustomizationFluentBuilder::set_image_file):<br>required: **false**<br><p>The image that you want to set as your login in the classic hosted UI, as a Base64-formatted binary object.</p><br>
10    /// - On success, responds with [`SetUiCustomizationOutput`](crate::operation::set_ui_customization::SetUiCustomizationOutput) with field(s):
11    ///   - [`ui_customization(Option<UiCustomizationType>)`](crate::operation::set_ui_customization::SetUiCustomizationOutput::ui_customization): <p>Information about the hosted UI branding that you applied.</p>
12    /// - On failure, responds with [`SdkError<SetUICustomizationError>`](crate::operation::set_ui_customization::SetUICustomizationError)
13    pub fn set_ui_customization(&self) -> crate::operation::set_ui_customization::builders::SetUICustomizationFluentBuilder {
14        crate::operation::set_ui_customization::builders::SetUICustomizationFluentBuilder::new(self.handle.clone())
15    }
16}