AWS.MarketplaceAgreement — AWS SDK for JavaScript (original) (raw)

We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Inherits:

AWS.Service

Identifier:

marketplaceagreement

API Version:

2020-03-01

Defined in:

(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

AWS Marketplace is a curated digital catalog that customers can use to find, buy, deploy, and manage third-party software, data, and services to build solutions and run their businesses. The AWS Marketplace Agreement Service provides an API interface that helps AWS Marketplace sellers manage their product-related agreements, including listing, searching, and filtering agreements.

To manage agreements in AWS Marketplace, you must ensure that your AWS Identity and Access Management (IAM) policies and roles are set up. The user must have the required policies/permissions that allow them to carry out the actions in AWS:

Sending a Request Using MarketplaceAgreement

var marketplaceagreement = new AWS.MarketplaceAgreement();
marketplaceagreement.describeAgreement(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the MarketplaceAgreement object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var marketplaceagreement = new AWS.MarketplaceAgreement({apiVersion: '2020-03-01'});

You can also set the API version globally in AWS.config.apiVersions using the marketplaceagreement service identifier:

AWS.config.apiVersions = {
  marketplaceagreement: '2020-03-01',
  // other service API versions
};

var marketplaceagreement = new AWS.MarketplaceAgreement();

Constructor Summarycollapse

Property Summarycollapse

Properties inherited from AWS.Service

apiVersions

Method Summarycollapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.MarketplaceAgreement(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Property Details

endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

Method Details

describeAgreement(params = {}, callback) ⇒ AWS.Request

Provides details about an agreement, such as the proposer, acceptor, start date, and end date.

getAgreementTerms(params = {}, callback) ⇒ AWS.Request

Obtains details about the terms in an agreement that you participated in as proposer or acceptor.

The details include:

searchAgreements(params = {}, callback) ⇒ AWS.Request

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.

The following filter combinations are supported: