aws_sdk_quicksight/operation/create_dashboard/_create_dashboard_input.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2#[allow(missing_docs)] // documentation missing in model
3#[non_exhaustive]
4#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
5pub struct CreateDashboardInput {
6 /// <p>The ID of the Amazon Web Services account where you want to create the dashboard.</p>
7 pub aws_account_id: ::std::option::Option<::std::string::String>,
8 /// <p>The ID for the dashboard, also added to the IAM policy.</p>
9 pub dashboard_id: ::std::option::Option<::std::string::String>,
10 /// <p>The display name of the dashboard.</p>
11 pub name: ::std::option::Option<::std::string::String>,
12 /// <p>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.</p>
13 pub parameters: ::std::option::Option<crate::types::Parameters>,
14 /// <p>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.</p>
15 /// <p>To specify no permissions, omit the permissions list.</p>
16 pub permissions: ::std::option::Option<::std::vec::Vec<crate::types::ResourcePermission>>,
17 /// <p>The entity that you are using as a source when you create the dashboard. In <code>SourceEntity</code>, you specify the type of object you're using as source. You can only create a dashboard from a template, so you use a <code>SourceTemplate</code> entity. If you need to create a dashboard from an analysis, first convert the analysis to a template by using the <code> <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_CreateTemplate.html">CreateTemplate</a> </code> API operation. For <code>SourceTemplate</code>, specify the Amazon Resource Name (ARN) of the source template. The <code>SourceTemplate</code>ARN can contain any Amazon Web Services account and any Amazon Quick Sight-supported Amazon Web Services Region.</p>
18 /// <p>Use the <code>DataSetReferences</code> entity within <code>SourceTemplate</code> to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.</p>
19 /// <p>Either a <code>SourceEntity</code> or a <code>Definition</code> must be provided in order for the request to be valid.</p>
20 pub source_entity: ::std::option::Option<crate::types::DashboardSourceEntity>,
21 /// <p>Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.</p>
22 pub tags: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>,
23 /// <p>A description for the first version of the dashboard being created.</p>
24 pub version_description: ::std::option::Option<::std::string::String>,
25 /// <p>Options for publishing the dashboard when you create it:</p>
26 /// <ul>
27 /// <li>
28 /// <p><code>AvailabilityStatus</code> for <code>AdHocFilteringOption</code> - This status can be either <code>ENABLED</code> or <code>DISABLED</code>. When this is set to <code>DISABLED</code>, Amazon Quick Sight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is <code>ENABLED</code> by default.</p></li>
29 /// <li>
30 /// <p><code>AvailabilityStatus</code> for <code>ExportToCSVOption</code> - This status can be either <code>ENABLED</code> or <code>DISABLED</code>. The visual option to export data to .CSV format isn't enabled when this is set to <code>DISABLED</code>. This option is <code>ENABLED</code> by default.</p></li>
31 /// <li>
32 /// <p><code>VisibilityState</code> for <code>SheetControlsOption</code> - This visibility state can be either <code>COLLAPSED</code> or <code>EXPANDED</code>. This option is <code>COLLAPSED</code> by default.</p></li>
33 /// <li>
34 /// <p><code>AvailabilityStatus</code> for <code>QuickSuiteActionsOption</code> - This status can be either <code>ENABLED</code> or <code>DISABLED</code>. Features related to Actions in Amazon Quick Suite on dashboards are disabled when this is set to <code>DISABLED</code>. This option is <code>DISABLED</code> by default.</p></li>
35 /// <li>
36 /// <p><code>AvailabilityStatus</code> for <code>ExecutiveSummaryOption</code> - This status can be either <code>ENABLED</code> or <code>DISABLED</code>. The option to build an executive summary is disabled when this is set to <code>DISABLED</code>. This option is <code>ENABLED</code> by default.</p></li>
37 /// <li>
38 /// <p><code>AvailabilityStatus</code> for <code>DataStoriesSharingOption</code> - This status can be either <code>ENABLED</code> or <code>DISABLED</code>. The option to share a data story is disabled when this is set to <code>DISABLED</code>. This option is <code>ENABLED</code> by default.</p></li>
39 /// </ul>
40 pub dashboard_publish_options: ::std::option::Option<crate::types::DashboardPublishOptions>,
41 /// <p>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.</p>
42 pub theme_arn: ::std::option::Option<::std::string::String>,
43 /// <p>The definition of a dashboard.</p>
44 /// <p>A definition is the data model of all features in a Dashboard, Template, or Analysis.</p>
45 /// <p>Either a <code>SourceEntity</code> or a <code>Definition</code> must be provided in order for the request to be valid.</p>
46 pub definition: ::std::option::Option<crate::types::DashboardVersionDefinition>,
47 /// <p>The option to relax the validation needed to create a dashboard with definition objects. This option skips the validation step for specific errors.</p>
48 pub validation_strategy: ::std::option::Option<crate::types::ValidationStrategy>,
49 /// <p>When you create the dashboard, Amazon Quick Sight adds the dashboard to these folders.</p>
50 pub folder_arns: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
51 /// <p>A structure that contains the permissions of a shareable link to the dashboard.</p>
52 pub link_sharing_configuration: ::std::option::Option<crate::types::LinkSharingConfiguration>,
53 /// <p>A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.</p>
54 pub link_entities: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
55}
56impl CreateDashboardInput {
57 /// <p>The ID of the Amazon Web Services account where you want to create the dashboard.</p>
58 pub fn aws_account_id(&self) -> ::std::option::Option<&str> {
59 self.aws_account_id.as_deref()
60 }
61 /// <p>The ID for the dashboard, also added to the IAM policy.</p>
62 pub fn dashboard_id(&self) -> ::std::option::Option<&str> {
63 self.dashboard_id.as_deref()
64 }
65 /// <p>The display name of the dashboard.</p>
66 pub fn name(&self) -> ::std::option::Option<&str> {
67 self.name.as_deref()
68 }
69 /// <p>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.</p>
70 pub fn parameters(&self) -> ::std::option::Option<&crate::types::Parameters> {
71 self.parameters.as_ref()
72 }
73 /// <p>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.</p>
74 /// <p>To specify no permissions, omit the permissions list.</p>
75 ///
76 /// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.permissions.is_none()`.
77 pub fn permissions(&self) -> &[crate::types::ResourcePermission] {
78 self.permissions.as_deref().unwrap_or_default()
79 }
80 /// <p>The entity that you are using as a source when you create the dashboard. In <code>SourceEntity</code>, you specify the type of object you're using as source. You can only create a dashboard from a template, so you use a <code>SourceTemplate</code> entity. If you need to create a dashboard from an analysis, first convert the analysis to a template by using the <code> <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_CreateTemplate.html">CreateTemplate</a> </code> API operation. For <code>SourceTemplate</code>, specify the Amazon Resource Name (ARN) of the source template. The <code>SourceTemplate</code>ARN can contain any Amazon Web Services account and any Amazon Quick Sight-supported Amazon Web Services Region.</p>
81 /// <p>Use the <code>DataSetReferences</code> entity within <code>SourceTemplate</code> to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.</p>
82 /// <p>Either a <code>SourceEntity</code> or a <code>Definition</code> must be provided in order for the request to be valid.</p>
83 pub fn source_entity(&self) -> ::std::option::Option<&crate::types::DashboardSourceEntity> {
84 self.source_entity.as_ref()
85 }
86 /// <p>Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.</p>
87 ///
88 /// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.tags.is_none()`.
89 pub fn tags(&self) -> &[crate::types::Tag] {
90 self.tags.as_deref().unwrap_or_default()
91 }
92 /// <p>A description for the first version of the dashboard being created.</p>
93 pub fn version_description(&self) -> ::std::option::Option<&str> {
94 self.version_description.as_deref()
95 }
96 /// <p>Options for publishing the dashboard when you create it:</p>
97 /// <ul>
98 /// <li>
99 /// <p><code>AvailabilityStatus</code> for <code>AdHocFilteringOption</code> - This status can be either <code>ENABLED</code> or <code>DISABLED</code>. When this is set to <code>DISABLED</code>, Amazon Quick Sight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is <code>ENABLED</code> by default.</p></li>
100 /// <li>
101 /// <p><code>AvailabilityStatus</code> for <code>ExportToCSVOption</code> - This status can be either <code>ENABLED</code> or <code>DISABLED</code>. The visual option to export data to .CSV format isn't enabled when this is set to <code>DISABLED</code>. This option is <code>ENABLED</code> by default.</p></li>
102 /// <li>
103 /// <p><code>VisibilityState</code> for <code>SheetControlsOption</code> - This visibility state can be either <code>COLLAPSED</code> or <code>EXPANDED</code>. This option is <code>COLLAPSED</code> by default.</p></li>
104 /// <li>
105 /// <p><code>AvailabilityStatus</code> for <code>QuickSuiteActionsOption</code> - This status can be either <code>ENABLED</code> or <code>DISABLED</code>. Features related to Actions in Amazon Quick Suite on dashboards are disabled when this is set to <code>DISABLED</code>. This option is <code>DISABLED</code> by default.</p></li>
106 /// <li>
107 /// <p><code>AvailabilityStatus</code> for <code>ExecutiveSummaryOption</code> - This status can be either <code>ENABLED</code> or <code>DISABLED</code>. The option to build an executive summary is disabled when this is set to <code>DISABLED</code>. This option is <code>ENABLED</code> by default.</p></li>
108 /// <li>
109 /// <p><code>AvailabilityStatus</code> for <code>DataStoriesSharingOption</code> - This status can be either <code>ENABLED</code> or <code>DISABLED</code>. The option to share a data story is disabled when this is set to <code>DISABLED</code>. This option is <code>ENABLED</code> by default.</p></li>
110 /// </ul>
111 pub fn dashboard_publish_options(&self) -> ::std::option::Option<&crate::types::DashboardPublishOptions> {
112 self.dashboard_publish_options.as_ref()
113 }
114 /// <p>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.</p>
115 pub fn theme_arn(&self) -> ::std::option::Option<&str> {
116 self.theme_arn.as_deref()
117 }
118 /// <p>The definition of a dashboard.</p>
119 /// <p>A definition is the data model of all features in a Dashboard, Template, or Analysis.</p>
120 /// <p>Either a <code>SourceEntity</code> or a <code>Definition</code> must be provided in order for the request to be valid.</p>
121 pub fn definition(&self) -> ::std::option::Option<&crate::types::DashboardVersionDefinition> {
122 self.definition.as_ref()
123 }
124 /// <p>The option to relax the validation needed to create a dashboard with definition objects. This option skips the validation step for specific errors.</p>
125 pub fn validation_strategy(&self) -> ::std::option::Option<&crate::types::ValidationStrategy> {
126 self.validation_strategy.as_ref()
127 }
128 /// <p>When you create the dashboard, Amazon Quick Sight adds the dashboard to these folders.</p>
129 ///
130 /// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.folder_arns.is_none()`.
131 pub fn folder_arns(&self) -> &[::std::string::String] {
132 self.folder_arns.as_deref().unwrap_or_default()
133 }
134 /// <p>A structure that contains the permissions of a shareable link to the dashboard.</p>
135 pub fn link_sharing_configuration(&self) -> ::std::option::Option<&crate::types::LinkSharingConfiguration> {
136 self.link_sharing_configuration.as_ref()
137 }
138 /// <p>A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.</p>
139 ///
140 /// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.link_entities.is_none()`.
141 pub fn link_entities(&self) -> &[::std::string::String] {
142 self.link_entities.as_deref().unwrap_or_default()
143 }
144}
145impl CreateDashboardInput {
146 /// Creates a new builder-style object to manufacture [`CreateDashboardInput`](crate::operation::create_dashboard::CreateDashboardInput).
147 pub fn builder() -> crate::operation::create_dashboard::builders::CreateDashboardInputBuilder {
148 crate::operation::create_dashboard::builders::CreateDashboardInputBuilder::default()
149 }
150}
151
152/// A builder for [`CreateDashboardInput`](crate::operation::create_dashboard::CreateDashboardInput).
153#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
154#[non_exhaustive]
155pub struct CreateDashboardInputBuilder {
156 pub(crate) aws_account_id: ::std::option::Option<::std::string::String>,
157 pub(crate) dashboard_id: ::std::option::Option<::std::string::String>,
158 pub(crate) name: ::std::option::Option<::std::string::String>,
159 pub(crate) parameters: ::std::option::Option<crate::types::Parameters>,
160 pub(crate) permissions: ::std::option::Option<::std::vec::Vec<crate::types::ResourcePermission>>,
161 pub(crate) source_entity: ::std::option::Option<crate::types::DashboardSourceEntity>,
162 pub(crate) tags: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>,
163 pub(crate) version_description: ::std::option::Option<::std::string::String>,
164 pub(crate) dashboard_publish_options: ::std::option::Option<crate::types::DashboardPublishOptions>,
165 pub(crate) theme_arn: ::std::option::Option<::std::string::String>,
166 pub(crate) definition: ::std::option::Option<crate::types::DashboardVersionDefinition>,
167 pub(crate) validation_strategy: ::std::option::Option<crate::types::ValidationStrategy>,
168 pub(crate) folder_arns: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
169 pub(crate) link_sharing_configuration: ::std::option::Option<crate::types::LinkSharingConfiguration>,
170 pub(crate) link_entities: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
171}
172impl CreateDashboardInputBuilder {
173 /// <p>The ID of the Amazon Web Services account where you want to create the dashboard.</p>
174 /// This field is required.
175 pub fn aws_account_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
176 self.aws_account_id = ::std::option::Option::Some(input.into());
177 self
178 }
179 /// <p>The ID of the Amazon Web Services account where you want to create the dashboard.</p>
180 pub fn set_aws_account_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
181 self.aws_account_id = input;
182 self
183 }
184 /// <p>The ID of the Amazon Web Services account where you want to create the dashboard.</p>
185 pub fn get_aws_account_id(&self) -> &::std::option::Option<::std::string::String> {
186 &self.aws_account_id
187 }
188 /// <p>The ID for the dashboard, also added to the IAM policy.</p>
189 /// This field is required.
190 pub fn dashboard_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
191 self.dashboard_id = ::std::option::Option::Some(input.into());
192 self
193 }
194 /// <p>The ID for the dashboard, also added to the IAM policy.</p>
195 pub fn set_dashboard_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
196 self.dashboard_id = input;
197 self
198 }
199 /// <p>The ID for the dashboard, also added to the IAM policy.</p>
200 pub fn get_dashboard_id(&self) -> &::std::option::Option<::std::string::String> {
201 &self.dashboard_id
202 }
203 /// <p>The display name of the dashboard.</p>
204 /// This field is required.
205 pub fn name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
206 self.name = ::std::option::Option::Some(input.into());
207 self
208 }
209 /// <p>The display name of the dashboard.</p>
210 pub fn set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
211 self.name = input;
212 self
213 }
214 /// <p>The display name of the dashboard.</p>
215 pub fn get_name(&self) -> &::std::option::Option<::std::string::String> {
216 &self.name
217 }
218 /// <p>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.</p>
219 pub fn parameters(mut self, input: crate::types::Parameters) -> Self {
220 self.parameters = ::std::option::Option::Some(input);
221 self
222 }
223 /// <p>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.</p>
224 pub fn set_parameters(mut self, input: ::std::option::Option<crate::types::Parameters>) -> Self {
225 self.parameters = input;
226 self
227 }
228 /// <p>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.</p>
229 pub fn get_parameters(&self) -> &::std::option::Option<crate::types::Parameters> {
230 &self.parameters
231 }
232 /// Appends an item to `permissions`.
233 ///
234 /// To override the contents of this collection use [`set_permissions`](Self::set_permissions).
235 ///
236 /// <p>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.</p>
237 /// <p>To specify no permissions, omit the permissions list.</p>
238 pub fn permissions(mut self, input: crate::types::ResourcePermission) -> Self {
239 let mut v = self.permissions.unwrap_or_default();
240 v.push(input);
241 self.permissions = ::std::option::Option::Some(v);
242 self
243 }
244 /// <p>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.</p>
245 /// <p>To specify no permissions, omit the permissions list.</p>
246 pub fn set_permissions(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::ResourcePermission>>) -> Self {
247 self.permissions = input;
248 self
249 }
250 /// <p>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.</p>
251 /// <p>To specify no permissions, omit the permissions list.</p>
252 pub fn get_permissions(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::ResourcePermission>> {
253 &self.permissions
254 }
255 /// <p>The entity that you are using as a source when you create the dashboard. In <code>SourceEntity</code>, you specify the type of object you're using as source. You can only create a dashboard from a template, so you use a <code>SourceTemplate</code> entity. If you need to create a dashboard from an analysis, first convert the analysis to a template by using the <code> <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_CreateTemplate.html">CreateTemplate</a> </code> API operation. For <code>SourceTemplate</code>, specify the Amazon Resource Name (ARN) of the source template. The <code>SourceTemplate</code>ARN can contain any Amazon Web Services account and any Amazon Quick Sight-supported Amazon Web Services Region.</p>
256 /// <p>Use the <code>DataSetReferences</code> entity within <code>SourceTemplate</code> to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.</p>
257 /// <p>Either a <code>SourceEntity</code> or a <code>Definition</code> must be provided in order for the request to be valid.</p>
258 pub fn source_entity(mut self, input: crate::types::DashboardSourceEntity) -> Self {
259 self.source_entity = ::std::option::Option::Some(input);
260 self
261 }
262 /// <p>The entity that you are using as a source when you create the dashboard. In <code>SourceEntity</code>, you specify the type of object you're using as source. You can only create a dashboard from a template, so you use a <code>SourceTemplate</code> entity. If you need to create a dashboard from an analysis, first convert the analysis to a template by using the <code> <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_CreateTemplate.html">CreateTemplate</a> </code> API operation. For <code>SourceTemplate</code>, specify the Amazon Resource Name (ARN) of the source template. The <code>SourceTemplate</code>ARN can contain any Amazon Web Services account and any Amazon Quick Sight-supported Amazon Web Services Region.</p>
263 /// <p>Use the <code>DataSetReferences</code> entity within <code>SourceTemplate</code> to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.</p>
264 /// <p>Either a <code>SourceEntity</code> or a <code>Definition</code> must be provided in order for the request to be valid.</p>
265 pub fn set_source_entity(mut self, input: ::std::option::Option<crate::types::DashboardSourceEntity>) -> Self {
266 self.source_entity = input;
267 self
268 }
269 /// <p>The entity that you are using as a source when you create the dashboard. In <code>SourceEntity</code>, you specify the type of object you're using as source. You can only create a dashboard from a template, so you use a <code>SourceTemplate</code> entity. If you need to create a dashboard from an analysis, first convert the analysis to a template by using the <code> <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_CreateTemplate.html">CreateTemplate</a> </code> API operation. For <code>SourceTemplate</code>, specify the Amazon Resource Name (ARN) of the source template. The <code>SourceTemplate</code>ARN can contain any Amazon Web Services account and any Amazon Quick Sight-supported Amazon Web Services Region.</p>
270 /// <p>Use the <code>DataSetReferences</code> entity within <code>SourceTemplate</code> to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.</p>
271 /// <p>Either a <code>SourceEntity</code> or a <code>Definition</code> must be provided in order for the request to be valid.</p>
272 pub fn get_source_entity(&self) -> &::std::option::Option<crate::types::DashboardSourceEntity> {
273 &self.source_entity
274 }
275 /// Appends an item to `tags`.
276 ///
277 /// To override the contents of this collection use [`set_tags`](Self::set_tags).
278 ///
279 /// <p>Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.</p>
280 pub fn tags(mut self, input: crate::types::Tag) -> Self {
281 let mut v = self.tags.unwrap_or_default();
282 v.push(input);
283 self.tags = ::std::option::Option::Some(v);
284 self
285 }
286 /// <p>Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.</p>
287 pub fn set_tags(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>) -> Self {
288 self.tags = input;
289 self
290 }
291 /// <p>Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.</p>
292 pub fn get_tags(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Tag>> {
293 &self.tags
294 }
295 /// <p>A description for the first version of the dashboard being created.</p>
296 pub fn version_description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
297 self.version_description = ::std::option::Option::Some(input.into());
298 self
299 }
300 /// <p>A description for the first version of the dashboard being created.</p>
301 pub fn set_version_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
302 self.version_description = input;
303 self
304 }
305 /// <p>A description for the first version of the dashboard being created.</p>
306 pub fn get_version_description(&self) -> &::std::option::Option<::std::string::String> {
307 &self.version_description
308 }
309 /// <p>Options for publishing the dashboard when you create it:</p>
310 /// <ul>
311 /// <li>
312 /// <p><code>AvailabilityStatus</code> for <code>AdHocFilteringOption</code> - This status can be either <code>ENABLED</code> or <code>DISABLED</code>. When this is set to <code>DISABLED</code>, Amazon Quick Sight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is <code>ENABLED</code> by default.</p></li>
313 /// <li>
314 /// <p><code>AvailabilityStatus</code> for <code>ExportToCSVOption</code> - This status can be either <code>ENABLED</code> or <code>DISABLED</code>. The visual option to export data to .CSV format isn't enabled when this is set to <code>DISABLED</code>. This option is <code>ENABLED</code> by default.</p></li>
315 /// <li>
316 /// <p><code>VisibilityState</code> for <code>SheetControlsOption</code> - This visibility state can be either <code>COLLAPSED</code> or <code>EXPANDED</code>. This option is <code>COLLAPSED</code> by default.</p></li>
317 /// <li>
318 /// <p><code>AvailabilityStatus</code> for <code>QuickSuiteActionsOption</code> - This status can be either <code>ENABLED</code> or <code>DISABLED</code>. Features related to Actions in Amazon Quick Suite on dashboards are disabled when this is set to <code>DISABLED</code>. This option is <code>DISABLED</code> by default.</p></li>
319 /// <li>
320 /// <p><code>AvailabilityStatus</code> for <code>ExecutiveSummaryOption</code> - This status can be either <code>ENABLED</code> or <code>DISABLED</code>. The option to build an executive summary is disabled when this is set to <code>DISABLED</code>. This option is <code>ENABLED</code> by default.</p></li>
321 /// <li>
322 /// <p><code>AvailabilityStatus</code> for <code>DataStoriesSharingOption</code> - This status can be either <code>ENABLED</code> or <code>DISABLED</code>. The option to share a data story is disabled when this is set to <code>DISABLED</code>. This option is <code>ENABLED</code> by default.</p></li>
323 /// </ul>
324 pub fn dashboard_publish_options(mut self, input: crate::types::DashboardPublishOptions) -> Self {
325 self.dashboard_publish_options = ::std::option::Option::Some(input);
326 self
327 }
328 /// <p>Options for publishing the dashboard when you create it:</p>
329 /// <ul>
330 /// <li>
331 /// <p><code>AvailabilityStatus</code> for <code>AdHocFilteringOption</code> - This status can be either <code>ENABLED</code> or <code>DISABLED</code>. When this is set to <code>DISABLED</code>, Amazon Quick Sight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is <code>ENABLED</code> by default.</p></li>
332 /// <li>
333 /// <p><code>AvailabilityStatus</code> for <code>ExportToCSVOption</code> - This status can be either <code>ENABLED</code> or <code>DISABLED</code>. The visual option to export data to .CSV format isn't enabled when this is set to <code>DISABLED</code>. This option is <code>ENABLED</code> by default.</p></li>
334 /// <li>
335 /// <p><code>VisibilityState</code> for <code>SheetControlsOption</code> - This visibility state can be either <code>COLLAPSED</code> or <code>EXPANDED</code>. This option is <code>COLLAPSED</code> by default.</p></li>
336 /// <li>
337 /// <p><code>AvailabilityStatus</code> for <code>QuickSuiteActionsOption</code> - This status can be either <code>ENABLED</code> or <code>DISABLED</code>. Features related to Actions in Amazon Quick Suite on dashboards are disabled when this is set to <code>DISABLED</code>. This option is <code>DISABLED</code> by default.</p></li>
338 /// <li>
339 /// <p><code>AvailabilityStatus</code> for <code>ExecutiveSummaryOption</code> - This status can be either <code>ENABLED</code> or <code>DISABLED</code>. The option to build an executive summary is disabled when this is set to <code>DISABLED</code>. This option is <code>ENABLED</code> by default.</p></li>
340 /// <li>
341 /// <p><code>AvailabilityStatus</code> for <code>DataStoriesSharingOption</code> - This status can be either <code>ENABLED</code> or <code>DISABLED</code>. The option to share a data story is disabled when this is set to <code>DISABLED</code>. This option is <code>ENABLED</code> by default.</p></li>
342 /// </ul>
343 pub fn set_dashboard_publish_options(mut self, input: ::std::option::Option<crate::types::DashboardPublishOptions>) -> Self {
344 self.dashboard_publish_options = input;
345 self
346 }
347 /// <p>Options for publishing the dashboard when you create it:</p>
348 /// <ul>
349 /// <li>
350 /// <p><code>AvailabilityStatus</code> for <code>AdHocFilteringOption</code> - This status can be either <code>ENABLED</code> or <code>DISABLED</code>. When this is set to <code>DISABLED</code>, Amazon Quick Sight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is <code>ENABLED</code> by default.</p></li>
351 /// <li>
352 /// <p><code>AvailabilityStatus</code> for <code>ExportToCSVOption</code> - This status can be either <code>ENABLED</code> or <code>DISABLED</code>. The visual option to export data to .CSV format isn't enabled when this is set to <code>DISABLED</code>. This option is <code>ENABLED</code> by default.</p></li>
353 /// <li>
354 /// <p><code>VisibilityState</code> for <code>SheetControlsOption</code> - This visibility state can be either <code>COLLAPSED</code> or <code>EXPANDED</code>. This option is <code>COLLAPSED</code> by default.</p></li>
355 /// <li>
356 /// <p><code>AvailabilityStatus</code> for <code>QuickSuiteActionsOption</code> - This status can be either <code>ENABLED</code> or <code>DISABLED</code>. Features related to Actions in Amazon Quick Suite on dashboards are disabled when this is set to <code>DISABLED</code>. This option is <code>DISABLED</code> by default.</p></li>
357 /// <li>
358 /// <p><code>AvailabilityStatus</code> for <code>ExecutiveSummaryOption</code> - This status can be either <code>ENABLED</code> or <code>DISABLED</code>. The option to build an executive summary is disabled when this is set to <code>DISABLED</code>. This option is <code>ENABLED</code> by default.</p></li>
359 /// <li>
360 /// <p><code>AvailabilityStatus</code> for <code>DataStoriesSharingOption</code> - This status can be either <code>ENABLED</code> or <code>DISABLED</code>. The option to share a data story is disabled when this is set to <code>DISABLED</code>. This option is <code>ENABLED</code> by default.</p></li>
361 /// </ul>
362 pub fn get_dashboard_publish_options(&self) -> &::std::option::Option<crate::types::DashboardPublishOptions> {
363 &self.dashboard_publish_options
364 }
365 /// <p>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.</p>
366 pub fn theme_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
367 self.theme_arn = ::std::option::Option::Some(input.into());
368 self
369 }
370 /// <p>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.</p>
371 pub fn set_theme_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
372 self.theme_arn = input;
373 self
374 }
375 /// <p>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.</p>
376 pub fn get_theme_arn(&self) -> &::std::option::Option<::std::string::String> {
377 &self.theme_arn
378 }
379 /// <p>The definition of a dashboard.</p>
380 /// <p>A definition is the data model of all features in a Dashboard, Template, or Analysis.</p>
381 /// <p>Either a <code>SourceEntity</code> or a <code>Definition</code> must be provided in order for the request to be valid.</p>
382 pub fn definition(mut self, input: crate::types::DashboardVersionDefinition) -> Self {
383 self.definition = ::std::option::Option::Some(input);
384 self
385 }
386 /// <p>The definition of a dashboard.</p>
387 /// <p>A definition is the data model of all features in a Dashboard, Template, or Analysis.</p>
388 /// <p>Either a <code>SourceEntity</code> or a <code>Definition</code> must be provided in order for the request to be valid.</p>
389 pub fn set_definition(mut self, input: ::std::option::Option<crate::types::DashboardVersionDefinition>) -> Self {
390 self.definition = input;
391 self
392 }
393 /// <p>The definition of a dashboard.</p>
394 /// <p>A definition is the data model of all features in a Dashboard, Template, or Analysis.</p>
395 /// <p>Either a <code>SourceEntity</code> or a <code>Definition</code> must be provided in order for the request to be valid.</p>
396 pub fn get_definition(&self) -> &::std::option::Option<crate::types::DashboardVersionDefinition> {
397 &self.definition
398 }
399 /// <p>The option to relax the validation needed to create a dashboard with definition objects. This option skips the validation step for specific errors.</p>
400 pub fn validation_strategy(mut self, input: crate::types::ValidationStrategy) -> Self {
401 self.validation_strategy = ::std::option::Option::Some(input);
402 self
403 }
404 /// <p>The option to relax the validation needed to create a dashboard with definition objects. This option skips the validation step for specific errors.</p>
405 pub fn set_validation_strategy(mut self, input: ::std::option::Option<crate::types::ValidationStrategy>) -> Self {
406 self.validation_strategy = input;
407 self
408 }
409 /// <p>The option to relax the validation needed to create a dashboard with definition objects. This option skips the validation step for specific errors.</p>
410 pub fn get_validation_strategy(&self) -> &::std::option::Option<crate::types::ValidationStrategy> {
411 &self.validation_strategy
412 }
413 /// Appends an item to `folder_arns`.
414 ///
415 /// To override the contents of this collection use [`set_folder_arns`](Self::set_folder_arns).
416 ///
417 /// <p>When you create the dashboard, Amazon Quick Sight adds the dashboard to these folders.</p>
418 pub fn folder_arns(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
419 let mut v = self.folder_arns.unwrap_or_default();
420 v.push(input.into());
421 self.folder_arns = ::std::option::Option::Some(v);
422 self
423 }
424 /// <p>When you create the dashboard, Amazon Quick Sight adds the dashboard to these folders.</p>
425 pub fn set_folder_arns(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
426 self.folder_arns = input;
427 self
428 }
429 /// <p>When you create the dashboard, Amazon Quick Sight adds the dashboard to these folders.</p>
430 pub fn get_folder_arns(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
431 &self.folder_arns
432 }
433 /// <p>A structure that contains the permissions of a shareable link to the dashboard.</p>
434 pub fn link_sharing_configuration(mut self, input: crate::types::LinkSharingConfiguration) -> Self {
435 self.link_sharing_configuration = ::std::option::Option::Some(input);
436 self
437 }
438 /// <p>A structure that contains the permissions of a shareable link to the dashboard.</p>
439 pub fn set_link_sharing_configuration(mut self, input: ::std::option::Option<crate::types::LinkSharingConfiguration>) -> Self {
440 self.link_sharing_configuration = input;
441 self
442 }
443 /// <p>A structure that contains the permissions of a shareable link to the dashboard.</p>
444 pub fn get_link_sharing_configuration(&self) -> &::std::option::Option<crate::types::LinkSharingConfiguration> {
445 &self.link_sharing_configuration
446 }
447 /// Appends an item to `link_entities`.
448 ///
449 /// To override the contents of this collection use [`set_link_entities`](Self::set_link_entities).
450 ///
451 /// <p>A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.</p>
452 pub fn link_entities(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
453 let mut v = self.link_entities.unwrap_or_default();
454 v.push(input.into());
455 self.link_entities = ::std::option::Option::Some(v);
456 self
457 }
458 /// <p>A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.</p>
459 pub fn set_link_entities(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
460 self.link_entities = input;
461 self
462 }
463 /// <p>A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.</p>
464 pub fn get_link_entities(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
465 &self.link_entities
466 }
467 /// Consumes the builder and constructs a [`CreateDashboardInput`](crate::operation::create_dashboard::CreateDashboardInput).
468 pub fn build(
469 self,
470 ) -> ::std::result::Result<crate::operation::create_dashboard::CreateDashboardInput, ::aws_smithy_types::error::operation::BuildError> {
471 ::std::result::Result::Ok(crate::operation::create_dashboard::CreateDashboardInput {
472 aws_account_id: self.aws_account_id,
473 dashboard_id: self.dashboard_id,
474 name: self.name,
475 parameters: self.parameters,
476 permissions: self.permissions,
477 source_entity: self.source_entity,
478 tags: self.tags,
479 version_description: self.version_description,
480 dashboard_publish_options: self.dashboard_publish_options,
481 theme_arn: self.theme_arn,
482 definition: self.definition,
483 validation_strategy: self.validation_strategy,
484 folder_arns: self.folder_arns,
485 link_sharing_configuration: self.link_sharing_configuration,
486 link_entities: self.link_entities,
487 })
488 }
489}