Menu
AWS Greengrass
API Reference

CreateDeployment

Creates a deployment.

URI: /greengrass/groups/GroupId/deployments

Operation: POST

Produces: application/json

Parameters:

  • GroupId

    The unique id of the AWS Greengrass group.

    where used: path

    required: true

    type: string

  • CreateDeploymentRequestBody

    Information needed to create a deployment.

    where used: body

    required: true

    schema:

    CreateDeploymentRequest

    type: object

    Information about a Deployment.

    required: DeploymentType

    properties:

    • DeploymentType:

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

      DeploymentType:

      type: string

      enum: NewDeployment|Redeployment

    • DeploymentId:

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

      type: string

    • GroupVersionId:

      The id of the version of the group you wish to deploy.

      type: string

    Example:

    Copy
    { "DeploymentType": "NewDeployment|Redeployment", "DeploymentId": "string", "GroupVersionId": "string" }
  • X-Amzn-Client-Token

    A client token used to correlate requests and responses.

    where used: header

    required: false

    type: string

Responses: