Skip to content

Batch Describe Entities

marketplacecatalog_batch_describe_entities R Documentation

Returns metadata and content for multiple entities

Description

Returns metadata and content for multiple entities. This is the Batch version of the describe_entity API and uses the same IAM permission action as describe_entity API.

Usage

marketplacecatalog_batch_describe_entities(EntityRequestList)

Arguments

EntityRequestList

[required] List of entity IDs and the catalogs the entities are present in.

Value

A list with the following syntax:

list(
  EntityDetails = list(
    list(
      EntityType = "string",
      EntityArn = "string",
      EntityIdentifier = "string",
      LastModifiedDate = "string",
      DetailsDocument = list()
    )
  ),
  Errors = list(
    list(
      ErrorCode = "string",
      ErrorMessage = "string"
    )
  )
)

Request syntax

svc$batch_describe_entities(
  EntityRequestList = list(
    list(
      Catalog = "string",
      EntityId = "string"
    )
  )
)