aws_sdk_forecast/client/
create_explainability_export.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 [`CreateExplainabilityExport`](crate::operation::create_explainability_export::builders::CreateExplainabilityExportFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`explainability_export_name(impl Into<String>)`](crate::operation::create_explainability_export::builders::CreateExplainabilityExportFluentBuilder::explainability_export_name) / [`set_explainability_export_name(Option<String>)`](crate::operation::create_explainability_export::builders::CreateExplainabilityExportFluentBuilder::set_explainability_export_name):<br>required: **true**<br><p>A unique name for the Explainability export.</p><br>
7    ///   - [`explainability_arn(impl Into<String>)`](crate::operation::create_explainability_export::builders::CreateExplainabilityExportFluentBuilder::explainability_arn) / [`set_explainability_arn(Option<String>)`](crate::operation::create_explainability_export::builders::CreateExplainabilityExportFluentBuilder::set_explainability_arn):<br>required: **true**<br><p>The Amazon Resource Name (ARN) of the Explainability to export.</p><br>
8    ///   - [`destination(DataDestination)`](crate::operation::create_explainability_export::builders::CreateExplainabilityExportFluentBuilder::destination) / [`set_destination(Option<DataDestination>)`](crate::operation::create_explainability_export::builders::CreateExplainabilityExportFluentBuilder::set_destination):<br>required: **true**<br><p>The destination for an export job. Provide an S3 path, an Identity and Access Management (IAM) role that allows Amazon Forecast to access the location, and an Key Management Service (KMS) key (optional).</p><br>
9    ///   - [`tags(Tag)`](crate::operation::create_explainability_export::builders::CreateExplainabilityExportFluentBuilder::tags) / [`set_tags(Option<Vec::<Tag>>)`](crate::operation::create_explainability_export::builders::CreateExplainabilityExportFluentBuilder::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>
10    ///   - [`format(impl Into<String>)`](crate::operation::create_explainability_export::builders::CreateExplainabilityExportFluentBuilder::format) / [`set_format(Option<String>)`](crate::operation::create_explainability_export::builders::CreateExplainabilityExportFluentBuilder::set_format):<br>required: **false**<br><p>The format of the exported data, CSV or PARQUET.</p><br>
11    /// - On success, responds with [`CreateExplainabilityExportOutput`](crate::operation::create_explainability_export::CreateExplainabilityExportOutput) with field(s):
12    ///   - [`explainability_export_arn(Option<String>)`](crate::operation::create_explainability_export::CreateExplainabilityExportOutput::explainability_export_arn): <p>The Amazon Resource Name (ARN) of the export.</p>
13    /// - On failure, responds with [`SdkError<CreateExplainabilityExportError>`](crate::operation::create_explainability_export::CreateExplainabilityExportError)
14    pub fn create_explainability_export(&self) -> crate::operation::create_explainability_export::builders::CreateExplainabilityExportFluentBuilder {
15        crate::operation::create_explainability_export::builders::CreateExplainabilityExportFluentBuilder::new(self.handle.clone())
16    }
17}