CloudFormation / Client / list_stack_set_auto_deployment_targets

list_stack_set_auto_deployment_targets#

CloudFormation.Client.list_stack_set_auto_deployment_targets(**kwargs)#

Returns summary information about deployment targets for a stack set.

See also: AWS API Documentation

Request Syntax

response = client.list_stack_set_auto_deployment_targets(
    StackSetName='string',
    NextToken='string',
    MaxResults=123,
    CallAs='SELF'|'DELEGATED_ADMIN'
)
Parameters:

  • StackSetName (string) –

    [REQUIRED]

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

  • NextToken (string) – A string that identifies the next page of stack set deployment targets that you want to retrieve.

  • MaxResults (integer) – 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 (string) –

    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.

Return type:

dict

Returns:

Response Syntax

{
    'Summaries': [
        {
            'OrganizationalUnitId': 'string',
            'Regions': [
                'string',
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • Summaries (list) –

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

      • (dict) –

        One of the targets for the stack set. Returned by the ListStackSetAutoDeploymentTargets API operation.

        • OrganizationalUnitId (string) –

          The organization root ID or organizational unit (OU) IDs where the stack set is targeted.

        • Regions (list) –

          The list of Regions targeted for this organization or OU.

          • (string) –

    • NextToken (string) –

      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.

Exceptions