AWS パートナーセントラル API リファレンスが再構築されました。サポートされている API オペレーションの詳細については、 [AWS パートナーセントラル API リファレンス](https://docs.aws.amazon.com/partner-central/latest/APIReference/Welcome.html)を参照してください。
翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
# AWS Partner Central Benefits API の通知
Benefits Service は、 BenefitApplications と BenefitAllocations の両方の EventBridge イベントを提供します。これらのイベントにより、お客様は、最初のアプリケーションから割り当て、最終的なフルフィルメントまで、リソースのライフサイクル全体で変更に対応する包括的なイベント駆動型アーキテクチャを構築できます。
**Topics**
+ [イベントをモニタリングするための前提条件を満たす](#events-prerequites)
+ [イベントをモニタリングするように Amazon EventBridge を設定する](#eventbridge-setup)
+ [メリット API イベントの詳細](#learn-about-events)
## イベントをモニタリングするための前提条件を満たす
ユーザーは、メリット API によって発行されたイベントにアクセスして管理するための適切な IAM アクセス許可が必要です。EventBridge で使用できるアクション、リソース、および条件キーの詳細については、[「Amazon EventBridge ユーザーガイド」の「Amazon EventBridge での IAM ポリシー条件](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-use-conditions.html#events-pattern-detail-type)*EventBridge*」を参照してください。条件キーの 1 つは です。これは`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またはAWS SDKs を使用して、ルールを作成および管理できます。以下のセクションでは、両方の方法を使用してルールを作成する方法について説明します。使用する方法にかかわらず、米国東部 (バージニア北部) `us-east-1`リージョンでルールを作成する必要があります。
### AWS Management Consoleセットアップ
を使用して EventBridge ルールを設定するにはAWS Management Console、[「Amazon EventBridge ユーザーガイド」の「Amazon EventBridge のイベントに対応するルールの作成](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-create-rule.html)*EventBridge*」の手順に従います。ルールを作成するときは、イベントバスを**デフォルト**に設定し、米国東部 (バージニア北部) `us-east-1`リージョンでルールを作成する必要があります。
イベントルールの例を次に示します。
```
{
"source": ["aws.partnercentral-benefits"],
"detail": {
"catalog": ["AWS"]
}
}
```
### AWS SDK のセットアップ
AWS SDKs を使用して、プログラムで EventBridge ルールを作成および管理できます。詳細については、「*Amazon EventBridge API リファレンス*」の「[PutRule](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutRule.html)」を参照してください。
次の例では、AWS SDK for Python (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 イベントタイプ、イベントをトリガーするシナリオ、およびイベント例について説明します。
### イベントタイプ
以下は、イベントタイプとそのトリガーです。
#### メリットアプリケーション
+ [メリットアプリケーションの作成](#benefit-application-created): メリットアプリケーションの作成時
+ [レビュー中のメリットアプリケーション](#benefit-application-in-review): メリットアプリケーションが送信されるか、アプリケーションが「必要なアクション」から「レビュー中」に移行すると、このイベントがトリガーされます。
+ [メリットアプリケーションアクションが必要](#benefit-application-action-required): このイベントは、内部レビューワーがアプリケーションステータスを更新して、レビューを続行する前にパートナーが追加情報、明確化、または変更を提供する必要があることを示す場合に発生します。
+ [メリットアプリケーションの拒否](#benefit-application-rejected): このイベントは、内部レビューワーがアプリケーションのステータスを更新して、アプリケーションがメリットの基準または要件を満たしておらず、拒否されたことを示す場合に発生します。
+ [メリットアプリケーション承認済み](#benefit-application-approved): このイベントは、内部レビューワーがアプリケーションのステータスを更新して、アプリケーションがメリット配分のために承認されたことを示す場合に発生します。
+ [メリットアプリケーションステージの変更](#benefit-application-stage-changed): このイベントは、ビジネスレビュー、AWSレビュー、財務レビューなどのレビュープロセス中に内部レビューワーがアプリケーションのステージを更新したときに発生します。
#### メリット配分
+ [メリット配分のアクティブ化](#benefit-allocation-activated): メリット配分が作成または内部サービスによってアクティブ化された に更新された場合。
+ [メリット配分が無効:](#benefit-allocation-inactivated) このイベントは、内部レビューワーが配分ステータスを更新するか、メリット配分が自動的に期限切れになったときに発生します。
+ [メリット配分達成](#benefit-allocation-fulfilled): このイベントは、内部レビューワーが配分ステータスを更新して、配分が完全に使用されたことを示す場合に発生します。
### イベントの例
以下のセクションでは、前のセクションで示したイベントの例を示します。
**Topics**
+ [作成されたメリットアプリケーション](#benefit-application-created)
+ [レビュー中の利点アプリケーション](#benefit-application-in-review)
+ [メリットアプリケーションアクションが必要](#benefit-application-action-required)
+ [メリットアプリケーションが拒否されました](#benefit-application-rejected)
+ [特典アプリケーションが承認されました](#benefit-application-approved)
+ [メリットアプリケーションステージが変更されました](#benefit-application-stage-changed)
+ [メリット配分がアクティブ化されました](#benefit-allocation-activated)
+ [メリット配分が非アクティブ化されました](#benefit-allocation-inactivated)
+ [メリット配分を達成](#benefit-allocation-fulfilled)
#### 作成されたメリットアプリケーション
##### トリガーコンテキスト
Benefit Application Created イベントは、Benefit Service を通じて新しい Benefit アプリケーションが正常に作成されたときに Amazon 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"]
}
}
}
```
#### レビュー中の利点アプリケーション
##### トリガーコンテキスト
Benefit Application In Review イベントは、Benefit Service を通じて Benefit Application が IN\_REVIEW ステータスに移行したときに Amazon 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"]
}
}
}
```
#### メリットアプリケーションアクションが必要
##### トリガーコンテキスト
Benefit Application Action Required イベントは、Benefit Service を通じて Benefit Application が ACTION\_REQUIRED ステータスに移行したときに Amazon 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"]
}
}
}
```
#### メリットアプリケーションが拒否されました
##### トリガーコンテキスト
Benefit Application Rejected イベントは、Benefit Service を通じて Benefit Application が REJECTED ステータスに移行したときに Amazon 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"]
}
}
}
```
#### 特典アプリケーションが承認されました
##### トリガーコンテキスト
Benefit Application Approved イベントは、Benefit Service を通じて Benefit Application が APPROVED ステータスに移行したときに Amazon 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"]
}
}
}
```
#### メリットアプリケーションステージが変更されました
##### トリガーコンテキスト
Benefit Application Stage Changed イベントは、Benefit Service を通じて Benefit Application のレビューステージが更新されると、Amazon EventBridge に発行されます。このイベントは、内部レビューワーがアプリケーションのステージを可能な列挙値 (FINANCE\_REVIEW、BUSINESS\_REVIEW、TECH\_REVIEW、AWS\_REVIEW) のいずれかに更新したときに発生します。
ステータスの変更とは異なり、ステージの変更は読み取り専用の情報更新であり、パートナーアクションを必要とせずに内部レビューワークフローの進行状況を可視化できます。
##### 受取人
所有アカウントは、メリット配分のイベントを受け取ります。
##### 例
```
{
"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"]
}
}
}
```
#### メリット配分がアクティブ化されました
##### トリガーコンテキスト
メリット配分がアクティブ化されたイベントは、メリット配分が Benefits Service を通じて ACTIVE ステータスに移行したときに Amazon EventBridge に発行されます。このイベントは、内部レビューワーが 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"]
}
}
}
```
#### メリット配分が非アクティブ化されました
##### トリガーコンテキスト
メリット配分の非アクティブ化イベントは、メリット配分が Benefits Service を通じて INACTIVE ステータスに移行したときに Amazon EventBridge に発行されます。このイベントは、内部レビューワーが 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"]
}
}
}
```
#### メリット配分を達成
##### トリガーコンテキスト
Benefit Allocation Fulfilled イベントは、Benefit Service を通じて Benefit Allocation が FULFILLED ステータスに移行したときに Amazon EventBridge に発行されます。このイベントは、内部レビューワーが 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"]
}
}
}
```