Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . marketplace-catalog ]

batch-describe-entities

Description

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.

See also: AWS API Documentation

batch-describe-entities uses document type values. Document types follow the JSON data model where valid values are: strings, numbers, booleans, null, arrays, and objects. For command input, options and nested parameters that are labeled with the type document must be provided as JSON. Shorthand syntax does not support document types.

Synopsis

  batch-describe-entities
--entity-request-list <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--entity-request-list (list)

List of entity IDs and the catalogs the entities are present in.

(structure)

An object that contains entity ID and the catalog in which the entity is present.

Catalog -> (string)

The name of the catalog the entity is present in. The only value at this time is AWSMarketplace .

EntityId -> (string)

The ID of the entity.

Shorthand Syntax:

Catalog=string,EntityId=string ...

JSON Syntax:

[
  {
    "Catalog": "string",
    "EntityId": "string"
  }
  ...
]

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

• json
• text
• table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

EntityDetails -> (map)

Details about each entity.

key -> (string)

value -> (structure)

An object that contains metadata and details about the entity.

EntityType -> (string)

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

EntityArn -> (string)

The Amazon Resource Name (ARN) of the entity.

EntityIdentifier -> (string)

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

LastModifiedDate -> (string)

The last time the entity was modified.

DetailsDocument -> (document)

An object that contains all the details of the entity.

Errors -> (map)

A map of errors returned, with EntityId as the key and errorDetail as the value.

key -> (string)

value -> (structure)

An object that contains an error code and error message.

ErrorCode -> (string)

The error code returned.

ErrorMessage -> (string)

The error message returned.