AWS.Tools.SavingsPlans.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.SavingsPlans</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.SP.AddSPResourceTagCmdlet"> <summary> Adds the specified tags to the specified resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SP.AddSPResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SP.AddSPResourceTagCmdlet.Tag"> <summary> <para> <para>One or more tags. For example, { "tags": {"key1":"value1", "key2":"value2"} }.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SP.AddSPResourceTagCmdlet.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.SavingsPlans.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SP.AddSPResourceTagCmdlet.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.SP.AddSPResourceTagCmdlet.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.SP.GetSPResourceTagCmdlet"> <summary> Lists the tags for the specified resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SP.GetSPResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SP.GetSPResourceTagCmdlet.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.SavingsPlans.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.SavingsPlans.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.SP.GetSPResourceTagCmdlet.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.SP.GetSPSavingsPlanCmdlet"> <summary> Describes the specified Savings Plans.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SP.GetSPSavingsPlanCmdlet.Filter"> <summary> <para> <para>The filters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SP.GetSPSavingsPlanCmdlet.SavingsPlanArn"> <summary> <para> <para>The Amazon Resource Names (ARN) of the Savings Plans.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SP.GetSPSavingsPlanCmdlet.SavingsPlanId"> <summary> <para> <para>The IDs of the Savings Plans.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SP.GetSPSavingsPlanCmdlet.State"> <summary> <para> <para>The states.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SP.GetSPSavingsPlanCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return with a single call. To retrieve additional results, make another call with the returned token value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SP.GetSPSavingsPlanCmdlet.NextToken"> <summary> <para> <para>The token for the next page of results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SP.GetSPSavingsPlanCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'SavingsPlans'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SavingsPlans.Model.DescribeSavingsPlansResponse). Specifying the name of a property of type Amazon.SavingsPlans.Model.DescribeSavingsPlansResponse 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.SP.GetSPSavingsPlanCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SP.GetSPSavingsPlanRateCmdlet"> <summary> Describes the specified Savings Plans rates.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SP.GetSPSavingsPlanRateCmdlet.Filter"> <summary> <para> <para>The filters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SP.GetSPSavingsPlanRateCmdlet.SavingsPlanId"> <summary> <para> <para>The ID of the Savings Plan.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SP.GetSPSavingsPlanRateCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return with a single call. To retrieve additional results, make another call with the returned token value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SP.GetSPSavingsPlanRateCmdlet.NextToken"> <summary> <para> <para>The token for the next page of results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SP.GetSPSavingsPlanRateCmdlet.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.SavingsPlans.Model.DescribeSavingsPlanRatesResponse). Specifying the name of a property of type Amazon.SavingsPlans.Model.DescribeSavingsPlanRatesResponse 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.SP.GetSPSavingsPlanRateCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SavingsPlanId parameter. The -PassThru parameter is deprecated, use -Select '^SavingsPlanId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SP.GetSPSavingsPlanRateCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SP.GetSPSavingsPlansOfferingCmdlet"> <summary> Describes the specified Savings Plans offerings.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SP.GetSPSavingsPlansOfferingCmdlet.Currency"> <summary> <para> <para>The currencies.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SP.GetSPSavingsPlansOfferingCmdlet.Description"> <summary> <para> <para>The descriptions.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SP.GetSPSavingsPlansOfferingCmdlet.Duration"> <summary> <para> <para>The durations, in seconds.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SP.GetSPSavingsPlansOfferingCmdlet.Filter"> <summary> <para> <para>The filters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SP.GetSPSavingsPlansOfferingCmdlet.OfferingId"> <summary> <para> <para>The IDs of the offerings.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SP.GetSPSavingsPlansOfferingCmdlet.Operation"> <summary> <para> <para>The specific AWS operation for the line item in the billing report.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SP.GetSPSavingsPlansOfferingCmdlet.PaymentOption"> <summary> <para> <para>The payment options.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SP.GetSPSavingsPlansOfferingCmdlet.PlanType"> <summary> <para> <para>The plan type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SP.GetSPSavingsPlansOfferingCmdlet.ProductType"> <summary> <para> <para>The product type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SP.GetSPSavingsPlansOfferingCmdlet.ServiceCode"> <summary> <para> <para>The services.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SP.GetSPSavingsPlansOfferingCmdlet.UsageType"> <summary> <para> <para>The usage details of the line item in the billing report.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SP.GetSPSavingsPlansOfferingCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return with a single call. To retrieve additional results, make another call with the returned token value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SP.GetSPSavingsPlansOfferingCmdlet.NextToken"> <summary> <para> <para>The token for the next page of results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SP.GetSPSavingsPlansOfferingCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'SearchResults'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SavingsPlans.Model.DescribeSavingsPlansOfferingsResponse). Specifying the name of a property of type Amazon.SavingsPlans.Model.DescribeSavingsPlansOfferingsResponse 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.SP.GetSPSavingsPlansOfferingCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SP.GetSPSavingsPlansOfferingRateCmdlet"> <summary> Describes the specified Savings Plans offering rates.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SP.GetSPSavingsPlansOfferingRateCmdlet.Filter"> <summary> <para> <para>The filters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SP.GetSPSavingsPlansOfferingRateCmdlet.Operation"> <summary> <para> <para>The specific AWS operation for the line item in the billing report.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SP.GetSPSavingsPlansOfferingRateCmdlet.Product"> <summary> <para> <para>The AWS products.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SP.GetSPSavingsPlansOfferingRateCmdlet.SavingsPlanOfferingId"> <summary> <para> <para>The IDs of the offerings.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SP.GetSPSavingsPlansOfferingRateCmdlet.SavingsPlanPaymentOption"> <summary> <para> <para>The payment options.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SP.GetSPSavingsPlansOfferingRateCmdlet.SavingsPlanType"> <summary> <para> <para>The plan types.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SP.GetSPSavingsPlansOfferingRateCmdlet.ServiceCode"> <summary> <para> <para>The services.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SP.GetSPSavingsPlansOfferingRateCmdlet.UsageType"> <summary> <para> <para>The usage details of the line item in the billing report.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SP.GetSPSavingsPlansOfferingRateCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return with a single call. To retrieve additional results, make another call with the returned token value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SP.GetSPSavingsPlansOfferingRateCmdlet.NextToken"> <summary> <para> <para>The token for the next page of results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SP.GetSPSavingsPlansOfferingRateCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'SearchResults'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SavingsPlans.Model.DescribeSavingsPlansOfferingRatesResponse). Specifying the name of a property of type Amazon.SavingsPlans.Model.DescribeSavingsPlansOfferingRatesResponse 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.SP.GetSPSavingsPlansOfferingRateCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SP.NewSPSavingsPlanCmdlet"> <summary> Creates a Savings Plan. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SP.NewSPSavingsPlanCmdlet.Commitment"> <summary> <para> <para>The hourly commitment, in USD. This is a value between 0.001 and 1 million. You cannot specify more than five digits after the decimal point.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SP.NewSPSavingsPlanCmdlet.PurchaseTime"> <summary> <para> <para>The time at which to purchase the Savings Plan, in UTC format (YYYY-MM-DDTHH:MM:SSZ).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SP.NewSPSavingsPlanCmdlet.SavingsPlanOfferingId"> <summary> <para> <para>The ID of the offering.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SP.NewSPSavingsPlanCmdlet.Tag"> <summary> <para> <para>One or more tags.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SP.NewSPSavingsPlanCmdlet.UpfrontPaymentAmount"> <summary> <para> <para>The up-front payment amount. This is a whole number between 50 and 99 percent of the total value of the Savings Plan. This parameter is supported only if the payment option is <code>Partial Upfront</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SP.NewSPSavingsPlanCmdlet.ClientToken"> <summary> <para> <para>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SP.NewSPSavingsPlanCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'SavingsPlanId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SavingsPlans.Model.CreateSavingsPlanResponse). Specifying the name of a property of type Amazon.SavingsPlans.Model.CreateSavingsPlanResponse 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.SP.NewSPSavingsPlanCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SavingsPlanOfferingId parameter. The -PassThru parameter is deprecated, use -Select '^SavingsPlanOfferingId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SP.NewSPSavingsPlanCmdlet.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.SP.RemoveSPQueuedSavingsPlanCmdlet"> <summary> Deletes the queued purchase for the specified Savings Plan. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SP.RemoveSPQueuedSavingsPlanCmdlet.SavingsPlanId"> <summary> <para> <para>The ID of the Savings Plan.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SP.RemoveSPQueuedSavingsPlanCmdlet.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.SavingsPlans.Model.DeleteQueuedSavingsPlanResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SP.RemoveSPQueuedSavingsPlanCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SavingsPlanId parameter. The -PassThru parameter is deprecated, use -Select '^SavingsPlanId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SP.RemoveSPQueuedSavingsPlanCmdlet.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.SP.RemoveSPResourceTagCmdlet"> <summary> Removes the specified tags from the specified resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SP.RemoveSPResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SP.RemoveSPResourceTagCmdlet.TagKey"> <summary> <para> <para>The tag keys.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SP.RemoveSPResourceTagCmdlet.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.SavingsPlans.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SP.RemoveSPResourceTagCmdlet.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.SP.RemoveSPResourceTagCmdlet.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> |