paws.management: cloudformation_list_stack_instances – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

cloudformation_list_stack_instances

Returns summary information about stack instances that are associated with the specified stack set

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

Usage

cloudformation_list_stack_instances(StackSetName, NextToken, MaxResults,
  Filters, StackInstanceAccount, StackInstanceRegion)

Arguments

`StackSetName`	[required] The name or unique ID of the stack set that you want to list stack instances for.
`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 `list_stack_instances` 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.
`Filters`	The status that stack instances are filtered by.
`StackInstanceAccount`	The name of the AWS account that you want to list stack instances for.
`StackInstanceRegion`	The name of the Region where you want to list stack instances.

Value

A list with the following syntax:

list(
  Summaries = list(
    list(
      StackSetId = "string",
      Region = "string",
      Account = "string",
      StackId = "string",
      Status = "CURRENT"|"OUTDATED"|"INOPERABLE",
      StatusReason = "string",
      StackInstanceStatus = list(
        DetailedStatus = "PENDING"|"RUNNING"|"SUCCEEDED"|"FAILED"|"CANCELLED"|"INOPERABLE"
      ),
      OrganizationalUnitId = "string",
      DriftStatus = "DRIFTED"|"IN_SYNC"|"UNKNOWN"|"NOT_CHECKED",
      LastDriftCheckTimestamp = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_stack_instances(
  StackSetName = "string",
  NextToken = "string",
  MaxResults = 123,
  Filters = list(
    list(
      Name = "DETAILED_STATUS",
      Values = "string"
    )
  ),
  StackInstanceAccount = "string",
  StackInstanceRegion = "string"
)

paws.management

Amazon Web Services Management & Governance Services

v0.1.11

Apache License (>= 2.0)

Authors

David Kretch [aut, cre], Adam Banker [aut], Amazon.com, Inc. [cph]

Initial release