describeChangeSet method

Future<DescribeChangeSetOutput> describeChangeSet({
  1. required String changeSetName,
  2. String? nextToken,
  3. String? stackName,
})

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

May throw ChangeSetNotFoundException.

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

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

Parameter 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.

Implementation

Future<DescribeChangeSetOutput> describeChangeSet({
  required String changeSetName,
  String? nextToken,
  String? stackName,
}) async {
  ArgumentError.checkNotNull(changeSetName, 'changeSetName');
  _s.validateStringLength(
    'changeSetName',
    changeSetName,
    1,
    1600,
    isRequired: true,
  );
  _s.validateStringLength(
    'nextToken',
    nextToken,
    1,
    1024,
  );
  _s.validateStringLength(
    'stackName',
    stackName,
    1,
    1152921504606846976,
  );
  final $request = <String, dynamic>{};
  $request['ChangeSetName'] = changeSetName;
  nextToken?.also((arg) => $request['NextToken'] = arg);
  stackName?.also((arg) => $request['StackName'] = arg);
  final $result = await _protocol.send(
    $request,
    action: 'DescribeChangeSet',
    version: '2010-05-15',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['DescribeChangeSetInput'],
    shapes: shapes,
    resultWrapper: 'DescribeChangeSetResult',
  );
  return DescribeChangeSetOutput.fromXml($result);
}