对 AWS 合作伙伴中心 API 参考进行了重组。有关支持的 API 操作的更多信息,请参阅 AWS 合作伙伴中心 API 参考。
本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
的通知 AWS Partner Central Selling API
销售 API 的事件提供有关状态变化或机会详细信息的实时通知。这些事件有助于使您的系统与 P AWS artner Central 保持同步,并有助于确保及时响应和更新。
完成监控事件的先决条件
用户需要相应的 IAM 权限才能访问和管理合作伙伴中心销售 API 发布的事件。有关可用操作、资源和条件密钥的更多信息 EventBridge,请参阅亚马逊 EventBridge 用户指南中的在亚马逊 EventBridge中使用 IAM 政策条件。条件键之一是events:detail-type,它可用于将权限范围限定为特定事件类型。
以下示例策略演示了如何自定义拟议活动的权限并确定其范围。该AllowPutRuleForPartnercentralSellingEvents语句允许创建规则,但仅适用于来自aws.partnercentral-selling源的事件。
将亚马逊配置 EventBridge 为监控事件
要监控销售 API 事件,您可以创建与要捕获的事件相匹配的 EventBridge 规则。您可以使用 AWS 管理控制台 或 S AWS DK 来创建和管理规则。以下各节说明如何使用这两种方法创建规则。无论使用哪种方法,都必须在美国东部(弗吉尼亚北部)us-east-1区域创建规则。
AWS 管理控制台 设置
要使用设置 EventBridge 规则 AWS 管理控制台,请按照亚马逊 EventBridge 用户指南中创建应对亚马逊事件的规则 EventBridge中的步骤进行操作。创建规则时,必须将事件总线设置为默认值,并在美国东部(弗吉尼亚北部)us-east-1区域创建规则。
以下是事件规则的示例:
{ "source": ["aws.partnercentral-selling"], "detail": { "catalog": ["AWS"] } }
AWS SDK 设置
您可以使用 AWS 软件开发工具包以编程方式创建和管理 EventBridge 规则。有关更多信息,请参阅亚马逊 EventBridge API 参考PutRule中的内容。
以下示例使用 AWS 适用于 Python 的软件开发工具包 (Boto3):
import boto3 client = boto3.client('events', region_name='us-east-1') response = client.put_rule( Name='MyOpportunityCreatedRule', EventPattern= '{ "source": ["aws.partnercentral-selling"], "detail-type": ["Opportunity Created"], "detail": {"catalog": ["AWS"]} }', State='ENABLED' ) print('Rule ARN:', response['RuleArn'])
了解有关销售 API 活动的更多信息
以下部分描述了销售 API 事件类型、触发事件的场景和事件示例。
事件类型
以下是事件类型及其触发器。
-
已创建机会:创建新机会时触发。
-
机会已更新:更新机会(机会或其相应的机 AWS 会摘要)时触发。
-
已创建参与邀请:创建 AWS 推荐邀请时触发。
-
已接受参与邀请:当合作伙伴接受 AWS 参与邀请,确认他们有兴趣 AWS 就机会与之合作时触发。
-
参与邀请被拒绝:当合作伙伴拒绝 AWS 参与邀请时触发。
-
参与邀请已过期:当合作伙伴拒绝参与邀请时,会触发此事件。 EngagementInvitation它会通知发送方和接收方邀请已过期。
-
已添加参与成员:当新成员接受邀请后加入参与活动时,会触发此事件。它会将新成员添加到项目中的信息通知该项目的所有当前成员。
-
已创建项目资源快照:创建与项目相关的资源(例如机会)快照的新版本时,将触发此事件。它会将关联资源快照的更改通知项目的所有当前成员。
-
已创建参与度:创建新互动时触发。
-
参与度已更新:更新参与度时触发。
事件场景
下表描述了事件在不同场景下的运作方式。针对这些情景做出了以下假设:
-
AWS 也是这些场景中的合作伙伴。
-
ResourceSnapshotJob已由合作伙伴正确配置。 -
有关机会更新的字段也位于资源快照的机会模板上。
| 您作为合作伙伴采取的行动 | 收到的活动 | 参与者类型 |
|---|---|---|
| 你创造了机会 | 机会已创造 | |
你StartEngagementFromOpportunityTask用来提交机会 |
机会已更新、参与度已创建、参与资源快照已创建、参与成员已添加、参与邀请已创建 | |
| AWS 批准您提交的机会 | 参与邀请已接受,参与成员已添加,机会已更新,参与资源快照已创建 | |
| AWS 拒绝您提交的机会 | 参与邀请被拒绝,机会已更新,参与资源快照已创建 | |
| 您将出 AWS Marketplace 价与机会相关联 | 机会已更新 | |
| 您将解决方案与机会联系起来 | 机会已更新,参与资源快照已创建 | |
| 你更新了机会 | 机会已更新,参与资源快照已创建(如果已设置ResourceSnapshotJob且模板上有字段更新,则可选) |
|
| AWS 更新您的机会 | 机会已更新,参与资源快照已创建 | |
| 您邀请其他合作伙伴参与互动 | 订婚邀请已创建 | 发件人 |
| 您的参与邀请已被合作伙伴接受 | 参与邀请已接受,参与成员已添加 | 发件人 |
| 您的参与邀请被合作伙伴拒绝 | 订婚邀请被拒绝 | 发件人 |
| 合作伙伴在 15 天内未对您的参与邀请采取行动 | 订婚邀请已过期 | 发件人 |
| 您会收到来自其他合作伙伴的邀请加入活动 | 订婚邀请已创建 | 接收方 |
您接受其他合作伙伴的邀请,通过以下方式加入互动 StartEngagementByAcceptingInvitationTask |
参与邀请已接受、参与成员已添加、机会已创建、机会已更新、参与资源快照已创建 | 接收方 |
| 您拒绝了其他合作伙伴发出的加入活动的邀请 | 订婚邀请被拒绝 | 接收方 |
| 在 15 天内,您未按其他合作伙伴的邀请采取行动 | 订婚邀请已过期 | 接收方 |
| 你创造了参与度 | 参与度已创建 | 发件人 |
| 你更新了参与度 | 参与度已更新 | 发送者、接收者 |
示例事件
以下各节提供了前面部分中列出的事件的示例。
机会已创造
合作伙伴利用此活动来:
-
通知他们的用户已创建新的机会。
-
触发自动化工作流程,例如更新 CRM 系统或通知销售团队有关新机会的创造。
以下示例显示了典型的 “机会创造” 事件。
{ "version": "1", "id": "01234567-0123-0123-0123-0123456789ab", "source": "aws.partnercentral-selling", "detail-type": "Opportunity Created", "time": "2023-04-16T15:23:45Z", "region": "us-east-1", "account": "123456789012", "detail": { "schemaVersion": "<version number>", "catalog": "<Sandbox | AWS>", "opportunity": { "identifier": "String" } } }
机会已更新
合作伙伴利用此活动来:
-
通知其用户现有机会已更新。
-
触发自动化工作流程,例如更新 CRM 系统或通知销售团队。
以下示例显示了典型的 “机会更新” 事件。
{ "version": "1", "id": "01234567-0123-0123-0123-0123456789ab", "source": "aws.partnercentral-selling", "detail-type": "Opportunity Updated", "time": "2023-04-16T15:23:45Z", "region": "us-east-1", "account": "123456789012", "detail": { "schemaVersion": "<version number>", "catalog": "<Sandbox | AWS>", "opportunity": { "identifier": "String" } } }
订婚邀请已创建
合作伙伴利用此活动来:
-
通知他们的用户 EngagementInvitation 他们收到的新内容。
-
触发自动化工作流程以接受或拒绝邀请,例如更新 CRM 系统或通知销售团队。
以下示例显示了典型的互动邀请创建事件。
{ "version": "0", "id": "01234567-0123-0123-0123-0123456789ab", "detail-type": "Engagement Invitation Created", "source": "aws.partnercentral-selling", "account": "123456789012", "time": "2023-04-15T12:34:56Z", "region": "us-east-1", "resources": [ "arn:aws:partnercentral:us-east-1::catalog/AWS/engagement-invitation/engi-v7p8z56whnauo" ], "detail": { "catalog": "AWS", "engagementInvitation": { "arn": "arn:aws:partnercentral:us-east-1::catalog/AWS/engagement-invitation/engi-v7p8z56whnauo", "id": "engi-v7p8z56whnauo", "engagementId": "eng-12345678901234", "senderAccountId": "string", "receiverAccountId": "string", "senderCompanyName": "string", "expirationDate": "string", "participantType": "Enum", //Sender/Receiver "payloadType": "LeadInvitation" //OpportunityInvitation|LeadInvitation } } }
订婚邀请已接受
合作伙伴利用此活动来:
-
通知他们的用户 EngagementInvitation 已被接受。
-
更新他们的内部记录,以反映项目中的新合作伙伴。
-
触发自动工作流程以同步数据或通知其他团队成员有关新参与成员的信息。
以下示例显示了典型的参与邀请已接受事件。
{ "version": "0", "id": "01234567-0123-0123-0123-0123456789ab", "detail-type": "Engagement Invitation Accepted", "source": "aws.partnercentral-selling", "account": "123456789012", "time": "2023-04-16T15:23:45Z", "region": "us-east-1", "resources": ["arn:aws:partnercentral:us-east-1::catalog/AWS/engagement-invitation/engi-v7p8z56whnauo"], "detail": { "catalog": "AWS", "engagementInvitation": { "arn": "arn:aws:partnercentral:us-east-1::catalog/AWS/engagement-invitation/engi-v7p8z56whnauo", "id": "engi-v7p8z56whnauo", "engagementId": "eng-12356whnauo", "participantType": "Enum", //Sender/Receiver "senderAccountId": "string", "receiverAccountId": "string", "payloadType": "LeadInvitation" //OpportunityInvitation|LeadInvitation } } }
订婚邀请被拒绝
合作伙伴利用此活动来:
-
通知他们的用户 EngagementInvitation 已被拒绝。
-
更新他们的内部记录以反映被拒绝的邀请。
-
触发任何必要的工作流程,例如将拒绝通知销售团队。
以下示例显示了典型的参与邀请被拒绝事件。
{ "version": "0", "id": "01234567-0123-0123-0123-0123456789ab", "detail-type": "Engagement Invitation Rejected", "source": "aws.partnercentral-selling", "account": "123456789012", "time": "2023-04-17T09:48:27Z", "region": "us-east-1", "resources": ["arn:aws:partnercentral:us-east-1::catalog/AWS/engagement-invitation/engi-v7p8z56whnauo"], "detail": { "catalog": "AWS", "engagementInvitation": { "arn": "arn:aws:partnercentral:us-east-1::catalog/AWS/engagement-invitation/engi-v7p8z56whnauo", "id": "engi-v7p8z56whnauo", "engagementId": "eng-12356whnauo", "participantType": "Enum", //Sender/Receiver "senderAccountId": "string", "receiverAccountId": "string", "payloadType": "LeadInvitation" //OpportunityInvitation|LeadInvitation } } }
订婚邀请已过期
合作伙伴利用此活动来:
-
通知他们的用户 EngagementInvitation 已过期,无法再对其采取行动。
-
更新他们的内部记录以反映已过期的邀请。
-
触发任何必要的工作流程,例如将已过期的邀请通知销售团队。
以下示例显示了典型的参与邀请到期事件。
{ "version": "0", "id": "01234567-0123-0123-0123-0123456789ab", "detail-type": "Engagement Invitation Expired", "source": "aws.partnercentral-selling", "account": "123456789012", "time": "2023-04-18T18:20:15Z", "region": "us-east-1", "resources": [ "arn:aws:partnercentral:us-east-1::catalog/AWS/engagement-invitation/engi-v7p8z56whnauo" ], "detail": { "catalog" : "AWS", "engagementInvitation": { "arn": "arn:aws:partnercentral:us-east-1::catalog/AWS/engagement-invitation/engi-v7p8z56whnauo", "id": "engi-v7p8z56whnauo", "engagementId": "eng-12356whnauo", "participantType": "Enum", //Sender/Receiver "senderAccountId": "string", "receiverAccountId": "string", "payloadType": "LeadInvitation" //OpportunityInvitation|LeadInvitation } } }
已添加参与会员
合作伙伴利用此活动来:
-
将参与成员资格的更改通知其用户。
-
更新他们的内部记录以反映新的参与成员。
-
触发任何必要的工作流程,例如将更改通知团队成员。
以下示例显示了典型的参与度成员添加事件。
{ "version": "0", "id": "01234567-0123-0123-0123-0123456789ab", "detail-type": "Engagement Member Added", "source": "aws.partnercentral-selling", "account": "123456789012", "time": "2023-04-16T15:23:45Z", "region": "us-east-1", "resources": [ "arn:aws:partnercentral:us-east-1::catalog/AWS/engagement/eng-v7p8z56whnauo" ], "detail": { "catalog" : "AWS", "engagement": { "id": "eng-v7p8z56whnauo" }, "engagementMember": { "accountId": "string", "companyName": "string" } } }
参与资源快照已创建
合作伙伴使用此事件来跟踪与互动相关的资源变更并触发自动化工作流程,例如更新 CRM 系统或通知销售团队。快照模板决定更新的类型:
OpportunitySummaryView-
-
通知参与活动的所有成员该互动已更新。
-
AwsOpportunitySummaryFullView-
-
跟踪 AWS 专门对项目中的机会所做的更新。
-
只有机会所有者才能看到此通知和快照。
-
包括交易规模更新,这些更新无法通过
OpportunitySummaryView模板获得。
-
以下示例显示了典型的互动资源快照创建事件。
{ "version": "0", "id": "01234567-0123-0123-0123-0123456789ab", "detail-type": "Engagement Resource Snapshot Created", "source": "aws.partnercentral-selling", "account": "123456789012", "time": "2023-04-18T18:20:15Z", "region": "us-east-1", "resources": [ "arn:aws:partnercentral:us-east-1::catalog/AWS/engagement/eng-v7p8z56whnauo" ], "detail": { "catalog" : "AWS", "resourceSnapshot": { "arn": "arn:aws:partnercentral-selling:us-east-1::catalog/AWS/engagement/eng-v7p8z56whnauo/resource/Opportunity/o-12312/template/temp-name/snapshot/snapshot-19232", "engagementId": "eng-v7p8z56whnauo", "resourceType": "Opportunity", "resourceId" : "O123211231", "createdBy": "123123123123", "targetMemberAccounts": ["123123123123", "aws"], "resourceSnapshotTemplateName": "temp-name" } } }
参与度已创建
合作伙伴利用此活动来:
-
通知他们的用户已创建新的互动。
-
触发自动化工作流程,例如更新 CRM 系统或通知销售团队有关新增互动的信息。
以下示例显示了典型的互动创建事件。
{ "version": "0", "id": "01234567-0123-0123-0123-0123456789ab", "detail-type": "Engagement Created", "source": "aws.partnercentral-selling", "account": "123456789012", "time": "2023-04-18T18:20:15Z", "region": "us-east-1", "resources": [ "arn:aws:partnercentral:us-east-1::catalog/AWS/engagement/eng-567a1j5hxp35lo" ], "detail": { "catalog": "AWS", "engagement": { "engagementArn": "arn:aws:partnercentral:us-east-1::catalog/AWS/engagement/eng-567a1j5hxp35lo", "engagementId": "eng-567a1j5hxp35lo", "CreatedAt": "2023-04-18T18:20:15Z", "CreatedBy": "aws", "ContextTypes": ["Lead"] } } }
参与度已更新
合作伙伴利用此活动来:
-
通知其用户现有互动已更新。
-
触发自动化工作流程,例如更新 CRM 系统或通知销售团队。
以下示例显示了典型的互动更新事件。
{ "version": "0", "id": "01234567-0123-0123-0123-0123456789ab", "detail-type": "Engagement Updated", "source": "aws.partnercentral-selling", "account": "123456789012", "time": "2023-04-18T18:20:15Z", "region": "us-east-1", "resources": [ "arn:aws:partnercentral:us-east-1::catalog/AWS/engagement/eng-567a1j5hxp35lo" ], "detail": { "catalog": "AWS", "engagement": { "engagementArn": "arn:aws:partnercentral:us-east-1::catalog/AWS/engagement/eng-567a1j5hxp35lo", "engagementId": "eng-567a1j5hxp35lo", "LastModifiedAt": "2023-04-18T18:20:15Z", "LastModifiedBy": "aws", "ContextTypes": ["Lead", "CustomerProject"] } } }