[ aws . marketplace-catalog ]
Provides the list of entities of a given type.
See also: AWS API Documentation
list-entities
--catalog <value>
--entity-type <value>
[--filter-list <value>]
[--sort <value>]
[--next-token <value>]
[--max-results <value>]
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
--catalog
(string)
The catalog related to the request. Fixed value:
AWSMarketplace
--entity-type
(string)
The type of entities to retrieve.
--filter-list
(list)
An array of filter objects. Each filter object contains two attributes,
filterName
andfilterValues
.(structure)
A filter object, used to optionally filter results from calls to the
ListEntities
andListChangeSets
actions.Name -> (string)
For
ListEntities
, the supported value for this is anEntityId
.For
ListChangeSets
, the supported values are as follows:ValueList -> (list)
ListEntities
- This is a list of uniqueEntityId
s.
ListChangeSets
- The supported filter names and associatedValueList
s is as follows:
ChangeSetName
- The supportedValueList
is a list of non-uniqueChangeSetName
s. These are defined when you call theStartChangeSet
action.
Status
- The supportedValueList
is a list of statuses for all change set requests.
EntityId
- The supportedValueList
is a list of uniqueEntityId
s.
BeforeStartTime
- The supportedValueList
is a list of all change sets that started before the filter value.
AfterStartTime
- The supportedValueList
is a list of all change sets that started after the filter value.
BeforeEndTime
- The supportedValueList
is a list of all change sets that ended before the filter value.
AfterEndTime
- The supportedValueList
is a list of all change sets that ended after the filter value.(string)
Shorthand Syntax:
Name=string,ValueList=string,string ...
JSON Syntax:
[
{
"Name": "string",
"ValueList": ["string", ...]
}
...
]
--sort
(structure)
An object that contains two attributes,
SortBy
andSortOrder
.SortBy -> (string)
For
ListEntities
, supported attributes includeLastModifiedDate
(default),Visibility
,EntityId
, andName
.For
ListChangeSets
, supported attributes includeStartTime
andEndTime
.SortOrder -> (string)
The sorting order. Can be
ASCENDING
orDESCENDING
. The default value isDESCENDING
.
Shorthand Syntax:
SortBy=string,SortOrder=string
JSON Syntax:
{
"SortBy": "string",
"SortOrder": "ASCENDING"|"DESCENDING"
}
--next-token
(string)
The value of the next token, if it exists. Null if there are no more results.
--max-results
(integer)
Specifies the upper limit of the elements on a single page. If a value isn’t provided, the default value is 20.
--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.
--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
yaml
yaml-stream
--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.
--cli-binary-format
(string)
The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb://
will always be treated as binary and use the file contents directly regardless of the cli-binary-format
setting. When using file://
the file contents will need to properly formatted for the configured cli-binary-format
.
base64
raw-in-base64-out
--no-cli-pager
(boolean)
Disable cli pager for output.
--cli-auto-prompt
(boolean)
Automatically prompt for CLI input parameters.
--no-cli-auto-prompt
(boolean)
Disable automatically prompt for CLI input parameters.
EntitySummaryList -> (list)
Array of
EntitySummary
object.(structure)
This object is a container for common summary information about the entity. The summary doesn’t contain the whole entity structure, but it does contain information common across all entities.
Name -> (string)
The name for the entity. This value is not unique. It is defined by the seller.
EntityType -> (string)
The type of the entity.
EntityId -> (string)
The unique identifier for the entity.
EntityArn -> (string)
The ARN associated with the unique identifier for the entity.
LastModifiedDate -> (string)
The last time the entity was published, using ISO 8601 format (2018-02-27T13:45:22Z).
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), orRestricted
(the entity was published and then unpublished and only existing buyers can view it).
NextToken -> (string)
The value of the next token if it exists. Null if there is no more result.