ServiceCatalog / Client / list_provisioned_product_plans

list_provisioned_product_plans#

ServiceCatalog.Client.list_provisioned_product_plans(**kwargs)#

Lists the plans for the specified provisioned product or all plans to which the user has access.

See also: AWS API Documentation

Request Syntax

response = client.list_provisioned_product_plans(
    AcceptLanguage='string',
    ProvisionProductId='string',
    PageSize=123,
    PageToken='string',
    AccessLevelFilter={
        'Key': 'Account'|'Role'|'User',
        'Value': 'string'
    }
)
Parameters:

  • AcceptLanguage (string) –

    The language code.

    • jp - Japanese

    • zh - Chinese

  • ProvisionProductId (string) – The product identifier.

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

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

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

Return type:

dict

Returns:

Response Syntax

{
    'ProvisionedProductPlans': [
        {
            'PlanName': 'string',
            'PlanId': 'string',
            'ProvisionProductId': 'string',
            'ProvisionProductName': 'string',
            'PlanType': 'CLOUDFORMATION',
            'ProvisioningArtifactId': 'string'
        },
    ],
    'NextPageToken': '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.

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

  • ServiceCatalog.Client.exceptions.InvalidParametersException