AWS.Tools.RecycleBin.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.RecycleBin</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.RBIN.AddRBINResourceTagCmdlet"> <summary> Assigns tags to the specified resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.AddRBINResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource to which to assign the tags.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.AddRBINResourceTagCmdlet.Tag"> <summary> <para> <para>Information about the tags to assign to the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.AddRBINResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.RecycleBin.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.AddRBINResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.AddRBINResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.RBIN.GetRBINResourceTagCmdlet"> <summary> Lists the tags assigned a specific resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.GetRBINResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource for which to list the tags.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.GetRBINResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Tags'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.RecycleBin.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.RecycleBin.Model.ListTagsForResourceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.GetRBINResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.RBIN.GetRBINRuleCmdlet"> <summary> Gets information about a Recycle Bin retention rule. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.GetRBINRuleCmdlet.Identifier"> <summary> <para> <para>The unique ID of the retention rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.GetRBINRuleCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.RecycleBin.Model.GetRuleResponse). Specifying the name of a property of type Amazon.RecycleBin.Model.GetRuleResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.GetRBINRuleCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Identifier parameter. The -PassThru parameter is deprecated, use -Select '^Identifier' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.RBIN.GetRBINRuleListCmdlet"> <summary> Lists the Recycle Bin retention rules in the Region. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.GetRBINRuleListCmdlet.ResourceTag"> <summary> <para> <para>The tags used to identify resources that are to be retained by the retention rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.GetRBINRuleListCmdlet.ResourceType"> <summary> <para> <para>The resource type retained by the retention rule. Only retention rules that retain the specified resource type are listed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.GetRBINRuleListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned <code>nextToken</code> value. This value can be between 5 and 500. If <code>maxResults</code> is given a larger value than 500, you receive an error.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.GetRBINRuleListCmdlet.NextToken"> <summary> <para> <para>The token to use to retrieve the next page of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.GetRBINRuleListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Rules'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.RecycleBin.Model.ListRulesResponse). Specifying the name of a property of type Amazon.RecycleBin.Model.ListRulesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.GetRBINRuleListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceType parameter. The -PassThru parameter is deprecated, use -Select '^ResourceType' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.RBIN.NewRBINRuleCmdlet"> <summary> Creates a Recycle Bin retention rule. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/recycle-bin-working-with-rules.html#recycle-bin-create-rule"> Create Recycle Bin retention rules</a> in the <i>Amazon EC2 User Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.NewRBINRuleCmdlet.Description"> <summary> <para> <para>A brief description for the retention rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.NewRBINRuleCmdlet.ResourceTag"> <summary> <para> <para>Information about the resource tags to use to identify resources that are to be retained by the retention rule. The retention rule retains only deleted snapshots that have one or more of the specified tag key and value pairs. If a snapshot is deleted, but it does not have any of the specified tag key and value pairs, it is immediately deleted without being retained by the retention rule.</para><para>You can add the same tag key and value pair to a maximum or five retention rules.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.NewRBINRuleCmdlet.ResourceType"> <summary> <para> <para>The resource type to be retained by the retention rule. Currently, only Amazon EBS snapshots are supported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.NewRBINRuleCmdlet.RetentionPeriod_RetentionPeriodUnit"> <summary> <para> <para>The unit of time in which the retention period is measured. Currently, only <code>DAYS</code> is supported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.NewRBINRuleCmdlet.RetentionPeriod_RetentionPeriodValue"> <summary> <para> <para>The period value for which the retention rule is to retain resources. The period is measured using the unit specified for <b>RetentionPeriodUnit</b>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.NewRBINRuleCmdlet.Tag"> <summary> <para> <para>Information about the tags to assign to the retention rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.NewRBINRuleCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.RecycleBin.Model.CreateRuleResponse). Specifying the name of a property of type Amazon.RecycleBin.Model.CreateRuleResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.NewRBINRuleCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceType parameter. The -PassThru parameter is deprecated, use -Select '^ResourceType' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.NewRBINRuleCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.RBIN.RemoveRBINResourceTagCmdlet"> <summary> Unassigns a tag from a resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.RemoveRBINResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource from which to unassign the tags.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.RemoveRBINResourceTagCmdlet.TagKey"> <summary> <para> <para>Information about the tags to unassign from the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.RemoveRBINResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.RecycleBin.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.RemoveRBINResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.RemoveRBINResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.RBIN.RemoveRBINRuleCmdlet"> <summary> Deletes a Recycle Bin retention rule. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/recycle-bin-working-with-rules.html#recycle-bin-delete-rule"> Delete Recycle Bin retention rules</a> in the <i>Amazon EC2 User Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.RemoveRBINRuleCmdlet.Identifier"> <summary> <para> <para>The unique ID of the retention rule to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.RemoveRBINRuleCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.RecycleBin.Model.DeleteRuleResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.RemoveRBINRuleCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Identifier parameter. The -PassThru parameter is deprecated, use -Select '^Identifier' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.RemoveRBINRuleCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.RBIN.UpdateRBINRuleCmdlet"> <summary> Updates an existing Recycle Bin retention rule. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/recycle-bin-working-with-rules.html#recycle-bin-update-rule"> Update Recycle Bin retention rules</a> in the <i>Amazon EC2 User Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.UpdateRBINRuleCmdlet.Description"> <summary> <para> <para>The retention rule description.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.UpdateRBINRuleCmdlet.Identifier"> <summary> <para> <para>The unique ID of the retention rule to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.UpdateRBINRuleCmdlet.ResourceTag"> <summary> <para> <para>Information about the resource tags to use to identify resources that are to be retained by the retention rule. The retention rule retains only deleted snapshots that have one or more of the specified tag key and value pairs. If a snapshot is deleted, but it does not have any of the specified tag key and value pairs, it is immediately deleted without being retained by the retention rule. </para><para>You can add the same tag key and value pair to a maximum or five retention rules.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.UpdateRBINRuleCmdlet.ResourceType"> <summary> <para> <para>The resource type to be retained by the retention rule. Currently, only Amazon EBS snapshots are supported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.UpdateRBINRuleCmdlet.RetentionPeriod_RetentionPeriodUnit"> <summary> <para> <para>The unit of time in which the retention period is measured. Currently, only <code>DAYS</code> is supported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.UpdateRBINRuleCmdlet.RetentionPeriod_RetentionPeriodValue"> <summary> <para> <para>The period value for which the retention rule is to retain resources. The period is measured using the unit specified for <b>RetentionPeriodUnit</b>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.UpdateRBINRuleCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.RecycleBin.Model.UpdateRuleResponse). Specifying the name of a property of type Amazon.RecycleBin.Model.UpdateRuleResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.UpdateRBINRuleCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Identifier parameter. The -PassThru parameter is deprecated, use -Select '^Identifier' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.RBIN.UpdateRBINRuleCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> </members> </doc> |