MarketplaceCatalog / Client / batch_describe_entities



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

See also: AWS API Documentation

Request Syntax

response = client.batch_describe_entities(
            'Catalog': 'string',
            'EntityId': 'string'

EntityRequestList (list) –


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

  • (dict) –

    An object that contains entity ID and the catalog in which the entity is present.

    • Catalog (string) – [REQUIRED]

      The name of the catalog the entity is present in. The only value at this time is AWSMarketplace.

    • EntityId (string) – [REQUIRED]

      The ID of the entity.

Return type:



Response Syntax

    'EntityDetails': {
        'string': {
            'EntityType': 'string',
            'EntityArn': 'string',
            'EntityIdentifier': 'string',
            'LastModifiedDate': 'string',
            'DetailsDocument': {...}|[...]|123|123.4|'string'|True|None
    'Errors': {
        'string': {
            'ErrorCode': 'string',
            'ErrorMessage': 'string'

Response Structure

  • (dict) –

    • EntityDetails (dict) –

      Details about each entity.

      • (string) –

        • (dict) –

          An object that contains metadata and details about the entity.

          • EntityType (string) –

            The entity type of the entity, in the format of EntityType@Version.

          • EntityArn (string) –

            The Amazon Resource Name (ARN) of the entity.

          • EntityIdentifier (string) –

            The ID of the entity, in the format of EntityId@RevisionId.

          • LastModifiedDate (string) –

            The last time the entity was modified.

          • DetailsDocument (document) –

            An object that contains all the details of the entity.

    • Errors (dict) –

      A map of errors returned, with EntityId as the key and errorDetail as the value.

      • (string) –

        • (dict) –

          An object that contains an error code and error message.

          • ErrorCode (string) –

            The error code returned.

          • ErrorMessage (string) –

            The error message returned.