ListEntities
Provides the list of entities of a given type.
Request Syntax
POST /ListEntities HTTP/1.1
Content-type: application/json
{
"Catalog": "string
",
"EntityType": "string
",
"FilterList": [
{
"Name": "string
",
"ValueList": [ "string
" ]
}
],
"MaxResults": number
,
"NextToken": "string
",
"Sort": {
"SortBy": "string
",
"SortOrder": "string
"
}
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- Catalog
-
The catalog related to the request. Fixed value:
AWSMarketplace
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
^[a-zA-Z]+$
Required: Yes
- EntityType
-
The type of entities to retrieve.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
^[a-zA-Z]+$
Required: Yes
- FilterList
-
An array of filter objects. Each filter object contains two attributes,
filterName
andfilterValues
.Type: Array of Filter objects
Array Members: Minimum number of 1 item. Maximum number of 8 items.
Required: No
- MaxResults
-
Specifies the upper limit of the elements on a single page. If a value isn't provided, the default value is 20.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 20.
Required: No
- NextToken
-
The value of the next token, if it exists. Null if there are no more results.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
^[\w+=.:@\-\/]$
Required: No
- Sort
-
An object that contains two attributes,
SortBy
andSortOrder
.Type: Sort object
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"EntitySummaryList": [
{
"EntityArn": "string",
"EntityId": "string",
"EntityType": "string",
"LastModifiedDate": "string",
"Name": "string",
"Visibility": "string"
}
],
"NextToken": "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.
- EntitySummaryList
-
Array of
EntitySummary
object.Type: Array of EntitySummary objects
- NextToken
-
The value of the next token if it exists. Null if there is no more result.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
^[\w+=.:@\-\/]$
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
Access is denied.
HTTP Status Code: 403
- InternalServiceException
-
There was an internal service exception.
HTTP Status Code: 500
- ResourceNotFoundException
-
The specified resource wasn't found.
HTTP Status Code: 404
- ThrottlingException
-
Too many requests.
HTTP Status Code: 429
- ValidationException
-
An error occurred during validation.
HTTP Status Code: 422
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: