SearchListings
Searches listings (records of an asset at a given time) in Amazon DataZone.
Request Syntax
POST /v2/domains/domainIdentifier/listings/search HTTP/1.1
Content-type: application/json
{
"additionalAttributes": [ "string" ],
"filters": { ... },
"maxResults": number,
"nextToken": "string",
"searchIn": [
{
"attribute": "string"
}
],
"searchText": "string",
"sort": {
"attribute": "string",
"order": "string"
}
}URI Request Parameters
The request uses the following URI parameters.
- domainIdentifier
-
The identifier of the domain in which to search listings.
Pattern:
^dzd[-_][a-zA-Z0-9_-]{1,36}$Required: Yes
Request Body
The request accepts the following data in JSON format.
- additionalAttributes
-
Specifies additional attributes for the search.
Type: Array of strings
Valid Values:
FORMS | TIME_SERIES_DATA_POINT_FORMSRequired: No
- filters
-
Specifies the filters for the search of listings.
Type: FilterClause object
Note: This object is a Union. Only one member of this object can be specified or returned.
Required: No
- maxResults
-
The maximum number of results to return in a single call to
SearchListings. When the number of results to be listed is greater than the value ofMaxResults, the response contains aNextTokenvalue that you can use in a subsequent call toSearchListingsto list the next set of results.Type: Integer
Valid Range: Minimum value of 1. Maximum value of 50.
Required: No
- nextToken
-
When the number of results is greater than the default value for the
MaxResultsparameter, or if you explicitly specify a value forMaxResultsthat is less than the number of results, the response includes a pagination token namedNextToken. You can specify thisNextTokenvalue in a subsequent call toSearchListingsto list the next set of results.Type: String
Length Constraints: Minimum length of 1. Maximum length of 8192.
Required: No
- searchIn
-
The details of the search.
Type: Array of SearchInItem objects
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Required: No
- searchText
-
Specifies the text for which to search.
Type: String
Required: No
- sort
-
Specifies the way for sorting the search results.
Type: SearchSort object
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"items": [
{ ... }
],
"nextToken": "string",
"totalMatchCount": number
}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.
- items
-
The results of the
SearchListingsaction.Type: Array of SearchResultItem objects
- nextToken
-
When the number of results is greater than the default value for the
MaxResultsparameter, or if you explicitly specify a value forMaxResultsthat is less than the number of results, the response includes a pagination token namedNextToken. You can specify thisNextTokenvalue in a subsequent call toSearchListingsto list the next set of results.Type: String
Length Constraints: Minimum length of 1. Maximum length of 8192.
- totalMatchCount
-
Total number of search results.
Type: Integer
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have sufficient access to perform this action.
HTTP Status Code: 403
- InternalServerException
-
The request has failed because of an unknown error, exception or failure.
HTTP Status Code: 500
- ThrottlingException
-
The request was denied due to request throttling.
HTTP Status Code: 429
- UnauthorizedException
-
You do not have permission to perform this action.
HTTP Status Code: 401
- ValidationException
-
The input fails to satisfy the constraints specified by the AWS service.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
