[ aws . elasticbeanstalk ]
Retrieve a list of application versions.
See also: AWS API Documentation
describe-application-versions
is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate
argument.
When using --output text
and the --query
argument on a paginated response, the --query
argument must extract data from the results of the following query expressions: ApplicationVersions
describe-application-versions
[--application-name <value>]
[--version-labels <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
--application-name
(string)
Specify an application name to show only application versions for that application.
--version-labels
(list)
Specify a version label to show a specific application version.
(string)
Syntax:
"string" "string" ...
--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
.
--starting-token
(string)
A token to specify where to start paginating. This is the
NextToken
from a previously truncated response.For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--page-size
(integer)
The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.
For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--max-items
(integer)
The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a
NextToken
is provided in the command’s output. To resume pagination, provide theNextToken
value in thestarting-token
argument of a subsequent command. Do not use theNextToken
response element directly outside of the AWS CLI.For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--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.
Note
To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.
Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .
To view information about an application version
The following command retrieves information about an application version labeled v2
:
aws elasticbeanstalk describe-application-versions --application-name my-app --version-label "v2"
Output:
{
"ApplicationVersions": [
{
"ApplicationName": "my-app",
"VersionLabel": "v2",
"Description": "update cover page",
"DateCreated": "2015-07-23T01:32:26.079Z",
"DateUpdated": "2015-07-23T01:32:26.079Z",
"SourceBundle": {
"S3Bucket": "elasticbeanstalk-us-west-2-015321684451",
"S3Key": "my-app/5026-stage-150723_224258.war"
}
},
{
"ApplicationName": "my-app",
"VersionLabel": "v1",
"Description": "initial version",
"DateCreated": "2015-07-23T22:26:10.816Z",
"DateUpdated": "2015-07-23T22:26:10.816Z",
"SourceBundle": {
"S3Bucket": "elasticbeanstalk-us-west-2-015321684451",
"S3Key": "my-app/5026-stage-150723_222618.war"
}
}
]
}
ApplicationVersions -> (list)
List of
ApplicationVersionDescription
objects sorted in order of creation.(structure)
Describes the properties of an application version.
ApplicationVersionArn -> (string)
The Amazon Resource Name (ARN) of the application version.
ApplicationName -> (string)
The name of the application to which the application version belongs.
Description -> (string)
The description of the application version.
VersionLabel -> (string)
A unique identifier for the application version.
SourceBuildInformation -> (structure)
If the version’s source code was retrieved from AWS CodeCommit, the location of the source code for the application version.
SourceType -> (string)
The type of repository.
Git
Zip
SourceRepository -> (string)
Location where the repository is stored.
CodeCommit
S3
SourceLocation -> (string)
The location of the source code, as a formatted string, depending on the value of
SourceRepository
For
CodeCommit
, the format is the repository name and commit ID, separated by a forward slash. For example,my-git-repo/265cfa0cf6af46153527f55d6503ec030551f57a
.For
S3
, the format is the S3 bucket name and object key, separated by a forward slash. For example,my-s3-bucket/Folders/my-source-file
.BuildArn -> (string)
Reference to the artifact from the AWS CodeBuild build.
SourceBundle -> (structure)
The storage location of the application version’s source bundle in Amazon S3.
S3Bucket -> (string)
The Amazon S3 bucket where the data is located.
S3Key -> (string)
The Amazon S3 key where the data is located.
DateCreated -> (timestamp)
The creation date of the application version.
DateUpdated -> (timestamp)
The last modified date of the application version.
Status -> (string)
The processing status of the application version. Reflects the state of the application version during its creation. Many of the values are only applicable if you specified
True
for theProcess
parameter of theCreateApplicationVersion
action. The following list describes the possible values.
Unprocessed
– Application version wasn’t pre-processed or validated. Elastic Beanstalk will validate configuration files during deployment of the application version to an environment.
Processing
– Elastic Beanstalk is currently processing the application version.
Building
– Application version is currently undergoing an AWS CodeBuild build.
Processed
– Elastic Beanstalk was successfully pre-processed and validated.
Failed
– Either the AWS CodeBuild build failed or configuration files didn’t pass validation. This application version isn’t usable.
NextToken -> (string)
In a paginated request, the token that you can pass in a subsequent request to get the next response page.