ServiceCatalog / Client / list_provisioning_artifacts_for_service_action

list_provisioning_artifacts_for_service_action#

ServiceCatalog.Client.list_provisioning_artifacts_for_service_action(**kwargs)#

Lists all provisioning artifacts (also known as versions) for the specified self-service action.

See also: AWS API Documentation

Request Syntax

response = client.list_provisioning_artifacts_for_service_action(
    ServiceActionId='string',
    PageSize=123,
    PageToken='string',
    AcceptLanguage='string'
)
Parameters:
  • ServiceActionId (string) –

    [REQUIRED]

    The self-service action identifier. For example, act-fs7abcd89wxyz.

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

  • AcceptLanguage (string) –

    The language code.

    • jp - Japanese

    • zh - Chinese

Return type:

dict

Returns:

Response Syntax

{
    'ProvisioningArtifactViews': [
        {
            'ProductViewSummary': {
                'Id': 'string',
                'ProductId': 'string',
                'Name': 'string',
                'Owner': 'string',
                'ShortDescription': 'string',
                'Type': 'CLOUD_FORMATION_TEMPLATE'|'MARKETPLACE'|'TERRAFORM_OPEN_SOURCE'|'TERRAFORM_CLOUD'|'EXTERNAL',
                'Distributor': 'string',
                'HasDefaultPath': True|False,
                'SupportEmail': 'string',
                'SupportDescription': 'string',
                'SupportUrl': 'string'
            },
            'ProvisioningArtifact': {
                'Id': 'string',
                'Name': 'string',
                'Description': 'string',
                'CreatedTime': datetime(2015, 1, 1),
                'Guidance': 'DEFAULT'|'DEPRECATED'
            }
        },
    ],
    'NextPageToken': 'string'
}

Response Structure

  • (dict) –

    • ProvisioningArtifactViews (list) –

      An array of objects with information about product views and provisioning artifacts.

      • (dict) –

        An object that contains summary information about a product view and a provisioning artifact.

        • ProductViewSummary (dict) –

          Summary information about a product view.

          • Id (string) –

            The product view identifier.

          • ProductId (string) –

            The product identifier.

          • Name (string) –

            The name of the product.

          • Owner (string) –

            The owner of the product. Contact the product administrator for the significance of this value.

          • ShortDescription (string) –

            Short description of the product.

          • Type (string) –

            The product type. Contact the product administrator for the significance of this value. If this value is MARKETPLACE, the product was created by Amazon Web Services Marketplace.

          • Distributor (string) –

            The distributor of the product. Contact the product administrator for the significance of this value.

          • HasDefaultPath (boolean) –

            Indicates whether the product has a default path. If the product does not have a default path, call ListLaunchPaths to disambiguate between paths. Otherwise, ListLaunchPaths is not required, and the output of ProductViewSummary can be used directly with DescribeProvisioningParameters.

          • SupportEmail (string) –

            The email contact information to obtain support for this Product.

          • SupportDescription (string) –

            The description of the support for this Product.

          • SupportUrl (string) –

            The URL information to obtain support for this Product.

        • ProvisioningArtifact (dict) –

          Information about a provisioning artifact. A provisioning artifact is also known as a product version.

          • Id (string) –

            The identifier of the provisioning artifact.

          • Name (string) –

            The name of the provisioning artifact.

          • Description (string) –

            The description of the provisioning artifact.

          • CreatedTime (datetime) –

            The UTC time stamp of the creation time.

          • Guidance (string) –

            Information set by the administrator to provide guidance to end users about which provisioning artifacts to use.

    • 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