ServiceCatalog / Client / search_products

search_products#

ServiceCatalog.Client.search_products(**kwargs)#

Gets information about the products to which the caller has access.

See also: AWS API Documentation

Request Syntax

response = client.search_products(
    AcceptLanguage='string',
    Filters={
        'string': [
            'string',
        ]
    },
    PageSize=123,
    SortBy='Title'|'VersionCount'|'CreationDate',
    SortOrder='ASCENDING'|'DESCENDING',
    PageToken='string'
)
Parameters:
  • AcceptLanguage (string) –

    The language code.

    • jp - Japanese

    • zh - Chinese

  • Filters (dict) –

    The search filters. If no search filters are specified, the output includes all products to which the caller has access.

    • (string) –

      • (list) –

        • (string) –

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

  • SortBy (string) – The sort field. If no value is specified, the results are not sorted.

  • SortOrder (string) – The sort order. If no value is specified, the results are not sorted.

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

Return type:

dict

Returns:

Response Syntax

{
    'ProductViewSummaries': [
        {
            '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'
        },
    ],
    'ProductViewAggregations': {
        'string': [
            {
                'Value': 'string',
                'ApproximateCount': 123
            },
        ]
    },
    'NextPageToken': 'string'
}

Response Structure

  • (dict) –

    • ProductViewSummaries (list) –

      Information about the product views.

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

    • ProductViewAggregations (dict) –

      The product view aggregations.

      • (string) –

        • (list) –

          • (dict) –

            A single product view aggregation value/count pair, containing metadata about each product to which the calling user has access.

            • Value (string) –

              The value of the product view aggregation.

            • ApproximateCount (integer) –

              An approximate count of the products that match the value.

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