{ "smithy": "2.0", "metadata": { "suppressions": [ { "id": "HttpMethodSemantics", "namespace": "*" }, { "id": "HttpResponseCodeSemantics", "namespace": "*" }, { "id": "PaginatedTrait", "namespace": "*" }, { "id": "HttpHeaderTrait", "namespace": "*" }, { "id": "HttpUriConflict", "namespace": "*" }, { "id": "Service", "namespace": "*" } ] }, "shapes": { "com.amazonaws.dlm#Action": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.dlm#ActionName", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "
A descriptive name for the action.
", "smithy.api#required": {} } }, "CrossRegionCopy": { "target": "com.amazonaws.dlm#CrossRegionCopyActionList", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The rule for copying shared snapshots across Regions.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "\n [Event-based policies only] Specifies an action for an event-based policy.
" } }, "com.amazonaws.dlm#ActionList": { "type": "list", "member": { "target": "com.amazonaws.dlm#Action" }, "traits": { "smithy.api#length": { "min": 1, "max": 1 } } }, "com.amazonaws.dlm#ActionName": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 120 }, "smithy.api#pattern": "^[0-9A-Za-z _-]+$" } }, "com.amazonaws.dlm#ArchiveRetainRule": { "type": "structure", "members": { "RetentionArchiveTier": { "target": "com.amazonaws.dlm#RetentionArchiveTier", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "Information about retention period in the Amazon EBS Snapshots Archive. For more information, see \n\t\t\tArchive Amazon \n\t\t\t\tEBS snapshots.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "\n [Custom snapshot policies only] Specifies information about the archive storage tier retention period.
" } }, "com.amazonaws.dlm#ArchiveRule": { "type": "structure", "members": { "RetainRule": { "target": "com.amazonaws.dlm#ArchiveRetainRule", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "Information about the retention period for the snapshot archiving rule.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "\n [Custom snapshot policies only] Specifies a snapshot archiving rule for a schedule.
" } }, "com.amazonaws.dlm#AvailabilityZone": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 16 }, "smithy.api#pattern": "^([a-z]+-){2,3}\\d[a-z]$" } }, "com.amazonaws.dlm#AvailabilityZoneId": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 16 }, "smithy.api#pattern": "^[a-z]{3,4}\\d-az\\d+$" } }, "com.amazonaws.dlm#AvailabilityZoneIdList": { "type": "list", "member": { "target": "com.amazonaws.dlm#AvailabilityZoneId" }, "traits": { "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.dlm#AvailabilityZoneList": { "type": "list", "member": { "target": "com.amazonaws.dlm#AvailabilityZone" }, "traits": { "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.dlm#AwsAccountId": { "type": "string", "traits": { "smithy.api#length": { "min": 12, "max": 12 }, "smithy.api#pattern": "^[0-9]{12}$" } }, "com.amazonaws.dlm#CmkArn": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 2048 }, "smithy.api#pattern": "^arn:aws(-[a-z]{1,3}){0,2}:kms:([a-z]+-){2,3}\\d:\\d+:key/" } }, "com.amazonaws.dlm#CopyTags": { "type": "boolean" }, "com.amazonaws.dlm#CopyTagsNullable": { "type": "boolean" }, "com.amazonaws.dlm#Count": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 1000 } } }, "com.amazonaws.dlm#CreateInterval": { "type": "integer", "traits": { "smithy.api#range": { "min": 1 } } }, "com.amazonaws.dlm#CreateLifecyclePolicy": { "type": "operation", "input": { "target": "com.amazonaws.dlm#CreateLifecyclePolicyRequest" }, "output": { "target": "com.amazonaws.dlm#CreateLifecyclePolicyResponse" }, "errors": [ { "target": "com.amazonaws.dlm#InternalServerException" }, { "target": "com.amazonaws.dlm#InvalidRequestException" }, { "target": "com.amazonaws.dlm#LimitExceededException" } ], "traits": { "smithy.api#documentation": "Creates an Amazon Data Lifecycle Manager lifecycle policy. Amazon Data Lifecycle Manager supports the following policy types:
\nCustom EBS snapshot policy
\nCustom EBS-backed AMI policy
\nCross-account copy event policy
\nDefault policy for EBS snapshots
\nDefault policy for EBS-backed AMIs
\nFor more information, see \n\t\t\tDefault policies vs custom policies.
\nIf you create a default policy, you can specify the request parameters either in \n\t\t\t\tthe request body, or in the PolicyDetails request structure, but not both.
\nThe Amazon Resource Name (ARN) of the IAM role used to run the operations specified by\n\t\t\tthe lifecycle policy.
", "smithy.api#required": {} } }, "Description": { "target": "com.amazonaws.dlm#PolicyDescription", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "A description of the lifecycle policy. The characters ^[0-9A-Za-z _-]+$ are\n\t\t\tsupported.
", "smithy.api#required": {} } }, "State": { "target": "com.amazonaws.dlm#SettablePolicyStateValues", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The activation state of the lifecycle policy after creation.
", "smithy.api#required": {} } }, "PolicyDetails": { "target": "com.amazonaws.dlm#PolicyDetails", "traits": { "smithy.api#documentation": "The configuration details of the lifecycle policy.
\nIf you create a default policy, you can specify the request parameters either in \n\t\t\t\tthe request body, or in the PolicyDetails request structure, but not both.
\nThe tags to apply to the lifecycle policy during creation.
" } }, "DefaultPolicy": { "target": "com.amazonaws.dlm#DefaultPolicyTypeValues", "traits": { "smithy.api#documentation": "\n [Default policies only] Specify the type of default policy to create.
\nTo create a default policy for EBS snapshots, that creates snapshots of all volumes in the\n\t\t\t\t\tRegion that do not have recent backups, specify VOLUME.
To create a default policy for EBS-backed AMIs, that creates EBS-backed \n\t\t\t\t\tAMIs from all instances in the Region that do not have recent backups, specify \n\t\t\t\t\tINSTANCE.
\n [Default policies only] Specifies how often the policy should run and create snapshots or AMIs. \n\t\t\tThe creation frequency can range from 1 to 7 days. If you do not specify a value, the \n\t\t\tdefault is 1.
\nDefault: 1
" } }, "RetainInterval": { "target": "com.amazonaws.dlm#RetainInterval", "traits": { "smithy.api#documentation": "\n [Default policies only] Specifies how long the policy should retain snapshots or AMIs before \n\t\t\tdeleting them. The retention period can range from 2 to 14 days, but it must be greater \n\t\t\tthan the creation frequency to ensure that the policy retains at least 1 snapshot or \n\t\t\tAMI at any given time. If you do not specify a value, the default is 7.
\nDefault: 7
" } }, "CopyTags": { "target": "com.amazonaws.dlm#CopyTagsNullable", "traits": { "smithy.api#documentation": "\n [Default policies only] Indicates whether the policy should copy tags from the source resource \n\t\t\tto the snapshot or AMI. If you do not specify a value, the default is false.
Default: false
" } }, "ExtendDeletion": { "target": "com.amazonaws.dlm#ExtendDeletion", "traits": { "smithy.api#documentation": "\n [Default policies only] Defines the snapshot or AMI retention behavior for the policy if the \n\t\t\tsource volume or instance is deleted, or if the policy enters the error, disabled, or \n\t\t\tdeleted state.
\nBy default (ExtendDeletion=false):
\nIf a source resource is deleted, Amazon Data Lifecycle Manager will continue to delete previously \n\t\t\t\tcreated snapshots or AMIs, up to but not including the last one, based on the \n\t\t\t\tspecified retention period. If you want Amazon Data Lifecycle Manager to delete all snapshots or AMIs, \n\t\t\t\tincluding the last one, specify true.
If a policy enters the error, disabled, or deleted state, Amazon Data Lifecycle Manager stops deleting \n\t\t\t\t\tsnapshots and AMIs. If you want Amazon Data Lifecycle Manager to continue deleting snapshots or AMIs, \n\t\t\t\t\tincluding the last one, if the policy enters one of these states, specify \n\t\t\t\t\ttrue.
If you enable extended deletion (ExtendDeletion=true), \n\t\t\tyou override both default behaviors simultaneously.
\nIf you do not specify a value, the default is false.
Default: false
" } }, "CrossRegionCopyTargets": { "target": "com.amazonaws.dlm#CrossRegionCopyTargetList", "traits": { "smithy.api#documentation": "\n [Default policies only] Specifies destination Regions for snapshot or AMI copies. You can specify \n\t\t\tup to 3 destination Regions. If you do not want to create cross-Region copies, omit this \n\t\t\tparameter.
" } }, "Exclusions": { "target": "com.amazonaws.dlm#Exclusions", "traits": { "smithy.api#documentation": "\n [Default policies only] Specifies exclusion parameters for volumes or instances for which you \n\t\t\tdo not want to create snapshots or AMIs. The policy will not create snapshots or AMIs \n\t\t\tfor target resources that match any of the specified exclusion parameters.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.dlm#CreateLifecyclePolicyResponse": { "type": "structure", "members": { "PolicyId": { "target": "com.amazonaws.dlm#PolicyId", "traits": { "smithy.api#documentation": "The identifier of the lifecycle policy.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.dlm#CreateRule": { "type": "structure", "members": { "Location": { "target": "com.amazonaws.dlm#LocationValues", "traits": { "smithy.api#documentation": "\n [Custom snapshot policies only] Specifies the destination for snapshots created by the policy. The \n\t\t\tallowed destinations depend on the location of the targeted resources.
\nIf the policy targets resources in a Region, then you must create snapshots \n\t\t\t\t\tin the same Region as the source resource.
\nIf the policy targets resources in a Local Zone, you can create snapshots in \n\t\t\t\t\tthe same Local Zone or in its parent Region.
\nIf the policy targets resources on an Outpost, then you can create snapshots \n\t\t\t\t\ton the same Outpost or in its parent Region.
\nSpecify one of the following values:
\nTo create snapshots in the same Region as the source resource, specify \n\t\t\t\t\tCLOUD.
To create snapshots in the same Local Zone as the source resource, specify \n\t\t\t\t\tLOCAL_ZONE.
To create snapshots on the same Outpost as the source resource, specify \n\t\t\t\t\tOUTPOST_LOCAL.
Default: CLOUD\n
The interval between snapshots. The supported values are 1, 2, 3, 4, 6, 8, 12, and 24.
" } }, "IntervalUnit": { "target": "com.amazonaws.dlm#IntervalUnitValues", "traits": { "smithy.api#documentation": "The interval unit.
" } }, "Times": { "target": "com.amazonaws.dlm#TimesList", "traits": { "smithy.api#documentation": "The time, in UTC, to start the operation. The supported format is hh:mm.
\nThe operation occurs within a one-hour window following the specified time. If you do\n\t\t\tnot specify a time, Amazon Data Lifecycle Manager selects a time within the next 24 hours.
" } }, "CronExpression": { "target": "com.amazonaws.dlm#CronExpression", "traits": { "smithy.api#documentation": "The schedule, as a Cron expression. The schedule interval must be between 1 hour and 1\n\t\t\tyear. For more information, see the Cron expressions reference in \n\t\t\tthe Amazon EventBridge User Guide.
" } }, "Scripts": { "target": "com.amazonaws.dlm#ScriptsList", "traits": { "smithy.api#documentation": "\n [Custom snapshot policies that target instances only] Specifies pre and/or post scripts for a snapshot lifecycle policy \n\t\t\tthat targets instances. This is useful for creating application-consistent snapshots, or for \n\t\t\tperforming specific administrative tasks before or after Amazon Data Lifecycle Manager initiates snapshot creation.
\nFor more information, see Automating \n\t\t\t\tapplication-consistent snapshots with pre and post scripts.
" } } }, "traits": { "smithy.api#documentation": "\n [Custom snapshot and AMI policies only] Specifies when the policy should create snapshots or AMIs.
\nYou must specify either CronExpression, or \n\t\t\t\t\t\tInterval, IntervalUnit, \n\t\t\t\t\t\tand Times.
\nIf you need to specify an ArchiveRule \n\t\t\t\t\t\tfor the schedule, then you must specify a creation frequency of at least \n\t\t\t\t\t\t28 days.
\nThe target Region.
", "smithy.api#required": {} } }, "EncryptionConfiguration": { "target": "com.amazonaws.dlm#EncryptionConfiguration", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The encryption settings for the copied snapshot.
", "smithy.api#required": {} } }, "RetainRule": { "target": "com.amazonaws.dlm#CrossRegionCopyRetainRule" } }, "traits": { "smithy.api#documentation": "\n [Event-based policies only] Specifies a cross-Region copy action for event-based policies.
\nTo specify a cross-Region copy rule for snapshot and AMI policies, use \n\t\t\t\tCrossRegionCopyRule.
\nThe period after which to deprecate the cross-Region AMI copies. The period must be less than or \n\t\t\tequal to the cross-Region AMI copy retention period, and it can't be greater than 10 years. This is \n\t\t\tequivalent to 120 months, 520 weeks, or 3650 days.
" } }, "IntervalUnit": { "target": "com.amazonaws.dlm#RetentionIntervalUnitValues", "traits": { "smithy.api#documentation": "The unit of time in which to measure the Interval. For example, \n\t\t\tto deprecate a cross-Region AMI copy after 3 months, specify Interval=3 and \n\t\t\tIntervalUnit=MONTHS.
\n [Custom AMI policies only] Specifies an AMI deprecation rule for cross-Region AMI copies created by an AMI policy.
" } }, "com.amazonaws.dlm#CrossRegionCopyRetainRule": { "type": "structure", "members": { "Interval": { "target": "com.amazonaws.dlm#Interval", "traits": { "smithy.api#documentation": "The amount of time to retain a cross-Region snapshot or AMI copy. The maximum is 100 years. \n\t\t\tThis is equivalent to 1200 months, 5200 weeks, or 36500 days.
" } }, "IntervalUnit": { "target": "com.amazonaws.dlm#RetentionIntervalUnitValues", "traits": { "smithy.api#documentation": "The unit of time for time-based retention. For example, to retain a cross-Region copy for \n\t\t\t3 months, specify Interval=3 and IntervalUnit=MONTHS.
Specifies a retention rule for cross-Region snapshot copies created by snapshot or \n\t\t\tevent-based policies, or cross-Region AMI copies created by AMI policies. After the \n\t\t\tretention period expires, the cross-Region copy is deleted.
" } }, "com.amazonaws.dlm#CrossRegionCopyRule": { "type": "structure", "members": { "TargetRegion": { "target": "com.amazonaws.dlm#TargetRegion", "traits": { "smithy.api#documentation": "Use this parameter for AMI policies only. For snapshot policies, use \n\t\t\t\tTarget instead. For snapshot policies \n\t\t\t\tcreated before the Target parameter \n\t\t\t\twas introduced, this parameter indicates the target Region for snapshot \n\t\t\t\tcopies.
\n \n\n [Custom AMI policies only] The target Region or the Amazon Resource Name (ARN) of the target Outpost for the \n\t\t\tsnapshot copies.
" } }, "Target": { "target": "com.amazonaws.dlm#Target", "traits": { "smithy.api#documentation": "Use this parameter for snapshot policies only. For AMI policies, use \n\t\t\t\tTargetRegion instead.
\n\n [Custom snapshot policies only] The target Region or the Amazon Resource Name (ARN) of the target Outpost for the \n\t\t\tsnapshot copies.
" } }, "Encrypted": { "target": "com.amazonaws.dlm#Encrypted", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "To encrypt a copy of an unencrypted snapshot if encryption by default is not enabled,\n\t\t\tenable encryption using this parameter. Copies of encrypted snapshots are encrypted,\n\t\t\teven if this parameter is false or if encryption by default is not enabled.
", "smithy.api#required": {} } }, "CmkArn": { "target": "com.amazonaws.dlm#CmkArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key to use for EBS encryption. If this \n\t\t\tparameter is not specified, the default KMS key for the account is used.
" } }, "CopyTags": { "target": "com.amazonaws.dlm#CopyTagsNullable", "traits": { "smithy.api#documentation": "Indicates whether to copy all user-defined tags from the source snapshot or AMI to the \n\t\t\tcross-Region copy.
" } }, "RetainRule": { "target": "com.amazonaws.dlm#CrossRegionCopyRetainRule", "traits": { "smithy.api#documentation": "The retention rule that indicates how long the cross-Region snapshot or AMI copies are \n\t\t\tto be retained in the destination Region.
" } }, "DeprecateRule": { "target": "com.amazonaws.dlm#CrossRegionCopyDeprecateRule", "traits": { "smithy.api#documentation": "\n [Custom AMI policies only] The AMI deprecation rule for cross-Region AMI copies created by the rule.
" } } }, "traits": { "smithy.api#documentation": "\n [Custom snapshot and AMI policies only] Specifies a cross-Region copy rule for a snapshot and AMI policies.
\nTo specify a cross-Region copy action for event-based polices, use \n\t\t\t\tCrossRegionCopyAction.
\nThe target Region, for example us-east-1.
\n [Default policies only] Specifies a destination Region for cross-Region copy actions.
" } }, "com.amazonaws.dlm#CrossRegionCopyTargetList": { "type": "list", "member": { "target": "com.amazonaws.dlm#CrossRegionCopyTarget" }, "traits": { "smithy.api#length": { "min": 0, "max": 3 } } }, "com.amazonaws.dlm#DefaultPoliciesTypeValues": { "type": "enum", "members": { "VOLUME": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "VOLUME" } }, "INSTANCE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INSTANCE" } }, "ALL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ALL" } } } }, "com.amazonaws.dlm#DefaultPolicy": { "type": "boolean" }, "com.amazonaws.dlm#DefaultPolicyTypeValues": { "type": "enum", "members": { "VOLUME": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "VOLUME" } }, "INSTANCE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INSTANCE" } } } }, "com.amazonaws.dlm#DeleteLifecyclePolicy": { "type": "operation", "input": { "target": "com.amazonaws.dlm#DeleteLifecyclePolicyRequest" }, "output": { "target": "com.amazonaws.dlm#DeleteLifecyclePolicyResponse" }, "errors": [ { "target": "com.amazonaws.dlm#InternalServerException" }, { "target": "com.amazonaws.dlm#LimitExceededException" }, { "target": "com.amazonaws.dlm#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "Deletes the specified lifecycle policy and halts the automated operations that the\n\t\t\tpolicy specified.
\nFor more information about deleting a policy, see Delete lifecycle \n\t\t\tpolicies.
", "smithy.api#http": { "method": "DELETE", "uri": "/policies/{PolicyId}", "code": 200 } } }, "com.amazonaws.dlm#DeleteLifecyclePolicyRequest": { "type": "structure", "members": { "PolicyId": { "target": "com.amazonaws.dlm#PolicyId", "traits": { "smithy.api#documentation": "The identifier of the lifecycle policy.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.dlm#DeleteLifecyclePolicyResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.dlm#DeprecateRule": { "type": "structure", "members": { "Count": { "target": "com.amazonaws.dlm#Count", "traits": { "smithy.api#documentation": "If the schedule has a count-based retention rule, this parameter specifies the number of oldest \n\t\t\tAMIs to deprecate. The count must be less than or equal to the schedule's retention count, and it \n\t\t\tcan't be greater than 1000.
" } }, "Interval": { "target": "com.amazonaws.dlm#Interval", "traits": { "smithy.api#documentation": "If the schedule has an age-based retention rule, this parameter specifies the period after which \n\t\t\tto deprecate AMIs created by the schedule. The period must be less than or equal to the schedule's \n\t\t\tretention period, and it can't be greater than 10 years. This is equivalent to 120 months, 520 \n\t\t\tweeks, or 3650 days.
" } }, "IntervalUnit": { "target": "com.amazonaws.dlm#RetentionIntervalUnitValues", "traits": { "smithy.api#documentation": "The unit of time in which to measure the Interval.
" } } }, "traits": { "smithy.api#documentation": "\n [Custom AMI policies only] Specifies an AMI deprecation rule for AMIs created by an AMI lifecycle policy.
\nFor age-based schedules, you must specify Interval and \n\t\t\tIntervalUnit. For count-based schedules, you must specify \n\t\t\tCount.
" } }, "com.amazonaws.dlm#DescriptionRegex": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1000 }, "smithy.api#pattern": "^[\\p{all}]*$" } }, "com.amazonaws.dlm#Encrypted": { "type": "boolean" }, "com.amazonaws.dlm#EncryptionConfiguration": { "type": "structure", "members": { "Encrypted": { "target": "com.amazonaws.dlm#Encrypted", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "To encrypt a copy of an unencrypted snapshot when encryption by default is not enabled, enable \n\t\t\tencryption using this parameter. Copies of encrypted snapshots are encrypted, even if this \n\t\t\tparameter is false or when encryption by default is not enabled.
", "smithy.api#required": {} } }, "CmkArn": { "target": "com.amazonaws.dlm#CmkArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the KMS key to use for EBS encryption. If \n\t\t\tthis parameter is not specified, the default KMS key for the account is used.
" } } }, "traits": { "smithy.api#documentation": "\n [Event-based policies only] Specifies the encryption settings for cross-Region snapshot copies created by \n\t\t\tevent-based policies.
" } }, "com.amazonaws.dlm#ErrorCode": { "type": "string" }, "com.amazonaws.dlm#ErrorMessage": { "type": "string" }, "com.amazonaws.dlm#EventParameters": { "type": "structure", "members": { "EventType": { "target": "com.amazonaws.dlm#EventTypeValues", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The type of event. Currently, only snapshot sharing events are supported.
", "smithy.api#required": {} } }, "SnapshotOwner": { "target": "com.amazonaws.dlm#SnapshotOwnerList", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The IDs of the Amazon Web Services accounts that can trigger policy by sharing snapshots with your account. \n\t\t\tThe policy only runs if one of the specified Amazon Web Services accounts shares a snapshot with your account.
", "smithy.api#required": {} } }, "DescriptionRegex": { "target": "com.amazonaws.dlm#DescriptionRegex", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The snapshot description that can trigger the policy. The description pattern is specified using \n\t\t\ta regular expression. The policy runs only if a snapshot with a description that matches the \n\t\t\tspecified pattern is shared with your account.
\nFor example, specifying ^.*Created for policy: policy-1234567890abcdef0.*$ \n\t\t\tconfigures the policy to run only if snapshots created by policy policy-1234567890abcdef0 \n\t\t\tare shared with your account.
\n [Event-based policies only] Specifies an event that activates an event-based policy.
" } }, "com.amazonaws.dlm#EventSource": { "type": "structure", "members": { "Type": { "target": "com.amazonaws.dlm#EventSourceValues", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The source of the event. Currently only managed CloudWatch Events rules are supported.
", "smithy.api#required": {} } }, "Parameters": { "target": "com.amazonaws.dlm#EventParameters", "traits": { "smithy.api#documentation": "Information about the event.
" } } }, "traits": { "smithy.api#documentation": "\n [Event-based policies only] Specifies an event that activates an event-based policy.
" } }, "com.amazonaws.dlm#EventSourceValues": { "type": "enum", "members": { "MANAGED_CWE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MANAGED_CWE" } } } }, "com.amazonaws.dlm#EventTypeValues": { "type": "enum", "members": { "SHARE_SNAPSHOT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "shareSnapshot" } } } }, "com.amazonaws.dlm#ExcludeBootVolume": { "type": "boolean" }, "com.amazonaws.dlm#ExcludeBootVolumes": { "type": "boolean" }, "com.amazonaws.dlm#ExcludeDataVolumeTagList": { "type": "list", "member": { "target": "com.amazonaws.dlm#Tag" }, "traits": { "smithy.api#length": { "min": 0, "max": 50 } } }, "com.amazonaws.dlm#ExcludeTagsList": { "type": "list", "member": { "target": "com.amazonaws.dlm#Tag" }, "traits": { "smithy.api#length": { "min": 0, "max": 50 } } }, "com.amazonaws.dlm#ExcludeVolumeTypesList": { "type": "list", "member": { "target": "com.amazonaws.dlm#VolumeTypeValues" }, "traits": { "smithy.api#length": { "min": 0, "max": 6 } } }, "com.amazonaws.dlm#Exclusions": { "type": "structure", "members": { "ExcludeBootVolumes": { "target": "com.amazonaws.dlm#ExcludeBootVolumes", "traits": { "smithy.api#documentation": "\n [Default policies for EBS snapshots only] Indicates whether to exclude volumes that are attached to \n\t\t\tinstances as the boot volume. If you exclude boot volumes, only volumes attached as data \n\t\t\t(non-boot) volumes will be backed up by the policy. To exclude boot volumes, specify \n\t\t\ttrue.
\n [Default policies for EBS snapshots only] Specifies the volume types to exclude. Volumes of the specified \n\t\t\ttypes will not be targeted by the policy.
" } }, "ExcludeTags": { "target": "com.amazonaws.dlm#ExcludeTagsList", "traits": { "smithy.api#documentation": "\n [Default policies for EBS-backed AMIs only] Specifies whether to exclude volumes that have specific tags.
" } } }, "traits": { "smithy.api#documentation": "\n [Default policies only] Specifies exclusion parameters for volumes or instances for which you \n\t\t\tdo not want to create snapshots or AMIs. The policy will not create snapshots or AMIs \n\t\t\tfor target resources that match any of the specified exclusion parameters.
" } }, "com.amazonaws.dlm#ExecuteOperationOnScriptFailure": { "type": "boolean" }, "com.amazonaws.dlm#ExecutionHandler": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 200 }, "smithy.api#pattern": "^([a-zA-Z0-9_\\-.]{3,128}|[a-zA-Z0-9_\\-.:/]{3,200}|[A-Z0-9_]+)$" } }, "com.amazonaws.dlm#ExecutionHandlerServiceValues": { "type": "enum", "members": { "AWS_SYSTEMS_MANAGER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWS_SYSTEMS_MANAGER" } } } }, "com.amazonaws.dlm#ExecutionRoleArn": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 2048 }, "smithy.api#pattern": "^arn:aws(-[a-z]{1,3}){0,2}:iam::\\d+:role/" } }, "com.amazonaws.dlm#ExtendDeletion": { "type": "boolean" }, "com.amazonaws.dlm#FastRestoreRule": { "type": "structure", "members": { "Count": { "target": "com.amazonaws.dlm#Count", "traits": { "smithy.api#documentation": "The number of snapshots to be enabled with fast snapshot restore.
" } }, "Interval": { "target": "com.amazonaws.dlm#Interval", "traits": { "smithy.api#documentation": "The amount of time to enable fast snapshot restore. The maximum is 100 years. This is\n\t\t\tequivalent to 1200 months, 5200 weeks, or 36500 days.
" } }, "IntervalUnit": { "target": "com.amazonaws.dlm#RetentionIntervalUnitValues", "traits": { "smithy.api#documentation": "The unit of time for enabling fast snapshot restore.
" } }, "AvailabilityZones": { "target": "com.amazonaws.dlm#AvailabilityZoneList", "traits": { "smithy.api#documentation": "The Availability Zones in which to enable fast snapshot restore.
" } }, "AvailabilityZoneIds": { "target": "com.amazonaws.dlm#AvailabilityZoneIdList", "traits": { "smithy.api#documentation": "The Availability Zone Ids in which to enable fast snapshot restore.
" } } }, "traits": { "smithy.api#documentation": "\n [Custom snapshot policies only] Specifies a rule for enabling fast snapshot restore for snapshots created by\n\t\t\tsnapshot policies. You can enable fast snapshot restore based on either a count or a\n\t\t\ttime interval.
" } }, "com.amazonaws.dlm#GetLifecyclePolicies": { "type": "operation", "input": { "target": "com.amazonaws.dlm#GetLifecyclePoliciesRequest" }, "output": { "target": "com.amazonaws.dlm#GetLifecyclePoliciesResponse" }, "errors": [ { "target": "com.amazonaws.dlm#InternalServerException" }, { "target": "com.amazonaws.dlm#InvalidRequestException" }, { "target": "com.amazonaws.dlm#LimitExceededException" }, { "target": "com.amazonaws.dlm#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "Gets summary information about all or the specified data lifecycle policies.
\nTo get complete information about a policy, use GetLifecyclePolicy.
", "smithy.api#http": { "method": "GET", "uri": "/policies", "code": 200 } } }, "com.amazonaws.dlm#GetLifecyclePoliciesRequest": { "type": "structure", "members": { "PolicyIds": { "target": "com.amazonaws.dlm#PolicyIdList", "traits": { "smithy.api#documentation": "The identifiers of the data lifecycle policies.
", "smithy.api#httpQuery": "policyIds" } }, "State": { "target": "com.amazonaws.dlm#GettablePolicyStateValues", "traits": { "smithy.api#documentation": "The activation state.
", "smithy.api#httpQuery": "state" } }, "ResourceTypes": { "target": "com.amazonaws.dlm#ResourceTypeValuesList", "traits": { "smithy.api#documentation": "The resource type.
", "smithy.api#httpQuery": "resourceTypes" } }, "TargetTags": { "target": "com.amazonaws.dlm#TargetTagsFilterList", "traits": { "smithy.api#documentation": "The target tag for a policy.
\nTags are strings in the format key=value.
The tags to add to objects created by the policy.
\nTags are strings in the format key=value.
These user-defined tags are added in addition to the Amazon Web Services-added lifecycle tags.
", "smithy.api#httpQuery": "tagsToAdd" } }, "DefaultPolicyType": { "target": "com.amazonaws.dlm#DefaultPoliciesTypeValues", "traits": { "smithy.api#documentation": "\n [Default policies only] Specifies the type of default policy to get. Specify one of the following:
\n\n VOLUME - To get only the default policy for EBS snapshots
\n INSTANCE - To get only the default policy for EBS-backed AMIs
\n ALL - To get all default policies
Summary information about the lifecycle policies.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.dlm#GetLifecyclePolicy": { "type": "operation", "input": { "target": "com.amazonaws.dlm#GetLifecyclePolicyRequest" }, "output": { "target": "com.amazonaws.dlm#GetLifecyclePolicyResponse" }, "errors": [ { "target": "com.amazonaws.dlm#InternalServerException" }, { "target": "com.amazonaws.dlm#LimitExceededException" }, { "target": "com.amazonaws.dlm#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "Gets detailed information about the specified lifecycle policy.
", "smithy.api#http": { "method": "GET", "uri": "/policies/{PolicyId}", "code": 200 } } }, "com.amazonaws.dlm#GetLifecyclePolicyRequest": { "type": "structure", "members": { "PolicyId": { "target": "com.amazonaws.dlm#PolicyId", "traits": { "smithy.api#documentation": "The identifier of the lifecycle policy.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.dlm#GetLifecyclePolicyResponse": { "type": "structure", "members": { "Policy": { "target": "com.amazonaws.dlm#LifecyclePolicy", "traits": { "smithy.api#documentation": "Detailed information about the lifecycle policy.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.dlm#GettablePolicyStateValues": { "type": "enum", "members": { "ENABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ENABLED" } }, "DISABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DISABLED" } }, "ERROR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ERROR" } } } }, "com.amazonaws.dlm#InternalServerException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.dlm#ErrorMessage" }, "Code": { "target": "com.amazonaws.dlm#ErrorCode" } }, "traits": { "smithy.api#documentation": "The service failed in an unexpected way.
", "smithy.api#error": "server", "smithy.api#httpError": 500 } }, "com.amazonaws.dlm#Interval": { "type": "integer", "traits": { "smithy.api#range": { "min": 1 } } }, "com.amazonaws.dlm#IntervalUnitValues": { "type": "enum", "members": { "HOURS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "HOURS" } } } }, "com.amazonaws.dlm#InvalidRequestException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.dlm#ErrorMessage" }, "Code": { "target": "com.amazonaws.dlm#ErrorCode" }, "RequiredParameters": { "target": "com.amazonaws.dlm#ParameterList", "traits": { "smithy.api#documentation": "The request omitted one or more required parameters.
" } }, "MutuallyExclusiveParameters": { "target": "com.amazonaws.dlm#ParameterList", "traits": { "smithy.api#documentation": "The request included parameters that cannot be provided together.
" } } }, "traits": { "smithy.api#documentation": "Bad request. The request is missing required parameters or has invalid\n\t\t\tparameters.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.dlm#LifecyclePolicy": { "type": "structure", "members": { "PolicyId": { "target": "com.amazonaws.dlm#PolicyId", "traits": { "smithy.api#documentation": "The identifier of the lifecycle policy.
" } }, "Description": { "target": "com.amazonaws.dlm#PolicyDescription", "traits": { "smithy.api#documentation": "The description of the lifecycle policy.
" } }, "State": { "target": "com.amazonaws.dlm#GettablePolicyStateValues", "traits": { "smithy.api#documentation": "The activation state of the lifecycle policy.
" } }, "StatusMessage": { "target": "com.amazonaws.dlm#StatusMessage", "traits": { "smithy.api#documentation": "The description of the status.
" } }, "ExecutionRoleArn": { "target": "com.amazonaws.dlm#ExecutionRoleArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by\n\t\t\tthe lifecycle policy.
" } }, "DateCreated": { "target": "com.amazonaws.dlm#Timestamp", "traits": { "smithy.api#documentation": "The local date and time when the lifecycle policy was created.
" } }, "DateModified": { "target": "com.amazonaws.dlm#Timestamp", "traits": { "smithy.api#documentation": "The local date and time when the lifecycle policy was last modified.
" } }, "PolicyDetails": { "target": "com.amazonaws.dlm#PolicyDetails", "traits": { "smithy.api#documentation": "The configuration of the lifecycle policy
" } }, "Tags": { "target": "com.amazonaws.dlm#TagMap", "traits": { "smithy.api#documentation": "The tags.
" } }, "PolicyArn": { "target": "com.amazonaws.dlm#PolicyArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the policy.
" } }, "DefaultPolicy": { "target": "com.amazonaws.dlm#DefaultPolicy", "traits": { "smithy.api#documentation": "Indicates whether the policy is a default lifecycle policy or a custom \n\t\t\tlifecycle policy.
\n\n true - the policy is a default policy.
\n false - the policy is a custom policy.
Information about a lifecycle policy.
" } }, "com.amazonaws.dlm#LifecyclePolicySummary": { "type": "structure", "members": { "PolicyId": { "target": "com.amazonaws.dlm#PolicyId", "traits": { "smithy.api#documentation": "The identifier of the lifecycle policy.
" } }, "Description": { "target": "com.amazonaws.dlm#PolicyDescription", "traits": { "smithy.api#documentation": "The description of the lifecycle policy.
" } }, "State": { "target": "com.amazonaws.dlm#GettablePolicyStateValues", "traits": { "smithy.api#documentation": "The activation state of the lifecycle policy.
" } }, "Tags": { "target": "com.amazonaws.dlm#TagMap", "traits": { "smithy.api#documentation": "The tags.
" } }, "PolicyType": { "target": "com.amazonaws.dlm#PolicyTypeValues", "traits": { "smithy.api#documentation": "The type of policy. EBS_SNAPSHOT_MANAGEMENT indicates that the policy \n\t\t\tmanages the lifecycle of Amazon EBS snapshots. IMAGE_MANAGEMENT \n\t\t\tindicates that the policy manages the lifecycle of EBS-backed AMIs. \n\t\t\tEVENT_BASED_POLICY indicates that the policy automates cross-account \n\t\t\tsnapshot copies for snapshots that are shared with your account.
\n [Default policies only] The type of default policy. Values include:
\n\n VOLUME - Default policy for EBS snapshots
\n INSTANCE - Default policy for EBS-backed AMIs
Summary information about a lifecycle policy.
" } }, "com.amazonaws.dlm#LifecyclePolicySummaryList": { "type": "list", "member": { "target": "com.amazonaws.dlm#LifecyclePolicySummary" } }, "com.amazonaws.dlm#LimitExceededException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.dlm#ErrorMessage" }, "Code": { "target": "com.amazonaws.dlm#ErrorCode" }, "ResourceType": { "target": "com.amazonaws.dlm#String", "traits": { "smithy.api#documentation": "Value is the type of resource for which a limit was exceeded.
" } } }, "traits": { "smithy.api#documentation": "The request failed because a limit was exceeded.
", "smithy.api#error": "client", "smithy.api#httpError": 429 } }, "com.amazonaws.dlm#ListTagsForResource": { "type": "operation", "input": { "target": "com.amazonaws.dlm#ListTagsForResourceRequest" }, "output": { "target": "com.amazonaws.dlm#ListTagsForResourceResponse" }, "errors": [ { "target": "com.amazonaws.dlm#InternalServerException" }, { "target": "com.amazonaws.dlm#InvalidRequestException" }, { "target": "com.amazonaws.dlm#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "Lists the tags for the specified resource.
", "smithy.api#http": { "method": "GET", "uri": "/tags/{ResourceArn}", "code": 200 } } }, "com.amazonaws.dlm#ListTagsForResourceRequest": { "type": "structure", "members": { "ResourceArn": { "target": "com.amazonaws.dlm#PolicyArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.dlm#ListTagsForResourceResponse": { "type": "structure", "members": { "Tags": { "target": "com.amazonaws.dlm#TagMap", "traits": { "smithy.api#documentation": "Information about the tags.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.dlm#LocationValues": { "type": "enum", "members": { "CLOUD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CLOUD" } }, "OUTPOST_LOCAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OUTPOST_LOCAL" } }, "LOCAL_ZONE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LOCAL_ZONE" } } } }, "com.amazonaws.dlm#NoReboot": { "type": "boolean" }, "com.amazonaws.dlm#Parameter": { "type": "string" }, "com.amazonaws.dlm#ParameterList": { "type": "list", "member": { "target": "com.amazonaws.dlm#Parameter" } }, "com.amazonaws.dlm#Parameters": { "type": "structure", "members": { "ExcludeBootVolume": { "target": "com.amazonaws.dlm#ExcludeBootVolume", "traits": { "smithy.api#documentation": "\n [Custom snapshot policies that target instances only] Indicates whether to exclude the root volume from multi-volume \n\t\t\tsnapshot sets. The default is false. If you specify true, \n\t\t\tthen the root volumes attached to targeted instances will be excluded from the multi-volume \n\t\t\tsnapshot sets created by the policy.
\n [Custom AMI policies only] Indicates whether targeted instances are rebooted when the lifecycle policy \n\t\t\truns. true indicates that targeted instances are not rebooted when the policy \n\t\t\truns. false indicates that target instances are rebooted when the policy runs. \n\t\t\tThe default is true (instances are not rebooted).
\n [Custom snapshot policies that target instances only] The tags used to identify data (non-root) volumes to exclude from \n\t\t\tmulti-volume snapshot sets.
\nIf you create a snapshot lifecycle policy that targets instances and you specify tags for \n\t\t\tthis parameter, then data volumes with the specified tags that are attached to targeted \n\t\t\tinstances will be excluded from the multi-volume snapshot sets created by the policy.
" } } }, "traits": { "smithy.api#documentation": "\n [Custom snapshot and AMI policies only] Specifies optional parameters for snapshot and AMI policies. The \n\t\t\tset of valid parameters depends on the combination of policy type and target resource \n\t\t\ttype.
\nIf you choose to exclude boot volumes and you specify tags that consequently exclude \n\t\t\tall of the additional data volumes attached to an instance, then Amazon Data Lifecycle Manager will not create \n\t\t\tany snapshots for the affected instance, and it will emit a SnapshotsCreateFailed \n\t\t\tAmazon CloudWatch metric. For more information, see Monitor your policies \n\t\t\t\tusing Amazon CloudWatch.
The type of policy. Specify EBS_SNAPSHOT_MANAGEMENT \n\t\t\tto create a lifecycle policy that manages the lifecycle of Amazon EBS snapshots. Specify IMAGE_MANAGEMENT \n\t\t\tto create a lifecycle policy that manages the lifecycle of EBS-backed AMIs. Specify EVENT_BASED_POLICY \n\t\t\tto create an event-based policy that performs specific actions when a defined event occurs in your Amazon Web Services account.
The default is EBS_SNAPSHOT_MANAGEMENT.
\n [Custom snapshot policies only] The target resource type for snapshot and AMI lifecycle policies. Use VOLUME to \n\t\t\tcreate snapshots of individual volumes or use INSTANCE to create multi-volume \n\t\t\tsnapshots from the volumes for an instance.
\n [Custom snapshot and AMI policies only] The location of the resources to backup.
\nIf the source resources are located in a Region, specify CLOUD. In this case, \n\t\t\t\t\tthe policy targets all resources of the specified type with matching target tags across all \n\t\t\t\t\tAvailability Zones in the Region.
\n [Custom snapshot policies only] If the source resources are located in a Local Zone, specify LOCAL_ZONE. \n\t\t\t\t\tIn this case, the policy targets all resources of the specified type with matching target \n\t\t\t\t\ttags across all Local Zones in the Region.
If the source resources are located on an Outpost in your account, specify OUTPOST. \n\t\t\t\t\tIn this case, the policy targets all resources of the specified type with matching target \n\t\t\t\t\ttags across all of the Outposts in your account.
\n [Custom snapshot and AMI policies only] The single tag that identifies targeted resources for this policy.
" } }, "Schedules": { "target": "com.amazonaws.dlm#ScheduleList", "traits": { "smithy.api#documentation": "\n [Custom snapshot and AMI policies only] The schedules of policy-defined actions for snapshot and AMI lifecycle policies. A policy \n\t\t\tcan have up to four schedules\u2014one mandatory schedule and up to three optional schedules.
" } }, "Parameters": { "target": "com.amazonaws.dlm#Parameters", "traits": { "smithy.api#documentation": "\n [Custom snapshot and AMI policies only] A set of optional parameters for snapshot and AMI lifecycle policies.
\nIf you are modifying a policy that was created or previously modified using the Amazon \n\t\t\t\tData Lifecycle Manager console, then you must include this parameter and specify either \n\t\t\t\tthe default values or the new values that you require. You can't omit this parameter or \n\t\t\t\tset its values to null.
\n\n [Event-based policies only] The event that activates the event-based policy.
" } }, "Actions": { "target": "com.amazonaws.dlm#ActionList", "traits": { "smithy.api#documentation": "\n [Event-based policies only] The actions to be performed when the event-based policy is activated. You can specify \n\t\t\tonly one action per policy.
" } }, "PolicyLanguage": { "target": "com.amazonaws.dlm#PolicyLanguageValues", "traits": { "smithy.api#documentation": "The type of policy to create. Specify one of the following:
\n\n SIMPLIFIED To create a default policy.
\n STANDARD To create a custom policy.
\n [Default policies only] Specify the type of default policy to create.
\nTo create a default policy for EBS snapshots, that creates snapshots of all volumes in the\n\t\t\t\t\tRegion that do not have recent backups, specify VOLUME.
To create a default policy for EBS-backed AMIs, that creates EBS-backed \n\t\t\t\t\tAMIs from all instances in the Region that do not have recent backups, specify \n\t\t\t\t\tINSTANCE.
\n [Default policies only] Specifies how often the policy should run and create snapshots or AMIs. \n\t\t\tThe creation frequency can range from 1 to 7 days. If you do not specify a value, the \n\t\t\tdefault is 1.
\nDefault: 1
" } }, "RetainInterval": { "target": "com.amazonaws.dlm#RetainInterval", "traits": { "smithy.api#documentation": "\n [Default policies only] Specifies how long the policy should retain snapshots or AMIs before \n\t\t\tdeleting them. The retention period can range from 2 to 14 days, but it must be greater \n\t\t\tthan the creation frequency to ensure that the policy retains at least 1 snapshot or \n\t\t\tAMI at any given time. If you do not specify a value, the default is 7.
\nDefault: 7
" } }, "CopyTags": { "target": "com.amazonaws.dlm#CopyTagsNullable", "traits": { "smithy.api#documentation": "\n [Default policies only] Indicates whether the policy should copy tags from the source resource \n\t\t\tto the snapshot or AMI. If you do not specify a value, the default is false.
Default: false
" } }, "CrossRegionCopyTargets": { "target": "com.amazonaws.dlm#CrossRegionCopyTargetList", "traits": { "smithy.api#documentation": "\n [Default policies only] Specifies destination Regions for snapshot or AMI copies. You can specify \n\t\t\tup to 3 destination Regions. If you do not want to create cross-Region copies, omit this \n\t\t\tparameter.
" } }, "ExtendDeletion": { "target": "com.amazonaws.dlm#ExtendDeletion", "traits": { "smithy.api#documentation": "\n [Default policies only] Defines the snapshot or AMI retention behavior for the policy if the \n\t\t\tsource volume or instance is deleted, or if the policy enters the error, disabled, or \n\t\t\tdeleted state.
\nBy default (ExtendDeletion=false):
\nIf a source resource is deleted, Amazon Data Lifecycle Manager will continue to delete previously \n\t\t\t\t\tcreated snapshots or AMIs, up to but not including the last one, based on the \n\t\t\t\t\tspecified retention period. If you want Amazon Data Lifecycle Manager to delete all snapshots or AMIs, \n\t\t\t\t\tincluding the last one, specify true.
If a policy enters the error, disabled, or deleted state, Amazon Data Lifecycle Manager stops deleting \n\t\t\t\t\tsnapshots and AMIs. If you want Amazon Data Lifecycle Manager to continue deleting snapshots or AMIs, \n\t\t\t\t\tincluding the last one, if the policy enters one of these states, specify \n\t\t\t\t\ttrue.
If you enable extended deletion (ExtendDeletion=true), \n\t\t\tyou override both default behaviors simultaneously.
\nIf you do not specify a value, the default is false.
Default: false
" } }, "Exclusions": { "target": "com.amazonaws.dlm#Exclusions", "traits": { "smithy.api#documentation": "\n [Default policies only] Specifies exclusion parameters for volumes or instances for which you \n\t\t\tdo not want to create snapshots or AMIs. The policy will not create snapshots or AMIs \n\t\t\tfor target resources that match any of the specified exclusion parameters.
" } } }, "traits": { "smithy.api#documentation": "Specifies the configuration of a lifecycle policy.
" } }, "com.amazonaws.dlm#PolicyId": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 64 }, "smithy.api#pattern": "^policy-[a-f0-9]+$" } }, "com.amazonaws.dlm#PolicyIdList": { "type": "list", "member": { "target": "com.amazonaws.dlm#PolicyId" } }, "com.amazonaws.dlm#PolicyLanguageValues": { "type": "enum", "members": { "SIMPLIFIED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SIMPLIFIED" } }, "STANDARD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "STANDARD" } } } }, "com.amazonaws.dlm#PolicyTypeValues": { "type": "enum", "members": { "EBS_SNAPSHOT_MANAGEMENT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EBS_SNAPSHOT_MANAGEMENT" } }, "IMAGE_MANAGEMENT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IMAGE_MANAGEMENT" } }, "EVENT_BASED_POLICY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EVENT_BASED_POLICY" } } } }, "com.amazonaws.dlm#ResourceLocationList": { "type": "list", "member": { "target": "com.amazonaws.dlm#ResourceLocationValues" }, "traits": { "smithy.api#length": { "min": 1, "max": 1 } } }, "com.amazonaws.dlm#ResourceLocationValues": { "type": "enum", "members": { "CLOUD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CLOUD" } }, "OUTPOST": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OUTPOST" } }, "LOCAL_ZONE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LOCAL_ZONE" } } } }, "com.amazonaws.dlm#ResourceNotFoundException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.dlm#ErrorMessage" }, "Code": { "target": "com.amazonaws.dlm#ErrorCode" }, "ResourceType": { "target": "com.amazonaws.dlm#String", "traits": { "smithy.api#documentation": "Value is the type of resource that was not found.
" } }, "ResourceIds": { "target": "com.amazonaws.dlm#PolicyIdList", "traits": { "smithy.api#documentation": "Value is a list of resource IDs that were not found.
" } } }, "traits": { "smithy.api#documentation": "A requested resource was not found.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.dlm#ResourceTypeValues": { "type": "enum", "members": { "VOLUME": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "VOLUME" } }, "INSTANCE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INSTANCE" } } } }, "com.amazonaws.dlm#ResourceTypeValuesList": { "type": "list", "member": { "target": "com.amazonaws.dlm#ResourceTypeValues" }, "traits": { "smithy.api#length": { "min": 1, "max": 1 } } }, "com.amazonaws.dlm#RetainInterval": { "type": "integer", "traits": { "smithy.api#range": { "min": 1 } } }, "com.amazonaws.dlm#RetainRule": { "type": "structure", "members": { "Count": { "target": "com.amazonaws.dlm#StandardTierRetainRuleCount", "traits": { "smithy.api#documentation": "The number of snapshots to retain for each volume, up to a maximum of 1000. For example if you want to \n\t\t\tretain a maximum of three snapshots, specify 3. When the fourth snapshot is created, the \n\t\t\toldest retained snapshot is deleted, or it is moved to the archive tier if you have specified an \n\t\t\tArchiveRule.
The amount of time to retain each snapshot. The maximum is 100 years. This is\n\t\t\tequivalent to 1200 months, 5200 weeks, or 36500 days.
" } }, "IntervalUnit": { "target": "com.amazonaws.dlm#RetentionIntervalUnitValues", "traits": { "smithy.api#documentation": "The unit of time for time-based retention. For example, to retain snapshots for 3 months, specify \n\t\t\tInterval=3 and IntervalUnit=MONTHS. Once the snapshot has been retained for \n\t\t\t3 months, it is deleted, or it is moved to the archive tier if you have specified an \n\t\t\tArchiveRule.
\n [Custom snapshot and AMI policies only] Specifies a retention rule for snapshots created by snapshot policies, or for AMIs \n\t\t\tcreated by AMI policies.
\nFor snapshot policies that have an ArchiveRule, this retention rule\n\t\t\t\tapplies to standard tier retention. When the retention threshold is met, snapshots\n\t\t\t\tare moved from the standard to the archive tier.
\nFor snapshot policies that do not have an ArchiveRule, snapshots \n\t\t\t\tare permanently deleted when this retention threshold is met.
\nYou can retain snapshots based on either a count or a time interval.
\n\n Count-based retention\n
\nYou must specify Count. \n\t\t\t\t\tIf you specify an ArchiveRule for the schedule, then you can specify a retention count of \n\t\t\t\t\t0 to archive snapshots immediately after creation. If you specify a FastRestoreRule, \n\t\t\t\t\tShareRule, or a \n\t\t\t\t\tCrossRegionCopyRule, then you must specify a retention count \n\t\t\t\t\tof 1 or more.
\n Age-based retention\n
\nYou must specify Interval \n\t\t\t\t\tand IntervalUnit. If you specify an ArchiveRule for the \n\t\t\t\t\tschedule, then you can specify a retention interval of 0 days to archive snapshots immediately \n\t\t\t\t\tafter creation. If you specify a FastRestoreRule, ShareRule, or a \n\t\t\t\t\tCrossRegionCopyRule, \n\t\t\t\t\tthen you must specify a retention interval of 1 day or \n\t\t\t\t\tmore.
The maximum number of snapshots to retain in the archive storage tier for each volume. \n\t\t\tThe count must ensure that each snapshot remains in the archive tier for at least \n\t\t90 days. For example, if the schedule creates snapshots every 30 days, you must specify a \n\t\tcount of 3 or more to ensure that each snapshot is archived for at least 90 days.
" } }, "Interval": { "target": "com.amazonaws.dlm#Interval", "traits": { "smithy.api#documentation": "Specifies the period of time to retain snapshots in the archive tier. After this period \n\t\t\texpires, the snapshot is permanently deleted.
" } }, "IntervalUnit": { "target": "com.amazonaws.dlm#RetentionIntervalUnitValues", "traits": { "smithy.api#documentation": "The unit of time in which to measure the Interval. For \n\t\t\texample, to retain a snapshots in the archive tier for 6 months, specify Interval=6 \n\t\t\tand IntervalUnit=MONTHS.
\n [Custom snapshot policies only] Describes the retention rule for archived snapshots. Once the archive \n\t\t\tretention threshold is met, the snapshots are permanently deleted from the archive tier.
\nThe archive retention rule must retain snapshots in the archive tier for a minimum \n\t\t\t\tof 90 days.
\nFor count-based schedules, you must specify Count. For age-based\n\t\t\t\tschedules, you must specify Interval and\n\t\t\t\t IntervalUnit.
\nFor more information about using snapshot archiving, see Considerations for \n\t\t\tsnapshot lifecycle policies.
" } }, "com.amazonaws.dlm#RetentionIntervalUnitValues": { "type": "enum", "members": { "DAYS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DAYS" } }, "WEEKS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "WEEKS" } }, "MONTHS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MONTHS" } }, "YEARS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "YEARS" } } } }, "com.amazonaws.dlm#Schedule": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.dlm#ScheduleName", "traits": { "smithy.api#documentation": "The name of the schedule.
" } }, "CopyTags": { "target": "com.amazonaws.dlm#CopyTags", "traits": { "smithy.api#documentation": "Copy all user-defined tags on a source volume to snapshots of the volume created by\n\t\t\tthis policy.
" } }, "TagsToAdd": { "target": "com.amazonaws.dlm#TagsToAddList", "traits": { "smithy.api#documentation": "The tags to apply to policy-created resources. These user-defined tags are in addition\n\t\t\tto the Amazon Web Services-added lifecycle tags.
" } }, "VariableTags": { "target": "com.amazonaws.dlm#VariableTagsList", "traits": { "smithy.api#documentation": "\n [AMI policies and snapshot policies that target instances only] \n\t\t\tA collection of key/value pairs with values determined dynamically when the policy is\n\t\t\texecuted. Keys may be any valid Amazon EC2 tag key. Values must be in one of the two\n\t\t\tfollowing formats: $(instance-id) or $(timestamp). Variable\n\t\t\ttags are only valid for EBS Snapshot Management \u2013 Instance policies.
The creation rule.
" } }, "RetainRule": { "target": "com.amazonaws.dlm#RetainRule", "traits": { "smithy.api#documentation": "The retention rule for snapshots or AMIs created by the policy.
" } }, "FastRestoreRule": { "target": "com.amazonaws.dlm#FastRestoreRule", "traits": { "smithy.api#documentation": "\n [Custom snapshot policies only] The rule for enabling fast snapshot restore.
" } }, "CrossRegionCopyRules": { "target": "com.amazonaws.dlm#CrossRegionCopyRules", "traits": { "smithy.api#documentation": "Specifies a rule for copying snapshots or AMIs across Regions.
\nYou can't specify cross-Region copy rules for policies that create snapshots on an \n\t\t\t\tOutpost or in a Local Zone. If the policy creates snapshots in a Region, then snapshots \n\t\t\t\tcan be copied to up to three Regions or Outposts.
\n\n [Custom snapshot policies only] The rule for sharing snapshots with other Amazon Web Services accounts.
" } }, "DeprecateRule": { "target": "com.amazonaws.dlm#DeprecateRule", "traits": { "smithy.api#documentation": "\n [Custom AMI policies only] The AMI deprecation rule for the schedule.
" } }, "ArchiveRule": { "target": "com.amazonaws.dlm#ArchiveRule", "traits": { "smithy.api#documentation": "\n [Custom snapshot policies that target volumes only] The snapshot archiving rule for the schedule. When you specify an archiving \n\t\t\trule, snapshots are automatically moved from the standard tier to the archive tier once the schedule's \n\t\t\tretention threshold is met. Snapshots are then retained in the archive tier for the archive retention \n\t\t\tperiod that you specify.
\nFor more information about using snapshot archiving, see Considerations for \n\t\t\t\tsnapshot lifecycle policies.
" } } }, "traits": { "smithy.api#documentation": "\n [Custom snapshot and AMI policies only] Specifies a schedule for a snapshot or AMI lifecycle policy.
" } }, "com.amazonaws.dlm#ScheduleList": { "type": "list", "member": { "target": "com.amazonaws.dlm#Schedule" }, "traits": { "smithy.api#length": { "min": 1, "max": 4 } } }, "com.amazonaws.dlm#ScheduleName": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 120 }, "smithy.api#pattern": "^[0-9A-Za-z _-]+$" } }, "com.amazonaws.dlm#Script": { "type": "structure", "members": { "Stages": { "target": "com.amazonaws.dlm#StagesList", "traits": { "smithy.api#documentation": "Indicate which scripts Amazon Data Lifecycle Manager should run on target instances. Pre scripts \n\t\t\trun before Amazon Data Lifecycle Manager initiates snapshot creation. Post scripts run after Amazon Data Lifecycle Manager \n\t\t\tinitiates snapshot creation.
\nTo run a pre script only, specify PRE. In this case, \n\t\t\t\t\tAmazon Data Lifecycle Manager calls the SSM document with the pre-script parameter \n\t\t\t\t\tbefore initiating snapshot creation.
To run a post script only, specify POST. In this case, \n\t\t\t\t\tAmazon Data Lifecycle Manager calls the SSM document with the post-script parameter \n\t\t\t\t\tafter initiating snapshot creation.
To run both pre and post scripts, specify both PRE and POST. In\n\t\t\t\t\tthis case, Amazon Data Lifecycle Manager calls the SSM document with the pre-script\n\t\t\t\t\tparameter before initiating snapshot creation, and then it calls the SSM\n\t\t\t\t\tdocument again with the post-script parameter after initiating\n\t\t\t\t\tsnapshot creation.
If you are automating VSS Backups, omit this parameter.
\nDefault: PRE and POST
" } }, "ExecutionHandlerService": { "target": "com.amazonaws.dlm#ExecutionHandlerServiceValues", "traits": { "smithy.api#documentation": "Indicates the service used to execute the pre and/or post scripts.
\nIf you are using custom SSM documents or automating \n\t\t\t\t\tapplication-consistent snapshots of SAP HANA workloads, specify \n\t\t\t\t\tAWS_SYSTEMS_MANAGER.
If you are automating VSS Backups, omit this parameter.
\nDefault: AWS_SYSTEMS_MANAGER
" } }, "ExecutionHandler": { "target": "com.amazonaws.dlm#ExecutionHandler", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The SSM document that includes the pre and/or post scripts to run.
\nIf you are automating VSS backups, specify AWS_VSS_BACKUP. \n\t\t\t\t\tIn this case, Amazon Data Lifecycle Manager automatically uses the AWSEC2-CreateVssSnapshot \n\t\t\t\t\tSSM document.
If you are automating application-consistent snapshots for SAP HANA \n\t\t\t\t\tworkloads, specify AWSSystemsManagerSAP-CreateDLMSnapshotForSAPHANA.
If you are using a custom SSM document that you own, specify either \n\t\t\t\t\tthe name or ARN of the SSM document. If you are using a custom SSM \n\t\t\t\t\tdocument that is shared with you, specify the ARN of the SSM document.
\nIndicates whether Amazon Data Lifecycle Manager should default to crash-consistent snapshots if the \n\t\t\tpre script fails.
\nTo default to crash consistent snapshot if the pre script fails, \n\t\t\t\t\tspecify true.
To skip the instance for snapshot creation if the pre script fails, \n\t\t\t\t\tspecify false.
This parameter is supported only if you run a pre script. If you run a post \n\t\t\tscript only, omit this parameter.
\nDefault: true
" } }, "ExecutionTimeout": { "target": "com.amazonaws.dlm#ScriptExecutionTimeout", "traits": { "smithy.api#documentation": "Specifies a timeout period, in seconds, after which Amazon Data Lifecycle Manager fails the script \n\t\t\trun attempt if it has not completed. If a script does not complete within its \n\t\t\ttimeout period, Amazon Data Lifecycle Manager fails the attempt. The timeout period applies to the pre \n\t\t\tand post scripts individually.
\nIf you are automating VSS Backups, omit this parameter.
\nDefault: 10
" } }, "MaximumRetryCount": { "target": "com.amazonaws.dlm#ScriptMaximumRetryCount", "traits": { "smithy.api#documentation": "Specifies the number of times Amazon Data Lifecycle Manager should retry scripts that fail.
\nIf the pre script fails, Amazon Data Lifecycle Manager retries the entire snapshot creation \n\t\t\t\t\tprocess, including running the pre and post scripts.
\nIf the post script fails, Amazon Data Lifecycle Manager retries the post script only; in this \n\t\t\t\t\tcase, the pre script will have completed and the snapshot might have \n\t\t\t\t\tbeen created.
\nIf you do not want Amazon Data Lifecycle Manager to retry failed scripts, specify 0.
Default: 0
" } } }, "traits": { "smithy.api#documentation": "\n [Custom snapshot policies that target instances only] Information about pre and/or post scripts for a \n\t\t\tsnapshot lifecycle policy that targets instances. For more information, see \n\t\t\t\n\t\t\t\tAutomating application-consistent snapshots with pre and post scripts.
" } }, "com.amazonaws.dlm#ScriptExecutionTimeout": { "type": "integer", "traits": { "smithy.api#range": { "min": 10, "max": 120 } } }, "com.amazonaws.dlm#ScriptMaximumRetryCount": { "type": "integer", "traits": { "smithy.api#range": { "min": 0, "max": 3 } } }, "com.amazonaws.dlm#ScriptsList": { "type": "list", "member": { "target": "com.amazonaws.dlm#Script" }, "traits": { "smithy.api#length": { "min": 0, "max": 1 } } }, "com.amazonaws.dlm#SettablePolicyStateValues": { "type": "enum", "members": { "ENABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ENABLED" } }, "DISABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DISABLED" } } } }, "com.amazonaws.dlm#ShareRule": { "type": "structure", "members": { "TargetAccounts": { "target": "com.amazonaws.dlm#ShareTargetAccountList", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The IDs of the Amazon Web Services accounts with which to share the snapshots.
", "smithy.api#required": {} } }, "UnshareInterval": { "target": "com.amazonaws.dlm#Interval", "traits": { "smithy.api#documentation": "The period after which snapshots that are shared with other Amazon Web Services accounts are automatically unshared.
" } }, "UnshareIntervalUnit": { "target": "com.amazonaws.dlm#RetentionIntervalUnitValues", "traits": { "smithy.api#documentation": "The unit of time for the automatic unsharing interval.
" } } }, "traits": { "smithy.api#documentation": "\n [Custom snapshot policies only] Specifies a rule for sharing snapshots across Amazon Web Services accounts.
" } }, "com.amazonaws.dlm#ShareRules": { "type": "list", "member": { "target": "com.amazonaws.dlm#ShareRule" }, "traits": { "smithy.api#length": { "min": 0, "max": 1 } } }, "com.amazonaws.dlm#ShareTargetAccountList": { "type": "list", "member": { "target": "com.amazonaws.dlm#AwsAccountId" }, "traits": { "smithy.api#length": { "min": 1 } } }, "com.amazonaws.dlm#SnapshotOwnerList": { "type": "list", "member": { "target": "com.amazonaws.dlm#AwsAccountId" }, "traits": { "smithy.api#length": { "min": 0, "max": 50 } } }, "com.amazonaws.dlm#StageValues": { "type": "enum", "members": { "PRE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PRE" } }, "POST": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "POST" } } } }, "com.amazonaws.dlm#StagesList": { "type": "list", "member": { "target": "com.amazonaws.dlm#StageValues" }, "traits": { "smithy.api#length": { "min": 1, "max": 2 } } }, "com.amazonaws.dlm#StandardTierRetainRuleCount": { "type": "integer", "traits": { "smithy.api#range": { "min": 0, "max": 1000 } } }, "com.amazonaws.dlm#StandardTierRetainRuleInterval": { "type": "integer", "traits": { "smithy.api#range": { "min": 0 } } }, "com.amazonaws.dlm#StatusMessage": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 500 }, "smithy.api#pattern": "^[\\p{all}]*$" } }, "com.amazonaws.dlm#String": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 500 }, "smithy.api#pattern": "^[\\p{all}]*$" } }, "com.amazonaws.dlm#Tag": { "type": "structure", "members": { "Key": { "target": "com.amazonaws.dlm#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The tag key.
", "smithy.api#required": {} } }, "Value": { "target": "com.amazonaws.dlm#String", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The tag value.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Specifies a tag for a resource.
" } }, "com.amazonaws.dlm#TagFilter": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 }, "smithy.api#pattern": "^[\\p{all}]*$" } }, "com.amazonaws.dlm#TagKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$" } }, "com.amazonaws.dlm#TagKeyList": { "type": "list", "member": { "target": "com.amazonaws.dlm#TagKey" }, "traits": { "smithy.api#length": { "min": 1, "max": 200 } } }, "com.amazonaws.dlm#TagMap": { "type": "map", "key": { "target": "com.amazonaws.dlm#TagKey" }, "value": { "target": "com.amazonaws.dlm#TagValue" }, "traits": { "smithy.api#length": { "min": 1, "max": 200 } } }, "com.amazonaws.dlm#TagResource": { "type": "operation", "input": { "target": "com.amazonaws.dlm#TagResourceRequest" }, "output": { "target": "com.amazonaws.dlm#TagResourceResponse" }, "errors": [ { "target": "com.amazonaws.dlm#InternalServerException" }, { "target": "com.amazonaws.dlm#InvalidRequestException" }, { "target": "com.amazonaws.dlm#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "Adds the specified tags to the specified resource.
", "smithy.api#http": { "method": "POST", "uri": "/tags/{ResourceArn}", "code": 200 } } }, "com.amazonaws.dlm#TagResourceRequest": { "type": "structure", "members": { "ResourceArn": { "target": "com.amazonaws.dlm#PolicyArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.dlm#TagMap", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "One or more tags.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.dlm#TagResourceResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.dlm#TagValue": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 }, "smithy.api#pattern": "^[\\p{all}]*$" } }, "com.amazonaws.dlm#TagsToAddFilterList": { "type": "list", "member": { "target": "com.amazonaws.dlm#TagFilter" }, "traits": { "smithy.api#length": { "min": 0, "max": 50 } } }, "com.amazonaws.dlm#TagsToAddList": { "type": "list", "member": { "target": "com.amazonaws.dlm#Tag" }, "traits": { "smithy.api#length": { "min": 0, "max": 45 } } }, "com.amazonaws.dlm#Target": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 2048 }, "smithy.api#pattern": "^[\\w:\\-\\/\\*]+$" } }, "com.amazonaws.dlm#TargetRegion": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 16 }, "smithy.api#pattern": "^([a-z]+-){2,3}\\d$" } }, "com.amazonaws.dlm#TargetTagList": { "type": "list", "member": { "target": "com.amazonaws.dlm#Tag" }, "traits": { "smithy.api#length": { "min": 1, "max": 50 } } }, "com.amazonaws.dlm#TargetTagsFilterList": { "type": "list", "member": { "target": "com.amazonaws.dlm#TagFilter" }, "traits": { "smithy.api#length": { "min": 1, "max": 50 } } }, "com.amazonaws.dlm#Time": { "type": "string", "traits": { "smithy.api#length": { "min": 5, "max": 5 }, "smithy.api#pattern": "^(0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$" } }, "com.amazonaws.dlm#TimesList": { "type": "list", "member": { "target": "com.amazonaws.dlm#Time" }, "traits": { "smithy.api#length": { "min": 0, "max": 1 } } }, "com.amazonaws.dlm#Timestamp": { "type": "timestamp", "traits": { "smithy.api#timestampFormat": "date-time" } }, "com.amazonaws.dlm#UntagResource": { "type": "operation", "input": { "target": "com.amazonaws.dlm#UntagResourceRequest" }, "output": { "target": "com.amazonaws.dlm#UntagResourceResponse" }, "errors": [ { "target": "com.amazonaws.dlm#InternalServerException" }, { "target": "com.amazonaws.dlm#InvalidRequestException" }, { "target": "com.amazonaws.dlm#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "Removes the specified tags from the specified resource.
", "smithy.api#http": { "method": "DELETE", "uri": "/tags/{ResourceArn}", "code": 200 } } }, "com.amazonaws.dlm#UntagResourceRequest": { "type": "structure", "members": { "ResourceArn": { "target": "com.amazonaws.dlm#PolicyArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "TagKeys": { "target": "com.amazonaws.dlm#TagKeyList", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The tag keys.
", "smithy.api#httpQuery": "tagKeys", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.dlm#UntagResourceResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.dlm#UpdateLifecyclePolicy": { "type": "operation", "input": { "target": "com.amazonaws.dlm#UpdateLifecyclePolicyRequest" }, "output": { "target": "com.amazonaws.dlm#UpdateLifecyclePolicyResponse" }, "errors": [ { "target": "com.amazonaws.dlm#InternalServerException" }, { "target": "com.amazonaws.dlm#InvalidRequestException" }, { "target": "com.amazonaws.dlm#LimitExceededException" }, { "target": "com.amazonaws.dlm#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "Updates the specified lifecycle policy.
\nFor more information about updating a policy, see Modify lifecycle \n\t\t\tpolicies.
", "smithy.api#http": { "method": "PATCH", "uri": "/policies/{PolicyId}", "code": 200 } } }, "com.amazonaws.dlm#UpdateLifecyclePolicyRequest": { "type": "structure", "members": { "PolicyId": { "target": "com.amazonaws.dlm#PolicyId", "traits": { "smithy.api#documentation": "The identifier of the lifecycle policy.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ExecutionRoleArn": { "target": "com.amazonaws.dlm#ExecutionRoleArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by\n\t\t\tthe lifecycle policy.
" } }, "State": { "target": "com.amazonaws.dlm#SettablePolicyStateValues", "traits": { "smithy.api#documentation": "The desired activation state of the lifecycle policy after creation.
" } }, "Description": { "target": "com.amazonaws.dlm#PolicyDescription", "traits": { "smithy.api#documentation": "A description of the lifecycle policy.
" } }, "PolicyDetails": { "target": "com.amazonaws.dlm#PolicyDetails", "traits": { "smithy.api#documentation": "The configuration of the lifecycle policy. You cannot update the policy type or the\n\t\t\tresource type.
" } }, "CreateInterval": { "target": "com.amazonaws.dlm#CreateInterval", "traits": { "smithy.api#documentation": "\n [Default policies only] Specifies how often the policy should run and create snapshots or AMIs. \n\t\t\tThe creation frequency can range from 1 to 7 days.
" } }, "RetainInterval": { "target": "com.amazonaws.dlm#RetainInterval", "traits": { "smithy.api#documentation": "\n [Default policies only] Specifies how long the policy should retain snapshots or AMIs before \n\t\t\tdeleting them. The retention period can range from 2 to 14 days, but it must be greater \n\t\t\tthan the creation frequency to ensure that the policy retains at least 1 snapshot or \n\t\t\tAMI at any given time.
" } }, "CopyTags": { "target": "com.amazonaws.dlm#CopyTagsNullable", "traits": { "smithy.api#documentation": "\n [Default policies only] Indicates whether the policy should copy tags from the source resource \n\t\t\tto the snapshot or AMI.
" } }, "ExtendDeletion": { "target": "com.amazonaws.dlm#ExtendDeletion", "traits": { "smithy.api#documentation": "\n [Default policies only] Defines the snapshot or AMI retention behavior for the policy if the \n\t\t\tsource volume or instance is deleted, or if the policy enters the error, disabled, or \n\t\t\tdeleted state.
\nBy default (ExtendDeletion=false):
\nIf a source resource is deleted, Amazon Data Lifecycle Manager will continue to delete previously \n\t\t\t\t\tcreated snapshots or AMIs, up to but not including the last one, based on the \n\t\t\t\t\tspecified retention period. If you want Amazon Data Lifecycle Manager to delete all snapshots or AMIs, \n\t\t\t\t\tincluding the last one, specify true.
If a policy enters the error, disabled, or deleted state, Amazon Data Lifecycle Manager stops deleting \n\t\t\t\t\tsnapshots and AMIs. If you want Amazon Data Lifecycle Manager to continue deleting snapshots or AMIs, \n\t\t\t\t\tincluding the last one, if the policy enters one of these states, specify \n\t\t\t\t\ttrue.
If you enable extended deletion (ExtendDeletion=true), \n\t\t\tyou override both default behaviors simultaneously.
\nDefault: false
" } }, "CrossRegionCopyTargets": { "target": "com.amazonaws.dlm#CrossRegionCopyTargetList", "traits": { "smithy.api#documentation": "\n [Default policies only] Specifies destination Regions for snapshot or AMI copies. You can specify \n\t\t\tup to 3 destination Regions. If you do not want to create cross-Region copies, omit this \n\t\t\tparameter.
" } }, "Exclusions": { "target": "com.amazonaws.dlm#Exclusions", "traits": { "smithy.api#documentation": "\n [Default policies only] Specifies exclusion parameters for volumes or instances for which you \n\t\t\tdo not want to create snapshots or AMIs. The policy will not create snapshots or AMIs \n\t\t\tfor target resources that match any of the specified exclusion parameters.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.dlm#UpdateLifecyclePolicyResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.dlm#VariableTagsList": { "type": "list", "member": { "target": "com.amazonaws.dlm#Tag" }, "traits": { "smithy.api#length": { "min": 0, "max": 45 } } }, "com.amazonaws.dlm#VolumeTypeValues": { "type": "string" }, "com.amazonaws.dlm#dlm_20180112": { "type": "service", "version": "2018-01-12", "operations": [ { "target": "com.amazonaws.dlm#CreateLifecyclePolicy" }, { "target": "com.amazonaws.dlm#DeleteLifecyclePolicy" }, { "target": "com.amazonaws.dlm#GetLifecyclePolicies" }, { "target": "com.amazonaws.dlm#GetLifecyclePolicy" }, { "target": "com.amazonaws.dlm#ListTagsForResource" }, { "target": "com.amazonaws.dlm#TagResource" }, { "target": "com.amazonaws.dlm#UntagResource" }, { "target": "com.amazonaws.dlm#UpdateLifecyclePolicy" } ], "traits": { "aws.api#service": { "sdkId": "DLM", "arnNamespace": "dlm", "cloudFormationName": "DLM", "cloudTrailEventSource": "dlm.amazonaws.com", "endpointPrefix": "dlm" }, "aws.auth#sigv4": { "name": "dlm" }, "aws.protocols#restJson1": {}, "smithy.api#documentation": "With Amazon Data Lifecycle Manager, you can manage the lifecycle of your Amazon Web Services resources. You create\n\t\t\tlifecycle policies, which are used to automate operations on the specified\n\t\t\tresources.
\nAmazon Data Lifecycle Manager supports Amazon EBS volumes and snapshots. For information about using Amazon Data Lifecycle Manager\n\t\t\twith Amazon EBS, see \n\t\t\t\tAmazon Data Lifecycle Manager in the Amazon EC2 User Guide.
", "smithy.api#title": "Amazon Data Lifecycle Manager", "smithy.rules#endpointBdd": { "version": "1.1", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-us-gov" ] } ], "results": [ { "conditions": [], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://dlm-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://dlm.{Region}.amazonaws.com", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://dlm-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://dlm.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://dlm.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "root": 2, "nodeCount": 14, "nodes": "/////wAAAAH/////AAAAAAAAAA0AAAADAAAAAQAAAAQF9eEMAAAAAgAAAAUF9eEMAAAAAwAAAAgAAAAGAAAABAAAAAcF9eELAAAABQX14QkF9eEKAAAABAAAAAsAAAAJAAAABgAAAAoF9eEIAAAABwX14QYF9eEHAAAABQAAAAwF9eEFAAAABgX14QQF9eEFAAAAAwX14QEAAAAOAAAABAX14QIF9eED" }, "smithy.rules#endpointRuleSet": { "version": "1.0", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Region" } ] } ], "rules": [ { "conditions": [ { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] } ] }, { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://dlm-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-us-gov" ] } ], "endpoint": { "url": "https://dlm.{Region}.amazonaws.com", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://dlm-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://dlm.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } ], "type": "tree" }, { "conditions": [], "endpoint": { "url": "https://dlm.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ] }, "smithy.rules#endpointTests": { "testCases": [ { "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://dlm.af-south-1.amazonaws.com" } }, "params": { "Region": "af-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://dlm.ap-east-1.amazonaws.com" } }, "params": { "Region": "ap-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://dlm.ap-northeast-1.amazonaws.com" } }, "params": { "Region": "ap-northeast-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://dlm.ap-northeast-2.amazonaws.com" } }, "params": { "Region": "ap-northeast-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://dlm.ap-northeast-3.amazonaws.com" } }, "params": { "Region": "ap-northeast-3", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://dlm.ap-south-1.amazonaws.com" } }, "params": { "Region": "ap-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://dlm.ap-southeast-1.amazonaws.com" } }, "params": { "Region": "ap-southeast-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://dlm.ap-southeast-2.amazonaws.com" } }, "params": { "Region": "ap-southeast-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://dlm.ap-southeast-3.amazonaws.com" } }, "params": { "Region": "ap-southeast-3", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://dlm.ca-central-1.amazonaws.com" } }, "params": { "Region": "ca-central-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://dlm.eu-central-1.amazonaws.com" } }, "params": { "Region": "eu-central-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://dlm.eu-north-1.amazonaws.com" } }, "params": { "Region": "eu-north-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://dlm.eu-south-1.amazonaws.com" } }, "params": { "Region": "eu-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://dlm.eu-west-1.amazonaws.com" } }, "params": { "Region": "eu-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://dlm.eu-west-2.amazonaws.com" } }, "params": { "Region": "eu-west-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://dlm.eu-west-3.amazonaws.com" } }, "params": { "Region": "eu-west-3", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://dlm.me-south-1.amazonaws.com" } }, "params": { "Region": "me-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://dlm.sa-east-1.amazonaws.com" } }, "params": { "Region": "sa-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://dlm.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://dlm.us-east-2.amazonaws.com" } }, "params": { "Region": "us-east-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://dlm.us-west-1.amazonaws.com" } }, "params": { "Region": "us-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://dlm.us-west-2.amazonaws.com" } }, "params": { "Region": "us-west-2", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://dlm-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://dlm-fips.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://dlm.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://dlm.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://dlm.cn-northwest-1.amazonaws.com.cn" } }, "params": { "Region": "cn-northwest-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://dlm-fips.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://dlm-fips.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://dlm.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://dlm.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://dlm.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://dlm.us-gov-west-1.amazonaws.com" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://dlm.us-gov-west-1.amazonaws.com" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://dlm-fips.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://dlm.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://dlm-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://dlm.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://dlm-fips.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://dlm.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips enabled and dualstack disabled", "expect": { "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips disabled and dualstack enabled", "expect": { "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true, "Endpoint": "https://example.com" } }, { "documentation": "Missing region", "expect": { "error": "Invalid Configuration: Missing Region" } } ], "version": "1.0" } } } } }