MarketplaceCatalog / Client / describe_entity

describe_entity#

MarketplaceCatalog.Client.describe_entity(**kwargs)#

Returns the metadata and content of the entity.

See also: AWS API Documentation

Request Syntax

response = client.describe_entity(
    Catalog='string',
    EntityId='string'
)
Parameters:

  • Catalog (string) –

    [REQUIRED]

    Required. The catalog related to the request. Fixed value: AWSMarketplace

  • EntityId (string) –

    [REQUIRED]

    Required. The unique ID of the entity to describe.

Return type:

dict

Returns:

Response Syntax

{
    'EntityType': 'string',
    'EntityIdentifier': 'string',
    'EntityArn': 'string',
    'LastModifiedDate': 'string',
    'Details': 'string',
    'DetailsDocument': {...}|[...]|123|123.4|'string'|True|None
}

Response Structure

  • (dict) –

    • EntityType (string) –

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

    • EntityIdentifier (string) –

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

    • EntityArn (string) –

      The ARN associated to the unique identifier for the entity referenced in this request.

    • LastModifiedDate (string) –

      The last modified date of the entity, in ISO 8601 format (2018-02-27T13:45:22Z).

    • Details (string) –

      This stringified JSON object includes the details of the entity.

    • DetailsDocument (document) –

      The JSON value of the details specific to the entity.

Exceptions