5.0.0 • Published 5 years ago

@datafire/amazonaws_backup v5.0.0

Weekly downloads
1
License
MIT
Repository
github
Last release
5 years ago

@datafire/amazonaws_backup

Client library for AWS Backup

Installation and Usage

npm install --save @datafire/amazonaws_backup
let amazonaws_backup = require('@datafire/amazonaws_backup').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

.then(data => {
  console.log(data);
});

Description

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

Actions

DescribeRegionSettings

amazonaws_backup.DescribeRegionSettings({}, context)

Input

  • input object

Output

UpdateRegionSettings

amazonaws_backup.UpdateRegionSettings({}, context)

Input

  • input object
    • ResourceTypeOptInPreference object: Updates the list of services along with the opt-in preferences for the Region.

Output

Output schema unknown

StartBackupJob

amazonaws_backup.StartBackupJob({
  "BackupVaultName": "",
  "ResourceArn": "",
  "IamRoleArn": ""
}, context)

Input

  • input object
    • BackupOptions object: 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 WindowsVSS backup option and create a VSS Windows backup. Set to “WindowsVSS”:”disabled” to create a regular backup. The WindowsVSS option is not enabled by default.
    • BackupVaultName 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 AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.
    • CompleteWindowMinutes integer: A value in minutes after a backup job is successfully started before it must be completed or it will be canceled by AWS Backup. This value is optional.
    • IamRoleArn required string: Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.
    • IdempotencyToken string: A customer chosen string that can be used to distinguish between calls to StartBackupJob.
    • Lifecycle object: Contains an array of Transition objects specifying how long in days before a recovery point transitions to cold storage or is deleted. Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, on the console, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.
      • DeleteAfterDays
      • MoveToColdStorageAfterDays
    • RecoveryPointTags object: To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair.
    • ResourceArn required string: An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
    • 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.

Output

ListBackupJobs

amazonaws_backup.ListBackupJobs({}, context)

Input

  • input object
    • nextToken string
    • maxResults integer
    • resourceArn string
    • state string
    • backupVaultName string
    • createdBefore string
    • createdAfter string
    • resourceType string
    • accountId string
    • MaxResults string
    • NextToken string

Output

DescribeBackupJob

amazonaws_backup.DescribeBackupJob({
  "backupJobId": ""
}, context)

Input

  • input object
    • backupJobId required string

Output

StopBackupJob

amazonaws_backup.StopBackupJob({
  "backupJobId": ""
}, context)

Input

  • input object
    • backupJobId required string

Output

Output schema unknown

ListBackupVaults

amazonaws_backup.ListBackupVaults({}, context)

Input

  • input object
    • nextToken string
    • maxResults integer
    • MaxResults string
    • NextToken string

Output

DeleteBackupVault

amazonaws_backup.DeleteBackupVault({
  "backupVaultName": ""
}, context)

Input

  • input object
    • backupVaultName required string

Output

Output schema unknown

DescribeBackupVault

amazonaws_backup.DescribeBackupVault({
  "backupVaultName": ""
}, context)

Input

  • input object
    • backupVaultName required string

Output

CreateBackupVault

amazonaws_backup.CreateBackupVault({
  "backupVaultName": ""
}, context)

Input

  • input object
    • backupVaultName required string
    • BackupVaultTags object: Metadata that you can assign to help organize the resources that you create. Each tag is a key-value pair.
    • CreatorRequestId string: A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice.
    • 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.

Output

DeleteBackupVaultAccessPolicy

amazonaws_backup.DeleteBackupVaultAccessPolicy({
  "backupVaultName": ""
}, context)

Input

  • input object
    • backupVaultName required string

Output

Output schema unknown

GetBackupVaultAccessPolicy

amazonaws_backup.GetBackupVaultAccessPolicy({
  "backupVaultName": ""
}, context)

Input

  • input object
    • backupVaultName required string

Output

PutBackupVaultAccessPolicy

amazonaws_backup.PutBackupVaultAccessPolicy({
  "backupVaultName": ""
}, context)

Input

  • input object
    • backupVaultName required string
    • Policy string: The backup vault access policy document in JSON format.

Output

Output schema unknown

DeleteBackupVaultNotifications

amazonaws_backup.DeleteBackupVaultNotifications({
  "backupVaultName": ""
}, context)

Input

  • input object
    • backupVaultName required string

Output

Output schema unknown

GetBackupVaultNotifications

amazonaws_backup.GetBackupVaultNotifications({
  "backupVaultName": ""
}, context)

Input

  • input object
    • backupVaultName required string

Output

PutBackupVaultNotifications

amazonaws_backup.PutBackupVaultNotifications({
  "backupVaultName": "",
  "SNSTopicArn": "",
  "BackupVaultEvents": []
}, context)

Input

  • input object
    • backupVaultName required string
    • BackupVaultEvents required array: An array of events that indicate the status of jobs to back up resources to the backup vault.
    • SNSTopicArn required string: The Amazon Resource Name (ARN) that specifies the topic for a backup vault’s events; for example, arn:aws:sns:us-west-2:111122223333:MyVaultTopic.

Output

Output schema unknown

ListRecoveryPointsByBackupVault

amazonaws_backup.ListRecoveryPointsByBackupVault({
  "backupVaultName": ""
}, context)

Input

  • input object
    • backupVaultName required string
    • nextToken string
    • maxResults integer
    • resourceArn string
    • resourceType string
    • backupPlanId string
    • createdBefore string
    • createdAfter string
    • MaxResults string
    • NextToken string

Output

DeleteRecoveryPoint

amazonaws_backup.DeleteRecoveryPoint({
  "backupVaultName": "",
  "recoveryPointArn": ""
}, context)

Input

  • input object
    • backupVaultName required string
    • recoveryPointArn required string

Output

Output schema unknown

DescribeRecoveryPoint

amazonaws_backup.DescribeRecoveryPoint({
  "backupVaultName": "",
  "recoveryPointArn": ""
}, context)

Input

  • input object
    • backupVaultName required string
    • recoveryPointArn required string

Output

UpdateRecoveryPointLifecycle

amazonaws_backup.UpdateRecoveryPointLifecycle({
  "backupVaultName": "",
  "recoveryPointArn": ""
}, context)

Input

  • input object
    • backupVaultName required string
    • recoveryPointArn required string
    • Lifecycle object: Contains an array of Transition objects specifying how long in days before a recovery point transitions to cold storage or is deleted. Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, on the console, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.
      • DeleteAfterDays
      • MoveToColdStorageAfterDays

Output

GetRecoveryPointRestoreMetadata

amazonaws_backup.GetRecoveryPointRestoreMetadata({
  "backupVaultName": "",
  "recoveryPointArn": ""
}, context)

Input

  • input object
    • backupVaultName required string
    • recoveryPointArn required string

Output

ListBackupPlans

amazonaws_backup.ListBackupPlans({}, context)

Input

  • input object
    • nextToken string
    • maxResults integer
    • includeDeleted boolean
    • MaxResults string
    • NextToken string

Output

CreateBackupPlan

amazonaws_backup.CreateBackupPlan({
  "BackupPlan": {}
}, context)

Input

  • input object
    • BackupPlan required object: Contains an optional backup plan display name and an array of BackupRule objects, each of which specifies a backup rule. Each rule in a backup plan is a separate scheduled task and can back up a different selection of AWS resources.
    • BackupPlanTags object: To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair. The specified tags are assigned to all backups created with this plan.
    • CreatorRequestId string: Identifies the request and allows failed requests to be retried without the risk of running the operation twice. If the request includes a CreatorRequestId that matches an existing backup plan, that plan is returned. This parameter is optional.

Output

DeleteBackupPlan

amazonaws_backup.DeleteBackupPlan({
  "backupPlanId": ""
}, context)

Input

  • input object
    • backupPlanId required string

Output

UpdateBackupPlan

amazonaws_backup.UpdateBackupPlan({
  "backupPlanId": "",
  "BackupPlan": {}
}, context)

Input

  • input object
    • backupPlanId required string
    • BackupPlan required object: Contains an optional backup plan display name and an array of BackupRule objects, each of which specifies a backup rule. Each rule in a backup plan is a separate scheduled task and can back up a different selection of AWS resources.

Output

GetBackupPlan

amazonaws_backup.GetBackupPlan({
  "backupPlanId": ""
}, context)

Input

  • input object
    • backupPlanId required string
    • versionId string

Output

ListBackupSelections

amazonaws_backup.ListBackupSelections({
  "backupPlanId": ""
}, context)

Input

  • input object
    • backupPlanId required string
    • nextToken string
    • maxResults integer
    • MaxResults string
    • NextToken string

Output

CreateBackupSelection

amazonaws_backup.CreateBackupSelection({
  "backupPlanId": "",
  "BackupSelection": {}
}, context)

Input

  • input object
    • backupPlanId required string
    • BackupSelection required object: Used to specify a set of resources to a backup plan.
      • IamRoleArn
      • ListOfTags
      • Resources
      • SelectionName
    • CreatorRequestId string: A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice.

Output

DeleteBackupSelection

amazonaws_backup.DeleteBackupSelection({
  "backupPlanId": "",
  "selectionId": ""
}, context)

Input

  • input object
    • backupPlanId required string
    • selectionId required string

Output

Output schema unknown

GetBackupSelection

amazonaws_backup.GetBackupSelection({
  "backupPlanId": "",
  "selectionId": ""
}, context)

Input

  • input object
    • backupPlanId required string
    • selectionId required string

Output

ExportBackupPlanTemplate

amazonaws_backup.ExportBackupPlanTemplate({
  "backupPlanId": ""
}, context)

Input

  • input object
    • backupPlanId required string

Output

ListBackupPlanVersions

amazonaws_backup.ListBackupPlanVersions({
  "backupPlanId": ""
}, context)

Input

  • input object
    • backupPlanId required string
    • nextToken string
    • maxResults integer
    • MaxResults string
    • NextToken string

Output

GetBackupPlanFromJSON

amazonaws_backup.GetBackupPlanFromJSON({
  "BackupPlanTemplateJson": ""
}, context)

Input

  • input object
    • BackupPlanTemplateJson required string: A customer-supplied backup plan document in JSON format.

Output

ListBackupPlanTemplates

amazonaws_backup.ListBackupPlanTemplates({}, context)

Input

  • input object
    • nextToken string
    • maxResults integer
    • MaxResults string
    • NextToken string

Output

GetBackupPlanFromTemplate

amazonaws_backup.GetBackupPlanFromTemplate({
  "templateId": ""
}, context)

Input

  • input object
    • templateId required string

Output

StartCopyJob

amazonaws_backup.StartCopyJob({
  "RecoveryPointArn": "",
  "SourceBackupVaultName": "",
  "DestinationBackupVaultArn": "",
  "IamRoleArn": ""
}, context)

Input

  • input object
    • DestinationBackupVaultArn required string: An Amazon Resource Name (ARN) that uniquely identifies a destination backup vault to copy to; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
    • IamRoleArn required string: Specifies the IAM role ARN used to copy the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.
    • IdempotencyToken string: A customer chosen string that can be used to distinguish between calls to StartCopyJob.
    • Lifecycle object: Contains an array of Transition objects specifying how long in days before a recovery point transitions to cold storage or is deleted. Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, on the console, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.
      • DeleteAfterDays
      • MoveToColdStorageAfterDays
    • RecoveryPointArn required string: An ARN that uniquely identifies a recovery point to use for the copy job; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
    • SourceBackupVaultName required string: The name of a logical source container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.

Output

ListCopyJobs

amazonaws_backup.ListCopyJobs({}, context)

Input

  • input object
    • nextToken string
    • maxResults integer
    • resourceArn string
    • state string
    • createdBefore string
    • createdAfter string
    • resourceType string
    • destinationVaultArn string
    • accountId string
    • MaxResults string
    • NextToken string

Output

DescribeCopyJob

amazonaws_backup.DescribeCopyJob({
  "copyJobId": ""
}, context)

Input

  • input object
    • copyJobId required string

Output

DescribeGlobalSettings

amazonaws_backup.DescribeGlobalSettings({}, context)

Input

  • input object

Output

UpdateGlobalSettings

amazonaws_backup.UpdateGlobalSettings({}, context)

Input

  • input object
    • GlobalSettings object: A list of resources along with the opt-in preferences for the account.

Output

Output schema unknown

ListProtectedResources

amazonaws_backup.ListProtectedResources({}, context)

Input

  • input object
    • nextToken string
    • maxResults integer
    • MaxResults string
    • NextToken string

Output

DescribeProtectedResource

amazonaws_backup.DescribeProtectedResource({
  "resourceArn": ""
}, context)

Input

  • input object
    • resourceArn required string

Output

ListRecoveryPointsByResource

amazonaws_backup.ListRecoveryPointsByResource({
  "resourceArn": ""
}, context)

Input

  • input object
    • resourceArn required string
    • nextToken string
    • maxResults integer
    • MaxResults string
    • NextToken string

Output

StartRestoreJob

amazonaws_backup.StartRestoreJob({
  "RecoveryPointArn": "",
  "Metadata": {},
  "IamRoleArn": ""
}, context)

Input

  • input object
    • IamRoleArn required string: The Amazon Resource Name (ARN) of the IAM role that AWS Backup uses to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.
    • IdempotencyToken string: A customer chosen string that can be used to distinguish between calls to StartRestoreJob.
    • Metadata required object: A set of metadata key-value pairs. Contains information, such as a resource name, required to restore a recovery point. You can get configuration metadata about a resource at the time it was backed up by calling GetRecoveryPointRestoreMetadata. However, values in addition to those provided by GetRecoveryPointRestoreMetadata might be required to restore a resource. For example, you might need to provide a new resource name if the original already exists. You need to specify specific metadata to restore an Amazon Elastic File System (Amazon EFS) instance: file-system-id: The ID of the Amazon EFS file system that is backed up by AWS Backup. Returned in GetRecoveryPointRestoreMetadata. Encrypted: A Boolean value that, if true, specifies that the file system is encrypted. If KmsKeyId is specified, Encrypted must be set to true. KmsKeyId: Specifies the AWS KMS key that is used to encrypt the restored file system. You can specify a key from another AWS account provided that key it is properly shared with your account via AWS KMS. PerformanceMode: Specifies the throughput mode of the file system. CreationToken: A user-supplied value that ensures the uniqueness (idempotency) of the request. newFileSystem: A Boolean value that, if true, specifies that the recovery point is restored to a new Amazon EFS file system. ItemsToRestore : A serialized list of up to five strings where each string is a file path. Use ItemsToRestore to restore specific files or directories rather than the entire file system. This parameter is optional.
    • RecoveryPointArn required 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.
    • ResourceType string: Starts a job to restore a recovery point for one of the following resources: DynamoDB for Amazon DynamoDB EBS for Amazon Elastic Block Store EC2 for Amazon Elastic Compute Cloud EFS for Amazon Elastic File System RDS for Amazon Relational Database Service Storage Gateway for AWS Storage Gateway

Output

ListRestoreJobs

amazonaws_backup.ListRestoreJobs({}, context)

Input

  • input object
    • nextToken string
    • maxResults integer
    • accountId string
    • createdBefore string
    • createdAfter string
    • status string
    • MaxResults string
    • NextToken string

Output

DescribeRestoreJob

amazonaws_backup.DescribeRestoreJob({
  "restoreJobId": ""
}, context)

Input

  • input object
    • restoreJobId required string

Output

GetSupportedResourceTypes

amazonaws_backup.GetSupportedResourceTypes({}, context)

Input

  • input object

Output

TagResource

amazonaws_backup.TagResource({
  "resourceArn": "",
  "Tags": {}
}, context)

Input

  • input object
    • resourceArn required string
    • Tags required object: Key-value pairs that are used to help organize your resources. You can assign your own metadata to the resources you create.

Output

Output schema unknown

ListTags

amazonaws_backup.ListTags({
  "resourceArn": ""
}, context)

Input

  • input object
    • resourceArn required string
    • nextToken string
    • maxResults integer
    • MaxResults string
    • NextToken string

Output

UntagResource

amazonaws_backup.UntagResource({
  "resourceArn": "",
  "TagKeyList": []
}, context)

Input

  • input object
    • resourceArn required string
    • TagKeyList required array: A list of keys to identify which key-value tags to remove from a resource.

Output

Output schema unknown

Definitions

ARN

  • ARN string

AccountId

  • AccountId string

AdvancedBackupSetting

  • AdvancedBackupSetting object: A list of backup options for each resource type.
    • BackupOptions
    • ResourceType

AdvancedBackupSettings

AlreadyExistsException

BackupJob

  • BackupJob object: Contains detailed information about a backup job.
    • AccountId
    • BackupJobId
    • BackupOptions
    • BackupSizeInBytes
    • BackupType
    • BackupVaultArn
    • BackupVaultName
    • BytesTransferred
    • CompletionDate
    • CreatedBy
      • BackupPlanArn
      • BackupPlanId
      • BackupPlanVersion
      • BackupRuleId
    • CreationDate
    • ExpectedCompletionDate
    • IamRoleArn
    • PercentDone
    • RecoveryPointArn
    • ResourceArn
    • ResourceType
    • StartBy
    • State
    • StatusMessage

BackupJobState

  • BackupJobState string (values: CREATED, PENDING, RUNNING, ABORTING, ABORTED, COMPLETED, FAILED, EXPIRED)

BackupJobsList

BackupOptionKey

  • BackupOptionKey string

BackupOptionValue

  • BackupOptionValue string

BackupOptions

  • BackupOptions object

BackupPlan

  • BackupPlan object: Contains an optional backup plan display name and an array of BackupRule objects, each of which specifies a backup rule. Each rule in a backup plan is a separate scheduled task and can back up a different selection of AWS resources.

BackupPlanInput

  • BackupPlanInput object: Contains an optional backup plan display name and an array of BackupRule objects, each of which specifies a backup rule. Each rule in a backup plan is a separate scheduled task and can back up a different selection of AWS resources.

BackupPlanName

  • BackupPlanName string

BackupPlanTemplatesList

BackupPlanTemplatesListMember

  • BackupPlanTemplatesListMember object: An object specifying metadata associated with a backup plan template.
    • BackupPlanTemplateId
    • BackupPlanTemplateName

BackupPlanVersionsList

BackupPlansList

BackupPlansListMember

  • BackupPlansListMember object: Contains metadata about a backup plan.
    • AdvancedBackupSettings
    • BackupPlanArn
    • BackupPlanId
    • BackupPlanName
    • CreationDate
    • CreatorRequestId
    • DeletionDate
    • LastExecutionDate
    • VersionId

BackupRule

  • BackupRule object: Specifies a scheduled task used to back up a selection of resources.
    • CompletionWindowMinutes
    • CopyActions
    • Lifecycle
      • DeleteAfterDays
      • MoveToColdStorageAfterDays
    • RecoveryPointTags
    • RuleId
    • RuleName required
    • ScheduleExpression
    • StartWindowMinutes
    • TargetBackupVaultName required

BackupRuleInput

  • BackupRuleInput object: Specifies a scheduled task used to back up a selection of resources.
    • CompletionWindowMinutes
    • CopyActions
    • Lifecycle
      • DeleteAfterDays
      • MoveToColdStorageAfterDays
    • RecoveryPointTags
    • RuleName required
    • ScheduleExpression
    • StartWindowMinutes
    • TargetBackupVaultName required

BackupRuleName

  • BackupRuleName string

BackupRules

BackupRulesInput

BackupSelection

  • BackupSelection object: Used to specify a set of resources to a backup plan.
    • IamRoleArn required
    • ListOfTags
    • Resources
    • SelectionName required

BackupSelectionName

  • BackupSelectionName string

BackupSelectionsList

BackupSelectionsListMember

  • BackupSelectionsListMember object: Contains metadata about a BackupSelection object.
    • BackupPlanId
    • CreationDate
    • CreatorRequestId
    • IamRoleArn
    • SelectionId
    • SelectionName

BackupVaultEvent

  • BackupVaultEvent string (values: BACKUP_JOB_STARTED, BACKUP_JOB_COMPLETED, BACKUP_JOB_SUCCESSFUL, BACKUP_JOB_FAILED, BACKUP_JOB_EXPIRED, RESTORE_JOB_STARTED, RESTORE_JOB_COMPLETED, RESTORE_JOB_SUCCESSFUL, RESTORE_JOB_FAILED, COPY_JOB_STARTED, COPY_JOB_SUCCESSFUL, COPY_JOB_FAILED, RECOVERY_POINT_MODIFIED, BACKUP_PLAN_CREATED, BACKUP_PLAN_MODIFIED)

BackupVaultEvents

BackupVaultList

BackupVaultListMember

  • BackupVaultListMember object: Contains metadata about a backup vault.
    • BackupVaultArn
    • BackupVaultName
    • CreationDate
    • CreatorRequestId
    • EncryptionKeyArn
    • NumberOfRecoveryPoints

BackupVaultName

  • BackupVaultName string

Boolean

  • Boolean boolean

CalculatedLifecycle

  • CalculatedLifecycle object: Contains DeleteAt and MoveToColdStorageAt timestamps, which are used to specify a lifecycle for a recovery point. The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup transitions and expires backups automatically according to the lifecycle that you define. Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.
    • DeleteAt
    • MoveToColdStorageAt

Condition

  • Condition object: Contains an array of triplets made up of a condition type (such as StringEquals), a key, and a value. Conditions are used to filter resources in a selection that is assigned to a backup plan.
    • ConditionKey required
    • ConditionType required
    • ConditionValue required

ConditionKey

  • ConditionKey string

ConditionType

  • ConditionType string (values: STRINGEQUALS)

ConditionValue

  • ConditionValue string

CopyAction

  • CopyAction object: The details of the copy operation.
    • DestinationBackupVaultArn required
    • Lifecycle Lifecycle

CopyActions

CopyJob

  • CopyJob object: Contains detailed information about a copy job.
    • AccountId
    • BackupSizeInBytes
    • CompletionDate
    • CopyJobId
    • CreatedBy RecoveryPointCreator
    • CreationDate
    • DestinationBackupVaultArn
    • DestinationRecoveryPointArn
    • IamRoleArn
    • ResourceArn
    • ResourceType
    • SourceBackupVaultArn
    • SourceRecoveryPointArn
    • State
    • StatusMessage

CopyJobState

  • CopyJobState string (values: CREATED, RUNNING, COMPLETED, FAILED)

CopyJobsList

CreateBackupPlanInput

  • CreateBackupPlanInput object

CreateBackupPlanOutput

  • CreateBackupPlanOutput object

CreateBackupSelectionInput

  • CreateBackupSelectionInput object
    • BackupSelection required
      • IamRoleArn required
      • ListOfTags
      • Resources
      • SelectionName required
    • CreatorRequestId

CreateBackupSelectionOutput

  • CreateBackupSelectionOutput object
    • BackupPlanId
    • CreationDate
    • SelectionId

CreateBackupVaultInput

  • CreateBackupVaultInput object
    • BackupVaultTags
    • CreatorRequestId
    • EncryptionKeyArn

CreateBackupVaultOutput

  • CreateBackupVaultOutput object
    • BackupVaultArn
    • BackupVaultName
    • CreationDate

CronExpression

  • CronExpression string

DeleteBackupPlanInput

  • DeleteBackupPlanInput object

DeleteBackupPlanOutput

  • DeleteBackupPlanOutput object
    • BackupPlanArn
    • BackupPlanId
    • DeletionDate
    • VersionId

DeleteBackupSelectionInput

  • DeleteBackupSelectionInput object

DeleteBackupVaultAccessPolicyInput

  • DeleteBackupVaultAccessPolicyInput object

DeleteBackupVaultInput

  • DeleteBackupVaultInput object

DeleteBackupVaultNotificationsInput

  • DeleteBackupVaultNotificationsInput object

DeleteRecoveryPointInput

  • DeleteRecoveryPointInput object

DependencyFailureException

DescribeBackupJobInput

  • DescribeBackupJobInput object

DescribeBackupJobOutput

  • DescribeBackupJobOutput object
    • AccountId
    • BackupJobId
    • BackupOptions
    • BackupSizeInBytes
    • BackupType
    • BackupVaultArn
    • BackupVaultName
    • BytesTransferred
    • CompletionDate
    • CreatedBy
      • BackupPlanArn
      • BackupPlanId
      • BackupPlanVersion
      • BackupRuleId
    • CreationDate
    • ExpectedCompletionDate
    • IamRoleArn
    • PercentDone
    • RecoveryPointArn
    • ResourceArn
    • ResourceType
    • StartBy
    • State
    • StatusMessage

DescribeBackupVaultInput

  • DescribeBackupVaultInput object

DescribeBackupVaultOutput

  • DescribeBackupVaultOutput object
    • BackupVaultArn
    • BackupVaultName
    • CreationDate
    • CreatorRequestId
    • EncryptionKeyArn
    • NumberOfRecoveryPoints

DescribeCopyJobInput

  • DescribeCopyJobInput object

DescribeCopyJobOutput

  • DescribeCopyJobOutput object
    • CopyJob
      • AccountId
      • BackupSizeInBytes
      • CompletionDate
      • CopyJobId
      • CreatedBy RecoveryPointCreator
      • CreationDate
      • DestinationBackupVaultArn
      • DestinationRecoveryPointArn
      • IamRoleArn
      • ResourceArn
      • ResourceType
      • SourceBackupVaultArn
      • SourceRecoveryPointArn
      • State
      • StatusMessage

DescribeGlobalSettingsInput

  • DescribeGlobalSettingsInput object

DescribeGlobalSettingsOutput

  • DescribeGlobalSettingsOutput object
    • GlobalSettings
    • LastUpdateTime

DescribeProtectedResourceInput

  • DescribeProtectedResourceInput object

DescribeProtectedResourceOutput

  • DescribeProtectedResourceOutput object
    • LastBackupTime
    • ResourceArn
    • ResourceType

DescribeRecoveryPointInput

  • DescribeRecoveryPointInput object

DescribeRecoveryPointOutput

  • DescribeRecoveryPointOutput object
    • BackupSizeInBytes
    • BackupVaultArn
    • BackupVaultName
    • CalculatedLifecycle
      • DeleteAt
      • MoveToColdStorageAt
    • CompletionDate
    • CreatedBy
      • BackupPlanArn
      • BackupPlanId
      • BackupPlanVersion
      • BackupRuleId
    • CreationDate
    • EncryptionKeyArn
    • IamRoleArn
    • IsEncrypted
    • LastRestoreTime
    • Lifecycle
      • DeleteAfterDays
      • MoveToColdStorageAfterDays
    • RecoveryPointArn
    • ResourceArn
    • ResourceType
    • SourceBackupVaultArn
    • Status
    • StorageClass

DescribeRegionSettingsInput

  • DescribeRegionSettingsInput object

DescribeRegionSettingsOutput

  • DescribeRegionSettingsOutput object
    • ResourceTypeOptInPreference

DescribeRestoreJobInput

  • DescribeRestoreJobInput object

DescribeRestoreJobOutput

  • DescribeRestoreJobOutput object
    • AccountId
    • BackupSizeInBytes
    • CompletionDate
    • CreatedResourceArn
    • CreationDate
    • ExpectedCompletionTimeMinutes
    • IamRoleArn
    • PercentDone
    • RecoveryPointArn
    • ResourceType
    • RestoreJobId
    • Status
    • StatusMessage

ExportBackupPlanTemplateInput

  • ExportBackupPlanTemplateInput object

ExportBackupPlanTemplateOutput

  • ExportBackupPlanTemplateOutput object
    • BackupPlanTemplateJson

GetBackupPlanFromJSONInput

  • GetBackupPlanFromJSONInput object
    • BackupPlanTemplateJson required

GetBackupPlanFromJSONOutput

GetBackupPlanFromTemplateInput

  • GetBackupPlanFromTemplateInput object

GetBackupPlanFromTemplateOutput

  • GetBackupPlanFromTemplateOutput object

GetBackupPlanInput

  • GetBackupPlanInput object

GetBackupPlanOutput

  • GetBackupPlanOutput object

GetBackupSelectionInput

  • GetBackupSelectionInput object

GetBackupSelectionOutput

  • GetBackupSelectionOutput object
    • BackupPlanId
    • BackupSelection
      • IamRoleArn required
      • ListOfTags
      • Resources
      • SelectionName required
    • CreationDate
    • CreatorRequestId
    • SelectionId

GetBackupVaultAccessPolicyInput

  • GetBackupVaultAccessPolicyInput object

GetBackupVaultAccessPolicyOutput

  • GetBackupVaultAccessPolicyOutput object
    • BackupVaultArn
    • BackupVaultName
    • Policy

GetBackupVaultNotificationsInput

  • GetBackupVaultNotificationsInput object

GetBackupVaultNotificationsOutput

  • GetBackupVaultNotificationsOutput object

GetRecoveryPointRestoreMetadataInput

  • GetRecoveryPointRestoreMetadataInput object

GetRecoveryPointRestoreMetadataOutput

  • GetRecoveryPointRestoreMetadataOutput object
    • BackupVaultArn
    • RecoveryPointArn
    • RestoreMetadata

GetSupportedResourceTypesOutput

  • GetSupportedResourceTypesOutput object

GlobalSettings

  • GlobalSettings object

GlobalSettingsName

  • GlobalSettingsName string

GlobalSettingsValue

  • GlobalSettingsValue string

IAMPolicy

  • IAMPolicy string

IAMRoleArn

  • IAMRoleArn string

InvalidParameterValueException

InvalidRequestException

IsEnabled

  • IsEnabled boolean

Lifecycle

  • Lifecycle object: Contains an array of Transition objects specifying how long in days before a recovery point transitions to cold storage or is deleted. Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, on the console, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.
    • DeleteAfterDays
    • MoveToColdStorageAfterDays

LimitExceededException

ListBackupJobsInput

  • ListBackupJobsInput object

ListBackupJobsOutput

  • ListBackupJobsOutput object

ListBackupPlanTemplatesInput

  • ListBackupPlanTemplatesInput object

ListBackupPlanTemplatesOutput

ListBackupPlanVersionsInput

  • ListBackupPlanVersionsInput object

ListBackupPlanVersionsOutput

ListBackupPlansInput

  • ListBackupPlansInput object

ListBackupPlansOutput

ListBackupSelectionsInput

  • ListBackupSelectionsInput object

ListBackupSelectionsOutput

ListBackupVaultsInput

  • ListBackupVaultsInput object

ListBackupVaultsOutput

ListCopyJobsInput

  • ListCopyJobsInput object

ListCopyJobsOutput

  • ListCopyJobsOutput object

ListOfTags

ListProtectedResourcesInput

  • ListProtectedResourcesInput object

ListProtectedResourcesOutput

ListRecoveryPointsByBackupVaultInput

  • ListRecoveryPointsByBackupVaultInput object

ListRecoveryPointsByBackupVaultOutput

ListRecoveryPointsByResourceInput

  • ListRecoveryPointsByResourceInput object

ListRecoveryPointsByResourceOutput

ListRestoreJobsInput

  • ListRestoreJobsInput object

ListRestoreJobsOutput

ListTagsInput

  • ListTagsInput object

ListTagsOutput

  • ListTagsOutput object
    • NextToken
    • Tags

Long

  • Long integer

MaxResults

  • MaxResults integer

Metadata

  • Metadata object

MetadataKey

  • MetadataKey string

MetadataValue

  • MetadataValue string

MissingParameterValueException

ProtectedResource

  • ProtectedResource object: A structure that contains information about a backed-up resource.
    • LastBackupTime
    • ResourceArn
    • ResourceType

ProtectedResourcesList

PutBackupVaultAccessPolicyInput

  • PutBackupVaultAccessPolicyInput object
    • Policy

PutBackupVaultNotificationsInput

  • PutBackupVaultNotificationsInput object

RecoveryPointByBackupVault

  • RecoveryPointByBackupVault object: Contains detailed information about the recovery points stored in a backup vault.
    • BackupSizeInBytes
    • BackupVaultArn
    • BackupVaultName
    • CalculatedLifecycle
      • DeleteAt
      • MoveToColdStorageAt
    • CompletionDate
    • CreatedBy
      • BackupPlanArn
      • BackupPlanId
      • BackupPlanVersion
      • BackupRuleId
    • CreationDate
    • EncryptionKeyArn
    • IamRoleArn
    • IsEncrypted
    • LastRestoreTime
    • Lifecycle
      • DeleteAfterDays
      • MoveToColdStorageAfterDays
    • RecoveryPointArn
    • ResourceArn
    • ResourceType
    • SourceBackupVaultArn
    • Status

RecoveryPointByBackupVaultList

RecoveryPointByResource

  • RecoveryPointByResource object: Contains detailed information about a saved recovery point.
    • BackupSizeBytes
    • BackupVaultName
    • CreationDate
    • EncryptionKeyArn
    • RecoveryPointArn
    • Status

RecoveryPointByResourceList

RecoveryPointCreator

  • RecoveryPointCreator object: Contains information about the backup plan and rule that AWS Backup used to initiate the recovery point backup.
    • BackupPlanArn
    • BackupPlanId
    • BackupPlanVersion
    • BackupRuleId

RecoveryPointStatus

  • RecoveryPointStatus string (values: COMPLETED, PARTIAL, DELETING, EXPIRED)

ResourceArns

  • ResourceArns array

ResourceNotFoundException

ResourceType

  • ResourceType string

ResourceTypeOptInPreference

  • ResourceTypeOptInPreference object

ResourceTypes

RestoreJobId

  • RestoreJobId string

RestoreJobStatus

  • RestoreJobStatus string (values: PENDING, RUNNING, COMPLETED, ABORTED, FAILED)

RestoreJobsList

RestoreJobsListMember

  • RestoreJobsListMember object: Contains metadata about a restore job.
    • AccountId
    • BackupSizeInBytes
    • CompletionDate
    • CreatedResourceArn
    • CreationDate
    • ExpectedCompletionTimeMinutes
    • IamRoleArn
    • PercentDone
    • RecoveryPointArn
    • ResourceType
    • RestoreJobId
    • Status
    • StatusMessage

ServiceUnavailableException

StartBackupJobInput

  • StartBackupJobInput object
    • BackupOptions
    • BackupVaultName required
    • CompleteWindowMinutes
    • IamRoleArn required
    • IdempotencyToken
    • Lifecycle
      • DeleteAfterDays
      • MoveToColdStorageAfterDays
    • RecoveryPointTags
    • ResourceArn required
    • StartWindowMinutes

StartBackupJobOutput

  • StartBackupJobOutput object
    • BackupJobId
    • CreationDate
    • RecoveryPointArn

StartCopyJobInput

  • StartCopyJobInput object
    • DestinationBackupVaultArn required
    • IamRoleArn required
    • IdempotencyToken
    • Lifecycle Lifecycle
    • RecoveryPointArn required
    • SourceBackupVaultName required

StartCopyJobOutput

  • StartCopyJobOutput object
    • CopyJobId
    • CreationDate

StartRestoreJobInput

  • StartRestoreJobInput object
    • IamRoleArn required
    • IdempotencyToken
    • Metadata required
    • RecoveryPointArn required
    • ResourceType

StartRestoreJobOutput

  • StartRestoreJobOutput object
    • RestoreJobId

StopBackupJobInput

  • StopBackupJobInput object

StorageClass

  • StorageClass string (values: WARM, COLD, DELETED)

TagKey

  • TagKey string

TagKeyList

TagResourceInput

  • TagResourceInput object
    • Tags required

TagValue

  • TagValue string

Tags

  • Tags object

UntagResourceInput

  • UntagResourceInput object
    • TagKeyList required

UpdateBackupPlanInput

UpdateBackupPlanOutput

  • UpdateBackupPlanOutput object

UpdateGlobalSettingsInput

  • UpdateGlobalSettingsInput object
    • GlobalSettings

UpdateRecoveryPointLifecycleInput

  • UpdateRecoveryPointLifecycleInput object
    • Lifecycle
      • DeleteAfterDays
      • MoveToColdStorageAfterDays

UpdateRecoveryPointLifecycleOutput

  • UpdateRecoveryPointLifecycleOutput object
    • BackupVaultArn
    • CalculatedLifecycle
      • DeleteAt
      • MoveToColdStorageAt
    • Lifecycle
      • DeleteAfterDays
      • MoveToColdStorageAfterDays
    • RecoveryPointArn

UpdateRegionSettingsInput

  • UpdateRegionSettingsInput object
    • ResourceTypeOptInPreference

WindowMinutes

  • WindowMinutes integer

boolean

  • boolean boolean

long

  • long integer

string

  • string string

timestamp

  • timestamp string
datafireaws-sdk
@infinitebrahmanuniverse/nolb-_datafire_am@everything-registry/sub-chunk-220
5.0.0

5 years ago