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="P:Amazon.PowerShell.Cmdlets.MAS.GetMASAgreementCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AgreementId parameter. The -PassThru parameter is deprecated, use -Select '^AgreementId' instead. This parameter will be removed in a future version. </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><code>TermType</code> – The type of term, such as <code>LegalTerm</code>, <code>RenewalTerm</code>, or <code>ConfigurableUpfrontPricingTerm</code>. </para></li><li><para><code>TermID</code> – The ID of the particular term, which is common between offer and agreement. </para></li><li><para><code>TermPayload</code> – The key information contained in the term, such as the EULA for <code>LegalTerm</code> or pricing and dimensions for various pricing terms, such as <code>ConfigurableUpfrontPricingTerm</code> or <code>UsageBasedPricingTerm</code>. </para></li></ul><ul><li><para><code>Configuration</code> – The buyer/acceptor's selection at the time of agreement creation, such as the number of units purchased for a dimension or setting the <code>EnableAutoRenew</code> flag. </para></li></ul> </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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MAS.GetMASAgreementTermCmdlet.NextToken"> <summary> <para> <para>A token to specify where to start pagination</para> </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.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AgreementId parameter. The -PassThru parameter is deprecated, use -Select '^AgreementId' instead. This parameter will be removed in a future version. </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><code>PartyType</code> as <code>Proposer</code> + <code>AgreementType</code> + <code>ResourceIdentifier</code></para></li><li><para><code>PartyType</code> as <code>Proposer</code> + <code>AgreementType</code> + <code>OfferId</code></para></li><li><para><code>PartyType</code> as <code>Proposer</code> + <code>AgreementType</code> + <code>AcceptorAccountId</code></para></li><li><para><code>PartyType</code> as <code>Proposer</code> + <code>AgreementType</code> + <code>Status</code></para></li><li><para><code>PartyType</code> as <code>Proposer</code> + <code>AgreementType</code> + <code>ResourceIdentifier</code> + <code>Status</code></para></li><li><para><code>PartyType</code> as <code>Proposer</code> + <code>AgreementType</code> + <code>OfferId</code> + <code>Status</code></para></li><li><para><code>PartyType</code> as <code>Proposer</code> + <code>AgreementType</code> + <code>AcceptorAccountId</code> + <code>Status</code></para></li><li><para><code>PartyType</code> as <code>Proposer</code> + <code>AgreementType</code> + <code>ResourceType</code> + <code>Status</code></para></li><li><para><code>PartyType</code> as <code>Proposer</code> + <code>AgreementType</code> + <code>AcceptorAccountId</code> + <code>ResourceType</code> + <code>Status</code></para></li><li><para><code>PartyType</code> as <code>Proposer</code> + <code>AgreementType</code> + <code>AcceptorAccountId</code> + <code>OfferId</code></para></li><li><para><code>PartyType</code> as <code>Proposer</code> + <code>AgreementType</code> + <code>AcceptorAccountId</code> + <code>OfferId</code> + <code>Status</code></para></li><li><para><code>PartyType</code> as <code>Proposer</code> + <code>AgreementType</code> + <code>AcceptorAccountId</code> + <code>ResourceIdentifier</code></para></li><li><para><code>PartyType</code> as <code>Proposer</code> + <code>AgreementType</code> + <code>AcceptorAccountId</code> + <code>ResourceIdentifier</code> + <code>Status</code></para></li><li><para><code>PartyType</code> as <code>Proposer</code> + <code>AgreementType</code> + <code>AcceptorAccountId</code> + <code>ResourceType</code></para></li></ul> </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><code>ResourceIdentifier</code> – The unique identifier of the resource.</para></li><li><para><code>ResourceType</code> – Type of the resource, which is the product (<code>AmiProduct</code>, <code>ContainerProduct</code>, or <code>SaaSProduct</code>).</para></li><li><para><code>PartyType</code> – The party type (either <code>Acceptor</code> or <code>Proposer</code>) of the caller. For agreements where the caller is the proposer, use the <code>Proposer</code> filter. For agreements where the caller is the acceptor, use the <code>Acceptor</code> filter.</para></li><li><para><code>AcceptorAccountId</code> – The AWS account ID of the party accepting the agreement terms.</para></li><li><para><code>OfferId</code> – The unique identifier of the offer in which the terms are registered in the agreement token.</para></li><li><para><code>Status</code> – The current status of the agreement. Values include <code>ACTIVE</code>, <code>ARCHIVED</code>, <code>CANCELLED</code>, <code>EXPIRED</code>, <code>RENEWED</code>, <code>REPLACED</code>, and <code>TERMINATED</code>.</para></li><li><para><code>BeforeEndTime</code> – A date used to filter agreements with a date before the <code>endTime</code> of an agreement.</para></li><li><para><code>AfterEndTime</code> – A date used to filter agreements with a date after the <code>endTime</code> of an agreement.</para></li><li><para><code>AgreementType</code> – The type of agreement. Values include <code>PurchaseAgreement</code> or <code>VendorInsightsAgreement</code>.</para></li></ul> </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 <code>StartTime</code> and <code>EndTime</code>. The default value is <code>EndTime</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MAS.SearchMASAgreementCmdlet.Sort_SortOrder"> <summary> <para> <para>The sorting order, which can be <code>ASCENDING</code> or <code>DESCENDING</code>. The default value is <code>DESCENDING</code>.</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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MAS.SearchMASAgreementCmdlet.NextToken"> <summary> <para> <para>A token to specify where to start pagination.</para> </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.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Catalog parameter. The -PassThru parameter is deprecated, use -Select '^Catalog' instead. This parameter will be removed in a future version. </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> </members> </doc> |