aws_sdk_workmail/client/
test_availability_configuration.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`TestAvailabilityConfiguration`](crate::operation::test_availability_configuration::builders::TestAvailabilityConfigurationFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`organization_id(impl Into<String>)`](crate::operation::test_availability_configuration::builders::TestAvailabilityConfigurationFluentBuilder::organization_id) / [`set_organization_id(Option<String>)`](crate::operation::test_availability_configuration::builders::TestAvailabilityConfigurationFluentBuilder::set_organization_id):<br>required: **true**<br><p>The WorkMail organization where the availability provider will be tested.</p><br>
    ///   - [`domain_name(impl Into<String>)`](crate::operation::test_availability_configuration::builders::TestAvailabilityConfigurationFluentBuilder::domain_name) / [`set_domain_name(Option<String>)`](crate::operation::test_availability_configuration::builders::TestAvailabilityConfigurationFluentBuilder::set_domain_name):<br>required: **false**<br><p>The domain to which the provider applies. If this field is provided, a stored availability provider associated to this domain name will be tested.</p><br>
    ///   - [`ews_provider(EwsAvailabilityProvider)`](crate::operation::test_availability_configuration::builders::TestAvailabilityConfigurationFluentBuilder::ews_provider) / [`set_ews_provider(Option<EwsAvailabilityProvider>)`](crate::operation::test_availability_configuration::builders::TestAvailabilityConfigurationFluentBuilder::set_ews_provider):<br>required: **false**<br><p>Describes an EWS based availability provider. This is only used as input to the service.</p><br>
    ///   - [`lambda_provider(LambdaAvailabilityProvider)`](crate::operation::test_availability_configuration::builders::TestAvailabilityConfigurationFluentBuilder::lambda_provider) / [`set_lambda_provider(Option<LambdaAvailabilityProvider>)`](crate::operation::test_availability_configuration::builders::TestAvailabilityConfigurationFluentBuilder::set_lambda_provider):<br>required: **false**<br><p>Describes a Lambda based availability provider.</p><br>
    /// - On success, responds with [`TestAvailabilityConfigurationOutput`](crate::operation::test_availability_configuration::TestAvailabilityConfigurationOutput) with field(s):
    ///   - [`test_passed(bool)`](crate::operation::test_availability_configuration::TestAvailabilityConfigurationOutput::test_passed): <p>Boolean indicating whether the test passed or failed.</p>
    ///   - [`failure_reason(Option<String>)`](crate::operation::test_availability_configuration::TestAvailabilityConfigurationOutput::failure_reason): <p>String containing the reason for a failed test if <code>TestPassed</code> is false.</p>
    /// - On failure, responds with [`SdkError<TestAvailabilityConfigurationError>`](crate::operation::test_availability_configuration::TestAvailabilityConfigurationError)
    pub fn test_availability_configuration(
        &self,
    ) -> crate::operation::test_availability_configuration::builders::TestAvailabilityConfigurationFluentBuilder {
        crate::operation::test_availability_configuration::builders::TestAvailabilityConfigurationFluentBuilder::new(self.handle.clone())
    }
}