update-application-version¶

Description¶

Updates the specified application version to have the specified properties.

Note

If a property (for example, description ) is not provided, the value remains unchanged. To clear properties, specify an empty string.

Synopsis¶

  update-application-version
--application-name <value>
--version-label <value>
[--description <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--application-name (string)

The name of the application associated with this version.

If no application is found with this name, UpdateApplication returns an InvalidParameterValue error.

--version-label (string)

The name of the version to update.

If no application version is found with this label, UpdateApplication returns an InvalidParameterValue error.

--description (string)

A new description for this version.

--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.

Examples¶

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 change an application version’s description

The following command updates the description of an application version named 22a0-stage-150819_185942:

aws elasticbeanstalk update-application-version --version-label 22a0-stage-150819_185942 --application-name my-app --description "new description"

Output:

{
    "ApplicationVersion": {
        "ApplicationName": "my-app",
        "VersionLabel": "22a0-stage-150819_185942",
        "Description": "new description",
        "DateCreated": "2015-08-19T18:59:17.646Z",
        "DateUpdated": "2015-08-20T22:53:28.871Z",
        "SourceBundle": {
            "S3Bucket": "elasticbeanstalk-us-west-2-0123456789012",
            "S3Key": "my-app/22a0-stage-150819_185942.war"
        }
    }
}

Output¶

ApplicationVersion -> (structure)

The ApplicationVersionDescription of the 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 the Process parameter of the CreateApplicationVersion 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.

Table of Contents

Feedback

User Guide