MarketplaceCatalog / Paginator / ListEntities
ListEntities#
- class MarketplaceCatalog.Paginator.ListEntities#
paginator = client.get_paginator('list_entities')
- paginate(**kwargs)#
Creates an iterator that will paginate through responses from
MarketplaceCatalog.Client.list_entities()
.See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate( Catalog='string', EntityType='string', FilterList=[ { 'Name': 'string', 'ValueList': [ 'string', ] }, ], Sort={ 'SortBy': 'string', 'SortOrder': 'ASCENDING'|'DESCENDING' }, OwnershipType='SELF'|'SHARED', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } )
- Parameters:
Catalog (string) –
[REQUIRED]
The catalog related to the request. Fixed value:
AWSMarketplace
EntityType (string) –
[REQUIRED]
The type of entities to retrieve.
FilterList (list) –
An array of filter objects. Each filter object contains two attributes,
filterName
andfilterValues
.(dict) –
A filter object, used to optionally filter results from calls to the
ListEntities
andListChangeSets
actions.Name (string) –
For
ListEntities
, the supported value for this is anEntityId
.For
ListChangeSets
, the supported values are as follows:ValueList (list) –
ListEntities
- This is a list of unique ``EntityId``s.ListChangeSets
- The supported filter names and associated ``ValueList``s is as follows:ChangeSetName
- The supportedValueList
is a list of non-uniqueChangeSetName``s. These are defined when you call the ``StartChangeSet
action.Status
- The supportedValueList
is a list of statuses for all change set requests.EntityId
- The supportedValueList
is a list of unique ``EntityId``s.BeforeStartTime
- The supportedValueList
is a list of all change sets that started before the filter value.AfterStartTime
- The supportedValueList
is a list of all change sets that started after the filter value.BeforeEndTime
- The supportedValueList
is a list of all change sets that ended before the filter value.AfterEndTime
- The supportedValueList
is a list of all change sets that ended after the filter value.
(string) –
Sort (dict) –
An object that contains two attributes,
SortBy
andSortOrder
.SortBy (string) –
For
ListEntities
, supported attributes includeLastModifiedDate
(default) andEntityId
. In addition toLastModifiedDate
andEntityId
, eachEntityType
might support additional fields.For
ListChangeSets
, supported attributes includeStartTime
andEndTime
.SortOrder (string) –
The sorting order. Can be
ASCENDING
orDESCENDING
. The default value isDESCENDING
.
OwnershipType (string) – 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 toSHARED
. Entities shared through the AWS Marketplace Catalog APIPutResourcePolicy
operation can’t be discovered through theSHARED
parameter.PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
The total number of items to return. If the total number of items available is more than the value specified in max-items then a
NextToken
will be provided in the output that you can use to resume pagination.PageSize (integer) –
The size of each page.
StartingToken (string) –
A token to specify where to start paginating. This is the
NextToken
from a previous response.
- Return type:
dict
- Returns:
Response Syntax
{ 'EntitySummaryList': [ { 'Name': 'string', 'EntityType': 'string', 'EntityId': 'string', 'EntityArn': 'string', 'LastModifiedDate': 'string', 'Visibility': '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), orRestricted
(the entity was published and then unpublished and only existing buyers can view it).