ListStackSetAutoDeploymentTargets - AWS CloudFormation

ListStackSetAutoDeploymentTargets

Returns summary information about deployment targets for a stack set.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

CallAs

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 AWS account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the AWS CloudFormation User Guide.

Type: String

Valid Values: SELF | DELEGATED_ADMIN

Required: No

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.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

NextToken

A string that identifies the next page of stack set deployment targets that you want to retrieve.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: No

StackSetName

The name or unique ID of the stack set that you want to get automatic deployment targets for.

Type: String

Pattern: [a-zA-Z][-a-zA-Z0-9]*(?::[a-zA-Z0-9]{8}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{12})?

Required: Yes

Response Elements

The following elements are returned by the service.

NextToken

If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve the next set of results, call ListStackSetAutoDeploymentTargets again and use that value for the NextToken parameter. If the request returns all results, NextToken is set to an empty string.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Summaries.member.N

An array of summaries of the deployment targets for the stack set.

Type: Array of StackSetAutoDeploymentTargetSummary objects

Errors

For information about the errors that are common to all actions, see Common Errors.

StackSetNotFound

The specified stack set doesn't exist.

HTTP Status Code: 404

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: