Skip to content

List Stack Sets

cloudformation_list_stack_sets R Documentation

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

Description

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, list_stack_sets 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, list_stack_sets 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, list_stack_sets returns all stack sets with service-managed permissions in the management account.

Usage

cloudformation_list_stack_sets(NextToken, MaxResults, Status, CallAs)

Arguments

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

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.

Status

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

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.

Value

A list with the following syntax: 

list(
  Summaries = list(
    list(
      StackSetName = "string",
      StackSetId = "string",
      Description = "string",
      Status = "ACTIVE"|"DELETED",
      AutoDeployment = list(
        Enabled = TRUE|FALSE,
        RetainStacksOnAccountRemoval = TRUE|FALSE
      ),
      PermissionModel = "SERVICE_MANAGED"|"SELF_MANAGED",
      DriftStatus = "DRIFTED"|"IN_SYNC"|"UNKNOWN"|"NOT_CHECKED",
      LastDriftCheckTimestamp = as.POSIXct(
        "2015-01-01"
      ),
      ManagedExecution = list(
        Active = TRUE|FALSE
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_stack_sets(
  NextToken = "string",
  MaxResults = 123,
  Status = "ACTIVE"|"DELETED",
  CallAs = "SELF"|"DELEGATED_ADMIN"
)