@aws-sdk/client-partnercentral-selling

Description

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

AWS Partner Central API for Selling

AWS Partner Central API for Selling Reference Guide

This Amazon Web Services (AWS) Partner Central API reference is designed to help AWS Partners 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 Actions or by using an AWS SDK that's tailored to your programming language or platform. For more information, see Getting Started with AWS and Tools to Build on AWS.

Features offered by AWS Partner Central API

1. Opportunity management: Manages coselling opportunities through API actions such as CreateOpportunity, UpdateOpportunity, ListOpportunities, GetOpportunity, and AssignOpportunity.

2. AWS referral management: Manages referrals shared by AWS using actions such as ListEngagementInvitations, GetEngagementInvitation, StartEngagementByAcceptingInvitation, and RejectEngagementInvitation.

3. Entity association: Associates related entities such as AWS Products, Partner Solutions, and AWS Marketplace Private Offers with opportunities using the actions AssociateOpportunity, and DisassociateOpportunity.

4. View AWS opportunity details: Retrieves real-time summaries of AWS opportunities using the GetAWSOpportunitySummary action.

5. List solutions: Provides list APIs for listing partner offers using ListSolutions.

6. 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.

Installing

To install this package, simply type add or install @aws-sdk/client-partnercentral-selling
using 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

$3

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:

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

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

$3

To send a request, you:

- Initiate client with configuration (e.g. credentials, region).
- Initiate command with input parameters.
- Call send operation on client with command object as input.
- If you are using a custom http handler, you may call destroy() to close open connections.

`js
// a client can be shared by different commands.
const client = new PartnerCentralSellingClient({ region: "REGION" });

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

#### Async/await

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

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

Async-await is clean, concise, intuitive, easy to debug and has better error handling
as compared to using Promise chains or callbacks.

#### Promises

You can also use Promise chaining
to execute send operation.

`js
client.send(command).then(
(data) => {
// process data.
},
(error) => {
// error handling.
}
);
`

Promises can also be called using .catch() and .finally() as follows:

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

#### Callbacks

We do not recommend using callbacks because of callback hell,
but they are supported by the send operation.

`js
// callbacks.
client.send(command, (err, data) => {
// process err and data.
});
`

#### v2 compatible style

The client can also send requests using v2 compatible style.
However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post
on modular packages in AWS SDK for JavaScript

`ts
import * as AWS from "@aws-sdk/client-partnercentral-selling";
const client = new AWS.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.
client.listEngagements(params, (err, data) => {
// process err and data.
});
`

$3

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

`js
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 the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.

- Visit 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)

AcceptEngagementInvitation

Command API Reference / Input / Output

AssignOpportunity

Command API Reference / Input / Output

AssociateOpportunity

Command API Reference / Input / Output

CreateEngagement

Command API Reference / Input / Output

CreateEngagementContext

Command API Reference / Input / Output

CreateEngagementInvitation

Command API Reference / Input / Output

CreateOpportunity

Command API Reference / Input / Output

CreateResourceSnapshot

Command API Reference / Input / Output

CreateResourceSnapshotJob

Command API Reference / Input / Output

DeleteResourceSnapshotJob

Command API Reference / Input / Output

DisassociateOpportunity

Command API Reference / Input / Output

GetAwsOpportunitySummary

Command API Reference / Input / Output

GetEngagement

Command API Reference / Input / Output

GetEngagementInvitation

Command API Reference / Input / Output

GetOpportunity

Command API Reference / Input / Output

GetResourceSnapshot

Command API Reference / Input / Output

GetResourceSnapshotJob

Command API Reference / Input / Output

GetSellingSystemSettings

Command API Reference / Input / Output

ListEngagementByAcceptingInvitationTasks

Command API Reference / Input / Output

ListEngagementFromOpportunityTasks

Command API Reference / Input / Output

ListEngagementInvitations

Command API Reference / Input / Output

ListEngagementMembers

Command API Reference / Input / Output

ListEngagementResourceAssociations

Command API Reference / Input / Output

ListEngagements

Command API Reference / Input / Output

ListOpportunities

Command API Reference / Input / Output

ListOpportunityFromEngagementTasks

Command API Reference / Input / Output

ListResourceSnapshotJobs

Command API Reference / Input / Output

ListResourceSnapshots

Command API Reference / Input / Output

ListSolutions

Command API Reference / Input / Output

ListTagsForResource

Command API Reference / Input / Output

PutSellingSystemSettings

Command API Reference / Input / Output

RejectEngagementInvitation

Command API Reference / Input / Output

StartEngagementByAcceptingInvitationTask

Command API Reference / Input / Output

StartEngagementFromOpportunityTask

Command API Reference / Input / Output

StartOpportunityFromEngagementTask

Command API Reference / Input / Output

StartResourceSnapshotJob

Command API Reference / Input / Output

StopResourceSnapshotJob

Command API Reference / Input / Output

SubmitOpportunity

Command API Reference / Input / Output

TagResource

Command API Reference / Input / Output

UntagResource

Command API Reference / Input / Output

UpdateEngagementContext

Command API Reference / Input / Output

UpdateOpportunity

Command API Reference / Input / Output