[ aws . sms ]

update-app

Description

Updates the specified application.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  update-app
[--app-id <value>]
[--name <value>]
[--description <value>]
[--role-name <value>]
[--server-groups <value>]
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--app-id (string)

The ID of the application.

--name (string)

The new name of the application.

--description (string)

The new description of the application.

--role-name (string)

The name of the service role in the customer’s account used by AWS SMS.

--server-groups (list)

The server groups in the application to update.

(structure)

Logical grouping of servers.

serverGroupId -> (string)

The ID of a server group.

name -> (string)

The name of a server group.

serverList -> (list)

The servers that belong to a server group.

(structure)

Represents a server.

serverId -> (string)

The ID of the server.

serverType -> (string)

The type of server.

vmServer -> (structure)

Information about the VM server.

vmServerAddress -> (structure)

The VM server location.

vmManagerId -> (string)

The ID of the VM manager.

vmId -> (string)

The ID of the VM.

vmName -> (string)

The name of the VM.

vmManagerName -> (string)

The name of the VM manager.

vmManagerType -> (string)

The type of VM management product.

vmPath -> (string)

The VM folder path in the vCenter Server virtual machine inventory tree.

replicationJobId -> (string)

The ID of the replication job.

replicationJobTerminated -> (boolean)

Indicates whether the replication job is deleted or failed.

JSON Syntax:

[
  {
    "serverGroupId": "string",
    "name": "string",
    "serverList": [
      {
        "serverId": "string",
        "serverType": "VIRTUAL_MACHINE",
        "vmServer": {
          "vmServerAddress": {
            "vmManagerId": "string",
            "vmId": "string"
          },
          "vmName": "string",
          "vmManagerName": "string",
          "vmManagerType": "VSPHERE"|"SCVMM"|"HYPERV-MANAGER",
          "vmPath": "string"
        },
        "replicationJobId": "string",
        "replicationJobTerminated": true|false
      }
      ...
    ]
  }
  ...
]

--tags (list)

The tags to associate with the application.

(structure)

Key/value pair that can be assigned to an application.

key -> (string)

The tag key.

value -> (string)

The tag value.

Shorthand Syntax:

key=string,value=string ...

JSON Syntax:

[
  {
    "key": "string",
    "value": "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.

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

See ‘aws help’ for descriptions of global parameters.

Output

appSummary -> (structure)

A summary description of the application.

appId -> (string)

The unique ID of the application.

importedAppId -> (string)

The ID of the application.

name -> (string)

The name of the application.

description -> (string)

The description of the application.

status -> (string)

Status of the application.

statusMessage -> (string)

A message related to the status of the application

replicationConfigurationStatus -> (string)

Status of the replication configuration.

replicationStatus -> (string)

The replication status of the application.

replicationStatusMessage -> (string)

A message related to the replication status of the application.

latestReplicationTime -> (timestamp)

The timestamp of the application’s most recent successful replication.

launchConfigurationStatus -> (string)

Status of the launch configuration.

launchStatus -> (string)

The launch status of the application.

launchStatusMessage -> (string)

A message related to the launch status of the application.

launchDetails -> (structure)

Details about the latest launch of the application.

latestLaunchTime -> (timestamp)

The latest time that this application was launched successfully.

stackName -> (string)

The name of the latest stack launched for this application.

stackId -> (string)

The ID of the latest stack launched for this application.

creationTime -> (timestamp)

The creation time of the application.

lastModified -> (timestamp)

The last modified time of the application.

roleName -> (string)

The name of the service role in the customer’s account used by AWS SMS.

totalServerGroups -> (integer)

The number of server groups present in the application.

totalServers -> (integer)

The number of servers present in the application.

serverGroups -> (list)

The updated server groups in the application.

(structure)

Logical grouping of servers.

serverGroupId -> (string)

The ID of a server group.

name -> (string)

The name of a server group.

serverList -> (list)

The servers that belong to a server group.

(structure)

Represents a server.

serverId -> (string)

The ID of the server.

serverType -> (string)

The type of server.

vmServer -> (structure)

Information about the VM server.

vmServerAddress -> (structure)

The VM server location.

vmManagerId -> (string)

The ID of the VM manager.

vmId -> (string)

The ID of the VM.

vmName -> (string)

The name of the VM.

vmManagerName -> (string)

The name of the VM manager.

vmManagerType -> (string)

The type of VM management product.

vmPath -> (string)

The VM folder path in the vCenter Server virtual machine inventory tree.

replicationJobId -> (string)

The ID of the replication job.

replicationJobTerminated -> (boolean)

Indicates whether the replication job is deleted or failed.

tags -> (list)

The tags associated with the application.

(structure)

Key/value pair that can be assigned to an application.

key -> (string)

The tag key.

value -> (string)

The tag value.