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
// 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 CreateTemplateInput {
/// <p>The ID for the Amazon Web Services account that the group is in. You use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.</p>
pub aws_account_id: ::std::option::Option<::std::string::String>,
/// <p>An ID for the template that you want to create. This template is unique per Amazon Web Services Region; in each Amazon Web Services account.</p>
pub template_id: ::std::option::Option<::std::string::String>,
/// <p>A display name for the template.</p>
pub name: ::std::option::Option<::std::string::String>,
/// <p>A list of resource permissions to be set on the template. </p>
pub permissions: ::std::option::Option<::std::vec::Vec<crate::types::ResourcePermission>>,
/// <p>The entity that you are using as a source when you create the template. In <code>SourceEntity</code>, you specify the type of object you're using as source: <code>SourceTemplate</code> for a template or <code>SourceAnalysis</code> for an analysis. Both of these require an Amazon Resource Name (ARN). For <code>SourceTemplate</code>, specify the ARN of the source template. For <code>SourceAnalysis</code>, specify the ARN of the source analysis. The <code>SourceTemplate</code> ARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region. </p>
/// <p>Use the <code>DataSetReferences</code> entity within <code>SourceTemplate</code> or <code>SourceAnalysis</code> to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder. </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::TemplateSourceEntity>,
/// <p>Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.</p>
pub tags: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>,
/// <p>A description of the current template version being created. This API operation creates the first version of the template. Every time <code>UpdateTemplate</code> is called, a new version is created. Each version of the template maintains a description of the version in the <code>VersionDescription</code> field.</p>
pub version_description: ::std::option::Option<::std::string::String>,
/// <p>The definition of a template.</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::TemplateVersionDefinition>,
/// <p>TThe option to relax the validation needed to create a template with definition objects. This skips the validation step for specific errors.</p>
pub validation_strategy: ::std::option::Option<crate::types::ValidationStrategy>,
}
impl CreateTemplateInput {
/// <p>The ID for the Amazon Web Services account that the group is in. You use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.</p>
pub fn aws_account_id(&self) -> ::std::option::Option<&str> {
self.aws_account_id.as_deref()
}
/// <p>An ID for the template that you want to create. This template is unique per Amazon Web Services Region; in each Amazon Web Services account.</p>
pub fn template_id(&self) -> ::std::option::Option<&str> {
self.template_id.as_deref()
}
/// <p>A display name for the template.</p>
pub fn name(&self) -> ::std::option::Option<&str> {
self.name.as_deref()
}
/// <p>A list of resource permissions to be set on the template. </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>The entity that you are using as a source when you create the template. In <code>SourceEntity</code>, you specify the type of object you're using as source: <code>SourceTemplate</code> for a template or <code>SourceAnalysis</code> for an analysis. Both of these require an Amazon Resource Name (ARN). For <code>SourceTemplate</code>, specify the ARN of the source template. For <code>SourceAnalysis</code>, specify the ARN of the source analysis. The <code>SourceTemplate</code> ARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region. </p>
/// <p>Use the <code>DataSetReferences</code> entity within <code>SourceTemplate</code> or <code>SourceAnalysis</code> to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder. </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::TemplateSourceEntity> {
self.source_entity.as_ref()
}
/// <p>Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.</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>A description of the current template version being created. This API operation creates the first version of the template. Every time <code>UpdateTemplate</code> is called, a new version is created. Each version of the template maintains a description of the version in the <code>VersionDescription</code> field.</p>
pub fn version_description(&self) -> ::std::option::Option<&str> {
self.version_description.as_deref()
}
/// <p>The definition of a template.</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::TemplateVersionDefinition> {
self.definition.as_ref()
}
/// <p>TThe option to relax the validation needed to create a template 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()
}
}
impl CreateTemplateInput {
/// Creates a new builder-style object to manufacture [`CreateTemplateInput`](crate::operation::create_template::CreateTemplateInput).
pub fn builder() -> crate::operation::create_template::builders::CreateTemplateInputBuilder {
crate::operation::create_template::builders::CreateTemplateInputBuilder::default()
}
}
/// A builder for [`CreateTemplateInput`](crate::operation::create_template::CreateTemplateInput).
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
pub struct CreateTemplateInputBuilder {
pub(crate) aws_account_id: ::std::option::Option<::std::string::String>,
pub(crate) template_id: ::std::option::Option<::std::string::String>,
pub(crate) name: ::std::option::Option<::std::string::String>,
pub(crate) permissions: ::std::option::Option<::std::vec::Vec<crate::types::ResourcePermission>>,
pub(crate) source_entity: ::std::option::Option<crate::types::TemplateSourceEntity>,
pub(crate) tags: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>,
pub(crate) version_description: ::std::option::Option<::std::string::String>,
pub(crate) definition: ::std::option::Option<crate::types::TemplateVersionDefinition>,
pub(crate) validation_strategy: ::std::option::Option<crate::types::ValidationStrategy>,
}
impl CreateTemplateInputBuilder {
/// <p>The ID for the Amazon Web Services account that the group is in. You use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.</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 for the Amazon Web Services account that the group is in. You use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.</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 for the Amazon Web Services account that the group is in. You use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.</p>
pub fn get_aws_account_id(&self) -> &::std::option::Option<::std::string::String> {
&self.aws_account_id
}
/// <p>An ID for the template that you want to create. This template is unique per Amazon Web Services Region; in each Amazon Web Services account.</p>
/// This field is required.
pub fn template_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.template_id = ::std::option::Option::Some(input.into());
self
}
/// <p>An ID for the template that you want to create. This template is unique per Amazon Web Services Region; in each Amazon Web Services account.</p>
pub fn set_template_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.template_id = input;
self
}
/// <p>An ID for the template that you want to create. This template is unique per Amazon Web Services Region; in each Amazon Web Services account.</p>
pub fn get_template_id(&self) -> &::std::option::Option<::std::string::String> {
&self.template_id
}
/// <p>A display name for the template.</p>
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 display name for the template.</p>
pub fn set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.name = input;
self
}
/// <p>A display name for the template.</p>
pub fn get_name(&self) -> &::std::option::Option<::std::string::String> {
&self.name
}
/// Appends an item to `permissions`.
///
/// To override the contents of this collection use [`set_permissions`](Self::set_permissions).
///
/// <p>A list of resource permissions to be set on the template. </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 list of resource permissions to be set on the template. </p>
pub fn set_permissions(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::ResourcePermission>>) -> Self {
self.permissions = input;
self
}
/// <p>A list of resource permissions to be set on the template. </p>
pub fn get_permissions(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::ResourcePermission>> {
&self.permissions
}
/// <p>The entity that you are using as a source when you create the template. In <code>SourceEntity</code>, you specify the type of object you're using as source: <code>SourceTemplate</code> for a template or <code>SourceAnalysis</code> for an analysis. Both of these require an Amazon Resource Name (ARN). For <code>SourceTemplate</code>, specify the ARN of the source template. For <code>SourceAnalysis</code>, specify the ARN of the source analysis. The <code>SourceTemplate</code> ARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region. </p>
/// <p>Use the <code>DataSetReferences</code> entity within <code>SourceTemplate</code> or <code>SourceAnalysis</code> to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder. </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::TemplateSourceEntity) -> Self {
self.source_entity = ::std::option::Option::Some(input);
self
}
/// <p>The entity that you are using as a source when you create the template. In <code>SourceEntity</code>, you specify the type of object you're using as source: <code>SourceTemplate</code> for a template or <code>SourceAnalysis</code> for an analysis. Both of these require an Amazon Resource Name (ARN). For <code>SourceTemplate</code>, specify the ARN of the source template. For <code>SourceAnalysis</code>, specify the ARN of the source analysis. The <code>SourceTemplate</code> ARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region. </p>
/// <p>Use the <code>DataSetReferences</code> entity within <code>SourceTemplate</code> or <code>SourceAnalysis</code> to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder. </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::TemplateSourceEntity>) -> Self {
self.source_entity = input;
self
}
/// <p>The entity that you are using as a source when you create the template. In <code>SourceEntity</code>, you specify the type of object you're using as source: <code>SourceTemplate</code> for a template or <code>SourceAnalysis</code> for an analysis. Both of these require an Amazon Resource Name (ARN). For <code>SourceTemplate</code>, specify the ARN of the source template. For <code>SourceAnalysis</code>, specify the ARN of the source analysis. The <code>SourceTemplate</code> ARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region. </p>
/// <p>Use the <code>DataSetReferences</code> entity within <code>SourceTemplate</code> or <code>SourceAnalysis</code> to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder. </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::TemplateSourceEntity> {
&self.source_entity
}
/// 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 resource.</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 resource.</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 resource.</p>
pub fn get_tags(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Tag>> {
&self.tags
}
/// <p>A description of the current template version being created. This API operation creates the first version of the template. Every time <code>UpdateTemplate</code> is called, a new version is created. Each version of the template maintains a description of the version in the <code>VersionDescription</code> field.</p>
pub fn version_description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.version_description = ::std::option::Option::Some(input.into());
self
}
/// <p>A description of the current template version being created. This API operation creates the first version of the template. Every time <code>UpdateTemplate</code> is called, a new version is created. Each version of the template maintains a description of the version in the <code>VersionDescription</code> field.</p>
pub fn set_version_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.version_description = input;
self
}
/// <p>A description of the current template version being created. This API operation creates the first version of the template. Every time <code>UpdateTemplate</code> is called, a new version is created. Each version of the template maintains a description of the version in the <code>VersionDescription</code> field.</p>
pub fn get_version_description(&self) -> &::std::option::Option<::std::string::String> {
&self.version_description
}
/// <p>The definition of a template.</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::TemplateVersionDefinition) -> Self {
self.definition = ::std::option::Option::Some(input);
self
}
/// <p>The definition of a template.</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::TemplateVersionDefinition>) -> Self {
self.definition = input;
self
}
/// <p>The definition of a template.</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::TemplateVersionDefinition> {
&self.definition
}
/// <p>TThe option to relax the validation needed to create a template 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>TThe option to relax the validation needed to create a template 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>TThe option to relax the validation needed to create a template 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
}
/// Consumes the builder and constructs a [`CreateTemplateInput`](crate::operation::create_template::CreateTemplateInput).
pub fn build(
self,
) -> ::std::result::Result<crate::operation::create_template::CreateTemplateInput, ::aws_smithy_types::error::operation::BuildError> {
::std::result::Result::Ok(crate::operation::create_template::CreateTemplateInput {
aws_account_id: self.aws_account_id,
template_id: self.template_id,
name: self.name,
permissions: self.permissions,
source_entity: self.source_entity,
tags: self.tags,
version_description: self.version_description,
definition: self.definition,
validation_strategy: self.validation_strategy,
})
}
}