Returns summary information about the results of a StackSet operation¶

Description¶

Returns summary information about the results of a StackSet operation.

This API provides eventually consistent reads meaning it may take some time but will eventually return the most up-to-date data.

Usage¶

cloudformation_list_stack_set_operation_results(StackSetName,
  OperationId, NextToken, MaxResults, CallAs, Filters)

Arguments¶

• StackSetName

  [required] The name or unique ID of the StackSet that you want to get operation results for.

• OperationId

  [required] The ID of the StackSet operation.

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

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

• Filters

  The filter to apply to operation results.

Value¶

A list with the following syntax:

list(
  Summaries = list(
    list(
      Account = "string",
      Region = "string",
      Status = "PENDING"|"RUNNING"|"SUCCEEDED"|"FAILED"|"CANCELLED",
      StatusReason = "string",
      AccountGateResult = list(
        Status = "SUCCEEDED"|"FAILED"|"SKIPPED",
        StatusReason = "string"
      ),
      OrganizationalUnitId = "string"
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$list_stack_set_operation_results(
  StackSetName = "string",
  OperationId = "string",
  NextToken = "string",
  MaxResults = 123,
  CallAs = "SELF"|"DELEGATED_ADMIN",
  Filters = list(
    list(
      Name = "OPERATION_RESULT_STATUS",
      Values = "string"
    )
  )
)