list_bulk_deployment_detailed_reports

Greengrass.Client.list_bulk_deployment_detailed_reports(**kwargs)

Gets a paginated list of the deployments that have been started in a bulk deployment operation, and their current deployment status.

See also: AWS API Documentation

Request Syntax

response = client.list_bulk_deployment_detailed_reports(
    BulkDeploymentId='string',
    MaxResults='string',
    NextToken='string'
)

Parameters

• BulkDeploymentId (string) -- [REQUIRED] The ID of the bulk deployment.
• 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',
            'DeploymentStatus': 'string',
            'DeploymentType': 'NewDeployment'|'Redeployment'|'ResetDeployment'|'ForceResetDeployment',
            'ErrorDetails': [
                {
                    'DetailedErrorCode': 'string',
                    'DetailedErrorMessage': 'string'
                },
            ],
            'ErrorMessage': 'string',
            '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 the individual group deployments in the bulk deployment operation.
    • (dict) -- Information about an individual group deployment in a bulk deployment operation.
      • CreatedAt (string) -- The time, in ISO format, when the deployment was created.
      • DeploymentArn (string) -- The ARN of the group deployment.
      • DeploymentId (string) -- The ID of the group deployment.
      • DeploymentStatus (string) -- The current status of the group deployment: ''InProgress'', ''Building'', ''Success'', or ''Failure''.
      • DeploymentType (string) -- The type of the deployment.
      • ErrorDetails (list) -- Details about the error.
        • (dict) -- Details about the error.
          • DetailedErrorCode (string) -- A detailed error code.
          • DetailedErrorMessage (string) -- A detailed error message.
      • ErrorMessage (string) -- The error message for a failed deployment
      • GroupArn (string) -- The ARN of the Greengrass group.
  • NextToken (string) -- The token for the next set of results, or ''null'' if there are no additional results.

Exceptions

• Greengrass.Client.exceptions.BadRequestException