View Source AWS.PartnerCentralSelling (aws-elixir v1.0.3)
AWS Partner Central API for Selling
aws-partner-central-api-for-selling-reference-guide
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
Features offered by AWS Partner Central API
1.
opportunity-management
Opportunity management:
Manages coselling opportunities through API actions such as
CreateOpportunity
, UpdateOpportunity
,
ListOpportunities
, GetOpportunity
, and
AssignOpportunity
.
2.
aws-referral-management
AWS referral management:
Manages referrals shared by AWS using actions such as
ListEngagementInvitations
,
GetEngagementInvitation
,
StartEngagementByAcceptingInvitation
, and
RejectEngagementInvitation
.
3.
entity-association
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
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.
Link to this section Summary
Functions
Enables you to reassign an existing Opportunity
to another user within your
Partner Central account.
Enables you to create a formal association between an Opportunity
and various
related entities, enriching the context and details of the opportunity for
better collaboration and
decision making.
Creates an Opportunity
record in Partner Central.
Allows you to remove an existing association between an Opportunity
and
related entities, such as a Partner Solution, Amazon Web Services product, or an
Amazon Web Services Marketplace offer.
Retrieves a summary of an AWS Opportunity.
Retrieves the details of an engagement invitation shared by AWS with a partner.
Fetches the Opportunity
record from Partner Central by a given Identifier
.
Retrieves a list of engagement invitations sent to the partner.
This request accepts a list of filters that retrieve opportunity subsets as well as sort options.
Retrieves a list of Partner Solutions that the partner registered on Partner Central.
This action rejects an EngagementInvitation
that AWS
shared.
This action starts the engagement by accepting an EngagementInvitation
.
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.
Updates the Opportunity
record identified by a given Identifier
.
Link to this section Functions
Enables you to reassign an existing Opportunity
to another user within your
Partner Central account.
The specified user receives the opportunity, and it appears on their Partner Central dashboard, allowing them to take necessary actions or proceed with the opportunity.
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.
Enables you to create a formal association between an Opportunity
and various
related entities, enriching the context and details of the opportunity for
better collaboration and
decision making.
You can associate an opportunity with the following entity types:
*
Partner Solution: A software product or consulting practice created and delivered by Partners. Partner Solutions help customers address business challenges using Amazon Web Services services.
*
Amazon Web Services Products: Amazon Web Services offers many products and services that provide scalable, reliable, and cost-effective infrastructure solutions. For the latest list of Amazon Web Services products, see Amazon Web Services products.
*
Amazon Web Services Marketplace private offer: Allows Amazon Web Services Marketplace sellers to extend custom pricing and terms to individual Amazon Web Services customers. Sellers can negotiate custom prices, payment schedules, and end user license terms through private offers, enabling Amazon Web Services customers to acquire software solutions tailored to their specific needs. For more information, see Private offers in Amazon Web Services Marketplace.
To obtain identifiers for these entities, use the following methods:
*
Solution: Use the ListSolutions
operation.
*
AWS Products: For the latest list of Amazon Web Services products, see Amazon Web Services products.
*
Amazon Web Services Marketplace private offer: Use the Using the Amazon Web Services Marketplace Catalog
API
to list entities. Specifically, use the ListEntities
operation to retrieve a
list of private offers. The request returns the details of available private
offers. For more information, see
ListEntities.
Creates an Opportunity
record in Partner Central.
Use this operation to create
a potential business opportunity for submission to Amazon Web Services. Creating
an opportunity sets Lifecycle.ReviewStatus
to
Pending Submission
.
To submit an opportunity, follow these steps:
1.
To create the opportunity, use CreateOpportunity
.
2.
To associate a solution with the opportunity, use AssociateOpportunity
.
3.
To submit the opportunity, use StartEngagementFromOpportunityTask
.
After submission, you can't edit the opportunity until the review is complete.
But opportunities in the
Pending Submission
state must have complete details. You can update
the opportunity while it's in the Pending Submission
state.
There's a set of mandatory fields to create opportunities, but consider providing optional fields to enrich the opportunity record.
Allows you to remove an existing association between an Opportunity
and
related entities, such as a Partner Solution, Amazon Web Services product, or an
Amazon Web Services Marketplace offer.
This operation is the counterpart to AssociateOpportunity
, and it provides
flexibility to manage
associations as business needs change.
Use this operation to update the associations of an Opportunity
due to changes
in the related entities,
or if an association was made in error. Ensuring accurate associations helps
maintain clarity and accuracy to track
and manage business opportunities. When you replace an entity, first attach the
new entity and then disassociate the
one to be removed, especially if it's the last remaining entity that's required.
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.
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 Payload.Project.Title
with opportunity Project.Title
.
Fetches the Opportunity
record from Partner Central by a given Identifier
.
Use the ListOpportunities
action or the event notification (from Amazon
EventBridge) to obtain this identifier.
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.
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 ListOpportunities
API action.
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 ListOpportunities
action.
We recommend the following approach:
1.
Find the latest LastModifiedDate
that you stored, and only use the values that
came
from Amazon Web Services. Don’t use values generated by your system.
2.
When you send a ListOpportunities
request, submit the date in ISO 8601 format
in the AfterLastModifiedDate
filter.
3.
Amazon Web Services only returns opportunities created or updated on or after
that date and time. Use NextToken
to iterate over all pages.
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.
This action rejects an EngagementInvitation
that AWS
shared.
Rejecting an invitation indicates that the partner doesn't want to pursue the opportunity, and all related data will become inaccessible thereafter.
start_engagement_by_accepting_invitation_task(client, input, options \\ [])
View SourceThis action starts the engagement by accepting an EngagementInvitation
.
The task is asynchronous and involves the following steps: accepting the
invitation, creating an opportunity in the partner’s account from the AWS
opportunity, and copying details for tracking. When completed, an Opportunity Created
event is generated, indicating that the opportunity has been
successfully created in the partner's account.
start_engagement_from_opportunity_task(client, input, options \\ [])
View SourceThis 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 StartEngagementByAcceptingInvitationTask
, this action is
asynchronous and performs multiple steps before completion.
Updates the Opportunity
record identified by a given Identifier
.
This operation allows you to modify the details of an existing opportunity to reflect the latest information and progress. Use this action to keep the opportunity record up-to-date and accurate.
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 null
. The best
practice is to always perform a GetOpportunity
to retrieve the latest values,
then send the complete payload with the updated values to be changed.