POST

/greengrass/groups/{GroupId}/deployments

http://greengrass.{region}.amazonaws.com/greengrass/groups/{GroupId}/deployments

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

Access Token Required: API Key

Path Parameters

GroupIdstringrequired

The ID of the Greengrass group.

Body Params

DeploymentIdstring

The ID of the deployment if you wish to redeploy a previous deployment.

DeploymentTypestringrequired

The type of deployment. When used for ''CreateDeployment'', only ''NewDeployment'' and ''Redeployment'' are valid.

GroupVersionIdstring

The ID of the group version to be deployed.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://greengrass.{region}.amazonaws.com/greengrass/groups/{GroupId}/deployments' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}