Proton / Paginator / ListComponentOutputs

ListComponentOutputs

class Proton.Paginator.ListComponentOutputs

paginator = client.get_paginator('list_component_outputs')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• componentName (string) –

  [REQUIRED]

  The name of the component whose outputs you want.

• deploymentId (string) – The ID of the deployment whose outputs 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

{
    'outputs': [
        {
            'key': 'string',
            'valueString': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • outputs (list) –

    An array of component Infrastructure as Code (IaC) outputs.

    • (dict) –

      An infrastructure as code defined resource output.

      • key (string) –

        The output key.

      • valueString (string) –

        The output value.

  • NextToken (string) –

    A token to resume pagination.