[ aws . marketplace-catalog ]

describe-entity

Description

Returns the metadata and content of the entity.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-entity
--catalog <value>
--entity-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--catalog (string)

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

--entity-id (string)

Required. The unique ID of the entity to describe.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

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.