ServiceCatalog / Paginator / ListLaunchPaths

ListLaunchPaths#

class ServiceCatalog.Paginator.ListLaunchPaths#
paginator = client.get_paginator('list_launch_paths')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from ServiceCatalog.Client.list_launch_paths().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    AcceptLanguage='string',
    ProductId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:
  • AcceptLanguage (string) –

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

  • ProductId (string) –

    [REQUIRED]

    The product identifier.

  • 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.

    • PageSize (integer) –

      The size of each page.

    • StartingToken (string) –

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

Return type:

dict

Returns:

Response Syntax

{
    'LaunchPathSummaries': [
        {
            'Id': 'string',
            'ConstraintSummaries': [
                {
                    'Type': 'string',
                    'Description': 'string'
                },
            ],
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'Name': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • LaunchPathSummaries (list) –

      Information about the launch path.

      • (dict) –

        Summary information about a product path for a user.

        • Id (string) –

          The identifier of the product path.

        • ConstraintSummaries (list) –

          The constraints on the portfolio-product relationship.

          • (dict) –

            Summary information about a constraint.

            • Type (string) –

              The type of constraint.

              • LAUNCH

              • NOTIFICATION

              • STACKSET

              • TEMPLATE

            • Description (string) –

              The description of the constraint.

        • Tags (list) –

          The tags associated with this product path.

          • (dict) –

            Information about a tag. A tag is a key-value pair. Tags are propagated to the resources created when provisioning a product.

            • Key (string) –

              The tag key.

            • Value (string) –

              The value for this key.

        • Name (string) –

          The name of the portfolio that contains the product.

    • NextToken (string) –

      A token to resume pagination.