@aws-sdk/client-partnercentral-selling

Description

AWS SDK for JavaScript PartnerCentralSelling Client for Node.js, Browser and React Native.

<fullname>AWS Partner Central API for Selling</fullname> AWS Partner Central API for Selling Reference Guide This Amazon Web Services (AWS) Partner Central API reference is designed to help <a href="http://aws.amazon.com/partners/programs/">AWS Partners</a> integrate Customer Relationship Management (CRM) systems with AWS Partner Central. Partners can automate interactions with AWS Partner Central, which helps to ensure effective engagements in joint business activities. The API provides standard AWS API functionality. Access it by either using API <a href="https://docs.aws.amazon.com/partner-central/latest/selling-api/API_Operations.html">Actions</a> or by using an AWS SDK that's tailored to your programming language or platform. For more information, see <a href="http://aws.amazon.com/getting-started">Getting Started with AWS</a> and <a href="http://aws.amazon.com/developer/tools/">Tools to Build on AWS</a>. Features offered by AWS Partner Central API <ol> <li> Opportunity management: Manages coselling opportunities through API actions such as <code>CreateOpportunity</code>, <code>UpdateOpportunity</code>, <code>ListOpportunities</code>, <code>GetOpportunity</code>, and <code>AssignOpportunity</code>. </li> <li> AWS referral management: Manages referrals shared by AWS using actions such as <code>ListEngagementInvitations</code>, <code>GetEngagementInvitation</code>, <code>StartEngagementByAcceptingInvitation</code>, and <code>RejectEngagementInvitation</code>. </li> <li> Entity association: Associates related entities such as AWS Products, Partner Solutions, and AWS Marketplace Private Offers with opportunities using the actions <code>AssociateOpportunity</code>, and <code>DisassociateOpportunity</code>. </li> <li> View AWS opportunity details: Retrieves real-time summaries of AWS opportunities using the <code>GetAWSOpportunitySummary</code> action. </li> <li> List solutions: Provides list APIs for listing partner offers using <code>ListSolutions</code>. </li> <li> Event subscription: Subscribe to real-time opportunity updates through AWS EventBridge by using actions such as Opportunity Created, Opportunity Updated, Engagement Invitation Accepted, Engagement Invitation Rejected, and Engagement Invitation Created. </li> </ol>

Installing

To install this package, use the CLI of your favorite package manager:

npm install @aws-sdk/client-partnercentral-selling
yarn add @aws-sdk/client-partnercentral-selling
pnpm add @aws-sdk/client-partnercentral-selling

Getting Started

Import

The AWS SDK is modulized by clients and commands. To send a request, you only need to import the PartnerCentralSellingClient and the commands you need, for example ListEngagementsCommand:

// ES5 example
const { PartnerCentralSellingClient, ListEngagementsCommand } = require("@aws-sdk/client-partnercentral-selling");

// ES6+ example
import { PartnerCentralSellingClient, ListEngagementsCommand } from "@aws-sdk/client-partnercentral-selling";

Usage

To send a request:

Instantiate a client with configuration (e.g. credentials, region).
- See docs/CLIENTS for configuration details.
- See @aws-sdk/config for additional options.
Instantiate a command with input parameters.
Call the send operation on the client, providing the command object as input.

const client = new PartnerCentralSellingClient({ region: "REGION" });

const params = { /** input parameters */ };
const command = new ListEngagementsCommand(params);

Async/await

We recommend using the await operator to wait for the promise returned by send operation as follows:

// async/await.
try {
  const data = await client.send(command);
  // process data.
} catch (error) {
  // error handling.
} finally {
  // finally.
}

Promises

You can also use Promise chaining.

client
  .send(command)
  .then((data) => {
    // process data.
  })
  .catch((error) => {
    // error handling.
  })
  .finally(() => {
    // finally.
  });

Aggregated client

The aggregated client class is exported from the same package, but without the "Client" suffix.

PartnerCentralSelling extends PartnerCentralSellingClient and additionally supports all operations, waiters, and paginators as methods. This style may be familiar to you from the AWS SDK for JavaScript v2.

If you are bundling the AWS SDK, we recommend using only the bare-bones client (PartnerCentralSellingClient). More details are in the blog post on modular packages in AWS SDK for JavaScript.

import { PartnerCentralSelling } from "@aws-sdk/client-partnercentral-selling";

const client = new PartnerCentralSelling({ region: "REGION" });

// async/await.
try {
  const data = await client.listEngagements(params);
  // process data.
} catch (error) {
  // error handling.
}

// Promises.
client
  .listEngagements(params)
  .then((data) => {
    // process data.
  })
  .catch((error) => {
    // error handling.
  });

// callbacks (not recommended).
client.listEngagements(params, (err, data) => {
  // process err and data.
});

Troubleshooting

When the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).

try {
  const data = await client.send(command);
  // process data.
} catch (error) {
  const { requestId, cfId, extendedRequestId } = error.$metadata;
  console.log({ requestId, cfId, extendedRequestId });
  /**
   * The keys within exceptions are also parsed.
   * You can access them by specifying exception names:
   * if (error.name === 'SomeServiceException') {
   *     const value = error.specialKeyInException;
   * }
   */
}

Getting Help

Please use these community resources for getting help. We use GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.

Visit the Developer Guide or API Reference.
Check out the blog posts tagged with aws-sdk-js on AWS Developer Blog.
Ask a question on StackOverflow and tag it with aws-sdk-js.
Join the AWS JavaScript community on gitter.
If it turns out that you may have found a bug, please open an issue.

To test your universal JavaScript code in Node.js, browser and react-native environments, visit our code samples repo.

Contributing

This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-partnercentral-selling package is updated. To contribute to client you can check our generate clients scripts.

License

This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.

Client Commands (Operations List)

<details> <summary> AcceptEngagementInvitation </summary>