AWS.Tools.MarketplaceEntitlementService

3.3.618.1

AWS.Tools.MarketplaceEntitlementService.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-MESEntitlementList</name>

      <description>

        <para>Calls the AWS Marketplace Entitlement Service GetEntitlements API operation.</para>

      </description>

      <verb>Get</verb>

      <noun>MESEntitlementList</noun>

      <copyright>

        <para>&amp;copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para>

      </copyright>

    </details>

    <description>

      <para>GetEntitlements retrieves entitlement values for a given product. The results can be filtered based on customer identifier or product dimensions.<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. </para>

    </description>

    <syntax>

      <syntaxItem>

        <name>Get-MESEntitlementList</name>

        <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1">

          <name>ProductCode</name>

          <description>

            <para>Product code is used to uniquely identify a product in AWS Marketplace. The product code will be provided by AWS Marketplace when the product listing is created. </para>

          </description>

          <parameterValue required="true" variableLength="false">System.String</parameterValue>

        </parameter>

        <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">

          <name>Filter</name>

          <description>

            <para>Filter is used to return entitlements for a specific customer or for a specific dimension. Filters are described as keys mapped to a lists of values. Filtered requests are <i>unioned</i> for each value in the value list, and then <i>intersected</i> for each filter key. </para>

          </description>

          <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue>

        </parameter>

        <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">

          <name>MaxResult</name>

          <description>

            <para>The maximum number of items to retrieve from the GetEntitlements operation. For pagination, use the NextToken field in subsequent calls to GetEntitlements. 

<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>

          </description>

          <parameterValue required="true" variableLength="false">System.Int32</parameterValue>

        </parameter>

        <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">

          <name>NextToken</name>

          <description>

            <para>For paginated calls to GetEntitlements, pass the NextToken from the previous GetEntitlementsResult. 

<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>

          </description>

          <parameterValue required="true" variableLength="false">System.String</parameterValue>

        </parameter>

        <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">

          <name>Select</name>

          <description>

            <para>Use the -Select parameter to control the cmdlet output. The default value is 'Entitlements'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.MarketplaceEntitlementService.Model.GetEntitlementsResponse). Specifying the name of a property of type Amazon.MarketplaceEntitlementService.Model.GetEntitlementsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para>

          </description>

          <parameterValue required="true" variableLength="false">System.String</parameterValue>

        </parameter>

        <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">

          <name>PassThru</name>

          <description>

            <para>Changes the cmdlet behavior to return the value passed to the ProductCode parameter. The -PassThru parameter is deprecated, use -Select '^ProductCode' instead. This parameter will be removed in a future version. </para>

          </description>

          <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue>

        </parameter>

        <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">

          <name>NoAutoIteration</name>

          <description>

            <para>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. </para>

          </description>

          <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue>

        </parameter>

      </syntaxItem>

    </syntax>

    <parameters>

      <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">

        <name>Filter</name>

        <description>

          <para>Filter is used to return entitlements for a specific customer or for a specific dimension. Filters are described as keys mapped to a lists of values. Filtered requests are <i>unioned</i> for each value in the value list, and then <i>intersected</i> for each filter key. </para>

        </description>

        <parameterValue required="true" variableLength="false">System.Collections.Hashtable</parameterValue>

        <type>

          <name>System.Collections.Hashtable</name>

          <uri />

        </type>

        <defaultValue>None</defaultValue>

      </parameter>

      <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named">

        <name>MaxResult</name>

        <description>

          <para>The maximum number of items to retrieve from the GetEntitlements operation. For pagination, use the NextToken field in subsequent calls to GetEntitlements. 

<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>

        </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="True (ByPropertyName)" position="Named">

        <name>NextToken</name>

        <description>

          <para>For paginated calls to GetEntitlements, pass the NextToken from the previous GetEntitlementsResult. 

<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>

        </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 (ByPropertyName)" position="Named">

        <name>NoAutoIteration</name>

        <description>

          <para>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. </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 (ByPropertyName)" position="Named">

        <name>PassThru</name>

        <description>

          <para>Changes the cmdlet behavior to return the value passed to the ProductCode parameter. The -PassThru parameter is deprecated, use -Select '^ProductCode' instead. This parameter will be removed in a future version. </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="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1">

        <name>ProductCode</name>

        <description>

          <para>Product code is used to uniquely identify a product in AWS Marketplace. The product code will be provided by AWS Marketplace when the product listing is created. </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 (ByPropertyName)" position="Named">

        <name>Select</name>

        <description>

          <para>Use the -Select parameter to control the cmdlet output. The default value is 'Entitlements'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.MarketplaceEntitlementService.Model.GetEntitlementsResponse). Specifying the name of a property of type Amazon.MarketplaceEntitlementService.Model.GetEntitlementsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </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.MarketplaceEntitlementService.Model.Entitlement or Amazon.MarketplaceEntitlementService.Model.GetEntitlementsResponse</name>

          <uri />

          <description />

        </type>

        <description>

          <para>This cmdlet returns a collection of Amazon.MarketplaceEntitlementService.Model.Entitlement objects.

The service call response (type Amazon.MarketplaceEntitlementService.Model.GetEntitlementsResponse) 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-MESEntitlementList.html&amp;tocid=Get-MESEntitlementList</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>