aws_sdk_connectcases/client/get_template.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3 /// Constructs a fluent builder for the [`GetTemplate`](crate::operation::get_template::builders::GetTemplateFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`domain_id(impl Into<String>)`](crate::operation::get_template::builders::GetTemplateFluentBuilder::domain_id) / [`set_domain_id(Option<String>)`](crate::operation::get_template::builders::GetTemplateFluentBuilder::set_domain_id):<br>required: **true**<br><p>The unique identifier of the Cases domain.</p><br>
7 /// - [`template_id(impl Into<String>)`](crate::operation::get_template::builders::GetTemplateFluentBuilder::template_id) / [`set_template_id(Option<String>)`](crate::operation::get_template::builders::GetTemplateFluentBuilder::set_template_id):<br>required: **true**<br><p>A unique identifier of a template.</p><br>
8 /// - On success, responds with [`GetTemplateOutput`](crate::operation::get_template::GetTemplateOutput) with field(s):
9 /// - [`template_id(String)`](crate::operation::get_template::GetTemplateOutput::template_id): <p>A unique identifier of a template.</p>
10 /// - [`template_arn(String)`](crate::operation::get_template::GetTemplateOutput::template_arn): <p>The Amazon Resource Name (ARN) of the template.</p>
11 /// - [`name(String)`](crate::operation::get_template::GetTemplateOutput::name): <p>The name of the template.</p>
12 /// - [`description(Option<String>)`](crate::operation::get_template::GetTemplateOutput::description): <p>A brief description of the template.</p>
13 /// - [`layout_configuration(Option<LayoutConfiguration>)`](crate::operation::get_template::GetTemplateOutput::layout_configuration): <p>Configuration of layouts associated to the template.</p>
14 /// - [`required_fields(Option<Vec::<RequiredField>>)`](crate::operation::get_template::GetTemplateOutput::required_fields): <p>A list of fields that must contain a value for a case to be successfully created with this template.</p>
15 /// - [`tags(Option<HashMap::<String, Option<String>>>)`](crate::operation::get_template::GetTemplateOutput::tags): <p>A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.</p>
16 /// - [`status(TemplateStatus)`](crate::operation::get_template::GetTemplateOutput::status): <p>The status of the template.</p>
17 /// - [`deleted(bool)`](crate::operation::get_template::GetTemplateOutput::deleted): <p>Denotes whether or not the resource has been deleted.</p>
18 /// - [`created_time(Option<DateTime>)`](crate::operation::get_template::GetTemplateOutput::created_time): <p>Timestamp at which the resource was created.</p>
19 /// - [`last_modified_time(Option<DateTime>)`](crate::operation::get_template::GetTemplateOutput::last_modified_time): <p>Timestamp at which the resource was created or last modified.</p>
20 /// - [`rules(Option<Vec::<TemplateRule>>)`](crate::operation::get_template::GetTemplateOutput::rules): <p>A list of case rules (also known as <a href="https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html">case field conditions</a>) on a template.</p>
21 /// - On failure, responds with [`SdkError<GetTemplateError>`](crate::operation::get_template::GetTemplateError)
22 pub fn get_template(&self) -> crate::operation::get_template::builders::GetTemplateFluentBuilder {
23 crate::operation::get_template::builders::GetTemplateFluentBuilder::new(self.handle.clone())
24 }
25}