ServiceCatalog / Paginator / ListProvisionedProductPlans

ListProvisionedProductPlans

class ServiceCatalog.Paginator.ListProvisionedProductPlans

paginator = client.get_paginator('list_provisioned_product_plans')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    AcceptLanguage='string',
    ProvisionProductId='string',
    AccessLevelFilter={
        'Key': 'Account'|'Role'|'User',
        'Value': 'string'
    },
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• AcceptLanguage (string) –

  The language code.

  • jp - Japanese

  • zh - Chinese

• ProvisionProductId (string) – The product identifier.

• AccessLevelFilter (dict) –

  The access level to use to obtain results. The default is User.

  • Key (string) –

    The access level.

    • Account - Filter results based on the account.

    • Role - Filter results based on the federated role of the specified user.

    • User - Filter results based on the specified user.

  • Value (string) –

    The user to which the access level applies. The only supported value is self.

• 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

{
    'ProvisionedProductPlans': [
        {
            'PlanName': 'string',
            'PlanId': 'string',
            'ProvisionProductId': 'string',
            'ProvisionProductName': 'string',
            'PlanType': 'CLOUDFORMATION',
            'ProvisioningArtifactId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • ProvisionedProductPlans (list) –

    Information about the plans.

    • (dict) –

      Summary information about a plan.

      • PlanName (string) –

        The name of the plan.

      • PlanId (string) –

        The plan identifier.

      • ProvisionProductId (string) –

        The product identifier.

      • ProvisionProductName (string) –

        The user-friendly name of the provisioned product.

      • PlanType (string) –

        The plan type.

      • ProvisioningArtifactId (string) –

        The identifier of the provisioning artifact.

  • NextToken (string) –

    A token to resume pagination.