aws_sdk_forecast/client/

create_explainability.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`CreateExplainability`](crate::operation::create_explainability::builders::CreateExplainabilityFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`explainability_name(impl Into<String>)`](crate::operation::create_explainability::builders::CreateExplainabilityFluentBuilder::explainability_name) / [`set_explainability_name(Option<String>)`](crate::operation::create_explainability::builders::CreateExplainabilityFluentBuilder::set_explainability_name):<br>required: **true**<br><p>A unique name for the Explainability.</p><br>
    ///   - [`resource_arn(impl Into<String>)`](crate::operation::create_explainability::builders::CreateExplainabilityFluentBuilder::resource_arn) / [`set_resource_arn(Option<String>)`](crate::operation::create_explainability::builders::CreateExplainabilityFluentBuilder::set_resource_arn):<br>required: **true**<br><p>The Amazon Resource Name (ARN) of the Predictor or Forecast used to create the Explainability.</p><br>
    ///   - [`explainability_config(ExplainabilityConfig)`](crate::operation::create_explainability::builders::CreateExplainabilityFluentBuilder::explainability_config) / [`set_explainability_config(Option<ExplainabilityConfig>)`](crate::operation::create_explainability::builders::CreateExplainabilityFluentBuilder::set_explainability_config):<br>required: **true**<br><p>The configuration settings that define the granularity of time series and time points for the Explainability.</p><br>
    ///   - [`data_source(DataSource)`](crate::operation::create_explainability::builders::CreateExplainabilityFluentBuilder::data_source) / [`set_data_source(Option<DataSource>)`](crate::operation::create_explainability::builders::CreateExplainabilityFluentBuilder::set_data_source):<br>required: **false**<br><p>The source of your data, an Identity and Access Management (IAM) role that allows Amazon Forecast to access the data and, optionally, an Key Management Service (KMS) key.</p><br>
    ///   - [`schema(Schema)`](crate::operation::create_explainability::builders::CreateExplainabilityFluentBuilder::schema) / [`set_schema(Option<Schema>)`](crate::operation::create_explainability::builders::CreateExplainabilityFluentBuilder::set_schema):<br>required: **false**<br><p>Defines the fields of a dataset.</p><br>
    ///   - [`enable_visualization(bool)`](crate::operation::create_explainability::builders::CreateExplainabilityFluentBuilder::enable_visualization) / [`set_enable_visualization(Option<bool>)`](crate::operation::create_explainability::builders::CreateExplainabilityFluentBuilder::set_enable_visualization):<br>required: **false**<br><p>Create an Explainability visualization that is viewable within the Amazon Web Services console.</p><br>
    ///   - [`start_date_time(impl Into<String>)`](crate::operation::create_explainability::builders::CreateExplainabilityFluentBuilder::start_date_time) / [`set_start_date_time(Option<String>)`](crate::operation::create_explainability::builders::CreateExplainabilityFluentBuilder::set_start_date_time):<br>required: **false**<br><p>If <code>TimePointGranularity</code> is set to <code>SPECIFIC</code>, define the first point for the Explainability.</p> <p>Use the following timestamp format: yyyy-MM-ddTHH:mm:ss (example: 2015-01-01T20:00:00)</p><br>
    ///   - [`end_date_time(impl Into<String>)`](crate::operation::create_explainability::builders::CreateExplainabilityFluentBuilder::end_date_time) / [`set_end_date_time(Option<String>)`](crate::operation::create_explainability::builders::CreateExplainabilityFluentBuilder::set_end_date_time):<br>required: **false**<br><p>If <code>TimePointGranularity</code> is set to <code>SPECIFIC</code>, define the last time point for the Explainability.</p> <p>Use the following timestamp format: yyyy-MM-ddTHH:mm:ss (example: 2015-01-01T20:00:00)</p><br>
    ///   - [`tags(Tag)`](crate::operation::create_explainability::builders::CreateExplainabilityFluentBuilder::tags) / [`set_tags(Option<Vec::<Tag>>)`](crate::operation::create_explainability::builders::CreateExplainabilityFluentBuilder::set_tags):<br>required: **false**<br><p>Optional metadata to help you categorize and organize your resources. Each tag consists of a key and an optional value, both of which you define. Tag keys and values are case sensitive.</p> <p>The following restrictions apply to tags:</p> <ul>  <li>   <p>For each resource, each tag key must be unique and each tag key must have one value.</p></li>  <li>   <p>Maximum number of tags per resource: 50.</p></li>  <li>   <p>Maximum key length: 128 Unicode characters in UTF-8.</p></li>  <li>   <p>Maximum value length: 256 Unicode characters in UTF-8.</p></li>  <li>   <p>Accepted characters: all letters and numbers, spaces representable in UTF-8, and + - = . _ : / @. If your tagging schema is used across other services and resources, the character restrictions of those services also apply.</p></li>  <li>   <p>Key prefixes cannot include any upper or lowercase combination of <code>aws:</code> or <code>AWS:</code>. Values can have this prefix. If a tag value has <code>aws</code> as its prefix but the key does not, Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of <code>aws</code> do not count against your tags per resource limit. You cannot edit or delete tag keys with this prefix.</p></li> </ul><br>
    /// - On success, responds with [`CreateExplainabilityOutput`](crate::operation::create_explainability::CreateExplainabilityOutput) with field(s):
    ///   - [`explainability_arn(Option<String>)`](crate::operation::create_explainability::CreateExplainabilityOutput::explainability_arn): <p>The Amazon Resource Name (ARN) of the Explainability.</p>
    /// - On failure, responds with [`SdkError<CreateExplainabilityError>`](crate::operation::create_explainability::CreateExplainabilityError)
    pub fn create_explainability(&self) -> crate::operation::create_explainability::builders::CreateExplainabilityFluentBuilder {
        crate::operation::create_explainability::builders::CreateExplainabilityFluentBuilder::new(self.handle.clone())
    }
}