AWS.Tools.Pricing

3.3.604.0

AWS.Tools.Pricing.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-PLSAttributeValue</name>
      <description>
        <para>Calls the AWS Price List Service GetAttributeValues API operation.</para>
      </description>
      <verb>Get</verb>
      <noun>PLSAttributeValue</noun>
      <copyright>
        <para>&amp;copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para>
      </copyright>
    </details>
    <description>
      <para>Returns a list of attribute values. Attibutes are similar to the details in a Price List API offer file. For a list of available attributes, see <a href="http://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/reading-an-offer.html#pps-defs">Offer File Definitions</a> in the <a href="http://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/billing-what-is.html">AWS Billing and Cost Management User Guide</a>.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para>
    </description>
    <syntax>
      <syntaxItem>
        <name>Get-PLSAttributeValue</name>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1">
          <name>AttributeName</name>
          <description>
            <para>The name of the attribute that you want to retrieve the values for, such as <code>volumeType</code>. </para>
          </description>
          <parameterValue required="true" variableLength="false">System.String</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">
          <name>ServiceCode</name>
          <description>
            <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>
          </description>
          <parameterValue required="true" variableLength="false">System.String</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">
          <name>MaxResult</name>
          <description>
            <para>The maximum number of results to return in response. </para>
          </description>
          <parameterValue required="true" variableLength="false">System.Int32</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">
          <name>NextToken</name>
          <description>
            <para>The pagination token that indicates the next set of results that you want to retrieve.
<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, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </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>AttributeName</name>
        <description>
          <para>The name of the attribute that you want to retrieve the values for, such as <code>volumeType</code>. </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>MaxResult</name>
        <description>
          <para>The maximum number of results to return in response. </para>
        </description>
        <parameterValue required="true" variableLength="false">System.Int32</parameterValue>
        <type>
          <name>System.Int32</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">
        <name>NextToken</name>
        <description>
          <para>The pagination token that indicates the next set of results that you want to retrieve.
<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, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </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>ServiceCode</name>
        <description>
          <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>
        </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.Pricing.Model.AttributeValue</name>
          <uri />
          <description />
        </type>
        <description>
          <para>This cmdlet returns a collection of Amazon.Pricing.Model.AttributeValue objects.
The service call response (type Amazon.Pricing.Model.GetAttributeValuesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)</para>
        </description>
      </returnValue>
    </returnValues>
    <relatedLinks>
      <navigationLink>
        <linkText>Online version:</linkText>
        <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-PLSAttributeValue.html&amp;tocid=Get-PLSAttributeValue</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>
      <navigationLink>
        <linkText>User Guide:</linkText>
        <uri>http://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/using-pelong.html</uri>
      </navigationLink>
    </relatedLinks>
    <examples>
      <example>
        <title>-------------------------- EXAMPLE 1 --------------------------</title><code>
PS C:\&gt; Get-PLSAttributeValue -ServiceCode AmazonEC2 -AttributeName "volumeType" -region us-east-1
     
Value
-----
Cold HDD
General Purpose
Magnetic
Provisioned IOPS
Throughput Optimized HDD
        </code><remarks><para>Description</para><para>-----------</para><para>Returns the values for the attribute 'volumeType' for Amazon EC2 in the us-east-1 region.</para><para /><para /></remarks>
      </example>
    </examples>
  </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-PLSProduct</name>
      <description>
        <para>Calls the AWS Price List Service GetProducts API operation.</para>
      </description>
      <verb>Get</verb>
      <noun>PLSProduct</noun>
      <copyright>
        <para>&amp;copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para>
      </copyright>
    </details>
    <description>
      <para>Returns a list of all products that match the filter criteria.<br /><br />This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para>
    </description>
    <syntax>
      <syntaxItem>
        <name>Get-PLSProduct</name>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1">
          <name>ServiceCode</name>
          <description>
            <para>The code for the service whose products you want to retrieve. </para>
          </description>
          <parameterValue required="true" variableLength="false">System.String</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">
          <name>Filter</name>
          <description>
            <para>The list of filters that limit the returned products. only products that match all filters are returned. </para>
          </description>
          <parameterValue required="true" variableLength="false">Amazon.Pricing.Model.Filter[]</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">
          <name>FormatVersion</name>
          <description>
            <para>The format version that you want the response to be in.
Valid values are: <code>aws_v1</code> </para>
          </description>
          <parameterValue required="true" variableLength="false">System.String</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">
          <name>MaxResult</name>
          <description>
            <para>The maximum number of results to return in the response. </para>
          </description>
          <parameterValue required="true" variableLength="false">System.Int32</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">
          <name>NextToken</name>
          <description>
            <para>The pagination token that indicates the next set of results that you want to retrieve.
<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, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </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>Filter</name>
        <description>
          <para>The list of filters that limit the returned products. only products that match all filters are returned. </para>
        </description>
        <parameterValue required="true" variableLength="false">Amazon.Pricing.Model.Filter[]</parameterValue>
        <type>
          <name>Amazon.Pricing.Model.Filter[]</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">
        <name>FormatVersion</name>
        <description>
          <para>The format version that you want the response to be in.
Valid values are: <code>aws_v1</code> </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>MaxResult</name>
        <description>
          <para>The maximum number of results to return in the response. </para>
        </description>
        <parameterValue required="true" variableLength="false">System.Int32</parameterValue>
        <type>
          <name>System.Int32</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">
        <name>NextToken</name>
        <description>
          <para>The pagination token that indicates the next set of results that you want to retrieve.
<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, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </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>ServiceCode</name>
        <description>
          <para>The code for the service whose products you want to retrieve. </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>System.String</name>
          <uri />
          <description />
        </type>
        <description>
          <para>This cmdlet returns a collection of System.String objects.
The service call response (type Amazon.Pricing.Model.GetProductsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: FormatVersion (type System.String), NextToken (type System.String)</para>
        </description>
      </returnValue>
    </returnValues>
    <relatedLinks>
      <navigationLink>
        <linkText>Online version:</linkText>
        <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-PLSProduct.html&amp;tocid=Get-PLSProduct</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>
      <navigationLink>
        <linkText>User Guide:</linkText>
        <uri>http://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/using-pelong.html</uri>
      </navigationLink>
    </relatedLinks>
    <examples>
      <example>
        <title>-------------------------- EXAMPLE 1 --------------------------</title><code>
PS C:\&gt; Get-PLSProduct -ServiceCode AmazonEC2 -Region us-east-1
 
{"product":{"productFamily":"Compute Instance","attributes":{"enhancedNetworkingSupported":"Yes","memory":"30.5 GiB","dedicatedEbsThroughput":"800 Mbps","vcpu":"4","locationType":"AWS Region","storage":"EBS only","instanceFamily":"Memory optimized","operatingSystem":"SUSE","physicalProcessor":"Intel Xeon E5-2686 v4 (Broadwell)","clockSpeed":"2.3 GHz","ecu":"Variable","networkPerformance":"Up to 10 Gigabit","servicename":"Amazon Elastic Compute Cloud","instanceType":"r4.xlarge","tenancy":"Shared","usagetype":"USW2-BoxUsage:r4.xlarge","normalizationSizeFactor":"8","processorFeatures":"Intel AVX, Intel AVX2, Intel Turbo","servicecode":"AmazonEC2","licenseModel":"No License required","currentGeneration":"Yes","preInstalledSw":"NA","location":"US West (Oregon)","processorArchitecture":"64-bit","operation":"RunInstances:000g"},...
        </code><remarks><para>Description</para><para>-----------</para><para>Returns details of all products for Amazon EC2.</para><para /><para /></remarks>
      </example>
      <example>
        <title>-------------------------- EXAMPLE 2 --------------------------</title><code>
PS C:\&gt; Get-PLSProduct -ServiceCode AmazonEC2 -Filter @{Type="TERM_MATCH";Field="volumeType";Value="General Purpose"},@{Type="TERM_MATCH";Field="storageMedia";Value="SSD-backed"} -Region us-east-1
 
{"product":{"productFamily":"Storage","attributes":{"storageMedia":"SSD-backed","maxThroughputvolume":"160 MB/sec","volumeType":"General Purpose","maxIopsvolume":"10000",...
        </code><remarks><para>Description</para><para>-----------</para><para>Returns data for Amazon EC2 in the us-east-1 region filtered by volume types of 'General Purpose' that are SSD-backed.</para><para /><para /></remarks>
      </example>
    </examples>
  </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-PLSService</name>
      <description>
        <para>Calls the AWS Price List Service DescribeServices API operation.</para>
      </description>
      <verb>Get</verb>
      <noun>PLSService</noun>
      <copyright>
        <para>&amp;copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para>
      </copyright>
    </details>
    <description>
      <para>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 operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </para>
    </description>
    <syntax>
      <syntaxItem>
        <name>Get-PLSService</name>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1">
          <name>ServiceCode</name>
          <description>
            <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>
          </description>
          <parameterValue required="true" variableLength="false">System.String</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">
          <name>FormatVersion</name>
          <description>
            <para>The format version that you want the response to be in.
Valid values are: <code>aws_v1</code> </para>
          </description>
          <parameterValue required="true" variableLength="false">System.String</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">
          <name>MaxResult</name>
          <description>
            <para>The maximum number of results that you want returned in the response. </para>
          </description>
          <parameterValue required="true" variableLength="false">System.Int32</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">
          <name>NextToken</name>
          <description>
            <para>The pagination token that indicates the next set of results that you want to retrieve.
<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, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </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>FormatVersion</name>
        <description>
          <para>The format version that you want the response to be in.
Valid values are: <code>aws_v1</code> </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>MaxResult</name>
        <description>
          <para>The maximum number of results that you want returned in the response. </para>
        </description>
        <parameterValue required="true" variableLength="false">System.Int32</parameterValue>
        <type>
          <name>System.Int32</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">
        <name>NextToken</name>
        <description>
          <para>The pagination token that indicates the next set of results that you want to retrieve.
<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, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </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>ServiceCode</name>
        <description>
          <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>
        </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.Pricing.Model.Service</name>
          <uri />
          <description />
        </type>
        <description>
          <para>This cmdlet returns a collection of Amazon.Pricing.Model.Service objects.
The service call response (type Amazon.Pricing.Model.DescribeServicesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: FormatVersion (type System.String), NextToken (type System.String)</para>
        </description>
      </returnValue>
    </returnValues>
    <relatedLinks>
      <navigationLink>
        <linkText>Online version:</linkText>
        <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-PLSService.html&amp;tocid=Get-PLSService</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>
      <navigationLink>
        <linkText>User Guide:</linkText>
        <uri>http://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/using-pelong.html</uri>
      </navigationLink>
    </relatedLinks>
    <examples>
      <example>
        <title>-------------------------- EXAMPLE 1 --------------------------</title><code>
PS C:\&gt; Get-PLSService -Region us-east-1
 
AttributeNames ServiceCode
-------------- -----------
{productFamily, servicecode, groupDescription, termType...} AWSBudgets
{productFamily, servicecode, termType, usagetype...} AWSCloudTrail
{productFamily, servicecode, termType, usagetype...} AWSCodeCommit
{productFamily, servicecode, termType, usagetype...} AWSCodeDeploy
{productFamily, servicecode, termType, usagetype...} AWSCodePipeline
{productFamily, servicecode, termType, usagetype...} AWSConfig
...
        </code><remarks><para>Description</para><para>-----------</para><para>Returns the metadata for all available service codes in the us-east-1 region.</para><para /><para /></remarks>
      </example>
      <example>
        <title>-------------------------- EXAMPLE 2 --------------------------</title><code>
PS C:\&gt; Get-PLSService -ServiceCode AmazonEC2 -Region us-east-1
 
AttributeNames ServiceCode
-------------- -----------
{volumeType, maxIopsvolume, instanceCapacity10xlarge, locationType...} AmazonEC2
        </code><remarks><para>Description</para><para>-----------</para><para>Returns the metadata for the Amazon EC2 service in the us-east-1 region.</para><para /><para /></remarks>
      </example>
    </examples>
  </command>
</helpItems>