AWS.Tools.Pricing.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.Pricing</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.PLS.GetPLSAttributeValueCmdlet"> <summary> Returns a list of attribute values. Attributes are similar to the details in a Price List API offer file. For a list of available attributes, see <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/reading-an-offer.html#pps-defs">Offer File Definitions</a> in the <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/billing-what-is.html">Billing and Cost Management User Guide</a>.<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.PLS.GetPLSAttributeValueCmdlet.AttributeName"> <summary> <para> <para>The name of the attribute that you want to retrieve the values for, such as <code>volumeType</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PLS.GetPLSAttributeValueCmdlet.ServiceCode"> <summary> <para> <para>The service code for the service whose attributes you want to retrieve. For example, if you want the retrieve an EC2 attribute, use <code>AmazonEC2</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PLS.GetPLSAttributeValueCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in response.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PLS.GetPLSAttributeValueCmdlet.NextToken"> <summary> <para> <para>The pagination token that indicates the next set of results that you want to retrieve.</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.PLS.GetPLSAttributeValueCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AttributeValues'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pricing.Model.GetAttributeValuesResponse). Specifying the name of a property of type Amazon.Pricing.Model.GetAttributeValuesResponse 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.PLS.GetPLSAttributeValueCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AttributeName parameter. The -PassThru parameter is deprecated, use -Select '^AttributeName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PLS.GetPLSAttributeValueCmdlet.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.PLS.GetPLSPriceListFileUrlCmdlet"> <summary> <i><b>This feature is in preview release and is subject to change. Your use of Amazon Web Services Price List API is subject to the Beta Service Participation terms of the <a href="https://aws.amazon.com/service-terms/">Amazon Web Services Service Terms</a> (Section 1.10).</b></i><para> This returns the URL that you can retrieve your Price List file from. This URL is based on the <code>PriceListArn</code> and <code>FileFormat</code> that you retrieve from the <a href="https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_pricing_ListPriceLists.html">ListPriceLists</a> response. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PLS.GetPLSPriceListFileUrlCmdlet.FileFormat"> <summary> <para> <para>The format that you want to retrieve your Price List files in. The <code>FileFormat</code> can be obtained from the <a href="https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_pricing_ListPriceLists.html">ListPriceLists</a> response. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PLS.GetPLSPriceListFileUrlCmdlet.PriceListArn"> <summary> <para> <para>The unique identifier that maps to where your Price List files are located. <code>PriceListArn</code> can be obtained from the <a href="https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_pricing_ListPriceLists.html">ListPriceLists</a> response. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PLS.GetPLSPriceListFileUrlCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Url'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pricing.Model.GetPriceListFileUrlResponse). Specifying the name of a property of type Amazon.Pricing.Model.GetPriceListFileUrlResponse 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="T:Amazon.PowerShell.Cmdlets.PLS.GetPLSPriceListListCmdlet"> <summary> <i><b>This feature is in preview release and is subject to change. Your use of Amazon Web Services Price List API is subject to the Beta Service Participation terms of the <a href="https://aws.amazon.com/service-terms/">Amazon Web Services Service Terms</a> (Section 1.10).</b></i><para> This returns a list of Price List references that the requester if authorized to view, given a <code>ServiceCode</code>, <code>CurrencyCode</code>, and an <code>EffectiveDate</code>. Use without a <code>RegionCode</code> filter to list Price List references from all available Amazon Web Services Regions. Use with a <code>RegionCode</code> filter to get the Price List reference that's specific to a specific Amazon Web Services Region. You can use the <code>PriceListArn</code> from the response to get your preferred Price List files through the <a href="https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_pricing_GetPriceListFileUrl.html">GetPriceListFileUrl</a> API. </para><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.PLS.GetPLSPriceListListCmdlet.CurrencyCode"> <summary> <para> <para>The three alphabetical character ISO-4217 currency code that the Price List files are denominated in. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PLS.GetPLSPriceListListCmdlet.EffectiveDate"> <summary> <para> <para>The date that the Price List file prices are effective from. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PLS.GetPLSPriceListListCmdlet.RegionCode"> <summary> <para> <para>This is used to filter the Price List by Amazon Web Services Region. For example, to get the price list only for the <code>US East (N. Virginia)</code> Region, use <code>us-east-1</code>. If nothing is specified, you retrieve price lists for all applicable Regions. The available <code>RegionCode</code> list can be retrieved from <a href="https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_pricing_GetAttributeValues.html">GetAttributeValues</a> API.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PLS.GetPLSPriceListListCmdlet.ServiceCode"> <summary> <para> <para>The service code or the Savings Plan service code for the attributes that you want to retrieve. For example, to get the list of applicable Amazon EC2 price lists, use <code>AmazonEC2</code>. For a full list of service codes containing On-Demand and Reserved Instance (RI) pricing, use the <a href="https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_pricing_DescribeServices.html#awscostmanagement-pricing_DescribeServices-request-FormatVersion">DescribeServices</a> API.</para><para>To retrieve the Reserved Instance and Compute Savings Plan price lists, use <code>ComputeSavingsPlans</code>. </para><para>To retrieve Machine Learning Savings Plans price lists, use <code>MachineLearningSavingsPlans</code>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PLS.GetPLSPriceListListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in the response. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PLS.GetPLSPriceListListCmdlet.NextToken"> <summary> <para> <para>The pagination token that indicates the next set of results that you want to retrieve. </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.PLS.GetPLSPriceListListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'PriceLists'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pricing.Model.ListPriceListsResponse). Specifying the name of a property of type Amazon.Pricing.Model.ListPriceListsResponse 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.PLS.GetPLSPriceListListCmdlet.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.PLS.GetPLSProductCmdlet"> <summary> Returns a list of all products that match the filter criteria.<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.PLS.GetPLSProductCmdlet.Filter"> <summary> <para> <para>The list of filters that limit the returned products. only products that match all filters are returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PLS.GetPLSProductCmdlet.ServiceCode"> <summary> <para> <para>The code for the service whose products you want to retrieve. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PLS.GetPLSProductCmdlet.FormatVersion"> <summary> <para> <para>The format version that you want the response to be in.</para><para>Valid values are: <code>aws_v1</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PLS.GetPLSProductCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in the response.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PLS.GetPLSProductCmdlet.NextToken"> <summary> <para> <para>The pagination token that indicates the next set of results that you want to retrieve.</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.PLS.GetPLSProductCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'PriceList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pricing.Model.GetProductsResponse). Specifying the name of a property of type Amazon.Pricing.Model.GetProductsResponse 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.PLS.GetPLSProductCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ServiceCode parameter. The -PassThru parameter is deprecated, use -Select '^ServiceCode' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PLS.GetPLSProductCmdlet.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.PLS.GetPLSServiceCmdlet"> <summary> Returns the metadata for one service or a list of the metadata for all services. Use this without a service code to get the service codes for all services. Use it with a service code, such as <code>AmazonEC2</code>, to get information specific to that service, such as the attribute names available for that service. For example, some of the attribute names available for EC2 are <code>volumeType</code>, <code>maxIopsVolume</code>, <code>operation</code>, <code>locationType</code>, and <code>instanceCapacity10xlarge</code>.<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.PLS.GetPLSServiceCmdlet.ServiceCode"> <summary> <para> <para>The code for the service whose information you want to retrieve, such as <code>AmazonEC2</code>. You can use the <code>ServiceCode</code> to filter the results in a <code>GetProducts</code> call. To retrieve a list of all services, leave this blank.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PLS.GetPLSServiceCmdlet.FormatVersion"> <summary> <para> <para>The format version that you want the response to be in.</para><para>Valid values are: <code>aws_v1</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PLS.GetPLSServiceCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results that you want returned in the response.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PLS.GetPLSServiceCmdlet.NextToken"> <summary> <para> <para>The pagination token that indicates the next set of results that you want to retrieve.</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.PLS.GetPLSServiceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Services'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Pricing.Model.DescribeServicesResponse). Specifying the name of a property of type Amazon.Pricing.Model.DescribeServicesResponse 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.PLS.GetPLSServiceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ServiceCode parameter. The -PassThru parameter is deprecated, use -Select '^ServiceCode' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.PLS.GetPLSServiceCmdlet.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> </members> </doc> |