AWS.Tools.MarketplaceDiscovery.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.MarketplaceDiscovery</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.MKTD.GetMKTDFulfillmentOptionListCmdlet"> <summary> Returns the fulfillment options available for a product, including deployment details such as version information, operating systems, usage instructions, and release notes.<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.MKTD.GetMKTDFulfillmentOptionListCmdlet.ProductId"> <summary> <para> <para>The unique identifier of the product for which to list fulfillment options.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MKTD.GetMKTDFulfillmentOptionListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results that are returned per call. You can use <c>nextToken</c> to get more results.</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.MKTD.GetMKTDFulfillmentOptionListCmdlet.NextToken"> <summary> <para> <para>If <c>nextToken</c> is returned, there are more results available. Make the call again using the returned token to retrieve the next page.</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.MKTD.GetMKTDFulfillmentOptionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'FulfillmentOptions'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.MarketplaceDiscovery.Model.ListFulfillmentOptionsResponse). Specifying the name of a property of type Amazon.MarketplaceDiscovery.Model.ListFulfillmentOptionsResponse 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.MKTD.GetMKTDFulfillmentOptionListCmdlet.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.MKTD.GetMKTDListingCmdlet"> <summary> Provides details about a listing, such as descriptions, badges, categories, pricing model summaries, reviews, and associated products and offers. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MKTD.GetMKTDListingCmdlet.ListingId"> <summary> <para> <para>The unique identifier of the listing to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MKTD.GetMKTDListingCmdlet.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.MarketplaceDiscovery.Model.GetListingResponse). Specifying the name of a property of type Amazon.MarketplaceDiscovery.Model.GetListingResponse 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.MKTD.GetMKTDOfferCmdlet"> <summary> Provides details about an offer, such as the pricing model, seller of record, availability dates, badges, and associated products. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MKTD.GetMKTDOfferCmdlet.OfferId"> <summary> <para> <para>The unique identifier of the offer to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MKTD.GetMKTDOfferCmdlet.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.MarketplaceDiscovery.Model.GetOfferResponse). Specifying the name of a property of type Amazon.MarketplaceDiscovery.Model.GetOfferResponse 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.MKTD.GetMKTDOfferSetCmdlet"> <summary> Provides details about an offer set, which is a bundle of offers across multiple products. Includes the seller, availability dates, buyer notes, and associated product-offer pairs. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MKTD.GetMKTDOfferSetCmdlet.OfferSetId"> <summary> <para> <para>The unique identifier of the offer set to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MKTD.GetMKTDOfferSetCmdlet.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.MarketplaceDiscovery.Model.GetOfferSetResponse). Specifying the name of a property of type Amazon.MarketplaceDiscovery.Model.GetOfferSetResponse 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.MKTD.GetMKTDOfferTermCmdlet"> <summary> Returns the terms attached to an offer, such as pricing terms (usage-based, contract, BYOL, free trial), legal terms, payment schedules, validity terms, support terms, and renewal terms.<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.MKTD.GetMKTDOfferTermCmdlet.OfferId"> <summary> <para> <para>The unique identifier of the offer whose terms to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MKTD.GetMKTDOfferTermCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results that are returned per call. You can use <c>nextToken</c> to get more results.</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.MKTD.GetMKTDOfferTermCmdlet.NextToken"> <summary> <para> <para>If <c>nextToken</c> is returned, there are more results available. Make the call again using the returned token to retrieve the next page.</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.MKTD.GetMKTDOfferTermCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'OfferTerms'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.MarketplaceDiscovery.Model.GetOfferTermsResponse). Specifying the name of a property of type Amazon.MarketplaceDiscovery.Model.GetOfferTermsResponse 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.MKTD.GetMKTDOfferTermCmdlet.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.MKTD.GetMKTDProductCmdlet"> <summary> Provides details about a product, such as descriptions, highlights, categories, fulfillment option summaries, promotional media, and seller engagement options. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MKTD.GetMKTDProductCmdlet.ProductId"> <summary> <para> <para>The unique identifier of the product to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MKTD.GetMKTDProductCmdlet.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.MarketplaceDiscovery.Model.GetProductResponse). Specifying the name of a property of type Amazon.MarketplaceDiscovery.Model.GetProductResponse 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.MKTD.GetMKTDPurchaseOptionListCmdlet"> <summary> Returns the purchase options (offers and offer sets) available to the buyer. You can filter results by product, seller, purchase option type, visibility scope, and availability status. <note><para> You must include at least one of the following filters in the request: a <c>PRODUCT_ID</c> filter to specify the product for which to retrieve purchase options, or a <c>VISIBILITY_SCOPE</c> filter to retrieve purchase options by visibility. </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.MKTD.GetMKTDPurchaseOptionListCmdlet.Filter"> <summary> <para> <para>Filters to narrow the results. Multiple filters are combined with AND logic. Multiple values within the same filter are combined with OR logic.</para><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.MKTD.GetMKTDPurchaseOptionListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results that are returned per call. You can use <c>nextToken</c> to get more results.</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.MKTD.GetMKTDPurchaseOptionListCmdlet.NextToken"> <summary> <para> <para>If <c>nextToken</c> is returned, there are more results available. Make the call again using the returned token to retrieve the next page.</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.MKTD.GetMKTDPurchaseOptionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'PurchaseOptions'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.MarketplaceDiscovery.Model.ListPurchaseOptionsResponse). Specifying the name of a property of type Amazon.MarketplaceDiscovery.Model.ListPurchaseOptionsResponse 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.MKTD.GetMKTDPurchaseOptionListCmdlet.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.MKTD.SearchMKTDFacetCmdlet"> <summary> Returns available facet values for filtering listings, such as categories, pricing models, fulfillment option types, publishers, and customer ratings. Each facet value includes a count of matching listings.<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.MKTD.SearchMKTDFacetCmdlet.FacetType"> <summary> <para> <para>A list of specific facet types to retrieve. If empty or null, all available facets are returned.</para><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.MKTD.SearchMKTDFacetCmdlet.Filter"> <summary> <para> <para>Filters to apply before retrieving facets. Multiple filters are combined with AND logic. Multiple values within the same filter are combined with OR logic.</para><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.MKTD.SearchMKTDFacetCmdlet.SearchText"> <summary> <para> <para>The search query text to filter listings before retrieving facets.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MKTD.SearchMKTDFacetCmdlet.NextToken"> <summary> <para> <para>If <c>nextToken</c> is returned, there are more results available. Make the call again using the returned token to retrieve the next page.</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.MKTD.SearchMKTDFacetCmdlet.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.MarketplaceDiscovery.Model.SearchFacetsResponse). Specifying the name of a property of type Amazon.MarketplaceDiscovery.Model.SearchFacetsResponse 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.MKTD.SearchMKTDFacetCmdlet.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.MKTD.SearchMKTDFacetCmdlet.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.MKTD.SearchMKTDListingCmdlet"> <summary> Returns a list of product listings based on search criteria and filters. You can search by keyword, filter by category, pricing model, fulfillment type, and other attributes, and sort results by relevance or customer rating.<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.MKTD.SearchMKTDListingCmdlet.Filter"> <summary> <para> <para>Filters to narrow search results. Multiple filters are combined with AND logic. Multiple values within the same filter are combined with OR logic.</para><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.MKTD.SearchMKTDListingCmdlet.SearchText"> <summary> <para> <para>The search query text to find relevant listings.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MKTD.SearchMKTDListingCmdlet.SortBy"> <summary> <para> <para>The field to sort results by. Valid values are <c>RELEVANCE</c> and <c>AVERAGE_CUSTOMER_RATING</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MKTD.SearchMKTDListingCmdlet.SortOrder"> <summary> <para> <para>The sort direction. Valid values are <c>DESCENDING</c> and <c>ASCENDING</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MKTD.SearchMKTDListingCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results that are returned per call. You can use <c>nextToken</c> to get more results.</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.MKTD.SearchMKTDListingCmdlet.NextToken"> <summary> <para> <para>If <c>nextToken</c> is returned, there are more results available. Make the call again using the returned token to retrieve the next page.</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.MKTD.SearchMKTDListingCmdlet.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.MarketplaceDiscovery.Model.SearchListingsResponse). Specifying the name of a property of type Amazon.MarketplaceDiscovery.Model.SearchListingsResponse 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.MKTD.SearchMKTDListingCmdlet.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.MKTD.SearchMKTDListingCmdlet.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> </members> </doc> |