Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

DescribeEntity

Returns the metadata and content of the entity.

Request Syntax


GET /DescribeEntity?catalog=Catalog&entityId=EntityId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

Catalog

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

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^[a-zA-Z]+$

Required: Yes

EntityId

Required. The unique ID of the entity to describe.

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: ^[\w\-]+$

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Details": "string",
   "DetailsDocument": JSON value,
   "EntityArn": "string",
   "EntityIdentifier": "string",
   "EntityType": "string",
   "LastModifiedDate": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Details

This stringified JSON object includes the details of the entity.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 16384.

Pattern: ^[\s]*\{[\s\S]*\}[\s]*$

DetailsDocument

The JSON value of the details specific to the entity.

Type: JSON value

EntityArn

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: ^[a-zA-Z0-9:*/-]+$

EntityIdentifier

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: ^[\w\-@]+$

EntityType

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: ^[a-zA-Z]+$

LastModifiedDate

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

Type: String

Length Constraints: Fixed length of 20.

Pattern: ^([\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$

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

Access is denied.

HTTP status code: 403

HTTP Status Code: 403

InternalServiceException

There was an internal service exception.

HTTP status code: 500

HTTP Status Code: 500

ResourceNotFoundException

The specified resource wasn't found.

HTTP status code: 404

HTTP Status Code: 404

ResourceNotSupportedException

Currently, the specified resource is not supported.

HTTP Status Code: 415

ThrottlingException

Too many requests.

HTTP status code: 429

HTTP Status Code: 429

ValidationException

An error occurred during validation.

HTTP status code: 422

HTTP Status Code: 422