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

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

Creating a Request

data ListStackInstances Source #

See: newListStackInstances smart constructor.

Constructors

ListStackInstances' 

Fields

  • 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 filter to apply to stack instances

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

  • nextToken :: Maybe Text

    If the previous request didn't return all 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.

  • stackInstanceRegion :: Maybe Text

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

  • stackSetName :: Text

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

Instances

Instances details
ToHeaders ListStackInstances Source # 
Instance details

Defined in Amazonka.CloudFormation.ListStackInstances

ToPath ListStackInstances Source # 
Instance details

Defined in Amazonka.CloudFormation.ListStackInstances

ToQuery ListStackInstances Source # 
Instance details

Defined in Amazonka.CloudFormation.ListStackInstances

AWSPager ListStackInstances Source # 
Instance details

Defined in Amazonka.CloudFormation.ListStackInstances

AWSRequest ListStackInstances Source # 
Instance details

Defined in Amazonka.CloudFormation.ListStackInstances

Associated Types

type AWSResponse ListStackInstances #

Generic ListStackInstances Source # 
Instance details

Defined in Amazonka.CloudFormation.ListStackInstances

Associated Types

type Rep ListStackInstances :: Type -> Type #

Read ListStackInstances Source # 
Instance details

Defined in Amazonka.CloudFormation.ListStackInstances

Show ListStackInstances Source # 
Instance details

Defined in Amazonka.CloudFormation.ListStackInstances

NFData ListStackInstances Source # 
Instance details

Defined in Amazonka.CloudFormation.ListStackInstances

Methods

rnf :: ListStackInstances -> () #

Eq ListStackInstances Source # 
Instance details

Defined in Amazonka.CloudFormation.ListStackInstances

Hashable ListStackInstances Source # 
Instance details

Defined in Amazonka.CloudFormation.ListStackInstances

type AWSResponse ListStackInstances Source # 
Instance details

Defined in Amazonka.CloudFormation.ListStackInstances

type Rep ListStackInstances Source # 
Instance details

Defined in Amazonka.CloudFormation.ListStackInstances

type Rep ListStackInstances = D1 ('MetaData "ListStackInstances" "Amazonka.CloudFormation.ListStackInstances" "amazonka-cloudformation-2.0-2g2oPzedi5AcwbDRlNZfB" 'False) (C1 ('MetaCons "ListStackInstances'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "callAs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CallAs)) :*: (S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [StackInstanceFilter])) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))) :*: ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "stackInstanceAccount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "stackInstanceRegion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "stackSetName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newListStackInstances Source #

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: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 filter to apply to stack instances

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

ListStackInstances, listStackInstances_nextToken - If the previous request didn't return all 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:stackInstanceRegion:ListStackInstances', listStackInstances_stackInstanceRegion - The name of the Region where you want to list stack instances.

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

Request Lenses

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_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_nextToken :: Lens' ListStackInstances (Maybe Text) Source #

If the previous request didn't return all 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_stackInstanceRegion :: Lens' ListStackInstances (Maybe Text) Source #

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

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 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
Generic ListStackInstancesResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.ListStackInstances

Associated Types

type Rep ListStackInstancesResponse :: Type -> Type #

Read ListStackInstancesResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.ListStackInstances

Show ListStackInstancesResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.ListStackInstances

NFData ListStackInstancesResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.ListStackInstances

Eq ListStackInstancesResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.ListStackInstances

type Rep ListStackInstancesResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.ListStackInstances

type Rep ListStackInstancesResponse = D1 ('MetaData "ListStackInstancesResponse" "Amazonka.CloudFormation.ListStackInstances" "amazonka-cloudformation-2.0-2g2oPzedi5AcwbDRlNZfB" '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 #

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:

ListStackInstances, listStackInstancesResponse_nextToken - If the request doesn't return all 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 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.