Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . emr ]



Adds a step to schedule automated HBase backup. This command is only available when using Amazon EMR versionsearlier than 4.0.

See 'aws help' for descriptions of global parameters.


--cluster-id <value>
--type <value>
--dir <value>
--interval <value>
--unit <value>
[--start-time <value>]


--cluster-id (string)

A unique string that identifies a cluster. The create-cluster command returns this identifier. You can use the list-clusters command to get cluster IDs.

--type (string)

Backup type. You can specify 'incremental' or 'full'.

--dir (string)

The Amazon S3 location of the Hbase backup. Example: s3://mybucket/mybackup , where mybucket is the specified Amazon S3 bucket and mybackup is the specified backup location. The path argument must begin with s3://, which refers to an Amazon S3 bucket.

--interval (string)

The time between backups.

--unit (string)

The time unit for backup's time-interval. You can specify one of the following values: 'minutes', 'hours', or 'days'.

--start-time (string)

The time of the first backup in ISO format.

e.g. 2014-04-21T05:26:10Z. Default is now.

--consistent (boolean)

Performs a consistent backup. Pauses all write operations to the HBase cluster during the backup process.

See 'aws help' for descriptions of global parameters.



To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal's quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

Note: This command can only be used with HBase on AMI version 2.x and 3.x

1. To schedule a full HBase backup >>>>>>> 06ab6d6e13564b5733d75abaf3b599f93cf39a23

  • Command:

    aws emr schedule-hbase-backup --cluster-id j-XXXXXXYY --type full --dir
    s3://myBucket/backup --interval 10 --unit hours --start-time
    2014-04-21T05:26:10Z --consistent
  • Output:


2. To schedule an incremental HBase backup

  • Command:

    aws emr schedule-hbase-backup --cluster-id j-XXXXXXYY --type incremental
     --dir s3://myBucket/backup --interval 30 --unit minutes --start-time
    2014-04-21T05:26:10Z --consistent
  • Output: