ListComponentProvisionedResources

class Proton.Paginator.ListComponentProvisionedResources

paginator = client.get_paginator('list_component_provisioned_resources')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Proton.Client.list_component_provisioned_resources().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    componentName='string',
    PaginationConfig={
        'MaxItems': 123,
        'StartingToken': 'string'
    }
)

Parameters

• componentName (string) --

  [REQUIRED]

  The name of the component whose provisioned resources you want.

• PaginationConfig (dict) --

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) --

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • StartingToken (string) --

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'provisionedResources': [
        {
            'identifier': 'string',
            'name': 'string',
            'provisioningEngine': 'CLOUDFORMATION'|'TERRAFORM'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • provisionedResources (list) --

    An array of provisioned resources for a component.

    • (dict) --

      Detail data for a provisioned resource.

      • identifier (string) --

        The provisioned resource identifier.

      • name (string) --

        The provisioned resource name.

      • provisioningEngine (string) --

        The resource provisioning engine. At this time, CLOUDFORMATION can be used for Amazon Web Services-managed provisioning, and TERRAFORM can be used for self-managed provisioning.

        For more information, see Self-managed provisioning in the Proton User Guide .

  • NextToken (string) --

    A token to resume pagination.