Provides the list of entities of a given type¶

Description¶

Provides the list of entities of a given type.

Usage¶

marketplacecatalog_list_entities(Catalog, EntityType, FilterList, Sort,
  NextToken, MaxResults, OwnershipType, EntityTypeFilters, EntityTypeSort)

Arguments¶

Catalog

[required] The catalog related to the request. Fixed value: AWSMarketplace
EntityType

[required] The type of entities to retrieve. Valid values are: AmiProduct, ContainerProduct, DataProduct, SaaSProduct, ProcurementPolicy, Experience, Audience, BrandingSettings, Offer, OfferSet, Seller, ResaleAuthorization, Solution.
FilterList

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

An object that contains two attributes, SortBy and SortOrder.
NextToken

The value of the next token, if it exists. Null if there are no more results.
MaxResults

Specifies the upper limit of the elements on a single page. If a value isn't provided, the default value is 20.
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 put_resource_policy operation can't be discovered through the SHARED parameter.
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.
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.

Value¶

A list with the following syntax:

list(
  EntitySummaryList = list(
    list(
      Name = "string",
      EntityType = "string",
      EntityId = "string",
      EntityArn = "string",
      LastModifiedDate = "string",
      Visibility = "string",
      AmiProductSummary = list(
        ProductTitle = "string",
        Visibility = "Limited"|"Public"|"Restricted"|"Draft"
      ),
      ContainerProductSummary = list(
        ProductTitle = "string",
        Visibility = "Limited"|"Public"|"Restricted"|"Draft"
      ),
      DataProductSummary = list(
        ProductTitle = "string",
        Visibility = "Limited"|"Public"|"Restricted"|"Unavailable"|"Draft"
      ),
      SaaSProductSummary = list(
        ProductTitle = "string",
        Visibility = "Limited"|"Public"|"Restricted"|"Draft"
      ),
      OfferSummary = list(
        Name = "string",
        ProductId = "string",
        ResaleAuthorizationId = "string",
        ReleaseDate = "string",
        AvailabilityEndDate = "string",
        BuyerAccounts = list(
          "string"
        ),
        State = "Draft"|"Released",
        Targeting = list(
          "BuyerAccounts"|"ParticipatingPrograms"|"CountryCodes"|"None"
        ),
        OfferSetId = "string",
        TargetAgreementId = "string",
        TargetAgreementIntent = "Renew",
        CreatedBySource = "Seller"|"AwsMarketplace"
      ),
      ResaleAuthorizationSummary = list(
        Name = "string",
        ProductId = "string",
        ProductName = "string",
        ManufacturerAccountId = "string",
        ManufacturerLegalName = "string",
        ResellerAccountID = "string",
        ResellerLegalName = "string",
        Status = "Draft"|"Active"|"Restricted",
        OfferExtendedStatus = "string",
        CreatedDate = "string",
        AvailabilityEndDate = "string",
        ResellerRole = "ChannelPartner"|"Distributor",
        SourceAuthorization = "string",
        IssuerAccountId = "string"
      ),
      MachineLearningProductSummary = list(
        ProductTitle = "string",
        Visibility = "Limited"|"Public"|"Restricted"|"Draft"
      ),
      OfferSetSummary = list(
        Name = "string",
        State = "Draft"|"Released",
        ReleaseDate = "string",
        AssociatedOfferIds = list(
          "string"
        ),
        SolutionId = "string"
      )
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$list_entities(
  Catalog = "string",
  EntityType = "string",
  FilterList = list(
    list(
      Name = "string",
      ValueList = list(
        "string"
      )
    )
  ),
  Sort = list(
    SortBy = "string",
    SortOrder = "ASCENDING"|"DESCENDING"
  ),
  NextToken = "string",
  MaxResults = 123,
  OwnershipType = "SELF"|"SHARED",
  EntityTypeFilters = list(
    DataProductFilters = list(
      EntityId = list(
        ValueList = list(
          "string"
        )
      ),
      ProductTitle = list(
        ValueList = list(
          "string"
        ),
        WildCardValue = "string"
      ),
      Visibility = list(
        ValueList = list(
          "Limited"|"Public"|"Restricted"|"Unavailable"|"Draft"
        )
      ),
      LastModifiedDate = list(
        DateRange = list(
          AfterValue = "string",
          BeforeValue = "string"
        )
      )
    ),
    SaaSProductFilters = list(
      EntityId = list(
        ValueList = list(
          "string"
        )
      ),
      ProductTitle = list(
        ValueList = list(
          "string"
        ),
        WildCardValue = "string"
      ),
      Visibility = list(
        ValueList = list(
          "Limited"|"Public"|"Restricted"|"Draft"
        )
      ),
      LastModifiedDate = list(
        DateRange = list(
          AfterValue = "string",
          BeforeValue = "string"
        )
      )
    ),
    AmiProductFilters = list(
      EntityId = list(
        ValueList = list(
          "string"
        )
      ),
      LastModifiedDate = list(
        DateRange = list(
          AfterValue = "string",
          BeforeValue = "string"
        )
      ),
      ProductTitle = list(
        ValueList = list(
          "string"
        ),
        WildCardValue = "string"
      ),
      Visibility = list(
        ValueList = list(
          "Limited"|"Public"|"Restricted"|"Draft"
        )
      )
    ),
    OfferFilters = list(
      EntityId = list(
        ValueList = list(
          "string"
        )
      ),
      Name = list(
        ValueList = list(
          "string"
        ),
        WildCardValue = "string"
      ),
      ProductId = list(
        ValueList = list(
          "string"
        )
      ),
      ResaleAuthorizationId = list(
        ValueList = list(
          "string"
        )
      ),
      ReleaseDate = list(
        DateRange = list(
          AfterValue = "string",
          BeforeValue = "string"
        )
      ),
      AvailabilityEndDate = list(
        DateRange = list(
          AfterValue = "string",
          BeforeValue = "string"
        )
      ),
      BuyerAccounts = list(
        WildCardValue = "string"
      ),
      State = list(
        ValueList = list(
          "Draft"|"Released"
        )
      ),
      Targeting = list(
        ValueList = list(
          "BuyerAccounts"|"ParticipatingPrograms"|"CountryCodes"|"None"
        )
      ),
      LastModifiedDate = list(
        DateRange = list(
          AfterValue = "string",
          BeforeValue = "string"
        )
      ),
      OfferSetId = list(
        ValueList = list(
          "string"
        )
      ),
      TargetAgreementId = list(
        ValueList = list(
          "string"
        )
      ),
      TargetAgreementIntent = list(
        ValueList = list(
          "Renew"
        )
      ),
      CreatedBySource = list(
        ValueList = list(
          "Seller"|"AwsMarketplace"
        )
      )
    ),
    ContainerProductFilters = list(
      EntityId = list(
        ValueList = list(
          "string"
        )
      ),
      LastModifiedDate = list(
        DateRange = list(
          AfterValue = "string",
          BeforeValue = "string"
        )
      ),
      ProductTitle = list(
        ValueList = list(
          "string"
        ),
        WildCardValue = "string"
      ),
      Visibility = list(
        ValueList = list(
          "Limited"|"Public"|"Restricted"|"Draft"
        )
      )
    ),
    ResaleAuthorizationFilters = list(
      EntityId = list(
        ValueList = list(
          "string"
        )
      ),
      Name = list(
        ValueList = list(
          "string"
        ),
        WildCardValue = "string"
      ),
      ProductId = list(
        ValueList = list(
          "string"
        ),
        WildCardValue = "string"
      ),
      CreatedDate = list(
        DateRange = list(
          AfterValue = "string",
          BeforeValue = "string"
        ),
        ValueList = list(
          "string"
        )
      ),
      AvailabilityEndDate = list(
        DateRange = list(
          AfterValue = "string",
          BeforeValue = "string"
        ),
        ValueList = list(
          "string"
        )
      ),
      ManufacturerAccountId = list(
        ValueList = list(
          "string"
        ),
        WildCardValue = "string"
      ),
      ProductName = list(
        ValueList = list(
          "string"
        ),
        WildCardValue = "string"
      ),
      ManufacturerLegalName = list(
        ValueList = list(
          "string"
        ),
        WildCardValue = "string"
      ),
      ResellerAccountID = list(
        ValueList = list(
          "string"
        ),
        WildCardValue = "string"
      ),
      ResellerLegalName = list(
        ValueList = list(
          "string"
        ),
        WildCardValue = "string"
      ),
      Status = list(
        ValueList = list(
          "Draft"|"Active"|"Restricted"
        )
      ),
      OfferExtendedStatus = list(
        ValueList = list(
          "string"
        )
      ),
      LastModifiedDate = list(
        DateRange = list(
          AfterValue = "string",
          BeforeValue = "string"
        )
      ),
      ResellerRole = list(
        ValueList = list(
          "ChannelPartner"|"Distributor"
        )
      ),
      SourceAuthorization = list(
        ValueList = list(
          "string"
        )
      ),
      IssuerAccountId = list(
        ValueList = list(
          "string"
        )
      )
    ),
    MachineLearningProductFilters = list(
      EntityId = list(
        ValueList = list(
          "string"
        )
      ),
      LastModifiedDate = list(
        DateRange = list(
          AfterValue = "string",
          BeforeValue = "string"
        )
      ),
      ProductTitle = list(
        ValueList = list(
          "string"
        ),
        WildCardValue = "string"
      ),
      Visibility = list(
        ValueList = list(
          "Limited"|"Public"|"Restricted"|"Draft"
        )
      )
    ),
    OfferSetFilters = list(
      EntityId = list(
        ValueList = list(
          "string"
        )
      ),
      Name = list(
        ValueList = list(
          "string"
        )
      ),
      State = list(
        ValueList = list(
          "Draft"|"Released"
        )
      ),
      ReleaseDate = list(
        DateRange = list(
          AfterValue = "string",
          BeforeValue = "string"
        )
      ),
      AssociatedOfferIds = list(
        ValueList = list(
          "string"
        )
      ),
      SolutionId = list(
        ValueList = list(
          "string"
        )
      ),
      LastModifiedDate = list(
        DateRange = list(
          AfterValue = "string",
          BeforeValue = "string"
        )
      )
    )
  ),
  EntityTypeSort = list(
    DataProductSort = list(
      SortBy = "EntityId"|"ProductTitle"|"Visibility"|"LastModifiedDate",
      SortOrder = "ASCENDING"|"DESCENDING"
    ),
    SaaSProductSort = list(
      SortBy = "EntityId"|"ProductTitle"|"Visibility"|"LastModifiedDate"|"DeliveryOptionTypes",
      SortOrder = "ASCENDING"|"DESCENDING"
    ),
    AmiProductSort = list(
      SortBy = "EntityId"|"LastModifiedDate"|"ProductTitle"|"Visibility",
      SortOrder = "ASCENDING"|"DESCENDING"
    ),
    OfferSort = list(
      SortBy = "EntityId"|"Name"|"ProductId"|"ResaleAuthorizationId"|"ReleaseDate"|"AvailabilityEndDate"|"BuyerAccounts"|"State"|"Targeting"|"LastModifiedDate"|"OfferSetId"|"TargetAgreementId"|"TargetAgreementIntent"|"CreatedBySource",
      SortOrder = "ASCENDING"|"DESCENDING"
    ),
    ContainerProductSort = list(
      SortBy = "EntityId"|"LastModifiedDate"|"ProductTitle"|"Visibility"|"CompatibleAWSServices",
      SortOrder = "ASCENDING"|"DESCENDING"
    ),
    ResaleAuthorizationSort = list(
      SortBy = "EntityId"|"Name"|"ProductId"|"ProductName"|"ManufacturerAccountId"|"ManufacturerLegalName"|"ResellerAccountID"|"ResellerLegalName"|"Status"|"OfferExtendedStatus"|"CreatedDate"|"AvailabilityEndDate"|"LastModifiedDate"|"ResellerRole"|"SourceAuthorization"|"IssuerAccountId",
      SortOrder = "ASCENDING"|"DESCENDING"
    ),
    MachineLearningProductSort = list(
      SortBy = "EntityId"|"LastModifiedDate"|"ProductTitle"|"Visibility",
      SortOrder = "ASCENDING"|"DESCENDING"
    ),
    OfferSetSort = list(
      SortBy = "Name"|"State"|"ReleaseDate"|"SolutionId"|"EntityId"|"LastModifiedDate",
      SortOrder = "ASCENDING"|"DESCENDING"
    )
  )
)