|
| 1 | +<!-- DO NOT EDIT: this file is automatically generated using scw-doc-gen --> |
| 2 | +# Documentation for `scw environmental-footprint` |
| 3 | +Access and download impact reports and impact data for your Scaleway projects. Our API provides key metrics such as estimated carbon emissions and water usage to help monitor your environmental footprint. |
| 4 | + |
| 5 | +- [Environmental impact data management commands](#environmental-impact-data-management-commands) |
| 6 | + - [Retrieve detailed impact data](#retrieve-detailed-impact-data) |
| 7 | +- [Environmental impact report management commands](#environmental-impact-report-management-commands) |
| 8 | + - [Download PDF impact report](#download-pdf-impact-report) |
| 9 | + - [Get available impact reports](#get-available-impact-reports) |
| 10 | + |
| 11 | + |
| 12 | +## Environmental impact data management commands |
| 13 | + |
| 14 | +Environmental impact data management commands. |
| 15 | + |
| 16 | + |
| 17 | +### Retrieve detailed impact data |
| 18 | + |
| 19 | +Retrieve detailed impact data for your Scaleway projects within a specified date range. Filter by project ID, region, zone, service category, and/or product category. |
| 20 | + |
| 21 | +**Usage:** |
| 22 | + |
| 23 | +``` |
| 24 | +scw environmental-footprint data get [arg=value ...] |
| 25 | +``` |
| 26 | + |
| 27 | + |
| 28 | +**Args:** |
| 29 | + |
| 30 | +| Name | | Description | |
| 31 | +|------|---|-------------| |
| 32 | +| start-date | Required | Start date (inclusive) of the period for which you want to retrieve impact data (ISO 8601 format, e.g. 2025-05-01T00:00:00Z). | |
| 33 | +| end-date | | End date (exclusive) of the period for which you want to retrieve impact data (ISO 8601 format, with time in UTC, `YYYY-MM-DDTHH:MM:SSZ`). Defaults to today's date. | |
| 34 | +| regions.{index} | | List of regions to filter by (e.g. `fr-par`). Defaults to all regions. | |
| 35 | +| zones.{index} | | List of zones to filter by (e.g. `fr-par-1`). Defaults to all zones. | |
| 36 | +| project-ids.{index} | | List of Project IDs to filter by. Defaults to all Projects in the Organization. | |
| 37 | +| service-categories.{index} | One of: `unknown_service_category`, `baremetal`, `compute`, `storage`, `network`, `containers`, `databases` | List of service categories to filter by. Defaults to all service categories. | |
| 38 | +| product-categories.{index} | One of: `unknown_product_category`, `apple_silicon`, `block_storage`, `dedibox`, `elastic_metal`, `instances`, `object_storage`, `load_balancer`, `kubernetes`, `managed_relational_databases`, `managed_mongodb`, `managed_redis` | List of product categories to filter by. Defaults to all product categories. | |
| 39 | +| organization-id | | Organization ID to use. If none is passed the default organization ID will be used | |
| 40 | + |
| 41 | + |
| 42 | + |
| 43 | +## Environmental impact report management commands |
| 44 | + |
| 45 | +Environmental impact report management commands. |
| 46 | + |
| 47 | + |
| 48 | +### Download PDF impact report |
| 49 | + |
| 50 | +Download a Scaleway impact PDF report with detailed impact data for your Scaleway projects. |
| 51 | + |
| 52 | +**Usage:** |
| 53 | + |
| 54 | +``` |
| 55 | +scw environmental-footprint report get [arg=value ...] |
| 56 | +``` |
| 57 | + |
| 58 | + |
| 59 | +**Args:** |
| 60 | + |
| 61 | +| Name | | Description | |
| 62 | +|------|---|-------------| |
| 63 | +| date | Required | The start date of the period for which you want to download a report (ISO 8601 format, e.g. 2025-05-01T00:00:00Z). | |
| 64 | +| type | One of: `unknown_report_type`, `monthly`, `yearly` | Type of report to download (e.g. `monthly`). | |
| 65 | +| organization-id | | Organization ID to use. If none is passed the default organization ID will be used | |
| 66 | + |
| 67 | + |
| 68 | + |
| 69 | +### Get available impact reports |
| 70 | + |
| 71 | +Returns a list of dates of available impact reports. |
| 72 | + |
| 73 | +**Usage:** |
| 74 | + |
| 75 | +``` |
| 76 | +scw environmental-footprint report list [arg=value ...] |
| 77 | +``` |
| 78 | + |
| 79 | + |
| 80 | +**Args:** |
| 81 | + |
| 82 | +| Name | | Description | |
| 83 | +|------|---|-------------| |
| 84 | +| start-date | Required | Start date of the search period (ISO 8601 format, with time in UTC, `YYYY-MM-DDTHH:MM:SSZ`). The date is inclusive. | |
| 85 | +| end-date | | End date of the search period (ISO 8601 format, with time in UTC, `YYYY-MM-DDTHH:MM:SSZ`). The date is inclusive. Defaults to today's date. | |
| 86 | +| organization-id | | Organization ID to use. If none is passed the default organization ID will be used | |
| 87 | + |
| 88 | + |
| 89 | + |
0 commit comments