Amazonka.CloudFormation.ListStackSets

Returns summary information about stack sets that are associated with the user.

• [Self-managed permissions] If you set the CallAs parameter to SELF while signed in to your Amazon Web Services account, ListStackSets returns all self-managed stack sets in your Amazon Web Services account.
• [Service-managed permissions] If you set the CallAs parameter to SELF while signed in to the organization's management account, ListStackSets returns all stack sets in the management account.
• [Service-managed permissions] If you set the CallAs parameter to DELEGATED_ADMIN while signed in to your member account, ListStackSets returns all stack sets with service-managed permissions in the management account.

This operation returns paginated results.

Creating a Request

data ListStackSets

See: newListStackSets smart constructor.

Constructors

ListStackSets'

Fields

• callAs :: Maybe CallAs

  Service-managed permissions

  Specifies whether you are acting as an account administrator in the 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.

• 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 paginated request didn't return all the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call ListStackSets 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.

• status :: Maybe StackSetStatus

  The status of the stack sets that you want to get summary information about.

Instances

ToHeaders ListStackSets

Defined in Amazonka.CloudFormation.ListStackSets

Methods

toHeaders :: ListStackSets -> [Header]

ToPath ListStackSets

Defined in Amazonka.CloudFormation.ListStackSets

Methods

toPath :: ListStackSets -> ByteString

ToQuery ListStackSets

Defined in Amazonka.CloudFormation.ListStackSets

Methods

toQuery :: ListStackSets -> QueryString

AWSPager ListStackSets

Defined in Amazonka.CloudFormation.ListStackSets

Methods

page :: ListStackSets -> AWSResponse ListStackSets -> Maybe ListStackSets

AWSRequest ListStackSets

Defined in Amazonka.CloudFormation.ListStackSets

Associated Types

type AWSResponse ListStackSets

Methods

request :: (Service -> Service) -> ListStackSets -> Request ListStackSets

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

Generic ListStackSets

Defined in Amazonka.CloudFormation.ListStackSets

Associated Types

type Rep ListStackSets :: Type -> Type

Methods

from :: ListStackSets -> Rep ListStackSets x

to :: Rep ListStackSets x -> ListStackSets

Read ListStackSets

Defined in Amazonka.CloudFormation.ListStackSets

Methods

readsPrec :: Int -> ReadS ListStackSets

readList :: ReadS [ListStackSets]

readPrec :: ReadPrec ListStackSets

readListPrec :: ReadPrec [ListStackSets]

Show ListStackSets

Defined in Amazonka.CloudFormation.ListStackSets

Methods

showsPrec :: Int -> ListStackSets -> ShowS

show :: ListStackSets -> String

showList :: [ListStackSets] -> ShowS

NFData ListStackSets

Defined in Amazonka.CloudFormation.ListStackSets

Methods

rnf :: ListStackSets -> ()

Eq ListStackSets

Defined in Amazonka.CloudFormation.ListStackSets

Methods

(==) :: ListStackSets -> ListStackSets -> Bool

(/=) :: ListStackSets -> ListStackSets -> Bool

Hashable ListStackSets

Defined in Amazonka.CloudFormation.ListStackSets

Methods

hashWithSalt :: Int -> ListStackSets -> Int

hash :: ListStackSets -> Int

type AWSResponse ListStackSets

Defined in Amazonka.CloudFormation.ListStackSets

type AWSResponse ListStackSets = ListStackSetsResponse

type Rep ListStackSets

Defined in Amazonka.CloudFormation.ListStackSets

type Rep ListStackSets = D1 ('MetaData "ListStackSets" "Amazonka.CloudFormation.ListStackSets" "amazonka-cloudformation-2.0-2g2oPzedi5AcwbDRlNZfB" 'False) (C1 ('MetaCons "ListStackSets'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "callAs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CallAs)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StackSetStatus)))))

newListStackSets :: ListStackSets

Create a value of ListStackSets 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:ListStackSets', listStackSets_callAs - [Service-managed permissions] Specifies whether you are acting as an account administrator in the 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:maxResults:ListStackSets', listStackSets_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.

ListStackSets, listStackSets_nextToken - If the previous paginated request didn't return all the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call ListStackSets 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.

ListStackSets, listStackSets_status - The status of the stack sets that you want to get summary information about.

Request Lenses

listStackSets_callAs :: Lens' ListStackSets (Maybe CallAs)

Service-managed permissions

Specifies whether you are acting as an account administrator in the 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.

listStackSets_maxResults :: Lens' ListStackSets (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.

listStackSets_nextToken :: Lens' ListStackSets (Maybe Text)

If the previous paginated request didn't return all the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call ListStackSets 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.

listStackSets_status :: Lens' ListStackSets (Maybe StackSetStatus)

The status of the stack sets that you want to get summary information about.

Destructuring the Response

data ListStackSetsResponse

See: newListStackSetsResponse smart constructor.

Constructors

ListStackSetsResponse'

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 [StackSetSummary]

  A list of StackSetSummary structures that contain information about the user's stack sets.

• httpStatus :: Int

  The response's http status code.

Instances

Generic ListStackSetsResponse

Defined in Amazonka.CloudFormation.ListStackSets

Associated Types

type Rep ListStackSetsResponse :: Type -> Type

Methods

from :: ListStackSetsResponse -> Rep ListStackSetsResponse x

to :: Rep ListStackSetsResponse x -> ListStackSetsResponse

Read ListStackSetsResponse

Defined in Amazonka.CloudFormation.ListStackSets

Methods

readsPrec :: Int -> ReadS ListStackSetsResponse

readList :: ReadS [ListStackSetsResponse]

readPrec :: ReadPrec ListStackSetsResponse

readListPrec :: ReadPrec [ListStackSetsResponse]

Show ListStackSetsResponse

Defined in Amazonka.CloudFormation.ListStackSets

Methods

showsPrec :: Int -> ListStackSetsResponse -> ShowS

show :: ListStackSetsResponse -> String

showList :: [ListStackSetsResponse] -> ShowS

NFData ListStackSetsResponse

Defined in Amazonka.CloudFormation.ListStackSets

Methods

rnf :: ListStackSetsResponse -> ()

Eq ListStackSetsResponse

Defined in Amazonka.CloudFormation.ListStackSets

Methods

(==) :: ListStackSetsResponse -> ListStackSetsResponse -> Bool

(/=) :: ListStackSetsResponse -> ListStackSetsResponse -> Bool

type Rep ListStackSetsResponse

Defined in Amazonka.CloudFormation.ListStackSets

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

newListStackSetsResponse

Arguments

:: Int

$sel:httpStatus:ListStackSetsResponse'

-> ListStackSetsResponse

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

ListStackSets, listStackSetsResponse_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:ListStackSetsResponse', listStackSetsResponse_summaries - A list of StackSetSummary structures that contain information about the user's stack sets.

$sel:httpStatus:ListStackSetsResponse', listStackSetsResponse_httpStatus - The response's http status code.

Response Lenses

listStackSetsResponse_nextToken :: Lens' ListStackSetsResponse (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.

listStackSetsResponse_summaries :: Lens' ListStackSetsResponse (Maybe [StackSetSummary])

A list of StackSetSummary structures that contain information about the user's stack sets.

listStackSetsResponse_httpStatus :: Lens' ListStackSetsResponse Int

The response's http status code.