AWS.Tools.DLM

3.3.590.0

AWS.Tools.DLM.dll-Help.xml

<helpItems schema="maml">
  <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">
    <details>
      <name>Get-DLMLifecyclePolicy</name>
      <description>
        <para>Calls the Amazon Data Lifecycle Manager GetLifecyclePolicy API operation.</para>
      </description>
      <verb>Get</verb>
      <noun>DLMLifecyclePolicy</noun>
      <copyright>
        <para>&amp;copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para>
      </copyright>
    </details>
    <description>
      <para>Gets detailed information about the specified lifecycle policy. </para>
    </description>
    <syntax>
      <syntaxItem>
        <name>Get-DLMLifecyclePolicy</name>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1">
          <name>PolicyId</name>
          <description>
            <para>The identifier of the lifecycle policy. </para>
          </description>
          <parameterValue required="true" variableLength="false">System.String</parameterValue>
        </parameter>
      </syntaxItem>
    </syntax>
    <parameters>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1">
        <name>PolicyId</name>
        <description>
          <para>The identifier of the lifecycle policy. </para>
        </description>
        <parameterValue required="true" variableLength="false">System.String</parameterValue>
        <type>
          <name>System.String</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
    </parameters>
    <returnValues>
      <returnValue>
        <type>
          <name>Amazon.DLM.Model.LifecyclePolicy</name>
          <uri />
          <description />
        </type>
        <description>
          <para>This cmdlet returns a Amazon.DLM.Model.LifecyclePolicy object.
The service call response (type Amazon.DLM.Model.GetLifecyclePolicyResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para>
        </description>
      </returnValue>
    </returnValues>
    <relatedLinks>
      <navigationLink>
        <linkText>Online version:</linkText>
        <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-DLMLifecyclePolicy.html&amp;tocid=Get-DLMLifecyclePolicy</uri>
      </navigationLink>
      <navigationLink>
        <linkText>Common credential and region parameters: </linkText>
        <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri>
      </navigationLink>
    </relatedLinks>
  </command>
  <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">
    <details>
      <name>Get-DLMLifecyclePolicySummary</name>
      <description>
        <para>Calls the Amazon Data Lifecycle Manager GetLifecyclePolicies API operation.</para>
      </description>
      <verb>Get</verb>
      <noun>DLMLifecyclePolicySummary</noun>
      <copyright>
        <para>&amp;copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para>
      </copyright>
    </details>
    <description>
      <para>Gets summary information about all or the specified data lifecycle policies.
To get complete information about a policy, use <a>GetLifecyclePolicy</a>. </para>
    </description>
    <syntax>
      <syntaxItem>
        <name>Get-DLMLifecyclePolicySummary</name>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">
          <name>PolicyId</name>
          <description>
            <para>The identifiers of the data lifecycle policies. </para>
          </description>
          <parameterValue required="true" variableLength="false">System.String[]</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">
          <name>ResourceType</name>
          <description>
            <para>The resource type. </para>
          </description>
          <parameterValue required="true" variableLength="false">System.String[]</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">
          <name>State</name>
          <description>
            <para>The activation state. </para>
          </description>
          <parameterValue required="true" variableLength="false">Amazon.DLM.GettablePolicyStateValues</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">
          <name>TagsToAdd</name>
          <description>
            <para>The tags to add to objects created by the policy.
Tags are strings in the format <code>key=value</code>.
These user-defined tags are added in addition to the AWS-added lifecycle tags. </para>
          </description>
          <parameterValue required="true" variableLength="false">System.String[]</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">
          <name>TargetTag</name>
          <description>
            <para>The target tag for a policy.
Tags are strings in the format <code>key=value</code>. </para>
          </description>
          <parameterValue required="true" variableLength="false">System.String[]</parameterValue>
        </parameter>
      </syntaxItem>
    </syntax>
    <parameters>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">
        <name>PolicyId</name>
        <description>
          <para>The identifiers of the data lifecycle policies. </para>
        </description>
        <parameterValue required="true" variableLength="false">System.String[]</parameterValue>
        <type>
          <name>System.String[]</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">
        <name>ResourceType</name>
        <description>
          <para>The resource type. </para>
        </description>
        <parameterValue required="true" variableLength="false">System.String[]</parameterValue>
        <type>
          <name>System.String[]</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">
        <name>State</name>
        <description>
          <para>The activation state. </para>
        </description>
        <parameterValue required="true" variableLength="false">Amazon.DLM.GettablePolicyStateValues</parameterValue>
        <type>
          <name>Amazon.DLM.GettablePolicyStateValues</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">
        <name>TagsToAdd</name>
        <description>
          <para>The tags to add to objects created by the policy.
Tags are strings in the format <code>key=value</code>.
These user-defined tags are added in addition to the AWS-added lifecycle tags. </para>
        </description>
        <parameterValue required="true" variableLength="false">System.String[]</parameterValue>
        <type>
          <name>System.String[]</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">
        <name>TargetTag</name>
        <description>
          <para>The target tag for a policy.
Tags are strings in the format <code>key=value</code>. </para>
        </description>
        <parameterValue required="true" variableLength="false">System.String[]</parameterValue>
        <type>
          <name>System.String[]</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
    </parameters>
    <returnValues>
      <returnValue>
        <type>
          <name>Amazon.DLM.Model.LifecyclePolicySummary</name>
          <uri />
          <description />
        </type>
        <description>
          <para>This cmdlet returns a collection of Amazon.DLM.Model.LifecyclePolicySummary objects.
The service call response (type Amazon.DLM.Model.GetLifecyclePoliciesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para>
        </description>
      </returnValue>
    </returnValues>
    <relatedLinks>
      <navigationLink>
        <linkText>Online version:</linkText>
        <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-DLMLifecyclePolicySummary.html&amp;tocid=Get-DLMLifecyclePolicySummary</uri>
      </navigationLink>
      <navigationLink>
        <linkText>Common credential and region parameters: </linkText>
        <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri>
      </navigationLink>
    </relatedLinks>
  </command>
  <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">
    <details>
      <name>New-DLMLifecyclePolicy</name>
      <description>
        <para>Calls the Amazon Data Lifecycle Manager CreateLifecyclePolicy API operation.</para>
      </description>
      <verb>New</verb>
      <noun>DLMLifecyclePolicy</noun>
      <copyright>
        <para>&amp;copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para>
      </copyright>
    </details>
    <description>
      <para>Creates a policy to manage the lifecycle of the specified AWS resources. You can create up to 100 lifecycle policies. </para>
    </description>
    <syntax>
      <syntaxItem>
        <name>New-DLMLifecyclePolicy</name>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1">
          <name>ExecutionRoleArn</name>
          <description>
            <para>The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy. </para>
          </description>
          <parameterValue required="true" variableLength="false">System.String</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">
          <name>Description</name>
          <description>
            <para>A description of the lifecycle policy. The characters ^[0-9A-Za-z _-]+$ are supported. </para>
          </description>
          <parameterValue required="true" variableLength="false">System.String</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">
          <name>Parameters_ExcludeBootVolume</name>
          <description>
            <para>When executing an EBS Snapshot Management – Instance policy, execute all CreateSnapshots calls with the <code>excludeBootVolume</code> set to the supplied field. Defaults to false. Only valid for EBS Snapshot Management – Instance policies. </para>
          </description>
          <parameterValue required="true" variableLength="false">System.Boolean</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">
          <name>PolicyDetails_PolicyType</name>
          <description>
            <para>This field determines the valid target resource types and actions a policy can manage. This field defaults to EBS_SNAPSHOT_MANAGEMENT if not present. </para>
          </description>
          <parameterValue required="true" variableLength="false">Amazon.DLM.PolicyTypeValues</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">
          <name>PolicyDetails_ResourceType</name>
          <description>
            <para>The resource type. </para>
          </description>
          <parameterValue required="true" variableLength="false">System.String[]</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">
          <name>PolicyDetails_Schedule</name>
          <description>
            <para>The schedule of policy-defined actions. </para>
          </description>
          <parameterValue required="true" variableLength="false">Amazon.DLM.Model.Schedule[]</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">
          <name>State</name>
          <description>
            <para>The desired activation state of the lifecycle policy after creation. </para>
          </description>
          <parameterValue required="true" variableLength="false">Amazon.DLM.SettablePolicyStateValues</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">
          <name>PolicyDetails_TargetTag</name>
          <description>
            <para>The single tag that identifies targeted resources for this policy. </para>
          </description>
          <parameterValue required="true" variableLength="false">Amazon.DLM.Model.Tag[]</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">
          <name>Force</name>
          <description>
            <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para>
          </description>
          <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue>
        </parameter>
      </syntaxItem>
    </syntax>
    <parameters>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">
        <name>Description</name>
        <description>
          <para>A description of the lifecycle policy. The characters ^[0-9A-Za-z _-]+$ are supported. </para>
        </description>
        <parameterValue required="true" variableLength="false">System.String</parameterValue>
        <type>
          <name>System.String</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1">
        <name>ExecutionRoleArn</name>
        <description>
          <para>The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy. </para>
        </description>
        <parameterValue required="true" variableLength="false">System.String</parameterValue>
        <type>
          <name>System.String</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">
        <name>Force</name>
        <description>
          <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para>
        </description>
        <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue>
        <type>
          <name>System.Management.Automation.SwitchParameter</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">
        <name>Parameters_ExcludeBootVolume</name>
        <description>
          <para>When executing an EBS Snapshot Management – Instance policy, execute all CreateSnapshots calls with the <code>excludeBootVolume</code> set to the supplied field. Defaults to false. Only valid for EBS Snapshot Management – Instance policies. </para>
        </description>
        <parameterValue required="true" variableLength="false">System.Boolean</parameterValue>
        <type>
          <name>System.Boolean</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">
        <name>PolicyDetails_PolicyType</name>
        <description>
          <para>This field determines the valid target resource types and actions a policy can manage. This field defaults to EBS_SNAPSHOT_MANAGEMENT if not present. </para>
        </description>
        <parameterValue required="true" variableLength="false">Amazon.DLM.PolicyTypeValues</parameterValue>
        <type>
          <name>Amazon.DLM.PolicyTypeValues</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">
        <name>PolicyDetails_ResourceType</name>
        <description>
          <para>The resource type. </para>
        </description>
        <parameterValue required="true" variableLength="false">System.String[]</parameterValue>
        <type>
          <name>System.String[]</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">
        <name>PolicyDetails_Schedule</name>
        <description>
          <para>The schedule of policy-defined actions. </para>
        </description>
        <parameterValue required="true" variableLength="false">Amazon.DLM.Model.Schedule[]</parameterValue>
        <type>
          <name>Amazon.DLM.Model.Schedule[]</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">
        <name>PolicyDetails_TargetTag</name>
        <description>
          <para>The single tag that identifies targeted resources for this policy. </para>
        </description>
        <parameterValue required="true" variableLength="false">Amazon.DLM.Model.Tag[]</parameterValue>
        <type>
          <name>Amazon.DLM.Model.Tag[]</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">
        <name>State</name>
        <description>
          <para>The desired activation state of the lifecycle policy after creation. </para>
        </description>
        <parameterValue required="true" variableLength="false">Amazon.DLM.SettablePolicyStateValues</parameterValue>
        <type>
          <name>Amazon.DLM.SettablePolicyStateValues</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
    </parameters>
    <returnValues>
      <returnValue>
        <type>
          <name>System.String</name>
          <uri />
          <description />
        </type>
        <description>
          <para>This cmdlet returns a System.String object.
The service call response (type Amazon.DLM.Model.CreateLifecyclePolicyResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para>
        </description>
      </returnValue>
    </returnValues>
    <relatedLinks>
      <navigationLink>
        <linkText>Online version:</linkText>
        <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=New-DLMLifecyclePolicy.html&amp;tocid=New-DLMLifecyclePolicy</uri>
      </navigationLink>
      <navigationLink>
        <linkText>Common credential and region parameters: </linkText>
        <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri>
      </navigationLink>
    </relatedLinks>
  </command>
  <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">
    <details>
      <name>Remove-DLMLifecyclePolicy</name>
      <description>
        <para>Calls the Amazon Data Lifecycle Manager DeleteLifecyclePolicy API operation.</para>
      </description>
      <verb>Remove</verb>
      <noun>DLMLifecyclePolicy</noun>
      <copyright>
        <para>&amp;copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para>
      </copyright>
    </details>
    <description>
      <para>Deletes the specified lifecycle policy and halts the automated operations that the policy specified. </para>
    </description>
    <syntax>
      <syntaxItem>
        <name>Remove-DLMLifecyclePolicy</name>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1">
          <name>PolicyId</name>
          <description>
            <para>The identifier of the lifecycle policy. </para>
          </description>
          <parameterValue required="true" variableLength="false">System.String</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">
          <name>PassThru</name>
          <description>
            <para>Returns the value passed to the PolicyId parameter. By default, this cmdlet does not generate any output. </para>
          </description>
          <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">
          <name>Force</name>
          <description>
            <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para>
          </description>
          <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue>
        </parameter>
      </syntaxItem>
    </syntax>
    <parameters>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">
        <name>Force</name>
        <description>
          <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para>
        </description>
        <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue>
        <type>
          <name>System.Management.Automation.SwitchParameter</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">
        <name>PassThru</name>
        <description>
          <para>Returns the value passed to the PolicyId parameter. By default, this cmdlet does not generate any output. </para>
        </description>
        <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue>
        <type>
          <name>System.Management.Automation.SwitchParameter</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1">
        <name>PolicyId</name>
        <description>
          <para>The identifier of the lifecycle policy. </para>
        </description>
        <parameterValue required="true" variableLength="false">System.String</parameterValue>
        <type>
          <name>System.String</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
    </parameters>
    <returnValues>
      <returnValue>
        <type>
          <name>None or System.String</name>
          <uri />
          <description />
        </type>
        <description>
          <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the PolicyId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.DLM.Model.DeleteLifecyclePolicyResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para>
        </description>
      </returnValue>
    </returnValues>
    <relatedLinks>
      <navigationLink>
        <linkText>Online version:</linkText>
        <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Remove-DLMLifecyclePolicy.html&amp;tocid=Remove-DLMLifecyclePolicy</uri>
      </navigationLink>
      <navigationLink>
        <linkText>Common credential and region parameters: </linkText>
        <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri>
      </navigationLink>
    </relatedLinks>
  </command>
  <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">
    <details>
      <name>Update-DLMLifecyclePolicy</name>
      <description>
        <para>Calls the Amazon Data Lifecycle Manager UpdateLifecyclePolicy API operation.</para>
      </description>
      <verb>Update</verb>
      <noun>DLMLifecyclePolicy</noun>
      <copyright>
        <para>&amp;copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para>
      </copyright>
    </details>
    <description>
      <para>Updates the specified lifecycle policy. </para>
    </description>
    <syntax>
      <syntaxItem>
        <name>Update-DLMLifecyclePolicy</name>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1">
          <name>PolicyId</name>
          <description>
            <para>The identifier of the lifecycle policy. </para>
          </description>
          <parameterValue required="true" variableLength="false">System.String</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">
          <name>Description</name>
          <description>
            <para>A description of the lifecycle policy. </para>
          </description>
          <parameterValue required="true" variableLength="false">System.String</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">
          <name>Parameters_ExcludeBootVolume</name>
          <description>
            <para>When executing an EBS Snapshot Management – Instance policy, execute all CreateSnapshots calls with the <code>excludeBootVolume</code> set to the supplied field. Defaults to false. Only valid for EBS Snapshot Management – Instance policies. </para>
          </description>
          <parameterValue required="true" variableLength="false">System.Boolean</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">
          <name>ExecutionRoleArn</name>
          <description>
            <para>The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy. </para>
          </description>
          <parameterValue required="true" variableLength="false">System.String</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">
          <name>PolicyDetails_PolicyType</name>
          <description>
            <para>This field determines the valid target resource types and actions a policy can manage. This field defaults to EBS_SNAPSHOT_MANAGEMENT if not present. </para>
          </description>
          <parameterValue required="true" variableLength="false">Amazon.DLM.PolicyTypeValues</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">
          <name>PolicyDetails_ResourceType</name>
          <description>
            <para>The resource type. </para>
          </description>
          <parameterValue required="true" variableLength="false">System.String[]</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">
          <name>PolicyDetails_Schedule</name>
          <description>
            <para>The schedule of policy-defined actions. </para>
          </description>
          <parameterValue required="true" variableLength="false">Amazon.DLM.Model.Schedule[]</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">
          <name>State</name>
          <description>
            <para>The desired activation state of the lifecycle policy after creation. </para>
          </description>
          <parameterValue required="true" variableLength="false">Amazon.DLM.SettablePolicyStateValues</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">
          <name>PolicyDetails_TargetTag</name>
          <description>
            <para>The single tag that identifies targeted resources for this policy. </para>
          </description>
          <parameterValue required="true" variableLength="false">Amazon.DLM.Model.Tag[]</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">
          <name>PassThru</name>
          <description>
            <para>Returns the value passed to the PolicyId parameter. By default, this cmdlet does not generate any output. </para>
          </description>
          <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">
          <name>Force</name>
          <description>
            <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para>
          </description>
          <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue>
        </parameter>
      </syntaxItem>
    </syntax>
    <parameters>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">
        <name>Description</name>
        <description>
          <para>A description of the lifecycle policy. </para>
        </description>
        <parameterValue required="true" variableLength="false">System.String</parameterValue>
        <type>
          <name>System.String</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">
        <name>ExecutionRoleArn</name>
        <description>
          <para>The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy. </para>
        </description>
        <parameterValue required="true" variableLength="false">System.String</parameterValue>
        <type>
          <name>System.String</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">
        <name>Force</name>
        <description>
          <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para>
        </description>
        <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue>
        <type>
          <name>System.Management.Automation.SwitchParameter</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">
        <name>Parameters_ExcludeBootVolume</name>
        <description>
          <para>When executing an EBS Snapshot Management – Instance policy, execute all CreateSnapshots calls with the <code>excludeBootVolume</code> set to the supplied field. Defaults to false. Only valid for EBS Snapshot Management – Instance policies. </para>
        </description>
        <parameterValue required="true" variableLength="false">System.Boolean</parameterValue>
        <type>
          <name>System.Boolean</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">
        <name>PassThru</name>
        <description>
          <para>Returns the value passed to the PolicyId parameter. By default, this cmdlet does not generate any output. </para>
        </description>
        <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue>
        <type>
          <name>System.Management.Automation.SwitchParameter</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">
        <name>PolicyDetails_PolicyType</name>
        <description>
          <para>This field determines the valid target resource types and actions a policy can manage. This field defaults to EBS_SNAPSHOT_MANAGEMENT if not present. </para>
        </description>
        <parameterValue required="true" variableLength="false">Amazon.DLM.PolicyTypeValues</parameterValue>
        <type>
          <name>Amazon.DLM.PolicyTypeValues</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">
        <name>PolicyDetails_ResourceType</name>
        <description>
          <para>The resource type. </para>
        </description>
        <parameterValue required="true" variableLength="false">System.String[]</parameterValue>
        <type>
          <name>System.String[]</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">
        <name>PolicyDetails_Schedule</name>
        <description>
          <para>The schedule of policy-defined actions. </para>
        </description>
        <parameterValue required="true" variableLength="false">Amazon.DLM.Model.Schedule[]</parameterValue>
        <type>
          <name>Amazon.DLM.Model.Schedule[]</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">
        <name>PolicyDetails_TargetTag</name>
        <description>
          <para>The single tag that identifies targeted resources for this policy. </para>
        </description>
        <parameterValue required="true" variableLength="false">Amazon.DLM.Model.Tag[]</parameterValue>
        <type>
          <name>Amazon.DLM.Model.Tag[]</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1">
        <name>PolicyId</name>
        <description>
          <para>The identifier of the lifecycle policy. </para>
        </description>
        <parameterValue required="true" variableLength="false">System.String</parameterValue>
        <type>
          <name>System.String</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">
        <name>State</name>
        <description>
          <para>The desired activation state of the lifecycle policy after creation. </para>
        </description>
        <parameterValue required="true" variableLength="false">Amazon.DLM.SettablePolicyStateValues</parameterValue>
        <type>
          <name>Amazon.DLM.SettablePolicyStateValues</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
    </parameters>
    <returnValues>
      <returnValue>
        <type>
          <name>None or System.String</name>
          <uri />
          <description />
        </type>
        <description>
          <para>When you use the PassThru parameter, this cmdlet outputs the value supplied to the PolicyId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.DLM.Model.UpdateLifecyclePolicyResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para>
        </description>
      </returnValue>
    </returnValues>
    <relatedLinks>
      <navigationLink>
        <linkText>Online version:</linkText>
        <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Update-DLMLifecyclePolicy.html&amp;tocid=Update-DLMLifecyclePolicy</uri>
      </navigationLink>
      <navigationLink>
        <linkText>Common credential and region parameters: </linkText>
        <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri>
      </navigationLink>
    </relatedLinks>
  </command>
</helpItems>