Class: AWS.Backup

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',
              OptInToArchiveForSupportedResources: true || false
            }
          },
          /* more items */
        ],
        EnableContinuousBackup: true || false,
        Lifecycle: {
          DeleteAfterDays: 'NUMBER_VALUE',
          MoveToColdStorageAfterDays: 'NUMBER_VALUE',
          OptInToArchiveForSupportedResources: true || false
        },
        RecoveryPointTags: {
          '<TagKey>': 'STRING_VALUE',
          /* '<TagKey>': ... */
        },
        ScheduleExpression: 'STRING_VALUE',
        ScheduleExpressionTimezone: '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)

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

    • BackupPlanName — required — (String)

      The display name of a backup plan. Must contain 1 to 50 alphanumeric or '-_.' characters.

    • Rules — required — (Array<map>)

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

      • RuleName — required — (String)

        A display name for a backup rule. Must contain 1 to 50 alphanumeric or '-_.' characters.

      • TargetBackupVaultName — required — (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.

      • 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. If this value is included, it must be at least 60 minutes to avoid errors.

        This parameter has a maximum value of 100 years (52,560,000 minutes).

        During the start window, the backup job status remains in CREATED status until it has successfully begun or until the start window time has run out. If within the start window time Backup receives an error that allows the job to be retried, Backup will automatically retry to begin the job at least every 10 minutes until the backup successfully begins (the job status changes to RUNNING) or until the job status changes to EXPIRED (which is expected to occur when the start window time is over).

      • 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 “retention” 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 storage.

        Resource types that can transition to cold storage are listed in the Feature availability by resource table. Backup ignores this expression for other resource types.

        This parameter has a maximum value of 100 years (36,500 days).

        • MoveToColdStorageAfterDays — (Integer)

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

        • DeleteAfterDays — (Integer)

          The number of days after creation that a recovery point is deleted. This value must be at least 90 days after the number of days specified in MoveToColdStorageAfterDays.

        • OptInToArchiveForSupportedResources — (Boolean)

          If the value is true, your backup plan transitions supported resources to archive (cold) storage tier in accordance with your lifecycle settings.

      • RecoveryPointTags — (map<String>)

        The tags to assign to the resources.

      • CopyActions — (Array<map>)

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

        • Lifecycle — (map)

          Specifies the time period, 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 retention setting must be 90 days greater than the transition to cold after days setting. The transition to cold after days setting can't be changed after a backup has been transitioned to cold.

          Resource types that can transition to cold storage are listed in the Feature availability by resource table. Backup ignores this expression for other resource types.

          To remove the existing lifecycle and retention periods and keep your recovery points indefinitely, specify -1 for MoveToColdStorageAfterDays and DeleteAfterDays.

          • MoveToColdStorageAfterDays — (Integer)

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

          • DeleteAfterDays — (Integer)

            The number of days after creation that a recovery point is deleted. This value must be at least 90 days after the number of days specified in MoveToColdStorageAfterDays.

          • OptInToArchiveForSupportedResources — (Boolean)

            If the value is true, your backup plan transitions supported resources to archive (cold) storage tier in accordance with your lifecycle settings.

        • DestinationBackupVaultArn — required — (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:backup-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.

      • ScheduleExpressionTimezone — (String)

        The timezone in which the schedule expression is set. By default, ScheduleExpressions are in UTC. You can modify this to a specified timezone.

    • 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>)

    The tags to assign to the backup 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.

    If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.

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)

      The ID of the 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>)

      The 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.

var params = {
  BackupPlanId: 'STRING_VALUE', /* required */
  BackupSelection: { /* required */
    IamRoleArn: 'STRING_VALUE', /* required */
    SelectionName: 'STRING_VALUE', /* required */
    Conditions: {
      StringEquals: [
        {
          ConditionKey: 'STRING_VALUE',
          ConditionValue: 'STRING_VALUE'
        },
        /* more items */
      ],
      StringLike: [
        {
          ConditionKey: 'STRING_VALUE',
          ConditionValue: 'STRING_VALUE'
        },
        /* more items */
      ],
      StringNotEquals: [
        {
          ConditionKey: 'STRING_VALUE',
          ConditionValue: 'STRING_VALUE'
        },
        /* more items */
      ],
      StringNotLike: [
        {
          ConditionKey: 'STRING_VALUE',
          ConditionValue: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    ListOfTags: [
      {
        ConditionKey: 'STRING_VALUE', /* required */
        ConditionType: STRINGEQUALS, /* required */
        ConditionValue: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    NotResources: [
      'STRING_VALUE',
      /* 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)

    The ID of the backup plan.

  • BackupSelection — (map)

    The body of a request to assign a set of resources to a backup plan.

    • SelectionName — required — (String)

      The display name of a resource selection document. Must contain 1 to 50 alphanumeric or '-_.' characters.

    • IamRoleArn — required — (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>)

      The Amazon Resource Names (ARNs) of the resources to assign to a backup plan. The maximum number of ARNs is 500 without wildcards, or 30 ARNs with wildcards.

      If you need to assign many resources to a backup plan, consider a different resource selection strategy, such as assigning all resources of a resource type or refining your resource selection using tags.

      If you specify multiple ARNs, the resources much match any of the ARNs (OR logic).

    • ListOfTags — (Array<map>)

      The conditions that you define to assign resources to your backup plans using tags. For example, "StringEquals": { "ConditionKey": "backup", "ConditionValue": "daily"}.

      ListOfTags supports only StringEquals. Condition operators are case sensitive.

      If you specify multiple conditions, the resources much match any of the conditions (OR logic).

      • ConditionType — required — (String)

        An operation applied to a key-value pair used to assign resources to your backup plan. Condition only supports StringEquals. For more flexible assignment options, including StringLike and the ability to exclude resources from your backup plan, use Conditions (with an "s" on the end) for your BackupSelection .

        Possible values include:
        • "STRINGEQUALS"
      • ConditionKey — required — (String)

        The key in a key-value pair. For example, in the tag Department: Accounting, Department is the key.

      • ConditionValue — required — (String)

        The value in a key-value pair. For example, in the tag Department: Accounting, Accounting is the value.

    • NotResources — (Array<String>)

      The Amazon Resource Names (ARNs) of the resources to exclude from a backup plan. The maximum number of ARNs is 500 without wildcards, or 30 ARNs with wildcards.

      If you need to exclude many resources from a backup plan, consider a different resource selection strategy, such as assigning only one or a few resource types or refining your resource selection using tags.

    • Conditions — (map)

      The conditions that you define to assign resources to your backup plans using tags. For example, "StringEquals": { "ConditionKey": "aws:ResourceTag/backup", "ConditionValue": "daily" }.

      Conditions supports StringEquals, StringLike, StringNotEquals, and StringNotLike. Condition operators are case sensitive.

      If you specify multiple conditions, the resources much match all conditions (AND logic).

      • StringEquals — (Array<map>)

        Filters the values of your tagged resources for only those resources that you tagged with the same value. Also called "exact matching."

        • ConditionKey — (String)

          The key in a key-value pair. For example, in the tag Department: Accounting, Department is the key.

        • ConditionValue — (String)

          The value in a key-value pair. For example, in the tag Department: Accounting, Accounting is the value.

      • StringNotEquals — (Array<map>)

        Filters the values of your tagged resources for only those resources that you tagged that do not have the same value. Also called "negated matching."

        • ConditionKey — (String)

          The key in a key-value pair. For example, in the tag Department: Accounting, Department is the key.

        • ConditionValue — (String)

          The value in a key-value pair. For example, in the tag Department: Accounting, Accounting is the value.

      • StringLike — (Array<map>)

        Filters the values of your tagged resources for matching tag values with the use of a wildcard character () anywhere in the string. For example, "prod" or "rod" matches the tag value "production".

        • ConditionKey — (String)

          The key in a key-value pair. For example, in the tag Department: Accounting, Department is the key.

        • ConditionValue — (String)

          The value in a key-value pair. For example, in the tag Department: Accounting, Accounting is the value.

      • StringNotLike — (Array<map>)

        Filters the values of your tagged resources for non-matching tag values with the use of a wildcard character (*) anywhere in the string.

        • ConditionKey — (String)

          The key in a key-value pair. For example, in the tag Department: Accounting, Department is the key.

        • ConditionValue — (String)

          The value in a key-value pair. For example, in the tag 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. This parameter is optional.

    If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.

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)

      The ID of the 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.

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>)

    The tags to assign to the backup vault.

  • 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. This parameter is optional.

    If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.

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:backup-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.

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>)

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

    • ControlName — required — (String)

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

    • ControlInputParameters — (Array<map>)

      The name/value 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>)

        The ID of the only Amazon Web Services resource that you want your control scope to contain.

      • ComplianceResourceTypes — (Array<String>)

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

      • Tags — (map<String>)

        The tag key-value pair applied to those Amazon Web Services resources that you want to trigger an evaluation for a rule. A maximum of one key-value pair can be provided. The tag value is optional, but it cannot be an empty string if you are creating or editing a framework from the console (though the value can be an empty string when included in a CloudFormation template).

        The structure to assign a tag is: [{"Key":"string","Value":"string"}].

  • 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>)

    The tags to assign to the 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 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.

var params = {
  Description: 'STRING_VALUE', /* required */
  Title: 'STRING_VALUE', /* required */
  IdempotencyToken: 'STRING_VALUE',
  RecoveryPointSelection: {
    DateRange: {
      FromDate: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
      ToDate: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789 /* required */
    },
    ResourceIdentifiers: [
      'STRING_VALUE',
      /* more items */
    ],
    VaultNames: [
      'STRING_VALUE',
      /* more items */
    ]
  },
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
backup.createLegalHold(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: {}) —
  • Title — (String)

    The title of the legal hold.

  • Description — (String)

    The description of the legal hold.

  • IdempotencyToken — (String)

    This is a user-chosen string used to distinguish between otherwise identical calls. Retrying a successful request with the same idempotency token results in a success message with no action taken.

  • RecoveryPointSelection — (map)

    The criteria to assign a set of resources, such as resource types or backup vaults.

    • VaultNames — (Array<String>)

      These are the names of the vaults in which the selected recovery points are contained.

    • ResourceIdentifiers — (Array<String>)

      These are the resources included in the resource selection (including type of resources and vaults).

    • DateRange — (map)

      This is a resource filter containing FromDate: DateTime and ToDate: DateTime. Both values are required. Future DateTime values are not permitted.

      The date and time are in Unix format and Coordinated Universal Time (UTC), and it is accurate to milliseconds ((milliseconds are optional). For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

      • FromDate — required — (Date)

        This value is the beginning date, inclusive.

        The date and time are in Unix format and Coordinated Universal Time (UTC), and it is accurate to milliseconds (milliseconds are optional).

      • ToDate — required — (Date)

        This value is the end date, inclusive.

        The date and time are in Unix format and Coordinated Universal Time (UTC), and it is accurate to milliseconds (milliseconds are optional).

  • Tags — (map<String>)

    Optional tags to include. A tag is a key-value pair you can use to manage, filter, and search for your resources. Allowed characters include UTF-8 letters, numbers, spaces, and the following characters: + - = . _ : /.

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:

    • Title — (String)

      The title of the legal hold.

    • Status — (String)

      The status of the legal hold.

      Possible values include:
      • "CREATING"
      • "ACTIVE"
      • "CANCELING"
      • "CANCELED"
    • Description — (String)

      The description of the legal hold.

    • LegalHoldId — (String)

      The ID of the legal hold.

    • LegalHoldArn — (String)

      The Amazon Resource Name (ARN) of the legal hold.

    • CreationDate — (Date)

      The time when the legal hold was created.

    • RecoveryPointSelection — (map)

      The criteria to assign to a set of resources, such as resource types or backup vaults.

      • VaultNames — (Array<String>)

        These are the names of the vaults in which the selected recovery points are contained.

      • ResourceIdentifiers — (Array<String>)

        These are the resources included in the resource selection (including type of resources and vaults).

      • DateRange — (map)

        This is a resource filter containing FromDate: DateTime and ToDate: DateTime. Both values are required. Future DateTime values are not permitted.

        The date and time are in Unix format and Coordinated Universal Time (UTC), and it is accurate to milliseconds ((milliseconds are optional). For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

        • FromDate — required — (Date)

          This value is the beginning date, inclusive.

          The date and time are in Unix format and Coordinated Universal Time (UTC), and it is accurate to milliseconds (milliseconds are optional).

        • ToDate — required — (Date)

          This value is the end date, inclusive.

          The date and time are in Unix format and Coordinated Universal Time (UTC), and it is accurate to milliseconds (milliseconds are optional).

Returns:

• (AWS.Request) —

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

var params = {
  BackupVaultName: 'STRING_VALUE', /* required */
  MaxRetentionDays: 'NUMBER_VALUE', /* required */
  MinRetentionDays: 'NUMBER_VALUE', /* required */
  BackupVaultTags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  },
  CreatorRequestId: 'STRING_VALUE'
};
backup.createLogicallyAirGappedBackupVault(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. Logically air-gapped backup vaults are identified by names that are unique to the account used to create them and the Region where they are created.

  • BackupVaultTags — (map<String>)

    The tags to assign to the vault.

  • CreatorRequestId — (String)

    The ID of the creation request.

    This parameter is optional. If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.

  • MinRetentionDays — (Integer)

    This setting specifies the minimum retention period that the vault retains its recovery points.

    The minimum value accepted is 7 days.

  • MaxRetentionDays — (Integer)

    The maximum retention period that the vault retains its recovery points.

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. Logically air-gapped backup vaults are identified by names that are unique to the account used to create them and the Region where they are created.

    • BackupVaultArn — (String)

      The ARN (Amazon Resource Name) of the vault.

    • CreationDate — (Date)

      The date and time when the vault was created.

      This value is in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

    • VaultState — (String)

      The current state of the vault.

      Possible values include:
      • "CREATING"
      • "AVAILABLE"
      • "FAILED"

Returns:

• (AWS.Request) —

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

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 */
    Accounts: [
      'STRING_VALUE',
      /* more items */
    ],
    FrameworkArns: [
      'STRING_VALUE',
      /* more items */
    ],
    NumberOfFrameworks: 'NUMBER_VALUE',
    OrganizationUnits: [
      'STRING_VALUE',
      /* more items */
    ],
    Regions: [
      'STRING_VALUE',
      /* more items */
    ]
  },
  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.

    • S3BucketName — required — (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>)

      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:

    RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT

    If the report template is RESOURCE_COMPLIANCE_REPORT or CONTROL_COMPLIANCE_REPORT, this API resource also describes the report coverage by Amazon Web Services Regions and frameworks.

    • ReportTemplate — required — (String)

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

      RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT

    • FrameworkArns — (Array<String>)

      The Amazon Resource Names (ARNs) of the frameworks a report covers.

    • NumberOfFrameworks — (Integer)

      The number of frameworks a report covers.

    • Accounts — (Array<String>)

      These are the accounts to be included in the report.

      Use string value of ROOT to include all organizational units.

    • OrganizationUnits — (Array<String>)

      These are the Organizational Units to be included in the report.

    • Regions — (Array<String>)

      These are the Regions to be included in the report.

      Use the wildcard as the string value to include all Regions.

  • ReportPlanTags — (map<String>)

    The tags to assign to the report plan.

  • 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.

    • CreationTime — (Date)

      The date and time a backup vault 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.

var params = {
  RestoreTestingPlan: { /* required */
    RecoveryPointSelection: { /* required */
      Algorithm: LATEST_WITHIN_WINDOW | RANDOM_WITHIN_WINDOW,
      ExcludeVaults: [
        'STRING_VALUE',
        /* more items */
      ],
      IncludeVaults: [
        'STRING_VALUE',
        /* more items */
      ],
      RecoveryPointTypes: [
        CONTINUOUS | SNAPSHOT,
        /* more items */
      ],
      SelectionWindowDays: 'NUMBER_VALUE'
    },
    RestoreTestingPlanName: 'STRING_VALUE', /* required */
    ScheduleExpression: 'STRING_VALUE', /* required */
    ScheduleExpressionTimezone: 'STRING_VALUE',
    StartWindowHours: 'NUMBER_VALUE'
  },
  CreatorRequestId: 'STRING_VALUE',
  Tags: {
    '<String>': 'STRING_VALUE',
    /* '<String>': ... */
  }
};
backup.createRestoreTestingPlan(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: {}) —
  • CreatorRequestId — (String)

    This is a unique string that identifies the request and allows failed requests to be retriedwithout the risk of running the operation twice. This parameter is optional. If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.

  • RestoreTestingPlan — (map)

    A restore testing plan must contain a unique RestoreTestingPlanName string you create and must contain a ScheduleExpression cron. You may optionally include a StartWindowHours integer and a CreatorRequestId string.

    The RestoreTestingPlanName is a unique string that is the name of the restore testing plan. This cannot be changed after creation, and it must consist of only alphanumeric characters and underscores.

    • RecoveryPointSelection — required — (map)

      RecoveryPointSelection has five parameters (three required and two optional). The values you specify determine which recovery point is included in the restore test. You must indicate with Algorithm if you want the latest recovery point within your SelectionWindowDays or if you want a random recovery point, and you must indicate through IncludeVaults from which vaults the recovery points can be chosen.

      Algorithm (required) Valid values: "LATEST_WITHIN_WINDOW" or "RANDOM_WITHIN_WINDOW".

      Recovery point types (required) Valid values: "SNAPSHOT" and/or "CONTINUOUS". Include SNAPSHOT to restore only snapshot recovery points; include CONTINUOUS to restore continuous recovery points (point in time restore / PITR); use both to restore either a snapshot or a continuous recovery point. The recovery point will be determined by the value for Algorithm.

      IncludeVaults (required). You must include one or more backup vaults. Use the wildcard ["*"] or specific ARNs.

      SelectionWindowDays (optional) Value must be an integer (in days) from 1 to 365. If not included, the value defaults to 30.

      ExcludeVaults (optional). You can choose to input one or more specific backup vault ARNs to exclude those vaults' contents from restore eligibility. Or, you can include a list of selectors. If this parameter and its value are not included, it defaults to empty list.

      • Algorithm — (String)

        Acceptable values include "LATEST_WITHIN_WINDOW" or "RANDOM_WITHIN_WINDOW"

        Possible values include:
        • "LATEST_WITHIN_WINDOW"
        • "RANDOM_WITHIN_WINDOW"
      • ExcludeVaults — (Array<String>)

        Accepted values include specific ARNs or list of selectors. Defaults to empty list if not listed.

      • IncludeVaults — (Array<String>)

        Accepted values include wildcard [""] or by specific ARNs or ARN wilcard replacement ["arn:aws:backup:us-west-2:123456789012:backup-vault:asdf", ...] ["arn:aws:backup:::backup-vault:asdf-", ...]

      • RecoveryPointTypes — (Array<String>)

        These are the types of recovery points.

        Include SNAPSHOT to restore only snapshot recovery points; include CONTINUOUS to restore continuous recovery points (point in time restore / PITR); use both to restore either a snapshot or a continuous recovery point. The recovery point will be determined by the value for Algorithm.

      • SelectionWindowDays — (Integer)

        Accepted values are integers from 1 to 365.

    • RestoreTestingPlanName — required — (String)

      The RestoreTestingPlanName is a unique string that is the name of the restore testing plan. This cannot be changed after creation, and it must consist of only alphanumeric characters and underscores.

    • ScheduleExpression — required — (String)

      A CRON expression in specified timezone when a restore testing plan is executed.

    • ScheduleExpressionTimezone — (String)

      Optional. This is the timezone in which the schedule expression is set. By default, ScheduleExpressions are in UTC. You can modify this to a specified timezone.

    • StartWindowHours — (Integer)

      Defaults to 24 hours.

      A value in hours after a restore test is scheduled before a job will be canceled if it doesn't start successfully. This value is optional. If this value is included, this parameter has a maximum value of 168 hours (one week).

  • Tags — (map<String>)

    The tags to assign to the restore testing 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:

    • CreationTime — (Date)

      The date and time a restore testing plan was 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.087AM.

    • RestoreTestingPlanArn — (String)

      An Amazon Resource Name (ARN) that uniquely identifies the created restore testing plan.

    • RestoreTestingPlanName — (String)

      This unique string is the name of the restore testing plan.

      The name cannot be changed after creation. The name consists of only alphanumeric characters and underscores. Maximum length is 50.

Returns:

• (AWS.Request) —

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

var params = {
  RestoreTestingPlanName: 'STRING_VALUE', /* required */
  RestoreTestingSelection: { /* required */
    IamRoleArn: 'STRING_VALUE', /* required */
    ProtectedResourceType: 'STRING_VALUE', /* required */
    RestoreTestingSelectionName: 'STRING_VALUE', /* required */
    ProtectedResourceArns: [
      'STRING_VALUE',
      /* more items */
    ],
    ProtectedResourceConditions: {
      StringEquals: [
        {
          Key: 'STRING_VALUE', /* required */
          Value: 'STRING_VALUE' /* required */
        },
        /* more items */
      ],
      StringNotEquals: [
        {
          Key: 'STRING_VALUE', /* required */
          Value: 'STRING_VALUE' /* required */
        },
        /* more items */
      ]
    },
    RestoreMetadataOverrides: {
      '<String>': 'STRING_VALUE',
      /* '<String>': ... */
    },
    ValidationWindowHours: 'NUMBER_VALUE'
  },
  CreatorRequestId: 'STRING_VALUE'
};
backup.createRestoreTestingSelection(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: {}) —
  • CreatorRequestId — (String)

    This is an optional unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice. If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.

  • RestoreTestingPlanName — (String)

    Input the restore testing plan name that was returned from the related CreateRestoreTestingPlan request.

  • RestoreTestingSelection — (map)

    This consists of RestoreTestingSelectionName, ProtectedResourceType, and one of the following:

    • ProtectedResourceArns

    • ProtectedResourceConditions

    Each protected resource type can have one single value.

    A restore testing selection can include a wildcard value ("*") for ProtectedResourceArns along with ProtectedResourceConditions. Alternatively, you can include up to 30 specific protected resource ARNs in ProtectedResourceArns.

    • IamRoleArn — required — (String)

      The Amazon Resource Name (ARN) of the IAM role that Backup uses to create the target resource; for example: arn:aws:iam::123456789012:role/S3Access.

    • ProtectedResourceArns — (Array<String>)

      Each protected resource can be filtered by its specific ARNs, such as ProtectedResourceArns: ["arn:aws:...", "arn:aws:..."] or by a wildcard: ProtectedResourceArns: ["*"], but not both.

    • ProtectedResourceConditions — (map)

      If you have included the wildcard in ProtectedResourceArns, you can include resource conditions, such as ProtectedResourceConditions: { StringEquals: [{ key: "XXXX", value: "YYYY" }].

      • StringEquals — (Array<map>)

        Filters the values of your tagged resources for only those resources that you tagged with the same value. Also called "exact matching."

        • Key — required — (String)

          The tag key (String). The key can't start with aws:.

          Length Constraints: Minimum length of 1. Maximum length of 128.

          Pattern: ^(?![aA]{1}[wW]{1}[sS]{1}:)([\p{L}\p{Z}\p{N}_.:/=+-@]+)$

        • Value — required — (String)

          The value of the key.

          Length Constraints: Maximum length of 256.

          Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+-@]*)$

      • StringNotEquals — (Array<map>)

        Filters the values of your tagged resources for only those resources that you tagged that do not have the same value. Also called "negated matching."

        • Key — required — (String)

          The tag key (String). The key can't start with aws:.

          Length Constraints: Minimum length of 1. Maximum length of 128.

          Pattern: ^(?![aA]{1}[wW]{1}[sS]{1}:)([\p{L}\p{Z}\p{N}_.:/=+-@]+)$

        • Value — required — (String)

          The value of the key.

          Length Constraints: Maximum length of 256.

          Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+-@]*)$

    • ProtectedResourceType — required — (String)

      The type of Amazon Web Services resource included in a restore testing selection; for example, an Amazon EBS volume or an Amazon RDS database.

      Supported resource types accepted include:

      • Aurora for Amazon Aurora

      • DocumentDB for Amazon DocumentDB (with MongoDB compatibility)

      • DynamoDB for Amazon DynamoDB

      • EBS for Amazon Elastic Block Store

      • EC2 for Amazon Elastic Compute Cloud

      • EFS for Amazon Elastic File System

      • FSx for Amazon FSx

      • Neptune for Amazon Neptune

      • RDS for Amazon Relational Database Service

      • S3 for Amazon S3

    • RestoreMetadataOverrides — (map<String>)

      You can override certain restore metadata keys by including the parameter RestoreMetadataOverrides in the body of RestoreTestingSelection. Key values are not case sensitive.

      See the complete list of restore testing inferred metadata.

    • RestoreTestingSelectionName — required — (String)

      The unique name of the restore testing selection that belongs to the related restore testing plan.

    • ValidationWindowHours — (Integer)

      This is amount of hours (1 to 168) available to run a validation script on the data. The data will be deleted upon the completion of the validation script or the end of the specified retention period, whichever comes first.

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:

    • CreationTime — (Date)

      The time that the resource testing selection was created.

    • RestoreTestingPlanArn — (String)

      The ARN of the restore testing plan with which the restore testing selection is associated.

    • RestoreTestingPlanName — (String)

      The name of the restore testing plan.

      The name cannot be changed after creation. The name consists of only alphanumeric characters and underscores. Maximum length is 50.

    • RestoreTestingSelectionName — (String)

      The name of the restore testing selection for the related restore testing plan.

Returns:

• (AWS.Request) —

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

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.

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.

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.

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.

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.

var params = {
  BackupVaultName: 'STRING_VALUE' /* required */
};
backup.deleteBackupVaultLockConfiguration(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 the backup vault from which to delete Backup Vault Lock.

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.

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.

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.

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.

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.

  • 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.

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.

var params = {
  RestoreTestingPlanName: 'STRING_VALUE' /* required */
};
backup.deleteRestoreTestingPlan(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: {}) —
  • RestoreTestingPlanName — (String)

    Required unique name of the restore testing plan you wish to delete.

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.

var params = {
  RestoreTestingPlanName: 'STRING_VALUE', /* required */
  RestoreTestingSelectionName: 'STRING_VALUE' /* required */
};
backup.deleteRestoreTestingSelection(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: {}) —
  • RestoreTestingPlanName — (String)

    Required unique name of the restore testing plan that contains the restore testing selection you wish to delete.

  • RestoreTestingSelectionName — (String)

    Required unique name of the restore testing selection you wish to delete.

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.

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.

    • BackupVaultArn — (String)

      An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:backup-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 backup job.

      Possible values include:
      • "CREATED"
      • "PENDING"
      • "RUNNING"
      • "ABORTING"
      • "ABORTED"
      • "COMPLETED"
      • "FAILED"
      • "EXPIRED"
      • "PARTIAL"
    • 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.

    • ParentJobId — (String)

      This returns the parent (composite) resource backup job ID.

    • IsParent — (Boolean)

      This returns the boolean value that a backup job is a parent (composite) job.

    • NumberOfChildJobs — (Integer)

      This returns the number of child (nested) backup jobs.

    • ChildJobsInState — (map<Integer>)

      This returns the statistics of the included child (nested) backup jobs.

    • ResourceName — (String)

      The non-unique name of the resource that belongs to the specified backup.

    • InitiationDate — (Date)

      The date a backup job was initiated.

    • MessageCategory — (String)

      The job count for the specified message category.

      Example strings may include AccessDenied, SUCCESS, AGGREGATE_ALL, and INVALIDPARAMETERS. View Monitoring for a list of accepted MessageCategory strings.

Returns:

• (AWS.Request) —

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

var params = {
  BackupVaultName: 'STRING_VALUE', /* required */
  BackupVaultAccountId: 'STRING_VALUE'
};
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.

  • BackupVaultAccountId — (String)

    The account ID of the specified backup vault.

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.

    • BackupVaultArn — (String)

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

    • VaultType — (String)

      The type of vault described.

      Possible values include:
      • "BACKUP_VAULT"
      • "LOGICALLY_AIR_GAPPED_BACKUP_VAULT"
    • VaultState — (String)

      The current state of the vault.->

      Possible values include:
      • "CREATING"
      • "AVAILABLE"
      • "FAILED"
    • 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. This parameter is optional. If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.

    • NumberOfRecoveryPoints — (Integer)

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

    • Locked — (Boolean)

      A Boolean that indicates whether Backup Vault Lock is currently protecting the backup vault. True means that Vault Lock causes delete or update operations on the recovery points stored in the vault to fail.

    • MinRetentionDays — (Integer)

      The Backup Vault Lock setting that specifies the minimum retention period that the vault retains its recovery points. If this parameter is not specified, Vault Lock will not enforce a minimum retention period.

      If specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or longer than the minimum retention period. If the job's retention period is shorter than that minimum retention period, then the vault fails the backup or copy job, and you should either modify your lifecycle settings or use a different vault. Recovery points already stored in the vault prior to Vault Lock are not affected.

    • MaxRetentionDays — (Integer)

      The Backup Vault Lock setting that specifies the maximum retention period that the vault retains its recovery points. If this parameter is not specified, Vault Lock does not enforce a maximum retention period on the recovery points in the vault (allowing indefinite storage).

      If specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or shorter than the maximum retention period. If the job's retention period is longer than that maximum retention period, then the vault fails the backup or copy job, and you should either modify your lifecycle settings or use a different vault. Recovery points already stored in the vault prior to Vault Lock are not affected.

    • LockDate — (Date)

      The date and time when Backup Vault Lock configuration cannot be changed or deleted.

      If you applied Vault Lock to your vault without specifying a lock date, you can change any of your Vault Lock settings, or delete Vault Lock from the vault entirely, at any time.

      This value is in Unix format, Coordinated Universal Time (UTC), and 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.

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:backup-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:backup-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"
        • "PARTIAL"
      • 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.

      • ParentJobId — (String)

        This uniquely identifies a request to Backup to copy a resource. The return will be the parent (composite) job ID.

      • IsParent — (Boolean)

        This is a boolean value indicating this is a parent (composite) copy job.

      • CompositeMemberIdentifier — (String)

        The identifier of a resource within a composite group, such as nested (child) recovery point belonging to a composite (parent) stack. The ID is transferred from the logical ID within a stack.

      • NumberOfChildJobs — (Integer)

        The number of child (nested) copy jobs.

      • ChildJobsInState — (map<Integer>)

        This returns the statistics of the included child (nested) copy jobs.

      • ResourceName — (String)

        The non-unique name of the resource that belongs to the specified backup.

      • MessageCategory — (String)

        This parameter is the job count for the specified message category.

        Example strings may include AccessDenied, SUCCESS, AGGREGATE_ALL, and InvalidParameters. See Monitoring for a list of MessageCategory strings.

        The the value ANY returns count of all message categories.

        AGGREGATE_ALL aggregates job counts for all message categories and returns the sum

Returns:

• (AWS.Request) —

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

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>)

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

      • ControlName — required — (String)

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

      • ControlInputParameters — (Array<map>)

        The name/value 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>)

          The ID of the only Amazon Web Services resource that you want your control scope to contain.

        • ComplianceResourceTypes — (Array<String>)

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

        • Tags — (map<String>)

          The tag key-value pair applied to those Amazon Web Services resources that you want to trigger an evaluation for a rule. A maximum of one key-value pair can be provided. The tag value is optional, but it cannot be an empty string if you are creating or editing a framework from the console (though the value can be an empty string when included in a CloudFormation template).

          The structure to assign a tag is: [{"Key":"string","Value":"string"}].

    • CreationTime — (Date)

      The date and time that a framework is created, in ISO 8601 representation. The value of CreationTime is accurate to milliseconds. For example, 2020-07-10T15:00:00.000-08:00 represents the 10th of July 2020 at 3:00 PM 8 hours behind UTC.

    • 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.

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.

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.

    • ResourceName — (String)

      The name of the resource that belongs to the specified backup.

    • LastBackupVaultArn — (String)

      The ARN (Amazon Resource Name) of the backup vault that contains the most recent backup recovery point.

    • LastRecoveryPointArn — (String)

      The ARN (Amazon Resource Name) of the most recent recovery point.

    • LatestRestoreExecutionTimeMinutes — (Integer)

      The time, in minutes, that the most recent restore job took to complete.

    • LatestRestoreJobCreationDate — (Date)

      The creation date of the most recent restore job.

    • LatestRestoreRecoveryPointCreationDate — (Date)

      The date the most recent recovery point was created.

Returns:

• (AWS.Request) —

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

var params = {
  BackupVaultName: 'STRING_VALUE', /* required */
  RecoveryPointArn: 'STRING_VALUE', /* required */
  BackupVaultAccountId: 'STRING_VALUE'
};
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.

  • 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.

  • BackupVaultAccountId — (String)

    The account ID of the specified backup vault.

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.

    • BackupVaultArn — (String)

      An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:backup-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:backup-vault:aBackupVault. 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.

      STOPPED status occurs on a continuous backup where a user has taken some action that causes the continuous backup to be disabled. This can be caused by the removal of permissions, turning off versioning, turning off events being sent to EventBridge, or disabling the EventBridge rules that are put in place by Backup. For recovery points of Amazon S3, Amazon RDS, and Amazon Aurora resources, this status occurs when the retention period of a continuous backup rule is changed.

      To resolve STOPPED status, ensure that all requested permissions are in place and that versioning is enabled on the S3 bucket. Once these conditions are met, the next instance of a backup rule running will result in a new continuous recovery point being created. The recovery points with STOPPED status do not need to be deleted.

      For SAP HANA on Amazon EC2 STOPPED status occurs due to user action, application misconfiguration, or backup failure. To ensure that future continuous backups succeed, refer to the recovery point status and check SAP HANA for details.

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

      A status message explaining the status of the recovery point.

    • 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 “retention” 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.

      Resource types that can transition to cold storage are listed in the Feature availability by resource table. Backup ignores this expression for other resource types.

      • MoveToColdStorageAfterDays — (Integer)

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

      • DeleteAfterDays — (Integer)

        The number of days after creation that a recovery point is deleted. This value must be at least 90 days after the number of days specified in MoveToColdStorageAfterDays.

      • OptInToArchiveForSupportedResources — (Boolean)

        If the value is true, your backup plan transitions supported resources to archive (cold) storage tier in accordance with your lifecycle settings.

    • 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.

    • ParentRecoveryPointArn — (String)

      This is an ARN that uniquely identifies a parent (composite) recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

    • CompositeMemberIdentifier — (String)

      The identifier of a resource within a composite group, such as nested (child) recovery point belonging to a composite (parent) stack. The ID is transferred from the logical ID within a stack.

    • IsParent — (Boolean)

      This returns the boolean value that a recovery point is a parent (composite) job.

    • ResourceName — (String)

      The name of the resource that belongs to the specified backup.

    • VaultType — (String)

      The type of vault in which the described recovery point is stored.

      Possible values include:
      • "BACKUP_VAULT"
      • "LOGICALLY_AIR_GAPPED_BACKUP_VAULT"

Returns:

• (AWS.Request) —

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

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>)

      The services along with the opt-in preferences in the Region.

    • ResourceTypeManagementPreference — (map<Boolean>)

      Returns whether Backup fully manages the backups for a resource type.

      For the benefits of full Backup management, see Full Backup management.

      For a list of resource types and whether each supports full Backup management, see the Feature availability by resource table.

      If "DynamoDB":false, you can enable full Backup management for DynamoDB backup by enabling Backup's advanced DynamoDB backup features.

Returns:

• (AWS.Request) —

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

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)

      The 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:

        RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | 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.

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:

        RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT

        If the report template is RESOURCE_COMPLIANCE_REPORT or CONTROL_COMPLIANCE_REPORT, this API resource also describes the report coverage by Amazon Web Services Regions and frameworks.

        • ReportTemplate — required — (String)

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

          RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT

        • FrameworkArns — (Array<String>)

          The Amazon Resource Names (ARNs) of the frameworks a report covers.

        • NumberOfFrameworks — (Integer)

          The number of frameworks a report covers.

        • Accounts — (Array<String>)

          These are the accounts to be included in the report.

          Use string value of ROOT to include all organizational units.

        • OrganizationUnits — (Array<String>)

          These are the Organizational Units to be included in the report.

        • Regions — (Array<String>)

          These are the Regions to be included in the report.

          Use the wildcard as the string value to include all Regions.

      • 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.

        • S3BucketName — required — (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>)

          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.

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)

      The Amazon Resource Name (ARN) of the resource that was created by the restore job.

      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.

    • RecoveryPointCreationDate — (Date)

      The creation date of the recovery point made by the specifed restore job.

    • CreatedBy — (map)

      Contains identifying information about the creation of a restore job.

      • RestoreTestingPlanArn — (String)

        An Amazon Resource Name (ARN) that uniquely identifies a restore testing plan.

    • ValidationStatus — (String)

      The status of validation run on the indicated restore job.

      Possible values include:
      • "FAILED"
      • "SUCCESSFUL"
      • "TIMED_OUT"
      • "VALIDATING"
    • ValidationStatusMessage — (String)

      The status message.

    • DeletionStatus — (String)

      The status of the data generated by the restore test.

      Possible values include:
      • "DELETING"
      • "FAILED"
      • "SUCCESSFUL"
    • DeletionStatusMessage — (String)

      This describes the restore job deletion status.

Returns:

• (AWS.Request) —

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

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.

var params = {
  BackupVaultName: 'STRING_VALUE', /* required */
  RecoveryPointArn: 'STRING_VALUE' /* required */
};
backup.disassociateRecoveryPointFromParent(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 the child (nested) recovery point is 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.

  • RecoveryPointArn — (String)

    The Amazon Resource Name (ARN) that uniquely identifies the child (nested) 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.

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.

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.

      • BackupPlanName — required — (String)

        The display name of a backup plan. Must contain only alphanumeric or '-_.' special characters.

        If this is set in the console, it can contain 1 to 50 characters; if this is set through CLI or API, it can contain 1 to 200 characters.

      • Rules — required — (Array<map>)

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

        • RuleName — required — (String)

          A display name for a backup rule. Must contain 1 to 50 alphanumeric or '-_.' characters.

        • TargetBackupVaultName — required — (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.

        • ScheduleExpression — (String)

          A cron expression in UTC specifying when Backup initiates a backup job. For more information about Amazon Web Services cron expressions, see Schedule Expressions for Rules in the Amazon CloudWatch Events User Guide.. Two examples of Amazon Web Services cron expressions are 15 * ? * * * (take a backup every hour at 15 minutes past the hour) and 0 12 * * ? * (take a backup every day at 12 noon UTC). For a table of examples, click the preceding link and scroll down the page.

        • 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. If this value is included, it must be at least 60 minutes to avoid errors.

          During the start window, the backup job status remains in CREATED status until it has successfully begun or until the start window time has run out. If within the start window time Backup receives an error that allows the job to be retried, Backup will automatically retry to begin the job at least every 10 minutes until the backup successfully begins (the job status changes to RUNNING) or until the job status changes to EXPIRED (which is expected to occur when the start window time is over).

        • 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 “retention” 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.

          Resource types that can transition to cold storage are listed in the Feature availability by resource table. Backup ignores this expression for other resource types.

          • MoveToColdStorageAfterDays — (Integer)

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

          • DeleteAfterDays — (Integer)

            The number of days after creation that a recovery point is deleted. This value must be at least 90 days after the number of days specified in MoveToColdStorageAfterDays.

          • OptInToArchiveForSupportedResources — (Boolean)

            If the value is true, your backup plan transitions supported resources to archive (cold) storage tier in accordance with your lifecycle settings.

        • RecoveryPointTags — (map<String>)

          The tags 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)

            Specifies the time period, 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 retention setting must be 90 days greater than the transition to cold after days setting. The transition to cold after days setting can't be changed after a backup has been transitioned to cold.

            Resource types that can transition to cold storage are listed in the Feature availability by resource table. Backup ignores this expression for other resource types.

            To remove the existing lifecycle and retention periods and keep your recovery points indefinitely, specify -1 for MoveToColdStorageAfterDays and DeleteAfterDays.

            • MoveToColdStorageAfterDays — (Integer)

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

            • DeleteAfterDays — (Integer)

              The number of days after creation that a recovery point is deleted. This value must be at least 90 days after the number of days specified in MoveToColdStorageAfterDays.

            • OptInToArchiveForSupportedResources — (Boolean)

              If the value is true, your backup plan transitions supported resources to archive (cold) storage tier in accordance with your lifecycle settings.

          • DestinationBackupVaultArn — required — (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:backup-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.

        • ScheduleExpressionTimezone — (String)

          The timezone in which the schedule expression is set. By default, ScheduleExpressions are in UTC. You can modify this to a specified timezone.

      • 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 this backup plan was run. 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.

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.

      • BackupPlanName — required — (String)

        The display name of a backup plan. Must contain only alphanumeric or '-_.' special characters.

        If this is set in the console, it can contain 1 to 50 characters; if this is set through CLI or API, it can contain 1 to 200 characters.

      • Rules — required — (Array<map>)

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

        • RuleName — required — (String)

          A display name for a backup rule. Must contain 1 to 50 alphanumeric or '-_.' characters.

        • TargetBackupVaultName — required — (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.

        • ScheduleExpression — (String)

          A cron expression in UTC specifying when Backup initiates a backup job. For more information about Amazon Web Services cron expressions, see Schedule Expressions for Rules in the Amazon CloudWatch Events User Guide.. Two examples of Amazon Web Services cron expressions are 15 * ? * * * (take a backup every hour at 15 minutes past the hour) and 0 12 * * ? * (take a backup every day at 12 noon UTC). For a table of examples, click the preceding link and scroll down the page.

        • 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. If this value is included, it must be at least 60 minutes to avoid errors.

          During the start window, the backup job status remains in CREATED status until it has successfully begun or until the start window time has run out. If within the start window time Backup receives an error that allows the job to be retried, Backup will automatically retry to begin the job at least every 10 minutes until the backup successfully begins (the job status changes to RUNNING) or until the job status changes to EXPIRED (which is expected to occur when the start window time is over).

        • 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 “retention” 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.

          Resource types that can transition to cold storage are listed in the Feature availability by resource table. Backup ignores this expression for other resource types.

          • MoveToColdStorageAfterDays — (Integer)

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

          • DeleteAfterDays — (Integer)

            The number of days after creation that a recovery point is deleted. This value must be at least 90 days after the number of days specified in MoveToColdStorageAfterDays.

          • OptInToArchiveForSupportedResources — (Boolean)

            If the value is true, your backup plan transitions supported resources to archive (cold) storage tier in accordance with your lifecycle settings.

        • RecoveryPointTags — (map<String>)

          The tags 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)

            Specifies the time period, 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 retention setting must be 90 days greater than the transition to cold after days setting. The transition to cold after days setting can't be changed after a backup has been transitioned to cold.

            Resource types that can transition to cold storage are listed in the Feature availability by resource table. Backup ignores this expression for other resource types.

            To remove the existing lifecycle and retention periods and keep your recovery points indefinitely, specify -1 for MoveToColdStorageAfterDays and DeleteAfterDays.

            • MoveToColdStorageAfterDays — (Integer)

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

            • DeleteAfterDays — (Integer)

              The number of days after creation that a recovery point is deleted. This value must be at least 90 days after the number of days specified in MoveToColdStorageAfterDays.

            • OptInToArchiveForSupportedResources — (Boolean)

              If the value is true, your backup plan transitions supported resources to archive (cold) storage tier in accordance with your lifecycle settings.

          • DestinationBackupVaultArn — required — (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:backup-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.

        • ScheduleExpressionTimezone — (String)

          The timezone in which the schedule expression is set. By default, ScheduleExpressions are in UTC. You can modify this to a specified timezone.

      • 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.

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.

      • BackupPlanName — required — (String)

        The display name of a backup plan. Must contain only alphanumeric or '-_.' special characters.

        If this is set in the console, it can contain 1 to 50 characters; if this is set through CLI or API, it can contain 1 to 200 characters.

      • Rules — required — (Array<map>)

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

        • RuleName — required — (String)

          A display name for a backup rule. Must contain 1 to 50 alphanumeric or '-_.' characters.

        • TargetBackupVaultName — required — (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.

        • ScheduleExpression — (String)

          A cron expression in UTC specifying when Backup initiates a backup job. For more information about Amazon Web Services cron expressions, see Schedule Expressions for Rules in the Amazon CloudWatch Events User Guide.. Two examples of Amazon Web Services cron expressions are 15 * ? * * * (take a backup every hour at 15 minutes past the hour) and 0 12 * * ? * (take a backup every day at 12 noon UTC). For a table of examples, click the preceding link and scroll down the page.

        • 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. If this value is included, it must be at least 60 minutes to avoid errors.

          During the start window, the backup job status remains in CREATED status until it has successfully begun or until the start window time has run out. If within the start window time Backup receives an error that allows the job to be retried, Backup will automatically retry to begin the job at least every 10 minutes until the backup successfully begins (the job status changes to RUNNING) or until the job status changes to EXPIRED (which is expected to occur when the start window time is over).

        • 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 “retention” 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.

          Resource types that can transition to cold storage are listed in the Feature availability by resource table. Backup ignores this expression for other resource types.

          • MoveToColdStorageAfterDays — (Integer)

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

          • DeleteAfterDays — (Integer)

            The number of days after creation that a recovery point is deleted. This value must be at least 90 days after the number of days specified in MoveToColdStorageAfterDays.

          • OptInToArchiveForSupportedResources — (Boolean)

            If the value is true, your backup plan transitions supported resources to archive (cold) storage tier in accordance with your lifecycle settings.

        • RecoveryPointTags — (map<String>)

          The tags 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)

            Specifies the time period, 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 retention setting must be 90 days greater than the transition to cold after days setting. The transition to cold after days setting can't be changed after a backup has been transitioned to cold.

            Resource types that can transition to cold storage are listed in the Feature availability by resource table. Backup ignores this expression for other resource types.

            To remove the existing lifecycle and retention periods and keep your recovery points indefinitely, specify -1 for MoveToColdStorageAfterDays and DeleteAfterDays.

            • MoveToColdStorageAfterDays — (Integer)

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

            • DeleteAfterDays — (Integer)

              The number of days after creation that a recovery point is deleted. This value must be at least 90 days after the number of days specified in MoveToColdStorageAfterDays.

            • OptInToArchiveForSupportedResources — (Boolean)

              If the value is true, your backup plan transitions supported resources to archive (cold) storage tier in accordance with your lifecycle settings.

          • DestinationBackupVaultArn — required — (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:backup-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.

        • ScheduleExpressionTimezone — (String)

          The timezone in which the schedule expression is set. By default, ScheduleExpressions are in UTC. You can modify this to a specified timezone.

      • 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.

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.

      • SelectionName — required — (String)

        The display name of a resource selection document. Must contain 1 to 50 alphanumeric or '-_.' characters.

      • IamRoleArn — required — (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>)

        The Amazon Resource Names (ARNs) of the resources to assign to a backup plan. The maximum number of ARNs is 500 without wildcards, or 30 ARNs with wildcards.

        If you need to assign many resources to a backup plan, consider a different resource selection strategy, such as assigning all resources of a resource type or refining your resource selection using tags.

        If you specify multiple ARNs, the resources much match any of the ARNs (OR logic).

      • ListOfTags — (Array<map>)

        The conditions that you define to assign resources to your backup plans using tags. For example, "StringEquals": { "ConditionKey": "backup", "ConditionValue": "daily"}.

        ListOfTags supports only StringEquals. Condition operators are case sensitive.

        If you specify multiple conditions, the resources much match any of the conditions (OR logic).

        • ConditionType — required — (String)

          An operation applied to a key-value pair used to assign resources to your backup plan. Condition only supports StringEquals. For more flexible assignment options, including StringLike and the ability to exclude resources from your backup plan, use Conditions (with an "s" on the end) for your BackupSelection .

          Possible values include:
          • "STRINGEQUALS"
        • ConditionKey — required — (String)

          The key in a key-value pair. For example, in the tag Department: Accounting, Department is the key.

        • ConditionValue — required — (String)

          The value in a key-value pair. For example, in the tag Department: Accounting, Accounting is the value.

      • NotResources — (Array<String>)

        The Amazon Resource Names (ARNs) of the resources to exclude from a backup plan. The maximum number of ARNs is 500 without wildcards, or 30 ARNs with wildcards.

        If you need to exclude many resources from a backup plan, consider a different resource selection strategy, such as assigning only one or a few resource types or refining your resource selection using tags.

      • Conditions — (map)

        The conditions that you define to assign resources to your backup plans using tags. For example, "StringEquals": { "ConditionKey": "aws:ResourceTag/backup", "ConditionValue": "daily" }.

        Conditions supports StringEquals, StringLike, StringNotEquals, and StringNotLike. Condition operators are case sensitive.

        If you specify multiple conditions, the resources much match all conditions (AND logic).

        • StringEquals — (Array<map>)

          Filters the values of your tagged resources for only those resources that you tagged with the same value. Also called "exact matching."

          • ConditionKey — (String)

            The key in a key-value pair. For example, in the tag Department: Accounting, Department is the key.

          • ConditionValue — (String)

            The value in a key-value pair. For example, in the tag Department: Accounting, Accounting is the value.

        • StringNotEquals — (Array<map>)

          Filters the values of your tagged resources for only those resources that you tagged that do not have the same value. Also called "negated matching."

          • ConditionKey — (String)

            The key in a key-value pair. For example, in the tag Department: Accounting, Department is the key.

          • ConditionValue — (String)

            The value in a key-value pair. For example, in the tag Department: Accounting, Accounting is the value.

        • StringLike — (Array<map>)

          Filters the values of your tagged resources for matching tag values with the use of a wildcard character () anywhere in the string. For example, "prod" or "rod" matches the tag value "production".

          • ConditionKey — (String)

            The key in a key-value pair. For example, in the tag Department: Accounting, Department is the key.

          • ConditionValue — (String)

            The value in a key-value pair. For example, in the tag Department: Accounting, Accounting is the value.

        • StringNotLike — (Array<map>)

          Filters the values of your tagged resources for non-matching tag values with the use of a wildcard character (*) anywhere in the string.

          • ConditionKey — (String)

            The key in a key-value pair. For example, in the tag Department: Accounting, Department is the key.

          • ConditionValue — (String)

            The value in a key-value pair. For example, in the tag 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.

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.

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.

    • BackupVaultArn — (String)

      An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:backup-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.

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.

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.

    • BackupVaultArn — (String)

      An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:backup-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.

var params = {
  LegalHoldId: 'STRING_VALUE' /* required */
};
backup.getLegalHold(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: {}) —
  • LegalHoldId — (String)

    The ID of the legal hold.

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:

    • Title — (String)

      The title of the legal hold.

    • Status — (String)

      The status of the legal hold.

      Possible values include:
      • "CREATING"
      • "ACTIVE"
      • "CANCELING"
      • "CANCELED"
    • Description — (String)

      The description of the legal hold.

    • CancelDescription — (String)

      The reason for removing the legal hold.

    • LegalHoldId — (String)

      The ID of the legal hold.

    • LegalHoldArn — (String)

      The framework ARN for the specified legal hold. The format of the ARN depends on the resource type.

    • CreationDate — (Date)

      The time when the legal hold was created.

    • CancellationDate — (Date)

      The time when the legal hold was cancelled.

    • RetainRecordUntil — (Date)

      The date and time until which the legal hold record is retained.

    • RecoveryPointSelection — (map)

      The criteria to assign a set of resources, such as resource types or backup vaults.

      • VaultNames — (Array<String>)

        These are the names of the vaults in which the selected recovery points are contained.

      • ResourceIdentifiers — (Array<String>)

        These are the resources included in the resource selection (including type of resources and vaults).

      • DateRange — (map)

        This is a resource filter containing FromDate: DateTime and ToDate: DateTime. Both values are required. Future DateTime values are not permitted.

        The date and time are in Unix format and Coordinated Universal Time (UTC), and it is accurate to milliseconds ((milliseconds are optional). For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

        • FromDate — required — (Date)

          This value is the beginning date, inclusive.

          The date and time are in Unix format and Coordinated Universal Time (UTC), and it is accurate to milliseconds (milliseconds are optional).

        • ToDate — required — (Date)

          This value is the end date, inclusive.

          The date and time are in Unix format and Coordinated Universal Time (UTC), and it is accurate to milliseconds (milliseconds are optional).

Returns:

• (AWS.Request) —

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