View a markdown version of this page

的通知AWS合作伙伴中心权益 API - AWS 合作伙伴中心

AWS 合作伙伴中心 API 参考已重新构建。有关支持的 API 操作的更多信息,请参阅 AWS 合作伙伴中心 API 参考

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

的通知AWS合作伙伴中心权益 API

福利服务为两者提供 EventBridge BenefitApplications 活动 BenefitAllocations。这些事件使客户能够构建全面的事件驱动架构,以响应整个资源生命周期中的变化,从最初的应用程序到分配再到最终的执行。

完成监控事件的先决条件

用户需要相应的 IAM 权限才能访问和管理由福利 API 发布的事件。有关可用操作、资源和条件键的更多信息 EventBridge,请参阅亚马逊 EventBridge 用户指南中的在亚马逊 EventBridge中使用 IAM 策略条件。其中一个条件键是events:detail-type,它可用于将权限范围限定为特定事件类型。

以下示例策略演示了如何自定义和限定建议事件的权限范围。该AllowPutRuleForPartnercentralBenefitsEvents语句允许创建规则,但仅适用于来自aws.partnercentral-benefits源的事件。

有关详细的 IAM 策略示例,请参阅有关 EventBridge 权限的 AWS 文档。

{ "Version": "2012-10-17", "Statement": [ { "Sid": "AllowPutRuleForPartnerCentralBenefitsEvents", "Effect": "Allow", "Action": "events:PutRule", "Resource": "*", "Condition": { "StringEquals": { "events:source": "aws.partnercentral-benefits" } } } ] }

将 Amazon 配置 EventBridge 为监控事件

要监控福利 API 事件,您需要创建一个与要捕获的事件相匹配的 EventBridge 规则。您可以使用AWS Management Console或 S AWS DK 来创建和管理规则。以下各节说明如何使用这两种方法创建规则。无论使用哪种方法,都必须在美国东部(弗吉尼亚北部)us-east-1地区创建规则。

AWS Management Console设置

要使用设置 EventBridge 规则AWS Management Console,请按照《亚马逊 EventBridge 用户指南》中创建响应亚马逊事件的规则 EventBridge中的步骤进行操作。创建规则时,必须将事件总线设置为默认值,并在美国东部(弗吉尼亚北部)us-east-1区域创建规则。

以下是事件规则的示例:

{ "source": ["aws.partnercentral-benefits"], "detail": { "catalog": ["AWS"] } }

AWS软件开发工具包设置

您可以使用AWS软件开发工具包以编程方式创建和管理 EventBridge 规则。有关更多信息,请参阅 Amazon EventBridge API 参考PutRule中的。

以下示例使用适用于 Python 的AWS SDK (Boto3):

import boto3 client = boto3.client('events', region_name='us-east-1') response = client.put_rule( Name='MyBenefitApplicationCreatedRule', EventPattern= '{ "source": ["aws.partnercentral-benefits"], "detail-type": ["Benefit Application Created"], "detail": {"catalog": ["AWS"]} }', State='ENABLED' ) print('Rule ARN:', response['RuleArn'])

详细了解福利 API 事件

以下各节描述了 API 事件类型的好处、触发它们的场景以及事件示例。

事件类型

以下是事件类型及其触发器。

福利申请

  • 福利申请已创建:何时创建福利申请

  • 福利申请正在审核中:当福利申请提交或申请从 “需要采取行动” 转换回审中时,将触发此事件。

  • 需要采取福利申请行动:当内部审核者更新申请状态以表明合作伙伴需要提供其他信息、澄清或修改才能继续审核时,就会发生此事件。

  • 福利申请被拒绝:当内部审核者更新申请状态以表明该申请不符合福利标准或要求并已被拒绝时,就会发生此事件

  • 福利申请已批准:当内部审核者更新申请状态以表明该申请已获得福利分配批准时,就会发生此事件。

  • 福利申请阶段已更改:当内部审核者在业务审查、AWS审核、财务审查等审核过程中更新申请阶段时,就会发生此事件。

福利分配

  • 福利分配已激活:当福利分配创建或更新为由内部服务激活时。

  • 福利分配已停用:当内部审核者更新分配状态或福利分配自动到期时,就会发生此事件。

  • 福利分配已完成:当内部审核者更新分配状态以表明分配已被完全利用时,就会发生此事件。

示例事件

以下各节提供了前面部分中列出的事件的示例。

福利申请已创建

触发上下文

当通过福利服务成功创建新的福利申请 EventBridge 时,“福利申请已创建” 事件将发布到亚马逊。当 CreateBenefitApplication API 调用成功完成时,会发生此事件,表示合作伙伴已发起特定权益的申请。

此事件代表福利申请生命周期的开始,当向客户提交新申请时,该事件会立即通知客户。

收件人

拥有者的账户将收到福利分配的活动。

示例
{ "id": "7gh88765-k0jh-d08g-i292-2ff1796m030n", "detail-type": "Benefit Application Created", "source": "aws.partnercentral-benefits", "account": "123456789012", "time": "2025-02-10T15:45:00Z", "region": "us-east-1", "resources": [ "arn:aws:partnercentral:us-east-1:123456789012:benefit-application/benappl-12345abcdef123" ], "detail": { "catalog": "AWS", "benefitApplication": { "id": "benappl-12345abcdef123", "fulfillmentTypes": ["CREDITS"], "status": "PENDING_SUBMISSION", "revision": "hh7e8400-e29b-41d4-a716-446655440012" }, "benefit": { "id": "ben-xyz789uvw012", "name": "AWS Partner Credits", "program": ["AWS Partner Network"] } } }

福利申请正在审核中

触发上下文

当福利申请通过福利服务转换为 IN_REVIEW 状态 EventBridge 时,“福利申请审核中” 事件将发布到亚马逊。在以下情况下会发生此事件:

  • 合作伙伴通过 SubmitBenefitApplication API 调用提交申请

  • 合作伙伴回复反馈后,应用程序将从 ACTION_REQUIRED 转换回 IN_REVIEW

  • 申请被撤回,然后重新提交

此事件表示该申请已进入正式审核流程,并且正在接受AWS内部团队的评估。

收件人

拥有者的账户将收到福利分配的活动。

示例
{ "id": "8hi99876-l1ki-e19h-j303-3gg2807n141o", "detail-type": "Benefit Application In Review", "source": "aws.partnercentral-benefits", "account": "123456789012", "time": "2025-02-10T16:00:00Z", "region": "us-east-1", "resources": [ "arn:aws:partnercentral:us-east-1:123456789012:benefit-application/benappl-12345abcdef123" ], "detail": { "catalog": "AWS", "benefitApplication": { "id": "benappl-12345abcdef123", "fulfillmentTypes": ["CREDITS"], "status": "IN_REVIEW", "stage": "BUSINESS_REVIEW", "revision": "ii8f9511-f30c-52e5-b827-557766551123" }, "benefit": { "id": "ben-xyz789uvw012", "name": "AWS Partner Credits", "program": ["AWS Partner Network"] } } }

需要采取福利申请行动

触发上下文

当福利申请通过福利服务转换为 ACTION_REQUIRED 状态 EventBridge 时,“需要福利申请操作” 事件就会发布到亚马逊。当内部审阅者通过 UpdateBenefitApplicationInternal API 更新申请状态以表明合作伙伴需要提供其他信息、澄清或修改才能继续审核时,就会发生此事件。

此事件代表了应用程序生命周期中的一个关键时刻,需要合作伙伴干预,以推动申请在审核过程中向前发展。

收件人

持有者账户将收到福利分配活动

示例
{ "id": "9ij00987-m2lj-f20i-k414-4hh3918o252p", "detail-type": "Benefit Application Action Required", "source": "aws.partnercentral-benefits", "account": "123456789012", "time": "2025-02-12T10:30:00Z", "region": "us-east-1", "resources": [ "arn:aws:partnercentral:us-east-1:123456789012:benefit-application/benappl-12345abcdef123" ], "detail": { "catalog": "AWS", "benefitApplication": { "id": "benappl-12345abcdef123", "fulfillmentTypes": ["CREDITS"], "status": "ACTION_REQUIRED", "stage": "BUSINESS_REVIEW", "revision": "jj9g0622-g41d-63f6-c938-668877662234" }, "benefit": { "id": "ben-xyz789uvw012", "name": "AWS Partner Credits", "program": ["AWS Partner Network"] } } }

福利申请被拒绝

触发上下文

当福利申请通过福利服务转换为 “已拒绝” 状态 EventBridge 时,“福利申请被拒绝” 事件将发布到亚马逊。当内部审阅者通过 UpdateBenefitApplicationInternal API 更新申请状态以表明该申请不符合福利标准或要求并已被拒绝时,就会发生此事件。

此事件表示应用程序生命周期中的一种终止状态,即申请已被正式拒绝,并且不会继续进行福利分配。

收件人

拥有者的账户将收到福利分配的活动。

示例
{ "id": "0kl11098-n3mk-g31j-l525-5ii4029p363q", "detail-type": "Benefit Application Rejected", "source": "aws.partnercentral-benefits", "account": "123456789012", "time": "2025-02-15T14:20:00Z", "region": "us-east-1", "resources": [ "arn:aws:partnercentral:us-east-1:123456789012:benefit-application/benappl-12345abcdef123" ], "detail": { "catalog": "AWS", "benefitApplication": { "id": "benappl-12345abcdef123", "fulfillmentTypes": ["CREDITS"], "status": "REJECTED", "revision": "kk0h1733-h52e-74g7-d049-779988773345" }, "benefit": { "id": "ben-xyz789uvw012", "name": "AWS Partner Credits", "program": ["AWS Partner Network"] } } }

福利申请已获批准

触发上下文

当福利申请通过福利服务转换为 “已批准” 状态 EventBridge 时,“福利申请已批准” 事件将发布到亚马逊。当内部审核者通过 UpdateBenefitApplicationInternal API 更新申请状态以表明该申请符合所有福利标准和要求并且已获得福利分配批准时,就会发生此事件。

此事件表示成功完成申请审核流程,通常会触发相应的福利分配的创建。

收件人

拥有者的账户将收到福利分配的活动。

示例
{ "id": "1lm22109-o4nl-h42k-m636-6jj5130q474r", "detail-type": "Benefit Application Approved", "source": "aws.partnercentral-benefits", "account": "123456789012", "time": "2025-02-14T16:45:00Z", "region": "us-east-1", "resources": [ "arn:aws:partnercentral:us-east-1:123456789012:benefit-application/benappl-12345abcdef123" ], "detail": { "catalog": "AWS", "benefitApplication": { "id": "benappl-12345abcdef123", "fulfillmentTypes": ["CREDITS"], "status": "APPROVED", "revision": "ll1i2844-i63f-85h8-e150-880099884456" }, "benefit": { "id": "ben-xyz789uvw012", "name": "AWS Partner Credits", "program": ["AWS Partner Network"] } } }

福利申请阶段已更改

触发上下文

当福利申请的审核阶段通过福利服务更新 EventBridge 时,“福利申请阶段已更改” 事件将发布到 Amazon。当内部审阅者将应用程序的阶段更新为可能的枚举值之一(FINANCE_REVIEW、BUSINESS_REVIEW、TECH_REVIEW 和 _REVIEW)时,就会发生此事件。AWS

与状态更改不同,阶段变更是只读的信息更新,无需合作伙伴采取任何措施即可查看内部审查工作流程的进展。

收件人

拥有者的账户将收到福利分配的活动。

示例
{ "id": "2mn33210-p5om-i53l-n747-7kk6241r585s", "detail-type": "Benefit Application Stage Changed", "source": "aws.partnercentral-benefits", "account": "123456789012", "time": "2025-02-13T11:15:00Z", "region": "us-east-1", "resources": [ "arn:aws:partnercentral:us-east-1:123456789012:benefit-application/benappl-12345abcdef123" ], "detail": { "catalog": "AWS", "benefitApplication": { "id": "benappl-12345abcdef123", "fulfillmentTypes": ["CREDITS"], "status": "IN_REVIEW", "stage": "FINANCIAL_REVIEW", "revision": "mm2j3955-j74g-96i9-f261-991100995567" }, "benefit": { "id": "ben-xyz789uvw012", "name": "AWS Partner Credits", "program": ["AWS Partner Network"] } } }

福利分配已激活

触发上下文

当福利分配通过福利服务转换为 “有效” 状态 EventBridge 时,“激活福利分配” 事件将发布给 Amazon。当内部审核者通过 UpdateBenefitAllocationInternal API 更新分配状态以重新激活之前处于非活动状态的分配时,就会发生此事件。

此事件通常发生在暂时停用(由于到期、政策变更或管理原因)的分配恢复为有效状态,从而使合作伙伴可以再次使用福利时。

收件人

属于合作伙伴的AWS账户将收到消息。换句话说,就是拥有资源的AWS账户。

示例事件
{ "id": "3no44321-q6pn-j64m-o858-8ll7352s696t", "detail-type": "Benefit Allocation Activated", "source": "aws.partnercentral-benefits", "account": "123456789012", "time": "2025-03-01T08:15:00Z", "region": "us-east-1", "resources": [ "arn:aws:partnercentral:us-east-1:123456789012:benefit-allocation/benalloc-abc123def456" ], "detail": { "catalog": "AWS", "benefitAllocation": { "id": "benalloc-abc123def456", "fulfillmentType": "CREDITS", "status": "ACTIVE" }, "benefitApplication": { "id": "benappl-12345abcdef123" }, "benefit": { "id": "ben-xyz789uvw012", "name": "AWS Partner Credits", "program": ["AWS Partner Network"] } } }

福利分配已停用

触发上下文

当福利分配通过福利服务转换为 “不活动” 状态 EventBridge 时,“福利分配失效” 事件将发布给 Amazon。当内部审核者通过 UpdateBenefitAllocationInternal API 更新分配状态或福利分配自动到期时,就会发生此事件。

此事件通常发生在分配被暂时暂停时(由于到期、政策变更、合规性问题或管理原因),使合作伙伴在重新激活之前无法使用这些权益。

收件人

属于合作伙伴的AWS账户将收到消息。换句话说,就是拥有资源的AWS账户。

示例事件
{ "id": "4op55432-r7qo-k75n-p969-9mm8463t707u", "detail-type": "Benefit Allocation Inactivated", "source": "aws.partnercentral-benefits", "account": "123456789012", "time": "2025-06-30T23:59:59Z", "region": "us-east-1", "resources": [ "arn:aws:partnercentral:us-east-1:123456789012:benefit-allocation/benalloc-abc123def456" ], "detail": { "catalog": "AWS", "benefitAllocation": { "id": "benalloc-abc123def456", "fulfillmentType": "CREDITS", "status": "INACTIVE" }, "benefitApplication": { "id": "benappl-12345abcdef123" }, "benefit": { "id": "ben-xyz789uvw012", "name": "AWS Partner Credits", "program": ["AWS Partner Network"] } } }

福利分配已完成

触发上下文

当福利分配通过福利服务转换为 “已发货” 状态 EventBridge 时,“福利分配已完成” 事件将发布给 Amazon。当内部审核者通过 UpdateBenefitAllocationInternal API 更新分配状态以表明分配已完全使用或福利条款已得到满足时,就会发生此事件。

此事件代表福利生命周期的结束,表示合作伙伴已成功利用分配的福利或分配已自然结束。

收件人

属于合作伙伴的AWS账户将收到消息。换句话说,就是拥有资源的AWS账户。

示例事件
{ "id": "5pq66543-s8rp-l86o-q070-0nn9574u818v", "detail-type": "Benefit Allocation Fulfilled", "source": "aws.partnercentral-benefits", "account": "123456789012", "time": "2025-12-15T17:30:00Z", "region": "us-east-1", "resources": [ "arn:aws:partnercentral:us-east-1:123456789012:benefit-allocation/benalloc-abc123def456" ], "detail": { "catalog": "AWS", "benefitAllocation": { "id": "benalloc-abc123def456", "fulfillmentType": "CREDITS", "status": "FULFILLED" }, "benefitApplication": { "id": "benappl-12345abcdef123" }, "benefit": { "id": "ben-xyz789uvw012", "name": "AWS Partner Credits", "program": ["AWS Partner Network"] } } }