ServiceCatalog / Client / list_stack_instances_for_provisioned_product

list_stack_instances_for_provisioned_product#

ServiceCatalog.Client.list_stack_instances_for_provisioned_product(**kwargs)#

Returns summary information about stack instances that are associated with the specified CFN_STACKSET type provisioned product. You can filter for stack instances that are associated with a specific Amazon Web Services account name or Region.

See also: AWS API Documentation

Request Syntax

response = client.list_stack_instances_for_provisioned_product(
    AcceptLanguage='string',
    ProvisionedProductId='string',
    PageToken='string',
    PageSize=123
)
Parameters:

  • AcceptLanguage (string) –

    The language code.

    • jp - Japanese

    • zh - Chinese

  • ProvisionedProductId (string) –

    [REQUIRED]

    The identifier of the provisioned product.

  • PageToken (string) – The page token for the next set of results. To retrieve the first set of results, use null.

  • PageSize (integer) – The maximum number of items to return with this call.

Return type:

dict

Returns:

Response Syntax

{
    'StackInstances': [
        {
            'Account': 'string',
            'Region': 'string',
            'StackInstanceStatus': 'CURRENT'|'OUTDATED'|'INOPERABLE'
        },
    ],
    'NextPageToken': 'string'
}

Response Structure

  • (dict) –

    • StackInstances (list) –

      List of stack instances.

      • (dict) –

        An CloudFormation stack, in a specific account and Region, that’s part of a stack set operation. A stack instance is a reference to an attempted or actual stack in a given account within a given Region. A stack instance can exist without a stack—for example, if the stack couldn’t be created for some reason. A stack instance is associated with only one stack set. Each stack instance contains the ID of its associated stack set, as well as the ID of the actual stack and the stack status.

        • Account (string) –

          The name of the Amazon Web Services account that the stack instance is associated with.

        • Region (string) –

          The name of the Amazon Web Services Region that the stack instance is associated with.

        • StackInstanceStatus (string) –

          The status of the stack instance, in terms of its synchronization with its associated stack set.

          • INOPERABLE: A DeleteStackInstances operation has failed and left the stack in an unstable state. Stacks in this state are excluded from further UpdateStackSet operations. You might need to perform a DeleteStackInstances operation, with RetainStacks set to true, to delete the stack instance, and then delete the stack manually.

          • OUTDATED: The stack isn’t currently up to date with the stack set because either the associated stack failed during a CreateStackSet or UpdateStackSet operation, or the stack was part of a CreateStackSet or UpdateStackSet operation that failed or was stopped before the stack was created or updated.

          • CURRENT: The stack is currently up to date with the stack set.

    • NextPageToken (string) –

      The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

Exceptions

  • ServiceCatalog.Client.exceptions.InvalidParametersException

  • ServiceCatalog.Client.exceptions.ResourceNotFoundException