@datafire/amazonaws_dlm v5.0.0

@datafire/amazonaws_dlm

Client library for Amazon Data Lifecycle Manager

Installation and Usage

npm install --save @datafire/amazonaws_dlm

let amazonaws_dlm = require('@datafire/amazonaws_dlm').create({
  hmac: ""
});

amazonaws_dlm.GetLifecyclePolicies({
  "body": {},
  "Action": "",
  "Version": ""
}).then(data => {
  console.log(data);
});

Description

Amazon Data Lifecycle Manager With Amazon Data Lifecycle Manager, you can manage the lifecycle of your AWS resources. You create lifecycle policies, which are used to automate operations on the specified resources. Amazon DLM supports Amazon EBS volumes and snapshots. For information about using Amazon DLM with Amazon EBS, see Automating the Amazon EBS Snapshot Lifecycle in the Amazon EC2 User Guide.

Actions

GetLifecyclePolicies

amazonaws_dlm.GetLifecyclePolicies({
  "body": {},
  "Action": "",
  "Version": ""
}, context)

Input

• input object
  • body required GetLifecyclePoliciesRequest
  • Action required string
  • Version required string
  • X-Amz-Content-Sha256 string
  • X-Amz-Date string
  • X-Amz-Algorithm string
  • X-Amz-Credential string
  • X-Amz-Security-Token string
  • X-Amz-Signature string
  • X-Amz-SignedHeaders string

Output

• output GetLifecyclePoliciesResponse

CreateLifecyclePolicy

Creates a policy to manage the lifecycle of the specified AWS resources. You can create up to 100 lifecycle policies.

amazonaws_dlm.CreateLifecyclePolicy({
  "body": {
    "ExecutionRoleArn": "",
    "Description": "",
    "State": "",
    "PolicyDetails": {}
  },
  "Action": "",
  "Version": ""
}, context)

Input

• input object
  • body required CreateLifecyclePolicyRequest
  • Action required string
  • Version required string
  • X-Amz-Content-Sha256 string
  • X-Amz-Date string
  • X-Amz-Algorithm string
  • X-Amz-Credential string
  • X-Amz-Security-Token string
  • X-Amz-Signature string
  • X-Amz-SignedHeaders string

Output

• output CreateLifecyclePolicyResponse

UpdateLifecyclePolicy

Updates the specified lifecycle policy.

amazonaws_dlm.UpdateLifecyclePolicy({
  "body": {},
  "policyId": "",
  "Action": "",
  "Version": ""
}, context)

Input

• input object
  • body required UpdateLifecyclePolicyRequest
  • policyId required string
  • Action required string
  • Version required string
  • X-Amz-Content-Sha256 string
  • X-Amz-Date string
  • X-Amz-Algorithm string
  • X-Amz-Credential string
  • X-Amz-Security-Token string
  • X-Amz-Signature string
  • X-Amz-SignedHeaders string

Output

• output UpdateLifecyclePolicyResponse

DeleteLifecyclePolicy

Deletes the specified lifecycle policy and halts the automated operations that the policy specified.

amazonaws_dlm.DeleteLifecyclePolicy({
  "body": {},
  "policyId": "",
  "Action": "",
  "Version": ""
}, context)

Input

• input object
  • body required DeleteLifecyclePolicyRequest
  • policyId required string
  • Action required string
  • Version required string
  • X-Amz-Content-Sha256 string
  • X-Amz-Date string
  • X-Amz-Algorithm string
  • X-Amz-Credential string
  • X-Amz-Security-Token string
  • X-Amz-Signature string
  • X-Amz-SignedHeaders string

Output

• output DeleteLifecyclePolicyResponse

GetLifecyclePolicy

Gets detailed information about the specified lifecycle policy.

amazonaws_dlm.GetLifecyclePolicy({
  "body": {},
  "policyId": "",
  "Action": "",
  "Version": ""
}, context)

Input

• input object
  • body required GetLifecyclePolicyRequest
  • policyId required string
  • Action required string
  • Version required string
  • X-Amz-Content-Sha256 string
  • X-Amz-Date string
  • X-Amz-Algorithm string
  • X-Amz-Credential string
  • X-Amz-Security-Token string
  • X-Amz-Signature string
  • X-Amz-SignedHeaders string

Output

• output GetLifecyclePolicyResponse

Definitions

Count

• Count integer

CreateLifecyclePolicyRequest

• CreateLifecyclePolicyRequest object
  • Description required PolicyDescription
  • ExecutionRoleArn required ExecutionRoleArn
  • PolicyDetails required PolicyDetails
  • State required SettablePolicyStateValues

CreateLifecyclePolicyResponse

• CreateLifecyclePolicyResponse object
  • PolicyId PolicyId

CreateRule

• CreateRule object: Specifies when to create snapshots of EBS volumes.
  • Interval required Interval
  • IntervalUnit required IntervalUnitValues
  • Times TimesList

DeleteLifecyclePolicyRequest

• DeleteLifecyclePolicyRequest object

DeleteLifecyclePolicyResponse

• DeleteLifecyclePolicyResponse object

ExecutionRoleArn

• ExecutionRoleArn string

GetLifecyclePoliciesRequest

• GetLifecyclePoliciesRequest object

GetLifecyclePoliciesResponse

• GetLifecyclePoliciesResponse object
  • Policies LifecyclePolicySummaryList

GetLifecyclePolicyRequest

• GetLifecyclePolicyRequest object

GetLifecyclePolicyResponse

• GetLifecyclePolicyResponse object
  • Policy LifecyclePolicy

GettablePolicyStateValues

• GettablePolicyStateValues string (values: ENABLED, DISABLED, ERROR)

InternalServerException

Interval

• Interval integer

IntervalUnitValues

• IntervalUnitValues string (values: HOURS)

InvalidRequestException

LifecyclePolicy

• LifecyclePolicy object: Detailed information about a lifecycle policy.
  • DateCreated Timestamp
  • DateModified Timestamp
  • Description PolicyDescription
  • ExecutionRoleArn ExecutionRoleArn
  • PolicyDetails PolicyDetails
  • PolicyId PolicyId
  • State GettablePolicyStateValues

LifecyclePolicySummary

• LifecyclePolicySummary object: Summary information about a lifecycle policy.
  • Description PolicyDescription
  • PolicyId PolicyId
  • State GettablePolicyStateValues

LifecyclePolicySummaryList

• LifecyclePolicySummaryList array
  • items LifecyclePolicySummary

LimitExceededException

PolicyDescription

• PolicyDescription string

PolicyDetails

• PolicyDetails object: Specifies the configuration of a lifecycle policy.
  • ResourceTypes ResourceTypeValuesList
  • Schedules ScheduleList
  • TargetTags TargetTagList

PolicyId

• PolicyId string

PolicyIdList

• PolicyIdList array
  • items PolicyId

ResourceNotFoundException

ResourceTypeValues

• ResourceTypeValues string (values: VOLUME)

ResourceTypeValuesList

• ResourceTypeValuesList array
  • items ResourceTypeValues

RetainRule

• RetainRule object: Specifies the number of snapshots to keep for each EBS volume.
  • Count required Count

Schedule

• Schedule object: Specifies a schedule.
  • CreateRule CreateRule
  • Name ScheduleName
  • RetainRule RetainRule
  • TagsToAdd TagsToAddList

ScheduleList

• ScheduleList array
  • items Schedule

ScheduleName

• ScheduleName string

SettablePolicyStateValues

• SettablePolicyStateValues string (values: ENABLED, DISABLED)

String

• String string

Tag

• Tag object: Specifies a tag for a resource.
  • Key required String
  • Value required String

TagFilter

• TagFilter string

TagsToAddFilterList

• TagsToAddFilterList array
  • items TagFilter

TagsToAddList

• TagsToAddList array
  • items Tag

TargetTagList

• TargetTagList array
  • items Tag

TargetTagsFilterList

• TargetTagsFilterList array
  • items TagFilter

Time

• Time string

TimesList

• TimesList array
  • items Time

Timestamp

• Timestamp string

UpdateLifecyclePolicyRequest

• UpdateLifecyclePolicyRequest object
  • Description PolicyDescription
  • ExecutionRoleArn ExecutionRoleArn
  • PolicyDetails PolicyDetails
  • State SettablePolicyStateValues

UpdateLifecyclePolicyResponse

• UpdateLifecyclePolicyResponse object