pub struct Builder { /* private fields */ }
Expand description

A builder for CreateAnalysisInput.

Implementations§

The ID of the Amazon Web Services account where you are creating an analysis.

Examples found in repository?
src/client.rs (line 2620)
2619
2620
2621
2622
        pub fn aws_account_id(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.aws_account_id(input.into());
            self
        }

The ID of the Amazon Web Services account where you are creating an analysis.

Examples found in repository?
src/client.rs (line 2628)
2624
2625
2626
2627
2628
2629
2630
        pub fn set_aws_account_id(
            mut self,
            input: std::option::Option<std::string::String>,
        ) -> Self {
            self.inner = self.inner.set_aws_account_id(input);
            self
        }

The ID for the analysis that you're creating. This ID displays in the URL of the analysis.

Examples found in repository?
src/client.rs (line 2633)
2632
2633
2634
2635
        pub fn analysis_id(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.analysis_id(input.into());
            self
        }

The ID for the analysis that you're creating. This ID displays in the URL of the analysis.

Examples found in repository?
src/client.rs (line 2638)
2637
2638
2639
2640
        pub fn set_analysis_id(mut self, input: std::option::Option<std::string::String>) -> Self {
            self.inner = self.inner.set_analysis_id(input);
            self
        }

A descriptive name for the analysis that you're creating. This name displays for the analysis in the Amazon QuickSight console.

Examples found in repository?
src/client.rs (line 2643)
2642
2643
2644
2645
        pub fn name(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.name(input.into());
            self
        }

A descriptive name for the analysis that you're creating. This name displays for the analysis in the Amazon QuickSight console.

Examples found in repository?
src/client.rs (line 2648)
2647
2648
2649
2650
        pub fn set_name(mut self, input: std::option::Option<std::string::String>) -> Self {
            self.inner = self.inner.set_name(input);
            self
        }

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.

Examples found in repository?
src/client.rs (line 2653)
2652
2653
2654
2655
        pub fn parameters(mut self, input: crate::model::Parameters) -> Self {
            self.inner = self.inner.parameters(input);
            self
        }

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.

Examples found in repository?
src/client.rs (line 2661)
2657
2658
2659
2660
2661
2662
2663
        pub fn set_parameters(
            mut self,
            input: std::option::Option<crate::model::Parameters>,
        ) -> Self {
            self.inner = self.inner.set_parameters(input);
            self
        }

Appends an item to permissions.

To override the contents of this collection use set_permissions.

A structure that describes the principals and the resource-level permissions on an analysis. You can use the Permissions 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).

To specify no permissions, omit Permissions.

Examples found in repository?
src/client.rs (line 2671)
2670
2671
2672
2673
        pub fn permissions(mut self, input: crate::model::ResourcePermission) -> Self {
            self.inner = self.inner.permissions(input);
            self
        }

A structure that describes the principals and the resource-level permissions on an analysis. You can use the Permissions 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).

To specify no permissions, omit Permissions.

Examples found in repository?
src/client.rs (line 2680)
2676
2677
2678
2679
2680
2681
2682
        pub fn set_permissions(
            mut self,
            input: std::option::Option<std::vec::Vec<crate::model::ResourcePermission>>,
        ) -> Self {
            self.inner = self.inner.set_permissions(input);
            self
        }

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.

Examples found in repository?
src/client.rs (line 2685)
2684
2685
2686
2687
        pub fn source_entity(mut self, input: crate::model::AnalysisSourceEntity) -> Self {
            self.inner = self.inner.source_entity(input);
            self
        }

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.

Examples found in repository?
src/client.rs (line 2693)
2689
2690
2691
2692
2693
2694
2695
        pub fn set_source_entity(
            mut self,
            input: std::option::Option<crate::model::AnalysisSourceEntity>,
        ) -> Self {
            self.inner = self.inner.set_source_entity(input);
            self
        }

The ARN for the theme to apply to the analysis that you're creating. To see the theme in the Amazon QuickSight console, make sure that you have access to it.

Examples found in repository?
src/client.rs (line 2698)
2697
2698
2699
2700
        pub fn theme_arn(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.theme_arn(input.into());
            self
        }

The ARN for the theme to apply to the analysis that you're creating. To see the theme in the Amazon QuickSight console, make sure that you have access to it.

Examples found in repository?
src/client.rs (line 2703)
2702
2703
2704
2705
        pub fn set_theme_arn(mut self, input: std::option::Option<std::string::String>) -> Self {
            self.inner = self.inner.set_theme_arn(input);
            self
        }

Appends an item to tags.

To override the contents of this collection use set_tags.

Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.

Examples found in repository?
src/client.rs (line 2712)
2711
2712
2713
2714
        pub fn tags(mut self, input: crate::model::Tag) -> Self {
            self.inner = self.inner.tags(input);
            self
        }

Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.

Examples found in repository?
src/client.rs (line 2720)
2716
2717
2718
2719
2720
2721
2722
        pub fn set_tags(
            mut self,
            input: std::option::Option<std::vec::Vec<crate::model::Tag>>,
        ) -> Self {
            self.inner = self.inner.set_tags(input);
            self
        }

Consumes the builder and constructs a CreateAnalysisInput.

Examples found in repository?
src/client.rs (line 2587)
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
        pub async fn customize(
            self,
        ) -> std::result::Result<
            crate::operation::customize::CustomizableOperation<
                crate::operation::CreateAnalysis,
                aws_http::retry::AwsResponseRetryClassifier,
            >,
            aws_smithy_http::result::SdkError<crate::error::CreateAnalysisError>,
        > {
            let handle = self.handle.clone();
            let operation = self
                .inner
                .build()
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?
                .make_operation(&handle.conf)
                .await
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?;
            Ok(crate::operation::customize::CustomizableOperation { handle, operation })
        }

        /// Sends the request and returns the response.
        ///
        /// If an error occurs, an `SdkError` will be returned with additional details that
        /// can be matched against.
        ///
        /// By default, any retryable failures will be retried twice. Retry behavior
        /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
        /// set when configuring the client.
        pub async fn send(
            self,
        ) -> std::result::Result<
            crate::output::CreateAnalysisOutput,
            aws_smithy_http::result::SdkError<crate::error::CreateAnalysisError>,
        > {
            let op = self
                .inner
                .build()
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?
                .make_operation(&self.handle.conf)
                .await
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?;
            self.handle.client.call(op).await
        }

Trait Implementations§

Returns a copy of the value. Read more
Performs copy-assignment from source. Read more
Formats the value using the given formatter. Read more
Returns the “default value” for a type. Read more
This method tests for self and other values to be equal, and is used by ==. Read more
This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason. Read more

Auto Trait Implementations§

Blanket Implementations§

Gets the TypeId of self. Read more
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Should always be Self
The resulting type after obtaining ownership.
Creates owned data from borrowed data, usually by cloning. Read more
Uses borrowed data to replace owned data, usually by cloning. Read more
The type returned in the event of a conversion error.
Performs the conversion.
The type returned in the event of a conversion error.
Performs the conversion.
Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more