# ee.Dictionary.rename

Rename elements in a dictionary.

<br />

| Usage | Returns |
|---|---|
| `Dictionary.rename(from, to, *overwrite*)` | Dictionary |

| Argument | Type | Details |
|---|---|---|
| this: `dictionary` | Dictionary |   |
| `from` | List | A list of keys to be renamed. |
| `to` | List | A list of the new names for the keys listed in the 'from' parameter. Must have the same length as the 'from' list. |
| `overwrite` | Boolean, default: false | Allow overwriting existing properties with the same name. |

## Examples

### Code Editor (JavaScript)

```javascript
// A dictionary (e.g. results of ee.Image.reduceRegion of an S2 image).
var dict = ee.Dictionary({
  B1: 182,
  B2: 219,
  B3: 443
});

// Define from-to key name lists for selected keys.
var from = ['B2', 'B3'];
var to = ['Band_2', 'Band_3'];
print('Renamed keys', dict.rename(from, to));

print('Overwrite existing key names, e.g. B3 becomes B1',
      dict.rename({from: ['B3'], to: ['B1'], overwrite: true}));
```
Python setup

See the [Python Environment](https://developers.google.com/earth-engine/guides/python_install) page for information on the Python API and using
`geemap` for interactive development.

```python
import ee
import geemap.core as geemap
```

### Colab (Python)

```python
# A dictionary (e.g. results of ee.Image.reduceRegion of an S2 image).
dic = ee.Dictionary({
    'B1': 182,
    'B2': 219,
    'B3': 443
})

# Define from-to key name lists for selected keys.
frm = ['B2', 'B3']
to = ['Band_2', 'Band_3']
display('Renamed keys:', dic.rename(frm, to))

dic_overwrite = dic.rename(**{'from': ['B3'], 'to': ['B1'], 'overwrite': True})
display('Overwrite existing key names, e.g. B3 becomes B1:',
      dic_overwrite)
```