Returns summary information about StackSets that are associated with the user¶

Description¶

Returns summary information about StackSets that are associated with the user.

This API provides strongly consistent reads meaning it will always return the most up-to-date data.

• [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 StackSets 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 StackSets 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 StackSets with service-managed permissions in the management account.

Usage¶

cloudformation_list_stack_sets(NextToken, MaxResults, Status, CallAs)

Arguments¶

• NextToken

  The token for the next set of items to return. (You received this token from a previous call.)

• 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 StackSets 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 StackSets 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,
        DependsOn = list(
          "string"
        )
      ),
      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"
)