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
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`GetTemplateSummary`](crate::operation::get_template_summary::builders::GetTemplateSummaryFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`template_body(impl Into<String>)`](crate::operation::get_template_summary::builders::GetTemplateSummaryFluentBuilder::template_body) / [`set_template_body(Option<String>)`](crate::operation::get_template_summary::builders::GetTemplateSummaryFluentBuilder::set_template_body):<br>required: **false**<br><p>Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information about templates, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html">Template anatomy</a> in the <i>CloudFormation User Guide</i>.</p> <p>Conditional: You must specify only one of the following parameters: <code>StackName</code>, <code>StackSetName</code>, <code>TemplateBody</code>, or <code>TemplateURL</code>.</p><br>
    ///   - [`template_url(impl Into<String>)`](crate::operation::get_template_summary::builders::GetTemplateSummaryFluentBuilder::template_url) / [`set_template_url(Option<String>)`](crate::operation::get_template_summary::builders::GetTemplateSummaryFluentBuilder::set_template_url):<br>required: **false**<br><p>Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that's located in an Amazon S3 bucket or a Systems Manager document. For more information about templates, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html">Template anatomy</a> in the <i>CloudFormation User Guide</i>. The location for an Amazon S3 bucket must start with <code>https://</code>.</p> <p>Conditional: You must specify only one of the following parameters: <code>StackName</code>, <code>StackSetName</code>, <code>TemplateBody</code>, or <code>TemplateURL</code>.</p><br>
    ///   - [`stack_name(impl Into<String>)`](crate::operation::get_template_summary::builders::GetTemplateSummaryFluentBuilder::stack_name) / [`set_stack_name(Option<String>)`](crate::operation::get_template_summary::builders::GetTemplateSummaryFluentBuilder::set_stack_name):<br>required: **false**<br><p>The name or the stack ID that's associated with the stack, which aren't always interchangeable. For running stacks, you can specify either the stack's name or its unique stack ID. For deleted stack, you must specify the unique stack ID.</p> <p>Conditional: You must specify only one of the following parameters: <code>StackName</code>, <code>StackSetName</code>, <code>TemplateBody</code>, or <code>TemplateURL</code>.</p><br>
    ///   - [`stack_set_name(impl Into<String>)`](crate::operation::get_template_summary::builders::GetTemplateSummaryFluentBuilder::stack_set_name) / [`set_stack_set_name(Option<String>)`](crate::operation::get_template_summary::builders::GetTemplateSummaryFluentBuilder::set_stack_set_name):<br>required: **false**<br><p>The name or unique ID of the stack set from which the stack was created.</p> <p>Conditional: You must specify only one of the following parameters: <code>StackName</code>, <code>StackSetName</code>, <code>TemplateBody</code>, or <code>TemplateURL</code>.</p><br>
    ///   - [`call_as(CallAs)`](crate::operation::get_template_summary::builders::GetTemplateSummaryFluentBuilder::call_as) / [`set_call_as(Option<CallAs>)`](crate::operation::get_template_summary::builders::GetTemplateSummaryFluentBuilder::set_call_as):<br>required: **false**<br><p>[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.</p> <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for stack sets with self-managed permissions.</p> <ul>  <li>   <p>If you are signed in to the management account, specify <code>SELF</code>.</p></li>  <li>   <p>If you are signed in to a delegated administrator account, specify <code>DELEGATED_ADMIN</code>.</p>   <p>Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html">Register a delegated administrator</a> in the <i>CloudFormation User Guide</i>.</p></li> </ul><br>
    ///   - [`template_summary_config(TemplateSummaryConfig)`](crate::operation::get_template_summary::builders::GetTemplateSummaryFluentBuilder::template_summary_config) / [`set_template_summary_config(Option<TemplateSummaryConfig>)`](crate::operation::get_template_summary::builders::GetTemplateSummaryFluentBuilder::set_template_summary_config):<br>required: **false**<br><p>Specifies options for the <code>GetTemplateSummary</code> API action.</p><br>
    /// - On success, responds with [`GetTemplateSummaryOutput`](crate::operation::get_template_summary::GetTemplateSummaryOutput) with field(s):
    ///   - [`parameters(Option<Vec::<ParameterDeclaration>>)`](crate::operation::get_template_summary::GetTemplateSummaryOutput::parameters): <p>A list of parameter declarations that describe various properties for each parameter.</p>
    ///   - [`description(Option<String>)`](crate::operation::get_template_summary::GetTemplateSummaryOutput::description): <p>The value that's defined in the <code>Description</code> property of the template.</p>
    ///   - [`capabilities(Option<Vec::<Capability>>)`](crate::operation::get_template_summary::GetTemplateSummaryOutput::capabilities): <p>The capabilities found within the template. If your template contains IAM resources, you must specify the <code>CAPABILITY_IAM</code> or <code>CAPABILITY_NAMED_IAM</code> value for this parameter when you use the <code>CreateStack</code> or <code>UpdateStack</code> actions with your template; otherwise, those actions return an <code>InsufficientCapabilities</code> error.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities">Acknowledging IAM Resources in CloudFormation Templates</a>.</p>
    ///   - [`capabilities_reason(Option<String>)`](crate::operation::get_template_summary::GetTemplateSummaryOutput::capabilities_reason): <p>The list of resources that generated the values in the <code>Capabilities</code> response element.</p>
    ///   - [`resource_types(Option<Vec::<String>>)`](crate::operation::get_template_summary::GetTemplateSummaryOutput::resource_types): <p>A list of all the template resource types that are defined in the template, such as <code>AWS::EC2::Instance</code>, <code>AWS::Dynamo::Table</code>, and <code>Custom::MyCustomInstance</code>.</p>
    ///   - [`version(Option<String>)`](crate::operation::get_template_summary::GetTemplateSummaryOutput::version): <p>The Amazon Web Services template format version, which identifies the capabilities of the template.</p>
    ///   - [`metadata(Option<String>)`](crate::operation::get_template_summary::GetTemplateSummaryOutput::metadata): <p>The value that's defined for the <code>Metadata</code> property of the template.</p>
    ///   - [`declared_transforms(Option<Vec::<String>>)`](crate::operation::get_template_summary::GetTemplateSummaryOutput::declared_transforms): <p>A list of the transforms that are declared in the template.</p>
    ///   - [`resource_identifier_summaries(Option<Vec::<ResourceIdentifierSummary>>)`](crate::operation::get_template_summary::GetTemplateSummaryOutput::resource_identifier_summaries): <p>A list of resource identifier summaries that describe the target resources of an import operation and the properties you can provide during the import to identify the target resources. For example, <code>BucketName</code> is a possible identifier property for an <code>AWS::S3::Bucket</code> resource.</p>
    ///   - [`warnings(Option<Warnings>)`](crate::operation::get_template_summary::GetTemplateSummaryOutput::warnings): <p>An object containing any warnings returned.</p>
    /// - On failure, responds with [`SdkError<GetTemplateSummaryError>`](crate::operation::get_template_summary::GetTemplateSummaryError)
    pub fn get_template_summary(&self) -> crate::operation::get_template_summary::builders::GetTemplateSummaryFluentBuilder {
        crate::operation::get_template_summary::builders::GetTemplateSummaryFluentBuilder::new(self.handle.clone())
    }
}