AWS Greengrass
API Reference

CreateDeployment

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

URI: POST /greengrass/groups/GroupId/deployments

Produces: application/json

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" }

Parameters:

GroupId

The ID of the AWS Greengrass group.

where used: path; required: true

type: string

CreateDeploymentRequestBody

where used: body; required: true

{ "DeploymentType": "NewDeployment|Redeployment|ResetDeployment|ForceResetDeployment", "DeploymentId": "string", "GroupVersionId": "string" }

schema:

CreateDeploymentRequest

Information about a deployment.

type: object

required: ["DeploymentType"]

DeploymentType

The type of deployment.

type: string

enum: ["NewDeployment", "Redeployment", "ResetDeployment", "ForceResetDeployment"]

DeploymentId

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

type: string

GroupVersionId

The ID of the group version to be deployed.

type: string

X-Amzn-Client-Token

A client token used to correlate requests and responses.

where used: header; required: false

type: string

Responses:

200

Success. The group was deployed.

CreateDeploymentResponse

{ "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

GeneralError

{ "Message": "string", "ErrorDetails": [ { "DetailedErrorCode": "string", "DetailedErrorMessage": "string" } ] }
GeneralError

General error information.

type: object

required: ["Message"]

Message

A message containing 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