deployments

Creates, updates, deletes, gets or lists a deployments resource.

Overview

Name	deployments
Type	Resource
Id	aws.greengrass.deployments

Fields

The following fields are returned by SELECT queries:

list_deployments

Name	Datatype	Description
created_at	string	The time, in milliseconds since the epoch, when the deployment was created.
deployment_arn	string	The ARN of the deployment.
deployment_id	string	The ID of the deployment.
deployment_type	string	The type of deployment. When used for ''CreateDeployment'', only ''NewDeployment'' and ''Redeployment'' are valid. (NewDeployment, Redeployment, ResetDeployment, ForceResetDeployment)
group_arn	string	The ARN of the group for this deployment.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_deployments	select	group_id, region	MaxResults, NextToken	Returns a history of deployments for the group.
create_deployment	insert	group_id, region, DeploymentType	X-Amzn-Client-Token	Creates a deployment. ''CreateDeployment'' requests are idempotent with respect to the ''X-Amzn-Client-Token'' token and the request parameters.
reset_deployments	exec	group_id, region	X-Amzn-Client-Token	Resets a group's deployments.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
group_id	string	The ID of the Greengrass group.
region	string	AWS region (default: us-east-1)
MaxResults	string	The maximum number of results to be returned per request.
NextToken	string	The token for the next set of results, or ''null'' if there are no additional results.
X-Amzn-Client-Token	string	A client token used to correlate requests and responses.

SELECT examples

list_deployments

Returns a history of deployments for the group.

SELECT
created_at,
deployment_arn,
deployment_id,
deployment_type,
group_arn
FROM aws.greengrass.deployments
WHERE group_id = '{{ group_id }}' -- required
AND region = '{{ region }}' -- required
AND MaxResults = '{{ MaxResults }}'
AND NextToken = '{{ NextToken }}'
;

INSERT examples

create_deployment

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

INSERT INTO aws.greengrass.deployments (
DeploymentId,
DeploymentType,
GroupVersionId,
group_id,
region,
`X-Amzn-Client-Token`
)
SELECT 
'{{ DeploymentId }}',
'{{ DeploymentType }}' /* required */,
'{{ GroupVersionId }}',
'{{ group_id }}',
'{{ region }}',
'{{ X-Amzn-Client-Token }}'
RETURNING
deployment_arn,
deployment_id
;

Manifest

# Description fields are for documentation purposes
- name: deployments
props:
  - name: group_id
    value: "{{ group_id }}"
    description: Required parameter for the deployments resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the deployments resource.
  - name: DeploymentId
    value: "{{ DeploymentId }}"
  - name: DeploymentType
    value: "{{ DeploymentType }}"
    description: |
      The type of deployment. When used for ''CreateDeployment'', only ''NewDeployment'' and ''Redeployment'' are valid.
    valid_values: ['NewDeployment', 'Redeployment', 'ResetDeployment', 'ForceResetDeployment']
  - name: GroupVersionId
    value: "{{ GroupVersionId }}"
  - name: X-Amzn-Client-Token
    value: "{{ X-Amzn-Client-Token }}"
    description: A client token used to correlate requests and responses.
    description: A client token used to correlate requests and responses.

Lifecycle Methods

reset_deployments

Resets a group's deployments.

EXEC aws.greengrass.deployments.reset_deployments 
@group_id='{{ group_id }}' --required, 
@region='{{ region }}' --required, 
@X-Amzn-Client-Token='{{ X-Amzn-Client-Token }}' 
@@json=
'{
"Force": {{ Force }}
}'
;