AWS IoT Greengrass Version 1 entered the extended life phase on June 30, 2023. For more information, see the AWS IoT Greengrass V1 maintenance policy. After this date, AWS IoT Greengrass V1 won't release updates that provide features, enhancements, bug fixes, or security patches. Devices that run on AWS IoT Greengrass V1 won't be disrupted and will continue to operate and to connect to the cloud. We strongly recommend that you migrate to AWS IoT Greengrass Version 2, which adds significant new features and support for additional platforms.
/greengrass/groups/GroupId/deployments
POST
POST /greengrass/groups/GroupId/deployments
Operation ID: CreateDeployment
Creates a deployment. CreateDeployment requests are idempotent with
respect to the X-Amzn-Client-Token token and the request parameters.
Produces: application/json
Body Parameters
- CreateDeploymentRequestBody
-
where used: body; required: true
{ "DeploymentType": "NewDeployment|Redeployment|ResetDeployment|ForceResetDeployment", "DeploymentId": "string", "GroupVersionId": "string" }- CreateDeploymentRequest
-
Information about a deployment.
type: object
required: ["DeploymentType"]
- DeploymentType
-
The type of deployment. When used for
CreateDeployment, onlyNewDeploymentandRedeploymentare valid.type: string
enum: ["NewDeployment", "Redeployment", "ResetDeployment", "ForceResetDeployment"]
- DeploymentId
-
The ID of the previous deployment you want to redeploy.
type: string
- GroupVersionId
-
The ID of the group version to be deployed.
type: string
Header Parameters
- X-Amzn-Client-Token
-
A client token used to correlate requests and responses.
where used: header; required: false
type: string
Path Parameters
- GroupId
-
The ID of the Greengrass group.
where used: path; required: true
type: string
CLI
aws greengrass create-deployment \ --group-id <value> \ [--deployment-type <value>] \ [--deployment-id <value>] \ [--group-version-id <value>] \ [--amzn-client-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{
"GroupId": "string",
"DeploymentType": "NewDeployment|Redeployment|ResetDeployment|ForceResetDeployment",
"DeploymentId": "string",
"GroupVersionId": "string",
"AmznClientToken": "string"
}Responses
- 200
-
Success. The group was deployed.
{ "DeploymentArn": "string", "DeploymentId": "string" }- CreateDeploymentResponse
-
type: object
- DeploymentArn
-
The ARN of the deployment.
type: string
- DeploymentId
-
The ID of the deployment.
type: string
- 400
-
Invalid request.
{ "Message": "string", "ErrorDetails": [ { "DetailedErrorCode": "string", "DetailedErrorMessage": "string" } ] }- GeneralError
-
General error information.
type: object
required: ["Message"]
- Message
-
A message that contains information about the error.
type: string
- ErrorDetails
-
A list of error details.
type: array
items: ErrorDetail
- ErrorDetail
-
Details about the error.
type: object
- DetailedErrorCode
-
A detailed error code.
type: string
- DetailedErrorMessage
-
A detailed error message.
type: string
GET
GET /greengrass/groups/GroupId/deployments
Operation ID: ListDeployments
Returns a history of deployments for the group.
Produces: application/json
Path Parameters
- GroupId
-
The ID of the Greengrass group.
where used: path; required: true
type: string
Query Parameters
- MaxResults
-
The maximum number of results to be returned per request.
where used: query; required: false
type: integer
- NextToken
-
The token for the next set of results, or
nullif there are no more results.where used: query; required: false
type: string
CLI
aws greengrass list-deployments \ --group-id <value> \ [--max-results <value>] \ [--next-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{
"GroupId": "string",
"MaxResults": "integer",
"NextToken": "string"
}Responses
- 200
-
Success. The response body contains the list of deployments for the given group.
{ "Deployments": [ { "GroupArn": "string", "DeploymentId": "string", "DeploymentArn": "string", "DeploymentType": "NewDeployment|Redeployment|ResetDeployment|ForceResetDeployment", "CreatedAt": "string" } ], "NextToken": "string" }- ListDeploymentsResponse
-
type: object
- Deployments
-
type: array
items: Deployment
- Deployment
-
Information about a deployment.
type: object
- GroupArn
-
The ARN of the group for this deployment.
type: string
- DeploymentId
-
The ID of the deployment.
type: string
- DeploymentArn
-
The ARN of the deployment.
type: string
- DeploymentType
-
The type of deployment. When used for
CreateDeployment, onlyNewDeploymentandRedeploymentare valid.type: string
enum: ["NewDeployment", "Redeployment", "ResetDeployment", "ForceResetDeployment"]
- CreatedAt
-
The time, in milliseconds since the epoch, when the deployment was created.
type: string
- NextToken
-
The token for the next set of results, or
nullif there are no more results.in: query
type: string
- 400
-
Invalid request.
{ "Message": "string", "ErrorDetails": [ { "DetailedErrorCode": "string", "DetailedErrorMessage": "string" } ] }- GeneralError
-
General error information.
type: object
required: ["Message"]
- Message
-
A message that contains information about the error.
type: string
- ErrorDetails
-
A list of error details.
type: array
items: ErrorDetail
- ErrorDetail
-
Details about the error.
type: object
- DetailedErrorCode
-
A detailed error code.
type: string
- DetailedErrorMessage
-
A detailed error message.
type: string
