- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
DescribeBackupPolicyCommand
Returns the backup policy for the specified EFS file system.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { EFSClient, DescribeBackupPolicyCommand } from "@aws-sdk/client-efs"; // ES Modules import
// const { EFSClient, DescribeBackupPolicyCommand } = require("@aws-sdk/client-efs"); // CommonJS import
const client = new EFSClient(config);
const input = { // DescribeBackupPolicyRequest
FileSystemId: "STRING_VALUE", // required
};
const command = new DescribeBackupPolicyCommand(input);
const response = await client.send(command);
// { // BackupPolicyDescription
// BackupPolicy: { // BackupPolicy
// Status: "ENABLED" || "ENABLING" || "DISABLED" || "DISABLING", // required
// },
// };
DescribeBackupPolicyCommand Input
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
FileSystemIdRequired | string | undefined | Specifies which EFS file system for which to retrieve the |
DescribeBackupPolicyCommand Output
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
BackupPolicy | BackupPolicy | undefined | Describes the file system's backup policy, indicating whether automatic backups are turned on or off. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| BadRequest | client | Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter. |
| FileSystemNotFound | client | Returned if the specified |
| InternalServerError | server | Returned if an error occurred on the server side. |
| PolicyNotFound | client | Returned if the default file system policy is in effect for the EFS file system specified. |
| ValidationException | client | Returned if the Backup service is not available in the Amazon Web Services Region in which the request was made. |
| EFSServiceException | Base exception class for all service exceptions from EFS service. |