amazonka-cloudformation-2.0: Amazon CloudFormation SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.CloudFormation.DescribeChangeSet

Description

Returns the inputs for the change set and a list of changes that CloudFormation will make if you execute the change set. For more information, see Updating Stacks Using Change Sets in the CloudFormation User Guide.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeChangeSet Source #

The input for the DescribeChangeSet action.

See: newDescribeChangeSet smart constructor.

Constructors

DescribeChangeSet' 

Fields

  • nextToken :: Maybe Text

    A string (provided by the DescribeChangeSet response output) that identifies the next page of information that you want to retrieve.

  • stackName :: Maybe Text

    If you specified the name of a change set, specify the stack name or ID (ARN) of the change set you want to describe.

  • changeSetName :: Text

    The name or Amazon Resource Name (ARN) of the change set that you want to describe.

Instances

Instances details
ToHeaders DescribeChangeSet Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeChangeSet

ToPath DescribeChangeSet Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeChangeSet

ToQuery DescribeChangeSet Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeChangeSet

AWSPager DescribeChangeSet Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeChangeSet

AWSRequest DescribeChangeSet Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeChangeSet

Associated Types

type AWSResponse DescribeChangeSet #

Generic DescribeChangeSet Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeChangeSet

Associated Types

type Rep DescribeChangeSet :: Type -> Type #

Read DescribeChangeSet Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeChangeSet

Show DescribeChangeSet Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeChangeSet

NFData DescribeChangeSet Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeChangeSet

Methods

rnf :: DescribeChangeSet -> () #

Eq DescribeChangeSet Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeChangeSet

Hashable DescribeChangeSet Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeChangeSet

type AWSResponse DescribeChangeSet Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeChangeSet

type Rep DescribeChangeSet Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeChangeSet

type Rep DescribeChangeSet = D1 ('MetaData "DescribeChangeSet" "Amazonka.CloudFormation.DescribeChangeSet" "amazonka-cloudformation-2.0-2g2oPzedi5AcwbDRlNZfB" 'False) (C1 ('MetaCons "DescribeChangeSet'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "stackName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "changeSetName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newDescribeChangeSet Source #

Create a value of DescribeChangeSet with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeChangeSet, describeChangeSet_nextToken - A string (provided by the DescribeChangeSet response output) that identifies the next page of information that you want to retrieve.

DescribeChangeSet, describeChangeSet_stackName - If you specified the name of a change set, specify the stack name or ID (ARN) of the change set you want to describe.

DescribeChangeSet, describeChangeSet_changeSetName - The name or Amazon Resource Name (ARN) of the change set that you want to describe.

Request Lenses

describeChangeSet_nextToken :: Lens' DescribeChangeSet (Maybe Text) Source #

A string (provided by the DescribeChangeSet response output) that identifies the next page of information that you want to retrieve.

describeChangeSet_stackName :: Lens' DescribeChangeSet (Maybe Text) Source #

If you specified the name of a change set, specify the stack name or ID (ARN) of the change set you want to describe.

describeChangeSet_changeSetName :: Lens' DescribeChangeSet Text Source #

The name or Amazon Resource Name (ARN) of the change set that you want to describe.

Destructuring the Response

data DescribeChangeSetResponse Source #

The output for the DescribeChangeSet action.

See: newDescribeChangeSetResponse smart constructor.

Constructors

DescribeChangeSetResponse' 

Fields

  • capabilities :: Maybe [Capability]

    If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set was created.

  • changeSetId :: Maybe Text

    The Amazon Resource Name (ARN) of the change set.

  • changeSetName :: Maybe Text

    The name of the change set.

  • changes :: Maybe [Change]

    A list of Change structures that describes the resources CloudFormation changes if you execute the change set.

  • creationTime :: Maybe ISO8601

    The start time when the change set was created, in UTC.

  • description :: Maybe Text

    Information about the change set.

  • executionStatus :: Maybe ExecutionStatus

    If the change set execution status is AVAILABLE, 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 UNAVAILABLE state because CloudFormation is still creating it or in an OBSOLETE state because the stack was already updated.

  • includeNestedStacks :: Maybe Bool

    Verifies if IncludeNestedStacks is set to True.

  • nextToken :: Maybe Text

    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.

  • notificationARNs :: Maybe [Text]

    The ARNs of the Amazon Simple Notification Service (Amazon SNS) topics that will be associated with the stack if you execute the change set.

  • parameters :: Maybe [Parameter]

    A list of Parameter structures that describes the input parameters and their values used to create the change set. For more information, see the Parameter data type.

  • parentChangeSetId :: Maybe Text

    Specifies the change set ID of the parent change set in the current nested change set hierarchy.

  • rollbackConfiguration :: Maybe RollbackConfiguration

    The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.

  • rootChangeSetId :: Maybe Text

    Specifies the change set ID of the root change set in the current nested change set hierarchy.

  • stackId :: Maybe Text

    The Amazon Resource Name (ARN) of the stack that's associated with the change set.

  • stackName :: Maybe Text

    The name of the stack that's associated with the change set.

  • statusReason :: Maybe Text

    A description of the change set's status. For example, if your attempt to create a change set failed, CloudFormation shows the error message.

  • tags :: Maybe [Tag]

    If you execute the change set, the tags that will be associated with the stack.

  • httpStatus :: Int

    The response's http status code.

  • status :: ChangeSetStatus

    The current status of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE, or FAILED.

Instances

Instances details
Generic DescribeChangeSetResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeChangeSet

Associated Types

type Rep DescribeChangeSetResponse :: Type -> Type #

Read DescribeChangeSetResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeChangeSet

Show DescribeChangeSetResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeChangeSet

NFData DescribeChangeSetResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeChangeSet

Eq DescribeChangeSetResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeChangeSet

type Rep DescribeChangeSetResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeChangeSet

type Rep DescribeChangeSetResponse = D1 ('MetaData "DescribeChangeSetResponse" "Amazonka.CloudFormation.DescribeChangeSet" "amazonka-cloudformation-2.0-2g2oPzedi5AcwbDRlNZfB" 'False) (C1 ('MetaCons "DescribeChangeSetResponse'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "capabilities") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Capability])) :*: S1 ('MetaSel ('Just "changeSetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "changeSetName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "changes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Change])) :*: S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601))))) :*: ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "executionStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ExecutionStatus))) :*: (S1 ('MetaSel ('Just "includeNestedStacks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "notificationARNs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))))) :*: (((S1 ('MetaSel ('Just "parameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Parameter])) :*: S1 ('MetaSel ('Just "parentChangeSetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "rollbackConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RollbackConfiguration)) :*: (S1 ('MetaSel ('Just "rootChangeSetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "stackId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "stackName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "statusReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ChangeSetStatus)))))))

newDescribeChangeSetResponse Source #

Create a value of DescribeChangeSetResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeChangeSetResponse, describeChangeSetResponse_capabilities - If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set was created.

DescribeChangeSetResponse, describeChangeSetResponse_changeSetId - The Amazon Resource Name (ARN) of the change set.

DescribeChangeSet, describeChangeSetResponse_changeSetName - The name of the change set.

$sel:changes:DescribeChangeSetResponse', describeChangeSetResponse_changes - A list of Change structures that describes the resources CloudFormation changes if you execute the change set.

DescribeChangeSetResponse, describeChangeSetResponse_creationTime - The start time when the change set was created, in UTC.

DescribeChangeSetResponse, describeChangeSetResponse_description - Information about the change set.

DescribeChangeSetResponse, describeChangeSetResponse_executionStatus - If the change set execution status is AVAILABLE, 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 UNAVAILABLE state because CloudFormation is still creating it or in an OBSOLETE state because the stack was already updated.

DescribeChangeSetResponse, describeChangeSetResponse_includeNestedStacks - Verifies if IncludeNestedStacks is set to True.

DescribeChangeSet, describeChangeSetResponse_nextToken - 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.

DescribeChangeSetResponse, describeChangeSetResponse_notificationARNs - The ARNs of the Amazon Simple Notification Service (Amazon SNS) topics that will be associated with the stack if you execute the change set.

DescribeChangeSetResponse, describeChangeSetResponse_parameters - A list of Parameter structures that describes the input parameters and their values used to create the change set. For more information, see the Parameter data type.

DescribeChangeSetResponse, describeChangeSetResponse_parentChangeSetId - Specifies the change set ID of the parent change set in the current nested change set hierarchy.

DescribeChangeSetResponse, describeChangeSetResponse_rollbackConfiguration - The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.

DescribeChangeSetResponse, describeChangeSetResponse_rootChangeSetId - Specifies the change set ID of the root change set in the current nested change set hierarchy.

DescribeChangeSetResponse, describeChangeSetResponse_stackId - The Amazon Resource Name (ARN) of the stack that's associated with the change set.

DescribeChangeSet, describeChangeSetResponse_stackName - The name of the stack that's associated with the change set.

DescribeChangeSetResponse, describeChangeSetResponse_statusReason - A description of the change set's status. For example, if your attempt to create a change set failed, CloudFormation shows the error message.

DescribeChangeSetResponse, describeChangeSetResponse_tags - If you execute the change set, the tags that will be associated with the stack.

$sel:httpStatus:DescribeChangeSetResponse', describeChangeSetResponse_httpStatus - The response's http status code.

DescribeChangeSetResponse, describeChangeSetResponse_status - The current status of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE, or FAILED.

Response Lenses

describeChangeSetResponse_capabilities :: Lens' DescribeChangeSetResponse (Maybe [Capability]) Source #

If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set was created.

describeChangeSetResponse_changeSetId :: Lens' DescribeChangeSetResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the change set.

describeChangeSetResponse_changes :: Lens' DescribeChangeSetResponse (Maybe [Change]) Source #

A list of Change structures that describes the resources CloudFormation changes if you execute the change set.

describeChangeSetResponse_creationTime :: Lens' DescribeChangeSetResponse (Maybe UTCTime) Source #

The start time when the change set was created, in UTC.

describeChangeSetResponse_executionStatus :: Lens' DescribeChangeSetResponse (Maybe ExecutionStatus) Source #

If the change set execution status is AVAILABLE, 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 UNAVAILABLE state because CloudFormation is still creating it or in an OBSOLETE state because the stack was already updated.

describeChangeSetResponse_nextToken :: Lens' DescribeChangeSetResponse (Maybe Text) Source #

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.

describeChangeSetResponse_notificationARNs :: Lens' DescribeChangeSetResponse (Maybe [Text]) Source #

The ARNs of the Amazon Simple Notification Service (Amazon SNS) topics that will be associated with the stack if you execute the change set.

describeChangeSetResponse_parameters :: Lens' DescribeChangeSetResponse (Maybe [Parameter]) Source #

A list of Parameter structures that describes the input parameters and their values used to create the change set. For more information, see the Parameter data type.

describeChangeSetResponse_parentChangeSetId :: Lens' DescribeChangeSetResponse (Maybe Text) Source #

Specifies the change set ID of the parent change set in the current nested change set hierarchy.

describeChangeSetResponse_rollbackConfiguration :: Lens' DescribeChangeSetResponse (Maybe RollbackConfiguration) Source #

The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.

describeChangeSetResponse_rootChangeSetId :: Lens' DescribeChangeSetResponse (Maybe Text) Source #

Specifies the change set ID of the root change set in the current nested change set hierarchy.

describeChangeSetResponse_stackId :: Lens' DescribeChangeSetResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the stack that's associated with the change set.

describeChangeSetResponse_stackName :: Lens' DescribeChangeSetResponse (Maybe Text) Source #

The name of the stack that's associated with the change set.

describeChangeSetResponse_statusReason :: Lens' DescribeChangeSetResponse (Maybe Text) Source #

A description of the change set's status. For example, if your attempt to create a change set failed, CloudFormation shows the error message.

describeChangeSetResponse_tags :: Lens' DescribeChangeSetResponse (Maybe [Tag]) Source #

If you execute the change set, the tags that will be associated with the stack.

describeChangeSetResponse_status :: Lens' DescribeChangeSetResponse ChangeSetStatus Source #

The current status of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE, or FAILED.