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

Description

Returns all stack related events for a specified stack in reverse chronological order. For more information about a stack's event history, go to Stacks in the CloudFormation User Guide.

You can list events for stacks that have failed to create or have been deleted by specifying the unique stack identifier (stack ID).

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeStackEvents Source #

The input for DescribeStackEvents action.

See: newDescribeStackEvents smart constructor.

Constructors

DescribeStackEvents' 

Fields

  • nextToken :: Maybe Text

    A string that identifies the next page of events that you want to retrieve.

  • stackName :: Maybe Text

    The name or the unique stack ID that's associated with the stack, which aren't always interchangeable:

    • Running stacks: You can specify either the stack's name or its unique stack ID.
    • Deleted stacks: You must specify the unique stack ID.

    Default: There is no default value.

Instances

Instances details
ToHeaders DescribeStackEvents Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackEvents

ToPath DescribeStackEvents Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackEvents

ToQuery DescribeStackEvents Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackEvents

AWSPager DescribeStackEvents Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackEvents

AWSRequest DescribeStackEvents Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackEvents

Associated Types

type AWSResponse DescribeStackEvents #

Generic DescribeStackEvents Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackEvents

Associated Types

type Rep DescribeStackEvents :: Type -> Type #

Read DescribeStackEvents Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackEvents

Show DescribeStackEvents Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackEvents

NFData DescribeStackEvents Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackEvents

Methods

rnf :: DescribeStackEvents -> () #

Eq DescribeStackEvents Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackEvents

Hashable DescribeStackEvents Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackEvents

type AWSResponse DescribeStackEvents Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackEvents

type Rep DescribeStackEvents Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackEvents

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

newDescribeStackEvents :: DescribeStackEvents Source #

Create a value of DescribeStackEvents 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:

DescribeStackEvents, describeStackEvents_nextToken - A string that identifies the next page of events that you want to retrieve.

DescribeStackEvents, describeStackEvents_stackName - The name or the unique stack ID that's associated with the stack, which aren't always interchangeable:

  • Running stacks: You can specify either the stack's name or its unique stack ID.
  • Deleted stacks: You must specify the unique stack ID.

Default: There is no default value.

Request Lenses

describeStackEvents_nextToken :: Lens' DescribeStackEvents (Maybe Text) Source #

A string that identifies the next page of events that you want to retrieve.

describeStackEvents_stackName :: Lens' DescribeStackEvents (Maybe Text) Source #

The name or the unique stack ID that's associated with the stack, which aren't always interchangeable:

  • Running stacks: You can specify either the stack's name or its unique stack ID.
  • Deleted stacks: You must specify the unique stack ID.

Default: There is no default value.

Destructuring the Response

data DescribeStackEventsResponse Source #

The output for a DescribeStackEvents action.

See: newDescribeStackEventsResponse smart constructor.

Constructors

DescribeStackEventsResponse' 

Fields

Instances

Instances details
Generic DescribeStackEventsResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackEvents

Associated Types

type Rep DescribeStackEventsResponse :: Type -> Type #

Read DescribeStackEventsResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackEvents

Show DescribeStackEventsResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackEvents

NFData DescribeStackEventsResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackEvents

Eq DescribeStackEventsResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackEvents

type Rep DescribeStackEventsResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStackEvents

type Rep DescribeStackEventsResponse = D1 ('MetaData "DescribeStackEventsResponse" "Amazonka.CloudFormation.DescribeStackEvents" "amazonka-cloudformation-2.0-2g2oPzedi5AcwbDRlNZfB" 'False) (C1 ('MetaCons "DescribeStackEventsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "stackEvents") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [StackEvent])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeStackEventsResponse Source #

Create a value of DescribeStackEventsResponse 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:

DescribeStackEvents, describeStackEventsResponse_nextToken - If the output exceeds 1 MB in size, a string that identifies the next page of events. If no additional page exists, this value is null.

$sel:stackEvents:DescribeStackEventsResponse', describeStackEventsResponse_stackEvents - A list of StackEvents structures.

$sel:httpStatus:DescribeStackEventsResponse', describeStackEventsResponse_httpStatus - The response's http status code.

Response Lenses

describeStackEventsResponse_nextToken :: Lens' DescribeStackEventsResponse (Maybe Text) Source #

If the output exceeds 1 MB in size, a string that identifies the next page of events. If no additional page exists, this value is null.