Menu
AWS Service Catalog
Developer Guide

SearchProductsAsAdmin

Gets information about the products for the specified portfolio or all products.

Request Syntax

{
   "AcceptLanguage": "string",
   "Filters": { 
      "string" : [ "string" ]
   },
   "PageSize": number,
   "PageToken": "string",
   "PortfolioId": "string",
   "ProductSource": "string",
   "SortBy": "string",
   "SortOrder": "string"
}

Request Parameters

The request accepts the following data in JSON format.

AcceptLanguage

The language code.

  • en - English (default)

  • jp - Japanese

  • zh - Chinese

Type: String

Required: No

Filters

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

Type: String to array of strings map

Valid Keys: FullTextSearch | Owner | ProductType | SourceProductId

Required: No

PageSize

The maximum number of items to return with this call.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 20.

Required: No

PageToken

The page token for the next set of results. To retrieve the first set of results, use null.

Type: String

Pattern: [\u0009\u000a\u000d\u0020-\uD7FF\uE000-\uFFFD]*

Required: No

PortfolioId

The portfolio identifier.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Required: No

ProductSource

Access level of the source of the product.

Type: String

Valid Values: ACCOUNT

Required: No

SortBy

The sort field. If no value is specified, the results are not sorted.

Type: String

Valid Values: Title | VersionCount | CreationDate

Required: No

SortOrder

The sort order. If no value is specified, the results are not sorted.

Type: String

Valid Values: ASCENDING | DESCENDING

Required: No

Response Syntax

{
   "NextPageToken": "string",
   "ProductViewDetails": [ 
      { 
         "CreatedTime": number,
         "ProductARN": "string",
         "ProductViewSummary": { 
            "Distributor": "string",
            "HasDefaultPath": boolean,
            "Id": "string",
            "Name": "string",
            "Owner": "string",
            "ProductId": "string",
            "ShortDescription": "string",
            "SupportDescription": "string",
            "SupportEmail": "string",
            "SupportUrl": "string",
            "Type": "string"
         },
         "Status": "string"
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NextPageToken

The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

Type: String

Pattern: [\u0009\u000a\u000d\u0020-\uD7FF\uE000-\uFFFD]*

ProductViewDetails

Information about the product views.

Type: Array of ProductViewDetail objects

Errors

InvalidParametersException

One or more parameters provided to the operation are not valid.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: