Partner Central Selling API
Partner Central This Amazon Web Services (AWS) Partner Central API reference is designed to help AWS Partners integrate Customer Relationship Management (CRM)…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Partner Central 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 , and AssignOpportunity . AWS referral management: Manages referrals shared by AWS using actions such as ListEngagementInvitations , GetEngagementInvitation , StartEngagementByAcceptingInvitation , and RejectEngagementInvitation . Entity association: Associates related entities such as AWS Products , Partner Solutions , and AWS Marketplace Private Offers with opportunities using the actions AssociateOpportunity , and DisassociateOpportunity . 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 .
Endpoints 45
Engagement invitation
- POSTAccept engagement invitation
/#X-Amz-Target=AWSPartnerCentralSelling.AcceptEngagementInvitationUse the AcceptEngagementInvitation action to accept an engagement invitation shared by AWS. Accepting the invitation indicates your willingness to participate… - POSTCreate engagement invitation
/#X-Amz-Target=AWSPartnerCentralSelling.CreateEngagementInvitationThis action creates an invitation from a sender to a single receiver to join an engagement. - POSTGet engagement invitation
/#X-Amz-Target=AWSPartnerCentralSelling.GetEngagementInvitationRetrieves the details of an engagement invitation shared by AWS with a partner. The information includes aspects such as customer, project details, and… - POSTList engagement invitations
/#X-Amz-Target=AWSPartnerCentralSelling.ListEngagementInvitationsRetrieves a list of engagement invitations sent to the partner. This allows partners to view all pending or past engagement invitations, helping them track… - POSTReject engagement invitation
/#X-Amz-Target=AWSPartnerCentralSelling.RejectEngagementInvitationThis action rejects an EngagementInvitation that AWS shared. Rejecting an invitation indicates that the partner doesn't want to pursue the opportunity, and…
Opportunity
- POSTAssign opportunity
/#X-Amz-Target=AWSPartnerCentralSelling.AssignOpportunityEnables you to reassign an existing Opportunity to another user within your Partner Central account. The specified user receives the opportunity, and it… - POSTAssociate opportunity
/#X-Amz-Target=AWSPartnerCentralSelling.AssociateOpportunityEnables you to create a formal association between an Opportunity and various related entities, enriching the context and details of the opportunity for… - POSTCreate opportunity
/#X-Amz-Target=AWSPartnerCentralSelling.CreateOpportunityCreates an Opportunity record in Partner Central. Use this operation to create a potential business opportunity for submission to Amazon Web Services.… - POSTDisassociate opportunity
/#X-Amz-Target=AWSPartnerCentralSelling.DisassociateOpportunityAllows you to remove an existing association between an Opportunity and related entities, such as a Partner Solution, Amazon Web Services product, or an… - POSTGet aws opportunity summary
/#X-Amz-Target=AWSPartnerCentralSelling.GetAwsOpportunitySummaryRetrieves a summary of an AWS Opportunity. This summary includes high-level details about the opportunity sourced from AWS, such as lifecycle information,… - POSTGet opportunity
/#X-Amz-Target=AWSPartnerCentralSelling.GetOpportunityFetches the Opportunity record from Partner Central by a given Identifier . Use the ListOpportunities action or the event notification (from Amazon… - POSTList opportunities
/#X-Amz-Target=AWSPartnerCentralSelling.ListOpportunitiesThis request accepts a list of filters that retrieve opportunity subsets as well as sort options. This feature is available to partners from Partner Central… - POSTSubmit opportunity
/#X-Amz-Target=AWSPartnerCentralSelling.SubmitOpportunityUse this action to submit an Opportunity that was previously created by partner for AWS review. After you perform this action, the Opportunity becomes… - POSTUpdate opportunity
/#X-Amz-Target=AWSPartnerCentralSelling.UpdateOpportunityUpdates the Opportunity record identified by a given Identifier . This operation allows you to modify the details of an existing opportunity to reflect the…
Engagement
- POSTCreate engagement
/#X-Amz-Target=AWSPartnerCentralSelling.CreateEngagementThe CreateEngagement action allows you to create an Engagement , which serves as a collaborative space between different parties such as AWS Partners and AWS… - POSTGet engagement
/#X-Amz-Target=AWSPartnerCentralSelling.GetEngagementUse this action to retrieve the engagement record for a given EngagementIdentifier . - POSTList engagement members
/#X-Amz-Target=AWSPartnerCentralSelling.ListEngagementMembersRetrieves the details of member partners in an Engagement. This operation can only be invoked by members of the Engagement. The ListEngagementMembers… - POSTList engagements
/#X-Amz-Target=AWSPartnerCentralSelling.ListEngagementsThis 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…
Resource snapshot
- POSTCreate resource snapshot
/#X-Amz-Target=AWSPartnerCentralSelling.CreateResourceSnapshotThis action allows you to create an immutable snapshot of a specific resource, such as an opportunity, within the context of an engagement. The snapshot… - POSTGet resource snapshot
/#X-Amz-Target=AWSPartnerCentralSelling.GetResourceSnapshotUse this action to retrieve a specific snapshot record. - POSTList engagement resource associations
/#X-Amz-Target=AWSPartnerCentralSelling.ListEngagementResourceAssociationsLists the associations between resources and engagements where the caller is a member and has at least one snapshot in the engagement. - POSTList resource snapshots
/#X-Amz-Target=AWSPartnerCentralSelling.ListResourceSnapshotsRetrieves a list of resource view snapshots based on specified criteria. This operation supports various use cases, including: Fetching all snapshots…
Resource snapshot job
- POSTCreate resource snapshot job
/#X-Amz-Target=AWSPartnerCentralSelling.CreateResourceSnapshotJobUse 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… - POSTDelete resource snapshot job
/#X-Amz-Target=AWSPartnerCentralSelling.DeleteResourceSnapshotJobUse this action to deletes a previously created resource snapshot job. The job must be in a stopped state before it can be deleted. - POSTGet resource snapshot job
/#X-Amz-Target=AWSPartnerCentralSelling.GetResourceSnapshotJobUse this action to retrieves information about a specific resource snapshot job. - POSTList resource snapshot jobs
/#X-Amz-Target=AWSPartnerCentralSelling.ListResourceSnapshotJobsLists resource snapshot jobs owned by the customer. This operation supports various filtering scenarios, including listing all jobs owned by the caller, jobs… - POSTStart resource snapshot job
/#X-Amz-Target=AWSPartnerCentralSelling.StartResourceSnapshotJobStarts a resource snapshot job that has been previously created. - POSTStop resource snapshot job
/#X-Amz-Target=AWSPartnerCentralSelling.StopResourceSnapshotJobStops a resource snapshot job. The job must be started prior to being stopped.
Prospecting from engagement task
- POSTGet prospecting from engagement task
/#X-Amz-Target=AWSPartnerCentralSelling.GetProspectingFromEngagementTaskRetrieves the details and current status of a prospecting task previously started with StartProspectingFromEngagementTask to enable polling for completion and… - POSTList prospecting from engagement tasks
/#X-Amz-Target=AWSPartnerCentralSelling.ListProspectingFromEngagementTasksLists all prospecting tasks initiated by the caller's account. Supports optional filters by task identifier, task name, or start time range. Results can be… - POSTStart prospecting from engagement task
/#X-Amz-Target=AWSPartnerCentralSelling.StartProspectingFromEngagementTaskStarts a task to convert one or more engagement contexts into new prospecting leads. The task runs asynchronously. To poll for status, use…
Engagement by accepting invitation task
- POSTList engagement by accepting invitation tasks
/#X-Amz-Target=AWSPartnerCentralSelling.ListEngagementByAcceptingInvitationTasksLists all in-progress, completed, or failed StartEngagementByAcceptingInvitationTask tasks that were initiated by the caller's account. - POSTStart engagement by accepting invitation task
/#X-Amz-Target=AWSPartnerCentralSelling.StartEngagementByAcceptingInvitationTaskThis action starts the engagement by accepting an EngagementInvitation . The task is asynchronous and involves the following steps: accepting the invitation,…
Engagement from opportunity task
- POSTList engagement from opportunity tasks
/#X-Amz-Target=AWSPartnerCentralSelling.ListEngagementFromOpportunityTasksLists all in-progress, completed, or failed EngagementFromOpportunity tasks that were initiated by the caller's account. - POSTStart engagement from opportunity task
/#X-Amz-Target=AWSPartnerCentralSelling.StartEngagementFromOpportunityTaskSimilar to StartEngagementByAcceptingInvitationTask , this action is asynchronous and performs multiple steps before completion. This action orchestrates a…
Opportunity from engagement task
- POSTList opportunity from engagement tasks
/#X-Amz-Target=AWSPartnerCentralSelling.ListOpportunityFromEngagementTasksLists all in-progress, completed, or failed opportunity creation tasks from engagements that were initiated by the caller's account. - POSTStart opportunity from engagement task
/#X-Amz-Target=AWSPartnerCentralSelling.StartOpportunityFromEngagementTaskThis action creates an opportunity from an existing engagement context. The task is asynchronous and orchestrates the process of converting engagement…
Solution
- POSTList solutions
/#X-Amz-Target=AWSPartnerCentralSelling.ListSolutionsRetrieves 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…
- POSTCreate engagement context
/#X-Amz-Target=AWSPartnerCentralSelling.CreateEngagementContextCreates a new context within an existing engagement. This action allows you to add contextual information such as customer projects or documents to an… - POSTGet selling system settings
/#X-Amz-Target=AWSPartnerCentralSelling.GetSellingSystemSettingsRetrieves the currently set system settings, which include the IAM Role used for resource snapshot jobs. - POSTList tags for resource
/#X-Amz-Target=AWSPartnerCentralSelling.ListTagsForResourceReturns a list of tags for a resource. - POSTPut selling system settings
/#X-Amz-Target=AWSPartnerCentralSelling.PutSellingSystemSettingsUpdates the currently set system settings, which include the IAM Role used for resource snapshot jobs. - POSTTag resource
/#X-Amz-Target=AWSPartnerCentralSelling.TagResourceAssigns one or more tags (key-value pairs) to the specified resource. - POSTUntag resource
/#X-Amz-Target=AWSPartnerCentralSelling.UntagResourceRemoves a tag or tags from a resource. - POSTUpdate engagement context
/#X-Amz-Target=AWSPartnerCentralSelling.UpdateEngagementContextUpdates the context information for an existing engagement with new or modified data.
API details
- Base URL
https://partnercentral-selling.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 45 operations on 45 pathsPOST 45
- Main resources
- Opportunity 9Resource snapshot job 6Engagement invitation 5Engagement 4Resource snapshot 4Prospecting from engagement task 3Engagement by accepting invitation task 2Engagement from opportunity task 2Opportunity from engagement task 2Solution 1
- Description format
- AWS Smithy model, API version
2022-07-26 - Links
- Documentation · OpenAPI document
- Listed from
- AWS Smithy API model (aws/api-models-aws) (Apache-2.0)
How to test the Partner Central Selling API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Partner Central Selling API collection, without the publisher's secrets.
- Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Accept engagement invitation” (POST /#X-Amz-Target=AWSPartnerCentralSelling.AcceptEngagementInvitation), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Partner Central Selling API?
Partner Central This Amazon Web Services (AWS) Partner Central API reference is designed to help AWS Partners integrate Customer Relationship Management (CRM)… It is listed under Developer tools and has 45 endpoints.
Who publishes the Partner Central Selling API?
It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Partner Central Selling API?
Requests go to https://partnercentral-selling.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the Partner Central Selling API?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the Partner Central Selling API have?
45 operations on 45 paths (45 POST). The largest groups are Opportunity, Resource snapshot job, Engagement invitation, Engagement.
Is forking the Partner Central Selling API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.