amazonka-cloudformation-1.5.0: Amazon CloudFormation SDK.

Copyright(c) 2013-2017 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.CloudFormation.ListStackInstances

Contents

Description

Returns summary information about stack instances that are associated with the specified stack set. You can filter for stack instances that are associated with a specific AWS account name or region.

Synopsis

Creating a Request

listStackInstances Source #

Creates a value of ListStackInstances with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • lsiStackInstanceRegion - The name of the region where you want to list stack instances.
  • lsiNextToken - If the previous request didn't return all of the remaining results, the response's NextToken parameter value is set to a token. To retrieve the next set of results, call ListStackInstances again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null .
  • lsiStackInstanceAccount - The name of the AWS account that you want to list stack instances for.
  • lsiMaxResults - The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.
  • lsiStackSetName - The name or unique ID of the stack set that you want to list stack instances for.

data ListStackInstances Source #

See: listStackInstances smart constructor.

Instances

Eq ListStackInstances Source # 
Data ListStackInstances Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListStackInstances -> c ListStackInstances #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListStackInstances #

toConstr :: ListStackInstances -> Constr #

dataTypeOf :: ListStackInstances -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ListStackInstances) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListStackInstances) #

gmapT :: (forall b. Data b => b -> b) -> ListStackInstances -> ListStackInstances #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListStackInstances -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListStackInstances -> r #

gmapQ :: (forall d. Data d => d -> u) -> ListStackInstances -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ListStackInstances -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListStackInstances -> m ListStackInstances #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListStackInstances -> m ListStackInstances #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListStackInstances -> m ListStackInstances #

Read ListStackInstances Source # 
Show ListStackInstances Source # 
Generic ListStackInstances Source # 
Hashable ListStackInstances Source # 
NFData ListStackInstances Source # 

Methods

rnf :: ListStackInstances -> () #

AWSRequest ListStackInstances Source # 
ToQuery ListStackInstances Source # 
ToPath ListStackInstances Source # 
ToHeaders ListStackInstances Source # 
type Rep ListStackInstances Source # 
type Rep ListStackInstances = D1 (MetaData "ListStackInstances" "Network.AWS.CloudFormation.ListStackInstances" "amazonka-cloudformation-1.5.0-KJ8fU86x75V4EoPee9jClQ" False) (C1 (MetaCons "ListStackInstances'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_lsiStackInstanceRegion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_lsiNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_lsiStackInstanceAccount") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_lsiMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat))) (S1 (MetaSel (Just Symbol "_lsiStackSetName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))))
type Rs ListStackInstances Source # 

Request Lenses

lsiStackInstanceRegion :: Lens' ListStackInstances (Maybe Text) Source #

The name of the region where you want to list stack instances.

lsiNextToken :: Lens' ListStackInstances (Maybe Text) Source #

If the previous request didn't return all of the remaining results, the response's NextToken parameter value is set to a token. To retrieve the next set of results, call ListStackInstances again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null .

lsiStackInstanceAccount :: Lens' ListStackInstances (Maybe Text) Source #

The name of the AWS account that you want to list stack instances for.

lsiMaxResults :: Lens' ListStackInstances (Maybe Natural) Source #

The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

lsiStackSetName :: Lens' ListStackInstances Text Source #

The name or unique ID of the stack set that you want to list stack instances for.

Destructuring the Response

listStackInstancesResponse Source #

Creates a value of ListStackInstancesResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • lsirsNextToken - If the request doesn't return all of the remaining results, NextToken is set to a token. To retrieve the next set of results, call ListStackInstances again and assign that token to the request object's NextToken parameter. If the request returns all results, NextToken is set to null .
  • lsirsSummaries - A list of StackInstanceSummary structures that contain information about the specified stack instances.
  • lsirsResponseStatus - -- | The response status code.

data ListStackInstancesResponse Source #

See: listStackInstancesResponse smart constructor.

Instances

Eq ListStackInstancesResponse Source # 
Data ListStackInstancesResponse Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListStackInstancesResponse -> c ListStackInstancesResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListStackInstancesResponse #

toConstr :: ListStackInstancesResponse -> Constr #

dataTypeOf :: ListStackInstancesResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ListStackInstancesResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListStackInstancesResponse) #

gmapT :: (forall b. Data b => b -> b) -> ListStackInstancesResponse -> ListStackInstancesResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListStackInstancesResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListStackInstancesResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> ListStackInstancesResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ListStackInstancesResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListStackInstancesResponse -> m ListStackInstancesResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListStackInstancesResponse -> m ListStackInstancesResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListStackInstancesResponse -> m ListStackInstancesResponse #

Read ListStackInstancesResponse Source # 
Show ListStackInstancesResponse Source # 
Generic ListStackInstancesResponse Source # 
NFData ListStackInstancesResponse Source # 
type Rep ListStackInstancesResponse Source # 
type Rep ListStackInstancesResponse = D1 (MetaData "ListStackInstancesResponse" "Network.AWS.CloudFormation.ListStackInstances" "amazonka-cloudformation-1.5.0-KJ8fU86x75V4EoPee9jClQ" False) (C1 (MetaCons "ListStackInstancesResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_lsirsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_lsirsSummaries") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [StackInstanceSummary]))) (S1 (MetaSel (Just Symbol "_lsirsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))))

Response Lenses

lsirsNextToken :: Lens' ListStackInstancesResponse (Maybe Text) Source #

If the request doesn't return all of the remaining results, NextToken is set to a token. To retrieve the next set of results, call ListStackInstances again and assign that token to the request object's NextToken parameter. If the request returns all results, NextToken is set to null .

lsirsSummaries :: Lens' ListStackInstancesResponse [StackInstanceSummary] Source #

A list of StackInstanceSummary structures that contain information about the specified stack instances.