1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct CreateAnalysisInput {
/// <p>The ID of the Amazon Web Services account where you are creating an analysis.</p>
pub aws_account_id: ::std::option::Option<::std::string::String>,
/// <p>The ID for the analysis that you're creating. This ID displays in the URL of the analysis.</p>
pub analysis_id: ::std::option::Option<::std::string::String>,
/// <p>A descriptive name for the analysis that you're creating. This name displays for the analysis in the Amazon QuickSight console. </p>
pub name: ::std::option::Option<::std::string::String>,
/// <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>
pub parameters: ::std::option::Option<crate::types::Parameters>,
/// <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>
pub permissions: ::std::option::Option<::std::vec::Vec<crate::types::ResourcePermission>>,
/// <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>
pub source_entity: ::std::option::Option<crate::types::AnalysisSourceEntity>,
/// <p>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.</p>
pub theme_arn: ::std::option::Option<::std::string::String>,
/// <p>Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.</p>
pub tags: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>,
/// <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>
pub definition: ::std::option::Option<crate::types::AnalysisDefinition>,
/// <p>The option to relax the validation needed to create an analysis with definition objects. This skips the validation step for specific errors.</p>
pub validation_strategy: ::std::option::Option<crate::types::ValidationStrategy>,
/// <p>When you create the analysis, Amazon QuickSight adds the analysis to these folders.</p>
pub folder_arns: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
}
impl CreateAnalysisInput {
/// <p>The ID of the Amazon Web Services account where you are creating an analysis.</p>
pub fn aws_account_id(&self) -> ::std::option::Option<&str> {
self.aws_account_id.as_deref()
}
/// <p>The ID for the analysis that you're creating. This ID displays in the URL of the analysis.</p>
pub fn analysis_id(&self) -> ::std::option::Option<&str> {
self.analysis_id.as_deref()
}
/// <p>A descriptive name for the analysis that you're creating. This name displays for the analysis in the Amazon QuickSight console. </p>
pub fn name(&self) -> ::std::option::Option<&str> {
self.name.as_deref()
}
/// <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>
pub fn parameters(&self) -> ::std::option::Option<&crate::types::Parameters> {
self.parameters.as_ref()
}
/// <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>
///
/// 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()`.
pub fn permissions(&self) -> &[crate::types::ResourcePermission] {
self.permissions.as_deref().unwrap_or_default()
}
/// <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>
pub fn source_entity(&self) -> ::std::option::Option<&crate::types::AnalysisSourceEntity> {
self.source_entity.as_ref()
}
/// <p>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.</p>
pub fn theme_arn(&self) -> ::std::option::Option<&str> {
self.theme_arn.as_deref()
}
/// <p>Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.</p>
///
/// 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()`.
pub fn tags(&self) -> &[crate::types::Tag] {
self.tags.as_deref().unwrap_or_default()
}
/// <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>
pub fn definition(&self) -> ::std::option::Option<&crate::types::AnalysisDefinition> {
self.definition.as_ref()
}
/// <p>The option to relax the validation needed to create an analysis with definition objects. This skips the validation step for specific errors.</p>
pub fn validation_strategy(&self) -> ::std::option::Option<&crate::types::ValidationStrategy> {
self.validation_strategy.as_ref()
}
/// <p>When you create the analysis, Amazon QuickSight adds the analysis to these folders.</p>
///
/// 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()`.
pub fn folder_arns(&self) -> &[::std::string::String] {
self.folder_arns.as_deref().unwrap_or_default()
}
}
impl CreateAnalysisInput {
/// Creates a new builder-style object to manufacture [`CreateAnalysisInput`](crate::operation::create_analysis::CreateAnalysisInput).
pub fn builder() -> crate::operation::create_analysis::builders::CreateAnalysisInputBuilder {
crate::operation::create_analysis::builders::CreateAnalysisInputBuilder::default()
}
}
/// A builder for [`CreateAnalysisInput`](crate::operation::create_analysis::CreateAnalysisInput).
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
pub struct CreateAnalysisInputBuilder {
pub(crate) aws_account_id: ::std::option::Option<::std::string::String>,
pub(crate) analysis_id: ::std::option::Option<::std::string::String>,
pub(crate) name: ::std::option::Option<::std::string::String>,
pub(crate) parameters: ::std::option::Option<crate::types::Parameters>,
pub(crate) permissions: ::std::option::Option<::std::vec::Vec<crate::types::ResourcePermission>>,
pub(crate) source_entity: ::std::option::Option<crate::types::AnalysisSourceEntity>,
pub(crate) theme_arn: ::std::option::Option<::std::string::String>,
pub(crate) tags: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>,
pub(crate) definition: ::std::option::Option<crate::types::AnalysisDefinition>,
pub(crate) validation_strategy: ::std::option::Option<crate::types::ValidationStrategy>,
pub(crate) folder_arns: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
}
impl CreateAnalysisInputBuilder {
/// <p>The ID of the Amazon Web Services account where you are creating an analysis.</p>
/// This field is required.
pub fn aws_account_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.aws_account_id = ::std::option::Option::Some(input.into());
self
}
/// <p>The ID of the Amazon Web Services account where you are creating an analysis.</p>
pub fn set_aws_account_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.aws_account_id = input;
self
}
/// <p>The ID of the Amazon Web Services account where you are creating an analysis.</p>
pub fn get_aws_account_id(&self) -> &::std::option::Option<::std::string::String> {
&self.aws_account_id
}
/// <p>The ID for the analysis that you're creating. This ID displays in the URL of the analysis.</p>
/// This field is required.
pub fn analysis_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.analysis_id = ::std::option::Option::Some(input.into());
self
}
/// <p>The ID for the analysis that you're creating. This ID displays in the URL of the analysis.</p>
pub fn set_analysis_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.analysis_id = input;
self
}
/// <p>The ID for the analysis that you're creating. This ID displays in the URL of the analysis.</p>
pub fn get_analysis_id(&self) -> &::std::option::Option<::std::string::String> {
&self.analysis_id
}
/// <p>A descriptive name for the analysis that you're creating. This name displays for the analysis in the Amazon QuickSight console. </p>
/// This field is required.
pub fn name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.name = ::std::option::Option::Some(input.into());
self
}
/// <p>A descriptive name for the analysis that you're creating. This name displays for the analysis in the Amazon QuickSight console. </p>
pub fn set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.name = input;
self
}
/// <p>A descriptive name for the analysis that you're creating. This name displays for the analysis in the Amazon QuickSight console. </p>
pub fn get_name(&self) -> &::std::option::Option<::std::string::String> {
&self.name
}
/// <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>
pub fn parameters(mut self, input: crate::types::Parameters) -> Self {
self.parameters = ::std::option::Option::Some(input);
self
}
/// <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>
pub fn set_parameters(mut self, input: ::std::option::Option<crate::types::Parameters>) -> Self {
self.parameters = input;
self
}
/// <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>
pub fn get_parameters(&self) -> &::std::option::Option<crate::types::Parameters> {
&self.parameters
}
/// Appends an item to `permissions`.
///
/// To override the contents of this collection use [`set_permissions`](Self::set_permissions).
///
/// <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>
pub fn permissions(mut self, input: crate::types::ResourcePermission) -> Self {
let mut v = self.permissions.unwrap_or_default();
v.push(input);
self.permissions = ::std::option::Option::Some(v);
self
}
/// <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>
pub fn set_permissions(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::ResourcePermission>>) -> Self {
self.permissions = input;
self
}
/// <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>
pub fn get_permissions(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::ResourcePermission>> {
&self.permissions
}
/// <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>
pub fn source_entity(mut self, input: crate::types::AnalysisSourceEntity) -> Self {
self.source_entity = ::std::option::Option::Some(input);
self
}
/// <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>
pub fn set_source_entity(mut self, input: ::std::option::Option<crate::types::AnalysisSourceEntity>) -> Self {
self.source_entity = input;
self
}
/// <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>
pub fn get_source_entity(&self) -> &::std::option::Option<crate::types::AnalysisSourceEntity> {
&self.source_entity
}
/// <p>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.</p>
pub fn theme_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.theme_arn = ::std::option::Option::Some(input.into());
self
}
/// <p>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.</p>
pub fn set_theme_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.theme_arn = input;
self
}
/// <p>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.</p>
pub fn get_theme_arn(&self) -> &::std::option::Option<::std::string::String> {
&self.theme_arn
}
/// Appends an item to `tags`.
///
/// To override the contents of this collection use [`set_tags`](Self::set_tags).
///
/// <p>Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.</p>
pub fn tags(mut self, input: crate::types::Tag) -> Self {
let mut v = self.tags.unwrap_or_default();
v.push(input);
self.tags = ::std::option::Option::Some(v);
self
}
/// <p>Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.</p>
pub fn set_tags(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>) -> Self {
self.tags = input;
self
}
/// <p>Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.</p>
pub fn get_tags(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Tag>> {
&self.tags
}
/// <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>
pub fn definition(mut self, input: crate::types::AnalysisDefinition) -> Self {
self.definition = ::std::option::Option::Some(input);
self
}
/// <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>
pub fn set_definition(mut self, input: ::std::option::Option<crate::types::AnalysisDefinition>) -> Self {
self.definition = input;
self
}
/// <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>
pub fn get_definition(&self) -> &::std::option::Option<crate::types::AnalysisDefinition> {
&self.definition
}
/// <p>The option to relax the validation needed to create an analysis with definition objects. This skips the validation step for specific errors.</p>
pub fn validation_strategy(mut self, input: crate::types::ValidationStrategy) -> Self {
self.validation_strategy = ::std::option::Option::Some(input);
self
}
/// <p>The option to relax the validation needed to create an analysis with definition objects. This skips the validation step for specific errors.</p>
pub fn set_validation_strategy(mut self, input: ::std::option::Option<crate::types::ValidationStrategy>) -> Self {
self.validation_strategy = input;
self
}
/// <p>The option to relax the validation needed to create an analysis with definition objects. This skips the validation step for specific errors.</p>
pub fn get_validation_strategy(&self) -> &::std::option::Option<crate::types::ValidationStrategy> {
&self.validation_strategy
}
/// Appends an item to `folder_arns`.
///
/// To override the contents of this collection use [`set_folder_arns`](Self::set_folder_arns).
///
/// <p>When you create the analysis, Amazon QuickSight adds the analysis to these folders.</p>
pub fn folder_arns(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
let mut v = self.folder_arns.unwrap_or_default();
v.push(input.into());
self.folder_arns = ::std::option::Option::Some(v);
self
}
/// <p>When you create the analysis, Amazon QuickSight adds the analysis to these folders.</p>
pub fn set_folder_arns(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
self.folder_arns = input;
self
}
/// <p>When you create the analysis, Amazon QuickSight adds the analysis to these folders.</p>
pub fn get_folder_arns(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
&self.folder_arns
}
/// Consumes the builder and constructs a [`CreateAnalysisInput`](crate::operation::create_analysis::CreateAnalysisInput).
pub fn build(
self,
) -> ::std::result::Result<crate::operation::create_analysis::CreateAnalysisInput, ::aws_smithy_types::error::operation::BuildError> {
::std::result::Result::Ok(crate::operation::create_analysis::CreateAnalysisInput {
aws_account_id: self.aws_account_id,
analysis_id: self.analysis_id,
name: self.name,
parameters: self.parameters,
permissions: self.permissions,
source_entity: self.source_entity,
theme_arn: self.theme_arn,
tags: self.tags,
definition: self.definition,
validation_strategy: self.validation_strategy,
folder_arns: self.folder_arns,
})
}
}