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 . emr-serverless ]

update-application

Description

Updates a specified application. An application has to be in a stopped or created state in order to be updated.

See also: AWS API Documentation

Synopsis

  update-application
--application-id <value>
[--client-token <value>]
[--initial-capacity <value>]
[--maximum-capacity <value>]
[--auto-start-configuration <value>]
[--auto-stop-configuration <value>]
[--network-configuration <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

--application-id (string)

The ID of the application to update.

--client-token (string)

The client idempotency token of the application to update. Its value must be unique for each request.

--initial-capacity (map)

The capacity to initialize when the application is updated.

key -> (string)

value -> (structure)

The initial capacity configuration per worker.

workerCount -> (long)

The number of workers in the initial capacity configuration.

workerConfiguration -> (structure)

The resource configuration of the initial capacity configuration.

cpu -> (string)

The CPU requirements for every worker instance of the worker type.

memory -> (string)

The memory requirements for every worker instance of the worker type.

disk -> (string)

The disk requirements for every worker instance of the worker type.

Shorthand Syntax:

KeyName1=workerCount=long,workerConfiguration={cpu=string,memory=string,disk=string},KeyName2=workerCount=long,workerConfiguration={cpu=string,memory=string,disk=string}

JSON Syntax:

{"string": {
      "workerCount": long,
      "workerConfiguration": {
        "cpu": "string",
        "memory": "string",
        "disk": "string"
      }
    }
  ...}

--maximum-capacity (structure)

The maximum capacity to allocate when the application is updated. This is cumulative across all workers at any given point in time during the lifespan of the application. No new resources will be created once any one of the defined limits is hit.

cpu -> (string)

The maximum allowed CPU for an application.

memory -> (string)

The maximum allowed resources for an application.

disk -> (string)

The maximum allowed disk for an application.

Shorthand Syntax:

cpu=string,memory=string,disk=string

JSON Syntax:

{
  "cpu": "string",
  "memory": "string",
  "disk": "string"
}

--auto-start-configuration (structure)

The configuration for an application to automatically start on job submission.

enabled -> (boolean)

Enables the application to automatically start on job submission. Defaults to true.

Shorthand Syntax:

enabled=boolean

JSON Syntax:

{
  "enabled": true|false
}

--auto-stop-configuration (structure)

The configuration for an application to automatically stop after a certain amount of time being idle.

enabled -> (boolean)

Enables the application to automatically stop after a certain amount of time being idle. Defaults to true.

idleTimeoutMinutes -> (integer)

The amount of idle time in minutes after which your application will automatically stop. Defaults to 15 minutes.

Shorthand Syntax:

enabled=boolean,idleTimeoutMinutes=integer

JSON Syntax:

{
  "enabled": true|false,
  "idleTimeoutMinutes": integer
}

--network-configuration (structure)

The network configuration for customer VPC connectivity.

subnetIds -> (list)

The array of subnet Ids for customer VPC connectivity.

(string)

securityGroupIds -> (list)

The array of security group Ids for customer VPC connectivity.

(string)

Shorthand Syntax:

subnetIds=string,string,securityGroupIds=string,string

JSON Syntax:

{
  "subnetIds": ["string", ...],
  "securityGroupIds": ["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

application -> (structure)

Information about the updated application.

applicationId -> (string)

The ID of the application.

name -> (string)

The name of the application.

arn -> (string)

The ARN of the application.

releaseLabel -> (string)

The EMR release version associated with the application.

type -> (string)

The type of application, such as Spark or Hive.

state -> (string)

The state of the application.

stateDetails -> (string)

The state details of the application.

initialCapacity -> (map)

The initial capacity of the application.

key -> (string)

value -> (structure)

The initial capacity configuration per worker.

workerCount -> (long)

The number of workers in the initial capacity configuration.

workerConfiguration -> (structure)

The resource configuration of the initial capacity configuration.

cpu -> (string)

The CPU requirements for every worker instance of the worker type.

memory -> (string)

The memory requirements for every worker instance of the worker type.

disk -> (string)

The disk requirements for every worker instance of the worker type.

maximumCapacity -> (structure)

The maximum capacity of the application. This is cumulative across all workers at any given point in time during the lifespan of the application is created. No new resources will be created once any one of the defined limits is hit.

cpu -> (string)

The maximum allowed CPU for an application.

memory -> (string)

The maximum allowed resources for an application.

disk -> (string)

The maximum allowed disk for an application.

createdAt -> (timestamp)

The date and time when the application run was created.

updatedAt -> (timestamp)

The date and time when the application run was last updated.

tags -> (map)

The tags assigned to the application.

key -> (string)

value -> (string)

autoStartConfiguration -> (structure)

The configuration for an application to automatically start on job submission.

enabled -> (boolean)

Enables the application to automatically start on job submission. Defaults to true.

autoStopConfiguration -> (structure)

The configuration for an application to automatically stop after a certain amount of time being idle.

enabled -> (boolean)

Enables the application to automatically stop after a certain amount of time being idle. Defaults to true.

idleTimeoutMinutes -> (integer)

The amount of idle time in minutes after which your application will automatically stop. Defaults to 15 minutes.

networkConfiguration -> (structure)

The network configuration for customer VPC connectivity for the application.

subnetIds -> (list)

The array of subnet Ids for customer VPC connectivity.

(string)

securityGroupIds -> (list)

The array of security group Ids for customer VPC connectivity.

(string)