AWS.Tools.MarketplaceAgreement.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.MarketplaceAgreement</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.MAS.GetMASAgreementCmdlet"> <summary> Provides details about an agreement, such as the proposer, acceptor, start date, and end date. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MAS.GetMASAgreementCmdlet.AgreementId"> <summary> <para> <para>The unique identifier of the agreement.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MAS.GetMASAgreementCmdlet.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.MarketplaceAgreement.Model.DescribeAgreementResponse). Specifying the name of a property of type Amazon.MarketplaceAgreement.Model.DescribeAgreementResponse 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.MAS.GetMASAgreementTermCmdlet"> <summary> Obtains details about the terms in an agreement that you participated in as proposer or acceptor. <para> The details include: </para><ul><li><para><c>TermType</c> – The type of term, such as <c>LegalTerm</c>, <c>RenewalTerm</c>, or <c>ConfigurableUpfrontPricingTerm</c>. </para></li><li><para><c>TermID</c> – The ID of the particular term, which is common between offer and agreement. </para></li><li><para><c>TermPayload</c> – The key information contained in the term, such as the EULA for <c>LegalTerm</c> or pricing and dimensions for various pricing terms, such as <c>ConfigurableUpfrontPricingTerm</c> or <c>UsageBasedPricingTerm</c>. </para></li></ul><ul><li><para><c>Configuration</c> – The buyer/acceptor's selection at the time of agreement creation, such as the number of units purchased for a dimension or setting the <c>EnableAutoRenew</c> flag. </para></li></ul><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. This cmdlet didn't autopaginate in V4, auto-pagination support was added in V5. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MAS.GetMASAgreementTermCmdlet.AgreementId"> <summary> <para> <para>The unique identifier of the agreement.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MAS.GetMASAgreementTermCmdlet.MaxResult"> <summary> <para> <para>The maximum number of agreements 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.MAS.GetMASAgreementTermCmdlet.NextToken"> <summary> <para> <para>A token to specify where to start pagination</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/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MAS.GetMASAgreementTermCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AcceptedTerms'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.MarketplaceAgreement.Model.GetAgreementTermsResponse). Specifying the name of a property of type Amazon.MarketplaceAgreement.Model.GetAgreementTermsResponse 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.MAS.GetMASAgreementTermCmdlet.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. This cmdlet didn't autopaginate in V4. To preserve the V4 autopagination behavior for all cmdlets, run Set-AWSAutoIterationMode -IterationMode v4. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.MAS.SearchMASAgreementCmdlet"> <summary> Searches across all agreements that a proposer or an acceptor has in AWS Marketplace. The search returns a list of agreements with basic agreement information. <para> The following filter combinations are supported: </para><ul><li><para><c>PartyType</c> as <c>Proposer</c> + <c>AgreementType</c> + <c>ResourceIdentifier</c></para></li><li><para><c>PartyType</c> as <c>Proposer</c> + <c>AgreementType</c> + <c>OfferId</c></para></li><li><para><c>PartyType</c> as <c>Proposer</c> + <c>AgreementType</c> + <c>AcceptorAccountId</c></para></li><li><para><c>PartyType</c> as <c>Proposer</c> + <c>AgreementType</c> + <c>Status</c></para></li><li><para><c>PartyType</c> as <c>Proposer</c> + <c>AgreementType</c> + <c>ResourceIdentifier</c> + <c>Status</c></para></li><li><para><c>PartyType</c> as <c>Proposer</c> + <c>AgreementType</c> + <c>OfferId</c> + <c>Status</c></para></li><li><para><c>PartyType</c> as <c>Proposer</c> + <c>AgreementType</c> + <c>AcceptorAccountId</c> + <c>Status</c></para></li><li><para><c>PartyType</c> as <c>Proposer</c> + <c>AgreementType</c> + <c>ResourceType</c> + <c>Status</c></para></li><li><para><c>PartyType</c> as <c>Proposer</c> + <c>AgreementType</c> + <c>AcceptorAccountId</c> + <c>ResourceType</c> + <c>Status</c></para></li><li><para><c>PartyType</c> as <c>Proposer</c> + <c>AgreementType</c> + <c>AcceptorAccountId</c> + <c>OfferId</c></para></li><li><para><c>PartyType</c> as <c>Proposer</c> + <c>AgreementType</c> + <c>AcceptorAccountId</c> + <c>OfferId</c> + <c>Status</c></para></li><li><para><c>PartyType</c> as <c>Proposer</c> + <c>AgreementType</c> + <c>AcceptorAccountId</c> + <c>ResourceIdentifier</c></para></li><li><para><c>PartyType</c> as <c>Proposer</c> + <c>AgreementType</c> + <c>AcceptorAccountId</c> + <c>ResourceIdentifier</c> + <c>Status</c></para></li><li><para><c>PartyType</c> as <c>Proposer</c> + <c>AgreementType</c> + <c>AcceptorAccountId</c> + <c>ResourceType</c></para></li></ul><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. This cmdlet didn't autopaginate in V4, auto-pagination support was added in V5. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MAS.SearchMASAgreementCmdlet.Catalog"> <summary> <para> <para>The catalog in which the agreement was created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MAS.SearchMASAgreementCmdlet.Filter"> <summary> <para> <para>The filter name and value pair used to return a specific list of results.</para><para>The following filters are supported:</para><ul><li><para><c>ResourceIdentifier</c> – The unique identifier of the resource.</para></li><li><para><c>ResourceType</c> – Type of the resource, which is the product (<c>AmiProduct</c>, <c>ContainerProduct</c>, or <c>SaaSProduct</c>).</para></li><li><para><c>PartyType</c> – The party type (either <c>Acceptor</c> or <c>Proposer</c>) of the caller. For agreements where the caller is the proposer, use the <c>Proposer</c> filter. For agreements where the caller is the acceptor, use the <c>Acceptor</c> filter.</para></li><li><para><c>AcceptorAccountId</c> – The AWS account ID of the party accepting the agreement terms.</para></li><li><para><c>OfferId</c> – The unique identifier of the offer in which the terms are registered in the agreement token.</para></li><li><para><c>Status</c> – The current status of the agreement. Values include <c>ACTIVE</c>, <c>ARCHIVED</c>, <c>CANCELLED</c>, <c>EXPIRED</c>, <c>RENEWED</c>, <c>REPLACED</c>, and <c>TERMINATED</c>.</para></li><li><para><c>BeforeEndTime</c> – A date used to filter agreements with a date before the <c>endTime</c> of an agreement.</para></li><li><para><c>AfterEndTime</c> – A date used to filter agreements with a date after the <c>endTime</c> of an agreement.</para></li><li><para><c>AgreementType</c> – The type of agreement. Values include <c>PurchaseAgreement</c> or <c>VendorInsightsAgreement</c>.</para></li></ul><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MAS.SearchMASAgreementCmdlet.Sort_SortBy"> <summary> <para> <para>The attribute on which the data is grouped, which can be by <c>StartTime</c> and <c>EndTime</c>. The default value is <c>EndTime</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MAS.SearchMASAgreementCmdlet.Sort_SortOrder"> <summary> <para> <para>The sorting order, which can be <c>ASCENDING</c> or <c>DESCENDING</c>. The default value is <c>DESCENDING</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MAS.SearchMASAgreementCmdlet.MaxResult"> <summary> <para> <para>The maximum number of agreements 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.MAS.SearchMASAgreementCmdlet.NextToken"> <summary> <para> <para>A token to specify where to start pagination.</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/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MAS.SearchMASAgreementCmdlet.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.MarketplaceAgreement.Model.SearchAgreementsResponse). Specifying the name of a property of type Amazon.MarketplaceAgreement.Model.SearchAgreementsResponse 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.MAS.SearchMASAgreementCmdlet.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="P:Amazon.PowerShell.Cmdlets.MAS.SearchMASAgreementCmdlet.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. This cmdlet didn't autopaginate in V4. To preserve the V4 autopagination behavior for all cmdlets, run Set-AWSAutoIterationMode -IterationMode v4. </summary> </member> </members> </doc> |