You are viewing the documentation for an older major version of the AWS SDK for JavaScript.
The modular AWS SDK for JavaScript (v3), the latest major version of AWS SDK for JavaScript, is now stable and recommended for general use. For more information, see the Migration Guide and API Reference.

Class: AWS.Backup

Inherits:
AWS.Service show all
Identifier:
backup
API Version:
2018-11-15
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

Backup is a unified backup service designed to protect Amazon Web Services services and their associated data. Backup simplifies the creation, migration, restoration, and deletion of backups, while also providing reporting and auditing.

Sending a Request Using Backup

var backup = new AWS.Backup();
backup.createBackupPlan(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the Backup object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var backup = new AWS.Backup({apiVersion: '2018-11-15'});

You can also set the API version globally in AWS.config.apiVersions using the backup service identifier:

AWS.config.apiVersions = {
  backup: '2018-11-15',
  // other service API versions
};

var backup = new AWS.Backup();

Version:

  • 2018-11-15

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.Backup(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a Backup object

var backup = new AWS.Backup({apiVersion: '2018-11-15'});

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.Backup.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.Backup.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.Backup.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional')

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean)

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean)

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean)

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean)

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined)

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number)

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean)

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional')

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

Property Details

endpointAWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

createBackupPlan(params = {}, callback) ⇒ AWS.Request

Creates a backup plan using a backup plan name and backup rules. A backup plan is a document that contains information that Backup uses to schedule tasks that create recovery points for resources.

If you call CreateBackupPlan with a plan that already exists, you receive an AlreadyExistsException exception.

Service Reference:

Examples:

Calling the createBackupPlan operation

var params = {
  BackupPlan: { /* required */
    BackupPlanName: 'STRING_VALUE', /* required */
    Rules: [ /* required */
      {
        RuleName: 'STRING_VALUE', /* required */
        TargetBackupVaultName: 'STRING_VALUE', /* required */
        CompletionWindowMinutes: 'NUMBER_VALUE',
        CopyActions: [
          {
            DestinationBackupVaultArn: 'STRING_VALUE', /* required */
            Lifecycle: {
              DeleteAfterDays: 'NUMBER_VALUE',
              MoveToColdStorageAfterDays: 'NUMBER_VALUE'
            }
          },
          /* more items */
        ],
        EnableContinuousBackup: true || false,
        Lifecycle: {
          DeleteAfterDays: 'NUMBER_VALUE',
          MoveToColdStorageAfterDays: 'NUMBER_VALUE'
        },
        RecoveryPointTags: {
          '<TagKey>': 'STRING_VALUE',
          /* '<TagKey>': ... */
        },
        ScheduleExpression: 'STRING_VALUE',
        StartWindowMinutes: 'NUMBER_VALUE'
      },
      /* more items */
    ],
    AdvancedBackupSettings: [
      {
        BackupOptions: {
          '<BackupOptionKey>': 'STRING_VALUE',
          /* '<BackupOptionKey>': ... */
        },
        ResourceType: 'STRING_VALUE'
      },
      /* more items */
    ]
  },
  BackupPlanTags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  },
  CreatorRequestId: 'STRING_VALUE'
};
backup.createBackupPlan(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • BackupPlan — (map)

      Specifies the body of a backup plan. Includes a BackupPlanName and one or more sets of Rules.

      • BackupPlanNamerequired — (String)

        The optional display name of a backup plan.

      • Rulesrequired — (Array<map>)

        An array of BackupRule objects, each of which specifies a scheduled task that is used to back up a selection of resources.

        • RuleNamerequired — (String)

          An optional display name for a backup rule.

        • TargetBackupVaultNamerequired — (String)

          The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

        • ScheduleExpression — (String)

          A CRON expression in UTC specifying when Backup initiates a backup job.

        • StartWindowMinutes — (Integer)

          A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully. This value is optional.

        • CompletionWindowMinutes — (Integer)

          A value in minutes after a backup job is successfully started before it must be completed or it will be canceled by Backup. This value is optional.

        • Lifecycle — (map)

          The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup will transition and expire backups automatically according to the lifecycle that you define.

          Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.

          Only Amazon EFS file system backups can be transitioned to cold storage.

          • MoveToColdStorageAfterDays — (Integer)

            Specifies the number of days after creation that a recovery point is moved to cold storage.

          • DeleteAfterDays — (Integer)

            Specifies the number of days after creation that a recovery point is deleted. Must be greater than 90 days plus MoveToColdStorageAfterDays.

        • RecoveryPointTags — (map<String>)

          To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair.

        • CopyActions — (Array<map>)

          An array of CopyAction objects, which contains the details of the copy operation.

          • Lifecycle — (map)

            Contains an array of Transition objects specifying how long in days before a recovery point transitions to cold storage or is deleted.

            Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, on the console, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.

            Only Amazon EFS file system backups can be transitioned to cold storage.

            • MoveToColdStorageAfterDays — (Integer)

              Specifies the number of days after creation that a recovery point is moved to cold storage.

            • DeleteAfterDays — (Integer)

              Specifies the number of days after creation that a recovery point is deleted. Must be greater than 90 days plus MoveToColdStorageAfterDays.

          • DestinationBackupVaultArnrequired — (String)

            An Amazon Resource Name (ARN) that uniquely identifies the destination backup vault for the copied backup. For example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

        • EnableContinuousBackup — (Boolean)

          Specifies whether Backup creates continuous backups. True causes Backup to create continuous backups capable of point-in-time restore (PITR). False (or not specified) causes Backup to create snapshot backups.

      • AdvancedBackupSettings — (Array<map>)

        Specifies a list of BackupOptions for each resource type. These settings are only available for Windows Volume Shadow Copy Service (VSS) backup jobs.

        • ResourceType — (String)

          Specifies an object containing resource type and backup options. The only supported resource type is Amazon EC2 instances with Windows Volume Shadow Copy Service (VSS). For a CloudFormation example, see the sample CloudFormation template to enable Windows VSS in the Backup User Guide.

          Valid values: EC2.

        • BackupOptions — (map<String>)

          Specifies the backup option for a selected resource. This option is only available for Windows VSS backup jobs.

          Valid values:

          Set to "WindowsVSS":"enabled" to enable the WindowsVSS backup option and create a Windows VSS backup.

          Set to "WindowsVSS":"disabled" to create a regular backup. The WindowsVSS option is not enabled by default.

          If you specify an invalid option, you get an InvalidParameterValueException exception.

          For more information about Windows VSS backups, see Creating a VSS-Enabled Windows Backup.

    • BackupPlanTags — (map<String>)

      To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair. The specified tags are assigned to all backups created with this plan.

    • CreatorRequestId — (String)

      Identifies the request and allows failed requests to be retried without the risk of running the operation twice. If the request includes a CreatorRequestId that matches an existing backup plan, that plan is returned. This parameter is optional.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • BackupPlanId — (String)

        Uniquely identifies a backup plan.

      • BackupPlanArn — (String)

        An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.

      • CreationDate — (Date)

        The date and time that a backup plan is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

      • VersionId — (String)

        Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. They cannot be edited.

      • AdvancedBackupSettings — (Array<map>)

        A list of BackupOptions settings for a resource type. This option is only available for Windows Volume Shadow Copy Service (VSS) backup jobs.

        • ResourceType — (String)

          Specifies an object containing resource type and backup options. The only supported resource type is Amazon EC2 instances with Windows Volume Shadow Copy Service (VSS). For a CloudFormation example, see the sample CloudFormation template to enable Windows VSS in the Backup User Guide.

          Valid values: EC2.

        • BackupOptions — (map<String>)

          Specifies the backup option for a selected resource. This option is only available for Windows VSS backup jobs.

          Valid values:

          Set to "WindowsVSS":"enabled" to enable the WindowsVSS backup option and create a Windows VSS backup.

          Set to "WindowsVSS":"disabled" to create a regular backup. The WindowsVSS option is not enabled by default.

          If you specify an invalid option, you get an InvalidParameterValueException exception.

          For more information about Windows VSS backups, see Creating a VSS-Enabled Windows Backup.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createBackupSelection(params = {}, callback) ⇒ AWS.Request

Creates a JSON document that specifies a set of resources to assign to a backup plan. Resources can be included by specifying patterns for a ListOfTags and selected Resources.

For example, consider the following patterns:

  • Resources: "arn:aws:ec2:region:account-id:volume/volume-id"

  • ConditionKey:"department"

    ConditionValue:"finance"

    ConditionType:"StringEquals"

  • ConditionKey:"importance"

    ConditionValue:"critical"

    ConditionType:"StringEquals"

Using these patterns would back up all Amazon Elastic Block Store (Amazon EBS) volumes that are tagged as "department=finance", "importance=critical", in addition to an EBS volume with the specified volume ID.

Resources and conditions are additive in that all resources that match the pattern are selected. This shouldn't be confused with a logical AND, where all conditions must match. The matching patterns are logically put together using the OR operator. In other words, all patterns that match are selected for backup.

Service Reference:

Examples:

Calling the createBackupSelection operation

var params = {
  BackupPlanId: 'STRING_VALUE', /* required */
  BackupSelection: { /* required */
    IamRoleArn: 'STRING_VALUE', /* required */
    SelectionName: 'STRING_VALUE', /* required */
    ListOfTags: [
      {
        ConditionKey: 'STRING_VALUE', /* required */
        ConditionType: STRINGEQUALS, /* required */
        ConditionValue: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    Resources: [
      'STRING_VALUE',
      /* more items */
    ]
  },
  CreatorRequestId: 'STRING_VALUE'
};
backup.createBackupSelection(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • BackupPlanId — (String)

      Uniquely identifies the backup plan to be associated with the selection of resources.

    • BackupSelection — (map)

      Specifies the body of a request to assign a set of resources to a backup plan.

      • SelectionNamerequired — (String)

        The display name of a resource selection document.

      • IamRoleArnrequired — (String)

        The ARN of the IAM role that Backup uses to authenticate when backing up the target resource; for example, arn:aws:iam::123456789012:role/S3Access.

      • Resources — (Array<String>)

        An array of strings that contain Amazon Resource Names (ARNs) of resources to assign to a backup plan.

      • ListOfTags — (Array<map>)

        An array of conditions used to specify a set of resources to assign to a backup plan; for example, "StringEquals": {"ec2:ResourceTag/Department": "accounting". Assigns the backup plan to every resource with at least one matching tag.

        • ConditionTyperequired — (String)

          An operation, such as StringEquals, that is applied to a key-value pair used to filter resources in a selection.

          Possible values include:
          • "STRINGEQUALS"
        • ConditionKeyrequired — (String)

          The key in a key-value pair. For example, in "ec2:ResourceTag/Department": "accounting", "ec2:ResourceTag/Department" is the key.

        • ConditionValuerequired — (String)

          The value in a key-value pair. For example, in "ec2:ResourceTag/Department": "accounting", "accounting" is the value.

    • CreatorRequestId — (String)

      A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • SelectionId — (String)

        Uniquely identifies the body of a request to assign a set of resources to a backup plan.

      • BackupPlanId — (String)

        Uniquely identifies a backup plan.

      • CreationDate — (Date)

        The date and time a backup selection is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createBackupVault(params = {}, callback) ⇒ AWS.Request

Creates a logical container where backups are stored. A CreateBackupVault request includes a name, optionally one or more resource tags, an encryption key, and a request ID.

Note: Do not include sensitive data, such as passport numbers, in the name of a backup vault.

Service Reference:

Examples:

Calling the createBackupVault operation

var params = {
  BackupVaultName: 'STRING_VALUE', /* required */
  BackupVaultTags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  },
  CreatorRequestId: 'STRING_VALUE',
  EncryptionKeyArn: 'STRING_VALUE'
};
backup.createBackupVault(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • BackupVaultName — (String)

      The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of letters, numbers, and hyphens.

    • BackupVaultTags — (map<String>)

      Metadata that you can assign to help organize the resources that you create. Each tag is a key-value pair.

    • EncryptionKeyArn — (String)

      The server-side encryption key that is used to protect your backups; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.

    • CreatorRequestId — (String)

      A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • BackupVaultName — (String)

        The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created. They consist of lowercase letters, numbers, and hyphens.

      • BackupVaultArn — (String)

        An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

      • CreationDate — (Date)

        The date and time a backup vault is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createFramework(params = {}, callback) ⇒ AWS.Request

Creates a framework with one or more controls. A framework is a collection of controls that you can use to evaluate your backup practices. By using pre-built customizable controls to define your policies, you can evaluate whether your backup practices comply with your policies. To get insights into the compliance status of your frameworks, you can set up automatic daily reports.

Service Reference:

Examples:

Calling the createFramework operation

var params = {
  FrameworkControls: [ /* required */
    {
      ControlName: 'STRING_VALUE', /* required */
      ControlInputParameters: [
        {
          ParameterName: 'STRING_VALUE',
          ParameterValue: 'STRING_VALUE'
        },
        /* more items */
      ],
      ControlScope: {
        ComplianceResourceIds: [
          'STRING_VALUE',
          /* more items */
        ],
        ComplianceResourceTypes: [
          'STRING_VALUE',
          /* more items */
        ],
        Tags: {
          '<string>': 'STRING_VALUE',
          /* '<string>': ... */
        }
      }
    },
    /* more items */
  ],
  FrameworkName: 'STRING_VALUE', /* required */
  FrameworkDescription: 'STRING_VALUE',
  FrameworkTags: {
    '<string>': 'STRING_VALUE',
    /* '<string>': ... */
  },
  IdempotencyToken: 'STRING_VALUE'
};
backup.createFramework(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FrameworkName — (String)

      The unique name of the framework. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).

    • FrameworkDescription — (String)

      An optional description of the framework with a maximum of 1,024 characters.

    • FrameworkControls — (Array<map>)

      A list of the controls that make up the framework. Each control in the list has a name, input parameters, and scope.

      • ControlNamerequired — (String)

        The name of a control. This name is between 1 and 256 characters.

      • ControlInputParameters — (Array<map>)

        A list of ParameterName and ParameterValue pairs.

        • ParameterName — (String)

          The name of a parameter, for example, BackupPlanFrequency.

        • ParameterValue — (String)

          The value of parameter, for example, hourly.

      • ControlScope — (map)

        The scope of a control. The control scope defines what the control will evaluate. Three examples of control scopes are: a specific backup plan, all backup plans with a specific tag, or all backup plans. For more information, see ControlScope.

        • ComplianceResourceIds — (Array<String>)

          Describes whether the control scope includes a specific resource identified by its unique Amazon Resource Name (ARN).

        • ComplianceResourceTypes — (Array<String>)

          Describes whether the control scope includes one or more types of resources, such as EFS or RDS.

        • Tags — (map<String>)

          Describes whether the control scope includes resources with one or more tags. Each tag is a key-value pair.

    • IdempotencyToken — (String)

      A customer-chosen string that you can use to distinguish between otherwise identical calls to CreateFrameworkInput. Retrying a successful request with the same idempotency token results in a success message with no action taken.

      If a token is not provided, the SDK will use a version 4 UUID.
    • FrameworkTags — (map<String>)

      Metadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • FrameworkName — (String)

        The unique name of the framework. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).

      • FrameworkArn — (String)

        An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createReportPlan(params = {}, callback) ⇒ AWS.Request

Creates a report plan. A report plan is a document that contains information about the contents of the report and where Backup will deliver it.

If you call CreateReportPlan with a plan that already exists, you receive an AlreadyExistsException exception.

Service Reference:

Examples:

Calling the createReportPlan operation

var params = {
  ReportDeliveryChannel: { /* required */
    S3BucketName: 'STRING_VALUE', /* required */
    Formats: [
      'STRING_VALUE',
      /* more items */
    ],
    S3KeyPrefix: 'STRING_VALUE'
  },
  ReportPlanName: 'STRING_VALUE', /* required */
  ReportSetting: { /* required */
    ReportTemplate: 'STRING_VALUE' /* required */
  },
  IdempotencyToken: 'STRING_VALUE',
  ReportPlanDescription: 'STRING_VALUE',
  ReportPlanTags: {
    '<string>': 'STRING_VALUE',
    /* '<string>': ... */
  }
};
backup.createReportPlan(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ReportPlanName — (String)

      The unique name of the report plan. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).

    • ReportPlanDescription — (String)

      An optional description of the report plan with a maximum of 1,024 characters.

    • ReportDeliveryChannel — (map)

      A structure that contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.

      • S3BucketNamerequired — (String)

        The unique name of the S3 bucket that receives your reports.

      • S3KeyPrefix — (String)

        The prefix for where Backup Audit Manager delivers your reports to Amazon S3. The prefix is this part of the following path: s3://your-bucket-name/prefix/Backup/us-west-2/year/month/day/report-name. If not specified, there is no prefix.

      • Formats — (Array<String>)

        A list of the format of your reports: CSV, JSON, or both. If not specified, the default format is CSV.

    • ReportSetting — (map)

      Identifies the report template for the report. Reports are built using a report template. The report templates are:

      BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT

      • ReportTemplaterequired — (String)

        Identifies the report template for the report. Reports are built using a report template. The report templates are:

        BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT

    • ReportPlanTags — (map<String>)

      Metadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair.

    • IdempotencyToken — (String)

      A customer-chosen string that you can use to distinguish between otherwise identical calls to CreateReportPlanInput. Retrying a successful request with the same idempotency token results in a success message with no action taken.

      If a token is not provided, the SDK will use a version 4 UUID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ReportPlanName — (String)

        The unique name of the report plan.

      • ReportPlanArn — (String)

        An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteBackupPlan(params = {}, callback) ⇒ AWS.Request

Deletes a backup plan. A backup plan can only be deleted after all associated selections of resources have been deleted. Deleting a backup plan deletes the current version of a backup plan. Previous versions, if any, will still exist.

Service Reference:

Examples:

Calling the deleteBackupPlan operation

var params = {
  BackupPlanId: 'STRING_VALUE' /* required */
};
backup.deleteBackupPlan(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • BackupPlanId — (String)

      Uniquely identifies a backup plan.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • BackupPlanId — (String)

        Uniquely identifies a backup plan.

      • BackupPlanArn — (String)

        An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.

      • DeletionDate — (Date)

        The date and time a backup plan is deleted, in Unix format and Coordinated Universal Time (UTC). The value of DeletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

      • VersionId — (String)

        Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteBackupSelection(params = {}, callback) ⇒ AWS.Request

Deletes the resource selection associated with a backup plan that is specified by the SelectionId.

Service Reference:

Examples:

Calling the deleteBackupSelection operation

var params = {
  BackupPlanId: 'STRING_VALUE', /* required */
  SelectionId: 'STRING_VALUE' /* required */
};
backup.deleteBackupSelection(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • BackupPlanId — (String)

      Uniquely identifies a backup plan.

    • SelectionId — (String)

      Uniquely identifies the body of a request to assign a set of resources to a backup plan.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteBackupVault(params = {}, callback) ⇒ AWS.Request

Deletes the backup vault identified by its name. A vault can be deleted only if it is empty.

Service Reference:

Examples:

Calling the deleteBackupVault operation

var params = {
  BackupVaultName: 'STRING_VALUE' /* required */
};
backup.deleteBackupVault(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • BackupVaultName — (String)

      The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteBackupVaultAccessPolicy(params = {}, callback) ⇒ AWS.Request

Deletes the policy document that manages permissions on a backup vault.

Service Reference:

Examples:

Calling the deleteBackupVaultAccessPolicy operation

var params = {
  BackupVaultName: 'STRING_VALUE' /* required */
};
backup.deleteBackupVaultAccessPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • BackupVaultName — (String)

      The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteBackupVaultNotifications(params = {}, callback) ⇒ AWS.Request

Deletes event notifications for the specified backup vault.

Service Reference:

Examples:

Calling the deleteBackupVaultNotifications operation

var params = {
  BackupVaultName: 'STRING_VALUE' /* required */
};
backup.deleteBackupVaultNotifications(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • BackupVaultName — (String)

      The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created. They consist of lowercase letters, numbers, and hyphens.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteFramework(params = {}, callback) ⇒ AWS.Request

Deletes the framework specified by a framework name.

Service Reference:

Examples:

Calling the deleteFramework operation

var params = {
  FrameworkName: 'STRING_VALUE' /* required */
};
backup.deleteFramework(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FrameworkName — (String)

      The unique name of a framework.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteRecoveryPoint(params = {}, callback) ⇒ AWS.Request

Deletes the recovery point specified by a recovery point ID.

If the recovery point ID belongs to a continuous backup, calling this endpoint deletes the existing continuous backup and stops future continuous backup.

Service Reference:

Examples:

Calling the deleteRecoveryPoint operation

var params = {
  BackupVaultName: 'STRING_VALUE', /* required */
  RecoveryPointArn: 'STRING_VALUE' /* required */
};
backup.deleteRecoveryPoint(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • BackupVaultName — (String)

      The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

    • RecoveryPointArn — (String)

      An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteReportPlan(params = {}, callback) ⇒ AWS.Request

Deletes the report plan specified by a report plan name.

Service Reference:

Examples:

Calling the deleteReportPlan operation

var params = {
  ReportPlanName: 'STRING_VALUE' /* required */
};
backup.deleteReportPlan(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ReportPlanName — (String)

      The unique name of a report plan.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeBackupJob(params = {}, callback) ⇒ AWS.Request

Returns backup job details for the specified BackupJobId.

Service Reference:

Examples:

Calling the describeBackupJob operation

var params = {
  BackupJobId: 'STRING_VALUE' /* required */
};
backup.describeBackupJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • BackupJobId — (String)

      Uniquely identifies a request to Backup to back up a resource.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • AccountId — (String)

        Returns the account ID that owns the backup job.

      • BackupJobId — (String)

        Uniquely identifies a request to Backup to back up a resource.

      • BackupVaultName — (String)

        The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

      • BackupVaultArn — (String)

        An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

      • RecoveryPointArn — (String)

        An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

      • ResourceArn — (String)

        An ARN that uniquely identifies a saved resource. The format of the ARN depends on the resource type.

      • CreationDate — (Date)

        The date and time that a backup job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

      • CompletionDate — (Date)

        The date and time that a job to create a backup job is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

      • State — (String)

        The current state of a resource recovery point.

        Possible values include:
        • "CREATED"
        • "PENDING"
        • "RUNNING"
        • "ABORTING"
        • "ABORTED"
        • "COMPLETED"
        • "FAILED"
        • "EXPIRED"
      • StatusMessage — (String)

        A detailed message explaining the status of the job to back up a resource.

      • PercentDone — (String)

        Contains an estimated percentage that is complete of a job at the time the job status was queried.

      • BackupSizeInBytes — (Integer)

        The size, in bytes, of a backup.

      • IamRoleArn — (String)

        Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

      • CreatedBy — (map)

        Contains identifying information about the creation of a backup job, including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan that is used to create it.

        • BackupPlanId — (String)

          Uniquely identifies a backup plan.

        • BackupPlanArn — (String)

          An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.

        • BackupPlanVersion — (String)

          Version IDs are unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. They cannot be edited.

        • BackupRuleId — (String)

          Uniquely identifies a rule used to schedule the backup of a selection of resources.

      • ResourceType — (String)

        The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

      • BytesTransferred — (Integer)

        The size in bytes transferred to a backup vault at the time that the job status was queried.

      • ExpectedCompletionDate — (Date)

        The date and time that a job to back up resources is expected to be completed, in Unix format and Coordinated Universal Time (UTC). The value of ExpectedCompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

      • StartBy — (Date)

        Specifies the time in Unix format and Coordinated Universal Time (UTC) when a backup job must be started before it is canceled. The value is calculated by adding the start window to the scheduled time. So if the scheduled time were 6:00 PM and the start window is 2 hours, the StartBy time would be 8:00 PM on the date specified. The value of StartBy is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

      • BackupOptions — (map<String>)

        Represents the options specified as part of backup plan or on-demand backup job.

      • BackupType — (String)

        Represents the actual backup type selected for a backup job. For example, if a successful Windows Volume Shadow Copy Service (VSS) backup was taken, BackupType returns "WindowsVSS". If BackupType is empty, then the backup type was a regular backup.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeBackupVault(params = {}, callback) ⇒ AWS.Request

Returns metadata about a backup vault specified by its name.

Service Reference:

Examples:

Calling the describeBackupVault operation

var params = {
  BackupVaultName: 'STRING_VALUE' /* required */
};
backup.describeBackupVault(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • BackupVaultName — (String)

      The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • BackupVaultName — (String)

        The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created. They consist of lowercase letters, numbers, and hyphens.

      • BackupVaultArn — (String)

        An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

      • EncryptionKeyArn — (String)

        The server-side encryption key that is used to protect your backups; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.

      • CreationDate — (Date)

        The date and time that a backup vault is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

      • CreatorRequestId — (String)

        A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice.

      • NumberOfRecoveryPoints — (Integer)

        The number of recovery points that are stored in a backup vault.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeCopyJob(params = {}, callback) ⇒ AWS.Request

Returns metadata associated with creating a copy of a resource.

Service Reference:

Examples:

Calling the describeCopyJob operation

var params = {
  CopyJobId: 'STRING_VALUE' /* required */
};
backup.describeCopyJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • CopyJobId — (String)

      Uniquely identifies a copy job.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • CopyJob — (map)

        Contains detailed information about a copy job.

        • AccountId — (String)

          The account ID that owns the copy job.

        • CopyJobId — (String)

          Uniquely identifies a copy job.

        • SourceBackupVaultArn — (String)

          An Amazon Resource Name (ARN) that uniquely identifies a source copy vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

        • SourceRecoveryPointArn — (String)

          An ARN that uniquely identifies a source recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

        • DestinationBackupVaultArn — (String)

          An Amazon Resource Name (ARN) that uniquely identifies a destination copy vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

        • DestinationRecoveryPointArn — (String)

          An ARN that uniquely identifies a destination recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

        • ResourceArn — (String)

          The Amazon Web Services resource to be copied; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

        • CreationDate — (Date)

          The date and time a copy job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

        • CompletionDate — (Date)

          The date and time a copy job is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

        • State — (String)

          The current state of a copy job.

          Possible values include:
          • "CREATED"
          • "RUNNING"
          • "COMPLETED"
          • "FAILED"
        • StatusMessage — (String)

          A detailed message explaining the status of the job to copy a resource.

        • BackupSizeInBytes — (Integer)

          The size, in bytes, of a copy job.

        • IamRoleArn — (String)

          Specifies the IAM role ARN used to copy the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

        • CreatedBy — (map)

          Contains information about the backup plan and rule that Backup used to initiate the recovery point backup.

          • BackupPlanId — (String)

            Uniquely identifies a backup plan.

          • BackupPlanArn — (String)

            An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.

          • BackupPlanVersion — (String)

            Version IDs are unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. They cannot be edited.

          • BackupRuleId — (String)

            Uniquely identifies a rule used to schedule the backup of a selection of resources.

        • ResourceType — (String)

          The type of Amazon Web Services resource to be copied; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeFramework(params = {}, callback) ⇒ AWS.Request

Returns the framework details for the specified FrameworkName.

Service Reference:

Examples:

Calling the describeFramework operation

var params = {
  FrameworkName: 'STRING_VALUE' /* required */
};
backup.describeFramework(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FrameworkName — (String)

      The unique name of a framework.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • FrameworkName — (String)

        The unique name of a framework.

      • FrameworkArn — (String)

        An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

      • FrameworkDescription — (String)

        An optional description of the framework.

      • FrameworkControls — (Array<map>)

        A list of the controls that make up the framework. Each control in the list has a name, input parameters, and scope.

        • ControlNamerequired — (String)

          The name of a control. This name is between 1 and 256 characters.

        • ControlInputParameters — (Array<map>)

          A list of ParameterName and ParameterValue pairs.

          • ParameterName — (String)

            The name of a parameter, for example, BackupPlanFrequency.

          • ParameterValue — (String)

            The value of parameter, for example, hourly.

        • ControlScope — (map)

          The scope of a control. The control scope defines what the control will evaluate. Three examples of control scopes are: a specific backup plan, all backup plans with a specific tag, or all backup plans. For more information, see ControlScope.

          • ComplianceResourceIds — (Array<String>)

            Describes whether the control scope includes a specific resource identified by its unique Amazon Resource Name (ARN).

          • ComplianceResourceTypes — (Array<String>)

            Describes whether the control scope includes one or more types of resources, such as EFS or RDS.

          • Tags — (map<String>)

            Describes whether the control scope includes resources with one or more tags. Each tag is a key-value pair.

      • CreationTime — (Date)

        The date and time that a framework is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

      • DeploymentStatus — (String)

        The deployment status of a framework. The statuses are:

        CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED

      • FrameworkStatus — (String)

        A framework consists of one or more controls. Each control governs a resource, such as backup plans, backup selections, backup vaults, or recovery points. You can also turn Config recording on or off for each resource. The statuses are:

        • ACTIVE when recording is turned on for all resources governed by the framework.

        • PARTIALLY_ACTIVE when recording is turned off for at least one resource governed by the framework.

        • INACTIVE when recording is turned off for all resources governed by the framework.

        • UNAVAILABLE when Backup is unable to validate recording status at this time.

      • IdempotencyToken — (String)

        A customer-chosen string that you can use to distinguish between otherwise identical calls to DescribeFrameworkOutput. Retrying a successful request with the same idempotency token results in a success message with no action taken.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeGlobalSettings(params = {}, callback) ⇒ AWS.Request

Describes whether the Amazon Web Services account is opted in to cross-account backup. Returns an error if the account is not a member of an Organizations organization. Example: describe-global-settings --region us-west-2

Service Reference:

Examples:

Calling the describeGlobalSettings operation

var params = {
};
backup.describeGlobalSettings(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • GlobalSettings — (map<String>)

        The status of the flag isCrossAccountBackupEnabled.

      • LastUpdateTime — (Date)

        The date and time that the flag isCrossAccountBackupEnabled was last updated. This update is in Unix format and Coordinated Universal Time (UTC). The value of LastUpdateTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeProtectedResource(params = {}, callback) ⇒ AWS.Request

Returns information about a saved resource, including the last time it was backed up, its Amazon Resource Name (ARN), and the Amazon Web Services service type of the saved resource.

Service Reference:

Examples:

Calling the describeProtectedResource operation

var params = {
  ResourceArn: 'STRING_VALUE' /* required */
};
backup.describeProtectedResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceArn — (String)

      An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ResourceArn — (String)

        An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.

      • ResourceType — (String)

        The type of Amazon Web Services resource saved as a recovery point; for example, an Amazon EBS volume or an Amazon RDS database.

      • LastBackupTime — (Date)

        The date and time that a resource was last backed up, in Unix format and Coordinated Universal Time (UTC). The value of LastBackupTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeRecoveryPoint(params = {}, callback) ⇒ AWS.Request

Returns metadata associated with a recovery point, including ID, status, encryption, and lifecycle.

Service Reference:

Examples:

Calling the describeRecoveryPoint operation

var params = {
  BackupVaultName: 'STRING_VALUE', /* required */
  RecoveryPointArn: 'STRING_VALUE' /* required */
};
backup.describeRecoveryPoint(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • BackupVaultName — (String)

      The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

    • RecoveryPointArn — (String)

      An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • RecoveryPointArn — (String)

        An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

      • BackupVaultName — (String)

        The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created. They consist of lowercase letters, numbers, and hyphens.

      • BackupVaultArn — (String)

        An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

      • SourceBackupVaultArn — (String)

        An Amazon Resource Name (ARN) that uniquely identifies the source vault where the resource was originally backed up in; for example, arn:aws:backup:us-east-1:123456789012:vault:BackupVault. If the recovery is restored to the same Amazon Web Services account or Region, this value will be null.

      • ResourceArn — (String)

        An ARN that uniquely identifies a saved resource. The format of the ARN depends on the resource type.

      • ResourceType — (String)

        The type of Amazon Web Services resource to save as a recovery point; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

      • CreatedBy — (map)

        Contains identifying information about the creation of a recovery point, including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan used to create it.

        • BackupPlanId — (String)

          Uniquely identifies a backup plan.

        • BackupPlanArn — (String)

          An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.

        • BackupPlanVersion — (String)

          Version IDs are unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. They cannot be edited.

        • BackupRuleId — (String)

          Uniquely identifies a rule used to schedule the backup of a selection of resources.

      • IamRoleArn — (String)

        Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

      • Status — (String)

        A status code specifying the state of the recovery point.

        PARTIAL status indicates Backup could not create the recovery point before the backup window closed. To increase your backup plan window using the API, see UpdateBackupPlan. You can also increase your backup plan window using the Console by choosing and editing your backup plan.

        EXPIRED status indicates that the recovery point has exceeded its retention period, but Backup lacks permission or is otherwise unable to delete it. To manually delete these recovery points, see Step 3: Delete the recovery points in the Clean up resources section of Getting started.

        Possible values include:
        • "COMPLETED"
        • "PARTIAL"
        • "DELETING"
        • "EXPIRED"
      • StatusMessage — (String)

        A status message explaining the reason for the recovery point deletion failure.

      • CreationDate — (Date)

        The date and time that a recovery point is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

      • CompletionDate — (Date)

        The date and time that a job to create a recovery point is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

      • BackupSizeInBytes — (Integer)

        The size, in bytes, of a backup.

      • CalculatedLifecycle — (map)

        A CalculatedLifecycle object containing DeleteAt and MoveToColdStorageAt timestamps.

        • MoveToColdStorageAt — (Date)

          A timestamp that specifies when to transition a recovery point to cold storage.

        • DeleteAt — (Date)

          A timestamp that specifies when to delete a recovery point.

      • Lifecycle — (map)

        The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define.

        Backups that are transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.

        Only Amazon EFS file system backups can be transitioned to cold storage.

        • MoveToColdStorageAfterDays — (Integer)

          Specifies the number of days after creation that a recovery point is moved to cold storage.

        • DeleteAfterDays — (Integer)

          Specifies the number of days after creation that a recovery point is deleted. Must be greater than 90 days plus MoveToColdStorageAfterDays.

      • EncryptionKeyArn — (String)

        The server-side encryption key used to protect your backups; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.

      • IsEncrypted — (Boolean)

        A Boolean value that is returned as TRUE if the specified recovery point is encrypted, or FALSE if the recovery point is not encrypted.

      • StorageClass — (String)

        Specifies the storage class of the recovery point. Valid values are WARM or COLD.

        Possible values include:
        • "WARM"
        • "COLD"
        • "DELETED"
      • LastRestoreTime — (Date)

        The date and time that a recovery point was last restored, in Unix format and Coordinated Universal Time (UTC). The value of LastRestoreTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeRegionSettings(params = {}, callback) ⇒ AWS.Request

Returns the current service opt-in settings for the Region. If service opt-in is enabled for a service, Backup tries to protect that service's resources in this Region, when the resource is included in an on-demand backup or scheduled backup plan. Otherwise, Backup does not try to protect that service's resources in this Region.

Service Reference:

Examples:

Calling the describeRegionSettings operation

var params = {
};
backup.describeRegionSettings(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ResourceTypeOptInPreference — (map<Boolean>)

        Returns a list of all services along with the opt-in preferences in the Region.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeReportJob(params = {}, callback) ⇒ AWS.Request

Returns the details associated with creating a report as specified by its ReportJobId.

Service Reference:

Examples:

Calling the describeReportJob operation

var params = {
  ReportJobId: 'STRING_VALUE' /* required */
};
backup.describeReportJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ReportJobId — (String)

      The identifier of the report job. A unique, randomly generated, Unicode, UTF-8 encoded string that is at most 1,024 bytes long. The report job ID cannot be edited.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ReportJob — (map)

        A list of information about a report job, including its completion and creation times, report destination, unique report job ID, Amazon Resource Name (ARN), report template, status, and status message.

        • ReportJobId — (String)

          The identifier for a report job. A unique, randomly generated, Unicode, UTF-8 encoded string that is at most 1,024 bytes long. Report job IDs cannot be edited.

        • ReportPlanArn — (String)

          An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

        • ReportTemplate — (String)

          Identifies the report template for the report. Reports are built using a report template. The report templates are:

          BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT

        • CreationTime — (Date)

          The date and time that a report job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

        • CompletionTime — (Date)

          The date and time that a report job is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

        • Status — (String)

          The status of a report job. The statuses are:

          CREATED | RUNNING | COMPLETED | FAILED

          COMPLETED means that the report is available for your review at your designated destination. If the status is FAILED, review the StatusMessage for the reason.

        • StatusMessage — (String)

          A message explaining the status of the report job.

        • ReportDestination — (map)

          The S3 bucket name and S3 keys for the destination where the report job publishes the report.

          • S3BucketName — (String)

            The unique name of the Amazon S3 bucket that receives your reports.

          • S3Keys — (Array<String>)

            The object key that uniquely identifies your reports in your S3 bucket.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeReportPlan(params = {}, callback) ⇒ AWS.Request

Returns a list of all report plans for an Amazon Web Services account and Amazon Web Services Region.

Service Reference:

Examples:

Calling the describeReportPlan operation

var params = {
  ReportPlanName: 'STRING_VALUE' /* required */
};
backup.describeReportPlan(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ReportPlanName — (String)

      The unique name of a report plan.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ReportPlan — (map)

        Returns details about the report plan that is specified by its name. These details include the report plan's Amazon Resource Name (ARN), description, settings, delivery channel, deployment status, creation time, and last attempted and successful run times.

        • ReportPlanArn — (String)

          An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

        • ReportPlanName — (String)

          The unique name of the report plan. This name is between 1 and 256 characters starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).

        • ReportPlanDescription — (String)

          An optional description of the report plan with a maximum 1,024 characters.

        • ReportSetting — (map)

          Identifies the report template for the report. Reports are built using a report template. The report templates are:

          BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT

          • ReportTemplaterequired — (String)

            Identifies the report template for the report. Reports are built using a report template. The report templates are:

            BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT

        • ReportDeliveryChannel — (map)

          Contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.

          • S3BucketNamerequired — (String)

            The unique name of the S3 bucket that receives your reports.

          • S3KeyPrefix — (String)

            The prefix for where Backup Audit Manager delivers your reports to Amazon S3. The prefix is this part of the following path: s3://your-bucket-name/prefix/Backup/us-west-2/year/month/day/report-name. If not specified, there is no prefix.

          • Formats — (Array<String>)

            A list of the format of your reports: CSV, JSON, or both. If not specified, the default format is CSV.

        • DeploymentStatus — (String)

          The deployment status of a report plan. The statuses are:

          CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED

        • CreationTime — (Date)

          The date and time that a report plan is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

        • LastAttemptedExecutionTime — (Date)

          The date and time that a report job associated with this report plan last attempted to run, in Unix format and Coordinated Universal Time (UTC). The value of LastAttemptedExecutionTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

        • LastSuccessfulExecutionTime — (Date)

          The date and time that a report job associated with this report plan last successfully ran, in Unix format and Coordinated Universal Time (UTC). The value of LastSuccessfulExecutionTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeRestoreJob(params = {}, callback) ⇒ AWS.Request

Returns metadata associated with a restore job that is specified by a job ID.

Service Reference:

Examples:

Calling the describeRestoreJob operation

var params = {
  RestoreJobId: 'STRING_VALUE' /* required */
};
backup.describeRestoreJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • RestoreJobId — (String)

      Uniquely identifies the job that restores a recovery point.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • AccountId — (String)

        Returns the account ID that owns the restore job.

      • RestoreJobId — (String)

        Uniquely identifies the job that restores a recovery point.

      • RecoveryPointArn — (String)

        An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

      • CreationDate — (Date)

        The date and time that a restore job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

      • CompletionDate — (Date)

        The date and time that a job to restore a recovery point is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

      • Status — (String)

        Status code specifying the state of the job that is initiated by Backup to restore a recovery point.

        Possible values include:
        • "PENDING"
        • "RUNNING"
        • "COMPLETED"
        • "ABORTED"
        • "FAILED"
      • StatusMessage — (String)

        A message showing the status of a job to restore a recovery point.

      • PercentDone — (String)

        Contains an estimated percentage that is complete of a job at the time the job status was queried.

      • BackupSizeInBytes — (Integer)

        The size, in bytes, of the restored resource.

      • IamRoleArn — (String)

        Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

      • ExpectedCompletionTimeMinutes — (Integer)

        The amount of time in minutes that a job restoring a recovery point is expected to take.

      • CreatedResourceArn — (String)

        An Amazon Resource Name (ARN) that uniquely identifies a resource whose recovery point is being restored. The format of the ARN depends on the resource type of the backed-up resource.

      • ResourceType — (String)

        Returns metadata associated with a restore job listed by resource type.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

disassociateRecoveryPoint(params = {}, callback) ⇒ AWS.Request

Deletes the specified continuous backup recovery point from Backup and releases control of that continuous backup to the source service, such as Amazon RDS. The source service will continue to create and retain continuous backups using the lifecycle that you specified in your original backup plan.

Does not support snapshot backup recovery points.

Service Reference:

Examples:

Calling the disassociateRecoveryPoint operation

var params = {
  BackupVaultName: 'STRING_VALUE', /* required */
  RecoveryPointArn: 'STRING_VALUE' /* required */
};
backup.disassociateRecoveryPoint(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • BackupVaultName — (String)

      The unique name of an Backup vault.

    • RecoveryPointArn — (String)

      An Amazon Resource Name (ARN) that uniquely identifies an Backup recovery point.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

exportBackupPlanTemplate(params = {}, callback) ⇒ AWS.Request

Returns the backup plan that is specified by the plan ID as a backup template.

Service Reference:

Examples:

Calling the exportBackupPlanTemplate operation

var params = {
  BackupPlanId: 'STRING_VALUE' /* required */
};
backup.exportBackupPlanTemplate(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • BackupPlanId — (String)

      Uniquely identifies a backup plan.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • BackupPlanTemplateJson — (String)

        The body of a backup plan template in JSON format.

        Note: This is a signed JSON document that cannot be modified before being passed to GetBackupPlanFromJSON.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getBackupPlan(params = {}, callback) ⇒ AWS.Request

Returns BackupPlan details for the specified BackupPlanId. The details are the body of a backup plan in JSON format, in addition to plan metadata.

Service Reference:

Examples:

Calling the getBackupPlan operation

var params = {
  BackupPlanId: 'STRING_VALUE', /* required */
  VersionId: 'STRING_VALUE'
};
backup.getBackupPlan(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • BackupPlanId — (String)

      Uniquely identifies a backup plan.

    • VersionId — (String)

      Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • BackupPlan — (map)

        Specifies the body of a backup plan. Includes a BackupPlanName and one or more sets of Rules.

        • BackupPlanNamerequired — (String)

          The display name of a backup plan.

        • Rulesrequired — (Array<map>)

          An array of BackupRule objects, each of which specifies a scheduled task that is used to back up a selection of resources.

          • RuleNamerequired — (String)

            An optional display name for a backup rule.

          • TargetBackupVaultNamerequired — (String)

            The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

          • ScheduleExpression — (String)

            A cron expression in UTC specifying when Backup initiates a backup job. For more information about cron expressions, see Schedule Expressions for Rules in the Amazon CloudWatch Events User Guide.. Prior to specifying a value for this parameter, we recommend testing your cron expression using one of the many available cron generator and testing tools.

          • StartWindowMinutes — (Integer)

            A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully. This value is optional.

          • CompletionWindowMinutes — (Integer)

            A value in minutes after a backup job is successfully started before it must be completed or it will be canceled by Backup. This value is optional.

          • Lifecycle — (map)

            The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define.

            Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.

            Only Amazon EFS file system backups can be transitioned to cold storage.

            • MoveToColdStorageAfterDays — (Integer)

              Specifies the number of days after creation that a recovery point is moved to cold storage.

            • DeleteAfterDays — (Integer)

              Specifies the number of days after creation that a recovery point is deleted. Must be greater than 90 days plus MoveToColdStorageAfterDays.

          • RecoveryPointTags — (map<String>)

            An array of key-value pair strings that are assigned to resources that are associated with this rule when restored from backup.

          • RuleId — (String)

            Uniquely identifies a rule that is used to schedule the backup of a selection of resources.

          • CopyActions — (Array<map>)

            An array of CopyAction objects, which contains the details of the copy operation.

            • Lifecycle — (map)

              Contains an array of Transition objects specifying how long in days before a recovery point transitions to cold storage or is deleted.

              Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, on the console, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.

              Only Amazon EFS file system backups can be transitioned to cold storage.

              • MoveToColdStorageAfterDays — (Integer)

                Specifies the number of days after creation that a recovery point is moved to cold storage.

              • DeleteAfterDays — (Integer)

                Specifies the number of days after creation that a recovery point is deleted. Must be greater than 90 days plus MoveToColdStorageAfterDays.

            • DestinationBackupVaultArnrequired — (String)

              An Amazon Resource Name (ARN) that uniquely identifies the destination backup vault for the copied backup. For example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

          • EnableContinuousBackup — (Boolean)

            Specifies whether Backup creates continuous backups. True causes Backup to create continuous backups capable of point-in-time restore (PITR). False (or not specified) causes Backup to create snapshot backups.

        • AdvancedBackupSettings — (Array<map>)

          Contains a list of BackupOptions for each resource type.

          • ResourceType — (String)

            Specifies an object containing resource type and backup options. The only supported resource type is Amazon EC2 instances with Windows Volume Shadow Copy Service (VSS). For a CloudFormation example, see the sample CloudFormation template to enable Windows VSS in the Backup User Guide.

            Valid values: EC2.

          • BackupOptions — (map<String>)

            Specifies the backup option for a selected resource. This option is only available for Windows VSS backup jobs.

            Valid values:

            Set to "WindowsVSS":"enabled" to enable the WindowsVSS backup option and create a Windows VSS backup.

            Set to "WindowsVSS":"disabled" to create a regular backup. The WindowsVSS option is not enabled by default.

            If you specify an invalid option, you get an InvalidParameterValueException exception.

            For more information about Windows VSS backups, see Creating a VSS-Enabled Windows Backup.

      • BackupPlanId — (String)

        Uniquely identifies a backup plan.

      • BackupPlanArn — (String)

        An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.

      • VersionId — (String)

        Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited.

      • CreatorRequestId — (String)

        A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice.

      • CreationDate — (Date)

        The date and time that a backup plan is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

      • DeletionDate — (Date)

        The date and time that a backup plan is deleted, in Unix format and Coordinated Universal Time (UTC). The value of DeletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

      • LastExecutionDate — (Date)

        The last time a job to back up resources was run with this backup plan. A date and time, in Unix format and Coordinated Universal Time (UTC). The value of LastExecutionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

      • AdvancedBackupSettings — (Array<map>)

        Contains a list of BackupOptions for each resource type. The list is populated only if the advanced option is set for the backup plan.

        • ResourceType — (String)

          Specifies an object containing resource type and backup options. The only supported resource type is Amazon EC2 instances with Windows Volume Shadow Copy Service (VSS). For a CloudFormation example, see the sample CloudFormation template to enable Windows VSS in the Backup User Guide.

          Valid values: EC2.

        • BackupOptions — (map<String>)

          Specifies the backup option for a selected resource. This option is only available for Windows VSS backup jobs.

          Valid values:

          Set to "WindowsVSS":"enabled" to enable the WindowsVSS backup option and create a Windows VSS backup.

          Set to "WindowsVSS":"disabled" to create a regular backup. The WindowsVSS option is not enabled by default.

          If you specify an invalid option, you get an InvalidParameterValueException exception.

          For more information about Windows VSS backups, see Creating a VSS-Enabled Windows Backup.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getBackupPlanFromJSON(params = {}, callback) ⇒ AWS.Request

Returns a valid JSON document specifying a backup plan or an error.

Service Reference:

Examples:

Calling the getBackupPlanFromJSON operation

var params = {
  BackupPlanTemplateJson: 'STRING_VALUE' /* required */
};
backup.getBackupPlanFromJSON(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • BackupPlanTemplateJson — (String)

      A customer-supplied backup plan document in JSON format.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • BackupPlan — (map)

        Specifies the body of a backup plan. Includes a BackupPlanName and one or more sets of Rules.

        • BackupPlanNamerequired — (String)

          The display name of a backup plan.

        • Rulesrequired — (Array<map>)

          An array of BackupRule objects, each of which specifies a scheduled task that is used to back up a selection of resources.

          • RuleNamerequired — (String)

            An optional display name for a backup rule.

          • TargetBackupVaultNamerequired — (String)

            The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

          • ScheduleExpression — (String)

            A cron expression in UTC specifying when Backup initiates a backup job. For more information about cron expressions, see Schedule Expressions for Rules in the Amazon CloudWatch Events User Guide.. Prior to specifying a value for this parameter, we recommend testing your cron expression using one of the many available cron generator and testing tools.

          • StartWindowMinutes — (Integer)

            A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully. This value is optional.

          • CompletionWindowMinutes — (Integer)

            A value in minutes after a backup job is successfully started before it must be completed or it will be canceled by Backup. This value is optional.

          • Lifecycle — (map)

            The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define.

            Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.

            Only Amazon EFS file system backups can be transitioned to cold storage.

            • MoveToColdStorageAfterDays — (Integer)

              Specifies the number of days after creation that a recovery point is moved to cold storage.

            • DeleteAfterDays — (Integer)

              Specifies the number of days after creation that a recovery point is deleted. Must be greater than 90 days plus MoveToColdStorageAfterDays.

          • RecoveryPointTags — (map<String>)

            An array of key-value pair strings that are assigned to resources that are associated with this rule when restored from backup.

          • RuleId — (String)

            Uniquely identifies a rule that is used to schedule the backup of a selection of resources.

          • CopyActions — (Array<map>)

            An array of CopyAction objects, which contains the details of the copy operation.

            • Lifecycle — (map)

              Contains an array of Transition objects specifying how long in days before a recovery point transitions to cold storage or is deleted.

              Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, on the console, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.

              Only Amazon EFS file system backups can be transitioned to cold storage.

              • MoveToColdStorageAfterDays — (Integer)

                Specifies the number of days after creation that a recovery point is moved to cold storage.

              • DeleteAfterDays — (Integer)

                Specifies the number of days after creation that a recovery point is deleted. Must be greater than 90 days plus MoveToColdStorageAfterDays.

            • DestinationBackupVaultArnrequired — (String)

              An Amazon Resource Name (ARN) that uniquely identifies the destination backup vault for the copied backup. For example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

          • EnableContinuousBackup — (Boolean)

            Specifies whether Backup creates continuous backups. True causes Backup to create continuous backups capable of point-in-time restore (PITR). False (or not specified) causes Backup to create snapshot backups.

        • AdvancedBackupSettings — (Array<map>)

          Contains a list of BackupOptions for each resource type.

          • ResourceType — (String)

            Specifies an object containing resource type and backup options. The only supported resource type is Amazon EC2 instances with Windows Volume Shadow Copy Service (VSS). For a CloudFormation example, see the sample CloudFormation template to enable Windows VSS in the Backup User Guide.

            Valid values: EC2.

          • BackupOptions — (map<String>)

            Specifies the backup option for a selected resource. This option is only available for Windows VSS backup jobs.

            Valid values:

            Set to "WindowsVSS":"enabled" to enable the WindowsVSS backup option and create a Windows VSS backup.

            Set to "WindowsVSS":"disabled" to create a regular backup. The WindowsVSS option is not enabled by default.

            If you specify an invalid option, you get an InvalidParameterValueException exception.

            For more information about Windows VSS backups, see Creating a VSS-Enabled Windows Backup.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getBackupPlanFromTemplate(params = {}, callback) ⇒ AWS.Request

Returns the template specified by its templateId as a backup plan.

Service Reference:

Examples:

Calling the getBackupPlanFromTemplate operation

var params = {
  BackupPlanTemplateId: 'STRING_VALUE' /* required */
};
backup.getBackupPlanFromTemplate(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • BackupPlanTemplateId — (String)

      Uniquely identifies a stored backup plan template.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • BackupPlanDocument — (map)

        Returns the body of a backup plan based on the target template, including the name, rules, and backup vault of the plan.

        • BackupPlanNamerequired — (String)

          The display name of a backup plan.

        • Rulesrequired — (Array<map>)

          An array of BackupRule objects, each of which specifies a scheduled task that is used to back up a selection of resources.

          • RuleNamerequired — (String)

            An optional display name for a backup rule.

          • TargetBackupVaultNamerequired — (String)

            The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

          • ScheduleExpression — (String)

            A cron expression in UTC specifying when Backup initiates a backup job. For more information about cron expressions, see Schedule Expressions for Rules in the Amazon CloudWatch Events User Guide.. Prior to specifying a value for this parameter, we recommend testing your cron expression using one of the many available cron generator and testing tools.

          • StartWindowMinutes — (Integer)

            A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully. This value is optional.

          • CompletionWindowMinutes — (Integer)

            A value in minutes after a backup job is successfully started before it must be completed or it will be canceled by Backup. This value is optional.

          • Lifecycle — (map)

            The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define.

            Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.

            Only Amazon EFS file system backups can be transitioned to cold storage.

            • MoveToColdStorageAfterDays — (Integer)

              Specifies the number of days after creation that a recovery point is moved to cold storage.

            • DeleteAfterDays — (Integer)

              Specifies the number of days after creation that a recovery point is deleted. Must be greater than 90 days plus MoveToColdStorageAfterDays.

          • RecoveryPointTags — (map<String>)

            An array of key-value pair strings that are assigned to resources that are associated with this rule when restored from backup.

          • RuleId — (String)

            Uniquely identifies a rule that is used to schedule the backup of a selection of resources.

          • CopyActions — (Array<map>)

            An array of CopyAction objects, which contains the details of the copy operation.

            • Lifecycle — (map)

              Contains an array of Transition objects specifying how long in days before a recovery point transitions to cold storage or is deleted.

              Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, on the console, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.

              Only Amazon EFS file system backups can be transitioned to cold storage.

              • MoveToColdStorageAfterDays — (Integer)

                Specifies the number of days after creation that a recovery point is moved to cold storage.

              • DeleteAfterDays — (Integer)

                Specifies the number of days after creation that a recovery point is deleted. Must be greater than 90 days plus MoveToColdStorageAfterDays.

            • DestinationBackupVaultArnrequired — (String)

              An Amazon Resource Name (ARN) that uniquely identifies the destination backup vault for the copied backup. For example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

          • EnableContinuousBackup — (Boolean)

            Specifies whether Backup creates continuous backups. True causes Backup to create continuous backups capable of point-in-time restore (PITR). False (or not specified) causes Backup to create snapshot backups.

        • AdvancedBackupSettings — (Array<map>)

          Contains a list of BackupOptions for each resource type.

          • ResourceType — (String)

            Specifies an object containing resource type and backup options. The only supported resource type is Amazon EC2 instances with Windows Volume Shadow Copy Service (VSS). For a CloudFormation example, see the sample CloudFormation template to enable Windows VSS in the Backup User Guide.

            Valid values: EC2.

          • BackupOptions — (map<String>)

            Specifies the backup option for a selected resource. This option is only available for Windows VSS backup jobs.

            Valid values:

            Set to "WindowsVSS":"enabled" to enable the WindowsVSS backup option and create a Windows VSS backup.

            Set to "WindowsVSS":"disabled" to create a regular backup. The WindowsVSS option is not enabled by default.

            If you specify an invalid option, you get an InvalidParameterValueException exception.

            For more information about Windows VSS backups, see Creating a VSS-Enabled Windows Backup.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getBackupSelection(params = {}, callback) ⇒ AWS.Request

Returns selection metadata and a document in JSON format that specifies a list of resources that are associated with a backup plan.

Service Reference:

Examples:

Calling the getBackupSelection operation

var params = {
  BackupPlanId: 'STRING_VALUE', /* required */
  SelectionId: 'STRING_VALUE' /* required */
};
backup.getBackupSelection(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • BackupPlanId — (String)

      Uniquely identifies a backup plan.

    • SelectionId — (String)

      Uniquely identifies the body of a request to assign a set of resources to a backup plan.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • BackupSelection — (map)

        Specifies the body of a request to assign a set of resources to a backup plan.

        • SelectionNamerequired — (String)

          The display name of a resource selection document.

        • IamRoleArnrequired — (String)

          The ARN of the IAM role that Backup uses to authenticate when backing up the target resource; for example, arn:aws:iam::123456789012:role/S3Access.

        • Resources — (Array<String>)

          An array of strings that contain Amazon Resource Names (ARNs) of resources to assign to a backup plan.

        • ListOfTags — (Array<map>)

          An array of conditions used to specify a set of resources to assign to a backup plan; for example, "StringEquals": {"ec2:ResourceTag/Department": "accounting". Assigns the backup plan to every resource with at least one matching tag.

          • ConditionTyperequired — (String)

            An operation, such as StringEquals, that is applied to a key-value pair used to filter resources in a selection.

            Possible values include:
            • "STRINGEQUALS"
          • ConditionKeyrequired — (String)

            The key in a key-value pair. For example, in "ec2:ResourceTag/Department": "accounting", "ec2:ResourceTag/Department" is the key.

          • ConditionValuerequired — (String)

            The value in a key-value pair. For example, in "ec2:ResourceTag/Department": "accounting", "accounting" is the value.

      • SelectionId — (String)

        Uniquely identifies the body of a request to assign a set of resources to a backup plan.

      • BackupPlanId — (String)

        Uniquely identifies a backup plan.

      • CreationDate — (Date)

        The date and time a backup selection is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

      • CreatorRequestId — (String)

        A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getBackupVaultAccessPolicy(params = {}, callback) ⇒ AWS.Request

Returns the access policy document that is associated with the named backup vault.

Service Reference:

Examples:

Calling the getBackupVaultAccessPolicy operation

var params = {
  BackupVaultName: 'STRING_VALUE' /* required */
};
backup.getBackupVaultAccessPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • BackupVaultName — (String)

      The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • BackupVaultName — (String)

        The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created. They consist of lowercase letters, numbers, and hyphens.

      • BackupVaultArn — (String)

        An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

      • Policy — (String)

        The backup vault access policy document in JSON format.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getBackupVaultNotifications(params = {}, callback) ⇒ AWS.Request

Returns event notifications for the specified backup vault.

Service Reference:

Examples:

Calling the getBackupVaultNotifications operation

var params = {
  BackupVaultName: 'STRING_VALUE' /* required */
};
backup.getBackupVaultNotifications(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • BackupVaultName — (String)

      The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • BackupVaultName — (String)

        The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created. They consist of lowercase letters, numbers, and hyphens.

      • BackupVaultArn — (String)

        An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

      • SNSTopicArn — (String)

        An ARN that uniquely identifies an Amazon Simple Notification Service (Amazon SNS) topic; for example, arn:aws:sns:us-west-2:111122223333:MyTopic.

      • BackupVaultEvents — (Array<String>)

        An array of events that indicate the status of jobs to back up resources to the backup vault.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getRecoveryPointRestoreMetadata(params = {}, callback) ⇒ AWS.Request

Returns a set of metadata key-value pairs that were used to create the backup.

Service Reference:

Examples:

Calling the getRecoveryPointRestoreMetadata operation

var params = {
  BackupVaultName: 'STRING_VALUE', /* required */
  RecoveryPointArn: 'STRING_VALUE' /* required */
};
backup.getRecoveryPointRestoreMetadata(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • BackupVaultName — (String)

      The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

    • RecoveryPointArn — (String)

      An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • BackupVaultArn — (String)

        An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

      • RecoveryPointArn — (String)

        An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

      • RestoreMetadata — (map<String>)

        The set of metadata key-value pairs that describe the original configuration of the backed-up resource. These values vary depending on the service that is being restored.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getSupportedResourceTypes(params = {}, callback) ⇒ AWS.Request

Returns the Amazon Web Services resource types supported by Backup.

Service Reference:

Examples:

Calling the getSupportedResourceTypes operation

backup.getSupportedResourceTypes(function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ResourceTypes — (Array<String>)

        Contains a string with the supported Amazon Web Services resource types:

        • DynamoDB for Amazon DynamoDB

        • EBS for Amazon Elastic Block Store

        • EC2 for Amazon Elastic Compute Cloud

        • EFS for Amazon Elastic File System

        • RDS for Amazon Relational Database Service

        • Aurora for Amazon Aurora

        • Storage Gateway for Storage Gateway

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listBackupJobs(params = {}, callback) ⇒ AWS.Request

Returns a list of existing backup jobs for an authenticated account for the last 30 days. For a longer period of time, consider using these monitoring tools.

Service Reference:

Examples:

Calling the listBackupJobs operation

var params = {
  ByAccountId: 'STRING_VALUE',
  ByBackupVaultName: 'STRING_VALUE',
  ByCreatedAfter: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  ByCreatedBefore: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  ByResourceArn: 'STRING_VALUE',
  ByResourceType: 'STRING_VALUE',
  ByState: CREATED | PENDING | RUNNING | ABORTING | ABORTED | COMPLETED | FAILED | EXPIRED,
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
backup.listBackupJobs(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • NextToken — (String)

      The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

    • MaxResults — (Integer)

      The maximum number of items to be returned.

    • ByResourceArn — (String)

      Returns only backup jobs that match the specified resource Amazon Resource Name (ARN).

    • ByState — (String)

      Returns only backup jobs that are in the specified state.

      Possible values include:
      • "CREATED"
      • "PENDING"
      • "RUNNING"
      • "ABORTING"
      • "ABORTED"
      • "COMPLETED"
      • "FAILED"
      • "EXPIRED"
    • ByBackupVaultName — (String)

      Returns only backup jobs that will be stored in the specified backup vault. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

    • ByCreatedBefore — (Date)

      Returns only backup jobs that were created before the specified date.

    • ByCreatedAfter — (Date)

      Returns only backup jobs that were created after the specified date.

    • ByResourceType — (String)

      Returns only backup jobs for the specified resources:

      • DynamoDB for Amazon DynamoDB

      • EBS for Amazon Elastic Block Store

      • EC2 for Amazon Elastic Compute Cloud

      • EFS for Amazon Elastic File System

      • RDS for Amazon Relational Database Service

      • Aurora for Amazon Aurora

      • Storage Gateway for Storage Gateway

    • ByAccountId — (String)

      The account ID to list the jobs from. Returns only backup jobs associated with the specified account ID.

      If used from an Organizations management account, passing * returns all jobs across the organization.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • BackupJobs — (Array<map>)

        An array of structures containing metadata about your backup jobs returned in JSON format.

        • AccountId — (String)

          The account ID that owns the backup job.

        • BackupJobId — (String)

          Uniquely identifies a request to Backup to back up a resource.

        • BackupVaultName — (String)

          The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

        • BackupVaultArn — (String)

          An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

        • RecoveryPointArn — (String)

          An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

        • ResourceArn — (String)

          An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.

        • CreationDate — (Date)

          The date and time a backup job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

        • CompletionDate — (Date)

          The date and time a job to create a backup job is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

        • State — (String)

          The current state of a resource recovery point.

          Possible values include:
          • "CREATED"
          • "PENDING"
          • "RUNNING"
          • "ABORTING"
          • "ABORTED"
          • "COMPLETED"
          • "FAILED"
          • "EXPIRED"
        • StatusMessage — (String)

          A detailed message explaining the status of the job to back up a resource.

        • PercentDone — (String)

          Contains an estimated percentage complete of a job at the time the job status was queried.

        • BackupSizeInBytes — (Integer)

          The size, in bytes, of a backup.

        • IamRoleArn — (String)

          Specifies the IAM role ARN used to create the target recovery point. IAM roles other than the default role must include either AWSBackup or AwsBackup in the role name. For example, arn:aws:iam::123456789012:role/AWSBackupRDSAccess. Role names without those strings lack permissions to perform backup jobs.

        • CreatedBy — (map)

          Contains identifying information about the creation of a backup job, including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan used to create it.

          • BackupPlanId — (String)

            Uniquely identifies a backup plan.

          • BackupPlanArn — (String)

            An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.

          • BackupPlanVersion — (String)

            Version IDs are unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. They cannot be edited.

          • BackupRuleId — (String)

            Uniquely identifies a rule used to schedule the backup of a selection of resources.

        • ExpectedCompletionDate — (Date)

          The date and time a job to back up resources is expected to be completed, in Unix format and Coordinated Universal Time (UTC). The value of ExpectedCompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

        • StartBy — (Date)

          Specifies the time in Unix format and Coordinated Universal Time (UTC) when a backup job must be started before it is canceled. The value is calculated by adding the start window to the scheduled time. So if the scheduled time were 6:00 PM and the start window is 2 hours, the StartBy time would be 8:00 PM on the date specified. The value of StartBy is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

        • ResourceType — (String)

          The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. For Windows Volume Shadow Copy Service (VSS) backups, the only supported resource type is Amazon EC2.

        • BytesTransferred — (Integer)

          The size in bytes transferred to a backup vault at the time that the job status was queried.

        • BackupOptions — (map<String>)

          Specifies the backup option for a selected resource. This option is only available for Windows Volume Shadow Copy Service (VSS) backup jobs.

          Valid values: Set to "WindowsVSS":"enabled" to enable the WindowsVSS backup option and create a Windows VSS backup. Set to "WindowsVSS":"disabled" to create a regular backup. If you specify an invalid option, you get an InvalidParameterValueException exception.

        • BackupType — (String)

          Represents the type of backup for a backup job.

      • NextToken — (String)

        The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listBackupPlans(params = {}, callback) ⇒ AWS.Request

Returns a list of all active backup plans for an authenticated account. The list contains information such as Amazon Resource Names (ARNs), plan IDs, creation and deletion dates, version IDs, plan names, and creator request IDs.

Service Reference:

Examples:

Calling the listBackupPlans operation

var params = {
  IncludeDeleted: true || false,
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
backup.listBackupPlans(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • NextToken — (String)

      The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

    • MaxResults — (Integer)

      The maximum number of items to be returned.

    • IncludeDeleted — (Boolean)

      A Boolean value with a default value of FALSE that returns deleted backup plans when set to TRUE.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NextToken — (String)

        The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

      • BackupPlansList — (Array<map>)

        An array of backup plan list items containing metadata about your saved backup plans.

        • BackupPlanArn — (String)

          An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.

        • BackupPlanId — (String)

          Uniquely identifies a backup plan.

        • CreationDate — (Date)

          The date and time a resource backup plan is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

        • DeletionDate — (Date)

          The date and time a backup plan is deleted, in Unix format and Coordinated Universal Time (UTC). The value of DeletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

        • VersionId — (String)

          Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited.

        • BackupPlanName — (String)

          The display name of a saved backup plan.

        • CreatorRequestId — (String)

          A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice.

        • LastExecutionDate — (Date)

          The last time a job to back up resources was run with this rule. A date and time, in Unix format and Coordinated Universal Time (UTC). The value of LastExecutionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

        • AdvancedBackupSettings — (Array<map>)

          Contains a list of BackupOptions for a resource type.

          • ResourceType — (String)

            Specifies an object containing resource type and backup options. The only supported resource type is Amazon EC2 instances with Windows Volume Shadow Copy Service (VSS). For a CloudFormation example, see the sample CloudFormation template to enable Windows VSS in the Backup User Guide.

            Valid values: EC2.

          • BackupOptions — (map<String>)

            Specifies the backup option for a selected resource. This option is only available for Windows VSS backup jobs.

            Valid values:

            Set to "WindowsVSS":"enabled" to enable the WindowsVSS backup option and create a Windows VSS backup.

            Set to "WindowsVSS":"disabled" to create a regular backup. The WindowsVSS option is not enabled by default.

            If you specify an invalid option, you get an InvalidParameterValueException exception.

            For more information about Windows VSS backups, see Creating a VSS-Enabled Windows Backup.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listBackupPlanTemplates(params = {}, callback) ⇒ AWS.Request

Returns metadata of your saved backup plan templates, including the template ID, name, and the creation and deletion dates.

Service Reference:

Examples:

Calling the listBackupPlanTemplates operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
backup.listBackupPlanTemplates(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • NextToken — (String)

      The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

    • MaxResults — (Integer)

      The maximum number of items to be returned.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NextToken — (String)

        The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

      • BackupPlanTemplatesList — (Array<map>)

        An array of template list items containing metadata about your saved templates.

        • BackupPlanTemplateId — (String)

          Uniquely identifies a stored backup plan template.

        • BackupPlanTemplateName — (String)

          The optional display name of a backup plan template.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listBackupPlanVersions(params = {}, callback) ⇒ AWS.Request

Returns version metadata of your backup plans, including Amazon Resource Names (ARNs), backup plan IDs, creation and deletion dates, plan names, and version IDs.

Service Reference:

Examples:

Calling the listBackupPlanVersions operation

var params = {
  BackupPlanId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
backup.listBackupPlanVersions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • BackupPlanId — (String)

      Uniquely identifies a backup plan.

    • NextToken — (String)

      The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

    • MaxResults — (Integer)

      The maximum number of items to be returned.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NextToken — (String)

        The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

      • BackupPlanVersionsList — (Array<map>)

        An array of version list items containing metadata about your backup plans.

        • BackupPlanArn — (String)

          An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.

        • BackupPlanId — (String)

          Uniquely identifies a backup plan.

        • CreationDate — (Date)

          The date and time a resource backup plan is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

        • DeletionDate — (Date)

          The date and time a backup plan is deleted, in Unix format and Coordinated Universal Time (UTC). The value of DeletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

        • VersionId — (String)

          Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited.

        • BackupPlanName — (String)

          The display name of a saved backup plan.

        • CreatorRequestId — (String)

          A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice.

        • LastExecutionDate — (Date)

          The last time a job to back up resources was run with this rule. A date and time, in Unix format and Coordinated Universal Time (UTC). The value of LastExecutionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

        • AdvancedBackupSettings — (Array<map>)

          Contains a list of BackupOptions for a resource type.

          • ResourceType — (String)

            Specifies an object containing resource type and backup options. The only supported resource type is Amazon EC2 instances with Windows Volume Shadow Copy Service (VSS). For a CloudFormation example, see the sample CloudFormation template to enable Windows VSS in the Backup User Guide.

            Valid values: EC2.

          • BackupOptions — (map<String>)

            Specifies the backup option for a selected resource. This option is only available for Windows VSS backup jobs.

            Valid values:

            Set to "WindowsVSS":"enabled" to enable the WindowsVSS backup option and create a Windows VSS backup.

            Set to "WindowsVSS":"disabled" to create a regular backup. The WindowsVSS option is not enabled by default.

            If you specify an invalid option, you get an InvalidParameterValueException exception.

            For more information about Windows VSS backups, see Creating a VSS-Enabled Windows Backup.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listBackupSelections(params = {}, callback) ⇒ AWS.Request

Returns an array containing metadata of the resources associated with the target backup plan.

Service Reference:

Examples:

Calling the listBackupSelections operation

var params = {
  BackupPlanId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
backup.listBackupSelections(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • BackupPlanId — (String)

      Uniquely identifies a backup plan.

    • NextToken — (String)

      The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

    • MaxResults — (Integer)

      The maximum number of items to be returned.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NextToken — (String)

        The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

      • BackupSelectionsList — (Array<map>)

        An array of backup selection list items containing metadata about each resource in the list.

        • SelectionId — (String)

          Uniquely identifies a request to assign a set of resources to a backup plan.

        • SelectionName — (String)

          The display name of a resource selection document.

        • BackupPlanId — (String)

          Uniquely identifies a backup plan.

        • CreationDate — (Date)

          The date and time a backup plan is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

        • CreatorRequestId — (String)

          A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice.

        • IamRoleArn — (String)

          Specifies the IAM role Amazon Resource Name (ARN) to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listBackupVaults(params = {}, callback) ⇒ AWS.Request

Returns a list of recovery point storage containers along with information about them.

Service Reference:

Examples:

Calling the listBackupVaults operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
backup.listBackupVaults(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • NextToken — (String)

      The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

    • MaxResults — (Integer)

      The maximum number of items to be returned.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • BackupVaultList — (Array<map>)

        An array of backup vault list members containing vault metadata, including Amazon Resource Name (ARN), display name, creation date, number of saved recovery points, and encryption information if the resources saved in the backup vault are encrypted.

        • BackupVaultName — (String)

          The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

        • BackupVaultArn — (String)

          An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

        • CreationDate — (Date)

          The date and time a resource backup is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

        • EncryptionKeyArn — (String)

          The server-side encryption key that is used to protect your backups; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.

        • CreatorRequestId — (String)

          A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice.

        • NumberOfRecoveryPoints — (Integer)

          The number of recovery points that are stored in a backup vault.

      • NextToken — (String)

        The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listCopyJobs(params = {}, callback) ⇒ AWS.Request

Returns metadata about your copy jobs.

Service Reference:

Examples:

Calling the listCopyJobs operation

var params = {
  ByAccountId: 'STRING_VALUE',
  ByCreatedAfter: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  ByCreatedBefore: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  ByDestinationVaultArn: 'STRING_VALUE',
  ByResourceArn: 'STRING_VALUE',
  ByResourceType: 'STRING_VALUE',
  ByState: CREATED | RUNNING | COMPLETED | FAILED,
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
backup.listCopyJobs(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • NextToken — (String)

      The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

    • MaxResults — (Integer)

      The maximum number of items to be returned.

    • ByResourceArn — (String)

      Returns only copy jobs that match the specified resource Amazon Resource Name (ARN).

    • ByState — (String)

      Returns only copy jobs that are in the specified state.

      Possible values include:
      • "CREATED"
      • "RUNNING"
      • "COMPLETED"
      • "FAILED"
    • ByCreatedBefore — (Date)

      Returns only copy jobs that were created before the specified date.

    • ByCreatedAfter — (Date)

      Returns only copy jobs that were created after the specified date.

    • ByResourceType — (String)

      Returns only backup jobs for the specified resources:

      • DynamoDB for Amazon DynamoDB

      • EBS for Amazon Elastic Block Store

      • EC2 for Amazon Elastic Compute Cloud

      • EFS for Amazon Elastic File System

      • RDS for Amazon Relational Database Service

      • Aurora for Amazon Aurora

      • Storage Gateway for Storage Gateway

    • ByDestinationVaultArn — (String)

      An Amazon Resource Name (ARN) that uniquely identifies a source backup vault to copy from; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

    • ByAccountId — (String)

      The account ID to list the jobs from. Returns only copy jobs associated with the specified account ID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • CopyJobs — (Array<map>)

        An array of structures containing metadata about your copy jobs returned in JSON format.

        • AccountId — (String)

          The account ID that owns the copy job.

        • CopyJobId — (String)

          Uniquely identifies a copy job.

        • SourceBackupVaultArn — (String)

          An Amazon Resource Name (ARN) that uniquely identifies a source copy vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

        • SourceRecoveryPointArn — (String)

          An ARN that uniquely identifies a source recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

        • DestinationBackupVaultArn — (String)

          An Amazon Resource Name (ARN) that uniquely identifies a destination copy vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

        • DestinationRecoveryPointArn — (String)

          An ARN that uniquely identifies a destination recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

        • ResourceArn — (String)

          The Amazon Web Services resource to be copied; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

        • CreationDate — (Date)

          The date and time a copy job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

        • CompletionDate — (Date)

          The date and time a copy job is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

        • State — (String)

          The current state of a copy job.

          Possible values include:
          • "CREATED"
          • "RUNNING"
          • "COMPLETED"
          • "FAILED"
        • StatusMessage — (String)

          A detailed message explaining the status of the job to copy a resource.

        • BackupSizeInBytes — (Integer)

          The size, in bytes, of a copy job.

        • IamRoleArn — (String)

          Specifies the IAM role ARN used to copy the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

        • CreatedBy — (map)

          Contains information about the backup plan and rule that Backup used to initiate the recovery point backup.

          • BackupPlanId — (String)

            Uniquely identifies a backup plan.

          • BackupPlanArn — (String)

            An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.

          • BackupPlanVersion — (String)

            Version IDs are unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. They cannot be edited.

          • BackupRuleId — (String)

            Uniquely identifies a rule used to schedule the backup of a selection of resources.

        • ResourceType — (String)

          The type of Amazon Web Services resource to be copied; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

      • NextToken — (String)

        The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listFrameworks(params = {}, callback) ⇒ AWS.Request

Returns a list of all frameworks for an Amazon Web Services account and Amazon Web Services Region.

Service Reference:

Examples:

Calling the listFrameworks operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
backup.listFrameworks(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • MaxResults — (Integer)

      The number of desired results from 1 to 1000. Optional. If unspecified, the query will return 1 MB of data.

    • NextToken — (String)

      An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Frameworks — (Array<map>)

        A list of frameworks with details for each framework, including the framework name, Amazon Resource Name (ARN), description, number of controls, creation time, and deployment status.

        • FrameworkName — (String)

          The unique name of a framework. This name is between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).

        • FrameworkArn — (String)

          An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

        • FrameworkDescription — (String)

          An optional description of the framework with a maximum 1,024 characters.

        • NumberOfControls — (Integer)

          The number of controls contained by the framework.

        • CreationTime — (Date)

          The date and time that a framework is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

        • DeploymentStatus — (String)

          The deployment status of a framework. The statuses are:

          CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED

      • NextToken — (String)

        An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listProtectedResources(params = {}, callback) ⇒ AWS.Request

Returns an array of resources successfully backed up by Backup, including the time the resource was saved, an Amazon Resource Name (ARN) of the resource, and a resource type.

Service Reference:

Examples:

Calling the listProtectedResources operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
backup.listProtectedResources(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • NextToken — (String)

      The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

    • MaxResults — (Integer)

      The maximum number of items to be returned.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Results — (Array<map>)

        An array of resources successfully backed up by Backup including the time the resource was saved, an Amazon Resource Name (ARN) of the resource, and a resource type.

        • ResourceArn — (String)

          An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

        • ResourceType — (String)

          The type of Amazon Web Services resource; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. For Windows Volume Shadow Copy Service (VSS) backups, the only supported resource type is Amazon EC2.

        • LastBackupTime — (Date)

          The date and time a resource was last backed up, in Unix format and Coordinated Universal Time (UTC). The value of LastBackupTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

      • NextToken — (String)

        The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listRecoveryPointsByBackupVault(params = {}, callback) ⇒ AWS.Request

Returns detailed information about the recovery points stored in a backup vault.

Service Reference:

Examples:

Calling the listRecoveryPointsByBackupVault operation

var params = {
  BackupVaultName: 'STRING_VALUE', /* required */
  ByBackupPlanId: 'STRING_VALUE',
  ByCreatedAfter: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  ByCreatedBefore: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  ByResourceArn: 'STRING_VALUE',
  ByResourceType: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
backup.listRecoveryPointsByBackupVault(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • BackupVaultName — (String)

      The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

      Note: Backup vault name might not be available when a supported service creates the backup.
    • NextToken — (String)

      The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

    • MaxResults — (Integer)

      The maximum number of items to be returned.

    • ByResourceArn — (String)

      Returns only recovery points that match the specified resource Amazon Resource Name (ARN).

    • ByResourceType — (String)

      Returns only recovery points that match the specified resource type.

    • ByBackupPlanId — (String)

      Returns only recovery points that match the specified backup plan ID.

    • ByCreatedBefore — (Date)

      Returns only recovery points that were created before the specified timestamp.

    • ByCreatedAfter — (Date)

      Returns only recovery points that were created after the specified timestamp.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NextToken — (String)

        The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

      • RecoveryPoints — (Array<map>)

        An array of objects that contain detailed information about recovery points saved in a backup vault.

        • RecoveryPointArn — (String)

          An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

        • BackupVaultName — (String)

          The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

        • BackupVaultArn — (String)

          An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

        • SourceBackupVaultArn — (String)

          The backup vault where the recovery point was originally copied from. If the recovery point is restored to the same account this value will be null.

        • ResourceArn — (String)

          An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.

        • ResourceType — (String)

          The type of Amazon Web Services resource saved as a recovery point; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. For Windows Volume Shadow Copy Service (VSS) backups, the only supported resource type is Amazon EC2.

        • CreatedBy — (map)

          Contains identifying information about the creation of a recovery point, including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan that is used to create it.

          • BackupPlanId — (String)

            Uniquely identifies a backup plan.

          • BackupPlanArn — (String)

            An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.

          • BackupPlanVersion — (String)

            Version IDs are unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. They cannot be edited.

          • BackupRuleId — (String)

            Uniquely identifies a rule used to schedule the backup of a selection of resources.

        • IamRoleArn — (String)

          Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

        • Status — (String)

          A status code specifying the state of the recovery point.

          Possible values include:
          • "COMPLETED"
          • "PARTIAL"
          • "DELETING"
          • "EXPIRED"
        • StatusMessage — (String)

          A message explaining the reason of the recovery point deletion failure.

        • CreationDate — (Date)

          The date and time a recovery point is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

        • CompletionDate — (Date)

          The date and time a job to restore a recovery point is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

        • BackupSizeInBytes — (Integer)

          The size, in bytes, of a backup.

        • CalculatedLifecycle — (map)

          A CalculatedLifecycle object containing DeleteAt and MoveToColdStorageAt timestamps.

          • MoveToColdStorageAt — (Date)

            A timestamp that specifies when to transition a recovery point to cold storage.

          • DeleteAt — (Date)

            A timestamp that specifies when to delete a recovery point.

        • Lifecycle — (map)

          The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define.

          Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.

          Only Amazon EFS file system backups can be transitioned to cold storage.

          • MoveToColdStorageAfterDays — (Integer)

            Specifies the number of days after creation that a recovery point is moved to cold storage.

          • DeleteAfterDays — (Integer)

            Specifies the number of days after creation that a recovery point is deleted. Must be greater than 90 days plus MoveToColdStorageAfterDays.

        • EncryptionKeyArn — (String)

          The server-side encryption key that is used to protect your backups; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.

        • IsEncrypted — (Boolean)

          A Boolean value that is returned as TRUE if the specified recovery point is encrypted, or FALSE if the recovery point is not encrypted.

        • LastRestoreTime — (Date)

          The date and time a recovery point was last restored, in Unix format and Coordinated Universal Time (UTC). The value of LastRestoreTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listRecoveryPointsByResource(params = {}, callback) ⇒ AWS.Request

Returns detailed information about all the recovery points of the type specified by a resource Amazon Resource Name (ARN).

Note: For Amazon EFS and Amazon EC2, this action only lists recovery points created by Backup.

Service Reference:

Examples:

Calling the listRecoveryPointsByResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
backup.listRecoveryPointsByResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceArn — (String)

      An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.

    • NextToken — (String)

      The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

    • MaxResults — (Integer)

      The maximum number of items to be returned.

      Note: Amazon RDS requires a value of at least 20.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NextToken — (String)

        The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

      • RecoveryPoints — (Array<map>)

        An array of objects that contain detailed information about recovery points of the specified resource type.

        Note: Only Amazon EFS and Amazon EC2 recovery points return BackupVaultName.
        • RecoveryPointArn — (String)

          An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

        • CreationDate — (Date)

          The date and time a recovery point is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

        • Status — (String)

          A status code specifying the state of the recovery point.

          Possible values include:
          • "COMPLETED"
          • "PARTIAL"
          • "DELETING"
          • "EXPIRED"
        • StatusMessage — (String)

          A message explaining the reason of the recovery point deletion failure.

        • EncryptionKeyArn — (String)

          The server-side encryption key that is used to protect your backups; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.

        • BackupSizeBytes — (Integer)

          The size, in bytes, of a backup.

        • BackupVaultName — (String)

          The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listReportJobs(params = {}, callback) ⇒ AWS.Request

Returns details about your report jobs.

Service Reference:

Examples:

Calling the listReportJobs operation

var params = {
  ByCreationAfter: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  ByCreationBefore: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  ByReportPlanName: 'STRING_VALUE',
  ByStatus: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
backup.listReportJobs(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ByReportPlanName — (String)

      Returns only report jobs with the specified report plan name.

    • ByCreationBefore — (Date)

      Returns only report jobs that were created before the date and time specified in Unix format and Coordinated Universal Time (UTC). For example, the value 1516925490 represents Friday, January 26, 2018 12:11:30 AM.

    • ByCreationAfter — (Date)

      Returns only report jobs that were created after the date and time specified in Unix format and Coordinated Universal Time (UTC). For example, the value 1516925490 represents Friday, January 26, 2018 12:11:30 AM.

    • ByStatus — (String)

      Returns only report jobs that are in the specified status. The statuses are:

      CREATED | RUNNING | COMPLETED | FAILED

    • MaxResults — (Integer)

      The number of desired results from 1 to 1000. Optional. If unspecified, the query will return 1 MB of data.

    • NextToken — (String)

      An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ReportJobs — (Array<map>)

        Details about your report jobs in JSON format.

        • ReportJobId — (String)

          The identifier for a report job. A unique, randomly generated, Unicode, UTF-8 encoded string that is at most 1,024 bytes long. Report job IDs cannot be edited.

        • ReportPlanArn — (String)

          An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

        • ReportTemplate — (String)

          Identifies the report template for the report. Reports are built using a report template. The report templates are:

          BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT

        • CreationTime — (Date)

          The date and time that a report job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

        • CompletionTime — (Date)

          The date and time that a report job is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

        • Status — (String)

          The status of a report job. The statuses are:

          CREATED | RUNNING | COMPLETED | FAILED

          COMPLETED means that the report is available for your review at your designated destination. If the status is FAILED, review the StatusMessage for the reason.

        • StatusMessage — (String)

          A message explaining the status of the report job.

        • ReportDestination — (map)

          The S3 bucket name and S3 keys for the destination where the report job publishes the report.

          • S3BucketName — (String)

            The unique name of the Amazon S3 bucket that receives your reports.

          • S3Keys — (Array<String>)

            The object key that uniquely identifies your reports in your S3 bucket.

      • NextToken — (String)

        An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listReportPlans(params = {}, callback) ⇒ AWS.Request

Returns a list of your report plans. For detailed information about a single report plan, use DescribeReportPlan.

Service Reference:

Examples:

Calling the listReportPlans operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
backup.listReportPlans(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • MaxResults — (Integer)

      The number of desired results from 1 to 1000. Optional. If unspecified, the query will return 1 MB of data.

    • NextToken — (String)

      An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ReportPlans — (Array<map>)

        A list of your report plans with detailed information for each plan. This information includes the Amazon Resource Name (ARN), report plan name, description, settings, delivery channel, deployment status, creation time, and last times the report plan attempted to and successfully ran.

        • ReportPlanArn — (String)

          An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

        • ReportPlanName — (String)

          The unique name of the report plan. This name is between 1 and 256 characters starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).

        • ReportPlanDescription — (String)

          An optional description of the report plan with a maximum 1,024 characters.

        • ReportSetting — (map)

          Identifies the report template for the report. Reports are built using a report template. The report templates are:

          BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT

          • ReportTemplaterequired — (String)

            Identifies the report template for the report. Reports are built using a report template. The report templates are:

            BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT

        • ReportDeliveryChannel — (map)

          Contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.

          • S3BucketNamerequired — (String)

            The unique name of the S3 bucket that receives your reports.

          • S3KeyPrefix — (String)

            The prefix for where Backup Audit Manager delivers your reports to Amazon S3. The prefix is this part of the following path: s3://your-bucket-name/prefix/Backup/us-west-2/year/month/day/report-name. If not specified, there is no prefix.

          • Formats — (Array<String>)

            A list of the format of your reports: CSV, JSON, or both. If not specified, the default format is CSV.

        • DeploymentStatus — (String)

          The deployment status of a report plan. The statuses are:

          CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED

        • CreationTime — (Date)

          The date and time that a report plan is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

        • LastAttemptedExecutionTime — (Date)

          The date and time that a report job associated with this report plan last attempted to run, in Unix format and Coordinated Universal Time (UTC). The value of LastAttemptedExecutionTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

        • LastSuccessfulExecutionTime — (Date)

          The date and time that a report job associated with this report plan last successfully ran, in Unix format and Coordinated Universal Time (UTC). The value of LastSuccessfulExecutionTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

      • NextToken — (String)

        An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listRestoreJobs(params = {}, callback) ⇒ AWS.Request

Returns a list of jobs that Backup initiated to restore a saved resource, including details about the recovery process.

Service Reference:

Examples:

Calling the listRestoreJobs operation

var params = {
  ByAccountId: 'STRING_VALUE',
  ByCreatedAfter: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  ByCreatedBefore: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  ByStatus: PENDING | RUNNING | COMPLETED | ABORTED | FAILED,
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
backup.listRestoreJobs(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • NextToken — (String)

      The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

    • MaxResults — (Integer)

      The maximum number of items to be returned.

    • ByAccountId — (String)

      The account ID to list the jobs from. Returns only restore jobs associated with the specified account ID.

    • ByCreatedBefore — (Date)

      Returns only restore jobs that were created before the specified date.

    • ByCreatedAfter — (Date)

      Returns only restore jobs that were created after the specified date.

    • ByStatus — (String)

      Returns only restore jobs associated with the specified job status.

      Possible values include:
      • "PENDING"
      • "RUNNING"
      • "COMPLETED"
      • "ABORTED"
      • "FAILED"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • RestoreJobs — (Array<map>)

        An array of objects that contain detailed information about jobs to restore saved resources.

        • AccountId — (String)

          The account ID that owns the restore job.

        • RestoreJobId — (String)

          Uniquely identifies the job that restores a recovery point.

        • RecoveryPointArn — (String)

          An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

        • CreationDate — (Date)

          The date and time a restore job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

        • CompletionDate — (Date)

          The date and time a job to restore a recovery point is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

        • Status — (String)

          A status code specifying the state of the job initiated by Backup to restore a recovery point.

          Possible values include:
          • "PENDING"
          • "RUNNING"
          • "COMPLETED"
          • "ABORTED"
          • "FAILED"
        • StatusMessage — (String)

          A detailed message explaining the status of the job to restore a recovery point.

        • PercentDone — (String)

          Contains an estimated percentage complete of a job at the time the job status was queried.

        • BackupSizeInBytes — (Integer)

          The size, in bytes, of the restored resource.

        • IamRoleArn — (String)

          Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

        • ExpectedCompletionTimeMinutes — (Integer)

          The amount of time in minutes that a job restoring a recovery point is expected to take.

        • CreatedResourceArn — (String)

          An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

        • ResourceType — (String)

          The resource type of the listed restore jobs; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. For Windows Volume Shadow Copy Service (VSS) backups, the only supported resource type is Amazon EC2.

      • NextToken — (String)

        The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listTags(params = {}, callback) ⇒ AWS.Request

Returns a list of key-value pairs assigned to a target recovery point, backup plan, or backup vault.

Note: ListTags are currently only supported with Amazon EFS backups.

Service Reference:

Examples:

Calling the listTags operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
backup.listTags(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceArn — (String)

      An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the type of resource. Valid targets for ListTags are recovery points, backup plans, and backup vaults.

    • NextToken — (String)

      The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

    • MaxResults — (Integer)

      The maximum number of items to be returned.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NextToken — (String)

        The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

      • Tags — (map<String>)

        To help organize your resources, you can assign your own metadata to the resources you create. Each tag is a key-value pair.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

putBackupVaultAccessPolicy(params = {}, callback) ⇒ AWS.Request

Sets a resource-based policy that is used to manage access permissions on the target backup vault. Requires a backup vault name and an access policy document in JSON format.

Service Reference:

Examples:

Calling the putBackupVaultAccessPolicy operation

var params = {
  BackupVaultName: 'STRING_VALUE', /* required */
  Policy: 'STRING_VALUE'
};
backup.putBackupVaultAccessPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • BackupVaultName — (String)

      The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

    • Policy — (String)

      The backup vault access policy document in JSON format.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

putBackupVaultNotifications(params = {}, callback) ⇒ AWS.Request

Turns on notifications on a backup vault for the specified topic and events.

Service Reference:

Examples:

Calling the putBackupVaultNotifications operation

var params = {
  BackupVaultEvents: [ /* required */
    BACKUP_JOB_STARTED | BACKUP_JOB_COMPLETED | BACKUP_JOB_SUCCESSFUL | BACKUP_JOB_FAILED | BACKUP_JOB_EXPIRED | RESTORE_JOB_STARTED | RESTORE_JOB_COMPLETED | RESTORE_JOB_SUCCESSFUL | RESTORE_JOB_FAILED | COPY_JOB_STARTED | COPY_JOB_SUCCESSFUL | COPY_JOB_FAILED | RECOVERY_POINT_MODIFIED | BACKUP_PLAN_CREATED | BACKUP_PLAN_MODIFIED,
    /* more items */
  ],
  BackupVaultName: 'STRING_VALUE', /* required */
  SNSTopicArn: 'STRING_VALUE' /* required */
};
backup.putBackupVaultNotifications(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • BackupVaultName — (String)

      The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

    • SNSTopicArn — (String)

      The Amazon Resource Name (ARN) that specifies the topic for a backup vault’s events; for example, arn:aws:sns:us-west-2:111122223333:MyVaultTopic.

    • BackupVaultEvents — (Array<String>)

      An array of events that indicate the status of jobs to back up resources to the backup vault.

      Note: The following events are supported: BACKUP_JOB_STARTED, BACKUP_JOB_COMPLETED, COPY_JOB_STARTED, COPY_JOB_SUCCESSFUL, COPY_JOB_FAILED, RESTORE_JOB_STARTED, RESTORE_JOB_COMPLETED, and RECOVERY_POINT_MODIFIED. To find failed backup jobs, use BACKUP_JOB_COMPLETED and filter using event metadata. Other events in the following list are deprecated.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

startBackupJob(params = {}, callback) ⇒ AWS.Request

Starts an on-demand backup job for the specified resource.

Service Reference:

Examples:

Calling the startBackupJob operation

var params = {
  BackupVaultName: 'STRING_VALUE', /* required */
  IamRoleArn: 'STRING_VALUE', /* required */
  ResourceArn: 'STRING_VALUE', /* required */
  BackupOptions: {
    '<BackupOptionKey>': 'STRING_VALUE',
    /* '<BackupOptionKey>': ... */
  },
  CompleteWindowMinutes: 'NUMBER_VALUE',
  IdempotencyToken: 'STRING_VALUE',
  Lifecycle: {
    DeleteAfterDays: 'NUMBER_VALUE',
    MoveToColdStorageAfterDays: 'NUMBER_VALUE'
  },
  RecoveryPointTags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  },
  StartWindowMinutes: 'NUMBER_VALUE'
};
backup.startBackupJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • BackupVaultName — (String)

      The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

    • ResourceArn — (String)

      An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

    • IamRoleArn — (String)

      Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

    • IdempotencyToken — (String)

      A customer-chosen string that you can use to distinguish between otherwise identical calls to StartBackupJob. Retrying a successful request with the same idempotency token results in a success message with no action taken.

    • StartWindowMinutes — (Integer)

      A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully. This value is optional, and the default is 8 hours.

    • CompleteWindowMinutes — (Integer)

      A value in minutes during which a successfully started backup must complete, or else AWS Backup will cancel the job. This value is optional. This value begins counting down from when the backup was scheduled. It does not add additional time for StartWindowMinutes, or if the backup started later than scheduled.

    • Lifecycle — (map)

      The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup will transition and expire backups automatically according to the lifecycle that you define.

      Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.

      Only Amazon EFS file system backups can be transitioned to cold storage.

      • MoveToColdStorageAfterDays — (Integer)

        Specifies the number of days after creation that a recovery point is moved to cold storage.

      • DeleteAfterDays — (Integer)

        Specifies the number of days after creation that a recovery point is deleted. Must be greater than 90 days plus MoveToColdStorageAfterDays.

    • RecoveryPointTags — (map<String>)

      To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair.

    • BackupOptions — (map<String>)

      Specifies the backup option for a selected resource. This option is only available for Windows Volume Shadow Copy Service (VSS) backup jobs.

      Valid values: Set to "WindowsVSS":"enabled" to enable the WindowsVSS backup option and create a Windows VSS backup. Set to "WindowsVSS""disabled" to create a regular backup. The WindowsVSS option is not enabled by default.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • BackupJobId — (String)

        Uniquely identifies a request to Backup to back up a resource.

      • RecoveryPointArn — (String)

        An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

      • CreationDate — (Date)

        The date and time that a backup job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

startCopyJob(params = {}, callback) ⇒ AWS.Request

Starts a job to create a one-time copy of the specified resource.

Does not support continuous backups.

Service Reference:

Examples:

Calling the startCopyJob operation

var params = {
  DestinationBackupVaultArn: 'STRING_VALUE', /* required */
  IamRoleArn: 'STRING_VALUE', /* required */
  RecoveryPointArn: 'STRING_VALUE', /* required */
  SourceBackupVaultName: 'STRING_VALUE', /* required */
  IdempotencyToken: 'STRING_VALUE',
  Lifecycle: {
    DeleteAfterDays: 'NUMBER_VALUE',
    MoveToColdStorageAfterDays: 'NUMBER_VALUE'
  }
};
backup.startCopyJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • RecoveryPointArn — (String)

      An ARN that uniquely identifies a recovery point to use for the copy job; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

    • SourceBackupVaultName — (String)

      The name of a logical source container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

    • DestinationBackupVaultArn — (String)

      An Amazon Resource Name (ARN) that uniquely identifies a destination backup vault to copy to; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

    • IamRoleArn — (String)

      Specifies the IAM role ARN used to copy the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

    • IdempotencyToken — (String)

      A customer-chosen string that you can use to distinguish between otherwise identical calls to StartCopyJob. Retrying a successful request with the same idempotency token results in a success message with no action taken.

    • Lifecycle — (map)

      Contains an array of Transition objects specifying how long in days before a recovery point transitions to cold storage or is deleted.

      Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, on the console, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.

      Only Amazon EFS file system backups can be transitioned to cold storage.

      • MoveToColdStorageAfterDays — (Integer)

        Specifies the number of days after creation that a recovery point is moved to cold storage.

      • DeleteAfterDays — (Integer)

        Specifies the number of days after creation that a recovery point is deleted. Must be greater than 90 days plus MoveToColdStorageAfterDays.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • CopyJobId — (String)

        Uniquely identifies a copy job.

      • CreationDate — (Date)

        The date and time that a copy job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

startReportJob(params = {}, callback) ⇒ AWS.Request

Starts an on-demand report job for the specified report plan.

Service Reference:

Examples:

Calling the startReportJob operation

var params = {
  ReportPlanName: 'STRING_VALUE', /* required */
  IdempotencyToken: 'STRING_VALUE'
};
backup.startReportJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ReportPlanName — (String)

      The unique name of a report plan.

    • IdempotencyToken — (String)

      A customer-chosen string that you can use to distinguish between otherwise identical calls to StartReportJobInput. Retrying a successful request with the same idempotency token results in a success message with no action taken.

      If a token is not provided, the SDK will use a version 4 UUID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ReportJobId — (String)

        The identifier of the report job. A unique, randomly generated, Unicode, UTF-8 encoded string that is at most 1,024 bytes long. The report job ID cannot be edited.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

startRestoreJob(params = {}, callback) ⇒ AWS.Request

Recovers the saved resource identified by an Amazon Resource Name (ARN).

Service Reference:

Examples:

Calling the startRestoreJob operation

var params = {
  IamRoleArn: 'STRING_VALUE', /* required */
  Metadata: { /* required */
    '<MetadataKey>': 'STRING_VALUE',
    /* '<MetadataKey>': ... */
  },
  RecoveryPointArn: 'STRING_VALUE', /* required */
  IdempotencyToken: 'STRING_VALUE',
  ResourceType: 'STRING_VALUE'
};
backup.startRestoreJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • RecoveryPointArn — (String)

      An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

    • Metadata — (map<String>)

      A set of metadata key-value pairs. Contains information, such as a resource name, required to restore a recovery point.

      You can get configuration metadata about a resource at the time it was backed up by calling GetRecoveryPointRestoreMetadata. However, values in addition to those provided by GetRecoveryPointRestoreMetadata might be required to restore a resource. For example, you might need to provide a new resource name if the original already exists.

      You need to specify specific metadata to restore an Amazon Elastic File System (Amazon EFS) instance:

      • file-system-id: The ID of the Amazon EFS file system that is backed up by Backup. Returned in GetRecoveryPointRestoreMetadata.

      • Encrypted: A Boolean value that, if true, specifies that the file system is encrypted. If KmsKeyId is specified, Encrypted must be set to true.

      • KmsKeyId: Specifies the Amazon Web Services KMS key that is used to encrypt the restored file system. You can specify a key from another Amazon Web Services account provided that key it is properly shared with your account via Amazon Web Services KMS.

      • PerformanceMode: Specifies the throughput mode of the file system.

      • CreationToken: A user-supplied value that ensures the uniqueness (idempotency) of the request.

      • newFileSystem: A Boolean value that, if true, specifies that the recovery point is restored to a new Amazon EFS file system.

      • ItemsToRestore: An array of one to five strings where each string is a file path. Use ItemsToRestore to restore specific files or directories rather than the entire file system. This parameter is optional. For example, "itemsToRestore":"[\"/my.test\"]".

    • IamRoleArn — (String)

      The Amazon Resource Name (ARN) of the IAM role that Backup uses to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

    • IdempotencyToken — (String)

      A customer-chosen string that you can use to distinguish between otherwise identical calls to StartRestoreJob. Retrying a successful request with the same idempotency token results in a success message with no action taken.

    • ResourceType — (String)

      Starts a job to restore a recovery point for one of the following resources:

      • DynamoDB for Amazon DynamoDB

      • EBS for Amazon Elastic Block Store

      • EC2 for Amazon Elastic Compute Cloud

      • EFS for Amazon Elastic File System

      • RDS for Amazon Relational Database Service

      • Aurora for Amazon Aurora

      • Storage Gateway for Storage Gateway

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • RestoreJobId — (String)

        Uniquely identifies the job that restores a recovery point.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

stopBackupJob(params = {}, callback) ⇒ AWS.Request

Attempts to cancel a job to create a one-time backup of a resource.

Service Reference:

Examples:

Calling the stopBackupJob operation

var params = {
  BackupJobId: 'STRING_VALUE' /* required */
};
backup.stopBackupJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • BackupJobId — (String)

      Uniquely identifies a request to Backup to back up a resource.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

tagResource(params = {}, callback) ⇒ AWS.Request

Assigns a set of key-value pairs to a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN).

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  Tags: { /* required */
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
backup.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceArn — (String)

      An ARN that uniquely identifies a resource. The format of the ARN depends on the type of the tagged resource.

    • Tags — (map<String>)

      Key-value pairs that are used to help organize your resources. You can assign your own metadata to the resources you create.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

untagResource(params = {}, callback) ⇒ AWS.Request

Removes a set of key-value pairs from a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN)

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  TagKeyList: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
backup.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceArn — (String)

      An ARN that uniquely identifies a resource. The format of the ARN depends on the type of the tagged resource.

    • TagKeyList — (Array<String>)

      A list of keys to identify which key-value tags to remove from a resource.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateBackupPlan(params = {}, callback) ⇒ AWS.Request

Updates an existing backup plan identified by its backupPlanId with the input document in JSON format. The new version is uniquely identified by a VersionId.

Service Reference:

Examples:

Calling the updateBackupPlan operation

var params = {
  BackupPlan: { /* required */
    BackupPlanName: 'STRING_VALUE', /* required */
    Rules: [ /* required */
      {
        RuleName: 'STRING_VALUE', /* required */
        TargetBackupVaultName: 'STRING_VALUE', /* required */
        CompletionWindowMinutes: 'NUMBER_VALUE',
        CopyActions: [
          {
            DestinationBackupVaultArn: 'STRING_VALUE', /* required */
            Lifecycle: {
              DeleteAfterDays: 'NUMBER_VALUE',
              MoveToColdStorageAfterDays: 'NUMBER_VALUE'
            }
          },
          /* more items */
        ],
        EnableContinuousBackup: true || false,
        Lifecycle: {
          DeleteAfterDays: 'NUMBER_VALUE',
          MoveToColdStorageAfterDays: 'NUMBER_VALUE'
        },
        RecoveryPointTags: {
          '<TagKey>': 'STRING_VALUE',
          /* '<TagKey>': ... */
        },
        ScheduleExpression: 'STRING_VALUE',
        StartWindowMinutes: 'NUMBER_VALUE'
      },
      /* more items */
    ],
    AdvancedBackupSettings: [
      {
        BackupOptions: {
          '<BackupOptionKey>': 'STRING_VALUE',
          /* '<BackupOptionKey>': ... */
        },
        ResourceType: 'STRING_VALUE'
      },
      /* more items */
    ]
  },
  BackupPlanId: 'STRING_VALUE' /* required */
};
backup.updateBackupPlan(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • BackupPlanId — (String)

      Uniquely identifies a backup plan.

    • BackupPlan — (map)

      Specifies the body of a backup plan. Includes a BackupPlanName and one or more sets of Rules.

      • BackupPlanNamerequired — (String)

        The optional display name of a backup plan.

      • Rulesrequired — (Array<map>)

        An array of BackupRule objects, each of which specifies a scheduled task that is used to back up a selection of resources.

        • RuleNamerequired — (String)

          An optional display name for a backup rule.

        • TargetBackupVaultNamerequired — (String)

          The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

        • ScheduleExpression — (String)

          A CRON expression in UTC specifying when Backup initiates a backup job.

        • StartWindowMinutes — (Integer)

          A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully. This value is optional.

        • CompletionWindowMinutes — (Integer)

          A value in minutes after a backup job is successfully started before it must be completed or it will be canceled by Backup. This value is optional.

        • Lifecycle — (map)

          The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup will transition and expire backups automatically according to the lifecycle that you define.

          Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.

          Only Amazon EFS file system backups can be transitioned to cold storage.

          • MoveToColdStorageAfterDays — (Integer)

            Specifies the number of days after creation that a recovery point is moved to cold storage.

          • DeleteAfterDays — (Integer)

            Specifies the number of days after creation that a recovery point is deleted. Must be greater than 90 days plus MoveToColdStorageAfterDays.

        • RecoveryPointTags — (map<String>)

          To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair.

        • CopyActions — (Array<map>)

          An array of CopyAction objects, which contains the details of the copy operation.

          • Lifecycle — (map)

            Contains an array of Transition objects specifying how long in days before a recovery point transitions to cold storage or is deleted.

            Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, on the console, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.

            Only Amazon EFS file system backups can be transitioned to cold storage.

            • MoveToColdStorageAfterDays — (Integer)

              Specifies the number of days after creation that a recovery point is moved to cold storage.

            • DeleteAfterDays — (Integer)

              Specifies the number of days after creation that a recovery point is deleted. Must be greater than 90 days plus MoveToColdStorageAfterDays.

          • DestinationBackupVaultArnrequired — (String)

            An Amazon Resource Name (ARN) that uniquely identifies the destination backup vault for the copied backup. For example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

        • EnableContinuousBackup — (Boolean)

          Specifies whether Backup creates continuous backups. True causes Backup to create continuous backups capable of point-in-time restore (PITR). False (or not specified) causes Backup to create snapshot backups.

      • AdvancedBackupSettings — (Array<map>)

        Specifies a list of BackupOptions for each resource type. These settings are only available for Windows Volume Shadow Copy Service (VSS) backup jobs.

        • ResourceType — (String)

          Specifies an object containing resource type and backup options. The only supported resource type is Amazon EC2 instances with Windows Volume Shadow Copy Service (VSS). For a CloudFormation example, see the sample CloudFormation template to enable Windows VSS in the Backup User Guide.

          Valid values: EC2.

        • BackupOptions — (map<String>)

          Specifies the backup option for a selected resource. This option is only available for Windows VSS backup jobs.

          Valid values:

          Set to "WindowsVSS":"enabled" to enable the WindowsVSS backup option and create a Windows VSS backup.

          Set to "WindowsVSS":"disabled" to create a regular backup. The WindowsVSS option is not enabled by default.

          If you specify an invalid option, you get an InvalidParameterValueException exception.

          For more information about Windows VSS backups, see Creating a VSS-Enabled Windows Backup.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • BackupPlanId — (String)

        Uniquely identifies a backup plan.

      • BackupPlanArn — (String)

        An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.

      • CreationDate — (Date)

        The date and time a backup plan is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

      • VersionId — (String)

        Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version Ids cannot be edited.

      • AdvancedBackupSettings — (Array<map>)

        Contains a list of BackupOptions for each resource type.

        • ResourceType — (String)

          Specifies an object containing resource type and backup options. The only supported resource type is Amazon EC2 instances with Windows Volume Shadow Copy Service (VSS). For a CloudFormation example, see the sample CloudFormation template to enable Windows VSS in the Backup User Guide.

          Valid values: EC2.

        • BackupOptions — (map<String>)

          Specifies the backup option for a selected resource. This option is only available for Windows VSS backup jobs.

          Valid values:

          Set to "WindowsVSS":"enabled" to enable the WindowsVSS backup option and create a Windows VSS backup.

          Set to "WindowsVSS":"disabled" to create a regular backup. The WindowsVSS option is not enabled by default.

          If you specify an invalid option, you get an InvalidParameterValueException exception.

          For more information about Windows VSS backups, see Creating a VSS-Enabled Windows Backup.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateFramework(params = {}, callback) ⇒ AWS.Request

Updates an existing framework identified by its FrameworkName with the input document in JSON format.

Service Reference:

Examples:

Calling the updateFramework operation

var params = {
  FrameworkName: 'STRING_VALUE', /* required */
  FrameworkControls: [
    {
      ControlName: 'STRING_VALUE', /* required */
      ControlInputParameters: [
        {
          ParameterName: 'STRING_VALUE',
          ParameterValue: 'STRING_VALUE'
        },
        /* more items */
      ],
      ControlScope: {
        ComplianceResourceIds: [
          'STRING_VALUE',
          /* more items */
        ],
        ComplianceResourceTypes: [
          'STRING_VALUE',
          /* more items */
        ],
        Tags: {
          '<string>': 'STRING_VALUE',
          /* '<string>': ... */
        }
      }
    },
    /* more items */
  ],
  FrameworkDescription: 'STRING_VALUE',
  IdempotencyToken: 'STRING_VALUE'
};
backup.updateFramework(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FrameworkName — (String)

      The unique name of a framework. This name is between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).

    • FrameworkDescription — (String)

      An optional description of the framework with a maximum 1,024 characters.

    • FrameworkControls — (Array<map>)

      A list of the controls that make up the framework. Each control in the list has a name, input parameters, and scope.

      • ControlNamerequired — (String)

        The name of a control. This name is between 1 and 256 characters.

      • ControlInputParameters — (Array<map>)

        A list of ParameterName and ParameterValue pairs.

        • ParameterName — (String)

          The name of a parameter, for example, BackupPlanFrequency.

        • ParameterValue — (String)

          The value of parameter, for example, hourly.

      • ControlScope — (map)

        The scope of a control. The control scope defines what the control will evaluate. Three examples of control scopes are: a specific backup plan, all backup plans with a specific tag, or all backup plans. For more information, see ControlScope.

        • ComplianceResourceIds — (Array<String>)

          Describes whether the control scope includes a specific resource identified by its unique Amazon Resource Name (ARN).

        • ComplianceResourceTypes — (Array<String>)

          Describes whether the control scope includes one or more types of resources, such as EFS or RDS.

        • Tags — (map<String>)

          Describes whether the control scope includes resources with one or more tags. Each tag is a key-value pair.

    • IdempotencyToken — (String)

      A customer-chosen string that you can use to distinguish between otherwise identical calls to UpdateFrameworkInput. Retrying a successful request with the same idempotency token results in a success message with no action taken.

      If a token is not provided, the SDK will use a version 4 UUID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • FrameworkName — (String)

        The unique name of a framework. This name is between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).

      • FrameworkArn — (String)

        An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

      • CreationTime — (Date)

        The date and time that a framework is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateGlobalSettings(params = {}, callback) ⇒ AWS.Request

Updates whether the Amazon Web Services account is opted in to cross-account backup. Returns an error if the account is not an Organizations management account. Use the DescribeGlobalSettings API to determine the current settings.

Service Reference:

Examples:

Calling the updateGlobalSettings operation

var params = {
  GlobalSettings: {
    '<GlobalSettingsName>': 'STRING_VALUE',
    /* '<GlobalSettingsName>': ... */
  }
};
backup.updateGlobalSettings(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • GlobalSettings — (map<String>)

      A value for isCrossAccountBackupEnabled and a Region. Example: update-global-settings --global-settings isCrossAccountBackupEnabled=false --region us-west-2.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateRecoveryPointLifecycle(params = {}, callback) ⇒ AWS.Request

Sets the transition lifecycle of a recovery point.

The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define.

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.

Only Amazon EFS file system backups can be transitioned to cold storage.

Does not support continuous backups.

Service Reference:

Examples:

Calling the updateRecoveryPointLifecycle operation

var params = {
  BackupVaultName: 'STRING_VALUE', /* required */
  RecoveryPointArn: 'STRING_VALUE', /* required */
  Lifecycle: {
    DeleteAfterDays: 'NUMBER_VALUE',
    MoveToColdStorageAfterDays: 'NUMBER_VALUE'
  }
};
backup.updateRecoveryPointLifecycle(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • BackupVaultName — (String)

      The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

    • RecoveryPointArn — (String)

      An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

    • Lifecycle — (map)

      The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define.

      Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.

      • MoveToColdStorageAfterDays — (Integer)

        Specifies the number of days after creation that a recovery point is moved to cold storage.

      • DeleteAfterDays — (Integer)

        Specifies the number of days after creation that a recovery point is deleted. Must be greater than 90 days plus MoveToColdStorageAfterDays.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • BackupVaultArn — (String)

        An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

      • RecoveryPointArn — (String)

        An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

      • Lifecycle — (map)

        The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define.

        Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.

        Only Amazon EFS file system backups can be transitioned to cold storage.

        • MoveToColdStorageAfterDays — (Integer)

          Specifies the number of days after creation that a recovery point is moved to cold storage.

        • DeleteAfterDays — (Integer)

          Specifies the number of days after creation that a recovery point is deleted. Must be greater than 90 days plus MoveToColdStorageAfterDays.

      • CalculatedLifecycle — (map)

        A CalculatedLifecycle object containing DeleteAt and MoveToColdStorageAt timestamps.

        • MoveToColdStorageAt — (Date)

          A timestamp that specifies when to transition a recovery point to cold storage.

        • DeleteAt — (Date)

          A timestamp that specifies when to delete a recovery point.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateRegionSettings(params = {}, callback) ⇒ AWS.Request

Updates the current service opt-in settings for the Region. If service-opt-in is enabled for a service, Backup tries to protect that service's resources in this Region, when the resource is included in an on-demand backup or scheduled backup plan. Otherwise, Backup does not try to protect that service's resources in this Region. Use the DescribeRegionSettings API to determine the resource types that are supported.

Service Reference:

Examples:

Calling the updateRegionSettings operation

var params = {
  ResourceTypeOptInPreference: {
    '<ResourceType>': true || false,
    /* '<ResourceType>': ... */
  }
};
backup.updateRegionSettings(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceTypeOptInPreference — (map<Boolean>)

      Updates the list of services along with the opt-in preferences for the Region.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateReportPlan(params = {}, callback) ⇒ AWS.Request

Updates an existing report plan identified by its ReportPlanName with the input document in JSON format.

Service Reference:

Examples:

Calling the updateReportPlan operation

var params = {
  ReportPlanName: 'STRING_VALUE', /* required */
  IdempotencyToken: 'STRING_VALUE',
  ReportDeliveryChannel: {
    S3BucketName: 'STRING_VALUE', /* required */
    Formats: [
      'STRING_VALUE',
      /* more items */
    ],
    S3KeyPrefix: 'STRING_VALUE'
  },
  ReportPlanDescription: 'STRING_VALUE',
  ReportSetting: {
    ReportTemplate: 'STRING_VALUE' /* required */
  }
};
backup.updateReportPlan(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ReportPlanName — (String)

      The unique name of the report plan. This name is between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).

    • ReportPlanDescription — (String)

      An optional description of the report plan with a maximum 1,024 characters.

    • ReportDeliveryChannel — (map)

      A structure that contains information about where to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.

      • S3BucketNamerequired — (String)

        The unique name of the S3 bucket that receives your reports.

      • S3KeyPrefix — (String)

        The prefix for where Backup Audit Manager delivers your reports to Amazon S3. The prefix is this part of the following path: s3://your-bucket-name/prefix/Backup/us-west-2/year/month/day/report-name. If not specified, there is no prefix.

      • Formats — (Array<String>)

        A list of the format of your reports: CSV, JSON, or both. If not specified, the default format is CSV.

    • ReportSetting — (map)

      Identifies the report template for the report. Reports are built using a report template. The report templates are:

      BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT

      • ReportTemplaterequired — (String)

        Identifies the report template for the report. Reports are built using a report template. The report templates are:

        BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT

    • IdempotencyToken — (String)

      A customer-chosen string that you can use to distinguish between otherwise identical calls to UpdateReportPlanInput. Retrying a successful request with the same idempotency token results in a success message with no action taken.

      If a token is not provided, the SDK will use a version 4 UUID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ReportPlanName — (String)

        The unique name of the report plan.

      • ReportPlanArn — (String)

        An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

      • CreationTime — (Date)

        The date and time that a report plan is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.