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

Description

Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created.

If the stack doesn't exist, an ValidationError is returned.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeStacks Source #

The input for DescribeStacks action.

See: newDescribeStacks smart constructor.

Constructors

DescribeStacks' 

Fields

  • nextToken :: Maybe Text

    A string that identifies the next page of stacks 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 DescribeStacks Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStacks

Methods

toHeaders :: DescribeStacks -> [Header] #

ToPath DescribeStacks Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStacks

Methods

toPath :: DescribeStacks -> ByteString #

ToQuery DescribeStacks Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStacks

Methods

toQuery :: DescribeStacks -> QueryString #

AWSPager DescribeStacks Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStacks

Methods

page :: DescribeStacks -> AWSResponse DescribeStacks -> Maybe DescribeStacks #

AWSRequest DescribeStacks Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStacks

Associated Types

type AWSResponse DescribeStacks #

Methods

request :: (Service -> Service) -> DescribeStacks -> Request DescribeStacks #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeStacks -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeStacks))) #

Generic DescribeStacks Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStacks

Associated Types

type Rep DescribeStacks :: Type -> Type #

Methods

from :: DescribeStacks -> Rep DescribeStacks x #

to :: Rep DescribeStacks x -> DescribeStacks #

Read DescribeStacks Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStacks

Methods

readsPrec :: Int -> ReadS DescribeStacks #

readList :: ReadS [DescribeStacks] #

readPrec :: ReadPrec DescribeStacks #

readListPrec :: ReadPrec [DescribeStacks] #

Show DescribeStacks Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStacks

Methods

showsPrec :: Int -> DescribeStacks -> ShowS #

show :: DescribeStacks -> String #

showList :: [DescribeStacks] -> ShowS #

NFData DescribeStacks Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStacks

Methods

rnf :: DescribeStacks -> () #

Eq DescribeStacks Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStacks

Methods

(==) :: DescribeStacks -> DescribeStacks -> Bool #

(/=) :: DescribeStacks -> DescribeStacks -> Bool #

Hashable DescribeStacks Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStacks

Methods

hashWithSalt :: Int -> DescribeStacks -> Int #

hash :: DescribeStacks -> Int #

type AWSResponse DescribeStacks Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStacks

type AWSResponse DescribeStacks = DescribeStacksResponse
type Rep DescribeStacks Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStacks

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

newDescribeStacks :: DescribeStacks Source #

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

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

DescribeStacks, describeStacks_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

describeStacks_nextToken :: Lens' DescribeStacks (Maybe Text) Source #

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

describeStacks_stackName :: Lens' DescribeStacks (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 DescribeStacksResponse Source #

The output for a DescribeStacks action.

See: newDescribeStacksResponse smart constructor.

Constructors

DescribeStacksResponse' 

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.

  • stacks :: Maybe [Stack]

    A list of stack structures.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic DescribeStacksResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStacks

Associated Types

type Rep DescribeStacksResponse :: Type -> Type #

Methods

from :: DescribeStacksResponse -> Rep DescribeStacksResponse x #

to :: Rep DescribeStacksResponse x -> DescribeStacksResponse #

Read DescribeStacksResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStacks

Methods

readsPrec :: Int -> ReadS DescribeStacksResponse #

readList :: ReadS [DescribeStacksResponse] #

readPrec :: ReadPrec DescribeStacksResponse #

readListPrec :: ReadPrec [DescribeStacksResponse] #

Show DescribeStacksResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStacks

Methods

showsPrec :: Int -> DescribeStacksResponse -> ShowS #

show :: DescribeStacksResponse -> String #

showList :: [DescribeStacksResponse] -> ShowS #

NFData DescribeStacksResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStacks

Methods

rnf :: DescribeStacksResponse -> () #

Eq DescribeStacksResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStacks

Methods

(==) :: DescribeStacksResponse -> DescribeStacksResponse -> Bool #

(/=) :: DescribeStacksResponse -> DescribeStacksResponse -> Bool #

type Rep DescribeStacksResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.DescribeStacks

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

newDescribeStacksResponse Source #

Arguments

:: Int

$sel:httpStatus:DescribeStacksResponse'

-> DescribeStacksResponse 

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

DescribeStacks, describeStacksResponse_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:stacks:DescribeStacksResponse', describeStacksResponse_stacks - A list of stack structures.

$sel:httpStatus:DescribeStacksResponse', describeStacksResponse_httpStatus - The response's http status code.

Response Lenses

describeStacksResponse_nextToken :: Lens' DescribeStacksResponse (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.

describeStacksResponse_stacks :: Lens' DescribeStacksResponse (Maybe [Stack]) Source #

A list of stack structures.

describeStacksResponse_httpStatus :: Lens' DescribeStacksResponse Int Source #

The response's http status code.