list_entities
(**kwargs)¶Provides the list of entities of a given type.
See also: AWS API Documentation
Request Syntax
response = client.list_entities(
Catalog='string',
EntityType='string',
FilterList=[
{
'Name': 'string',
'ValueList': [
'string',
]
},
],
Sort={
'SortBy': 'string',
'SortOrder': 'ASCENDING'|'DESCENDING'
},
NextToken='string',
MaxResults=123
)
[REQUIRED]
The catalog related to the request. Fixed value: AWSMarketplace
[REQUIRED]
The type of entities to retrieve.
An array of filter objects. Each filter object contains two attributes, filterName
and filterValues
.
A filter object, used to optionally filter results from calls to the ListEntities
and ListChangeSets
actions.
For ListEntities
, the supported value for this is an EntityId
.
For ListChangeSets
, the supported values are as follows:
ListEntities
- This is a list of uniqueEntityId
s.
ListChangeSets
- The supported filter names and associatedValueList
s is as follows:
ChangeSetName
- The supported ValueList
is a list of non-unique ChangeSetName
s. These are defined when you call the StartChangeSet
action.Status
- The supported ValueList
is a list of statuses for all change set requests.EntityId
- The supported ValueList
is a list of unique EntityId
s.BeforeStartTime
- The supported ValueList
is a list of all change sets that started before the filter value.AfterStartTime
- The supported ValueList
is a list of all change sets that started after the filter value.BeforeEndTime
- The supported ValueList
is a list of all change sets that ended before the filter value.AfterEndTime
- The supported ValueList
is a list of all change sets that ended after the filter value.An object that contains two attributes, SortBy
and SortOrder
.
For ListEntities
, supported attributes include LastModifiedDate
(default), Visibility
, EntityId
, and Name
.
For ListChangeSets
, supported attributes include StartTime
and EndTime
.
The sorting order. Can be ASCENDING
or DESCENDING
. The default value is DESCENDING
.
dict
Response Syntax
{
'EntitySummaryList': [
{
'Name': 'string',
'EntityType': 'string',
'EntityId': 'string',
'EntityArn': 'string',
'LastModifiedDate': 'string',
'Visibility': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
EntitySummaryList (list) --
Array of EntitySummary
object.
(dict) --
This object is a container for common summary information about the entity. The summary doesn't contain the whole entity structure, but it does contain information common across all entities.
Name (string) --
The name for the entity. This value is not unique. It is defined by the seller.
EntityType (string) --
The type of the entity.
EntityId (string) --
The unique identifier for the entity.
EntityArn (string) --
The ARN associated with the unique identifier for the entity.
LastModifiedDate (string) --
The last time the entity was published, using ISO 8601 format (2018-02-27T13:45:22Z).
Visibility (string) --
The visibility status of the entity to buyers. This value can be Public
(everyone can view the entity), Limited
(the entity is visible to limited accounts only), or Restricted
(the entity was published and then unpublished and only existing buyers can view it).
NextToken (string) --
The value of the next token if it exists. Null if there is no more result.
Exceptions
MarketplaceCatalog.Client.exceptions.InternalServiceException
MarketplaceCatalog.Client.exceptions.AccessDeniedException
MarketplaceCatalog.Client.exceptions.ValidationException
MarketplaceCatalog.Client.exceptions.ResourceNotFoundException
MarketplaceCatalog.Client.exceptions.ThrottlingException