Select your cookie preferences

We use cookies and similar tools to enhance your experience, provide our services, deliver relevant advertising, and make improvements. Approved third parties also use these tools to help us deliver advertising and provide certain site features.

describe_entity

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'
}

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.

Exceptions

  • MarketplaceCatalog.Client.exceptions.InternalServiceException
  • MarketplaceCatalog.Client.exceptions.AccessDeniedException
  • MarketplaceCatalog.Client.exceptions.ValidationException
  • MarketplaceCatalog.Client.exceptions.ResourceNotSupportedException
  • MarketplaceCatalog.Client.exceptions.ResourceNotFoundException
  • MarketplaceCatalog.Client.exceptions.ThrottlingException