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

create-app

Description

Creates an application. An application consists of one or more server groups. Each server group contain one or more servers.

See also: AWS API Documentation

Synopsis

  create-app
[--name <value>]
[--description <value>]
[--role-name <value>]
[--client-token <value>]
[--server-groups <value>]
[--tags <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

--name (string)

The name of the new application.

--description (string)

The description of the new application

--role-name (string)

The name of the service role in the customer's account to be used by Server Migration Service.

--client-token (string)

A unique, case-sensitive identifier that you provide to ensure the idempotency of application creation.

--server-groups (list)

The server groups to include 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.

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

Shorthand Syntax:

key=string,value=string ...

JSON Syntax:

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

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 Server Migration Service.

totalServerGroups -> (integer)

The number of server groups present in the application.

totalServers -> (integer)

The number of servers present in the application.

serverGroups -> (list)

The server groups included 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.