[ aws . greengrass ]



Creates a deployment. ‘’CreateDeployment’’ requests are idempotent with respect to the ‘’X-Amzn-Client-Token’’ token and the request parameters.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.


[--amzn-client-token <value>]
[--deployment-id <value>]
--deployment-type <value>
--group-id <value>
[--group-version-id <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]


--amzn-client-token (string) A client token used to correlate requests and responses.

--deployment-id (string) The ID of the deployment if you wish to redeploy a previous deployment.

--deployment-type (string) The type of deployment. When used for ‘’CreateDeployment’’, only ‘’NewDeployment’’ and ‘’Redeployment’’ are valid.

Possible values:

  • NewDeployment

  • Redeployment

  • ResetDeployment

  • ForceResetDeployment

--group-id (string) The ID of the Greengrass group.

--group-version-id (string) The ID of the group version to be deployed.

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


To create a deployment for a version of a Greengrass group

The following create-deployment example deploys the specified version of a Greengrass group.

aws greengrass create-deployment \
    --deployment-type NewDeployment \
    --group-id "ce2e7d01-3240-4c24-b8e6-f6f6e7a9eeca" \
    --group-version-id "dc40c1e9-e8c8-4d28-a84d-a9cad5f599c9"


    "DeploymentArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/ce2e7d01-3240-4c24-b8e6-f6f6e7a9eeca/deployments/bfceb608-4e97-45bc-af5c-460144270308",
    "DeploymentId": "bfceb608-4e97-45bc-af5c-460144270308"

For more information, see Getting Started with Connectors (CLI) in the AWS IoT Greengrass Developer Guide.


DeploymentArn -> (string)

The ARN of the deployment.

DeploymentId -> (string)

The ID of the deployment.