Retrieve snapshot policies for an FSx system
Retrieves the snapshot policies for an existing FSx system. Use this to view the policies configured for managing snapshots on the system.
HTTP method and endpoint
GET /fsx/working-environments/{fileSystemId}/snapshot-policies
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
fileSystemId |
string |
path |
True |
Error
Status: Default, Default response
| Name | Type | Required | Description |
|---|---|---|---|
description |
string |
True |
Description |
name |
string |
True |
Name |
schedules |
array[PolicySchedule] |
True |
Schedules |
Example error response
{
"description": "string",
"name": "string",
"schedules": [
{
"frequency": "string",
"retention": 0
}
]
}
Definitions
See Definitions
PolicySchedule
| Name | Type | Required | Description |
|---|---|---|---|
frequency |
string |
True |
Frequency |
retention |
integer |
True |
Retention |