- Navigation GuideYou are on a Client landing page. Commands (operations) are listed on this page. The Client constructor type is linked at the bottom.
PartnerCentralSellingClient
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
-
Opportunity management: Manages coselling opportunities through API actions such as
CreateOpportunity
,UpdateOpportunity
,ListOpportunities
,GetOpportunity
, andAssignOpportunity
. -
AWS referral management: Manages referrals shared by AWS using actions such as
ListEngagementInvitations
,GetEngagementInvitation
,StartEngagementByAcceptingInvitation
, andRejectEngagementInvitation
. -
Entity association: Associates related entities such as AWS Products, Partner Solutions, and AWS Marketplace Private Offers with opportunities using the actions
AssociateOpportunity
, andDisassociateOpportunity
. -
View AWS opportunity details: Retrieves real-time summaries of AWS opportunities using the
GetAWSOpportunitySummary
action. -
List solutions: Provides list APIs for listing partner offers using
ListSolutions
. -
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.
Installation
npm install @aws-sdk/client-partnercentral-selling
yarn add @aws-sdk/client-partnercentral-selling
pnpm add @aws-sdk/client-partnercentral-selling
PartnerCentralSellingClient Operations
Command | Summary |
---|
Command | Summary |
---|---|
AcceptEngagementInvitationCommand | Use the |
AssignOpportunityCommand | Enables you to reassign an existing This is useful for distributing opportunities to the appropriate team members or departments within your organization, ensuring that each opportunity is handled by the right person. By default, the opportunity owner is the one who creates it. Currently, there's no API to enumerate the list of available users. |
AssociateOpportunityCommand | Enables you to create a formal association between an
To obtain identifiers for these entities, use the following methods:
|
CreateEngagementCommand | The |
CreateEngagementInvitationCommand | This action creates an invitation from a sender to a single receiver to join an engagement. |
CreateOpportunityCommand | Creates an To submit an opportunity, follow these steps:
After submission, you can't edit the opportunity until the review is complete. But opportunities in the There's a set of mandatory fields to create opportunities, but consider providing optional fields to enrich the opportunity record. |
CreateResourceSnapshotCommand | This action allows you to create an immutable snapshot of a specific resource, such as an opportunity, within the context of an engagement. The snapshot captures a subset of the resource's data based on the schema defined by the provided template. |
CreateResourceSnapshotJobCommand | Use this action to create a job to generate a snapshot of the specified resource within an engagement. It initiates an asynchronous process to create a resource snapshot. The job creates a new snapshot only if the resource state has changed, adhering to the same access control and immutability rules as direct snapshot creation. |
DeleteResourceSnapshotJobCommand | Use this action to deletes a previously created resource snapshot job. The job must be in a stopped state before it can be deleted. |
DisassociateOpportunityCommand | Allows you to remove an existing association between an Use this operation to update the associations of an |
GetAwsOpportunitySummaryCommand | Retrieves a summary of an AWS Opportunity. This summary includes high-level details about the opportunity sourced from AWS, such as lifecycle information, customer details, and involvement type. It is useful for tracking updates on the AWS opportunity corresponding to an opportunity in the partner's account. |
GetEngagementCommand | Use this action to retrieve the engagement record for a given |
GetEngagementInvitationCommand | Retrieves the details of an engagement invitation shared by AWS with a partner. The information includes aspects such as customer, project details, and lifecycle information. To connect an engagement invitation with an opportunity, match the invitation’s |
GetOpportunityCommand | Fetches the Use the |
GetResourceSnapshotCommand | Use this action to retrieve a specific snapshot record. |
GetResourceSnapshotJobCommand | Use this action to retrieves information about a specific resource snapshot job. |
GetSellingSystemSettingsCommand | Retrieves the currently set system settings, which include the IAM Role used for resource snapshot jobs. |
ListEngagementByAcceptingInvitationTasksCommand | Lists all in-progress, completed, or failed StartEngagementByAcceptingInvitationTask tasks that were initiated by the caller's account. |
ListEngagementFromOpportunityTasksCommand | Lists all in-progress, completed, or failed |
ListEngagementInvitationsCommand | Retrieves a list of engagement invitations sent to the partner. This allows partners to view all pending or past engagement invitations, helping them track opportunities shared by AWS. |
ListEngagementMembersCommand | Retrieves the details of member partners in an Engagement. This operation can only be invoked by members of the Engagement. The |
ListEngagementResourceAssociationsCommand | Lists the associations between resources and engagements where the caller is a member and has at least one snapshot in the engagement. |
ListEngagementsCommand | This action allows users to retrieve a list of Engagement records from Partner Central. This action can be used to manage and track various engagements across different stages of the partner selling process. |
ListOpportunitiesCommand | This request accepts a list of filters that retrieve opportunity subsets as well as sort options. This feature is available to partners from Partner Central using the To synchronize your system with Amazon Web Services, only list the opportunities that were newly created or updated. We recommend you rely on events emitted by the service into your Amazon Web Services account’s Amazon EventBridge default event bus, you can also use the We recommend the following approach:
|
ListResourceSnapshotJobsCommand | Lists resource snapshot jobs owned by the customer. This operation supports various filtering scenarios, including listing all jobs owned by the caller, jobs for a specific engagement, jobs with a specific status, or any combination of these filters. |
ListResourceSnapshotsCommand | Retrieves a list of resource view snapshots based on specified criteria. This operation supports various use cases, including:
|
ListSolutionsCommand | Retrieves a list of Partner Solutions that the partner registered on Partner Central. This API is used to generate a list of solutions that an end user selects from for association with an opportunity. |
ListTagsForResourceCommand | Returns a list of tags for a resource. |
PutSellingSystemSettingsCommand | Updates the currently set system settings, which include the IAM Role used for resource snapshot jobs. |
RejectEngagementInvitationCommand | This action rejects an |
StartEngagementByAcceptingInvitationTaskCommand | This action starts the engagement by accepting an |
StartEngagementFromOpportunityTaskCommand | This action initiates the engagement process from an existing opportunity by accepting the engagement invitation and creating a corresponding opportunity in the partner’s system. Similar to |
StartResourceSnapshotJobCommand | Starts a resource snapshot job that has been previously created. |
StopResourceSnapshotJobCommand | Stops a resource snapshot job. The job must be started prior to being stopped. |
SubmitOpportunityCommand | Use this action to submit an Opportunity that was previously created by partner for AWS review. After you perform this action, the Opportunity becomes non-editable until it is reviewed by AWS and has |
TagResourceCommand | Assigns one or more tags (key-value pairs) to the specified resource. |
UntagResourceCommand | Removes a tag or tags from a resource. |
UpdateOpportunityCommand | Updates the When you perform updates, include the entire payload with each request. If any field is omitted, the API assumes that the field is set to |
PartnerCentralSellingClient Configuration
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
defaultsMode Optional | DefaultsMode | Provider<DefaultsMode> | The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK. |
disableHostPrefix Optional | boolean | Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation. |
extensions Optional | RuntimeExtension[] | Optional extensions |
logger Optional | Logger | Optional logger for logging debug/info/warn/error. |
maxAttempts Optional | number | Provider<number> | Value for how many times a request will be made at most in case of retry. |
profile Optional | string | Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options. |
region Optional | string | Provider<string> | The AWS region to which this client will send requests |
requestHandler Optional | __HttpHandlerUserInput | The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs. |
retryMode Optional | string | Provider<string> | Specifies which retry algorithm to use. |
useDualstackEndpoint Optional | boolean | Provider<boolean> | Enables IPv6/IPv4 dualstack endpoint. |
useFipsEndpoint Optional | boolean | Provider<boolean> | Enables FIPS compatible endpoints. |
Additional config fields are described in the full configuration type: PartnerCentralSellingClientConfig