amazonka-appstream-2.0: Amazon AppStream 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.AppStream.DescribeStacks

Description

Retrieves a list that describes one or more specified stacks, if the stack names are provided. Otherwise, all stacks in the account are described.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeStacks Source #

See: newDescribeStacks smart constructor.

Constructors

DescribeStacks' 

Fields

  • names :: Maybe [Text]

    The names of the stacks to describe.

  • nextToken :: Maybe Text

    The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

Instances

Instances details
ToJSON DescribeStacks Source # 
Instance details

Defined in Amazonka.AppStream.DescribeStacks

Methods

toJSON :: DescribeStacks -> Value #

toEncoding :: DescribeStacks -> Encoding #

toJSONList :: [DescribeStacks] -> Value #

toEncodingList :: [DescribeStacks] -> Encoding #

ToHeaders DescribeStacks Source # 
Instance details

Defined in Amazonka.AppStream.DescribeStacks

Methods

toHeaders :: DescribeStacks -> [Header] #

ToPath DescribeStacks Source # 
Instance details

Defined in Amazonka.AppStream.DescribeStacks

Methods

toPath :: DescribeStacks -> ByteString #

ToQuery DescribeStacks Source # 
Instance details

Defined in Amazonka.AppStream.DescribeStacks

Methods

toQuery :: DescribeStacks -> QueryString #

AWSPager DescribeStacks Source # 
Instance details

Defined in Amazonka.AppStream.DescribeStacks

Methods

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

AWSRequest DescribeStacks Source # 
Instance details

Defined in Amazonka.AppStream.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.AppStream.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.AppStream.DescribeStacks

Methods

readsPrec :: Int -> ReadS DescribeStacks #

readList :: ReadS [DescribeStacks] #

readPrec :: ReadPrec DescribeStacks #

readListPrec :: ReadPrec [DescribeStacks] #

Show DescribeStacks Source # 
Instance details

Defined in Amazonka.AppStream.DescribeStacks

Methods

showsPrec :: Int -> DescribeStacks -> ShowS #

show :: DescribeStacks -> String #

showList :: [DescribeStacks] -> ShowS #

NFData DescribeStacks Source # 
Instance details

Defined in Amazonka.AppStream.DescribeStacks

Methods

rnf :: DescribeStacks -> () #

Eq DescribeStacks Source # 
Instance details

Defined in Amazonka.AppStream.DescribeStacks

Methods

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

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

Hashable DescribeStacks Source # 
Instance details

Defined in Amazonka.AppStream.DescribeStacks

Methods

hashWithSalt :: Int -> DescribeStacks -> Int #

hash :: DescribeStacks -> Int #

type AWSResponse DescribeStacks Source # 
Instance details

Defined in Amazonka.AppStream.DescribeStacks

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

Defined in Amazonka.AppStream.DescribeStacks

type Rep DescribeStacks = D1 ('MetaData "DescribeStacks" "Amazonka.AppStream.DescribeStacks" "amazonka-appstream-2.0-2EgS7yjN1zMCngYkSFPgOd" 'False) (C1 ('MetaCons "DescribeStacks'" 'PrefixI 'True) (S1 ('MetaSel ('Just "names") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "nextToken") '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:

$sel:names:DescribeStacks', describeStacks_names - The names of the stacks to describe.

DescribeStacks, describeStacks_nextToken - The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

Request Lenses

describeStacks_names :: Lens' DescribeStacks (Maybe [Text]) Source #

The names of the stacks to describe.

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

The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

Destructuring the Response

data DescribeStacksResponse Source #

See: newDescribeStacksResponse smart constructor.

Constructors

DescribeStacksResponse' 

Fields

  • nextToken :: Maybe Text

    The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

  • stacks :: Maybe [Stack]

    Information about the stacks.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic DescribeStacksResponse Source # 
Instance details

Defined in Amazonka.AppStream.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.AppStream.DescribeStacks

Methods

readsPrec :: Int -> ReadS DescribeStacksResponse #

readList :: ReadS [DescribeStacksResponse] #

readPrec :: ReadPrec DescribeStacksResponse #

readListPrec :: ReadPrec [DescribeStacksResponse] #

Show DescribeStacksResponse Source # 
Instance details

Defined in Amazonka.AppStream.DescribeStacks

Methods

showsPrec :: Int -> DescribeStacksResponse -> ShowS #

show :: DescribeStacksResponse -> String #

showList :: [DescribeStacksResponse] -> ShowS #

NFData DescribeStacksResponse Source # 
Instance details

Defined in Amazonka.AppStream.DescribeStacks

Methods

rnf :: DescribeStacksResponse -> () #

Eq DescribeStacksResponse Source # 
Instance details

Defined in Amazonka.AppStream.DescribeStacks

Methods

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

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

type Rep DescribeStacksResponse Source # 
Instance details

Defined in Amazonka.AppStream.DescribeStacks

type Rep DescribeStacksResponse = D1 ('MetaData "DescribeStacksResponse" "Amazonka.AppStream.DescribeStacks" "amazonka-appstream-2.0-2EgS7yjN1zMCngYkSFPgOd" '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 - The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

$sel:stacks:DescribeStacksResponse', describeStacksResponse_stacks - Information about the stacks.

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

Response Lenses

describeStacksResponse_nextToken :: Lens' DescribeStacksResponse (Maybe Text) Source #

The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

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

Information about the stacks.

describeStacksResponse_httpStatus :: Lens' DescribeStacksResponse Int Source #

The response's http status code.