entities

Creates, updates, deletes, gets or lists an entities resource.

Overview

Name	entities
Type	Resource
Id	aws.marketplace_catalog.entities

Fields

The following fields are returned by SELECT queries:

describe_entity

Name	Datatype	Description
details	string	This stringified JSON object includes the details of the entity. (pattern: <code>^[\s]&#123;[\s\S]&#125;[\s]*$</code>)
details_document	object	The JSON value of the details specific to the entity. To download "DetailsDocument" shapes, see the Python and Java shapes on GitHub.
entity_arn	string	The ARN associated to the unique identifier for the entity referenced in this request. (pattern: <code>^[a-zA-Z0-9:*/-]+$</code>)
entity_identifier	string	The identifier of the entity, in the format of EntityId@RevisionId. (pattern: <code>^[\w-@]+$</code>)
entity_type	string	The named type of the entity, in the format of EntityType@Version. (pattern: <code>^[a-zA-Z]+$</code>)
last_modified_date	string	The last modified date of the entity, in ISO 8601 format (2018-02-27T13:45:22Z). (pattern: <code>^([\d]{4})-(1[0-2]|0[1-9])-(3[01]|0[1-9]|[12][\d])T(2[0-3]|[01][\d]):([0-5][\d]):([0-5][\d])Z$</code>)

list_entities

Name	Datatype	Description
ami_product_summary	object	An object that contains summary information about the AMI product.
container_product_summary	object	An object that contains summary information about the container product.
data_product_summary	object	An object that contains summary information about the data product.
entity_arn	string	The ARN associated with the unique identifier for the entity. (pattern: <code>^[a-zA-Z0-9:*/-]+$</code>)
entity_id	string	The unique identifier for the entity. (pattern: <code>^[\w-]+$</code>)
entity_type	string	The type of the entity. (pattern: <code>^[a-zA-Z]+$</code>)
last_modified_date	string	The last time the entity was published, using ISO 8601 format (2018-02-27T13:45:22Z). (pattern: <code>^([\d]{4})-(1[0-2]|0[1-9])-(3[01]|0[1-9]|[12][\d])T(2[0-3]|[01][\d]):([0-5][\d]):([0-5][\d])Z$</code>)
machine_learning_product_summary	object	A summary of a machine learning product.
name	string	The name for the entity. This value is not unique. It is defined by the seller. (pattern: <code>^\S+[\S\s]*</code>)
offer_set_summary	object	An object that contains summary information about the offer set.
offer_summary	object	An object that contains summary information about the offer.
resale_authorization_summary	object	An object that contains summary information about the Resale Authorization.
saa_s_product_summary	object	An object that contains summary information about the SaaS product.
visibility	string	The visibility status of the entity to buyers. This value can be Public (everyone can view the entity), Limited (the entity is visible to limited accounts only), or Restricted (the entity was published and then unpublished and only existing buyers can view it). (pattern: <code>^[a-zA-Z]+$</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_entity	select	catalog, entityId, region		Returns the metadata and content of the entity.
list_entities	select	region		Provides the list of entities of a given type.
batch_describe_entities	exec	region, EntityRequestList		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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
catalog	string	Required. The catalog related to the request. Fixed value: AWSMarketplace
entityId	string	Required. The unique ID of the entity to describe.
region	string	AWS region (default: us-east-1)

SELECT examples

describe_entity

Returns the metadata and content of the entity.

SELECT
details,
details_document,
entity_arn,
entity_identifier,
entity_type,
last_modified_date
FROM aws.marketplace_catalog.entities
WHERE catalog = '{{ catalog }}' -- required
AND entityId = '{{ entityId }}' -- required
AND region = '{{ region }}' -- required
;

list_entities

Provides the list of entities of a given type.

SELECT
ami_product_summary,
container_product_summary,
data_product_summary,
entity_arn,
entity_id,
entity_type,
last_modified_date,
machine_learning_product_summary,
name,
offer_set_summary,
offer_summary,
resale_authorization_summary,
saa_s_product_summary,
visibility
FROM aws.marketplace_catalog.entities
WHERE region = '{{ region }}' -- required
;

Lifecycle Methods

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.

EXEC aws.marketplace_catalog.entities.batch_describe_entities 
@region='{{ region }}' --required 
@@json=
'{
"EntityRequestList": "{{ EntityRequestList }}"
}'
;