Greengrass / Client / get_bulk_deployment_status



Returns the status of a bulk deployment.

See also: AWS API Documentation

Request Syntax

response = client.get_bulk_deployment_status(

BulkDeploymentId (string) – [REQUIRED] The ID of the bulk deployment.

Return type:



Response Syntax

    'BulkDeploymentMetrics': {
        'InvalidInputRecords': 123,
        'RecordsProcessed': 123,
        'RetryAttempts': 123
    'BulkDeploymentStatus': 'Initializing'|'Running'|'Completed'|'Stopping'|'Stopped'|'Failed',
    'CreatedAt': 'string',
    'ErrorDetails': [
            'DetailedErrorCode': 'string',
            'DetailedErrorMessage': 'string'
    'ErrorMessage': 'string',
    'tags': {
        'string': 'string'

Response Structure

  • (dict) – Success. The response body contains the status of the bulk deployment.

    • BulkDeploymentMetrics (dict) – Relevant metrics on input records processed during bulk deployment.

      • InvalidInputRecords (integer) – The total number of records that returned a non-retryable error. For example, this can occur if a group record from the input file uses an invalid format or specifies a nonexistent group version, or if the execution role doesn’t grant permission to deploy a group or group version.

      • RecordsProcessed (integer) – The total number of group records from the input file that have been processed so far, or attempted.

      • RetryAttempts (integer) – The total number of deployment attempts that returned a retryable error. For example, a retry is triggered if the attempt to deploy a group returns a throttling error. ‘’StartBulkDeployment’’ retries a group deployment up to five times.

    • BulkDeploymentStatus (string) – The status of the bulk deployment.

    • CreatedAt (string) – The time, in ISO format, when the deployment was created.

    • ErrorDetails (list) – Error details

      • (dict) – Details about the error.

        • DetailedErrorCode (string) – A detailed error code.

        • DetailedErrorMessage (string) – A detailed error message.

    • ErrorMessage (string) – Error message

    • tags (dict) – Tag(s) attached to the resource arn.

      • (string) –

        • (string) –


  • Greengrass.Client.exceptions.BadRequestException