aws_sdk_quicksight/client/

create_analysis.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`CreateAnalysis`](crate::operation::create_analysis::builders::CreateAnalysisFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`aws_account_id(impl Into<String>)`](crate::operation::create_analysis::builders::CreateAnalysisFluentBuilder::aws_account_id) / [`set_aws_account_id(Option<String>)`](crate::operation::create_analysis::builders::CreateAnalysisFluentBuilder::set_aws_account_id):<br>required: **true**<br><p>The ID of the Amazon Web Services account where you are creating an analysis.</p><br>
    ///   - [`analysis_id(impl Into<String>)`](crate::operation::create_analysis::builders::CreateAnalysisFluentBuilder::analysis_id) / [`set_analysis_id(Option<String>)`](crate::operation::create_analysis::builders::CreateAnalysisFluentBuilder::set_analysis_id):<br>required: **true**<br><p>The ID for the analysis that you're creating. This ID displays in the URL of the analysis.</p><br>
    ///   - [`name(impl Into<String>)`](crate::operation::create_analysis::builders::CreateAnalysisFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::create_analysis::builders::CreateAnalysisFluentBuilder::set_name):<br>required: **true**<br><p>A descriptive name for the analysis that you're creating. This name displays for the analysis in the QuickSight console.</p><br>
    ///   - [`parameters(Parameters)`](crate::operation::create_analysis::builders::CreateAnalysisFluentBuilder::parameters) / [`set_parameters(Option<Parameters>)`](crate::operation::create_analysis::builders::CreateAnalysisFluentBuilder::set_parameters):<br>required: **false**<br><p>The parameter names and override values that you want to use. An analysis can have any parameter type, and some parameters might accept multiple values.</p><br>
    ///   - [`permissions(ResourcePermission)`](crate::operation::create_analysis::builders::CreateAnalysisFluentBuilder::permissions) / [`set_permissions(Option<Vec::<ResourcePermission>>)`](crate::operation::create_analysis::builders::CreateAnalysisFluentBuilder::set_permissions):<br>required: **false**<br><p>A structure that describes the principals and the resource-level permissions on an analysis. You can use the <code>Permissions</code> structure to grant permissions by providing a list of Identity and Access Management (IAM) action information for each principal listed by Amazon Resource Name (ARN).</p> <p>To specify no permissions, omit <code>Permissions</code>.</p><br>
    ///   - [`source_entity(AnalysisSourceEntity)`](crate::operation::create_analysis::builders::CreateAnalysisFluentBuilder::source_entity) / [`set_source_entity(Option<AnalysisSourceEntity>)`](crate::operation::create_analysis::builders::CreateAnalysisFluentBuilder::set_source_entity):<br>required: **false**<br><p>A source entity to use for the analysis that you're creating. This metadata structure contains details that describe a source template and one or more datasets.</p> <p>Either a <code>SourceEntity</code> or a <code>Definition</code> must be provided in order for the request to be valid.</p><br>
    ///   - [`theme_arn(impl Into<String>)`](crate::operation::create_analysis::builders::CreateAnalysisFluentBuilder::theme_arn) / [`set_theme_arn(Option<String>)`](crate::operation::create_analysis::builders::CreateAnalysisFluentBuilder::set_theme_arn):<br>required: **false**<br><p>The ARN for the theme to apply to the analysis that you're creating. To see the theme in the QuickSight console, make sure that you have access to it.</p><br>
    ///   - [`tags(Tag)`](crate::operation::create_analysis::builders::CreateAnalysisFluentBuilder::tags) / [`set_tags(Option<Vec::<Tag>>)`](crate::operation::create_analysis::builders::CreateAnalysisFluentBuilder::set_tags):<br>required: **false**<br><p>Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.</p><br>
    ///   - [`definition(AnalysisDefinition)`](crate::operation::create_analysis::builders::CreateAnalysisFluentBuilder::definition) / [`set_definition(Option<AnalysisDefinition>)`](crate::operation::create_analysis::builders::CreateAnalysisFluentBuilder::set_definition):<br>required: **false**<br><p>The definition of an analysis.</p> <p>A definition is the data model of all features in a Dashboard, Template, or Analysis.</p> <p>Either a <code>SourceEntity</code> or a <code>Definition</code> must be provided in order for the request to be valid.</p><br>
    ///   - [`validation_strategy(ValidationStrategy)`](crate::operation::create_analysis::builders::CreateAnalysisFluentBuilder::validation_strategy) / [`set_validation_strategy(Option<ValidationStrategy>)`](crate::operation::create_analysis::builders::CreateAnalysisFluentBuilder::set_validation_strategy):<br>required: **false**<br><p>The option to relax the validation needed to create an analysis with definition objects. This skips the validation step for specific errors.</p><br>
    ///   - [`folder_arns(impl Into<String>)`](crate::operation::create_analysis::builders::CreateAnalysisFluentBuilder::folder_arns) / [`set_folder_arns(Option<Vec::<String>>)`](crate::operation::create_analysis::builders::CreateAnalysisFluentBuilder::set_folder_arns):<br>required: **false**<br><p>When you create the analysis, QuickSight adds the analysis to these folders.</p><br>
    /// - On success, responds with [`CreateAnalysisOutput`](crate::operation::create_analysis::CreateAnalysisOutput) with field(s):
    ///   - [`arn(Option<String>)`](crate::operation::create_analysis::CreateAnalysisOutput::arn): <p>The ARN for the analysis.</p>
    ///   - [`analysis_id(Option<String>)`](crate::operation::create_analysis::CreateAnalysisOutput::analysis_id): <p>The ID of the analysis.</p>
    ///   - [`creation_status(Option<ResourceStatus>)`](crate::operation::create_analysis::CreateAnalysisOutput::creation_status): <p>The status of the creation of the analysis.</p>
    ///   - [`status(i32)`](crate::operation::create_analysis::CreateAnalysisOutput::status): <p>The HTTP status of the request.</p>
    ///   - [`request_id(Option<String>)`](crate::operation::create_analysis::CreateAnalysisOutput::request_id): <p>The Amazon Web Services request ID for this operation.</p>
    /// - On failure, responds with [`SdkError<CreateAnalysisError>`](crate::operation::create_analysis::CreateAnalysisError)
    pub fn create_analysis(&self) -> crate::operation::create_analysis::builders::CreateAnalysisFluentBuilder {
        crate::operation::create_analysis::builders::CreateAnalysisFluentBuilder::new(self.handle.clone())
    }
}