Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.CloudFormation.ListStacks

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns the summary information for stacks whose status matches the specified StackStatusFilter. Summary information for stacks that have been deleted is kept for 90 days after the stack is deleted. If no StackStatusFilter is specified, summary information for all stacks is returned (including existing stacks and stacks that have been deleted).

This operation returns paginated results.

Synopsis

Creating a Request

data ListStacks Source #

The input for ListStacks action.

See: newListStacks smart constructor.

Constructors

ListStacks'
Fields nextToken :: Maybe Text A string that identifies the next page of stacks that you want to retrieve. stackStatusFilter :: Maybe [StackStatus] Stack status to use as a filter. Specify one or more stack status codes to list only stacks with the specified status codes. For a complete list of stack status codes, see the `StackStatus` parameter of the Stack data type.

Instances

Instances details

ToHeaders ListStacks Source #
Instance details Defined in Amazonka.CloudFormation.ListStacks Methods toHeaders :: ListStacks -> [Header] #
ToPath ListStacks Source #
Instance details Defined in Amazonka.CloudFormation.ListStacks Methods toPath :: ListStacks -> ByteString #
ToQuery ListStacks Source #
Instance details Defined in Amazonka.CloudFormation.ListStacks Methods toQuery :: ListStacks -> QueryString #
AWSPager ListStacks Source #
Instance details Defined in Amazonka.CloudFormation.ListStacks Methods page :: ListStacks -> AWSResponse ListStacks -> Maybe ListStacks #
AWSRequest ListStacks Source #
Instance details Defined in Amazonka.CloudFormation.ListStacks Associated Types type AWSResponse ListStacks # Methods request :: (Service -> Service) -> ListStacks -> Request ListStacks # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListStacks -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListStacks))) #
Generic ListStacks Source #
Instance details Defined in Amazonka.CloudFormation.ListStacks Associated Types type Rep ListStacks :: Type -> Type # Methods from :: ListStacks -> Rep ListStacks x # to :: Rep ListStacks x -> ListStacks #
Read ListStacks Source #
Instance details Defined in Amazonka.CloudFormation.ListStacks Methods readsPrec :: Int -> ReadS ListStacks # readList :: ReadS [ListStacks] # readPrec :: ReadPrec ListStacks # readListPrec :: ReadPrec [ListStacks] #
Show ListStacks Source #
Instance details Defined in Amazonka.CloudFormation.ListStacks Methods showsPrec :: Int -> ListStacks -> ShowS # show :: ListStacks -> String # showList :: [ListStacks] -> ShowS #
NFData ListStacks Source #
Instance details Defined in Amazonka.CloudFormation.ListStacks Methods rnf :: ListStacks -> () #
Eq ListStacks Source #
Instance details Defined in Amazonka.CloudFormation.ListStacks Methods (==) :: ListStacks -> ListStacks -> Bool # (/=) :: ListStacks -> ListStacks -> Bool #
Hashable ListStacks Source #
Instance details Defined in Amazonka.CloudFormation.ListStacks Methods hashWithSalt :: Int -> ListStacks -> Int # hash :: ListStacks -> Int #
type AWSResponse ListStacks Source #
Instance details Defined in Amazonka.CloudFormation.ListStacks type AWSResponse ListStacks = ListStacksResponse
type Rep ListStacks Source #
Instance details Defined in Amazonka.CloudFormation.ListStacks type Rep ListStacks = D1 ('MetaData "ListStacks" "Amazonka.CloudFormation.ListStacks" "amazonka-cloudformation-2.0-2g2oPzedi5AcwbDRlNZfB" 'False) (C1 ('MetaCons "ListStacks'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "stackStatusFilter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [StackStatus]))))

newListStacks :: ListStacks Source #

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

ListStacks, listStacks_nextToken - A string that identifies the next page of stacks that you want to retrieve.

$sel:stackStatusFilter:ListStacks', listStacks_stackStatusFilter - Stack status to use as a filter. Specify one or more stack status codes to list only stacks with the specified status codes. For a complete list of stack status codes, see the StackStatus parameter of the Stack data type.

Request Lenses

listStacks_nextToken :: Lens' ListStacks (Maybe Text) Source #

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

listStacks_stackStatusFilter :: Lens' ListStacks (Maybe [StackStatus]) Source #

Stack status to use as a filter. Specify one or more stack status codes to list only stacks with the specified status codes. For a complete list of stack status codes, see the StackStatus parameter of the Stack data type.

Destructuring the Response

data ListStacksResponse Source #

The output for ListStacks action.

See: newListStacksResponse smart constructor.

Constructors

ListStacksResponse'
Fields nextToken :: Maybe Text If the output exceeds 1 MB in size, a string that identifies the next page of stacks. If no additional page exists, this value is null. stackSummaries :: Maybe [StackSummary] A list of `StackSummary` structures containing information about the specified stacks. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic ListStacksResponse Source #
Instance details Defined in Amazonka.CloudFormation.ListStacks Associated Types type Rep ListStacksResponse :: Type -> Type # Methods from :: ListStacksResponse -> Rep ListStacksResponse x # to :: Rep ListStacksResponse x -> ListStacksResponse #
Read ListStacksResponse Source #
Instance details Defined in Amazonka.CloudFormation.ListStacks Methods readsPrec :: Int -> ReadS ListStacksResponse # readList :: ReadS [ListStacksResponse] # readPrec :: ReadPrec ListStacksResponse # readListPrec :: ReadPrec [ListStacksResponse] #
Show ListStacksResponse Source #
Instance details Defined in Amazonka.CloudFormation.ListStacks Methods showsPrec :: Int -> ListStacksResponse -> ShowS # show :: ListStacksResponse -> String # showList :: [ListStacksResponse] -> ShowS #
NFData ListStacksResponse Source #
Instance details Defined in Amazonka.CloudFormation.ListStacks Methods rnf :: ListStacksResponse -> () #
Eq ListStacksResponse Source #
Instance details Defined in Amazonka.CloudFormation.ListStacks Methods (==) :: ListStacksResponse -> ListStacksResponse -> Bool # (/=) :: ListStacksResponse -> ListStacksResponse -> Bool #
type Rep ListStacksResponse Source #
Instance details Defined in Amazonka.CloudFormation.ListStacks type Rep ListStacksResponse = D1 ('MetaData "ListStacksResponse" "Amazonka.CloudFormation.ListStacks" "amazonka-cloudformation-2.0-2g2oPzedi5AcwbDRlNZfB" 'False) (C1 ('MetaCons "ListStacksResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "stackSummaries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [StackSummary])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListStacksResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListStacksResponse'`
-> ListStacksResponse

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

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

$sel:stackSummaries:ListStacksResponse', listStacksResponse_stackSummaries - A list of StackSummary structures containing information about the specified stacks.

$sel:httpStatus:ListStacksResponse', listStacksResponse_httpStatus - The response's http status code.

Response Lenses

listStacksResponse_nextToken :: Lens' ListStacksResponse (Maybe Text) Source #

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

listStacksResponse_stackSummaries :: Lens' ListStacksResponse (Maybe [StackSummary]) Source #

A list of StackSummary structures containing information about the specified stacks.

listStacksResponse_httpStatus :: Lens' ListStacksResponse Int Source #

The response's http status code.