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
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeChangeSet`](crate::operation::describe_change_set::builders::DescribeChangeSetFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`change_set_name(impl Into<String>)`](crate::operation::describe_change_set::builders::DescribeChangeSetFluentBuilder::change_set_name) / [`set_change_set_name(Option<String>)`](crate::operation::describe_change_set::builders::DescribeChangeSetFluentBuilder::set_change_set_name):<br>required: **true**<br><p>The name or Amazon Resource Name (ARN) of the change set that you want to describe.</p><br>
    ///   - [`stack_name(impl Into<String>)`](crate::operation::describe_change_set::builders::DescribeChangeSetFluentBuilder::stack_name) / [`set_stack_name(Option<String>)`](crate::operation::describe_change_set::builders::DescribeChangeSetFluentBuilder::set_stack_name):<br>required: **false**<br><p>If you specified the name of a change set, specify the stack name or ID (ARN) of the change set you want to describe.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::describe_change_set::builders::DescribeChangeSetFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_change_set::builders::DescribeChangeSetFluentBuilder::set_next_token):<br>required: **false**<br><p>A string (provided by the <code>DescribeChangeSet</code> response output) that identifies the next page of information that you want to retrieve.</p><br>
    ///   - [`include_property_values(bool)`](crate::operation::describe_change_set::builders::DescribeChangeSetFluentBuilder::include_property_values) / [`set_include_property_values(Option<bool>)`](crate::operation::describe_change_set::builders::DescribeChangeSetFluentBuilder::set_include_property_values):<br>required: **false**<br><p>If <code>true</code>, the returned changes include detailed changes in the property values.</p><br>
    /// - On success, responds with [`DescribeChangeSetOutput`](crate::operation::describe_change_set::DescribeChangeSetOutput) with field(s):
    ///   - [`change_set_name(Option<String>)`](crate::operation::describe_change_set::DescribeChangeSetOutput::change_set_name): <p>The name of the change set.</p>
    ///   - [`change_set_id(Option<String>)`](crate::operation::describe_change_set::DescribeChangeSetOutput::change_set_id): <p>The Amazon Resource Name (ARN) of the change set.</p>
    ///   - [`stack_id(Option<String>)`](crate::operation::describe_change_set::DescribeChangeSetOutput::stack_id): <p>The Amazon Resource Name (ARN) of the stack that's associated with the change set.</p>
    ///   - [`stack_name(Option<String>)`](crate::operation::describe_change_set::DescribeChangeSetOutput::stack_name): <p>The name of the stack that's associated with the change set.</p>
    ///   - [`description(Option<String>)`](crate::operation::describe_change_set::DescribeChangeSetOutput::description): <p>Information about the change set.</p>
    ///   - [`parameters(Option<Vec::<Parameter>>)`](crate::operation::describe_change_set::DescribeChangeSetOutput::parameters): <p>A list of <code>Parameter</code> structures that describes the input parameters and their values used to create the change set. For more information, see the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_Parameter.html">Parameter</a> data type.</p>
    ///   - [`creation_time(Option<DateTime>)`](crate::operation::describe_change_set::DescribeChangeSetOutput::creation_time): <p>The start time when the change set was created, in UTC.</p>
    ///   - [`execution_status(Option<ExecutionStatus>)`](crate::operation::describe_change_set::DescribeChangeSetOutput::execution_status): <p>If the change set execution status is <code>AVAILABLE</code>, you can execute the change set. If you can't execute the change set, the status indicates why. For example, a change set might be in an <code>UNAVAILABLE</code> state because CloudFormation is still creating it or in an <code>OBSOLETE</code> state because the stack was already updated.</p>
    ///   - [`status(Option<ChangeSetStatus>)`](crate::operation::describe_change_set::DescribeChangeSetOutput::status): <p>The current status of the change set, such as <code>CREATE_IN_PROGRESS</code>, <code>CREATE_COMPLETE</code>, or <code>FAILED</code>.</p>
    ///   - [`status_reason(Option<String>)`](crate::operation::describe_change_set::DescribeChangeSetOutput::status_reason): <p>A description of the change set's status. For example, if your attempt to create a change set failed, CloudFormation shows the error message.</p>
    ///   - [`notification_arns(Option<Vec::<String>>)`](crate::operation::describe_change_set::DescribeChangeSetOutput::notification_arns): <p>The ARNs of the Amazon Simple Notification Service (Amazon SNS) topics that will be associated with the stack if you execute the change set.</p>
    ///   - [`rollback_configuration(Option<RollbackConfiguration>)`](crate::operation::describe_change_set::DescribeChangeSetOutput::rollback_configuration): <p>The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.</p>
    ///   - [`capabilities(Option<Vec::<Capability>>)`](crate::operation::describe_change_set::DescribeChangeSetOutput::capabilities): <p>If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set was created.</p>
    ///   - [`tags(Option<Vec::<Tag>>)`](crate::operation::describe_change_set::DescribeChangeSetOutput::tags): <p>If you execute the change set, the tags that will be associated with the stack.</p>
    ///   - [`changes(Option<Vec::<Change>>)`](crate::operation::describe_change_set::DescribeChangeSetOutput::changes): <p>A list of <code>Change</code> structures that describes the resources CloudFormation changes if you execute the change set.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::describe_change_set::DescribeChangeSetOutput::next_token): <p>If the output exceeds 1 MB, a string that identifies the next page of changes. If there is no additional page, this value is null.</p>
    ///   - [`include_nested_stacks(Option<bool>)`](crate::operation::describe_change_set::DescribeChangeSetOutput::include_nested_stacks): <p>Verifies if <code>IncludeNestedStacks</code> is set to <code>True</code>.</p>
    ///   - [`parent_change_set_id(Option<String>)`](crate::operation::describe_change_set::DescribeChangeSetOutput::parent_change_set_id): <p>Specifies the change set ID of the parent change set in the current nested change set hierarchy.</p>
    ///   - [`root_change_set_id(Option<String>)`](crate::operation::describe_change_set::DescribeChangeSetOutput::root_change_set_id): <p>Specifies the change set ID of the root change set in the current nested change set hierarchy.</p>
    ///   - [`on_stack_failure(Option<OnStackFailure>)`](crate::operation::describe_change_set::DescribeChangeSetOutput::on_stack_failure): <p>Determines what action will be taken if stack creation fails. When this parameter is specified, the <code>DisableRollback</code> parameter to the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ExecuteChangeSet.html">ExecuteChangeSet</a> API operation must not be specified. This must be one of these values:</p> <ul>  <li>   <p><code>DELETE</code> - Deletes the change set if the stack creation fails. This is only valid when the <code>ChangeSetType</code> parameter is set to <code>CREATE</code>. If the deletion of the stack fails, the status of the stack is <code>DELETE_FAILED</code>.</p></li>  <li>   <p><code>DO_NOTHING</code> - if the stack creation fails, do nothing. This is equivalent to specifying <code>true</code> for the <code>DisableRollback</code> parameter to the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ExecuteChangeSet.html">ExecuteChangeSet</a> API operation.</p></li>  <li>   <p><code>ROLLBACK</code> - if the stack creation fails, roll back the stack. This is equivalent to specifying <code>false</code> for the <code>DisableRollback</code> parameter to the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ExecuteChangeSet.html">ExecuteChangeSet</a> API operation.</p></li> </ul>
    ///   - [`import_existing_resources(Option<bool>)`](crate::operation::describe_change_set::DescribeChangeSetOutput::import_existing_resources): <p>Indicates if the change set imports resources that already exist.</p><note>  <p>This parameter can only import resources that have <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html">custom names</a> in templates. To import resources that do not accept custom names, such as EC2 instances, use the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resource-import.html">resource import</a> feature instead.</p> </note>
    /// - On failure, responds with [`SdkError<DescribeChangeSetError>`](crate::operation::describe_change_set::DescribeChangeSetError)
    pub fn describe_change_set(&self) -> crate::operation::describe_change_set::builders::DescribeChangeSetFluentBuilder {
        crate::operation::describe_change_set::builders::DescribeChangeSetFluentBuilder::new(self.handle.clone())
    }
}