Struct aws_sdk_quicksight::input::create_dashboard_input::Builder

pub struct Builder { /* private fields */ }

A builder for CreateDashboardInput.

Implementations

impl Builder

pub fn aws_account_id(self, input: impl Into<String>) -> Self

The ID of the Amazon Web Services account where you want to create the dashboard.

Examples found in repository

src/client.rs (line 2789)

        pub fn aws_account_id(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.aws_account_id(input.into());
            self
        }

pub fn set_aws_account_id(self, input: Option<String>) -> Self

The ID of the Amazon Web Services account where you want to create the dashboard.

Examples found in repository

src/client.rs (line 2797)

        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
        }

pub fn dashboard_id(self, input: impl Into<String>) -> Self

The ID for the dashboard, also added to the IAM policy.

Examples found in repository

src/client.rs (line 2802)

        pub fn dashboard_id(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.dashboard_id(input.into());
            self
        }

pub fn set_dashboard_id(self, input: Option<String>) -> Self

The ID for the dashboard, also added to the IAM policy.

Examples found in repository

src/client.rs (line 2807)

        pub fn set_dashboard_id(mut self, input: std::option::Option<std::string::String>) -> Self {
            self.inner = self.inner.set_dashboard_id(input);
            self
        }

pub fn name(self, input: impl Into<String>) -> Self

The display name of the dashboard.

Examples found in repository

src/client.rs (line 2812)

        pub fn name(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.name(input.into());
            self
        }

pub fn set_name(self, input: Option<String>) -> Self

The display name of the dashboard.

Examples found in repository

src/client.rs (line 2817)

        pub fn set_name(mut self, input: std::option::Option<std::string::String>) -> Self {
            self.inner = self.inner.set_name(input);
            self
        }

pub fn parameters(self, input: Parameters) -> Self

The parameters for the creation of the dashboard, which you want to use to override the default settings. A dashboard can have any type of parameters, and some parameters might accept multiple values.

Examples found in repository

src/client.rs (line 2822)

        pub fn parameters(mut self, input: crate::model::Parameters) -> Self {
            self.inner = self.inner.parameters(input);
            self
        }

pub fn set_parameters(self, input: Option<Parameters>) -> Self

The parameters for the creation of the dashboard, which you want to use to override the default settings. A dashboard can have any type of parameters, and some parameters might accept multiple values.

Examples found in repository

src/client.rs (line 2830)

        pub fn set_parameters(
            mut self,
            input: std::option::Option<crate::model::Parameters>,
        ) -> Self {
            self.inner = self.inner.set_parameters(input);
            self
        }

pub fn permissions(self, input: ResourcePermission) -> Self

Appends an item to permissions.

To override the contents of this collection use set_permissions.

A structure that contains the permissions of the dashboard. You can use this structure for granting permissions by providing a list of IAM action information for each principal ARN.

To specify no permissions, omit the permissions list.

Examples found in repository

src/client.rs (line 2840)

        pub fn permissions(mut self, input: crate::model::ResourcePermission) -> Self {
            self.inner = self.inner.permissions(input);
            self
        }

pub fn set_permissions(self, input: Option<Vec<ResourcePermission>>) -> Self

A structure that contains the permissions of the dashboard. You can use this structure for granting permissions by providing a list of IAM action information for each principal ARN.

To specify no permissions, omit the permissions list.

Examples found in repository

src/client.rs (line 2849)

        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
        }

pub fn source_entity(self, input: DashboardSourceEntity) -> Self

The entity that you are using as a source when you create the dashboard. In SourceEntity, you specify the type of object you're using as source. You can only create a dashboard from a template, so you use a SourceTemplate entity. If you need to create a dashboard from an analysis, first convert the analysis to a template by using the CreateTemplate API operation. For SourceTemplate, specify the Amazon Resource Name (ARN) of the source template. The SourceTemplateARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region.

Use the DataSetReferences entity within SourceTemplate to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.

Examples found in repository

src/client.rs (line 2855)

        pub fn source_entity(mut self, input: crate::model::DashboardSourceEntity) -> Self {
            self.inner = self.inner.source_entity(input);
            self
        }

pub fn set_source_entity(self, input: Option<DashboardSourceEntity>) -> Self

The entity that you are using as a source when you create the dashboard. In SourceEntity, you specify the type of object you're using as source. You can only create a dashboard from a template, so you use a SourceTemplate entity. If you need to create a dashboard from an analysis, first convert the analysis to a template by using the CreateTemplate API operation. For SourceTemplate, specify the Amazon Resource Name (ARN) of the source template. The SourceTemplateARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region.

Use the DataSetReferences entity within SourceTemplate to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.

Examples found in repository

src/client.rs (line 2864)

        pub fn set_source_entity(
            mut self,
            input: std::option::Option<crate::model::DashboardSourceEntity>,
        ) -> Self {
            self.inner = self.inner.set_source_entity(input);
            self
        }

pub fn tags(self, input: Tag) -> 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 dashboard.

Examples found in repository

src/client.rs (line 2873)

        pub fn tags(mut self, input: crate::model::Tag) -> Self {
            self.inner = self.inner.tags(input);
            self
        }

pub fn set_tags(self, input: Option<Vec<Tag>>) -> Self

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

Examples found in repository

src/client.rs (line 2881)

        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
        }

pub fn version_description(self, input: impl Into<String>) -> Self

A description for the first version of the dashboard being created.

Examples found in repository

src/client.rs (line 2886)

        pub fn version_description(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.version_description(input.into());
            self
        }

pub fn set_version_description(self, input: Option<String>) -> Self

A description for the first version of the dashboard being created.

Examples found in repository

src/client.rs (line 2894)

        pub fn set_version_description(
            mut self,
            input: std::option::Option<std::string::String>,
        ) -> Self {
            self.inner = self.inner.set_version_description(input);
            self
        }

pub fn dashboard_publish_options(self, input: DashboardPublishOptions) -> Self

Options for publishing the dashboard when you create it:

• AvailabilityStatus for AdHocFilteringOption - This status can be either ENABLED or DISABLED. When this is set to DISABLED, Amazon QuickSight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is ENABLED by default.

• AvailabilityStatus for ExportToCSVOption - This status can be either ENABLED or DISABLED. The visual option to export data to .CSV format isn't enabled when this is set to DISABLED. This option is ENABLED by default.

• VisibilityState for SheetControlsOption - This visibility state can be either COLLAPSED or EXPANDED. This option is COLLAPSED by default.

Examples found in repository

src/client.rs (line 2907)

        pub fn dashboard_publish_options(
            mut self,
            input: crate::model::DashboardPublishOptions,
        ) -> Self {
            self.inner = self.inner.dashboard_publish_options(input);
            self
        }

pub fn set_dashboard_publish_options(
    self,
    input: Option<DashboardPublishOptions>
) -> Self

Options for publishing the dashboard when you create it:

• AvailabilityStatus for AdHocFilteringOption - This status can be either ENABLED or DISABLED. When this is set to DISABLED, Amazon QuickSight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is ENABLED by default.

• AvailabilityStatus for ExportToCSVOption - This status can be either ENABLED or DISABLED. The visual option to export data to .CSV format isn't enabled when this is set to DISABLED. This option is ENABLED by default.

• VisibilityState for SheetControlsOption - This visibility state can be either COLLAPSED or EXPANDED. This option is COLLAPSED by default.

Examples found in repository

src/client.rs (line 2920)

        pub fn set_dashboard_publish_options(
            mut self,
            input: std::option::Option<crate::model::DashboardPublishOptions>,
        ) -> Self {
            self.inner = self.inner.set_dashboard_publish_options(input);
            self
        }

pub fn theme_arn(self, input: impl Into<String>) -> Self

The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If you add a value for this field, it overrides the value that is used in the source entity. The theme ARN must exist in the same Amazon Web Services account where you create the dashboard.

Examples found in repository

src/client.rs (line 2925)

        pub fn theme_arn(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.theme_arn(input.into());
            self
        }

pub fn set_theme_arn(self, input: Option<String>) -> Self

The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If you add a value for this field, it overrides the value that is used in the source entity. The theme ARN must exist in the same Amazon Web Services account where you create the dashboard.

Examples found in repository

src/client.rs (line 2930)

        pub fn set_theme_arn(mut self, input: std::option::Option<std::string::String>) -> Self {
            self.inner = self.inner.set_theme_arn(input);
            self
        }

pub fn build(self) -> Result<CreateDashboardInput, BuildError>

Consumes the builder and constructs a CreateDashboardInput.

Examples found in repository

src/client.rs (line 2756)

        pub async fn customize(
            self,
        ) -> std::result::Result<
            crate::operation::customize::CustomizableOperation<
                crate::operation::CreateDashboard,
                aws_http::retry::AwsResponseRetryClassifier,
            >,
            aws_smithy_http::result::SdkError<crate::error::CreateDashboardError>,
        > {
            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::CreateDashboardOutput,
            aws_smithy_http::result::SdkError<crate::error::CreateDashboardError>,
        > {
            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

impl Clone for Builder

fn clone(&self) -> Builder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Builder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Builder

Returns the “default value” for a type.

impl PartialEq<Builder> for Builder

fn eq(&self, other: &Builder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Builder