Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
- Service Configuration
- Errors
- Waiters
- Operations
- CancelLegalHold
- CreateBackupPlan
- CreateBackupSelection
- CreateBackupVault
- CreateFramework
- CreateLegalHold
- CreateReportPlan
- DeleteBackupPlan
- DeleteBackupSelection
- DeleteBackupVault
- DeleteBackupVaultAccessPolicy
- DeleteBackupVaultLockConfiguration
- DeleteBackupVaultNotifications
- DeleteFramework
- DeleteRecoveryPoint
- DeleteReportPlan
- DescribeBackupJob
- DescribeBackupVault
- DescribeCopyJob
- DescribeFramework
- DescribeGlobalSettings
- DescribeProtectedResource
- DescribeRecoveryPoint
- DescribeRegionSettings
- DescribeReportJob
- DescribeReportPlan
- DescribeRestoreJob
- DisassociateRecoveryPoint
- DisassociateRecoveryPointFromParent
- ExportBackupPlanTemplate
- GetBackupPlan
- GetBackupPlanFromJSON
- GetBackupPlanFromTemplate
- GetBackupSelection
- GetBackupVaultAccessPolicy
- GetBackupVaultNotifications
- GetLegalHold
- GetRecoveryPointRestoreMetadata
- GetSupportedResourceTypes
- ListBackupJobs (Paginated)
- ListBackupPlanTemplates (Paginated)
- ListBackupPlanVersions (Paginated)
- ListBackupPlans (Paginated)
- ListBackupSelections (Paginated)
- ListBackupVaults (Paginated)
- ListCopyJobs (Paginated)
- ListFrameworks
- ListLegalHolds (Paginated)
- ListProtectedResources (Paginated)
- ListRecoveryPointsByBackupVault (Paginated)
- ListRecoveryPointsByLegalHold (Paginated)
- ListRecoveryPointsByResource (Paginated)
- ListReportJobs
- ListReportPlans
- ListRestoreJobs (Paginated)
- ListTags
- PutBackupVaultAccessPolicy
- PutBackupVaultLockConfiguration
- PutBackupVaultNotifications
- StartBackupJob
- StartCopyJob
- StartReportJob
- StartRestoreJob
- StopBackupJob
- TagResource
- UntagResource
- UpdateBackupPlan
- UpdateFramework
- UpdateGlobalSettings
- UpdateRecoveryPointLifecycle
- UpdateRegionSettings
- UpdateReportPlan
- Types
- BackupJobState
- BackupVaultEvent
- ConditionType
- CopyJobState
- LegalHoldStatus
- RecoveryPointStatus
- RestoreJobStatus
- StorageClass
- AdvancedBackupSetting
- BackupJob
- BackupPlan
- BackupPlanInput
- BackupPlanTemplatesListMember
- BackupPlansListMember
- BackupRule
- BackupRuleInput
- BackupSelection
- BackupSelectionsListMember
- BackupVaultListMember
- CalculatedLifecycle
- Condition
- ConditionParameter
- Conditions
- ControlInputParameter
- ControlScope
- CopyAction
- CopyJob
- DateRange
- Framework
- FrameworkControl
- LegalHold
- Lifecycle
- ProtectedResource
- RecoveryPointByBackupVault
- RecoveryPointByResource
- RecoveryPointCreator
- RecoveryPointMember
- RecoveryPointSelection
- ReportDeliveryChannel
- ReportDestination
- ReportJob
- ReportPlan
- ReportSetting
- RestoreJobsListMember
Derived from API version 2018-11-15
of the AWS service descriptions, licensed under Apache 2.0.
Backup
Backup is a unified backup service designed to protect Amazon Web Services services and their associated data. Backup simplifies the creation, migration, restoration, and deletion of backups, while also providing reporting and auditing.
Synopsis
- defaultService :: Service
- _AlreadyExistsException :: AsError a => Fold a ServiceError
- _ConflictException :: AsError a => Fold a ServiceError
- _DependencyFailureException :: AsError a => Fold a ServiceError
- _InvalidParameterValueException :: AsError a => Fold a ServiceError
- _InvalidRequestException :: AsError a => Fold a ServiceError
- _InvalidResourceStateException :: AsError a => Fold a ServiceError
- _LimitExceededException :: AsError a => Fold a ServiceError
- _MissingParameterValueException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _ServiceUnavailableException :: AsError a => Fold a ServiceError
- data CancelLegalHold = CancelLegalHold' (Maybe Integer) Text Text
- newCancelLegalHold :: Text -> Text -> CancelLegalHold
- data CancelLegalHoldResponse = CancelLegalHoldResponse' Int
- newCancelLegalHoldResponse :: Int -> CancelLegalHoldResponse
- data CreateBackupPlan = CreateBackupPlan' (Maybe (Sensitive (HashMap Text Text))) (Maybe Text) BackupPlanInput
- newCreateBackupPlan :: BackupPlanInput -> CreateBackupPlan
- data CreateBackupPlanResponse = CreateBackupPlanResponse' (Maybe [AdvancedBackupSetting]) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) Int
- newCreateBackupPlanResponse :: Int -> CreateBackupPlanResponse
- data CreateBackupSelection = CreateBackupSelection' (Maybe Text) Text BackupSelection
- newCreateBackupSelection :: Text -> BackupSelection -> CreateBackupSelection
- data CreateBackupSelectionResponse = CreateBackupSelectionResponse' (Maybe Text) (Maybe POSIX) (Maybe Text) Int
- newCreateBackupSelectionResponse :: Int -> CreateBackupSelectionResponse
- data CreateBackupVault = CreateBackupVault' (Maybe (Sensitive (HashMap Text Text))) (Maybe Text) (Maybe Text) Text
- newCreateBackupVault :: Text -> CreateBackupVault
- data CreateBackupVaultResponse = CreateBackupVaultResponse' (Maybe Text) (Maybe Text) (Maybe POSIX) Int
- newCreateBackupVaultResponse :: Int -> CreateBackupVaultResponse
- data CreateFramework = CreateFramework' (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) Text [FrameworkControl]
- newCreateFramework :: Text -> CreateFramework
- data CreateFrameworkResponse = CreateFrameworkResponse' (Maybe Text) (Maybe Text) Int
- newCreateFrameworkResponse :: Int -> CreateFrameworkResponse
- data CreateLegalHold = CreateLegalHold' (Maybe Text) (Maybe RecoveryPointSelection) (Maybe (Sensitive (HashMap Text Text))) Text Text
- newCreateLegalHold :: Text -> Text -> CreateLegalHold
- data CreateLegalHoldResponse = CreateLegalHoldResponse' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe RecoveryPointSelection) (Maybe LegalHoldStatus) (Maybe Text) Int
- newCreateLegalHoldResponse :: Int -> CreateLegalHoldResponse
- data CreateReportPlan = CreateReportPlan' (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) Text ReportDeliveryChannel ReportSetting
- newCreateReportPlan :: Text -> ReportDeliveryChannel -> ReportSetting -> CreateReportPlan
- data CreateReportPlanResponse = CreateReportPlanResponse' (Maybe POSIX) (Maybe Text) (Maybe Text) Int
- newCreateReportPlanResponse :: Int -> CreateReportPlanResponse
- data DeleteBackupPlan = DeleteBackupPlan' Text
- newDeleteBackupPlan :: Text -> DeleteBackupPlan
- data DeleteBackupPlanResponse = DeleteBackupPlanResponse' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) Int
- newDeleteBackupPlanResponse :: Int -> DeleteBackupPlanResponse
- data DeleteBackupSelection = DeleteBackupSelection' Text Text
- newDeleteBackupSelection :: Text -> Text -> DeleteBackupSelection
- data DeleteBackupSelectionResponse = DeleteBackupSelectionResponse' {
- newDeleteBackupSelectionResponse :: DeleteBackupSelectionResponse
- data DeleteBackupVault = DeleteBackupVault' Text
- newDeleteBackupVault :: Text -> DeleteBackupVault
- data DeleteBackupVaultResponse = DeleteBackupVaultResponse' {
- newDeleteBackupVaultResponse :: DeleteBackupVaultResponse
- data DeleteBackupVaultAccessPolicy = DeleteBackupVaultAccessPolicy' Text
- newDeleteBackupVaultAccessPolicy :: Text -> DeleteBackupVaultAccessPolicy
- data DeleteBackupVaultAccessPolicyResponse = DeleteBackupVaultAccessPolicyResponse' {
- newDeleteBackupVaultAccessPolicyResponse :: DeleteBackupVaultAccessPolicyResponse
- data DeleteBackupVaultLockConfiguration = DeleteBackupVaultLockConfiguration' Text
- newDeleteBackupVaultLockConfiguration :: Text -> DeleteBackupVaultLockConfiguration
- data DeleteBackupVaultLockConfigurationResponse = DeleteBackupVaultLockConfigurationResponse' {
- newDeleteBackupVaultLockConfigurationResponse :: DeleteBackupVaultLockConfigurationResponse
- data DeleteBackupVaultNotifications = DeleteBackupVaultNotifications' Text
- newDeleteBackupVaultNotifications :: Text -> DeleteBackupVaultNotifications
- data DeleteBackupVaultNotificationsResponse = DeleteBackupVaultNotificationsResponse' {
- newDeleteBackupVaultNotificationsResponse :: DeleteBackupVaultNotificationsResponse
- data DeleteFramework = DeleteFramework' Text
- newDeleteFramework :: Text -> DeleteFramework
- data DeleteFrameworkResponse = DeleteFrameworkResponse' {
- newDeleteFrameworkResponse :: DeleteFrameworkResponse
- data DeleteRecoveryPoint = DeleteRecoveryPoint' Text Text
- newDeleteRecoveryPoint :: Text -> Text -> DeleteRecoveryPoint
- data DeleteRecoveryPointResponse = DeleteRecoveryPointResponse' {
- newDeleteRecoveryPointResponse :: DeleteRecoveryPointResponse
- data DeleteReportPlan = DeleteReportPlan' Text
- newDeleteReportPlan :: Text -> DeleteReportPlan
- data DeleteReportPlanResponse = DeleteReportPlanResponse' {
- newDeleteReportPlanResponse :: DeleteReportPlanResponse
- data DescribeBackupJob = DescribeBackupJob' Text
- newDescribeBackupJob :: Text -> DescribeBackupJob
- data DescribeBackupJobResponse = DescribeBackupJobResponse' (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Integer) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe (HashMap BackupJobState Integer)) (Maybe POSIX) (Maybe RecoveryPointCreator) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Bool) (Maybe Integer) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe BackupJobState) (Maybe Text) Int
- newDescribeBackupJobResponse :: Int -> DescribeBackupJobResponse
- data DescribeBackupVault = DescribeBackupVault' Text
- newDescribeBackupVault :: Text -> DescribeBackupVault
- data DescribeBackupVaultResponse = DescribeBackupVaultResponse' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Bool) (Maybe Integer) (Maybe Integer) (Maybe Integer) Int
- newDescribeBackupVaultResponse :: Int -> DescribeBackupVaultResponse
- data DescribeCopyJob = DescribeCopyJob' Text
- newDescribeCopyJob :: Text -> DescribeCopyJob
- data DescribeCopyJobResponse = DescribeCopyJobResponse' (Maybe CopyJob) Int
- newDescribeCopyJobResponse :: Int -> DescribeCopyJobResponse
- data DescribeFramework = DescribeFramework' Text
- newDescribeFramework :: Text -> DescribeFramework
- data DescribeFrameworkResponse = DescribeFrameworkResponse' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe [FrameworkControl]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Int
- newDescribeFrameworkResponse :: Int -> DescribeFrameworkResponse
- data DescribeGlobalSettings = DescribeGlobalSettings' {
- newDescribeGlobalSettings :: DescribeGlobalSettings
- data DescribeGlobalSettingsResponse = DescribeGlobalSettingsResponse' (Maybe (HashMap Text Text)) (Maybe POSIX) Int
- newDescribeGlobalSettingsResponse :: Int -> DescribeGlobalSettingsResponse
- data DescribeProtectedResource = DescribeProtectedResource' Text
- newDescribeProtectedResource :: Text -> DescribeProtectedResource
- data DescribeProtectedResourceResponse = DescribeProtectedResourceResponse' (Maybe POSIX) (Maybe Text) (Maybe Text) Int
- newDescribeProtectedResourceResponse :: Int -> DescribeProtectedResourceResponse
- data DescribeRecoveryPoint = DescribeRecoveryPoint' Text Text
- newDescribeRecoveryPoint :: Text -> Text -> DescribeRecoveryPoint
- data DescribeRecoveryPointResponse = DescribeRecoveryPointResponse' (Maybe Integer) (Maybe Text) (Maybe Text) (Maybe CalculatedLifecycle) (Maybe POSIX) (Maybe Text) (Maybe RecoveryPointCreator) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe POSIX) (Maybe Lifecycle) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe RecoveryPointStatus) (Maybe Text) (Maybe StorageClass) Int
- newDescribeRecoveryPointResponse :: Int -> DescribeRecoveryPointResponse
- data DescribeRegionSettings = DescribeRegionSettings' {
- newDescribeRegionSettings :: DescribeRegionSettings
- data DescribeRegionSettingsResponse = DescribeRegionSettingsResponse' (Maybe (HashMap Text Bool)) (Maybe (HashMap Text Bool)) Int
- newDescribeRegionSettingsResponse :: Int -> DescribeRegionSettingsResponse
- data DescribeReportJob = DescribeReportJob' Text
- newDescribeReportJob :: Text -> DescribeReportJob
- data DescribeReportJobResponse = DescribeReportJobResponse' (Maybe ReportJob) Int
- newDescribeReportJobResponse :: Int -> DescribeReportJobResponse
- data DescribeReportPlan = DescribeReportPlan' Text
- newDescribeReportPlan :: Text -> DescribeReportPlan
- data DescribeReportPlanResponse = DescribeReportPlanResponse' (Maybe ReportPlan) Int
- newDescribeReportPlanResponse :: Int -> DescribeReportPlanResponse
- data DescribeRestoreJob = DescribeRestoreJob' Text
- newDescribeRestoreJob :: Text -> DescribeRestoreJob
- data DescribeRestoreJobResponse = DescribeRestoreJobResponse' (Maybe Text) (Maybe Integer) (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe Integer) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe RestoreJobStatus) (Maybe Text) Int
- newDescribeRestoreJobResponse :: Int -> DescribeRestoreJobResponse
- data DisassociateRecoveryPoint = DisassociateRecoveryPoint' Text Text
- newDisassociateRecoveryPoint :: Text -> Text -> DisassociateRecoveryPoint
- data DisassociateRecoveryPointResponse = DisassociateRecoveryPointResponse' {
- newDisassociateRecoveryPointResponse :: DisassociateRecoveryPointResponse
- data DisassociateRecoveryPointFromParent = DisassociateRecoveryPointFromParent' Text Text
- newDisassociateRecoveryPointFromParent :: Text -> Text -> DisassociateRecoveryPointFromParent
- data DisassociateRecoveryPointFromParentResponse = DisassociateRecoveryPointFromParentResponse' {
- newDisassociateRecoveryPointFromParentResponse :: DisassociateRecoveryPointFromParentResponse
- data ExportBackupPlanTemplate = ExportBackupPlanTemplate' Text
- newExportBackupPlanTemplate :: Text -> ExportBackupPlanTemplate
- data ExportBackupPlanTemplateResponse = ExportBackupPlanTemplateResponse' (Maybe Text) Int
- newExportBackupPlanTemplateResponse :: Int -> ExportBackupPlanTemplateResponse
- data GetBackupPlan = GetBackupPlan' (Maybe Text) Text
- newGetBackupPlan :: Text -> GetBackupPlan
- data GetBackupPlanResponse = GetBackupPlanResponse' (Maybe [AdvancedBackupSetting]) (Maybe BackupPlan) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe Text) Int
- newGetBackupPlanResponse :: Int -> GetBackupPlanResponse
- data GetBackupPlanFromJSON = GetBackupPlanFromJSON' Text
- newGetBackupPlanFromJSON :: Text -> GetBackupPlanFromJSON
- data GetBackupPlanFromJSONResponse = GetBackupPlanFromJSONResponse' (Maybe BackupPlan) Int
- newGetBackupPlanFromJSONResponse :: Int -> GetBackupPlanFromJSONResponse
- data GetBackupPlanFromTemplate = GetBackupPlanFromTemplate' Text
- newGetBackupPlanFromTemplate :: Text -> GetBackupPlanFromTemplate
- data GetBackupPlanFromTemplateResponse = GetBackupPlanFromTemplateResponse' (Maybe BackupPlan) Int
- newGetBackupPlanFromTemplateResponse :: Int -> GetBackupPlanFromTemplateResponse
- data GetBackupSelection = GetBackupSelection' Text Text
- newGetBackupSelection :: Text -> Text -> GetBackupSelection
- data GetBackupSelectionResponse = GetBackupSelectionResponse' (Maybe Text) (Maybe BackupSelection) (Maybe POSIX) (Maybe Text) (Maybe Text) Int
- newGetBackupSelectionResponse :: Int -> GetBackupSelectionResponse
- data GetBackupVaultAccessPolicy = GetBackupVaultAccessPolicy' Text
- newGetBackupVaultAccessPolicy :: Text -> GetBackupVaultAccessPolicy
- data GetBackupVaultAccessPolicyResponse = GetBackupVaultAccessPolicyResponse' (Maybe Text) (Maybe Text) (Maybe Text) Int
- newGetBackupVaultAccessPolicyResponse :: Int -> GetBackupVaultAccessPolicyResponse
- data GetBackupVaultNotifications = GetBackupVaultNotifications' Text
- newGetBackupVaultNotifications :: Text -> GetBackupVaultNotifications
- data GetBackupVaultNotificationsResponse = GetBackupVaultNotificationsResponse' (Maybe Text) (Maybe [BackupVaultEvent]) (Maybe Text) (Maybe Text) Int
- newGetBackupVaultNotificationsResponse :: Int -> GetBackupVaultNotificationsResponse
- data GetLegalHold = GetLegalHold' Text
- newGetLegalHold :: Text -> GetLegalHold
- data GetLegalHoldResponse = GetLegalHoldResponse' (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe RecoveryPointSelection) (Maybe POSIX) (Maybe LegalHoldStatus) (Maybe Text) Int
- newGetLegalHoldResponse :: Int -> GetLegalHoldResponse
- data GetRecoveryPointRestoreMetadata = GetRecoveryPointRestoreMetadata' Text Text
- newGetRecoveryPointRestoreMetadata :: Text -> Text -> GetRecoveryPointRestoreMetadata
- data GetRecoveryPointRestoreMetadataResponse = GetRecoveryPointRestoreMetadataResponse' (Maybe Text) (Maybe Text) (Maybe (Sensitive (HashMap Text Text))) Int
- newGetRecoveryPointRestoreMetadataResponse :: Int -> GetRecoveryPointRestoreMetadataResponse
- data GetSupportedResourceTypes = GetSupportedResourceTypes' {
- newGetSupportedResourceTypes :: GetSupportedResourceTypes
- data GetSupportedResourceTypesResponse = GetSupportedResourceTypesResponse' (Maybe [Text]) Int
- newGetSupportedResourceTypesResponse :: Int -> GetSupportedResourceTypesResponse
- data ListBackupJobs = ListBackupJobs' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe BackupJobState) (Maybe Natural) (Maybe Text)
- newListBackupJobs :: ListBackupJobs
- data ListBackupJobsResponse = ListBackupJobsResponse' (Maybe [BackupJob]) (Maybe Text) Int
- newListBackupJobsResponse :: Int -> ListBackupJobsResponse
- data ListBackupPlanTemplates = ListBackupPlanTemplates' (Maybe Natural) (Maybe Text)
- newListBackupPlanTemplates :: ListBackupPlanTemplates
- data ListBackupPlanTemplatesResponse = ListBackupPlanTemplatesResponse' (Maybe [BackupPlanTemplatesListMember]) (Maybe Text) Int
- newListBackupPlanTemplatesResponse :: Int -> ListBackupPlanTemplatesResponse
- data ListBackupPlanVersions = ListBackupPlanVersions' (Maybe Natural) (Maybe Text) Text
- newListBackupPlanVersions :: Text -> ListBackupPlanVersions
- data ListBackupPlanVersionsResponse = ListBackupPlanVersionsResponse' (Maybe [BackupPlansListMember]) (Maybe Text) Int
- newListBackupPlanVersionsResponse :: Int -> ListBackupPlanVersionsResponse
- data ListBackupPlans = ListBackupPlans' (Maybe Bool) (Maybe Natural) (Maybe Text)
- newListBackupPlans :: ListBackupPlans
- data ListBackupPlansResponse = ListBackupPlansResponse' (Maybe [BackupPlansListMember]) (Maybe Text) Int
- newListBackupPlansResponse :: Int -> ListBackupPlansResponse
- data ListBackupSelections = ListBackupSelections' (Maybe Natural) (Maybe Text) Text
- newListBackupSelections :: Text -> ListBackupSelections
- data ListBackupSelectionsResponse = ListBackupSelectionsResponse' (Maybe [BackupSelectionsListMember]) (Maybe Text) Int
- newListBackupSelectionsResponse :: Int -> ListBackupSelectionsResponse
- data ListBackupVaults = ListBackupVaults' (Maybe Natural) (Maybe Text)
- newListBackupVaults :: ListBackupVaults
- data ListBackupVaultsResponse = ListBackupVaultsResponse' (Maybe [BackupVaultListMember]) (Maybe Text) Int
- newListBackupVaultsResponse :: Int -> ListBackupVaultsResponse
- data ListCopyJobs = ListCopyJobs' (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe CopyJobState) (Maybe Natural) (Maybe Text)
- newListCopyJobs :: ListCopyJobs
- data ListCopyJobsResponse = ListCopyJobsResponse' (Maybe [CopyJob]) (Maybe Text) Int
- newListCopyJobsResponse :: Int -> ListCopyJobsResponse
- data ListFrameworks = ListFrameworks' (Maybe Natural) (Maybe Text)
- newListFrameworks :: ListFrameworks
- data ListFrameworksResponse = ListFrameworksResponse' (Maybe [Framework]) (Maybe Text) Int
- newListFrameworksResponse :: Int -> ListFrameworksResponse
- data ListLegalHolds = ListLegalHolds' (Maybe Natural) (Maybe Text)
- newListLegalHolds :: ListLegalHolds
- data ListLegalHoldsResponse = ListLegalHoldsResponse' (Maybe [LegalHold]) (Maybe Text) Int
- newListLegalHoldsResponse :: Int -> ListLegalHoldsResponse
- data ListProtectedResources = ListProtectedResources' (Maybe Natural) (Maybe Text)
- newListProtectedResources :: ListProtectedResources
- data ListProtectedResourcesResponse = ListProtectedResourcesResponse' (Maybe Text) (Maybe [ProtectedResource]) Int
- newListProtectedResourcesResponse :: Int -> ListProtectedResourcesResponse
- data ListRecoveryPointsByBackupVault = ListRecoveryPointsByBackupVault' (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe Text) Text
- newListRecoveryPointsByBackupVault :: Text -> ListRecoveryPointsByBackupVault
- data ListRecoveryPointsByBackupVaultResponse = ListRecoveryPointsByBackupVaultResponse' (Maybe Text) (Maybe [RecoveryPointByBackupVault]) Int
- newListRecoveryPointsByBackupVaultResponse :: Int -> ListRecoveryPointsByBackupVaultResponse
- data ListRecoveryPointsByLegalHold = ListRecoveryPointsByLegalHold' (Maybe Natural) (Maybe Text) Text
- newListRecoveryPointsByLegalHold :: Text -> ListRecoveryPointsByLegalHold
- data ListRecoveryPointsByLegalHoldResponse = ListRecoveryPointsByLegalHoldResponse' (Maybe Text) (Maybe [RecoveryPointMember]) Int
- newListRecoveryPointsByLegalHoldResponse :: Int -> ListRecoveryPointsByLegalHoldResponse
- data ListRecoveryPointsByResource = ListRecoveryPointsByResource' (Maybe Natural) (Maybe Text) Text
- newListRecoveryPointsByResource :: Text -> ListRecoveryPointsByResource
- data ListRecoveryPointsByResourceResponse = ListRecoveryPointsByResourceResponse' (Maybe Text) (Maybe [RecoveryPointByResource]) Int
- newListRecoveryPointsByResourceResponse :: Int -> ListRecoveryPointsByResourceResponse
- data ListReportJobs = ListReportJobs' (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe Text)
- newListReportJobs :: ListReportJobs
- data ListReportJobsResponse = ListReportJobsResponse' (Maybe Text) (Maybe [ReportJob]) Int
- newListReportJobsResponse :: Int -> ListReportJobsResponse
- data ListReportPlans = ListReportPlans' (Maybe Natural) (Maybe Text)
- newListReportPlans :: ListReportPlans
- data ListReportPlansResponse = ListReportPlansResponse' (Maybe Text) (Maybe [ReportPlan]) Int
- newListReportPlansResponse :: Int -> ListReportPlansResponse
- data ListRestoreJobs = ListRestoreJobs' (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe POSIX) (Maybe POSIX) (Maybe RestoreJobStatus) (Maybe Natural) (Maybe Text)
- newListRestoreJobs :: ListRestoreJobs
- data ListRestoreJobsResponse = ListRestoreJobsResponse' (Maybe Text) (Maybe [RestoreJobsListMember]) Int
- newListRestoreJobsResponse :: Int -> ListRestoreJobsResponse
- data ListTags = ListTags' (Maybe Natural) (Maybe Text) Text
- newListTags :: Text -> ListTags
- data ListTagsResponse = ListTagsResponse' (Maybe Text) (Maybe (Sensitive (HashMap Text Text))) Int
- newListTagsResponse :: Int -> ListTagsResponse
- data PutBackupVaultAccessPolicy = PutBackupVaultAccessPolicy' (Maybe Text) Text
- newPutBackupVaultAccessPolicy :: Text -> PutBackupVaultAccessPolicy
- data PutBackupVaultAccessPolicyResponse = PutBackupVaultAccessPolicyResponse' {
- newPutBackupVaultAccessPolicyResponse :: PutBackupVaultAccessPolicyResponse
- data PutBackupVaultLockConfiguration = PutBackupVaultLockConfiguration' (Maybe Integer) (Maybe Integer) (Maybe Integer) Text
- newPutBackupVaultLockConfiguration :: Text -> PutBackupVaultLockConfiguration
- data PutBackupVaultLockConfigurationResponse = PutBackupVaultLockConfigurationResponse' {
- newPutBackupVaultLockConfigurationResponse :: PutBackupVaultLockConfigurationResponse
- data PutBackupVaultNotifications = PutBackupVaultNotifications' Text Text [BackupVaultEvent]
- newPutBackupVaultNotifications :: Text -> Text -> PutBackupVaultNotifications
- data PutBackupVaultNotificationsResponse = PutBackupVaultNotificationsResponse' {
- newPutBackupVaultNotificationsResponse :: PutBackupVaultNotificationsResponse
- data StartBackupJob = StartBackupJob' (Maybe (HashMap Text Text)) (Maybe Integer) (Maybe Text) (Maybe Lifecycle) (Maybe (Sensitive (HashMap Text Text))) (Maybe Integer) Text Text Text
- newStartBackupJob :: Text -> Text -> Text -> StartBackupJob
- data StartBackupJobResponse = StartBackupJobResponse' (Maybe Text) (Maybe POSIX) (Maybe Bool) (Maybe Text) Int
- newStartBackupJobResponse :: Int -> StartBackupJobResponse
- data StartCopyJob = StartCopyJob' (Maybe Text) (Maybe Lifecycle) Text Text Text Text
- newStartCopyJob :: Text -> Text -> Text -> Text -> StartCopyJob
- data StartCopyJobResponse = StartCopyJobResponse' (Maybe Text) (Maybe POSIX) (Maybe Bool) Int
- newStartCopyJobResponse :: Int -> StartCopyJobResponse
- data StartReportJob = StartReportJob' (Maybe Text) Text
- newStartReportJob :: Text -> StartReportJob
- data StartReportJobResponse = StartReportJobResponse' (Maybe Text) Int
- newStartReportJobResponse :: Int -> StartReportJobResponse
- data StartRestoreJob = StartRestoreJob' (Maybe Text) (Maybe Text) (Maybe Text) Text (Sensitive (HashMap Text Text))
- newStartRestoreJob :: Text -> StartRestoreJob
- data StartRestoreJobResponse = StartRestoreJobResponse' (Maybe Text) Int
- newStartRestoreJobResponse :: Int -> StartRestoreJobResponse
- data StopBackupJob = StopBackupJob' Text
- newStopBackupJob :: Text -> StopBackupJob
- data StopBackupJobResponse = StopBackupJobResponse' {
- newStopBackupJobResponse :: StopBackupJobResponse
- data TagResource = TagResource' Text (Sensitive (HashMap Text Text))
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' {
- newTagResourceResponse :: TagResourceResponse
- data UntagResource = UntagResource' Text (Sensitive [Text])
- newUntagResource :: Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' {
- newUntagResourceResponse :: UntagResourceResponse
- data UpdateBackupPlan = UpdateBackupPlan' Text BackupPlanInput
- newUpdateBackupPlan :: Text -> BackupPlanInput -> UpdateBackupPlan
- data UpdateBackupPlanResponse = UpdateBackupPlanResponse' (Maybe [AdvancedBackupSetting]) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) Int
- newUpdateBackupPlanResponse :: Int -> UpdateBackupPlanResponse
- data UpdateFramework = UpdateFramework' (Maybe [FrameworkControl]) (Maybe Text) (Maybe Text) Text
- newUpdateFramework :: Text -> UpdateFramework
- data UpdateFrameworkResponse = UpdateFrameworkResponse' (Maybe POSIX) (Maybe Text) (Maybe Text) Int
- newUpdateFrameworkResponse :: Int -> UpdateFrameworkResponse
- data UpdateGlobalSettings = UpdateGlobalSettings' (Maybe (HashMap Text Text))
- newUpdateGlobalSettings :: UpdateGlobalSettings
- data UpdateGlobalSettingsResponse = UpdateGlobalSettingsResponse' {
- newUpdateGlobalSettingsResponse :: UpdateGlobalSettingsResponse
- data UpdateRecoveryPointLifecycle = UpdateRecoveryPointLifecycle' (Maybe Lifecycle) Text Text
- newUpdateRecoveryPointLifecycle :: Text -> Text -> UpdateRecoveryPointLifecycle
- data UpdateRecoveryPointLifecycleResponse = UpdateRecoveryPointLifecycleResponse' (Maybe Text) (Maybe CalculatedLifecycle) (Maybe Lifecycle) (Maybe Text) Int
- newUpdateRecoveryPointLifecycleResponse :: Int -> UpdateRecoveryPointLifecycleResponse
- data UpdateRegionSettings = UpdateRegionSettings' (Maybe (HashMap Text Bool)) (Maybe (HashMap Text Bool))
- newUpdateRegionSettings :: UpdateRegionSettings
- data UpdateRegionSettingsResponse = UpdateRegionSettingsResponse' {
- newUpdateRegionSettingsResponse :: UpdateRegionSettingsResponse
- data UpdateReportPlan = UpdateReportPlan' (Maybe Text) (Maybe ReportDeliveryChannel) (Maybe Text) (Maybe ReportSetting) Text
- newUpdateReportPlan :: Text -> UpdateReportPlan
- data UpdateReportPlanResponse = UpdateReportPlanResponse' (Maybe POSIX) (Maybe Text) (Maybe Text) Int
- newUpdateReportPlanResponse :: Int -> UpdateReportPlanResponse
- newtype BackupJobState where
- BackupJobState' { }
- pattern BackupJobState_ABORTED :: BackupJobState
- pattern BackupJobState_ABORTING :: BackupJobState
- pattern BackupJobState_COMPLETED :: BackupJobState
- pattern BackupJobState_CREATED :: BackupJobState
- pattern BackupJobState_EXPIRED :: BackupJobState
- pattern BackupJobState_FAILED :: BackupJobState
- pattern BackupJobState_PARTIAL :: BackupJobState
- pattern BackupJobState_PENDING :: BackupJobState
- pattern BackupJobState_RUNNING :: BackupJobState
- newtype BackupVaultEvent where
- BackupVaultEvent' { }
- pattern BackupVaultEvent_BACKUP_JOB_COMPLETED :: BackupVaultEvent
- pattern BackupVaultEvent_BACKUP_JOB_EXPIRED :: BackupVaultEvent
- pattern BackupVaultEvent_BACKUP_JOB_FAILED :: BackupVaultEvent
- pattern BackupVaultEvent_BACKUP_JOB_STARTED :: BackupVaultEvent
- pattern BackupVaultEvent_BACKUP_JOB_SUCCESSFUL :: BackupVaultEvent
- pattern BackupVaultEvent_BACKUP_PLAN_CREATED :: BackupVaultEvent
- pattern BackupVaultEvent_BACKUP_PLAN_MODIFIED :: BackupVaultEvent
- pattern BackupVaultEvent_COPY_JOB_FAILED :: BackupVaultEvent
- pattern BackupVaultEvent_COPY_JOB_STARTED :: BackupVaultEvent
- pattern BackupVaultEvent_COPY_JOB_SUCCESSFUL :: BackupVaultEvent
- pattern BackupVaultEvent_RECOVERY_POINT_MODIFIED :: BackupVaultEvent
- pattern BackupVaultEvent_RESTORE_JOB_COMPLETED :: BackupVaultEvent
- pattern BackupVaultEvent_RESTORE_JOB_FAILED :: BackupVaultEvent
- pattern BackupVaultEvent_RESTORE_JOB_STARTED :: BackupVaultEvent
- pattern BackupVaultEvent_RESTORE_JOB_SUCCESSFUL :: BackupVaultEvent
- pattern BackupVaultEvent_S3_BACKUP_OBJECT_FAILED :: BackupVaultEvent
- pattern BackupVaultEvent_S3_RESTORE_OBJECT_FAILED :: BackupVaultEvent
- newtype ConditionType where
- ConditionType' { }
- pattern ConditionType_STRINGEQUALS :: ConditionType
- newtype CopyJobState where
- CopyJobState' { }
- pattern CopyJobState_COMPLETED :: CopyJobState
- pattern CopyJobState_CREATED :: CopyJobState
- pattern CopyJobState_FAILED :: CopyJobState
- pattern CopyJobState_PARTIAL :: CopyJobState
- pattern CopyJobState_RUNNING :: CopyJobState
- newtype LegalHoldStatus where
- LegalHoldStatus' { }
- pattern LegalHoldStatus_ACTIVE :: LegalHoldStatus
- pattern LegalHoldStatus_CANCELED :: LegalHoldStatus
- pattern LegalHoldStatus_CANCELING :: LegalHoldStatus
- pattern LegalHoldStatus_CREATING :: LegalHoldStatus
- newtype RecoveryPointStatus where
- newtype RestoreJobStatus where
- RestoreJobStatus' { }
- pattern RestoreJobStatus_ABORTED :: RestoreJobStatus
- pattern RestoreJobStatus_COMPLETED :: RestoreJobStatus
- pattern RestoreJobStatus_FAILED :: RestoreJobStatus
- pattern RestoreJobStatus_PENDING :: RestoreJobStatus
- pattern RestoreJobStatus_RUNNING :: RestoreJobStatus
- newtype StorageClass where
- StorageClass' { }
- pattern StorageClass_COLD :: StorageClass
- pattern StorageClass_DELETED :: StorageClass
- pattern StorageClass_WARM :: StorageClass
- data AdvancedBackupSetting = AdvancedBackupSetting' (Maybe (HashMap Text Text)) (Maybe Text)
- newAdvancedBackupSetting :: AdvancedBackupSetting
- data BackupJob = BackupJob' (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Integer) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe POSIX) (Maybe RecoveryPointCreator) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe BackupJobState) (Maybe Text)
- newBackupJob :: BackupJob
- data BackupPlan = BackupPlan' (Maybe [AdvancedBackupSetting]) Text [BackupRule]
- newBackupPlan :: Text -> BackupPlan
- data BackupPlanInput = BackupPlanInput' (Maybe [AdvancedBackupSetting]) Text [BackupRuleInput]
- newBackupPlanInput :: Text -> BackupPlanInput
- data BackupPlanTemplatesListMember = BackupPlanTemplatesListMember' (Maybe Text) (Maybe Text)
- newBackupPlanTemplatesListMember :: BackupPlanTemplatesListMember
- data BackupPlansListMember = BackupPlansListMember' (Maybe [AdvancedBackupSetting]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe Text)
- newBackupPlansListMember :: BackupPlansListMember
- data BackupRule = BackupRule' (Maybe Integer) (Maybe [CopyAction]) (Maybe Bool) (Maybe Lifecycle) (Maybe (Sensitive (HashMap Text Text))) (Maybe Text) (Maybe Text) (Maybe Integer) Text Text
- newBackupRule :: Text -> Text -> BackupRule
- data BackupRuleInput = BackupRuleInput' (Maybe Integer) (Maybe [CopyAction]) (Maybe Bool) (Maybe Lifecycle) (Maybe (Sensitive (HashMap Text Text))) (Maybe Text) (Maybe Integer) Text Text
- newBackupRuleInput :: Text -> Text -> BackupRuleInput
- data BackupSelection = BackupSelection' (Maybe Conditions) (Maybe [Condition]) (Maybe [Text]) (Maybe [Text]) Text Text
- newBackupSelection :: Text -> Text -> BackupSelection
- data BackupSelectionsListMember = BackupSelectionsListMember' (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newBackupSelectionsListMember :: BackupSelectionsListMember
- data BackupVaultListMember = BackupVaultListMember' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Bool) (Maybe Integer) (Maybe Integer) (Maybe Integer)
- newBackupVaultListMember :: BackupVaultListMember
- data CalculatedLifecycle = CalculatedLifecycle' (Maybe POSIX) (Maybe POSIX)
- newCalculatedLifecycle :: CalculatedLifecycle
- data Condition = Condition' ConditionType Text Text
- newCondition :: ConditionType -> Text -> Text -> Condition
- data ConditionParameter = ConditionParameter' (Maybe Text) (Maybe Text)
- newConditionParameter :: ConditionParameter
- data Conditions = Conditions' (Maybe [ConditionParameter]) (Maybe [ConditionParameter]) (Maybe [ConditionParameter]) (Maybe [ConditionParameter])
- newConditions :: Conditions
- data ControlInputParameter = ControlInputParameter' (Maybe Text) (Maybe Text)
- newControlInputParameter :: ControlInputParameter
- data ControlScope = ControlScope' (Maybe (NonEmpty Text)) (Maybe [Text]) (Maybe (HashMap Text Text))
- newControlScope :: ControlScope
- data CopyAction = CopyAction' (Maybe Lifecycle) Text
- newCopyAction :: Text -> CopyAction
- data CopyJob = CopyJob' (Maybe Text) (Maybe Integer) (Maybe (HashMap CopyJobState Integer)) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe RecoveryPointCreator) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Integer) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe CopyJobState) (Maybe Text)
- newCopyJob :: CopyJob
- data DateRange = DateRange' POSIX POSIX
- newDateRange :: UTCTime -> UTCTime -> DateRange
- data Framework = Framework' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int)
- newFramework :: Framework
- data FrameworkControl = FrameworkControl' (Maybe [ControlInputParameter]) (Maybe ControlScope) Text
- newFrameworkControl :: Text -> FrameworkControl
- data LegalHold = LegalHold' (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe LegalHoldStatus) (Maybe Text)
- newLegalHold :: LegalHold
- data Lifecycle = Lifecycle' (Maybe Integer) (Maybe Integer)
- newLifecycle :: Lifecycle
- data ProtectedResource = ProtectedResource' (Maybe POSIX) (Maybe Text) (Maybe Text)
- newProtectedResource :: ProtectedResource
- data RecoveryPointByBackupVault = RecoveryPointByBackupVault' (Maybe Integer) (Maybe Text) (Maybe Text) (Maybe CalculatedLifecycle) (Maybe POSIX) (Maybe Text) (Maybe RecoveryPointCreator) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe POSIX) (Maybe Lifecycle) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe RecoveryPointStatus) (Maybe Text)
- newRecoveryPointByBackupVault :: RecoveryPointByBackupVault
- data RecoveryPointByResource = RecoveryPointByResource' (Maybe Integer) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe RecoveryPointStatus) (Maybe Text)
- newRecoveryPointByResource :: RecoveryPointByResource
- data RecoveryPointCreator = RecoveryPointCreator' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newRecoveryPointCreator :: RecoveryPointCreator
- data RecoveryPointMember = RecoveryPointMember' (Maybe Text)
- newRecoveryPointMember :: RecoveryPointMember
- data RecoveryPointSelection = RecoveryPointSelection' (Maybe DateRange) (Maybe [Text]) (Maybe [Text])
- newRecoveryPointSelection :: RecoveryPointSelection
- data ReportDeliveryChannel = ReportDeliveryChannel' (Maybe [Text]) (Maybe Text) Text
- newReportDeliveryChannel :: Text -> ReportDeliveryChannel
- data ReportDestination = ReportDestination' (Maybe Text) (Maybe [Text])
- newReportDestination :: ReportDestination
- data ReportJob = ReportJob' (Maybe POSIX) (Maybe POSIX) (Maybe ReportDestination) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newReportJob :: ReportJob
- data ReportPlan = ReportPlan' (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe ReportDeliveryChannel) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ReportSetting)
- newReportPlan :: ReportPlan
- data ReportSetting = ReportSetting' (Maybe [Text]) (Maybe [Text]) (Maybe Int) (Maybe [Text]) (Maybe [Text]) Text
- newReportSetting :: Text -> ReportSetting
- data RestoreJobsListMember = RestoreJobsListMember' (Maybe Text) (Maybe Integer) (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe Integer) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe RestoreJobStatus) (Maybe Text)
- newRestoreJobsListMember :: RestoreJobsListMember
Service Configuration
defaultService :: Service Source #
API version 2018-11-15
of the Amazon Backup SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by Backup
.
AlreadyExistsException
_AlreadyExistsException :: AsError a => Fold a ServiceError Source #
The required resource already exists.
ConflictException
_ConflictException :: AsError a => Fold a ServiceError Source #
Backup can't perform the action that you requested until it finishes performing a previous action. Try again later.
DependencyFailureException
_DependencyFailureException :: AsError a => Fold a ServiceError Source #
A dependent Amazon Web Services service or resource returned an error to the Backup service, and the action cannot be completed.
InvalidParameterValueException
_InvalidParameterValueException :: AsError a => Fold a ServiceError Source #
Indicates that something is wrong with a parameter's value. For example, the value is out of range.
InvalidRequestException
_InvalidRequestException :: AsError a => Fold a ServiceError Source #
Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.
InvalidResourceStateException
_InvalidResourceStateException :: AsError a => Fold a ServiceError Source #
Backup is already performing an action on this recovery point. It can't perform the action you requested until the first action finishes. Try again later.
LimitExceededException
_LimitExceededException :: AsError a => Fold a ServiceError Source #
A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
MissingParameterValueException
_MissingParameterValueException :: AsError a => Fold a ServiceError Source #
Indicates that a required parameter is missing.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
A resource that is required for the action doesn't exist.
ServiceUnavailableException
_ServiceUnavailableException :: AsError a => Fold a ServiceError Source #
The request failed due to a temporary failure of the server.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait
specification is fulfilled. The Wait
specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects
operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager
instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
CancelLegalHold
data CancelLegalHold Source #
See: newCancelLegalHold
smart constructor.
Instances
Create a value of CancelLegalHold
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:retainRecordInDays:CancelLegalHold'
, cancelLegalHold_retainRecordInDays
- The integer amount in days specifying amount of days after this API
operation to remove legal hold.
CancelLegalHold
, cancelLegalHold_legalHoldId
- Legal hold ID required to remove the specified legal hold on a recovery
point.
$sel:cancelDescription:CancelLegalHold'
, cancelLegalHold_cancelDescription
- String describing the reason for removing the legal hold.
data CancelLegalHoldResponse Source #
See: newCancelLegalHoldResponse
smart constructor.
Instances
newCancelLegalHoldResponse Source #
Create a value of CancelLegalHoldResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:CancelLegalHoldResponse'
, cancelLegalHoldResponse_httpStatus
- The response's http status code.
CreateBackupPlan
data CreateBackupPlan Source #
See: newCreateBackupPlan
smart constructor.
Instances
Create a value of CreateBackupPlan
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:backupPlanTags:CreateBackupPlan'
, createBackupPlan_backupPlanTags
- 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.
CreateBackupPlan
, createBackupPlan_creatorRequestId
- 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.
$sel:backupPlan:CreateBackupPlan'
, createBackupPlan_backupPlan
- Specifies the body of a backup plan. Includes a BackupPlanName
and one
or more sets of Rules
.
data CreateBackupPlanResponse Source #
See: newCreateBackupPlanResponse
smart constructor.
CreateBackupPlanResponse' (Maybe [AdvancedBackupSetting]) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) Int |
Instances
newCreateBackupPlanResponse Source #
Create a value of CreateBackupPlanResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateBackupPlanResponse
, createBackupPlanResponse_advancedBackupSettings
- A list of BackupOptions
settings for a resource type. This option is
only available for Windows Volume Shadow Copy Service (VSS) backup jobs.
CreateBackupPlanResponse
, createBackupPlanResponse_backupPlanArn
- 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
.
CreateBackupPlanResponse
, createBackupPlanResponse_backupPlanId
- Uniquely identifies a backup plan.
CreateBackupPlanResponse
, createBackupPlanResponse_creationDate
- 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.
CreateBackupPlanResponse
, createBackupPlanResponse_versionId
- Unique, randomly generated, Unicode, UTF-8 encoded strings that are at
most 1,024 bytes long. They cannot be edited.
$sel:httpStatus:CreateBackupPlanResponse'
, createBackupPlanResponse_httpStatus
- The response's http status code.
CreateBackupSelection
data CreateBackupSelection Source #
See: newCreateBackupSelection
smart constructor.
Instances
newCreateBackupSelection Source #
Create a value of CreateBackupSelection
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateBackupSelection
, createBackupSelection_creatorRequestId
- 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.
CreateBackupSelection
, createBackupSelection_backupPlanId
- Uniquely identifies the backup plan to be associated with the selection
of resources.
$sel:backupSelection:CreateBackupSelection'
, createBackupSelection_backupSelection
- Specifies the body of a request to assign a set of resources to a backup
plan.
data CreateBackupSelectionResponse Source #
See: newCreateBackupSelectionResponse
smart constructor.
Instances
newCreateBackupSelectionResponse Source #
Create a value of CreateBackupSelectionResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateBackupSelection
, createBackupSelectionResponse_backupPlanId
- Uniquely identifies a backup plan.
CreateBackupSelectionResponse
, createBackupSelectionResponse_creationDate
- 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.
CreateBackupSelectionResponse
, createBackupSelectionResponse_selectionId
- Uniquely identifies the body of a request to assign a set of resources
to a backup plan.
$sel:httpStatus:CreateBackupSelectionResponse'
, createBackupSelectionResponse_httpStatus
- The response's http status code.
CreateBackupVault
data CreateBackupVault Source #
See: newCreateBackupVault
smart constructor.
Instances
Create a value of CreateBackupVault
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:backupVaultTags:CreateBackupVault'
, createBackupVault_backupVaultTags
- Metadata that you can assign to help organize the resources that you
create. Each tag is a key-value pair.
CreateBackupVault
, createBackupVault_creatorRequestId
- 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.
CreateBackupVault
, createBackupVault_encryptionKeyArn
- 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
.
CreateBackupVault
, createBackupVault_backupVaultName
- 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.
data CreateBackupVaultResponse Source #
See: newCreateBackupVaultResponse
smart constructor.
Instances
newCreateBackupVaultResponse Source #
Create a value of CreateBackupVaultResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateBackupVaultResponse
, createBackupVaultResponse_backupVaultArn
- An Amazon Resource Name (ARN) that uniquely identifies a backup vault;
for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault
.
CreateBackupVault
, createBackupVaultResponse_backupVaultName
- 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.
CreateBackupVaultResponse
, createBackupVaultResponse_creationDate
- 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.
$sel:httpStatus:CreateBackupVaultResponse'
, createBackupVaultResponse_httpStatus
- The response's http status code.
CreateFramework
data CreateFramework Source #
See: newCreateFramework
smart constructor.
Instances
Create a value of CreateFramework
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateFramework
, createFramework_frameworkDescription
- An optional description of the framework with a maximum of 1,024
characters.
$sel:frameworkTags:CreateFramework'
, createFramework_frameworkTags
- Metadata that you can assign to help organize the frameworks that you
create. Each tag is a key-value pair.
$sel:idempotencyToken:CreateFramework'
, createFramework_idempotencyToken
- 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.
CreateFramework
, createFramework_frameworkName
- 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 (_).
$sel:frameworkControls:CreateFramework'
, createFramework_frameworkControls
- A list of the controls that make up the framework. Each control in the
list has a name, input parameters, and scope.
data CreateFrameworkResponse Source #
See: newCreateFrameworkResponse
smart constructor.
Instances
newCreateFrameworkResponse Source #
Create a value of CreateFrameworkResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateFrameworkResponse
, createFrameworkResponse_frameworkArn
- An Amazon Resource Name (ARN) that uniquely identifies a resource. The
format of the ARN depends on the resource type.
CreateFramework
, createFrameworkResponse_frameworkName
- 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 (_).
$sel:httpStatus:CreateFrameworkResponse'
, createFrameworkResponse_httpStatus
- The response's http status code.
CreateLegalHold
data CreateLegalHold Source #
See: newCreateLegalHold
smart constructor.
CreateLegalHold' (Maybe Text) (Maybe RecoveryPointSelection) (Maybe (Sensitive (HashMap Text Text))) Text Text |
Instances
Create a value of CreateLegalHold
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:idempotencyToken:CreateLegalHold'
, createLegalHold_idempotencyToken
- 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.
CreateLegalHold
, createLegalHold_recoveryPointSelection
- This specifies criteria to assign a set of resources, such as resource
types or backup vaults.
CreateLegalHold
, createLegalHold_tags
- 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: +
- = . _ : /.
CreateLegalHold
, createLegalHold_title
- This is the string title of the legal hold.
CreateLegalHold
, createLegalHold_description
- This is the string description of the legal hold.
data CreateLegalHoldResponse Source #
See: newCreateLegalHoldResponse
smart constructor.
CreateLegalHoldResponse' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe RecoveryPointSelection) (Maybe LegalHoldStatus) (Maybe Text) Int |
Instances
newCreateLegalHoldResponse Source #
Create a value of CreateLegalHoldResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateLegalHoldResponse
, createLegalHoldResponse_creationDate
- Time in number format when legal hold was created.
CreateLegalHold
, createLegalHoldResponse_description
- This is the returned string description of the legal hold.
CreateLegalHoldResponse
, createLegalHoldResponse_legalHoldArn
- This is the ARN (Amazon Resource Number) of the created legal hold.
CreateLegalHoldResponse
, createLegalHoldResponse_legalHoldId
- Legal hold ID returned for the specified legal hold on a recovery point.
CreateLegalHold
, createLegalHoldResponse_recoveryPointSelection
- This specifies criteria to assign a set of resources, such as resource
types or backup vaults.
CreateLegalHoldResponse
, createLegalHoldResponse_status
- This displays the status of the legal hold returned after creating the
legal hold. Statuses can be ACTIVE
, PENDING
, CANCELED
,
CANCELING
, or FAILED
.
CreateLegalHold
, createLegalHoldResponse_title
- This is the string title of the legal hold returned after creating the
legal hold.
$sel:httpStatus:CreateLegalHoldResponse'
, createLegalHoldResponse_httpStatus
- The response's http status code.
CreateReportPlan
data CreateReportPlan Source #
See: newCreateReportPlan
smart constructor.
CreateReportPlan' (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) Text ReportDeliveryChannel ReportSetting |
Instances
Create a value of CreateReportPlan
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:idempotencyToken:CreateReportPlan'
, createReportPlan_idempotencyToken
- 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.
CreateReportPlan
, createReportPlan_reportPlanDescription
- An optional description of the report plan with a maximum of 1,024
characters.
$sel:reportPlanTags:CreateReportPlan'
, createReportPlan_reportPlanTags
- Metadata that you can assign to help organize the report plans that you
create. Each tag is a key-value pair.
CreateReportPlan
, createReportPlan_reportPlanName
- 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 (_).
CreateReportPlan
, createReportPlan_reportDeliveryChannel
- 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.
CreateReportPlan
, createReportPlan_reportSetting
- 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.
data CreateReportPlanResponse Source #
See: newCreateReportPlanResponse
smart constructor.
Instances
newCreateReportPlanResponse Source #
Create a value of CreateReportPlanResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateReportPlanResponse
, createReportPlanResponse_creationTime
- 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.
CreateReportPlanResponse
, createReportPlanResponse_reportPlanArn
- An Amazon Resource Name (ARN) that uniquely identifies a resource. The
format of the ARN depends on the resource type.
CreateReportPlan
, createReportPlanResponse_reportPlanName
- The unique name of the report plan.
$sel:httpStatus:CreateReportPlanResponse'
, createReportPlanResponse_httpStatus
- The response's http status code.
DeleteBackupPlan
data DeleteBackupPlan Source #
See: newDeleteBackupPlan
smart constructor.
Instances
Create a value of DeleteBackupPlan
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteBackupPlan
, deleteBackupPlan_backupPlanId
- Uniquely identifies a backup plan.
data DeleteBackupPlanResponse Source #
See: newDeleteBackupPlanResponse
smart constructor.
Instances
newDeleteBackupPlanResponse Source #
Create a value of DeleteBackupPlanResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteBackupPlanResponse
, deleteBackupPlanResponse_backupPlanArn
- 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
.
DeleteBackupPlan
, deleteBackupPlanResponse_backupPlanId
- Uniquely identifies a backup plan.
DeleteBackupPlanResponse
, deleteBackupPlanResponse_deletionDate
- 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.
DeleteBackupPlanResponse
, deleteBackupPlanResponse_versionId
- Unique, randomly generated, Unicode, UTF-8 encoded strings that are at
most 1,024 bytes long. Version IDs cannot be edited.
$sel:httpStatus:DeleteBackupPlanResponse'
, deleteBackupPlanResponse_httpStatus
- The response's http status code.
DeleteBackupSelection
data DeleteBackupSelection Source #
See: newDeleteBackupSelection
smart constructor.
Instances
newDeleteBackupSelection Source #
Create a value of DeleteBackupSelection
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteBackupSelection
, deleteBackupSelection_backupPlanId
- Uniquely identifies a backup plan.
DeleteBackupSelection
, deleteBackupSelection_selectionId
- Uniquely identifies the body of a request to assign a set of resources
to a backup plan.
data DeleteBackupSelectionResponse Source #
See: newDeleteBackupSelectionResponse
smart constructor.
Instances
newDeleteBackupSelectionResponse :: DeleteBackupSelectionResponse Source #
Create a value of DeleteBackupSelectionResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteBackupVault
data DeleteBackupVault Source #
See: newDeleteBackupVault
smart constructor.
Instances
Create a value of DeleteBackupVault
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteBackupVault
, deleteBackupVault_backupVaultName
- 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.
data DeleteBackupVaultResponse Source #
See: newDeleteBackupVaultResponse
smart constructor.
Instances
Generic DeleteBackupVaultResponse Source # | |
Defined in Amazonka.Backup.DeleteBackupVault type Rep DeleteBackupVaultResponse :: Type -> Type # | |
Read DeleteBackupVaultResponse Source # | |
Show DeleteBackupVaultResponse Source # | |
Defined in Amazonka.Backup.DeleteBackupVault showsPrec :: Int -> DeleteBackupVaultResponse -> ShowS # show :: DeleteBackupVaultResponse -> String # showList :: [DeleteBackupVaultResponse] -> ShowS # | |
NFData DeleteBackupVaultResponse Source # | |
Defined in Amazonka.Backup.DeleteBackupVault rnf :: DeleteBackupVaultResponse -> () # | |
Eq DeleteBackupVaultResponse Source # | |
Defined in Amazonka.Backup.DeleteBackupVault | |
type Rep DeleteBackupVaultResponse Source # | |
newDeleteBackupVaultResponse :: DeleteBackupVaultResponse Source #
Create a value of DeleteBackupVaultResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteBackupVaultAccessPolicy
data DeleteBackupVaultAccessPolicy Source #
See: newDeleteBackupVaultAccessPolicy
smart constructor.
Instances
newDeleteBackupVaultAccessPolicy Source #
Create a value of DeleteBackupVaultAccessPolicy
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteBackupVaultAccessPolicy
, deleteBackupVaultAccessPolicy_backupVaultName
- 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.
data DeleteBackupVaultAccessPolicyResponse Source #
See: newDeleteBackupVaultAccessPolicyResponse
smart constructor.
Instances
newDeleteBackupVaultAccessPolicyResponse :: DeleteBackupVaultAccessPolicyResponse Source #
Create a value of DeleteBackupVaultAccessPolicyResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteBackupVaultLockConfiguration
data DeleteBackupVaultLockConfiguration Source #
See: newDeleteBackupVaultLockConfiguration
smart constructor.
Instances
newDeleteBackupVaultLockConfiguration Source #
Create a value of DeleteBackupVaultLockConfiguration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteBackupVaultLockConfiguration
, deleteBackupVaultLockConfiguration_backupVaultName
- The name of the backup vault from which to delete Backup Vault Lock.
data DeleteBackupVaultLockConfigurationResponse Source #
See: newDeleteBackupVaultLockConfigurationResponse
smart constructor.
Instances
Generic DeleteBackupVaultLockConfigurationResponse Source # | |
Defined in Amazonka.Backup.DeleteBackupVaultLockConfiguration type Rep DeleteBackupVaultLockConfigurationResponse :: Type -> Type # | |
Read DeleteBackupVaultLockConfigurationResponse Source # | |
Show DeleteBackupVaultLockConfigurationResponse Source # | |
NFData DeleteBackupVaultLockConfigurationResponse Source # | |
Eq DeleteBackupVaultLockConfigurationResponse Source # | |
type Rep DeleteBackupVaultLockConfigurationResponse Source # | |
Defined in Amazonka.Backup.DeleteBackupVaultLockConfiguration type Rep DeleteBackupVaultLockConfigurationResponse = D1 ('MetaData "DeleteBackupVaultLockConfigurationResponse" "Amazonka.Backup.DeleteBackupVaultLockConfiguration" "amazonka-backup-2.0-LovIt41tphM6jvgQJhTyRf" 'False) (C1 ('MetaCons "DeleteBackupVaultLockConfigurationResponse'" 'PrefixI 'False) (U1 :: Type -> Type)) |
newDeleteBackupVaultLockConfigurationResponse :: DeleteBackupVaultLockConfigurationResponse Source #
Create a value of DeleteBackupVaultLockConfigurationResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteBackupVaultNotifications
data DeleteBackupVaultNotifications Source #
See: newDeleteBackupVaultNotifications
smart constructor.
Instances
newDeleteBackupVaultNotifications Source #
Create a value of DeleteBackupVaultNotifications
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteBackupVaultNotifications
, deleteBackupVaultNotifications_backupVaultName
- 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.
data DeleteBackupVaultNotificationsResponse Source #
See: newDeleteBackupVaultNotificationsResponse
smart constructor.
Instances
Generic DeleteBackupVaultNotificationsResponse Source # | |
Defined in Amazonka.Backup.DeleteBackupVaultNotifications type Rep DeleteBackupVaultNotificationsResponse :: Type -> Type # | |
Read DeleteBackupVaultNotificationsResponse Source # | |
Show DeleteBackupVaultNotificationsResponse Source # | |
NFData DeleteBackupVaultNotificationsResponse Source # | |
Defined in Amazonka.Backup.DeleteBackupVaultNotifications rnf :: DeleteBackupVaultNotificationsResponse -> () # | |
Eq DeleteBackupVaultNotificationsResponse Source # | |
type Rep DeleteBackupVaultNotificationsResponse Source # | |
Defined in Amazonka.Backup.DeleteBackupVaultNotifications type Rep DeleteBackupVaultNotificationsResponse = D1 ('MetaData "DeleteBackupVaultNotificationsResponse" "Amazonka.Backup.DeleteBackupVaultNotifications" "amazonka-backup-2.0-LovIt41tphM6jvgQJhTyRf" 'False) (C1 ('MetaCons "DeleteBackupVaultNotificationsResponse'" 'PrefixI 'False) (U1 :: Type -> Type)) |
newDeleteBackupVaultNotificationsResponse :: DeleteBackupVaultNotificationsResponse Source #
Create a value of DeleteBackupVaultNotificationsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteFramework
data DeleteFramework Source #
See: newDeleteFramework
smart constructor.
Instances
Create a value of DeleteFramework
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteFramework
, deleteFramework_frameworkName
- The unique name of a framework.
data DeleteFrameworkResponse Source #
See: newDeleteFrameworkResponse
smart constructor.
Instances
Generic DeleteFrameworkResponse Source # | |
Defined in Amazonka.Backup.DeleteFramework type Rep DeleteFrameworkResponse :: Type -> Type # | |
Read DeleteFrameworkResponse Source # | |
Show DeleteFrameworkResponse Source # | |
Defined in Amazonka.Backup.DeleteFramework showsPrec :: Int -> DeleteFrameworkResponse -> ShowS # show :: DeleteFrameworkResponse -> String # showList :: [DeleteFrameworkResponse] -> ShowS # | |
NFData DeleteFrameworkResponse Source # | |
Defined in Amazonka.Backup.DeleteFramework rnf :: DeleteFrameworkResponse -> () # | |
Eq DeleteFrameworkResponse Source # | |
Defined in Amazonka.Backup.DeleteFramework | |
type Rep DeleteFrameworkResponse Source # | |
newDeleteFrameworkResponse :: DeleteFrameworkResponse Source #
Create a value of DeleteFrameworkResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteRecoveryPoint
data DeleteRecoveryPoint Source #
See: newDeleteRecoveryPoint
smart constructor.
Instances
newDeleteRecoveryPoint Source #
Create a value of DeleteRecoveryPoint
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteRecoveryPoint
, deleteRecoveryPoint_backupVaultName
- 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.
DeleteRecoveryPoint
, deleteRecoveryPoint_recoveryPointArn
- 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
.
data DeleteRecoveryPointResponse Source #
See: newDeleteRecoveryPointResponse
smart constructor.
Instances
newDeleteRecoveryPointResponse :: DeleteRecoveryPointResponse Source #
Create a value of DeleteRecoveryPointResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteReportPlan
data DeleteReportPlan Source #
See: newDeleteReportPlan
smart constructor.
Instances
Create a value of DeleteReportPlan
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteReportPlan
, deleteReportPlan_reportPlanName
- The unique name of a report plan.
data DeleteReportPlanResponse Source #
See: newDeleteReportPlanResponse
smart constructor.
Instances
Generic DeleteReportPlanResponse Source # | |
Defined in Amazonka.Backup.DeleteReportPlan type Rep DeleteReportPlanResponse :: Type -> Type # | |
Read DeleteReportPlanResponse Source # | |
Show DeleteReportPlanResponse Source # | |
Defined in Amazonka.Backup.DeleteReportPlan showsPrec :: Int -> DeleteReportPlanResponse -> ShowS # show :: DeleteReportPlanResponse -> String # showList :: [DeleteReportPlanResponse] -> ShowS # | |
NFData DeleteReportPlanResponse Source # | |
Defined in Amazonka.Backup.DeleteReportPlan rnf :: DeleteReportPlanResponse -> () # | |
Eq DeleteReportPlanResponse Source # | |
Defined in Amazonka.Backup.DeleteReportPlan | |
type Rep DeleteReportPlanResponse Source # | |
newDeleteReportPlanResponse :: DeleteReportPlanResponse Source #
Create a value of DeleteReportPlanResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DescribeBackupJob
data DescribeBackupJob Source #
See: newDescribeBackupJob
smart constructor.
Instances
Create a value of DescribeBackupJob
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeBackupJob
, describeBackupJob_backupJobId
- Uniquely identifies a request to Backup to back up a resource.
data DescribeBackupJobResponse Source #
See: newDescribeBackupJobResponse
smart constructor.
DescribeBackupJobResponse' (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Integer) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe (HashMap BackupJobState Integer)) (Maybe POSIX) (Maybe RecoveryPointCreator) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Bool) (Maybe Integer) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe BackupJobState) (Maybe Text) Int |
Instances
newDescribeBackupJobResponse Source #
Create a value of DescribeBackupJobResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeBackupJobResponse
, describeBackupJobResponse_accountId
- Returns the account ID that owns the backup job.
DescribeBackupJob
, describeBackupJobResponse_backupJobId
- Uniquely identifies a request to Backup to back up a resource.
DescribeBackupJobResponse
, describeBackupJobResponse_backupOptions
- Represents the options specified as part of backup plan or on-demand
backup job.
DescribeBackupJobResponse
, describeBackupJobResponse_backupSizeInBytes
- The size, in bytes, of a backup.
DescribeBackupJobResponse
, describeBackupJobResponse_backupType
- 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.
DescribeBackupJobResponse
, describeBackupJobResponse_backupVaultArn
- An Amazon Resource Name (ARN) that uniquely identifies a backup vault;
for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault
.
DescribeBackupJobResponse
, describeBackupJobResponse_backupVaultName
- 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.
DescribeBackupJobResponse
, describeBackupJobResponse_bytesTransferred
- The size in bytes transferred to a backup vault at the time that the job
status was queried.
DescribeBackupJobResponse
, describeBackupJobResponse_childJobsInState
- This returns the statistics of the included child (nested) backup jobs.
DescribeBackupJobResponse
, describeBackupJobResponse_completionDate
- 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.
DescribeBackupJobResponse
, describeBackupJobResponse_createdBy
- 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.
DescribeBackupJobResponse
, describeBackupJobResponse_creationDate
- 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.
DescribeBackupJobResponse
, describeBackupJobResponse_expectedCompletionDate
- 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.
DescribeBackupJobResponse
, describeBackupJobResponse_iamRoleArn
- Specifies the IAM role ARN used to create the target recovery point; for
example, arn:aws:iam::123456789012:role/S3Access
.
DescribeBackupJobResponse
, describeBackupJobResponse_isParent
- This returns the boolean value that a backup job is a parent (composite)
job.
DescribeBackupJobResponse
, describeBackupJobResponse_numberOfChildJobs
- This returns the number of child (nested) backup jobs.
DescribeBackupJobResponse
, describeBackupJobResponse_parentJobId
- This returns the parent (composite) resource backup job ID.
DescribeBackupJobResponse
, describeBackupJobResponse_percentDone
- Contains an estimated percentage that is complete of a job at the time
the job status was queried.
DescribeBackupJobResponse
, describeBackupJobResponse_recoveryPointArn
- An ARN that uniquely identifies a recovery point; for example,
arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45
.
DescribeBackupJobResponse
, describeBackupJobResponse_resourceArn
- An ARN that uniquely identifies a saved resource. The format of the ARN
depends on the resource type.
DescribeBackupJobResponse
, describeBackupJobResponse_resourceType
- 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.
DescribeBackupJobResponse
, describeBackupJobResponse_startBy
- 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.
DescribeBackupJobResponse
, describeBackupJobResponse_state
- The current state of a resource recovery point.
DescribeBackupJobResponse
, describeBackupJobResponse_statusMessage
- A detailed message explaining the status of the job to back up a
resource.
$sel:httpStatus:DescribeBackupJobResponse'
, describeBackupJobResponse_httpStatus
- The response's http status code.
DescribeBackupVault
data DescribeBackupVault Source #
See: newDescribeBackupVault
smart constructor.
Instances
newDescribeBackupVault Source #
Create a value of DescribeBackupVault
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeBackupVault
, describeBackupVault_backupVaultName
- 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.
data DescribeBackupVaultResponse Source #
See: newDescribeBackupVaultResponse
smart constructor.
DescribeBackupVaultResponse' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Bool) (Maybe Integer) (Maybe Integer) (Maybe Integer) Int |
Instances
newDescribeBackupVaultResponse Source #
Create a value of DescribeBackupVaultResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeBackupVaultResponse
, describeBackupVaultResponse_backupVaultArn
- An Amazon Resource Name (ARN) that uniquely identifies a backup vault;
for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault
.
DescribeBackupVault
, describeBackupVaultResponse_backupVaultName
- 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.
DescribeBackupVaultResponse
, describeBackupVaultResponse_creationDate
- 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.
DescribeBackupVaultResponse
, describeBackupVaultResponse_creatorRequestId
- A unique string that identifies the request and allows failed requests
to be retried without the risk of running the operation twice.
DescribeBackupVaultResponse
, describeBackupVaultResponse_encryptionKeyArn
- 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
.
DescribeBackupVaultResponse
, describeBackupVaultResponse_lockDate
- 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.
DescribeBackupVaultResponse
, describeBackupVaultResponse_locked
- 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.
DescribeBackupVaultResponse
, describeBackupVaultResponse_maxRetentionDays
- 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.
DescribeBackupVaultResponse
, describeBackupVaultResponse_minRetentionDays
- 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 does 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.
DescribeBackupVaultResponse
, describeBackupVaultResponse_numberOfRecoveryPoints
- The number of recovery points that are stored in a backup vault.
$sel:httpStatus:DescribeBackupVaultResponse'
, describeBackupVaultResponse_httpStatus
- The response's http status code.
DescribeCopyJob
data DescribeCopyJob Source #
See: newDescribeCopyJob
smart constructor.
Instances
Create a value of DescribeCopyJob
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeCopyJob
, describeCopyJob_copyJobId
- Uniquely identifies a copy job.
data DescribeCopyJobResponse Source #
See: newDescribeCopyJobResponse
smart constructor.
Instances
newDescribeCopyJobResponse Source #
Create a value of DescribeCopyJobResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:copyJob:DescribeCopyJobResponse'
, describeCopyJobResponse_copyJob
- Contains detailed information about a copy job.
$sel:httpStatus:DescribeCopyJobResponse'
, describeCopyJobResponse_httpStatus
- The response's http status code.
DescribeFramework
data DescribeFramework Source #
See: newDescribeFramework
smart constructor.
Instances
Create a value of DescribeFramework
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeFramework
, describeFramework_frameworkName
- The unique name of a framework.
data DescribeFrameworkResponse Source #
See: newDescribeFrameworkResponse
smart constructor.
DescribeFrameworkResponse' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe [FrameworkControl]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Int |
Instances
newDescribeFrameworkResponse Source #
Create a value of DescribeFrameworkResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeFrameworkResponse
, describeFrameworkResponse_creationTime
- 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.
DescribeFrameworkResponse
, describeFrameworkResponse_deploymentStatus
- The deployment status of a framework. The statuses are:
CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED
DescribeFrameworkResponse
, describeFrameworkResponse_frameworkArn
- An Amazon Resource Name (ARN) that uniquely identifies a resource. The
format of the ARN depends on the resource type.
$sel:frameworkControls:DescribeFrameworkResponse'
, describeFrameworkResponse_frameworkControls
- A list of the controls that make up the framework. Each control in the
list has a name, input parameters, and scope.
DescribeFrameworkResponse
, describeFrameworkResponse_frameworkDescription
- An optional description of the framework.
DescribeFramework
, describeFrameworkResponse_frameworkName
- The unique name of a framework.
$sel:frameworkStatus:DescribeFrameworkResponse'
, describeFrameworkResponse_frameworkStatus
- 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.
$sel:idempotencyToken:DescribeFrameworkResponse'
, describeFrameworkResponse_idempotencyToken
- 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.
$sel:httpStatus:DescribeFrameworkResponse'
, describeFrameworkResponse_httpStatus
- The response's http status code.
DescribeGlobalSettings
data DescribeGlobalSettings Source #
See: newDescribeGlobalSettings
smart constructor.
Instances
newDescribeGlobalSettings :: DescribeGlobalSettings Source #
Create a value of DescribeGlobalSettings
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
data DescribeGlobalSettingsResponse Source #
See: newDescribeGlobalSettingsResponse
smart constructor.
Instances
newDescribeGlobalSettingsResponse Source #
Create a value of DescribeGlobalSettingsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:globalSettings:DescribeGlobalSettingsResponse'
, describeGlobalSettingsResponse_globalSettings
- The status of the flag isCrossAccountBackupEnabled
.
$sel:lastUpdateTime:DescribeGlobalSettingsResponse'
, describeGlobalSettingsResponse_lastUpdateTime
- 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.
$sel:httpStatus:DescribeGlobalSettingsResponse'
, describeGlobalSettingsResponse_httpStatus
- The response's http status code.
DescribeProtectedResource
data DescribeProtectedResource Source #
See: newDescribeProtectedResource
smart constructor.
Instances
newDescribeProtectedResource Source #
Create a value of DescribeProtectedResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeProtectedResource
, describeProtectedResource_resourceArn
- An Amazon Resource Name (ARN) that uniquely identifies a resource. The
format of the ARN depends on the resource type.
data DescribeProtectedResourceResponse Source #
See: newDescribeProtectedResourceResponse
smart constructor.
Instances
newDescribeProtectedResourceResponse Source #
Create a value of DescribeProtectedResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeProtectedResourceResponse
, describeProtectedResourceResponse_lastBackupTime
- 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.
DescribeProtectedResource
, describeProtectedResourceResponse_resourceArn
- An ARN that uniquely identifies a resource. The format of the ARN
depends on the resource type.
DescribeProtectedResourceResponse
, describeProtectedResourceResponse_resourceType
- The type of Amazon Web Services resource saved as a recovery point; for
example, an Amazon EBS volume or an Amazon RDS database.
$sel:httpStatus:DescribeProtectedResourceResponse'
, describeProtectedResourceResponse_httpStatus
- The response's http status code.
DescribeRecoveryPoint
data DescribeRecoveryPoint Source #
See: newDescribeRecoveryPoint
smart constructor.
Instances
newDescribeRecoveryPoint Source #
Create a value of DescribeRecoveryPoint
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeRecoveryPoint
, describeRecoveryPoint_backupVaultName
- 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.
DescribeRecoveryPoint
, describeRecoveryPoint_recoveryPointArn
- 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
.
data DescribeRecoveryPointResponse Source #
See: newDescribeRecoveryPointResponse
smart constructor.
DescribeRecoveryPointResponse' (Maybe Integer) (Maybe Text) (Maybe Text) (Maybe CalculatedLifecycle) (Maybe POSIX) (Maybe Text) (Maybe RecoveryPointCreator) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe POSIX) (Maybe Lifecycle) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe RecoveryPointStatus) (Maybe Text) (Maybe StorageClass) Int |
Instances
newDescribeRecoveryPointResponse Source #
Create a value of DescribeRecoveryPointResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeRecoveryPointResponse
, describeRecoveryPointResponse_backupSizeInBytes
- The size, in bytes, of a backup.
DescribeRecoveryPointResponse
, describeRecoveryPointResponse_backupVaultArn
- An ARN that uniquely identifies a backup vault; for example,
arn:aws:backup:us-east-1:123456789012:vault:aBackupVault
.
DescribeRecoveryPoint
, describeRecoveryPointResponse_backupVaultName
- 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.
DescribeRecoveryPointResponse
, describeRecoveryPointResponse_calculatedLifecycle
- A CalculatedLifecycle
object containing DeleteAt
and
MoveToColdStorageAt
timestamps.
DescribeRecoveryPointResponse
, describeRecoveryPointResponse_completionDate
- 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.
DescribeRecoveryPointResponse
, describeRecoveryPointResponse_compositeMemberIdentifier
- This is 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.
DescribeRecoveryPointResponse
, describeRecoveryPointResponse_createdBy
- 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.
DescribeRecoveryPointResponse
, describeRecoveryPointResponse_creationDate
- 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.
DescribeRecoveryPointResponse
, describeRecoveryPointResponse_encryptionKeyArn
- 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
.
DescribeRecoveryPointResponse
, describeRecoveryPointResponse_iamRoleArn
- Specifies the IAM role ARN used to create the target recovery point; for
example, arn:aws:iam::123456789012:role/S3Access
.
DescribeRecoveryPointResponse
, describeRecoveryPointResponse_isEncrypted
- A Boolean value that is returned as TRUE
if the specified recovery
point is encrypted, or FALSE
if the recovery point is not encrypted.
DescribeRecoveryPointResponse
, describeRecoveryPointResponse_isParent
- This returns the boolean value that a recovery point is a parent
(composite) job.
DescribeRecoveryPointResponse
, describeRecoveryPointResponse_lastRestoreTime
- 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.
DescribeRecoveryPointResponse
, describeRecoveryPointResponse_lifecycle
- 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 are able to be transitioned to cold storage are listed in the "Lifecycle to cold storage" section of the Feature availability by resource table. Backup ignores this expression for other resource types.
DescribeRecoveryPointResponse
, describeRecoveryPointResponse_parentRecoveryPointArn
- 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
.
DescribeRecoveryPoint
, describeRecoveryPointResponse_recoveryPointArn
- An ARN that uniquely identifies a recovery point; for example,
arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45
.
DescribeRecoveryPointResponse
, describeRecoveryPointResponse_resourceArn
- An ARN that uniquely identifies a saved resource. The format of the ARN
depends on the resource type.
DescribeRecoveryPointResponse
, describeRecoveryPointResponse_resourceType
- 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.
DescribeRecoveryPointResponse
, describeRecoveryPointResponse_sourceBackupVaultArn
- An Amazon Resource Name (ARN) that uniquely identifies the source vault
where the resource was originally backed up in; for example,
arn:aws:backup:us-east-1:123456789012:vault:BackupVault
. If the
recovery is restored to the same Amazon Web Services account or Region,
this value will be null
.
DescribeRecoveryPointResponse
, describeRecoveryPointResponse_status
- 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.
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.
DescribeRecoveryPointResponse
, describeRecoveryPointResponse_statusMessage
- A status message explaining the reason for the recovery point deletion
failure.
$sel:storageClass:DescribeRecoveryPointResponse'
, describeRecoveryPointResponse_storageClass
- Specifies the storage class of the recovery point. Valid values are
WARM
or COLD
.
$sel:httpStatus:DescribeRecoveryPointResponse'
, describeRecoveryPointResponse_httpStatus
- The response's http status code.
DescribeRegionSettings
data DescribeRegionSettings Source #
See: newDescribeRegionSettings
smart constructor.
Instances
newDescribeRegionSettings :: DescribeRegionSettings Source #
Create a value of DescribeRegionSettings
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
data DescribeRegionSettingsResponse Source #
See: newDescribeRegionSettingsResponse
smart constructor.
Instances
newDescribeRegionSettingsResponse Source #
Create a value of DescribeRegionSettingsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceTypeManagementPreference:DescribeRegionSettingsResponse'
, describeRegionSettingsResponse_resourceTypeManagementPreference
- 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.
$sel:resourceTypeOptInPreference:DescribeRegionSettingsResponse'
, describeRegionSettingsResponse_resourceTypeOptInPreference
- Returns a list of all services along with the opt-in preferences in the
Region.
$sel:httpStatus:DescribeRegionSettingsResponse'
, describeRegionSettingsResponse_httpStatus
- The response's http status code.
DescribeReportJob
data DescribeReportJob Source #
See: newDescribeReportJob
smart constructor.
Instances
Create a value of DescribeReportJob
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeReportJob
, describeReportJob_reportJobId
- 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.
data DescribeReportJobResponse Source #
See: newDescribeReportJobResponse
smart constructor.
Instances
newDescribeReportJobResponse Source #
Create a value of DescribeReportJobResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:reportJob:DescribeReportJobResponse'
, describeReportJobResponse_reportJob
- A list of information about a report job, including its completion and
creation times, report destination, unique report job ID, Amazon
Resource Name (ARN), report template, status, and status message.
$sel:httpStatus:DescribeReportJobResponse'
, describeReportJobResponse_httpStatus
- The response's http status code.
DescribeReportPlan
data DescribeReportPlan Source #
See: newDescribeReportPlan
smart constructor.
Instances
newDescribeReportPlan Source #
Create a value of DescribeReportPlan
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeReportPlan
, describeReportPlan_reportPlanName
- The unique name of a report plan.
data DescribeReportPlanResponse Source #
See: newDescribeReportPlanResponse
smart constructor.
Instances
newDescribeReportPlanResponse Source #
Create a value of DescribeReportPlanResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:reportPlan:DescribeReportPlanResponse'
, describeReportPlanResponse_reportPlan
- 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.
$sel:httpStatus:DescribeReportPlanResponse'
, describeReportPlanResponse_httpStatus
- The response's http status code.
DescribeRestoreJob
data DescribeRestoreJob Source #
See: newDescribeRestoreJob
smart constructor.
Instances
newDescribeRestoreJob Source #
Create a value of DescribeRestoreJob
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeRestoreJob
, describeRestoreJob_restoreJobId
- Uniquely identifies the job that restores a recovery point.
data DescribeRestoreJobResponse Source #
See: newDescribeRestoreJobResponse
smart constructor.
DescribeRestoreJobResponse' (Maybe Text) (Maybe Integer) (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe Integer) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe RestoreJobStatus) (Maybe Text) Int |
Instances
newDescribeRestoreJobResponse Source #
Create a value of DescribeRestoreJobResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeRestoreJobResponse
, describeRestoreJobResponse_accountId
- Returns the account ID that owns the restore job.
DescribeRestoreJobResponse
, describeRestoreJobResponse_backupSizeInBytes
- The size, in bytes, of the restored resource.
DescribeRestoreJobResponse
, describeRestoreJobResponse_completionDate
- 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.
DescribeRestoreJobResponse
, describeRestoreJobResponse_createdResourceArn
- An Amazon Resource Name (ARN) that uniquely identifies a resource whose
recovery point is being restored. The format of the ARN depends on the
resource type of the backed-up resource.
DescribeRestoreJobResponse
, describeRestoreJobResponse_creationDate
- 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.
DescribeRestoreJobResponse
, describeRestoreJobResponse_expectedCompletionTimeMinutes
- The amount of time in minutes that a job restoring a recovery point is
expected to take.
DescribeRestoreJobResponse
, describeRestoreJobResponse_iamRoleArn
- Specifies the IAM role ARN used to create the target recovery point; for
example, arn:aws:iam::123456789012:role/S3Access
.
DescribeRestoreJobResponse
, describeRestoreJobResponse_percentDone
- Contains an estimated percentage that is complete of a job at the time
the job status was queried.
DescribeRestoreJobResponse
, describeRestoreJobResponse_recoveryPointArn
- An ARN that uniquely identifies a recovery point; for example,
arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45
.
DescribeRestoreJobResponse
, describeRestoreJobResponse_resourceType
- Returns metadata associated with a restore job listed by resource type.
DescribeRestoreJob
, describeRestoreJobResponse_restoreJobId
- Uniquely identifies the job that restores a recovery point.
DescribeRestoreJobResponse
, describeRestoreJobResponse_status
- Status code specifying the state of the job that is initiated by Backup
to restore a recovery point.
DescribeRestoreJobResponse
, describeRestoreJobResponse_statusMessage
- A message showing the status of a job to restore a recovery point.
$sel:httpStatus:DescribeRestoreJobResponse'
, describeRestoreJobResponse_httpStatus
- The response's http status code.
DisassociateRecoveryPoint
data DisassociateRecoveryPoint Source #
See: newDisassociateRecoveryPoint
smart constructor.
Instances
newDisassociateRecoveryPoint Source #
Create a value of DisassociateRecoveryPoint
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DisassociateRecoveryPoint
, disassociateRecoveryPoint_backupVaultName
- The unique name of an Backup vault.
DisassociateRecoveryPoint
, disassociateRecoveryPoint_recoveryPointArn
- An Amazon Resource Name (ARN) that uniquely identifies an Backup
recovery point.
data DisassociateRecoveryPointResponse Source #
See: newDisassociateRecoveryPointResponse
smart constructor.
Instances
newDisassociateRecoveryPointResponse :: DisassociateRecoveryPointResponse Source #
Create a value of DisassociateRecoveryPointResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DisassociateRecoveryPointFromParent
data DisassociateRecoveryPointFromParent Source #
See: newDisassociateRecoveryPointFromParent
smart constructor.
Instances
newDisassociateRecoveryPointFromParent Source #
Create a value of DisassociateRecoveryPointFromParent
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DisassociateRecoveryPointFromParent
, disassociateRecoveryPointFromParent_backupVaultName
- This is 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. They consist of lowercase letters,
numbers, and hyphens.
DisassociateRecoveryPointFromParent
, disassociateRecoveryPointFromParent_recoveryPointArn
- This is 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.
data DisassociateRecoveryPointFromParentResponse Source #
See: newDisassociateRecoveryPointFromParentResponse
smart constructor.
Instances
Generic DisassociateRecoveryPointFromParentResponse Source # | |
Defined in Amazonka.Backup.DisassociateRecoveryPointFromParent type Rep DisassociateRecoveryPointFromParentResponse :: Type -> Type # | |
Read DisassociateRecoveryPointFromParentResponse Source # | |
Show DisassociateRecoveryPointFromParentResponse Source # | |
NFData DisassociateRecoveryPointFromParentResponse Source # | |
Eq DisassociateRecoveryPointFromParentResponse Source # | |
type Rep DisassociateRecoveryPointFromParentResponse Source # | |
Defined in Amazonka.Backup.DisassociateRecoveryPointFromParent type Rep DisassociateRecoveryPointFromParentResponse = D1 ('MetaData "DisassociateRecoveryPointFromParentResponse" "Amazonka.Backup.DisassociateRecoveryPointFromParent" "amazonka-backup-2.0-LovIt41tphM6jvgQJhTyRf" 'False) (C1 ('MetaCons "DisassociateRecoveryPointFromParentResponse'" 'PrefixI 'False) (U1 :: Type -> Type)) |
newDisassociateRecoveryPointFromParentResponse :: DisassociateRecoveryPointFromParentResponse Source #
Create a value of DisassociateRecoveryPointFromParentResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
ExportBackupPlanTemplate
data ExportBackupPlanTemplate Source #
See: newExportBackupPlanTemplate
smart constructor.
Instances
newExportBackupPlanTemplate Source #
Create a value of ExportBackupPlanTemplate
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ExportBackupPlanTemplate
, exportBackupPlanTemplate_backupPlanId
- Uniquely identifies a backup plan.
data ExportBackupPlanTemplateResponse Source #
See: newExportBackupPlanTemplateResponse
smart constructor.
Instances
Generic ExportBackupPlanTemplateResponse Source # | |
Read ExportBackupPlanTemplateResponse Source # | |
Show ExportBackupPlanTemplateResponse Source # | |
Defined in Amazonka.Backup.ExportBackupPlanTemplate | |
NFData ExportBackupPlanTemplateResponse Source # | |
Defined in Amazonka.Backup.ExportBackupPlanTemplate rnf :: ExportBackupPlanTemplateResponse -> () # | |
Eq ExportBackupPlanTemplateResponse Source # | |
type Rep ExportBackupPlanTemplateResponse Source # | |
Defined in Amazonka.Backup.ExportBackupPlanTemplate type Rep ExportBackupPlanTemplateResponse = D1 ('MetaData "ExportBackupPlanTemplateResponse" "Amazonka.Backup.ExportBackupPlanTemplate" "amazonka-backup-2.0-LovIt41tphM6jvgQJhTyRf" 'False) (C1 ('MetaCons "ExportBackupPlanTemplateResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "backupPlanTemplateJson") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newExportBackupPlanTemplateResponse Source #
Create a value of ExportBackupPlanTemplateResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:backupPlanTemplateJson:ExportBackupPlanTemplateResponse'
, exportBackupPlanTemplateResponse_backupPlanTemplateJson
- The body of a backup plan template in JSON format.
This is a signed JSON document that cannot be modified before being
passed to GetBackupPlanFromJSON.
$sel:httpStatus:ExportBackupPlanTemplateResponse'
, exportBackupPlanTemplateResponse_httpStatus
- The response's http status code.
GetBackupPlan
data GetBackupPlan Source #
See: newGetBackupPlan
smart constructor.
Instances
Create a value of GetBackupPlan
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetBackupPlan
, getBackupPlan_versionId
- Unique, randomly generated, Unicode, UTF-8 encoded strings that are at
most 1,024 bytes long. Version IDs cannot be edited.
GetBackupPlan
, getBackupPlan_backupPlanId
- Uniquely identifies a backup plan.
data GetBackupPlanResponse Source #
See: newGetBackupPlanResponse
smart constructor.
GetBackupPlanResponse' (Maybe [AdvancedBackupSetting]) (Maybe BackupPlan) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe Text) Int |
Instances
newGetBackupPlanResponse Source #
Create a value of GetBackupPlanResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetBackupPlanResponse
, getBackupPlanResponse_advancedBackupSettings
- Contains a list of BackupOptions
for each resource type. The list is
populated only if the advanced option is set for the backup plan.
$sel:backupPlan:GetBackupPlanResponse'
, getBackupPlanResponse_backupPlan
- Specifies the body of a backup plan. Includes a BackupPlanName
and one
or more sets of Rules
.
GetBackupPlanResponse
, getBackupPlanResponse_backupPlanArn
- 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
.
GetBackupPlan
, getBackupPlanResponse_backupPlanId
- Uniquely identifies a backup plan.
GetBackupPlanResponse
, getBackupPlanResponse_creationDate
- 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.
GetBackupPlanResponse
, getBackupPlanResponse_creatorRequestId
- A unique string that identifies the request and allows failed requests
to be retried without the risk of running the operation twice.
GetBackupPlanResponse
, getBackupPlanResponse_deletionDate
- 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.
GetBackupPlanResponse
, getBackupPlanResponse_lastExecutionDate
- The last time a job to back up resources was run with this backup plan.
A date and time, in Unix format and Coordinated Universal Time (UTC).
The value of LastExecutionDate
is accurate to milliseconds. For
example, the value 1516925490.087 represents Friday, January 26, 2018
12:11:30.087 AM.
GetBackupPlan
, getBackupPlanResponse_versionId
- Unique, randomly generated, Unicode, UTF-8 encoded strings that are at
most 1,024 bytes long. Version IDs cannot be edited.
$sel:httpStatus:GetBackupPlanResponse'
, getBackupPlanResponse_httpStatus
- The response's http status code.
GetBackupPlanFromJSON
data GetBackupPlanFromJSON Source #
See: newGetBackupPlanFromJSON
smart constructor.
Instances
newGetBackupPlanFromJSON Source #
Create a value of GetBackupPlanFromJSON
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:backupPlanTemplateJson:GetBackupPlanFromJSON'
, getBackupPlanFromJSON_backupPlanTemplateJson
- A customer-supplied backup plan document in JSON format.
data GetBackupPlanFromJSONResponse Source #
See: newGetBackupPlanFromJSONResponse
smart constructor.
Instances
newGetBackupPlanFromJSONResponse Source #
Create a value of GetBackupPlanFromJSONResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:backupPlan:GetBackupPlanFromJSONResponse'
, getBackupPlanFromJSONResponse_backupPlan
- Specifies the body of a backup plan. Includes a BackupPlanName
and one
or more sets of Rules
.
$sel:httpStatus:GetBackupPlanFromJSONResponse'
, getBackupPlanFromJSONResponse_httpStatus
- The response's http status code.
GetBackupPlanFromTemplate
data GetBackupPlanFromTemplate Source #
See: newGetBackupPlanFromTemplate
smart constructor.
Instances
newGetBackupPlanFromTemplate Source #
Create a value of GetBackupPlanFromTemplate
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetBackupPlanFromTemplate
, getBackupPlanFromTemplate_backupPlanTemplateId
- Uniquely identifies a stored backup plan template.
data GetBackupPlanFromTemplateResponse Source #
See: newGetBackupPlanFromTemplateResponse
smart constructor.
Instances
Generic GetBackupPlanFromTemplateResponse Source # | |
Show GetBackupPlanFromTemplateResponse Source # | |
NFData GetBackupPlanFromTemplateResponse Source # | |
Defined in Amazonka.Backup.GetBackupPlanFromTemplate rnf :: GetBackupPlanFromTemplateResponse -> () # | |
Eq GetBackupPlanFromTemplateResponse Source # | |
type Rep GetBackupPlanFromTemplateResponse Source # | |
Defined in Amazonka.Backup.GetBackupPlanFromTemplate type Rep GetBackupPlanFromTemplateResponse = D1 ('MetaData "GetBackupPlanFromTemplateResponse" "Amazonka.Backup.GetBackupPlanFromTemplate" "amazonka-backup-2.0-LovIt41tphM6jvgQJhTyRf" 'False) (C1 ('MetaCons "GetBackupPlanFromTemplateResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "backupPlanDocument") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BackupPlan)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newGetBackupPlanFromTemplateResponse Source #
Create a value of GetBackupPlanFromTemplateResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:backupPlanDocument:GetBackupPlanFromTemplateResponse'
, getBackupPlanFromTemplateResponse_backupPlanDocument
- Returns the body of a backup plan based on the target template,
including the name, rules, and backup vault of the plan.
$sel:httpStatus:GetBackupPlanFromTemplateResponse'
, getBackupPlanFromTemplateResponse_httpStatus
- The response's http status code.
GetBackupSelection
data GetBackupSelection Source #
See: newGetBackupSelection
smart constructor.
Instances
newGetBackupSelection Source #
Create a value of GetBackupSelection
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetBackupSelection
, getBackupSelection_backupPlanId
- Uniquely identifies a backup plan.
GetBackupSelection
, getBackupSelection_selectionId
- Uniquely identifies the body of a request to assign a set of resources
to a backup plan.
data GetBackupSelectionResponse Source #
See: newGetBackupSelectionResponse
smart constructor.
GetBackupSelectionResponse' (Maybe Text) (Maybe BackupSelection) (Maybe POSIX) (Maybe Text) (Maybe Text) Int |
Instances
newGetBackupSelectionResponse Source #
Create a value of GetBackupSelectionResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetBackupSelection
, getBackupSelectionResponse_backupPlanId
- Uniquely identifies a backup plan.
$sel:backupSelection:GetBackupSelectionResponse'
, getBackupSelectionResponse_backupSelection
- Specifies the body of a request to assign a set of resources to a backup
plan.
GetBackupSelectionResponse
, getBackupSelectionResponse_creationDate
- 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.
GetBackupSelectionResponse
, getBackupSelectionResponse_creatorRequestId
- A unique string that identifies the request and allows failed requests
to be retried without the risk of running the operation twice.
GetBackupSelection
, getBackupSelectionResponse_selectionId
- Uniquely identifies the body of a request to assign a set of resources
to a backup plan.
$sel:httpStatus:GetBackupSelectionResponse'
, getBackupSelectionResponse_httpStatus
- The response's http status code.
GetBackupVaultAccessPolicy
data GetBackupVaultAccessPolicy Source #
See: newGetBackupVaultAccessPolicy
smart constructor.
Instances
newGetBackupVaultAccessPolicy Source #
Create a value of GetBackupVaultAccessPolicy
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetBackupVaultAccessPolicy
, getBackupVaultAccessPolicy_backupVaultName
- 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.
data GetBackupVaultAccessPolicyResponse Source #
See: newGetBackupVaultAccessPolicyResponse
smart constructor.
Instances
newGetBackupVaultAccessPolicyResponse Source #
Create a value of GetBackupVaultAccessPolicyResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetBackupVaultAccessPolicyResponse
, getBackupVaultAccessPolicyResponse_backupVaultArn
- An Amazon Resource Name (ARN) that uniquely identifies a backup vault;
for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault
.
GetBackupVaultAccessPolicy
, getBackupVaultAccessPolicyResponse_backupVaultName
- 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.
$sel:policy:GetBackupVaultAccessPolicyResponse'
, getBackupVaultAccessPolicyResponse_policy
- The backup vault access policy document in JSON format.
$sel:httpStatus:GetBackupVaultAccessPolicyResponse'
, getBackupVaultAccessPolicyResponse_httpStatus
- The response's http status code.
GetBackupVaultNotifications
data GetBackupVaultNotifications Source #
See: newGetBackupVaultNotifications
smart constructor.
Instances
newGetBackupVaultNotifications Source #
Create a value of GetBackupVaultNotifications
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetBackupVaultNotifications
, getBackupVaultNotifications_backupVaultName
- 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.
data GetBackupVaultNotificationsResponse Source #
See: newGetBackupVaultNotificationsResponse
smart constructor.
GetBackupVaultNotificationsResponse' (Maybe Text) (Maybe [BackupVaultEvent]) (Maybe Text) (Maybe Text) Int |
Instances
newGetBackupVaultNotificationsResponse Source #
Create a value of GetBackupVaultNotificationsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetBackupVaultNotificationsResponse
, getBackupVaultNotificationsResponse_backupVaultArn
- An Amazon Resource Name (ARN) that uniquely identifies a backup vault;
for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault
.
$sel:backupVaultEvents:GetBackupVaultNotificationsResponse'
, getBackupVaultNotificationsResponse_backupVaultEvents
- An array of events that indicate the status of jobs to back up resources
to the backup vault.
GetBackupVaultNotifications
, getBackupVaultNotificationsResponse_backupVaultName
- 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.
$sel:sNSTopicArn:GetBackupVaultNotificationsResponse'
, getBackupVaultNotificationsResponse_sNSTopicArn
- An ARN that uniquely identifies an Amazon Simple Notification Service
(Amazon SNS) topic; for example,
arn:aws:sns:us-west-2:111122223333:MyTopic
.
$sel:httpStatus:GetBackupVaultNotificationsResponse'
, getBackupVaultNotificationsResponse_httpStatus
- The response's http status code.
GetLegalHold
data GetLegalHold Source #
See: newGetLegalHold
smart constructor.
Instances
Create a value of GetLegalHold
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetLegalHold
, getLegalHold_legalHoldId
- This is the ID required to use GetLegalHold
. This unique ID is
associated with a specific legal hold.
data GetLegalHoldResponse Source #
See: newGetLegalHoldResponse
smart constructor.
GetLegalHoldResponse' (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe RecoveryPointSelection) (Maybe POSIX) (Maybe LegalHoldStatus) (Maybe Text) Int |
Instances
newGetLegalHoldResponse Source #
Create a value of GetLegalHoldResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:cancelDescription:GetLegalHoldResponse'
, getLegalHoldResponse_cancelDescription
- String describing the reason for removing the legal hold.
GetLegalHoldResponse
, getLegalHoldResponse_cancellationDate
- Time in number when legal hold was cancelled.
GetLegalHoldResponse
, getLegalHoldResponse_creationDate
- Time in number format when legal hold was created.
GetLegalHoldResponse
, getLegalHoldResponse_description
- This is the returned string description of the legal hold.
GetLegalHoldResponse
, getLegalHoldResponse_legalHoldArn
- This is the returned framework ARN for the specified legal hold. An
Amazon Resource Name (ARN) uniquely identifies a resource. The format of
the ARN depends on the resource type.
GetLegalHold
, getLegalHoldResponse_legalHoldId
- This is the returned ID associated with a specified legal hold.
$sel:recoveryPointSelection:GetLegalHoldResponse'
, getLegalHoldResponse_recoveryPointSelection
- This specifies criteria to assign a set of resources, such as resource
types or backup vaults.
$sel:retainRecordUntil:GetLegalHoldResponse'
, getLegalHoldResponse_retainRecordUntil
- This is the date and time until which the legal hold record will be
retained.
GetLegalHoldResponse
, getLegalHoldResponse_status
- This is the status of the legal hold. Statuses can be ACTIVE
,
CREATING
, CANCELED
, and CANCELING
.
GetLegalHoldResponse
, getLegalHoldResponse_title
- This is the string title of the legal hold.
$sel:httpStatus:GetLegalHoldResponse'
, getLegalHoldResponse_httpStatus
- The response's http status code.
GetRecoveryPointRestoreMetadata
data GetRecoveryPointRestoreMetadata Source #
See: newGetRecoveryPointRestoreMetadata
smart constructor.
Instances
newGetRecoveryPointRestoreMetadata Source #
Create a value of GetRecoveryPointRestoreMetadata
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetRecoveryPointRestoreMetadata
, getRecoveryPointRestoreMetadata_backupVaultName
- 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.
GetRecoveryPointRestoreMetadata
, getRecoveryPointRestoreMetadata_recoveryPointArn
- 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
.
data GetRecoveryPointRestoreMetadataResponse Source #
See: newGetRecoveryPointRestoreMetadataResponse
smart constructor.
GetRecoveryPointRestoreMetadataResponse' (Maybe Text) (Maybe Text) (Maybe (Sensitive (HashMap Text Text))) Int |
Instances
newGetRecoveryPointRestoreMetadataResponse Source #
Create a value of GetRecoveryPointRestoreMetadataResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetRecoveryPointRestoreMetadataResponse
, getRecoveryPointRestoreMetadataResponse_backupVaultArn
- An ARN that uniquely identifies a backup vault; for example,
arn:aws:backup:us-east-1:123456789012:vault:aBackupVault
.
GetRecoveryPointRestoreMetadata
, getRecoveryPointRestoreMetadataResponse_recoveryPointArn
- An ARN that uniquely identifies a recovery point; for example,
arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45
.
$sel:restoreMetadata:GetRecoveryPointRestoreMetadataResponse'
, getRecoveryPointRestoreMetadataResponse_restoreMetadata
- The set of metadata key-value pairs that describe the original
configuration of the backed-up resource. These values vary depending on
the service that is being restored.
$sel:httpStatus:GetRecoveryPointRestoreMetadataResponse'
, getRecoveryPointRestoreMetadataResponse_httpStatus
- The response's http status code.
GetSupportedResourceTypes
data GetSupportedResourceTypes Source #
See: newGetSupportedResourceTypes
smart constructor.
Instances
newGetSupportedResourceTypes :: GetSupportedResourceTypes Source #
Create a value of GetSupportedResourceTypes
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
data GetSupportedResourceTypesResponse Source #
See: newGetSupportedResourceTypesResponse
smart constructor.
Instances
Generic GetSupportedResourceTypesResponse Source # | |
Read GetSupportedResourceTypesResponse Source # | |
Show GetSupportedResourceTypesResponse Source # | |
NFData GetSupportedResourceTypesResponse Source # | |
Defined in Amazonka.Backup.GetSupportedResourceTypes rnf :: GetSupportedResourceTypesResponse -> () # | |
Eq GetSupportedResourceTypesResponse Source # | |
type Rep GetSupportedResourceTypesResponse Source # | |
Defined in Amazonka.Backup.GetSupportedResourceTypes type Rep GetSupportedResourceTypesResponse = D1 ('MetaData "GetSupportedResourceTypesResponse" "Amazonka.Backup.GetSupportedResourceTypes" "amazonka-backup-2.0-LovIt41tphM6jvgQJhTyRf" 'False) (C1 ('MetaCons "GetSupportedResourceTypesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "resourceTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newGetSupportedResourceTypesResponse Source #
Create a value of GetSupportedResourceTypesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceTypes:GetSupportedResourceTypesResponse'
, getSupportedResourceTypesResponse_resourceTypes
- Contains a string with the supported Amazon Web Services resource types:
Aurora
for Amazon AuroraDynamoDB
for Amazon DynamoDBEBS
for Amazon Elastic Block StoreEC2
for Amazon Elastic Compute CloudEFS
for Amazon Elastic File SystemFSX
for Amazon FSxRDS
for Amazon Relational Database ServiceStorage Gateway
for Storage GatewayDocDB
for Amazon DocumentDB (with MongoDB compatibility)Neptune
for Amazon Neptune
$sel:httpStatus:GetSupportedResourceTypesResponse'
, getSupportedResourceTypesResponse_httpStatus
- The response's http status code.
ListBackupJobs (Paginated)
data ListBackupJobs Source #
See: newListBackupJobs
smart constructor.
ListBackupJobs' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe BackupJobState) (Maybe Natural) (Maybe Text) |
Instances
newListBackupJobs :: ListBackupJobs Source #
Create a value of ListBackupJobs
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:byAccountId:ListBackupJobs'
, listBackupJobs_byAccountId
- The account ID to list the jobs from. Returns only backup jobs
associated with the specified account ID.
If used from an Organizations management account, passing *
returns
all jobs across the organization.
$sel:byBackupVaultName:ListBackupJobs'
, listBackupJobs_byBackupVaultName
- Returns only backup jobs that will be stored in the specified backup
vault. Backup vaults are identified by names that are unique to the
account used to create them and the Amazon Web Services Region where
they are created. They consist of lowercase letters, numbers, and
hyphens.
$sel:byCompleteAfter:ListBackupJobs'
, listBackupJobs_byCompleteAfter
- Returns only backup jobs completed after a date expressed in Unix format
and Coordinated Universal Time (UTC).
$sel:byCompleteBefore:ListBackupJobs'
, listBackupJobs_byCompleteBefore
- Returns only backup jobs completed before a date expressed in Unix
format and Coordinated Universal Time (UTC).
$sel:byCreatedAfter:ListBackupJobs'
, listBackupJobs_byCreatedAfter
- Returns only backup jobs that were created after the specified date.
$sel:byCreatedBefore:ListBackupJobs'
, listBackupJobs_byCreatedBefore
- Returns only backup jobs that were created before the specified date.
$sel:byParentJobId:ListBackupJobs'
, listBackupJobs_byParentJobId
- This is a filter to list child (nested) jobs based on parent job ID.
$sel:byResourceArn:ListBackupJobs'
, listBackupJobs_byResourceArn
- Returns only backup jobs that match the specified resource Amazon
Resource Name (ARN).
$sel:byResourceType:ListBackupJobs'
, listBackupJobs_byResourceType
- Returns only backup jobs for the specified resources:
Aurora
for Amazon AuroraDocumentDB
for Amazon DocumentDB (with MongoDB compatibility)DynamoDB
for Amazon DynamoDBEBS
for Amazon Elastic Block StoreEC2
for Amazon Elastic Compute CloudEFS
for Amazon Elastic File SystemFSx
for Amazon FSxNeptune
for Amazon NeptuneRDS
for Amazon Relational Database ServiceStorage Gateway
for Storage GatewayS3
for Amazon S3VirtualMachine
for virtual machines
$sel:byState:ListBackupJobs'
, listBackupJobs_byState
- Returns only backup jobs that are in the specified state.
$sel:maxResults:ListBackupJobs'
, listBackupJobs_maxResults
- The maximum number of items to be returned.
ListBackupJobs
, listBackupJobs_nextToken
- The next item following a partial list of returned items. For example,
if a request is made to return maxResults
number of items, NextToken
allows you to return more items in your list starting at the location
pointed to by the next token.
data ListBackupJobsResponse Source #
See: newListBackupJobsResponse
smart constructor.
Instances
newListBackupJobsResponse Source #
Create a value of ListBackupJobsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:backupJobs:ListBackupJobsResponse'
, listBackupJobsResponse_backupJobs
- An array of structures containing metadata about your backup jobs
returned in JSON format.
ListBackupJobs
, listBackupJobsResponse_nextToken
- The next item following a partial list of returned items. For example,
if a request is made to return maxResults
number of items, NextToken
allows you to return more items in your list starting at the location
pointed to by the next token.
$sel:httpStatus:ListBackupJobsResponse'
, listBackupJobsResponse_httpStatus
- The response's http status code.
ListBackupPlanTemplates (Paginated)
data ListBackupPlanTemplates Source #
See: newListBackupPlanTemplates
smart constructor.
Instances
newListBackupPlanTemplates :: ListBackupPlanTemplates Source #
Create a value of ListBackupPlanTemplates
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListBackupPlanTemplates'
, listBackupPlanTemplates_maxResults
- The maximum number of items to be returned.
ListBackupPlanTemplates
, listBackupPlanTemplates_nextToken
- The next item following a partial list of returned items. For example,
if a request is made to return maxResults
number of items, NextToken
allows you to return more items in your list starting at the location
pointed to by the next token.
data ListBackupPlanTemplatesResponse Source #
See: newListBackupPlanTemplatesResponse
smart constructor.
Instances
newListBackupPlanTemplatesResponse Source #
Create a value of ListBackupPlanTemplatesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:backupPlanTemplatesList:ListBackupPlanTemplatesResponse'
, listBackupPlanTemplatesResponse_backupPlanTemplatesList
- An array of template list items containing metadata about your saved
templates.
ListBackupPlanTemplates
, listBackupPlanTemplatesResponse_nextToken
- The next item following a partial list of returned items. For example,
if a request is made to return maxResults
number of items, NextToken
allows you to return more items in your list starting at the location
pointed to by the next token.
$sel:httpStatus:ListBackupPlanTemplatesResponse'
, listBackupPlanTemplatesResponse_httpStatus
- The response's http status code.
ListBackupPlanVersions (Paginated)
data ListBackupPlanVersions Source #
See: newListBackupPlanVersions
smart constructor.
Instances
newListBackupPlanVersions Source #
Create a value of ListBackupPlanVersions
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListBackupPlanVersions'
, listBackupPlanVersions_maxResults
- The maximum number of items to be returned.
ListBackupPlanVersions
, listBackupPlanVersions_nextToken
- The next item following a partial list of returned items. For example,
if a request is made to return maxResults
number of items, NextToken
allows you to return more items in your list starting at the location
pointed to by the next token.
ListBackupPlanVersions
, listBackupPlanVersions_backupPlanId
- Uniquely identifies a backup plan.
data ListBackupPlanVersionsResponse Source #
See: newListBackupPlanVersionsResponse
smart constructor.
Instances
newListBackupPlanVersionsResponse Source #
Create a value of ListBackupPlanVersionsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:backupPlanVersionsList:ListBackupPlanVersionsResponse'
, listBackupPlanVersionsResponse_backupPlanVersionsList
- An array of version list items containing metadata about your backup
plans.
ListBackupPlanVersions
, listBackupPlanVersionsResponse_nextToken
- The next item following a partial list of returned items. For example,
if a request is made to return maxResults
number of items, NextToken
allows you to return more items in your list starting at the location
pointed to by the next token.
$sel:httpStatus:ListBackupPlanVersionsResponse'
, listBackupPlanVersionsResponse_httpStatus
- The response's http status code.
ListBackupPlans (Paginated)
data ListBackupPlans Source #
See: newListBackupPlans
smart constructor.
Instances
newListBackupPlans :: ListBackupPlans Source #
Create a value of ListBackupPlans
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:includeDeleted:ListBackupPlans'
, listBackupPlans_includeDeleted
- A Boolean value with a default value of FALSE
that returns deleted
backup plans when set to TRUE
.
$sel:maxResults:ListBackupPlans'
, listBackupPlans_maxResults
- The maximum number of items to be returned.
ListBackupPlans
, listBackupPlans_nextToken
- The next item following a partial list of returned items. For example,
if a request is made to return maxResults
number of items, NextToken
allows you to return more items in your list starting at the location
pointed to by the next token.
data ListBackupPlansResponse Source #
See: newListBackupPlansResponse
smart constructor.
Instances
newListBackupPlansResponse Source #
Create a value of ListBackupPlansResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:backupPlansList:ListBackupPlansResponse'
, listBackupPlansResponse_backupPlansList
- An array of backup plan list items containing metadata about your saved
backup plans.
ListBackupPlans
, listBackupPlansResponse_nextToken
- The next item following a partial list of returned items. For example,
if a request is made to return maxResults
number of items, NextToken
allows you to return more items in your list starting at the location
pointed to by the next token.
$sel:httpStatus:ListBackupPlansResponse'
, listBackupPlansResponse_httpStatus
- The response's http status code.
ListBackupSelections (Paginated)
data ListBackupSelections Source #
See: newListBackupSelections
smart constructor.
Instances
newListBackupSelections Source #
Create a value of ListBackupSelections
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListBackupSelections'
, listBackupSelections_maxResults
- The maximum number of items to be returned.
ListBackupSelections
, listBackupSelections_nextToken
- The next item following a partial list of returned items. For example,
if a request is made to return maxResults
number of items, NextToken
allows you to return more items in your list starting at the location
pointed to by the next token.
ListBackupSelections
, listBackupSelections_backupPlanId
- Uniquely identifies a backup plan.
data ListBackupSelectionsResponse Source #
See: newListBackupSelectionsResponse
smart constructor.
Instances
newListBackupSelectionsResponse Source #
Create a value of ListBackupSelectionsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:backupSelectionsList:ListBackupSelectionsResponse'
, listBackupSelectionsResponse_backupSelectionsList
- An array of backup selection list items containing metadata about each
resource in the list.
ListBackupSelections
, listBackupSelectionsResponse_nextToken
- The next item following a partial list of returned items. For example,
if a request is made to return maxResults
number of items, NextToken
allows you to return more items in your list starting at the location
pointed to by the next token.
$sel:httpStatus:ListBackupSelectionsResponse'
, listBackupSelectionsResponse_httpStatus
- The response's http status code.
ListBackupVaults (Paginated)
data ListBackupVaults Source #
See: newListBackupVaults
smart constructor.
Instances
newListBackupVaults :: ListBackupVaults Source #
Create a value of ListBackupVaults
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListBackupVaults'
, listBackupVaults_maxResults
- The maximum number of items to be returned.
ListBackupVaults
, listBackupVaults_nextToken
- The next item following a partial list of returned items. For example,
if a request is made to return maxResults
number of items, NextToken
allows you to return more items in your list starting at the location
pointed to by the next token.
data ListBackupVaultsResponse Source #
See: newListBackupVaultsResponse
smart constructor.
Instances
newListBackupVaultsResponse Source #
Create a value of ListBackupVaultsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:backupVaultList:ListBackupVaultsResponse'
, listBackupVaultsResponse_backupVaultList
- An array of backup vault list members containing vault metadata,
including Amazon Resource Name (ARN), display name, creation date,
number of saved recovery points, and encryption information if the
resources saved in the backup vault are encrypted.
ListBackupVaults
, listBackupVaultsResponse_nextToken
- The next item following a partial list of returned items. For example,
if a request is made to return maxResults
number of items, NextToken
allows you to return more items in your list starting at the location
pointed to by the next token.
$sel:httpStatus:ListBackupVaultsResponse'
, listBackupVaultsResponse_httpStatus
- The response's http status code.
ListCopyJobs (Paginated)
data ListCopyJobs Source #
See: newListCopyJobs
smart constructor.
ListCopyJobs' (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe CopyJobState) (Maybe Natural) (Maybe Text) |
Instances
newListCopyJobs :: ListCopyJobs Source #
Create a value of ListCopyJobs
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:byAccountId:ListCopyJobs'
, listCopyJobs_byAccountId
- The account ID to list the jobs from. Returns only copy jobs associated
with the specified account ID.
$sel:byCompleteAfter:ListCopyJobs'
, listCopyJobs_byCompleteAfter
- Returns only copy jobs completed after a date expressed in Unix format
and Coordinated Universal Time (UTC).
$sel:byCompleteBefore:ListCopyJobs'
, listCopyJobs_byCompleteBefore
- Returns only copy jobs completed before a date expressed in Unix format
and Coordinated Universal Time (UTC).
$sel:byCreatedAfter:ListCopyJobs'
, listCopyJobs_byCreatedAfter
- Returns only copy jobs that were created after the specified date.
$sel:byCreatedBefore:ListCopyJobs'
, listCopyJobs_byCreatedBefore
- Returns only copy jobs that were created before the specified date.
$sel:byDestinationVaultArn:ListCopyJobs'
, listCopyJobs_byDestinationVaultArn
- An Amazon Resource Name (ARN) that uniquely identifies a source backup
vault to copy from; for example,
arn:aws:backup:us-east-1:123456789012:vault:aBackupVault
.
$sel:byParentJobId:ListCopyJobs'
, listCopyJobs_byParentJobId
- This is a filter to list child (nested) jobs based on parent job ID.
$sel:byResourceArn:ListCopyJobs'
, listCopyJobs_byResourceArn
- Returns only copy jobs that match the specified resource Amazon Resource
Name (ARN).
$sel:byResourceType:ListCopyJobs'
, listCopyJobs_byResourceType
- Returns only backup jobs for the specified resources:
Aurora
for Amazon AuroraDocumentDB
for Amazon DocumentDB (with MongoDB compatibility)DynamoDB
for Amazon DynamoDBEBS
for Amazon Elastic Block StoreEC2
for Amazon Elastic Compute CloudEFS
for Amazon Elastic File SystemFSx
for Amazon FSxNeptune
for Amazon NeptuneRDS
for Amazon Relational Database ServiceStorage Gateway
for Storage GatewayS3
for Amazon S3VirtualMachine
for virtual machines
$sel:byState:ListCopyJobs'
, listCopyJobs_byState
- Returns only copy jobs that are in the specified state.
$sel:maxResults:ListCopyJobs'
, listCopyJobs_maxResults
- The maximum number of items to be returned.
ListCopyJobs
, listCopyJobs_nextToken
- The next item following a partial list of returned items. For example,
if a request is made to return maxResults number of items, NextToken
allows you to return more items in your list starting at the location
pointed to by the next token.
data ListCopyJobsResponse Source #
See: newListCopyJobsResponse
smart constructor.
Instances
newListCopyJobsResponse Source #
Create a value of ListCopyJobsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:copyJobs:ListCopyJobsResponse'
, listCopyJobsResponse_copyJobs
- An array of structures containing metadata about your copy jobs returned
in JSON format.
ListCopyJobs
, listCopyJobsResponse_nextToken
- The next item following a partial list of returned items. For example,
if a request is made to return maxResults number of items, NextToken
allows you to return more items in your list starting at the location
pointed to by the next token.
$sel:httpStatus:ListCopyJobsResponse'
, listCopyJobsResponse_httpStatus
- The response's http status code.
ListFrameworks
data ListFrameworks Source #
See: newListFrameworks
smart constructor.
Instances
newListFrameworks :: ListFrameworks Source #
Create a value of ListFrameworks
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListFrameworks'
, listFrameworks_maxResults
- The number of desired results from 1 to 1000. Optional. If unspecified,
the query will return 1 MB of data.
ListFrameworks
, listFrameworks_nextToken
- An identifier that was returned from the previous call to this
operation, which can be used to return the next set of items in the
list.
data ListFrameworksResponse Source #
See: newListFrameworksResponse
smart constructor.
Instances
newListFrameworksResponse Source #
Create a value of ListFrameworksResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:frameworks:ListFrameworksResponse'
, listFrameworksResponse_frameworks
- A list of frameworks with details for each framework, including the
framework name, Amazon Resource Name (ARN), description, number of
controls, creation time, and deployment status.
ListFrameworks
, listFrameworksResponse_nextToken
- An identifier that was returned from the previous call to this
operation, which can be used to return the next set of items in the
list.
$sel:httpStatus:ListFrameworksResponse'
, listFrameworksResponse_httpStatus
- The response's http status code.
ListLegalHolds (Paginated)
data ListLegalHolds Source #
See: newListLegalHolds
smart constructor.
Instances
newListLegalHolds :: ListLegalHolds Source #
Create a value of ListLegalHolds
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListLegalHolds'
, listLegalHolds_maxResults
- The maximum number of resource list items to be returned.
ListLegalHolds
, listLegalHolds_nextToken
- The next item following a partial list of returned resources. For
example, if a request is made to return maxResults
number of
resources, NextToken
allows you to return more items in your list
starting at the location pointed to by the next token.
data ListLegalHoldsResponse Source #
See: newListLegalHoldsResponse
smart constructor.
Instances
newListLegalHoldsResponse Source #
Create a value of ListLegalHoldsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:legalHolds:ListLegalHoldsResponse'
, listLegalHoldsResponse_legalHolds
- This is an array of returned legal holds, both active and previous.
ListLegalHolds
, listLegalHoldsResponse_nextToken
- The next item following a partial list of returned resources. For
example, if a request is made to return maxResults
number of
resources, NextToken
allows you to return more items in your list
starting at the location pointed to by the next token.
$sel:httpStatus:ListLegalHoldsResponse'
, listLegalHoldsResponse_httpStatus
- The response's http status code.
ListProtectedResources (Paginated)
data ListProtectedResources Source #
See: newListProtectedResources
smart constructor.
Instances
newListProtectedResources :: ListProtectedResources Source #
Create a value of ListProtectedResources
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListProtectedResources'
, listProtectedResources_maxResults
- The maximum number of items to be returned.
ListProtectedResources
, listProtectedResources_nextToken
- The next item following a partial list of returned items. For example,
if a request is made to return maxResults
number of items, NextToken
allows you to return more items in your list starting at the location
pointed to by the next token.
data ListProtectedResourcesResponse Source #
See: newListProtectedResourcesResponse
smart constructor.
Instances
newListProtectedResourcesResponse Source #
Create a value of ListProtectedResourcesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListProtectedResources
, listProtectedResourcesResponse_nextToken
- The next item following a partial list of returned items. For example,
if a request is made to return maxResults
number of items, NextToken
allows you to return more items in your list starting at the location
pointed to by the next token.
$sel:results:ListProtectedResourcesResponse'
, listProtectedResourcesResponse_results
- An array of resources successfully backed up by Backup including the
time the resource was saved, an Amazon Resource Name (ARN) of the
resource, and a resource type.
$sel:httpStatus:ListProtectedResourcesResponse'
, listProtectedResourcesResponse_httpStatus
- The response's http status code.
ListRecoveryPointsByBackupVault (Paginated)
data ListRecoveryPointsByBackupVault Source #
See: newListRecoveryPointsByBackupVault
smart constructor.
ListRecoveryPointsByBackupVault' (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe Text) Text |
Instances
newListRecoveryPointsByBackupVault Source #
Create a value of ListRecoveryPointsByBackupVault
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:byBackupPlanId:ListRecoveryPointsByBackupVault'
, listRecoveryPointsByBackupVault_byBackupPlanId
- Returns only recovery points that match the specified backup plan ID.
$sel:byCreatedAfter:ListRecoveryPointsByBackupVault'
, listRecoveryPointsByBackupVault_byCreatedAfter
- Returns only recovery points that were created after the specified
timestamp.
$sel:byCreatedBefore:ListRecoveryPointsByBackupVault'
, listRecoveryPointsByBackupVault_byCreatedBefore
- Returns only recovery points that were created before the specified
timestamp.
$sel:byParentRecoveryPointArn:ListRecoveryPointsByBackupVault'
, listRecoveryPointsByBackupVault_byParentRecoveryPointArn
- This returns only recovery points that match the specified parent
(composite) recovery point Amazon Resource Name (ARN).
$sel:byResourceArn:ListRecoveryPointsByBackupVault'
, listRecoveryPointsByBackupVault_byResourceArn
- Returns only recovery points that match the specified resource Amazon
Resource Name (ARN).
$sel:byResourceType:ListRecoveryPointsByBackupVault'
, listRecoveryPointsByBackupVault_byResourceType
- Returns only recovery points that match the specified resource type.
$sel:maxResults:ListRecoveryPointsByBackupVault'
, listRecoveryPointsByBackupVault_maxResults
- The maximum number of items to be returned.
ListRecoveryPointsByBackupVault
, listRecoveryPointsByBackupVault_nextToken
- The next item following a partial list of returned items. For example,
if a request is made to return maxResults
number of items, NextToken
allows you to return more items in your list starting at the location
pointed to by the next token.
ListRecoveryPointsByBackupVault
, listRecoveryPointsByBackupVault_backupVaultName
- 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.
Backup vault name might not be available when a supported service creates the backup.
data ListRecoveryPointsByBackupVaultResponse Source #
See: newListRecoveryPointsByBackupVaultResponse
smart constructor.
Instances
newListRecoveryPointsByBackupVaultResponse Source #
Create a value of ListRecoveryPointsByBackupVaultResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListRecoveryPointsByBackupVault
, listRecoveryPointsByBackupVaultResponse_nextToken
- The next item following a partial list of returned items. For example,
if a request is made to return maxResults
number of items, NextToken
allows you to return more items in your list starting at the location
pointed to by the next token.
$sel:recoveryPoints:ListRecoveryPointsByBackupVaultResponse'
, listRecoveryPointsByBackupVaultResponse_recoveryPoints
- An array of objects that contain detailed information about recovery
points saved in a backup vault.
$sel:httpStatus:ListRecoveryPointsByBackupVaultResponse'
, listRecoveryPointsByBackupVaultResponse_httpStatus
- The response's http status code.
ListRecoveryPointsByLegalHold (Paginated)
data ListRecoveryPointsByLegalHold Source #
See: newListRecoveryPointsByLegalHold
smart constructor.
Instances
newListRecoveryPointsByLegalHold Source #
Create a value of ListRecoveryPointsByLegalHold
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListRecoveryPointsByLegalHold'
, listRecoveryPointsByLegalHold_maxResults
- This is the maximum number of resource list items to be returned.
ListRecoveryPointsByLegalHold
, listRecoveryPointsByLegalHold_nextToken
- This is the next item following a partial list of returned resources.
For example, if a request is made to return maxResults
number of
resources, NextToken
allows you to return more items in your list
starting at the location pointed to by the next token.
ListRecoveryPointsByLegalHold
, listRecoveryPointsByLegalHold_legalHoldId
- This is the ID of the legal hold.
data ListRecoveryPointsByLegalHoldResponse Source #
See: newListRecoveryPointsByLegalHoldResponse
smart constructor.
Instances
newListRecoveryPointsByLegalHoldResponse Source #
Create a value of ListRecoveryPointsByLegalHoldResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListRecoveryPointsByLegalHold
, listRecoveryPointsByLegalHoldResponse_nextToken
- This return is the next item following a partial list of returned
resources.
$sel:recoveryPoints:ListRecoveryPointsByLegalHoldResponse'
, listRecoveryPointsByLegalHoldResponse_recoveryPoints
- This is a list of the recovery points returned by
ListRecoveryPointsByLegalHold
.
$sel:httpStatus:ListRecoveryPointsByLegalHoldResponse'
, listRecoveryPointsByLegalHoldResponse_httpStatus
- The response's http status code.
ListRecoveryPointsByResource (Paginated)
data ListRecoveryPointsByResource Source #
See: newListRecoveryPointsByResource
smart constructor.
Instances
newListRecoveryPointsByResource Source #
Create a value of ListRecoveryPointsByResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListRecoveryPointsByResource'
, listRecoveryPointsByResource_maxResults
- The maximum number of items to be returned.
Amazon RDS requires a value of at least 20.
ListRecoveryPointsByResource
, listRecoveryPointsByResource_nextToken
- The next item following a partial list of returned items. For example,
if a request is made to return maxResults
number of items, NextToken
allows you to return more items in your list starting at the location
pointed to by the next token.
ListRecoveryPointsByResource
, listRecoveryPointsByResource_resourceArn
- An ARN that uniquely identifies a resource. The format of the ARN
depends on the resource type.
data ListRecoveryPointsByResourceResponse Source #
See: newListRecoveryPointsByResourceResponse
smart constructor.
Instances
newListRecoveryPointsByResourceResponse Source #
Create a value of ListRecoveryPointsByResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListRecoveryPointsByResource
, listRecoveryPointsByResourceResponse_nextToken
- The next item following a partial list of returned items. For example,
if a request is made to return maxResults
number of items, NextToken
allows you to return more items in your list starting at the location
pointed to by the next token.
$sel:recoveryPoints:ListRecoveryPointsByResourceResponse'
, listRecoveryPointsByResourceResponse_recoveryPoints
- An array of objects that contain detailed information about recovery
points of the specified resource type.
Only Amazon EFS and Amazon EC2 recovery points return BackupVaultName.
$sel:httpStatus:ListRecoveryPointsByResourceResponse'
, listRecoveryPointsByResourceResponse_httpStatus
- The response's http status code.
ListReportJobs
data ListReportJobs Source #
See: newListReportJobs
smart constructor.
Instances
newListReportJobs :: ListReportJobs Source #
Create a value of ListReportJobs
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:byCreationAfter:ListReportJobs'
, listReportJobs_byCreationAfter
- Returns only report jobs that were created after the date and time
specified in Unix format and Coordinated Universal Time (UTC). For
example, the value 1516925490 represents Friday, January 26, 2018
12:11:30 AM.
$sel:byCreationBefore:ListReportJobs'
, listReportJobs_byCreationBefore
- Returns only report jobs that were created before the date and time
specified in Unix format and Coordinated Universal Time (UTC). For
example, the value 1516925490 represents Friday, January 26, 2018
12:11:30 AM.
$sel:byReportPlanName:ListReportJobs'
, listReportJobs_byReportPlanName
- Returns only report jobs with the specified report plan name.
$sel:byStatus:ListReportJobs'
, listReportJobs_byStatus
- Returns only report jobs that are in the specified status. The statuses
are:
CREATED | RUNNING | COMPLETED | FAILED
$sel:maxResults:ListReportJobs'
, listReportJobs_maxResults
- The number of desired results from 1 to 1000. Optional. If unspecified,
the query will return 1 MB of data.
ListReportJobs
, listReportJobs_nextToken
- An identifier that was returned from the previous call to this
operation, which can be used to return the next set of items in the
list.
data ListReportJobsResponse Source #
See: newListReportJobsResponse
smart constructor.
Instances
newListReportJobsResponse Source #
Create a value of ListReportJobsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListReportJobs
, listReportJobsResponse_nextToken
- An identifier that was returned from the previous call to this
operation, which can be used to return the next set of items in the
list.
$sel:reportJobs:ListReportJobsResponse'
, listReportJobsResponse_reportJobs
- Details about your report jobs in JSON format.
$sel:httpStatus:ListReportJobsResponse'
, listReportJobsResponse_httpStatus
- The response's http status code.
ListReportPlans
data ListReportPlans Source #
See: newListReportPlans
smart constructor.
Instances
newListReportPlans :: ListReportPlans Source #
Create a value of ListReportPlans
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListReportPlans'
, listReportPlans_maxResults
- The number of desired results from 1 to 1000. Optional. If unspecified,
the query will return 1 MB of data.
ListReportPlans
, listReportPlans_nextToken
- An identifier that was returned from the previous call to this
operation, which can be used to return the next set of items in the
list.
data ListReportPlansResponse Source #
See: newListReportPlansResponse
smart constructor.
Instances
newListReportPlansResponse Source #
Create a value of ListReportPlansResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListReportPlans
, listReportPlansResponse_nextToken
- An identifier that was returned from the previous call to this
operation, which can be used to return the next set of items in the
list.
$sel:reportPlans:ListReportPlansResponse'
, listReportPlansResponse_reportPlans
- A list of your report plans with detailed information for each plan.
This information includes the Amazon Resource Name (ARN), report plan
name, description, settings, delivery channel, deployment status,
creation time, and last times the report plan attempted to and
successfully ran.
$sel:httpStatus:ListReportPlansResponse'
, listReportPlansResponse_httpStatus
- The response's http status code.
ListRestoreJobs (Paginated)
data ListRestoreJobs Source #
See: newListRestoreJobs
smart constructor.
ListRestoreJobs' (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe POSIX) (Maybe POSIX) (Maybe RestoreJobStatus) (Maybe Natural) (Maybe Text) |
Instances
newListRestoreJobs :: ListRestoreJobs Source #
Create a value of ListRestoreJobs
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:byAccountId:ListRestoreJobs'
, listRestoreJobs_byAccountId
- The account ID to list the jobs from. Returns only restore jobs
associated with the specified account ID.
$sel:byCompleteAfter:ListRestoreJobs'
, listRestoreJobs_byCompleteAfter
- Returns only copy jobs completed after a date expressed in Unix format
and Coordinated Universal Time (UTC).
$sel:byCompleteBefore:ListRestoreJobs'
, listRestoreJobs_byCompleteBefore
- Returns only copy jobs completed before a date expressed in Unix format
and Coordinated Universal Time (UTC).
$sel:byCreatedAfter:ListRestoreJobs'
, listRestoreJobs_byCreatedAfter
- Returns only restore jobs that were created after the specified date.
$sel:byCreatedBefore:ListRestoreJobs'
, listRestoreJobs_byCreatedBefore
- Returns only restore jobs that were created before the specified date.
$sel:byStatus:ListRestoreJobs'
, listRestoreJobs_byStatus
- Returns only restore jobs associated with the specified job status.
$sel:maxResults:ListRestoreJobs'
, listRestoreJobs_maxResults
- The maximum number of items to be returned.
ListRestoreJobs
, listRestoreJobs_nextToken
- The next item following a partial list of returned items. For example,
if a request is made to return maxResults
number of items, NextToken
allows you to return more items in your list starting at the location
pointed to by the next token.
data ListRestoreJobsResponse Source #
See: newListRestoreJobsResponse
smart constructor.
Instances
newListRestoreJobsResponse Source #
Create a value of ListRestoreJobsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListRestoreJobs
, listRestoreJobsResponse_nextToken
- The next item following a partial list of returned items. For example,
if a request is made to return maxResults
number of items, NextToken
allows you to return more items in your list starting at the location
pointed to by the next token.
$sel:restoreJobs:ListRestoreJobsResponse'
, listRestoreJobsResponse_restoreJobs
- An array of objects that contain detailed information about jobs to
restore saved resources.
$sel:httpStatus:ListRestoreJobsResponse'
, listRestoreJobsResponse_httpStatus
- The response's http status code.
ListTags
See: newListTags
smart constructor.
Instances
Create a value of ListTags
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListTags'
, listTags_maxResults
- The maximum number of items to be returned.
ListTags
, listTags_nextToken
- The next item following a partial list of returned items. For example,
if a request is made to return maxResults
number of items, NextToken
allows you to return more items in your list starting at the location
pointed to by the next token.
ListTags
, listTags_resourceArn
- An Amazon Resource Name (ARN) that uniquely identifies a resource. The
format of the ARN depends on the type of resource. Valid targets for
ListTags
are recovery points, backup plans, and backup vaults.
data ListTagsResponse Source #
See: newListTagsResponse
smart constructor.
Instances
Create a value of ListTagsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListTags
, listTagsResponse_nextToken
- The next item following a partial list of returned items. For example,
if a request is made to return maxResults
number of items, NextToken
allows you to return more items in your list starting at the location
pointed to by the next token.
ListTagsResponse
, listTagsResponse_tags
- To help organize your resources, you can assign your own metadata to the
resources you create. Each tag is a key-value pair.
$sel:httpStatus:ListTagsResponse'
, listTagsResponse_httpStatus
- The response's http status code.
PutBackupVaultAccessPolicy
data PutBackupVaultAccessPolicy Source #
See: newPutBackupVaultAccessPolicy
smart constructor.
Instances
newPutBackupVaultAccessPolicy Source #
Create a value of PutBackupVaultAccessPolicy
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:policy:PutBackupVaultAccessPolicy'
, putBackupVaultAccessPolicy_policy
- The backup vault access policy document in JSON format.
PutBackupVaultAccessPolicy
, putBackupVaultAccessPolicy_backupVaultName
- 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.
data PutBackupVaultAccessPolicyResponse Source #
See: newPutBackupVaultAccessPolicyResponse
smart constructor.
Instances
newPutBackupVaultAccessPolicyResponse :: PutBackupVaultAccessPolicyResponse Source #
Create a value of PutBackupVaultAccessPolicyResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
PutBackupVaultLockConfiguration
data PutBackupVaultLockConfiguration Source #
See: newPutBackupVaultLockConfiguration
smart constructor.
Instances
newPutBackupVaultLockConfiguration Source #
Create a value of PutBackupVaultLockConfiguration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:changeableForDays:PutBackupVaultLockConfiguration'
, putBackupVaultLockConfiguration_changeableForDays
- The Backup Vault Lock configuration that specifies the number of days
before the lock date. For example, setting ChangeableForDays
to 30 on
Jan. 1, 2022 at 8pm UTC will set the lock date to Jan. 31, 2022 at 8pm
UTC.
Backup enforces a 72-hour cooling-off period before Vault Lock takes
effect and becomes immutable. Therefore, you must set
ChangeableForDays
to 3 or greater.
Before the lock date, you can delete Vault Lock from the vault using
DeleteBackupVaultLockConfiguration
or change the Vault Lock
configuration using PutBackupVaultLockConfiguration
. On and after the
lock date, the Vault Lock becomes immutable and cannot be changed or
deleted.
If this parameter is not specified, you can delete Vault Lock from the
vault using DeleteBackupVaultLockConfiguration
or change the Vault
Lock configuration using PutBackupVaultLockConfiguration
at any time.
PutBackupVaultLockConfiguration
, putBackupVaultLockConfiguration_maxRetentionDays
- The Backup Vault Lock configuration that specifies the maximum retention
period that the vault retains its recovery points. This setting can be
useful if, for example, your organization's policies require you to
destroy certain data after retaining it for four years (1460 days).
If this parameter is not included, Vault Lock does not enforce a maximum retention period on the recovery points in the vault. If this parameter is included without a value, Vault Lock will not enforce a maximum retention period.
If this parameter is 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. The longest maximum retention period you can specify is 36500 days (approximately 100 years). Recovery points already saved in the vault prior to Vault Lock are not affected.
PutBackupVaultLockConfiguration
, putBackupVaultLockConfiguration_minRetentionDays
- The Backup Vault Lock configuration that specifies the minimum retention
period that the vault retains its recovery points. This setting can be
useful if, for example, your organization's policies require you to
retain certain data for at least seven years (2555 days).
If this parameter is not specified, Vault Lock will not enforce a minimum retention period.
If this parameter is 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 that backup or copy job, and you should either modify your lifecycle settings or use a different vault. The shortest minimum retention period you can specify is 1 day. Recovery points already saved in the vault prior to Vault Lock are not affected.
PutBackupVaultLockConfiguration
, putBackupVaultLockConfiguration_backupVaultName
- The Backup Vault Lock configuration that specifies the name of the
backup vault it protects.
data PutBackupVaultLockConfigurationResponse Source #
See: newPutBackupVaultLockConfigurationResponse
smart constructor.
Instances
Generic PutBackupVaultLockConfigurationResponse Source # | |
Defined in Amazonka.Backup.PutBackupVaultLockConfiguration type Rep PutBackupVaultLockConfigurationResponse :: Type -> Type # | |
Read PutBackupVaultLockConfigurationResponse Source # | |
Show PutBackupVaultLockConfigurationResponse Source # | |
NFData PutBackupVaultLockConfigurationResponse Source # | |
Defined in Amazonka.Backup.PutBackupVaultLockConfiguration rnf :: PutBackupVaultLockConfigurationResponse -> () # | |
Eq PutBackupVaultLockConfigurationResponse Source # | |
type Rep PutBackupVaultLockConfigurationResponse Source # | |
Defined in Amazonka.Backup.PutBackupVaultLockConfiguration type Rep PutBackupVaultLockConfigurationResponse = D1 ('MetaData "PutBackupVaultLockConfigurationResponse" "Amazonka.Backup.PutBackupVaultLockConfiguration" "amazonka-backup-2.0-LovIt41tphM6jvgQJhTyRf" 'False) (C1 ('MetaCons "PutBackupVaultLockConfigurationResponse'" 'PrefixI 'False) (U1 :: Type -> Type)) |
newPutBackupVaultLockConfigurationResponse :: PutBackupVaultLockConfigurationResponse Source #
Create a value of PutBackupVaultLockConfigurationResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
PutBackupVaultNotifications
data PutBackupVaultNotifications Source #
See: newPutBackupVaultNotifications
smart constructor.
Instances
newPutBackupVaultNotifications Source #
:: Text | |
-> Text | |
-> PutBackupVaultNotifications |
Create a value of PutBackupVaultNotifications
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
PutBackupVaultNotifications
, putBackupVaultNotifications_backupVaultName
- 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.
$sel:sNSTopicArn:PutBackupVaultNotifications'
, putBackupVaultNotifications_sNSTopicArn
- 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
.
$sel:backupVaultEvents:PutBackupVaultNotifications'
, putBackupVaultNotifications_backupVaultEvents
- An array of events that indicate the status of jobs to back up resources
to the backup vault.
For common use cases and code samples, see Using Amazon SNS to track Backup events.
The following events are supported:
BACKUP_JOB_STARTED
|BACKUP_JOB_COMPLETED
COPY_JOB_STARTED
|COPY_JOB_SUCCESSFUL
|COPY_JOB_FAILED
RESTORE_JOB_STARTED
|RESTORE_JOB_COMPLETED
|RECOVERY_POINT_MODIFIED
S3_BACKUP_OBJECT_FAILED
|S3_RESTORE_OBJECT_FAILED
The list below shows items that are deprecated events (for reference) and are no longer in use. They are no longer supported and will not return statuses or notifications. Refer to the list above for current supported events.
data PutBackupVaultNotificationsResponse Source #
See: newPutBackupVaultNotificationsResponse
smart constructor.
Instances
newPutBackupVaultNotificationsResponse :: PutBackupVaultNotificationsResponse Source #
Create a value of PutBackupVaultNotificationsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
StartBackupJob
data StartBackupJob Source #
See: newStartBackupJob
smart constructor.
StartBackupJob' (Maybe (HashMap Text Text)) (Maybe Integer) (Maybe Text) (Maybe Lifecycle) (Maybe (Sensitive (HashMap Text Text))) (Maybe Integer) Text Text Text |
Instances
Create a value of StartBackupJob
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
StartBackupJob
, startBackupJob_backupOptions
- Specifies the backup option for a selected resource. This option is only
available for Windows Volume Shadow Copy Service (VSS) backup jobs.
Valid values: Set to "WindowsVSS":"enabled"
to enable the
WindowsVSS
backup option and create a Windows VSS backup. Set to
"WindowsVSS""disabled"
to create a regular backup. The
WindowsVSS
option is not enabled by default.
$sel:completeWindowMinutes:StartBackupJob'
, startBackupJob_completeWindowMinutes
- A value in minutes during which a successfully started backup must
complete, or else Backup will cancel the job. This value is optional.
This value begins counting down from when the backup was scheduled. It
does not add additional time for StartWindowMinutes
, or if the backup
started later than scheduled.
$sel:idempotencyToken:StartBackupJob'
, startBackupJob_idempotencyToken
- A customer-chosen string that you can use to distinguish between
otherwise identical calls to StartBackupJob
. Retrying a successful
request with the same idempotency token results in a success message
with no action taken.
StartBackupJob
, startBackupJob_lifecycle
- 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.
Resource types that are able to be transitioned to cold storage are listed in the "Lifecycle to cold storage" section of the Feature availability by resource table. Backup ignores this expression for other resource types.
StartBackupJob
, startBackupJob_recoveryPointTags
- To help organize your resources, you can assign your own metadata to the
resources that you create. Each tag is a key-value pair.
StartBackupJob
, startBackupJob_startWindowMinutes
- A value in minutes after a backup is scheduled before a job will be
canceled if it doesn't start successfully. This value is optional, and
the default is 8 hours. If this value is included, it must be at least
60 minutes to avoid errors.
StartBackupJob
, startBackupJob_backupVaultName
- 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.
StartBackupJob
, startBackupJob_resourceArn
- An Amazon Resource Name (ARN) that uniquely identifies a resource. The
format of the ARN depends on the resource type.
StartBackupJob
, startBackupJob_iamRoleArn
- Specifies the IAM role ARN used to create the target recovery point; for
example, arn:aws:iam::123456789012:role/S3Access
.
data StartBackupJobResponse Source #
See: newStartBackupJobResponse
smart constructor.
Instances
newStartBackupJobResponse Source #
Create a value of StartBackupJobResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
StartBackupJobResponse
, startBackupJobResponse_backupJobId
- Uniquely identifies a request to Backup to back up a resource.
StartBackupJobResponse
, startBackupJobResponse_creationDate
- 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.
StartBackupJobResponse
, startBackupJobResponse_isParent
- This is a returned boolean value indicating this is a parent (composite)
backup job.
StartBackupJobResponse
, startBackupJobResponse_recoveryPointArn
- An ARN that uniquely identifies a recovery point; for example,
arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45
.
$sel:httpStatus:StartBackupJobResponse'
, startBackupJobResponse_httpStatus
- The response's http status code.
StartCopyJob
data StartCopyJob Source #
See: newStartCopyJob
smart constructor.
Instances
:: Text | |
-> Text | |
-> Text | |
-> Text | |
-> StartCopyJob |
Create a value of StartCopyJob
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:idempotencyToken:StartCopyJob'
, startCopyJob_idempotencyToken
- A customer-chosen string that you can use to distinguish between
otherwise identical calls to StartCopyJob
. Retrying a successful
request with the same idempotency token results in a success message
with no action taken.
StartCopyJob
, startCopyJob_lifecycle
- Undocumented member.
StartCopyJob
, startCopyJob_recoveryPointArn
- 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.
$sel:sourceBackupVaultName:StartCopyJob'
, startCopyJob_sourceBackupVaultName
- The name of a logical source container where backups are stored. Backup
vaults are identified by names that are unique to the account used to
create them and the Amazon Web Services Region where they are created.
They consist of lowercase letters, numbers, and hyphens.
StartCopyJob
, startCopyJob_destinationBackupVaultArn
- 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
.
StartCopyJob
, startCopyJob_iamRoleArn
- Specifies the IAM role ARN used to copy the target recovery point; for
example, arn:aws:iam::123456789012:role/S3Access
.
data StartCopyJobResponse Source #
See: newStartCopyJobResponse
smart constructor.
Instances
newStartCopyJobResponse Source #
Create a value of StartCopyJobResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
StartCopyJobResponse
, startCopyJobResponse_copyJobId
- Uniquely identifies a copy job.
StartCopyJobResponse
, startCopyJobResponse_creationDate
- The date and time that a copy job is created, in Unix format and
Coordinated Universal Time (UTC). The value of CreationDate
is
accurate to milliseconds. For example, the value 1516925490.087
represents Friday, January 26, 2018 12:11:30.087 AM.
StartCopyJobResponse
, startCopyJobResponse_isParent
- This is a returned boolean value indicating this is a parent (composite)
copy job.
$sel:httpStatus:StartCopyJobResponse'
, startCopyJobResponse_httpStatus
- The response's http status code.
StartReportJob
data StartReportJob Source #
See: newStartReportJob
smart constructor.
Instances
Create a value of StartReportJob
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:idempotencyToken:StartReportJob'
, startReportJob_idempotencyToken
- A customer-chosen string that you can use to distinguish between
otherwise identical calls to StartReportJobInput
. Retrying a
successful request with the same idempotency token results in a success
message with no action taken.
StartReportJob
, startReportJob_reportPlanName
- The unique name of a report plan.
data StartReportJobResponse Source #
See: newStartReportJobResponse
smart constructor.
Instances
newStartReportJobResponse Source #
Create a value of StartReportJobResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
StartReportJobResponse
, startReportJobResponse_reportJobId
- 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.
$sel:httpStatus:StartReportJobResponse'
, startReportJobResponse_httpStatus
- The response's http status code.
StartRestoreJob
data StartRestoreJob Source #
See: newStartRestoreJob
smart constructor.
Instances
Create a value of StartRestoreJob
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
StartRestoreJob
, startRestoreJob_iamRoleArn
- 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
.
$sel:idempotencyToken:StartRestoreJob'
, startRestoreJob_idempotencyToken
- A customer-chosen string that you can use to distinguish between
otherwise identical calls to StartRestoreJob
. Retrying a successful
request with the same idempotency token results in a success message
with no action taken.
StartRestoreJob
, startRestoreJob_resourceType
- Starts a job to restore a recovery point for one of the following
resources:
Aurora
for Amazon AuroraDocumentDB
for Amazon DocumentDB (with MongoDB compatibility)DynamoDB
for Amazon DynamoDBEBS
for Amazon Elastic Block StoreEC2
for Amazon Elastic Compute CloudEFS
for Amazon Elastic File SystemFSx
for Amazon FSxNeptune
for Amazon NeptuneRDS
for Amazon Relational Database ServiceStorage Gateway
for Storage GatewayS3
for Amazon S3VirtualMachine
for virtual machines
StartRestoreJob
, startRestoreJob_recoveryPointArn
- An ARN that uniquely identifies a recovery point; for example,
arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45
.
$sel:metadata:StartRestoreJob'
, startRestoreJob_metadata
- A set of metadata key-value pairs. Contains information, such as a
resource name, required to restore a recovery point.
You can get configuration metadata about a resource at the time it was
backed up by calling GetRecoveryPointRestoreMetadata
. However, values
in addition to those provided by GetRecoveryPointRestoreMetadata
might
be required to restore a resource. For example, you might need to
provide a new resource name if the original already exists.
You need to specify specific metadata to restore an Amazon Elastic File System (Amazon EFS) instance:
file-system-id
: The ID of the Amazon EFS file system that is backed up by Backup. Returned inGetRecoveryPointRestoreMetadata
.Encrypted
: A Boolean value that, if true, specifies that the file system is encrypted. IfKmsKeyId
is specified,Encrypted
must be set totrue
.KmsKeyId
: Specifies the Amazon Web Services KMS key that is used to encrypt the restored file system. You can specify a key from another Amazon Web Services account provided that key it is properly shared with your account via Amazon Web Services KMS.PerformanceMode
: Specifies the throughput mode of the file system.CreationToken
: A user-supplied value that ensures the uniqueness (idempotency) of the request.newFileSystem
: A Boolean value that, if true, specifies that the recovery point is restored to a new Amazon EFS file system.ItemsToRestore
: An array of one to five strings where each string is a file path. UseItemsToRestore
to restore specific files or directories rather than the entire file system. This parameter is optional. For example,"itemsToRestore":"[\"/my.test\"]"
.
data StartRestoreJobResponse Source #
See: newStartRestoreJobResponse
smart constructor.
Instances
newStartRestoreJobResponse Source #
Create a value of StartRestoreJobResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
StartRestoreJobResponse
, startRestoreJobResponse_restoreJobId
- Uniquely identifies the job that restores a recovery point.
$sel:httpStatus:StartRestoreJobResponse'
, startRestoreJobResponse_httpStatus
- The response's http status code.
StopBackupJob
data StopBackupJob Source #
See: newStopBackupJob
smart constructor.
Instances
Create a value of StopBackupJob
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
StopBackupJob
, stopBackupJob_backupJobId
- Uniquely identifies a request to Backup to back up a resource.
data StopBackupJobResponse Source #
See: newStopBackupJobResponse
smart constructor.
Instances
Generic StopBackupJobResponse Source # | |
Defined in Amazonka.Backup.StopBackupJob type Rep StopBackupJobResponse :: Type -> Type # | |
Read StopBackupJobResponse Source # | |
Show StopBackupJobResponse Source # | |
Defined in Amazonka.Backup.StopBackupJob showsPrec :: Int -> StopBackupJobResponse -> ShowS # show :: StopBackupJobResponse -> String # showList :: [StopBackupJobResponse] -> ShowS # | |
NFData StopBackupJobResponse Source # | |
Defined in Amazonka.Backup.StopBackupJob rnf :: StopBackupJobResponse -> () # | |
Eq StopBackupJobResponse Source # | |
Defined in Amazonka.Backup.StopBackupJob (==) :: StopBackupJobResponse -> StopBackupJobResponse -> Bool # (/=) :: StopBackupJobResponse -> StopBackupJobResponse -> Bool # | |
type Rep StopBackupJobResponse Source # | |
newStopBackupJobResponse :: StopBackupJobResponse Source #
Create a value of StopBackupJobResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
TagResource
data TagResource Source #
See: newTagResource
smart constructor.
Instances
Create a value of TagResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
TagResource
, tagResource_resourceArn
- An ARN that uniquely identifies a resource. The format of the ARN
depends on the type of the tagged resource.
TagResource
, tagResource_tags
- Key-value pairs that are used to help organize your resources. You can
assign your own metadata to the resources you create. For clarity, this
is the structure to assign tags:
[{"Key":"string","Value":"string"}]
.
data TagResourceResponse Source #
See: newTagResourceResponse
smart constructor.
Instances
Generic TagResourceResponse Source # | |
Defined in Amazonka.Backup.TagResource type Rep TagResourceResponse :: Type -> Type # from :: TagResourceResponse -> Rep TagResourceResponse x # to :: Rep TagResourceResponse x -> TagResourceResponse # | |
Read TagResourceResponse Source # | |
Defined in Amazonka.Backup.TagResource | |
Show TagResourceResponse Source # | |
Defined in Amazonka.Backup.TagResource showsPrec :: Int -> TagResourceResponse -> ShowS # show :: TagResourceResponse -> String # showList :: [TagResourceResponse] -> ShowS # | |
NFData TagResourceResponse Source # | |
Defined in Amazonka.Backup.TagResource rnf :: TagResourceResponse -> () # | |
Eq TagResourceResponse Source # | |
Defined in Amazonka.Backup.TagResource (==) :: TagResourceResponse -> TagResourceResponse -> Bool # (/=) :: TagResourceResponse -> TagResourceResponse -> Bool # | |
type Rep TagResourceResponse Source # | |
newTagResourceResponse :: TagResourceResponse Source #
Create a value of TagResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
UntagResource
data UntagResource Source #
See: newUntagResource
smart constructor.
Instances
Create a value of UntagResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UntagResource
, untagResource_resourceArn
- An ARN that uniquely identifies a resource. The format of the ARN
depends on the type of the tagged resource.
$sel:tagKeyList:UntagResource'
, untagResource_tagKeyList
- A list of keys to identify which key-value tags to remove from a
resource.
data UntagResourceResponse Source #
See: newUntagResourceResponse
smart constructor.
Instances
Generic UntagResourceResponse Source # | |
Defined in Amazonka.Backup.UntagResource type Rep UntagResourceResponse :: Type -> Type # | |
Read UntagResourceResponse Source # | |
Show UntagResourceResponse Source # | |
Defined in Amazonka.Backup.UntagResource showsPrec :: Int -> UntagResourceResponse -> ShowS # show :: UntagResourceResponse -> String # showList :: [UntagResourceResponse] -> ShowS # | |
NFData UntagResourceResponse Source # | |
Defined in Amazonka.Backup.UntagResource rnf :: UntagResourceResponse -> () # | |
Eq UntagResourceResponse Source # | |
Defined in Amazonka.Backup.UntagResource (==) :: UntagResourceResponse -> UntagResourceResponse -> Bool # (/=) :: UntagResourceResponse -> UntagResourceResponse -> Bool # | |
type Rep UntagResourceResponse Source # | |
newUntagResourceResponse :: UntagResourceResponse Source #
Create a value of UntagResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
UpdateBackupPlan
data UpdateBackupPlan Source #
See: newUpdateBackupPlan
smart constructor.
Instances
Create a value of UpdateBackupPlan
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateBackupPlan
, updateBackupPlan_backupPlanId
- Uniquely identifies a backup plan.
$sel:backupPlan:UpdateBackupPlan'
, updateBackupPlan_backupPlan
- Specifies the body of a backup plan. Includes a BackupPlanName
and one
or more sets of Rules
.
data UpdateBackupPlanResponse Source #
See: newUpdateBackupPlanResponse
smart constructor.
UpdateBackupPlanResponse' (Maybe [AdvancedBackupSetting]) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) Int |
Instances
newUpdateBackupPlanResponse Source #
Create a value of UpdateBackupPlanResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateBackupPlanResponse
, updateBackupPlanResponse_advancedBackupSettings
- Contains a list of BackupOptions
for each resource type.
UpdateBackupPlanResponse
, updateBackupPlanResponse_backupPlanArn
- 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
.
UpdateBackupPlan
, updateBackupPlanResponse_backupPlanId
- Uniquely identifies a backup plan.
UpdateBackupPlanResponse
, updateBackupPlanResponse_creationDate
- The date and time a backup plan is created, in Unix format and
Coordinated Universal Time (UTC). The value of CreationDate
is
accurate to milliseconds. For example, the value 1516925490.087
represents Friday, January 26, 2018 12:11:30.087 AM.
UpdateBackupPlanResponse
, updateBackupPlanResponse_versionId
- Unique, randomly generated, Unicode, UTF-8 encoded strings that are at
most 1,024 bytes long. Version Ids cannot be edited.
$sel:httpStatus:UpdateBackupPlanResponse'
, updateBackupPlanResponse_httpStatus
- The response's http status code.
UpdateFramework
data UpdateFramework Source #
See: newUpdateFramework
smart constructor.
UpdateFramework' (Maybe [FrameworkControl]) (Maybe Text) (Maybe Text) Text |
Instances
Create a value of UpdateFramework
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:frameworkControls:UpdateFramework'
, updateFramework_frameworkControls
- A list of the controls that make up the framework. Each control in the
list has a name, input parameters, and scope.
UpdateFramework
, updateFramework_frameworkDescription
- An optional description of the framework with a maximum 1,024
characters.
$sel:idempotencyToken:UpdateFramework'
, updateFramework_idempotencyToken
- A customer-chosen string that you can use to distinguish between
otherwise identical calls to UpdateFrameworkInput
. Retrying a
successful request with the same idempotency token results in a success
message with no action taken.
UpdateFramework
, updateFramework_frameworkName
- The unique name of a framework. This name is between 1 and 256
characters, starting with a letter, and consisting of letters (a-z,
A-Z), numbers (0-9), and underscores (_).
data UpdateFrameworkResponse Source #
See: newUpdateFrameworkResponse
smart constructor.
Instances
newUpdateFrameworkResponse Source #
Create a value of UpdateFrameworkResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateFrameworkResponse
, updateFrameworkResponse_creationTime
- 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.
UpdateFrameworkResponse
, updateFrameworkResponse_frameworkArn
- An Amazon Resource Name (ARN) that uniquely identifies a resource. The
format of the ARN depends on the resource type.
UpdateFramework
, updateFrameworkResponse_frameworkName
- The unique name of a framework. This name is between 1 and 256
characters, starting with a letter, and consisting of letters (a-z,
A-Z), numbers (0-9), and underscores (_).
$sel:httpStatus:UpdateFrameworkResponse'
, updateFrameworkResponse_httpStatus
- The response's http status code.
UpdateGlobalSettings
data UpdateGlobalSettings Source #
See: newUpdateGlobalSettings
smart constructor.
Instances
newUpdateGlobalSettings :: UpdateGlobalSettings Source #
Create a value of UpdateGlobalSettings
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:globalSettings:UpdateGlobalSettings'
, updateGlobalSettings_globalSettings
- A value for isCrossAccountBackupEnabled
and a Region. Example:
update-global-settings --global-settings isCrossAccountBackupEnabled=false --region us-west-2
.
data UpdateGlobalSettingsResponse Source #
See: newUpdateGlobalSettingsResponse
smart constructor.
Instances
newUpdateGlobalSettingsResponse :: UpdateGlobalSettingsResponse Source #
Create a value of UpdateGlobalSettingsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
UpdateRecoveryPointLifecycle
data UpdateRecoveryPointLifecycle Source #
See: newUpdateRecoveryPointLifecycle
smart constructor.
Instances
newUpdateRecoveryPointLifecycle Source #
:: Text | |
-> Text | |
-> UpdateRecoveryPointLifecycle |
Create a value of UpdateRecoveryPointLifecycle
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateRecoveryPointLifecycle
, updateRecoveryPointLifecycle_lifecycle
- 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.
UpdateRecoveryPointLifecycle
, updateRecoveryPointLifecycle_backupVaultName
- 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.
UpdateRecoveryPointLifecycle
, updateRecoveryPointLifecycle_recoveryPointArn
- 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
.
data UpdateRecoveryPointLifecycleResponse Source #
See: newUpdateRecoveryPointLifecycleResponse
smart constructor.
UpdateRecoveryPointLifecycleResponse' (Maybe Text) (Maybe CalculatedLifecycle) (Maybe Lifecycle) (Maybe Text) Int |
Instances
newUpdateRecoveryPointLifecycleResponse Source #
Create a value of UpdateRecoveryPointLifecycleResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateRecoveryPointLifecycleResponse
, updateRecoveryPointLifecycleResponse_backupVaultArn
- An ARN that uniquely identifies a backup vault; for example,
arn:aws:backup:us-east-1:123456789012:vault:aBackupVault
.
UpdateRecoveryPointLifecycleResponse
, updateRecoveryPointLifecycleResponse_calculatedLifecycle
- A CalculatedLifecycle
object containing DeleteAt
and
MoveToColdStorageAt
timestamps.
UpdateRecoveryPointLifecycle
, updateRecoveryPointLifecycleResponse_lifecycle
- 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 are able to be transitioned to cold storage are listed in the "Lifecycle to cold storage" section of the Feature availability by resource table. Backup ignores this expression for other resource types.
UpdateRecoveryPointLifecycle
, updateRecoveryPointLifecycleResponse_recoveryPointArn
- 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
.
$sel:httpStatus:UpdateRecoveryPointLifecycleResponse'
, updateRecoveryPointLifecycleResponse_httpStatus
- The response's http status code.
UpdateRegionSettings
data UpdateRegionSettings Source #
See: newUpdateRegionSettings
smart constructor.
Instances
newUpdateRegionSettings :: UpdateRegionSettings Source #
Create a value of UpdateRegionSettings
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceTypeManagementPreference:UpdateRegionSettings'
, updateRegionSettings_resourceTypeManagementPreference
- Enables or disables full Backup management of backups for a resource
type. To enable full Backup management for DynamoDB along with
Backup's advanced DynamoDB backup features,
follow the procedure to
enable advanced DynamoDB backup programmatically.
$sel:resourceTypeOptInPreference:UpdateRegionSettings'
, updateRegionSettings_resourceTypeOptInPreference
- Updates the list of services along with the opt-in preferences for the
Region.
data UpdateRegionSettingsResponse Source #
See: newUpdateRegionSettingsResponse
smart constructor.
Instances
newUpdateRegionSettingsResponse :: UpdateRegionSettingsResponse Source #
Create a value of UpdateRegionSettingsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
UpdateReportPlan
data UpdateReportPlan Source #
See: newUpdateReportPlan
smart constructor.
UpdateReportPlan' (Maybe Text) (Maybe ReportDeliveryChannel) (Maybe Text) (Maybe ReportSetting) Text |
Instances
Create a value of UpdateReportPlan
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:idempotencyToken:UpdateReportPlan'
, updateReportPlan_idempotencyToken
- A customer-chosen string that you can use to distinguish between
otherwise identical calls to UpdateReportPlanInput
. Retrying a
successful request with the same idempotency token results in a success
message with no action taken.
UpdateReportPlan
, updateReportPlan_reportDeliveryChannel
- A structure that contains information about where to deliver your
reports, specifically your Amazon S3 bucket name, S3 key prefix, and the
formats of your reports.
UpdateReportPlan
, updateReportPlan_reportPlanDescription
- An optional description of the report plan with a maximum 1,024
characters.
UpdateReportPlan
, updateReportPlan_reportSetting
- 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.
UpdateReportPlan
, updateReportPlan_reportPlanName
- 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 (_).
data UpdateReportPlanResponse Source #
See: newUpdateReportPlanResponse
smart constructor.
Instances
newUpdateReportPlanResponse Source #
Create a value of UpdateReportPlanResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateReportPlanResponse
, updateReportPlanResponse_creationTime
- 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.
UpdateReportPlanResponse
, updateReportPlanResponse_reportPlanArn
- An Amazon Resource Name (ARN) that uniquely identifies a resource. The
format of the ARN depends on the resource type.
UpdateReportPlan
, updateReportPlanResponse_reportPlanName
- The unique name of the report plan.
$sel:httpStatus:UpdateReportPlanResponse'
, updateReportPlanResponse_httpStatus
- The response's http status code.
Types
BackupJobState
newtype BackupJobState Source #
pattern BackupJobState_ABORTED :: BackupJobState | |
pattern BackupJobState_ABORTING :: BackupJobState | |
pattern BackupJobState_COMPLETED :: BackupJobState | |
pattern BackupJobState_CREATED :: BackupJobState | |
pattern BackupJobState_EXPIRED :: BackupJobState | |
pattern BackupJobState_FAILED :: BackupJobState | |
pattern BackupJobState_PARTIAL :: BackupJobState | |
pattern BackupJobState_PENDING :: BackupJobState | |
pattern BackupJobState_RUNNING :: BackupJobState |
Instances
BackupVaultEvent
newtype BackupVaultEvent Source #
Instances
ConditionType
newtype ConditionType Source #
pattern ConditionType_STRINGEQUALS :: ConditionType |
Instances
CopyJobState
newtype CopyJobState Source #
pattern CopyJobState_COMPLETED :: CopyJobState | |
pattern CopyJobState_CREATED :: CopyJobState | |
pattern CopyJobState_FAILED :: CopyJobState | |
pattern CopyJobState_PARTIAL :: CopyJobState | |
pattern CopyJobState_RUNNING :: CopyJobState |
Instances
LegalHoldStatus
newtype LegalHoldStatus Source #
pattern LegalHoldStatus_ACTIVE :: LegalHoldStatus | |
pattern LegalHoldStatus_CANCELED :: LegalHoldStatus | |
pattern LegalHoldStatus_CANCELING :: LegalHoldStatus | |
pattern LegalHoldStatus_CREATING :: LegalHoldStatus |
Instances
RecoveryPointStatus
newtype RecoveryPointStatus Source #
pattern RecoveryPointStatus_COMPLETED :: RecoveryPointStatus | |
pattern RecoveryPointStatus_DELETING :: RecoveryPointStatus | |
pattern RecoveryPointStatus_EXPIRED :: RecoveryPointStatus | |
pattern RecoveryPointStatus_PARTIAL :: RecoveryPointStatus |
Instances
RestoreJobStatus
newtype RestoreJobStatus Source #
pattern RestoreJobStatus_ABORTED :: RestoreJobStatus | |
pattern RestoreJobStatus_COMPLETED :: RestoreJobStatus | |
pattern RestoreJobStatus_FAILED :: RestoreJobStatus | |
pattern RestoreJobStatus_PENDING :: RestoreJobStatus | |
pattern RestoreJobStatus_RUNNING :: RestoreJobStatus |
Instances
StorageClass
newtype StorageClass Source #
pattern StorageClass_COLD :: StorageClass | |
pattern StorageClass_DELETED :: StorageClass | |
pattern StorageClass_WARM :: StorageClass |
Instances
AdvancedBackupSetting
data AdvancedBackupSetting Source #
A list of backup options for each resource type.
See: newAdvancedBackupSetting
smart constructor.
Instances
newAdvancedBackupSetting :: AdvancedBackupSetting Source #
Create a value of AdvancedBackupSetting
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:backupOptions:AdvancedBackupSetting'
, advancedBackupSetting_backupOptions
- 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.
$sel:resourceType:AdvancedBackupSetting'
, advancedBackupSetting_resourceType
- 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
.
BackupJob
Contains detailed information about a backup job.
See: newBackupJob
smart constructor.
BackupJob' (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Integer) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe POSIX) (Maybe RecoveryPointCreator) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe BackupJobState) (Maybe Text) |
Instances
newBackupJob :: BackupJob Source #
Create a value of BackupJob
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accountId:BackupJob'
, backupJob_accountId
- The account ID that owns the backup job.
$sel:backupJobId:BackupJob'
, backupJob_backupJobId
- Uniquely identifies a request to Backup to back up a resource.
$sel:backupOptions:BackupJob'
, backupJob_backupOptions
- Specifies the backup option for a selected resource. This option is only
available for Windows Volume Shadow Copy Service (VSS) backup jobs.
Valid values: Set to "WindowsVSS":"enabled"
to enable the
WindowsVSS
backup option and create a Windows VSS backup. Set to
"WindowsVSS":"disabled"
to create a regular backup. If you specify
an invalid option, you get an InvalidParameterValueException
exception.
$sel:backupSizeInBytes:BackupJob'
, backupJob_backupSizeInBytes
- The size, in bytes, of a backup.
$sel:backupType:BackupJob'
, backupJob_backupType
- Represents the type of backup for a backup job.
$sel:backupVaultArn:BackupJob'
, backupJob_backupVaultArn
- An Amazon Resource Name (ARN) that uniquely identifies a backup vault;
for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault
.
$sel:backupVaultName:BackupJob'
, backupJob_backupVaultName
- 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.
$sel:bytesTransferred:BackupJob'
, backupJob_bytesTransferred
- The size in bytes transferred to a backup vault at the time that the job
status was queried.
$sel:completionDate:BackupJob'
, backupJob_completionDate
- The date and time a job to create a backup job is completed, in Unix
format and Coordinated Universal Time (UTC). The value of
CompletionDate
is accurate to milliseconds. For example, the value
1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
$sel:createdBy:BackupJob'
, backupJob_createdBy
- Contains identifying information about the creation of a backup job,
including the BackupPlanArn
, BackupPlanId
, BackupPlanVersion
, and
BackupRuleId
of the backup plan used to create it.
$sel:creationDate:BackupJob'
, backupJob_creationDate
- The date and time a backup job is created, in Unix format and
Coordinated Universal Time (UTC). The value of CreationDate
is
accurate to milliseconds. For example, the value 1516925490.087
represents Friday, January 26, 2018 12:11:30.087 AM.
$sel:expectedCompletionDate:BackupJob'
, backupJob_expectedCompletionDate
- The date and time a job to back up resources is expected to be
completed, in Unix format and Coordinated Universal Time (UTC). The
value of ExpectedCompletionDate
is accurate to milliseconds. For
example, the value 1516925490.087 represents Friday, January 26, 2018
12:11:30.087 AM.
$sel:iamRoleArn:BackupJob'
, backupJob_iamRoleArn
- Specifies the IAM role ARN used to create the target recovery point. IAM
roles other than the default role must include either AWSBackup
or
AwsBackup
in the role name. For example,
arn:aws:iam::123456789012:role/AWSBackupRDSAccess
. Role names without
those strings lack permissions to perform backup jobs.
$sel:isParent:BackupJob'
, backupJob_isParent
- This is a boolean value indicating this is a parent (composite) backup
job.
$sel:parentJobId:BackupJob'
, backupJob_parentJobId
- This uniquely identifies a request to Backup to back up a resource. The
return will be the parent (composite) job ID.
$sel:percentDone:BackupJob'
, backupJob_percentDone
- Contains an estimated percentage complete of a job at the time the job
status was queried.
$sel:recoveryPointArn:BackupJob'
, backupJob_recoveryPointArn
- An ARN that uniquely identifies a recovery point; for example,
arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45
.
$sel:resourceArn:BackupJob'
, backupJob_resourceArn
- An ARN that uniquely identifies a resource. The format of the ARN
depends on the resource type.
$sel:resourceType:BackupJob'
, backupJob_resourceType
- The type of Amazon Web Services resource to be backed up; for example,
an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon
Relational Database Service (Amazon RDS) database. For Windows Volume
Shadow Copy Service (VSS) backups, the only supported resource type is
Amazon EC2.
$sel:startBy:BackupJob'
, backupJob_startBy
- 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.
$sel:state:BackupJob'
, backupJob_state
- The current state of a resource recovery point.
$sel:statusMessage:BackupJob'
, backupJob_statusMessage
- A detailed message explaining the status of the job to back up a
resource.
BackupPlan
data BackupPlan Source #
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 Amazon Web Services resources.
See: newBackupPlan
smart constructor.
Instances
Create a value of BackupPlan
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:advancedBackupSettings:BackupPlan'
, backupPlan_advancedBackupSettings
- Contains a list of BackupOptions
for each resource type.
$sel:backupPlanName:BackupPlan'
, backupPlan_backupPlanName
- The display name of a backup plan. Must contain 1 to 50 alphanumeric or
'-_.' characters.
$sel:rules:BackupPlan'
, backupPlan_rules
- An array of BackupRule
objects, each of which specifies a scheduled
task that is used to back up a selection of resources.
BackupPlanInput
data BackupPlanInput Source #
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.
See: newBackupPlanInput
smart constructor.
Instances
Create a value of BackupPlanInput
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:advancedBackupSettings:BackupPlanInput'
, backupPlanInput_advancedBackupSettings
- Specifies a list of BackupOptions
for each resource type. These
settings are only available for Windows Volume Shadow Copy Service (VSS)
backup jobs.
$sel:backupPlanName:BackupPlanInput'
, backupPlanInput_backupPlanName
- The display name of a backup plan. Must contain 1 to 50 alphanumeric or
'-_.' characters.
$sel:rules:BackupPlanInput'
, backupPlanInput_rules
- An array of BackupRule
objects, each of which specifies a scheduled
task that is used to back up a selection of resources.
BackupPlanTemplatesListMember
data BackupPlanTemplatesListMember Source #
An object specifying metadata associated with a backup plan template.
See: newBackupPlanTemplatesListMember
smart constructor.
Instances
newBackupPlanTemplatesListMember :: BackupPlanTemplatesListMember Source #
Create a value of BackupPlanTemplatesListMember
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:backupPlanTemplateId:BackupPlanTemplatesListMember'
, backupPlanTemplatesListMember_backupPlanTemplateId
- Uniquely identifies a stored backup plan template.
$sel:backupPlanTemplateName:BackupPlanTemplatesListMember'
, backupPlanTemplatesListMember_backupPlanTemplateName
- The optional display name of a backup plan template.
BackupPlansListMember
data BackupPlansListMember Source #
Contains metadata about a backup plan.
See: newBackupPlansListMember
smart constructor.
BackupPlansListMember' (Maybe [AdvancedBackupSetting]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe Text) |
Instances
newBackupPlansListMember :: BackupPlansListMember Source #
Create a value of BackupPlansListMember
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:advancedBackupSettings:BackupPlansListMember'
, backupPlansListMember_advancedBackupSettings
- Contains a list of BackupOptions
for a resource type.
$sel:backupPlanArn:BackupPlansListMember'
, backupPlansListMember_backupPlanArn
- 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
.
$sel:backupPlanId:BackupPlansListMember'
, backupPlansListMember_backupPlanId
- Uniquely identifies a backup plan.
$sel:backupPlanName:BackupPlansListMember'
, backupPlansListMember_backupPlanName
- The display name of a saved backup plan.
$sel:creationDate:BackupPlansListMember'
, backupPlansListMember_creationDate
- The date and time a resource backup plan is created, in Unix format and
Coordinated Universal Time (UTC). The value of CreationDate
is
accurate to milliseconds. For example, the value 1516925490.087
represents Friday, January 26, 2018 12:11:30.087 AM.
$sel:creatorRequestId:BackupPlansListMember'
, backupPlansListMember_creatorRequestId
- 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.
$sel:deletionDate:BackupPlansListMember'
, backupPlansListMember_deletionDate
- 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.
$sel:lastExecutionDate:BackupPlansListMember'
, backupPlansListMember_lastExecutionDate
- The last time a job to back up resources was run with this rule. A date
and time, in Unix format and Coordinated Universal Time (UTC). The value
of LastExecutionDate
is accurate to milliseconds. For example, the
value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087
AM.
$sel:versionId:BackupPlansListMember'
, backupPlansListMember_versionId
- Unique, randomly generated, Unicode, UTF-8 encoded strings that are at
most 1,024 bytes long. Version IDs cannot be edited.
BackupRule
data BackupRule Source #
Specifies a scheduled task used to back up a selection of resources.
See: newBackupRule
smart constructor.
BackupRule' (Maybe Integer) (Maybe [CopyAction]) (Maybe Bool) (Maybe Lifecycle) (Maybe (Sensitive (HashMap Text Text))) (Maybe Text) (Maybe Text) (Maybe Integer) Text Text |
Instances
Create a value of BackupRule
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:completionWindowMinutes:BackupRule'
, backupRule_completionWindowMinutes
- 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.
$sel:copyActions:BackupRule'
, backupRule_copyActions
- An array of CopyAction
objects, which contains the details of the copy
operation.
$sel:enableContinuousBackup:BackupRule'
, backupRule_enableContinuousBackup
- 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.
BackupRule
, backupRule_lifecycle
- 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 are able to be transitioned to cold storage are listed in the "Lifecycle to cold storage" section of the Feature availability by resource table. Backup ignores this expression for other resource types.
$sel:recoveryPointTags:BackupRule'
, backupRule_recoveryPointTags
- An array of key-value pair strings that are assigned to resources that
are associated with this rule when restored from backup.
$sel:ruleId:BackupRule'
, backupRule_ruleId
- Uniquely identifies a rule that is used to schedule the backup of a
selection of resources.
$sel:scheduleExpression:BackupRule'
, backupRule_scheduleExpression
- 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.
$sel:startWindowMinutes:BackupRule'
, backupRule_startWindowMinutes
- 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.
$sel:ruleName:BackupRule'
, backupRule_ruleName
- A display name for a backup rule. Must contain 1 to 50 alphanumeric or
'-_.' characters.
$sel:targetBackupVaultName:BackupRule'
, backupRule_targetBackupVaultName
- 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.
BackupRuleInput
data BackupRuleInput Source #
Specifies a scheduled task used to back up a selection of resources.
See: newBackupRuleInput
smart constructor.
BackupRuleInput' (Maybe Integer) (Maybe [CopyAction]) (Maybe Bool) (Maybe Lifecycle) (Maybe (Sensitive (HashMap Text Text))) (Maybe Text) (Maybe Integer) Text Text |
Instances
:: Text | |
-> Text | |
-> BackupRuleInput |
Create a value of BackupRuleInput
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:completionWindowMinutes:BackupRuleInput'
, backupRuleInput_completionWindowMinutes
- 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.
$sel:copyActions:BackupRuleInput'
, backupRuleInput_copyActions
- An array of CopyAction
objects, which contains the details of the copy
operation.
$sel:enableContinuousBackup:BackupRuleInput'
, backupRuleInput_enableContinuousBackup
- 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.
BackupRuleInput
, backupRuleInput_lifecycle
- 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.
Resource types that are able to be transitioned to cold storage are listed in the "Lifecycle to cold storage" section of the Feature availability by resource table. Backup ignores this expression for other resource types.
$sel:recoveryPointTags:BackupRuleInput'
, backupRuleInput_recoveryPointTags
- To help organize your resources, you can assign your own metadata to the
resources that you create. Each tag is a key-value pair.
$sel:scheduleExpression:BackupRuleInput'
, backupRuleInput_scheduleExpression
- A CRON expression in UTC specifying when Backup initiates a backup job.
$sel:startWindowMinutes:BackupRuleInput'
, backupRuleInput_startWindowMinutes
- 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.
$sel:ruleName:BackupRuleInput'
, backupRuleInput_ruleName
- A display name for a backup rule. Must contain 1 to 50 alphanumeric or
'-_.' characters.
$sel:targetBackupVaultName:BackupRuleInput'
, backupRuleInput_targetBackupVaultName
- 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.
BackupSelection
data BackupSelection Source #
Used to specify a set of resources to a backup plan.
Specifying your desired Conditions
, ListOfTags
, NotResources
,
and/or Resources
is recommended. If none of these are specified,
Backup will attempt to select all supported and opted-in storage
resources, which could have unintended cost implications.
See: newBackupSelection
smart constructor.
Instances
Create a value of BackupSelection
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:conditions:BackupSelection'
, backupSelection_conditions
- A list of conditions that you define to assign resources to your backup
plans using tags. For example,
"StringEquals": { "ConditionKey": "aws:ResourceTag/CreatedByCryo", "ConditionValue": "true" },
.
Condition operators are case sensitive.
Conditions
differs from ListOfTags
as follows:
- When you specify more than one condition, you only assign the resources that match ALL conditions (using AND logic).
Conditions
supportsStringEquals
,StringLike
,StringNotEquals
, andStringNotLike
.ListOfTags
only supportsStringEquals
.
$sel:listOfTags:BackupSelection'
, backupSelection_listOfTags
- A list of conditions that you define to assign resources to your backup
plans using tags. For example,
"StringEquals": { "ConditionKey": "aws:ResourceTag/CreatedByCryo", "ConditionValue": "true" },
.
Condition operators are case sensitive.
ListOfTags
differs from Conditions
as follows:
- When you specify more than one condition, you assign all resources that match AT LEAST ONE condition (using OR logic).
ListOfTags
only supportsStringEquals
.Conditions
supportsStringEquals
,StringLike
,StringNotEquals
, andStringNotLike
.
$sel:notResources:BackupSelection'
, backupSelection_notResources
- A list of Amazon Resource Names (ARNs) 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.
$sel:resources:BackupSelection'
, backupSelection_resources
- A list of Amazon Resource Names (ARNs) 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.
$sel:selectionName:BackupSelection'
, backupSelection_selectionName
- The display name of a resource selection document. Must contain 1 to 50
alphanumeric or '-_.' characters.
$sel:iamRoleArn:BackupSelection'
, backupSelection_iamRoleArn
- 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
.
BackupSelectionsListMember
data BackupSelectionsListMember Source #
Contains metadata about a BackupSelection
object.
See: newBackupSelectionsListMember
smart constructor.
BackupSelectionsListMember' (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newBackupSelectionsListMember :: BackupSelectionsListMember Source #
Create a value of BackupSelectionsListMember
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:backupPlanId:BackupSelectionsListMember'
, backupSelectionsListMember_backupPlanId
- Uniquely identifies a backup plan.
$sel:creationDate:BackupSelectionsListMember'
, backupSelectionsListMember_creationDate
- The date and time a backup plan is created, in Unix format and
Coordinated Universal Time (UTC). The value of CreationDate
is
accurate to milliseconds. For example, the value 1516925490.087
represents Friday, January 26, 2018 12:11:30.087 AM.
$sel:creatorRequestId:BackupSelectionsListMember'
, backupSelectionsListMember_creatorRequestId
- 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.
$sel:iamRoleArn:BackupSelectionsListMember'
, backupSelectionsListMember_iamRoleArn
- Specifies the IAM role Amazon Resource Name (ARN) to create the target
recovery point; for example, arn:aws:iam::123456789012:role/S3Access
.
$sel:selectionId:BackupSelectionsListMember'
, backupSelectionsListMember_selectionId
- Uniquely identifies a request to assign a set of resources to a backup
plan.
$sel:selectionName:BackupSelectionsListMember'
, backupSelectionsListMember_selectionName
- The display name of a resource selection document.
BackupVaultListMember
data BackupVaultListMember Source #
Contains metadata about a backup vault.
See: newBackupVaultListMember
smart constructor.
BackupVaultListMember' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Bool) (Maybe Integer) (Maybe Integer) (Maybe Integer) |
Instances
newBackupVaultListMember :: BackupVaultListMember Source #
Create a value of BackupVaultListMember
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:backupVaultArn:BackupVaultListMember'
, backupVaultListMember_backupVaultArn
- An Amazon Resource Name (ARN) that uniquely identifies a backup vault;
for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault
.
$sel:backupVaultName:BackupVaultListMember'
, backupVaultListMember_backupVaultName
- 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.
$sel:creationDate:BackupVaultListMember'
, backupVaultListMember_creationDate
- The date and time a resource backup is created, in Unix format and
Coordinated Universal Time (UTC). The value of CreationDate
is
accurate to milliseconds. For example, the value 1516925490.087
represents Friday, January 26, 2018 12:11:30.087 AM.
$sel:creatorRequestId:BackupVaultListMember'
, backupVaultListMember_creatorRequestId
- 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.
$sel:encryptionKeyArn:BackupVaultListMember'
, backupVaultListMember_encryptionKeyArn
- A server-side encryption key you can specify to encrypt your backups
from services that support full Backup management; for example,
arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
.
If you specify a key, you must specify its ARN, not its alias. If you do
not specify a key, Backup creates a KMS key for you by default.
To learn which Backup services support full Backup management and how Backup handles encryption for backups from services that do not yet support full Backup, see Encryption for backups in Backup
$sel:lockDate:BackupVaultListMember'
, backupVaultListMember_lockDate
- The date and time when Backup Vault Lock configuration becomes
immutable, meaning it cannot be changed or deleted.
If you applied Vault Lock to your vault without specifying a lock date, you can change 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.
$sel:locked:BackupVaultListMember'
, backupVaultListMember_locked
- A Boolean value that indicates whether Backup Vault Lock applies to the
selected backup vault. If true
, Vault Lock prevents delete and update
operations on the recovery points in the selected vault.
$sel:maxRetentionDays:BackupVaultListMember'
, backupVaultListMember_maxRetentionDays
- 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.
$sel:minRetentionDays:BackupVaultListMember'
, backupVaultListMember_minRetentionDays
- 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 does 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.
$sel:numberOfRecoveryPoints:BackupVaultListMember'
, backupVaultListMember_numberOfRecoveryPoints
- The number of recovery points that are stored in a backup vault.
CalculatedLifecycle
data CalculatedLifecycle Source #
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. 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 are able to be transitioned to cold storage are listed in the "Lifecycle to cold storage" section of the Feature availability by resource table. Backup ignores this expression for other resource types.
See: newCalculatedLifecycle
smart constructor.
Instances
newCalculatedLifecycle :: CalculatedLifecycle Source #
Create a value of CalculatedLifecycle
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:deleteAt:CalculatedLifecycle'
, calculatedLifecycle_deleteAt
- A timestamp that specifies when to delete a recovery point.
$sel:moveToColdStorageAt:CalculatedLifecycle'
, calculatedLifecycle_moveToColdStorageAt
- A timestamp that specifies when to transition a recovery point to cold
storage.
Condition
Contains an array of triplets made up of a condition type (such as
StringEquals
), a key, and a value. Used to filter resources using
their tags and assign them to a backup plan. Case sensitive.
See: newCondition
smart constructor.
Instances
FromJSON Condition Source # | |
ToJSON Condition Source # | |
Defined in Amazonka.Backup.Types.Condition | |
Generic Condition Source # | |
Read Condition Source # | |
Show Condition Source # | |
NFData Condition Source # | |
Defined in Amazonka.Backup.Types.Condition | |
Eq Condition Source # | |
Hashable Condition Source # | |
Defined in Amazonka.Backup.Types.Condition | |
type Rep Condition Source # | |
Defined in Amazonka.Backup.Types.Condition type Rep Condition = D1 ('MetaData "Condition" "Amazonka.Backup.Types.Condition" "amazonka-backup-2.0-LovIt41tphM6jvgQJhTyRf" 'False) (C1 ('MetaCons "Condition'" 'PrefixI 'True) (S1 ('MetaSel ('Just "conditionType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ConditionType) :*: (S1 ('MetaSel ('Just "conditionKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "conditionValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))) |
:: ConditionType | |
-> Text | |
-> Text | |
-> Condition |
Create a value of Condition
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:conditionType:Condition'
, condition_conditionType
- 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
.
$sel:conditionKey:Condition'
, condition_conditionKey
- The key in a key-value pair. For example, in the tag
Department: Accounting
, Department
is the key.
$sel:conditionValue:Condition'
, condition_conditionValue
- The value in a key-value pair. For example, in the tag
Department: Accounting
, Accounting
is the value.
ConditionParameter
data ConditionParameter Source #
Includes information about tags you define to assign tagged resources to a backup plan.
See: newConditionParameter
smart constructor.
Instances
newConditionParameter :: ConditionParameter Source #
Create a value of ConditionParameter
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:conditionKey:ConditionParameter'
, conditionParameter_conditionKey
- The key in a key-value pair. For example, in the tag
Department: Accounting
, Department
is the key.
$sel:conditionValue:ConditionParameter'
, conditionParameter_conditionValue
- The value in a key-value pair. For example, in the tag
Department: Accounting
, Accounting
is the value.
Conditions
data Conditions Source #
Contains information about which resources to include or exclude from a backup plan using their tags. Conditions are case sensitive.
See: newConditions
smart constructor.
Conditions' (Maybe [ConditionParameter]) (Maybe [ConditionParameter]) (Maybe [ConditionParameter]) (Maybe [ConditionParameter]) |
Instances
newConditions :: Conditions Source #
Create a value of Conditions
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:stringEquals:Conditions'
, conditions_stringEquals
- Filters the values of your tagged resources for only those resources
that you tagged with the same value. Also called "exact matching."
$sel:stringLike:Conditions'
, conditions_stringLike
- 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".
$sel:stringNotEquals:Conditions'
, conditions_stringNotEquals
- 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."
$sel:stringNotLike:Conditions'
, conditions_stringNotLike
- Filters the values of your tagged resources for non-matching tag values
with the use of a wildcard character (*) anywhere in the string.
ControlInputParameter
data ControlInputParameter Source #
A list of parameters for a control. A control can have zero, one, or
more than one parameter. An example of a control with two parameters is:
"backup plan frequency is at least daily
and the retention period is
at least 1 year
". The first parameter is daily
. The second
parameter is 1 year
.
See: newControlInputParameter
smart constructor.
Instances
newControlInputParameter :: ControlInputParameter Source #
Create a value of ControlInputParameter
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:parameterName:ControlInputParameter'
, controlInputParameter_parameterName
- The name of a parameter, for example, BackupPlanFrequency
.
$sel:parameterValue:ControlInputParameter'
, controlInputParameter_parameterValue
- The value of parameter, for example, hourly
.
ControlScope
data ControlScope Source #
A framework consists of one or more controls. Each control has its own control scope. The control scope can include one or more resource types, a combination of a tag key and value, or a combination of one resource type and one resource ID. If no scope is specified, evaluations for the rule are triggered when any resource in your recording group changes in configuration.
To set a control scope that includes all of a particular resource, leave
the ControlScope
empty or do not pass it when calling
CreateFramework
.
See: newControlScope
smart constructor.
Instances
newControlScope :: ControlScope Source #
Create a value of ControlScope
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:complianceResourceIds:ControlScope'
, controlScope_complianceResourceIds
- The ID of the only Amazon Web Services resource that you want your
control scope to contain.
$sel:complianceResourceTypes:ControlScope'
, controlScope_complianceResourceTypes
- Describes whether the control scope includes one or more types of
resources, such as EFS
or RDS
.
$sel:tags:ControlScope'
, controlScope_tags
- 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. The structure to assign a tag is:
[{"Key":"string","Value":"string"}]
.
CopyAction
data CopyAction Source #
The details of the copy operation.
See: newCopyAction
smart constructor.
Instances
Create a value of CopyAction
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:lifecycle:CopyAction'
, copyAction_lifecycle
- Undocumented member.
$sel:destinationBackupVaultArn:CopyAction'
, copyAction_destinationBackupVaultArn
- An Amazon Resource Name (ARN) that uniquely identifies the destination
backup vault for the copied backup. For example,
arn:aws:backup:us-east-1:123456789012:vault:aBackupVault
.
CopyJob
Contains detailed information about a copy job.
See: newCopyJob
smart constructor.
CopyJob' (Maybe Text) (Maybe Integer) (Maybe (HashMap CopyJobState Integer)) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe RecoveryPointCreator) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Integer) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe CopyJobState) (Maybe Text) |
Instances
newCopyJob :: CopyJob Source #
Create a value of CopyJob
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accountId:CopyJob'
, copyJob_accountId
- The account ID that owns the copy job.
$sel:backupSizeInBytes:CopyJob'
, copyJob_backupSizeInBytes
- The size, in bytes, of a copy job.
$sel:childJobsInState:CopyJob'
, copyJob_childJobsInState
- This returns the statistics of the included child (nested) copy jobs.
$sel:completionDate:CopyJob'
, copyJob_completionDate
- 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.
$sel:compositeMemberIdentifier:CopyJob'
, copyJob_compositeMemberIdentifier
- This is 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.
$sel:copyJobId:CopyJob'
, copyJob_copyJobId
- Uniquely identifies a copy job.
$sel:createdBy:CopyJob'
, copyJob_createdBy
- Undocumented member.
$sel:creationDate:CopyJob'
, copyJob_creationDate
- 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.
$sel:destinationBackupVaultArn:CopyJob'
, copyJob_destinationBackupVaultArn
- An Amazon Resource Name (ARN) that uniquely identifies a destination
copy vault; for example,
arn:aws:backup:us-east-1:123456789012:vault:aBackupVault
.
$sel:destinationRecoveryPointArn:CopyJob'
, copyJob_destinationRecoveryPointArn
- 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
.
$sel:iamRoleArn:CopyJob'
, copyJob_iamRoleArn
- Specifies the IAM role ARN used to copy the target recovery point; for
example, arn:aws:iam::123456789012:role/S3Access
.
$sel:isParent:CopyJob'
, copyJob_isParent
- This is a boolean value indicating this is a parent (composite) copy
job.
$sel:numberOfChildJobs:CopyJob'
, copyJob_numberOfChildJobs
- This is the number of child (nested) copy jobs.
$sel:parentJobId:CopyJob'
, copyJob_parentJobId
- This uniquely identifies a request to Backup to copy a resource. The
return will be the parent (composite) job ID.
$sel:resourceArn:CopyJob'
, copyJob_resourceArn
- 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.
$sel:resourceType:CopyJob'
, copyJob_resourceType
- 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.
$sel:sourceBackupVaultArn:CopyJob'
, copyJob_sourceBackupVaultArn
- An Amazon Resource Name (ARN) that uniquely identifies a source copy
vault; for example,
arn:aws:backup:us-east-1:123456789012:vault:aBackupVault
.
$sel:sourceRecoveryPointArn:CopyJob'
, copyJob_sourceRecoveryPointArn
- 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
.
$sel:state:CopyJob'
, copyJob_state
- The current state of a copy job.
$sel:statusMessage:CopyJob'
, copyJob_statusMessage
- A detailed message explaining the status of the job to copy a resource.
DateRange
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.
See: newDateRange
smart constructor.
Instances
FromJSON DateRange Source # | |
ToJSON DateRange Source # | |
Defined in Amazonka.Backup.Types.DateRange | |
Generic DateRange Source # | |
Read DateRange Source # | |
Show DateRange Source # | |
NFData DateRange Source # | |
Defined in Amazonka.Backup.Types.DateRange | |
Eq DateRange Source # | |
Hashable DateRange Source # | |
Defined in Amazonka.Backup.Types.DateRange | |
type Rep DateRange Source # | |
Defined in Amazonka.Backup.Types.DateRange type Rep DateRange = D1 ('MetaData "DateRange" "Amazonka.Backup.Types.DateRange" "amazonka-backup-2.0-LovIt41tphM6jvgQJhTyRf" 'False) (C1 ('MetaCons "DateRange'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :*: S1 ('MetaSel ('Just "toDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX))) |
Create a value of DateRange
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:fromDate:DateRange'
, dateRange_fromDate
- 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).
$sel:toDate:DateRange'
, dateRange_toDate
- 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).
Framework
Contains detailed information about a framework. Frameworks contain controls, which evaluate and report on your backup events and resources. Frameworks generate daily compliance results.
See: newFramework
smart constructor.
Instances
newFramework :: Framework Source #
Create a value of Framework
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:creationTime:Framework'
, framework_creationTime
- 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.
$sel:deploymentStatus:Framework'
, framework_deploymentStatus
- The deployment status of a framework. The statuses are:
CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED
$sel:frameworkArn:Framework'
, framework_frameworkArn
- An Amazon Resource Name (ARN) that uniquely identifies a resource. The
format of the ARN depends on the resource type.
$sel:frameworkDescription:Framework'
, framework_frameworkDescription
- An optional description of the framework with a maximum 1,024
characters.
$sel:frameworkName:Framework'
, framework_frameworkName
- The unique name of a framework. This name is between 1 and 256
characters, starting with a letter, and consisting of letters (a-z,
A-Z), numbers (0-9), and underscores (_).
$sel:numberOfControls:Framework'
, framework_numberOfControls
- The number of controls contained by the framework.
FrameworkControl
data FrameworkControl Source #
Contains detailed information about all of the controls of a framework. Each framework must contain at least one control.
See: newFrameworkControl
smart constructor.
Instances
Create a value of FrameworkControl
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:controlInputParameters:FrameworkControl'
, frameworkControl_controlInputParameters
- A list of ParameterName
and ParameterValue
pairs.
$sel:controlScope:FrameworkControl'
, frameworkControl_controlScope
- 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.
$sel:controlName:FrameworkControl'
, frameworkControl_controlName
- The name of a control. This name is between 1 and 256 characters.
LegalHold
A legal hold is an administrative tool that helps prevent backups from being deleted while under a hold. While the hold is in place, backups under a hold cannot be deleted and lifecycle policies that would alter the backup status (such as transition to cold storage) are delayed until the legal hold is removed. A backup can have more than one legal hold. Legal holds are applied to one or more backups (also known as recovery points). These backups can be filtered by resource types and by resource IDs.
See: newLegalHold
smart constructor.
LegalHold' (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe LegalHoldStatus) (Maybe Text) |
Instances
newLegalHold :: LegalHold Source #
Create a value of LegalHold
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:cancellationDate:LegalHold'
, legalHold_cancellationDate
- This is the time in number format when legal hold was cancelled.
$sel:creationDate:LegalHold'
, legalHold_creationDate
- This is the time in number format when legal hold was created.
$sel:description:LegalHold'
, legalHold_description
- This is the description of a legal hold.
$sel:legalHoldArn:LegalHold'
, legalHold_legalHoldArn
- This is an Amazon Resource Number (ARN) that uniquely identifies the
legal hold; for example,
arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45
.
$sel:legalHoldId:LegalHold'
, legalHold_legalHoldId
- ID of specific legal hold on one or more recovery points.
$sel:status:LegalHold'
, legalHold_status
- This is the status of the legal hold. Statuses can be ACTIVE
,
CREATING
, CANCELED
, and CANCELING
.
$sel:title:LegalHold'
, legalHold_title
- This is the title of a legal hold.
Lifecycle
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 “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 are able to be transitioned to cold storage are listed in the "Lifecycle to cold storage" section of the Feature availability by resource table. Backup ignores this expression for other resource types.
See: newLifecycle
smart constructor.
Instances
FromJSON Lifecycle Source # | |
ToJSON Lifecycle Source # | |
Defined in Amazonka.Backup.Types.Lifecycle | |
Generic Lifecycle Source # | |
Read Lifecycle Source # | |
Show Lifecycle Source # | |
NFData Lifecycle Source # | |
Defined in Amazonka.Backup.Types.Lifecycle | |
Eq Lifecycle Source # | |
Hashable Lifecycle Source # | |
Defined in Amazonka.Backup.Types.Lifecycle | |
type Rep Lifecycle Source # | |
Defined in Amazonka.Backup.Types.Lifecycle type Rep Lifecycle = D1 ('MetaData "Lifecycle" "Amazonka.Backup.Types.Lifecycle" "amazonka-backup-2.0-LovIt41tphM6jvgQJhTyRf" 'False) (C1 ('MetaCons "Lifecycle'" 'PrefixI 'True) (S1 ('MetaSel ('Just "deleteAfterDays") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "moveToColdStorageAfterDays") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)))) |
newLifecycle :: Lifecycle Source #
Create a value of Lifecycle
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:deleteAfterDays:Lifecycle'
, lifecycle_deleteAfterDays
- Specifies the number of days after creation that a recovery point is
deleted. Must be greater than 90 days plus MoveToColdStorageAfterDays
.
$sel:moveToColdStorageAfterDays:Lifecycle'
, lifecycle_moveToColdStorageAfterDays
- Specifies the number of days after creation that a recovery point is
moved to cold storage.
ProtectedResource
data ProtectedResource Source #
A structure that contains information about a backed-up resource.
See: newProtectedResource
smart constructor.
Instances
newProtectedResource :: ProtectedResource Source #
Create a value of ProtectedResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:lastBackupTime:ProtectedResource'
, protectedResource_lastBackupTime
- The date and time a resource was last backed up, in Unix format and
Coordinated Universal Time (UTC). The value of LastBackupTime
is
accurate to milliseconds. For example, the value 1516925490.087
represents Friday, January 26, 2018 12:11:30.087 AM.
$sel:resourceArn:ProtectedResource'
, protectedResource_resourceArn
- An Amazon Resource Name (ARN) that uniquely identifies a resource. The
format of the ARN depends on the resource type.
$sel:resourceType:ProtectedResource'
, protectedResource_resourceType
- The type of Amazon Web Services resource; for example, an Amazon Elastic
Block Store (Amazon EBS) volume or an Amazon Relational Database Service
(Amazon RDS) database. For Windows Volume Shadow Copy Service (VSS)
backups, the only supported resource type is Amazon EC2.
RecoveryPointByBackupVault
data RecoveryPointByBackupVault Source #
Contains detailed information about the recovery points stored in a backup vault.
See: newRecoveryPointByBackupVault
smart constructor.
RecoveryPointByBackupVault' (Maybe Integer) (Maybe Text) (Maybe Text) (Maybe CalculatedLifecycle) (Maybe POSIX) (Maybe Text) (Maybe RecoveryPointCreator) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe POSIX) (Maybe Lifecycle) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe RecoveryPointStatus) (Maybe Text) |
Instances
newRecoveryPointByBackupVault :: RecoveryPointByBackupVault Source #
Create a value of RecoveryPointByBackupVault
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:backupSizeInBytes:RecoveryPointByBackupVault'
, recoveryPointByBackupVault_backupSizeInBytes
- The size, in bytes, of a backup.
$sel:backupVaultArn:RecoveryPointByBackupVault'
, recoveryPointByBackupVault_backupVaultArn
- An ARN that uniquely identifies a backup vault; for example,
arn:aws:backup:us-east-1:123456789012:vault:aBackupVault
.
$sel:backupVaultName:RecoveryPointByBackupVault'
, recoveryPointByBackupVault_backupVaultName
- 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.
$sel:calculatedLifecycle:RecoveryPointByBackupVault'
, recoveryPointByBackupVault_calculatedLifecycle
- A CalculatedLifecycle
object containing DeleteAt
and
MoveToColdStorageAt
timestamps.
$sel:completionDate:RecoveryPointByBackupVault'
, recoveryPointByBackupVault_completionDate
- The date and time a job to restore a recovery point is completed, in
Unix format and Coordinated Universal Time (UTC). The value of
CompletionDate
is accurate to milliseconds. For example, the value
1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
$sel:compositeMemberIdentifier:RecoveryPointByBackupVault'
, recoveryPointByBackupVault_compositeMemberIdentifier
- This is 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.
$sel:createdBy:RecoveryPointByBackupVault'
, recoveryPointByBackupVault_createdBy
- Contains identifying information about the creation of a recovery point,
including the BackupPlanArn
, BackupPlanId
, BackupPlanVersion
, and
BackupRuleId
of the backup plan that is used to create it.
$sel:creationDate:RecoveryPointByBackupVault'
, recoveryPointByBackupVault_creationDate
- The date and time a recovery point is created, in Unix format and
Coordinated Universal Time (UTC). The value of CreationDate
is
accurate to milliseconds. For example, the value 1516925490.087
represents Friday, January 26, 2018 12:11:30.087 AM.
$sel:encryptionKeyArn:RecoveryPointByBackupVault'
, recoveryPointByBackupVault_encryptionKeyArn
- 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
.
$sel:iamRoleArn:RecoveryPointByBackupVault'
, recoveryPointByBackupVault_iamRoleArn
- Specifies the IAM role ARN used to create the target recovery point; for
example, arn:aws:iam::123456789012:role/S3Access
.
$sel:isEncrypted:RecoveryPointByBackupVault'
, recoveryPointByBackupVault_isEncrypted
- A Boolean value that is returned as TRUE
if the specified recovery
point is encrypted, or FALSE
if the recovery point is not encrypted.
$sel:isParent:RecoveryPointByBackupVault'
, recoveryPointByBackupVault_isParent
- This is a boolean value indicating this is a parent (composite) recovery
point.
$sel:lastRestoreTime:RecoveryPointByBackupVault'
, recoveryPointByBackupVault_lastRestoreTime
- The date and time a recovery point was last restored, in Unix format and
Coordinated Universal Time (UTC). The value of LastRestoreTime
is
accurate to milliseconds. For example, the value 1516925490.087
represents Friday, January 26, 2018 12:11:30.087 AM.
$sel:lifecycle:RecoveryPointByBackupVault'
, recoveryPointByBackupVault_lifecycle
- 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 are able to be transitioned to cold storage are listed in the "Lifecycle to cold storage" section of the Feature availability by resource table. Backup ignores this expression for other resource types.
$sel:parentRecoveryPointArn:RecoveryPointByBackupVault'
, recoveryPointByBackupVault_parentRecoveryPointArn
- This is the Amazon Resource Name (ARN) of the parent (composite)
recovery point.
$sel:recoveryPointArn:RecoveryPointByBackupVault'
, recoveryPointByBackupVault_recoveryPointArn
- 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
.
$sel:resourceArn:RecoveryPointByBackupVault'
, recoveryPointByBackupVault_resourceArn
- An ARN that uniquely identifies a resource. The format of the ARN
depends on the resource type.
$sel:resourceType:RecoveryPointByBackupVault'
, recoveryPointByBackupVault_resourceType
- The type of Amazon Web Services resource saved as a recovery point; for
example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon
Relational Database Service (Amazon RDS) database. For Windows Volume
Shadow Copy Service (VSS) backups, the only supported resource type is
Amazon EC2.
$sel:sourceBackupVaultArn:RecoveryPointByBackupVault'
, recoveryPointByBackupVault_sourceBackupVaultArn
- The backup vault where the recovery point was originally copied from. If
the recovery point is restored to the same account this value will be
null
.
$sel:status:RecoveryPointByBackupVault'
, recoveryPointByBackupVault_status
- A status code specifying the state of the recovery point.
$sel:statusMessage:RecoveryPointByBackupVault'
, recoveryPointByBackupVault_statusMessage
- A message explaining the reason of the recovery point deletion failure.
RecoveryPointByResource
data RecoveryPointByResource Source #
Contains detailed information about a saved recovery point.
See: newRecoveryPointByResource
smart constructor.
RecoveryPointByResource' (Maybe Integer) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe RecoveryPointStatus) (Maybe Text) |
Instances
newRecoveryPointByResource :: RecoveryPointByResource Source #
Create a value of RecoveryPointByResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:backupSizeBytes:RecoveryPointByResource'
, recoveryPointByResource_backupSizeBytes
- The size, in bytes, of a backup.
$sel:backupVaultName:RecoveryPointByResource'
, recoveryPointByResource_backupVaultName
- 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.
$sel:creationDate:RecoveryPointByResource'
, recoveryPointByResource_creationDate
- The date and time a recovery point is created, in Unix format and
Coordinated Universal Time (UTC). The value of CreationDate
is
accurate to milliseconds. For example, the value 1516925490.087
represents Friday, January 26, 2018 12:11:30.087 AM.
$sel:encryptionKeyArn:RecoveryPointByResource'
, recoveryPointByResource_encryptionKeyArn
- 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
.
$sel:isParent:RecoveryPointByResource'
, recoveryPointByResource_isParent
- This is a boolean value indicating this is a parent (composite) recovery
point.
$sel:parentRecoveryPointArn:RecoveryPointByResource'
, recoveryPointByResource_parentRecoveryPointArn
- This is the Amazon Resource Name (ARN) of the parent (composite)
recovery point.
$sel:recoveryPointArn:RecoveryPointByResource'
, recoveryPointByResource_recoveryPointArn
- 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
.
$sel:status:RecoveryPointByResource'
, recoveryPointByResource_status
- A status code specifying the state of the recovery point.
$sel:statusMessage:RecoveryPointByResource'
, recoveryPointByResource_statusMessage
- A message explaining the reason of the recovery point deletion failure.
RecoveryPointCreator
data RecoveryPointCreator Source #
Contains information about the backup plan and rule that Backup used to initiate the recovery point backup.
See: newRecoveryPointCreator
smart constructor.
Instances
newRecoveryPointCreator :: RecoveryPointCreator Source #
Create a value of RecoveryPointCreator
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:backupPlanArn:RecoveryPointCreator'
, recoveryPointCreator_backupPlanArn
- 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
.
$sel:backupPlanId:RecoveryPointCreator'
, recoveryPointCreator_backupPlanId
- Uniquely identifies a backup plan.
$sel:backupPlanVersion:RecoveryPointCreator'
, recoveryPointCreator_backupPlanVersion
- Version IDs are unique, randomly generated, Unicode, UTF-8 encoded
strings that are at most 1,024 bytes long. They cannot be edited.
$sel:backupRuleId:RecoveryPointCreator'
, recoveryPointCreator_backupRuleId
- Uniquely identifies a rule used to schedule the backup of a selection of
resources.
RecoveryPointMember
data RecoveryPointMember Source #
This is a recovery point which is a child (nested) recovery point of a parent (composite) recovery point. These recovery points can be disassociated from their parent (composite) recovery point, in which case they will no longer be a member.
See: newRecoveryPointMember
smart constructor.
Instances
newRecoveryPointMember :: RecoveryPointMember Source #
Create a value of RecoveryPointMember
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:recoveryPointArn:RecoveryPointMember'
, recoveryPointMember_recoveryPointArn
- This is the Amazon Resource Name (ARN) of the parent (composite)
recovery point.
RecoveryPointSelection
data RecoveryPointSelection Source #
This specifies criteria to assign a set of resources, such as resource types or backup vaults.
See: newRecoveryPointSelection
smart constructor.
Instances
newRecoveryPointSelection :: RecoveryPointSelection Source #
Create a value of RecoveryPointSelection
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dateRange:RecoveryPointSelection'
, recoveryPointSelection_dateRange
- Undocumented member.
$sel:resourceIdentifiers:RecoveryPointSelection'
, recoveryPointSelection_resourceIdentifiers
- These are the resources included in the resource selection (including
type of resources and vaults).
$sel:vaultNames:RecoveryPointSelection'
, recoveryPointSelection_vaultNames
- These are the names of the vaults in which the selected recovery points
are contained.
ReportDeliveryChannel
data ReportDeliveryChannel Source #
Contains information from your report plan about where to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.
See: newReportDeliveryChannel
smart constructor.
Instances
newReportDeliveryChannel Source #
Create a value of ReportDeliveryChannel
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:formats:ReportDeliveryChannel'
, reportDeliveryChannel_formats
- A list of the format of your reports: CSV
, JSON
, or both. If not
specified, the default format is CSV
.
$sel:s3KeyPrefix:ReportDeliveryChannel'
, reportDeliveryChannel_s3KeyPrefix
- 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.
$sel:s3BucketName:ReportDeliveryChannel'
, reportDeliveryChannel_s3BucketName
- The unique name of the S3 bucket that receives your reports.
ReportDestination
data ReportDestination Source #
Contains information from your report job about your report destination.
See: newReportDestination
smart constructor.
ReportDestination' (Maybe Text) (Maybe [Text]) |
Instances
newReportDestination :: ReportDestination Source #
Create a value of ReportDestination
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:s3BucketName:ReportDestination'
, reportDestination_s3BucketName
- The unique name of the Amazon S3 bucket that receives your reports.
$sel:s3Keys:ReportDestination'
, reportDestination_s3Keys
- The object key that uniquely identifies your reports in your S3 bucket.
ReportJob
Contains detailed information about a report job. A report job compiles a report based on a report plan and publishes it to Amazon S3.
See: newReportJob
smart constructor.
ReportJob' (Maybe POSIX) (Maybe POSIX) (Maybe ReportDestination) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newReportJob :: ReportJob Source #
Create a value of ReportJob
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:completionTime:ReportJob'
, reportJob_completionTime
- 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.
$sel:creationTime:ReportJob'
, reportJob_creationTime
- 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.
$sel:reportDestination:ReportJob'
, reportJob_reportDestination
- The S3 bucket name and S3 keys for the destination where the report job
publishes the report.
$sel:reportJobId:ReportJob'
, reportJob_reportJobId
- 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.
$sel:reportPlanArn:ReportJob'
, reportJob_reportPlanArn
- An Amazon Resource Name (ARN) that uniquely identifies a resource. The
format of the ARN depends on the resource type.
$sel:reportTemplate:ReportJob'
, reportJob_reportTemplate
- 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
$sel:status:ReportJob'
, reportJob_status
- 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.
$sel:statusMessage:ReportJob'
, reportJob_statusMessage
- A message explaining the status of the report job.
ReportPlan
data ReportPlan Source #
Contains detailed information about a report plan.
See: newReportPlan
smart constructor.
ReportPlan' (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe ReportDeliveryChannel) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ReportSetting) |
Instances
newReportPlan :: ReportPlan Source #
Create a value of ReportPlan
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:creationTime:ReportPlan'
, reportPlan_creationTime
- 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.
$sel:deploymentStatus:ReportPlan'
, reportPlan_deploymentStatus
- The deployment status of a report plan. The statuses are:
CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED
$sel:lastAttemptedExecutionTime:ReportPlan'
, reportPlan_lastAttemptedExecutionTime
- 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.
$sel:lastSuccessfulExecutionTime:ReportPlan'
, reportPlan_lastSuccessfulExecutionTime
- 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.
$sel:reportDeliveryChannel:ReportPlan'
, reportPlan_reportDeliveryChannel
- 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.
$sel:reportPlanArn:ReportPlan'
, reportPlan_reportPlanArn
- An Amazon Resource Name (ARN) that uniquely identifies a resource. The
format of the ARN depends on the resource type.
$sel:reportPlanDescription:ReportPlan'
, reportPlan_reportPlanDescription
- An optional description of the report plan with a maximum 1,024
characters.
$sel:reportPlanName:ReportPlan'
, reportPlan_reportPlanName
- 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 (_).
$sel:reportSetting:ReportPlan'
, reportPlan_reportSetting
- 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.
ReportSetting
data ReportSetting Source #
Contains detailed information about a report setting.
See: newReportSetting
smart constructor.
Instances
Create a value of ReportSetting
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accounts:ReportSetting'
, reportSetting_accounts
- These are the accounts to be included in the report.
$sel:frameworkArns:ReportSetting'
, reportSetting_frameworkArns
- The Amazon Resource Names (ARNs) of the frameworks a report covers.
$sel:numberOfFrameworks:ReportSetting'
, reportSetting_numberOfFrameworks
- The number of frameworks a report covers.
$sel:organizationUnits:ReportSetting'
, reportSetting_organizationUnits
- These are the Organizational Units to be included in the report.
$sel:regions:ReportSetting'
, reportSetting_regions
- These are the Regions to be included in the report.
$sel:reportTemplate:ReportSetting'
, reportSetting_reportTemplate
- 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
RestoreJobsListMember
data RestoreJobsListMember Source #
Contains metadata about a restore job.
See: newRestoreJobsListMember
smart constructor.
RestoreJobsListMember' (Maybe Text) (Maybe Integer) (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe Integer) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe RestoreJobStatus) (Maybe Text) |
Instances
newRestoreJobsListMember :: RestoreJobsListMember Source #
Create a value of RestoreJobsListMember
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accountId:RestoreJobsListMember'
, restoreJobsListMember_accountId
- The account ID that owns the restore job.
$sel:backupSizeInBytes:RestoreJobsListMember'
, restoreJobsListMember_backupSizeInBytes
- The size, in bytes, of the restored resource.
$sel:completionDate:RestoreJobsListMember'
, restoreJobsListMember_completionDate
- The date and time a job to restore a recovery point is completed, in
Unix format and Coordinated Universal Time (UTC). The value of
CompletionDate
is accurate to milliseconds. For example, the value
1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
$sel:createdResourceArn:RestoreJobsListMember'
, restoreJobsListMember_createdResourceArn
- An Amazon Resource Name (ARN) that uniquely identifies a resource. The
format of the ARN depends on the resource type.
$sel:creationDate:RestoreJobsListMember'
, restoreJobsListMember_creationDate
- The date and time a restore job is created, in Unix format and
Coordinated Universal Time (UTC). The value of CreationDate
is
accurate to milliseconds. For example, the value 1516925490.087
represents Friday, January 26, 2018 12:11:30.087 AM.
$sel:expectedCompletionTimeMinutes:RestoreJobsListMember'
, restoreJobsListMember_expectedCompletionTimeMinutes
- The amount of time in minutes that a job restoring a recovery point is
expected to take.
$sel:iamRoleArn:RestoreJobsListMember'
, restoreJobsListMember_iamRoleArn
- Specifies the IAM role ARN used to create the target recovery point; for
example, arn:aws:iam::123456789012:role/S3Access
.
$sel:percentDone:RestoreJobsListMember'
, restoreJobsListMember_percentDone
- Contains an estimated percentage complete of a job at the time the job
status was queried.
$sel:recoveryPointArn:RestoreJobsListMember'
, restoreJobsListMember_recoveryPointArn
- An ARN that uniquely identifies a recovery point; for example,
arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45
.
$sel:resourceType:RestoreJobsListMember'
, restoreJobsListMember_resourceType
- The resource type of the listed restore jobs; for example, an Amazon
Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database
Service (Amazon RDS) database. For Windows Volume Shadow Copy Service
(VSS) backups, the only supported resource type is Amazon EC2.
$sel:restoreJobId:RestoreJobsListMember'
, restoreJobsListMember_restoreJobId
- Uniquely identifies the job that restores a recovery point.
$sel:status:RestoreJobsListMember'
, restoreJobsListMember_status
- A status code specifying the state of the job initiated by Backup to
restore a recovery point.
$sel:statusMessage:RestoreJobsListMember'
, restoreJobsListMember_statusMessage
- A detailed message explaining the status of the job to restore a
recovery point.