describe_stack_events ( $opt )

Returns all the stack related events for the AWS account. If StackName is specified, returns events related to all the stacks with the given name. If StackName is not specified, returns all the events for the account. For more information about a stack’s event history, go to the AWS CloudFormation User Guide.

Events are returned, even if the stack never existed or has been successfully deleted.

Access

public

Parameters

Parameter

Type

Required

Description

$opt

array

Optional

An associative array of parameters that can have the following keys:

  • StackName - string - Optional - The name or the unique identifier associated with the stack. Default: There is no default value.
  • NextToken - string - Optional - String that identifies the start of the next list of events, if there is one. Default: There is no default value.
  • curlopts - array - Optional - A set of values to pass directly into curl_setopt(), where the key is a pre-defined CURLOPT_* constant.
  • returnCurlHandle - boolean - Optional - A private toggle specifying that the cURL handle be returned rather than actually completing the request. This toggle is useful for manually managed batch requests.

Returns

Type

Description

CFResponse

A CFResponse object containing a parsed HTTP response.

Examples

Describe events for a given stack.

$stack = new AmazonCloudFormation();

$response = $stack->describe_stack_events(array(
	'StackName' => 'aws-php-sdk-stack1'
));

// Success?
var_dump($response->isOK());
Result:
bool(true)

Related Methods

Source

Method defined in services/cloudformation.class.php | Toggle source view (6 lines) | View on GitHub

public function describe_stack_events($opt = null)
{
    if (!$opt) $opt = array();
            
    return $this->authenticate('DescribeStackEvents', $opt);
}

Copyright © 2010–2013 Amazon Web Services, LLC


Feedback