list_deployments

list_deployments(**kwargs)

Returns a history of deployments for the group.

See also: AWS API Documentation

Request Syntax

response = client.list_deployments(
    GroupId='string',
    MaxResults='string',
    NextToken='string'
)

Parameters

• GroupId (string) -- [REQUIRED] The ID of the Greengrass group.
• 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.

Return type

dict

Returns

Response Syntax

{
    'Deployments': [
        {
            'CreatedAt': 'string',
            'DeploymentArn': 'string',
            'DeploymentId': 'string',
            'DeploymentType': 'NewDeployment'|'Redeployment'|'ResetDeployment'|'ForceResetDeployment',
            'GroupArn': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) -- Success. The response body contains the list of deployments for the given group.
  • Deployments (list) -- A list of deployments for the requested groups.
    • (dict) -- Information about a deployment.
      • CreatedAt (string) -- The time, in milliseconds since the epoch, when the deployment was created.
      • DeploymentArn (string) -- The ARN of the deployment.
      • DeploymentId (string) -- The ID of the deployment.
      • DeploymentType (string) -- The type of the deployment.
      • GroupArn (string) -- The ARN of the group for this deployment.
  • NextToken (string) -- The token for the next set of results, or ''null'' if there are no additional results.

Exceptions

• Greengrass.Client.exceptions.BadRequestException