Greengrass / Client / create_deployment

create_deployment#

Greengrass.Client.create_deployment(**kwargs)#

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

Request Syntax

response = client.create_deployment(
    AmznClientToken='string',
    DeploymentId='string',
    DeploymentType='NewDeployment'|'Redeployment'|'ResetDeployment'|'ForceResetDeployment',
    GroupId='string',
    GroupVersionId='string'
)
Parameters:

  • AmznClientToken (string) – A client token used to correlate requests and responses.

  • DeploymentId (string) – The ID of the deployment if you wish to redeploy a previous deployment.

  • DeploymentType (string) – [REQUIRED] The type of deployment. When used for ‘’CreateDeployment’’, only ‘’NewDeployment’’ and ‘’Redeployment’’ are valid.

  • GroupId (string) – [REQUIRED] The ID of the Greengrass group.

  • GroupVersionId (string) – The ID of the group version to be deployed.

Return type:

dict

Returns:

Response Syntax

{
    'DeploymentArn': 'string',
    'DeploymentId': 'string'
}

Response Structure

  • (dict) – Success. The group was deployed.

    • DeploymentArn (string) – The ARN of the deployment.

    • DeploymentId (string) – The ID of the deployment.

Exceptions

  • Greengrass.Client.exceptions.BadRequestException