Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.CloudFormation.ListStackInstances

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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 Amazon Web Services account name or Region, or that have a specific status.

This operation returns paginated results.

Synopsis

data ListStackInstances = ListStackInstances' {
- stackInstanceRegion :: Maybe Text
- callAs :: Maybe CallAs
- filters :: Maybe [StackInstanceFilter]
- nextToken :: Maybe Text
- stackInstanceAccount :: Maybe Text
- maxResults :: Maybe Natural
- stackSetName :: Text
}
newListStackInstances :: Text -> ListStackInstances
listStackInstances_stackInstanceRegion :: Lens' ListStackInstances (Maybe Text)
listStackInstances_callAs :: Lens' ListStackInstances (Maybe CallAs)
listStackInstances_filters :: Lens' ListStackInstances (Maybe [StackInstanceFilter])
listStackInstances_nextToken :: Lens' ListStackInstances (Maybe Text)
listStackInstances_stackInstanceAccount :: Lens' ListStackInstances (Maybe Text)
listStackInstances_maxResults :: Lens' ListStackInstances (Maybe Natural)
listStackInstances_stackSetName :: Lens' ListStackInstances Text
data ListStackInstancesResponse = ListStackInstancesResponse' {
- nextToken :: Maybe Text
- summaries :: Maybe [StackInstanceSummary]
- httpStatus :: Int
}
newListStackInstancesResponse :: Int -> ListStackInstancesResponse
listStackInstancesResponse_nextToken :: Lens' ListStackInstancesResponse (Maybe Text)
listStackInstancesResponse_summaries :: Lens' ListStackInstancesResponse (Maybe [StackInstanceSummary])
listStackInstancesResponse_httpStatus :: Lens' ListStackInstancesResponse Int

Creating a Request

data ListStackInstances Source #

See: newListStackInstances smart constructor.

Constructors

ListStackInstances'

Fields

stackInstanceRegion :: Maybe Text
The name of the Region where you want to list stack instances.
callAs :: Maybe CallAs
Service-managed permissions
Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.
By default, SELF is specified. Use SELF for stack sets with self-managed permissions.
- If you are signed in to the management account, specify SELF.
- If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
  Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.
filters :: Maybe [StackInstanceFilter]
The status that stack instances are filtered by.
nextToken :: Maybe Text
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.
stackInstanceAccount :: Maybe Text
The name of the Amazon Web Services account that you want to list stack instances for.
maxResults :: Maybe Natural
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.
stackSetName :: Text
The name or unique ID of the stack set that you want to list stack instances for.

Instances

Instances details

Eq ListStackInstances Source #
Instance details Defined in Amazonka.CloudFormation.ListStackInstances Methods (==) :: ListStackInstances -> ListStackInstances -> Bool # (/=) :: ListStackInstances -> ListStackInstances -> Bool #
Read ListStackInstances Source #
Instance details Defined in Amazonka.CloudFormation.ListStackInstances Methods readsPrec :: Int -> ReadS ListStackInstances # readList :: ReadS [ListStackInstances] # readPrec :: ReadPrec ListStackInstances # readListPrec :: ReadPrec [ListStackInstances] #
Show ListStackInstances Source #
Instance details Defined in Amazonka.CloudFormation.ListStackInstances Methods showsPrec :: Int -> ListStackInstances -> ShowS # show :: ListStackInstances -> String # showList :: [ListStackInstances] -> ShowS #
Generic ListStackInstances Source #
Instance details Defined in Amazonka.CloudFormation.ListStackInstances Associated Types type Rep ListStackInstances :: Type -> Type # Methods from :: ListStackInstances -> Rep ListStackInstances x # to :: Rep ListStackInstances x -> ListStackInstances #
NFData ListStackInstances Source #
Instance details Defined in Amazonka.CloudFormation.ListStackInstances Methods rnf :: ListStackInstances -> () #
Hashable ListStackInstances Source #
Instance details Defined in Amazonka.CloudFormation.ListStackInstances Methods hashWithSalt :: Int -> ListStackInstances -> Int # hash :: ListStackInstances -> Int #
AWSPager ListStackInstances Source #
Instance details Defined in Amazonka.CloudFormation.ListStackInstances Methods page :: ListStackInstances -> AWSResponse ListStackInstances -> Maybe ListStackInstances #
AWSRequest ListStackInstances Source #
Instance details Defined in Amazonka.CloudFormation.ListStackInstances Associated Types type AWSResponse ListStackInstances # Methods request :: ListStackInstances -> Request ListStackInstances # response :: MonadResource m => Logger -> Service -> Proxy ListStackInstances -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListStackInstances))) #
ToHeaders ListStackInstances Source #
Instance details Defined in Amazonka.CloudFormation.ListStackInstances Methods toHeaders :: ListStackInstances -> [Header] #
ToPath ListStackInstances Source #
Instance details Defined in Amazonka.CloudFormation.ListStackInstances Methods toPath :: ListStackInstances -> ByteString #
ToQuery ListStackInstances Source #
Instance details Defined in Amazonka.CloudFormation.ListStackInstances Methods toQuery :: ListStackInstances -> QueryString #
type Rep ListStackInstances Source #
Instance details Defined in Amazonka.CloudFormation.ListStackInstances type Rep ListStackInstances = D1 ('MetaData "ListStackInstances" "Amazonka.CloudFormation.ListStackInstances" "libZSservicesZSamazonka-cloudformationZSamazonka-cloudformation" 'False) (C1 ('MetaCons "ListStackInstances'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "stackInstanceRegion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "callAs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CallAs)) :: S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [StackInstanceFilter])))) :: ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "stackInstanceAccount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "stackSetName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse ListStackInstances Source #
Instance details Defined in Amazonka.CloudFormation.ListStackInstances type AWSResponse ListStackInstances = ListStackInstancesResponse

newListStackInstances Source #

Arguments

:: Text	`$sel:stackSetName:ListStackInstances'`
-> ListStackInstances

Create a value of ListStackInstances 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:stackInstanceRegion:ListStackInstances', listStackInstances_stackInstanceRegion - The name of the Region where you want to list stack instances.

$sel:callAs:ListStackInstances', listStackInstances_callAs - [Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

If you are signed in to the management account, specify SELF.
If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

$sel:filters:ListStackInstances', listStackInstances_filters - The status that stack instances are filtered by.

$sel:nextToken:ListStackInstances', listStackInstances_nextToken - 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.

$sel:stackInstanceAccount:ListStackInstances', listStackInstances_stackInstanceAccount - The name of the Amazon Web Services account that you want to list stack instances for.

$sel:maxResults:ListStackInstances', listStackInstances_maxResults - 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.

$sel:stackSetName:ListStackInstances', listStackInstances_stackSetName - The name or unique ID of the stack set that you want to list stack instances for.

Request Lenses

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

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

listStackInstances_callAs :: Lens' ListStackInstances (Maybe CallAs) Source #

Service-managed permissions: Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

If you are signed in to the management account, specify SELF.
If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

listStackInstances_filters :: Lens' ListStackInstances (Maybe [StackInstanceFilter]) Source #

The status that stack instances are filtered by.

listStackInstances_nextToken :: 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.

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

The name of the Amazon Web Services account that you want to list stack instances for.

listStackInstances_maxResults :: 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.

listStackInstances_stackSetName :: Lens' ListStackInstances Text Source #

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

Destructuring the Response

data ListStackInstancesResponse Source #

See: newListStackInstancesResponse smart constructor.

Constructors

ListStackInstancesResponse'

Fields

nextToken :: Maybe Text
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.
summaries :: Maybe [StackInstanceSummary]
A list of StackInstanceSummary structures that contain information about the specified stack instances.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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

newListStackInstancesResponse Source #

Arguments

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

Create a value of ListStackInstancesResponse 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:nextToken:ListStackInstances', listStackInstancesResponse_nextToken - 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.

$sel:summaries:ListStackInstancesResponse', listStackInstancesResponse_summaries - A list of StackInstanceSummary structures that contain information about the specified stack instances.

$sel:httpStatus:ListStackInstancesResponse', listStackInstancesResponse_httpStatus - The response's http status code.

Response Lenses

listStackInstancesResponse_nextToken :: 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.

listStackInstancesResponse_summaries :: Lens' ListStackInstancesResponse (Maybe [StackInstanceSummary]) Source #

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

listStackInstancesResponse_httpStatus :: Lens' ListStackInstancesResponse Int Source #

The response's http status code.