Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

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",
   "EntityTypeFilters": { ... },
   "EntityTypeSort": { ... },
   "FilterList": [ 
      { 
         "Name": "string",
         "ValueList": [ "string" ]
      }
   ],
   "MaxResults": number,
   "NextToken": "string",
   "OwnershipType": "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. Valid values are: ServerProduct, AmiProduct, ContainerProduct, DataProduct, SaaSProduct, ProcurementPolicy, Experience, Audience, BrandingSettings, Offer, Seller, ResaleAuthorization.

Type: String

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

Pattern: ^[a-zA-Z]+$

Required: Yes

EntityTypeFilters

A Union object containing filter shapes for all EntityTypes. Each EntityTypeFilter shape will have filters applicable for that EntityType that can be used to search or filter entities.

Type: EntityTypeFilters object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: No

EntityTypeSort

A Union object containing Sort shapes for all EntityTypes. Each EntityTypeSort shape will have SortBy and SortOrder applicable for fields on that EntityType. This can be used to sort the results of the filter query.

Type: EntityTypeSort object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: No

FilterList

An array of filter objects. Each filter object contains two attributes, filterName and filterValues.

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

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

OwnershipType

Filters the returned set of entities based on their owner. The default is SELF. To list entities shared with you through AWS Resource Access Manager (AWS RAM), set to SHARED. Entities shared through the AWS Marketplace Catalog API PutResourcePolicy operation can't be discovered through the SHARED parameter.

Type: String

Valid Values: SELF | SHARED

Required: No

Sort

An object that contains two attributes, SortBy and SortOrder.

Type: Sort object

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "EntitySummaryList": [ 
      { 
         "AmiProductSummary": { 
            "ProductTitle": "string",
            "Visibility": "string"
         },
         "ContainerProductSummary": { 
            "ProductTitle": "string",
            "Visibility": "string"
         },
         "DataProductSummary": { 
            "ProductTitle": "string",
            "Visibility": "string"
         },
         "EntityArn": "string",
         "EntityId": "string",
         "EntityType": "string",
         "LastModifiedDate": "string",
         "Name": "string",
         "OfferSummary": { 
            "AvailabilityEndDate": "string",
            "BuyerAccounts": [ "string" ],
            "Name": "string",
            "ProductId": "string",
            "ReleaseDate": "string",
            "State": "string",
            "Targeting": [ "string" ]
         },
         "ResaleAuthorizationSummary": { 
            "AvailabilityEndDate": "string",
            "CreatedDate": "string",
            "ManufacturerAccountId": "string",
            "ManufacturerLegalName": "string",
            "Name": "string",
            "OfferExtendedStatus": "string",
            "ProductId": "string",
            "ProductName": "string",
            "ResellerAccountID": "string",
            "ResellerLegalName": "string",
            "Status": "string"
         },
         "SaaSProductSummary": { 
            "ProductTitle": "string",
            "Visibility": "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 objects.

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

HTTP Status Code: 403

InternalServiceException

There was an internal service exception.

HTTP status code: 500

HTTP Status Code: 500

ResourceNotFoundException

The specified resource wasn't found.

HTTP status code: 404

HTTP Status Code: 404

ThrottlingException

Too many requests.

HTTP status code: 429

HTTP Status Code: 429

ValidationException

An error occurred during validation.

HTTP status code: 422

HTTP Status Code: 422