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.GetMASAgreementPaymentRequestCmdlet"> <summary> Retrieves detailed information about a specific payment request. Both sellers (proposers) and buyers (acceptors) can use this operation to view payment requests associated with their agreements. The response includes the current status, charge details, timestamps, and the charge ID if the request has been approved. <note><para> The calling identity must be either the acceptor or proposer of the payment request. A <c>ResourceNotFoundException</c> is returned if the payment request does not exist. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MAS.GetMASAgreementPaymentRequestCmdlet.AgreementId"> <summary> <para> <para>The unique identifier of the agreement associated with the payment request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MAS.GetMASAgreementPaymentRequestCmdlet.PaymentRequestId"> <summary> <para> <para>The identifier of the payment request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MAS.GetMASAgreementPaymentRequestCmdlet.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.GetAgreementPaymentRequestResponse). Specifying the name of a property of type Amazon.MarketplaceAgreement.Model.GetAgreementPaymentRequestResponse 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.GetMASAgreementPaymentRequestListCmdlet"> <summary> Lists payment requests available to you as a seller or buyer. Both sellers (proposers) and buyers (acceptors) can use this operation to find payment requests by specifying their party type and applying optional parameters. <note><para><c>PartyType</c> is a required parameter. A <c>ValidationException</c> is returned if <c>PartyType</c> is not provided. Pagination is supported through <c>maxResults</c> (1-50, default 50) and <c>nextToken</c> parameters. </para></note><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.MAS.GetMASAgreementPaymentRequestListCmdlet.AgreementId"> <summary> <para> <para>An optional parameter to list payment requests for a specific agreement.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MAS.GetMASAgreementPaymentRequestListCmdlet.AgreementType"> <summary> <para> <para>An optional parameter to list payment requests by agreement type (e.g., <c>PurchaseAgreement</c>).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MAS.GetMASAgreementPaymentRequestListCmdlet.Catalog"> <summary> <para> <para>An optional parameter to list payment requests by catalog (e.g., <c>AWSMarketplace</c>).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MAS.GetMASAgreementPaymentRequestListCmdlet.PartyType"> <summary> <para> <para>The party type for the payment requests. Required parameter. Use <c>Proposer</c> to list payment requests where you are the seller, or <c>Acceptor</c> to list payment requests where you are the buyer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MAS.GetMASAgreementPaymentRequestListCmdlet.Status"> <summary> <para> <para>An optional parameter to list payment requests by status. Valid values include <c>VALIDATING</c>, <c>VALIDATION_FAILED</c>, <c>PENDING_APPROVAL</c>, <c>APPROVED</c>, <c>REJECTED</c>, and <c>CANCELLED</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MAS.GetMASAgreementPaymentRequestListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of payment requests to return in a single response (1-50). Default is 50.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MAS.GetMASAgreementPaymentRequestListCmdlet.NextToken"> <summary> <para> <para>A token to specify where to start pagination. Use the <c>nextToken</c> value from a previous response to retrieve the next page of results.</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.GetMASAgreementPaymentRequestListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Items'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.MarketplaceAgreement.Model.ListAgreementPaymentRequestsResponse). Specifying the name of a property of type Amazon.MarketplaceAgreement.Model.ListAgreementPaymentRequestsResponse 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.GetMASAgreementPaymentRequestListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PartyType parameter. The -PassThru parameter is deprecated, use -Select '^PartyType' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MAS.GetMASAgreementPaymentRequestListCmdlet.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.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> </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 has in AWS Marketplace. The search returns a list of agreements with basic agreement information. <para> The following filter combinations are supported when the <c>PartyType</c> is <c>Proposer</c>: </para><ul><li><para><c>AgreementType</c></para></li><li><para><c>AgreementType</c> + <c>EndTime</c></para></li><li><para><c>AgreementType</c> + <c>ResourceType</c></para></li><li><para><c>AgreementType</c> + <c>ResourceType</c> + <c>EndTime</c></para></li><li><para><c>AgreementType</c> + <c>ResourceType</c> + <c>Status</c></para></li><li><para><c>AgreementType</c> + <c>ResourceType</c> + <c>Status</c> + <c>EndTime</c></para></li><li><para><c>AgreementType</c> + <c>ResourceId</c></para></li><li><para><c>AgreementType</c> + <c>ResourceId</c> + <c>EndTime</c></para></li><li><para><c>AgreementType</c> + <c>ResourceId</c> + <c>Status</c></para></li><li><para><c>AgreementType</c> + <c>ResourceId</c> + <c>Status</c> + <c>EndTime</c></para></li><li><para><c>AgreementType</c> + <c>AcceptorAccountId</c></para></li><li><para><c>AgreementType</c> + <c>AcceptorAccountId</c> + <c>EndTime</c></para></li><li><para><c>AgreementType</c> + <c>AcceptorAccountId</c> + <c>Status</c></para></li><li><para><c>AgreementType</c> + <c>AcceptorAccountId</c> + <c>Status</c> + <c>EndTime</c></para></li><li><para><c>AgreementType</c> + <c>AcceptorAccountId</c> + <c>OfferId</c></para></li><li><para><c>AgreementType</c> + <c>AcceptorAccountId</c> + <c>OfferId</c> + <c>Status</c></para></li><li><para><c>AgreementType</c> + <c>AcceptorAccountId</c> + <c>OfferId</c> + <c>EndTime</c></para></li><li><para><c>AgreementType</c> + <c>AcceptorAccountId</c> + <c>OfferId</c> + <c>Status</c> + <c>EndTime</c></para></li><li><para><c>AgreementType</c> + <c>AcceptorAccountId</c> + <c>ResourceId</c></para></li><li><para><c>AgreementType</c> + <c>AcceptorAccountId</c> + <c>ResourceId</c> + <c>Status</c></para></li><li><para><c>AgreementType</c> + <c>AcceptorAccountId</c> + <c>ResourceId</c> + <c>EndTime</c></para></li><li><para><c>AgreementType</c> + <c>AcceptorAccountId</c> + <c>ResourceId</c> + <c>Status</c> + <c>EndTime</c></para></li><li><para><c>AgreementType</c> + <c>AcceptorAccountId</c> + <c>ResourceType</c></para></li><li><para><c>AgreementType</c> + <c>AcceptorAccountId</c> + <c>ResourceType</c> + <c>EndTime</c></para></li><li><para><c>AgreementType</c> + <c>AcceptorAccountId</c> + <c>ResourceType</c> + <c>Status</c></para></li><li><para><c>AgreementType</c> + <c>AcceptorAccountId</c> + <c>ResourceType</c> + <c>Status</c> + <c>EndTime</c></para></li><li><para><c>AgreementType</c> + <c>Status</c></para></li><li><para><c>AgreementType</c> + <c>Status</c> + <c>EndTime</c></para></li><li><para><c>AgreementType</c> + <c>OfferId</c></para></li><li><para><c>AgreementType</c> + <c>OfferId</c> + <c>EndTime</c></para></li><li><para><c>AgreementType</c> + <c>OfferId</c> + <c>Status</c></para></li><li><para><c>AgreementType</c> + <c>OfferId</c> + <c>Status</c> + <c>EndTime</c></para></li><li><para><c>AgreementType</c> + <c>OfferSetId</c></para></li><li><para><c>AgreementType</c> + <c>OfferSetId</c> + <c>EndTime</c></para></li><li><para><c>AgreementType</c> + <c>OfferSetId</c> + <c>Status</c></para></li><li><para><c>AgreementType</c> + <c>OfferSetId</c> + <c>Status</c> + <c>EndTime</c></para></li></ul><note><para> To filter by <c>EndTime</c>, you can use either <c>BeforeEndTime</c> or <c>AfterEndTime</c>. Only <c>EndTime</c> is supported for sorting. </para></note> </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>, <c>SaaSProduct</c>, <c>ProfessionalServicesProduct</c>, or <c>MachineLearningProduct</c>).</para></li><li><para><c>PartyType</c> – The party type of the caller. For agreements where the caller is the proposer, use the <c>Proposer</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. Supported value includes <c>PurchaseAgreement</c>.</para></li><li><para><c>OfferSetId</c> – A unique identifier for the offer set containing this offer. All agreements created from offers in this set include this identifier as context.</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 <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> </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> <member name="T:Amazon.PowerShell.Cmdlets.MAS.SendMASAgreementPaymentRequestCmdlet"> <summary> Allows sellers (proposers) to submit a payment request to buyers (acceptors) for a specific charge amount for an agreement that includes a <c>VariablePaymentTerm</c>. The payment request is created in <c>PENDING_APPROVAL</c> status, at which point the buyer can accept or reject it. <note><para> The agreement must be active and have a <c>VariablePaymentTerm</c> to support payment requests. The <c>chargeAmount</c> must not exceed the remaining available balance under the <c>VariablePaymentTerm</c><c>maxTotalChargeAmount</c>. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MAS.SendMASAgreementPaymentRequestCmdlet.AgreementId"> <summary> <para> <para>The unique identifier of the agreement for which the payment request is being submitted. Use <c>GetAgreementTerms</c> to retrieve agreement term details.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MAS.SendMASAgreementPaymentRequestCmdlet.ChargeAmount"> <summary> <para> <para>The amount requested to be charged to the buyer, positive decimal value in the currency of the accepted term.</para><note><para>A <c>ValidationException</c> is returned if the <c>chargeAmount</c> exceeds the available balance, if the agreement doesn't have an active <c>VariablePaymentTerm</c>, or if the <c>termId</c> is invalid.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MAS.SendMASAgreementPaymentRequestCmdlet.Description"> <summary> <para> <para>An optional detailed description of the payment request (1-2000 characters).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MAS.SendMASAgreementPaymentRequestCmdlet.Name"> <summary> <para> <para>A descriptive name for the payment request (5-64 characters).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MAS.SendMASAgreementPaymentRequestCmdlet.TermId"> <summary> <para> <para>The unique identifier of the <c>VariablePaymentTerm</c> for the agreement that the payment request is being sent for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MAS.SendMASAgreementPaymentRequestCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MAS.SendMASAgreementPaymentRequestCmdlet.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.SendAgreementPaymentRequestResponse). Specifying the name of a property of type Amazon.MarketplaceAgreement.Model.SendAgreementPaymentRequestResponse 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.SendMASAgreementPaymentRequestCmdlet.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="T:Amazon.PowerShell.Cmdlets.MAS.StopMASAgreementPaymentRequestCmdlet"> <summary> Allows sellers (proposers) to cancel a payment request that is in <c>PENDING_APPROVAL</c> status. Once cancelled, the payment request transitions to <c>CANCELLED</c> status and can no longer be accepted or rejected by the buyer. <note><para> Only payment requests in <c>PENDING_APPROVAL</c> status can be cancelled. A <c>ConflictException</c> is thrown if the payment request is in any other status. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MAS.StopMASAgreementPaymentRequestCmdlet.AgreementId"> <summary> <para> <para>The unique identifier of the agreement associated with the payment request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MAS.StopMASAgreementPaymentRequestCmdlet.PaymentRequestId"> <summary> <para> <para>The unique identifier of the payment request to cancel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MAS.StopMASAgreementPaymentRequestCmdlet.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.CancelAgreementPaymentRequestResponse). Specifying the name of a property of type Amazon.MarketplaceAgreement.Model.CancelAgreementPaymentRequestResponse 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.StopMASAgreementPaymentRequestCmdlet.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> |