View a markdown version of this page

Notifications pour AWS API Partner Central Benefits - AWS Partner Central
Remplissez le prérequis pour surveiller les événementsConfigurer Amazon EventBridge pour surveiller les événementsEn savoir plus sur les avantages et les événements liés à l'API

La référence AWS Partner Central d'API a été restructurée. Pour plus d'informations sur les opérations d'API prises en charge, consultez la référence des AWS Partner Central API.

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Notifications pour AWS API Partner Central Benefits

Le service des avantages sociaux propose EventBridge des événements pour les deux BenefitApplications et BenefitAllocations. Ces événements permettent aux clients de créer des architectures complètes axées sur les événements qui répondent aux changements tout au long du cycle de vie des ressources, de l'application initiale à l'allocation et à l'exécution finale.

Remplissez le prérequis pour surveiller les événements

Les utilisateurs doivent disposer des autorisations IAM appropriées pour accéder aux événements publiés par l'API Benefits et les gérer. Pour plus d'informations sur les actions, les ressources et les clés de condition disponibles pour EventBridge, consultez la section Utilisation des conditions de politique IAM sur Amazon EventBridge dans le guide de l' EventBridge utilisateur Amazon. L'une des clés de condition est events:detail-type celle qui peut être utilisée pour étendre les autorisations à des types d'événements spécifiques.

L'exemple de politique suivant montre comment personnaliser et définir l'étendue des autorisations pour les événements proposés. L'AllowPutRuleForPartnercentralBenefitsEventsinstruction permet de créer des règles, mais uniquement pour les événements provenant de la aws.partnercentral-benefits source.

Pour obtenir des exemples détaillés de politique IAM, consultez la documentation AWS sur EventBridge les autorisations.

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

Configurer Amazon EventBridge pour surveiller les événements

Pour surveiller les événements de l'API des avantages, vous créez une EventBridge règle qui correspond aux événements que vous souhaitez capturer. Vous pouvez utiliser le AWS Management Console ou les AWS SDK pour créer et gérer des règles. Les sections suivantes expliquent comment créer des règles à l'aide des deux méthodes. Quelle que soit la méthode que vous utilisez, vous devez créer la règle dans la us-east-1 région USA Est (Virginie du Nord).

AWS Management Console configuration

Pour configurer une EventBridge règle à l'aide du AWS Management Console, suivez les étapes décrites dans la section Création de règles réagissant aux événements survenus sur Amazon EventBridge dans le guide de EventBridge l'utilisateur Amazon. Lors de la création de la règle, vous devez définir le bus d'événements par défaut et créer la règle dans la us-east-1 région USA Est (Virginie du Nord).

Voici un exemple de règle d'événement :

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

AWS Configuration du SDK

Vous pouvez utiliser les AWS SDK pour créer et gérer des EventBridge règles par programmation. Pour plus d'informations, consultez PutRulele Amazon EventBridge API Reference.

L'exemple suivant utilise le AWS SDK pour 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'])

En savoir plus sur les avantages et les événements liés à l'API

Les sections suivantes décrivent les avantages, les types d'événements de l'API, les scénarios qui les déclenchent et des exemples d'événements.

Types d’événements

Vous trouverez ci-dessous les types d'événements et leurs déclencheurs.

Demandes de prestations

  • Demande de prestations créée : Quand une demande de prestations est créée

  • Demande de prestations en cours d'examen : lorsqu'une demande de prestations est soumise ou lorsque la demande passe du statut Action requise à En cours d'examen, cet événement est déclenché.

  • Action requise pour la demande de prestations : Cet événement se produit lorsqu'un réviseur interne met à jour le statut de la demande pour indiquer que le partenaire doit fournir des informations supplémentaires, des éclaircissements ou des modifications avant que l'examen ne puisse se poursuivre.

  • Demande d'avantages rejetée : cet événement se produit lorsqu'un réviseur interne met à jour le statut de la demande pour indiquer que la demande ne répond pas aux critères ou aux exigences en matière de prestations et qu'elle a été refusée

  • Demande d'avantages approuvée : Cet événement se produit lorsqu'un réviseur interne met à jour le statut de la demande pour indiquer que la demande a été approuvée pour l'attribution des avantages.

  • Modification de l'étape de la demande de prestations : Cet événement se produit lorsqu'un réviseur interne met à jour l'étape de la demande au cours de processus de révision tels que l'examen commercial, l'examen, l'examen financier, etc.AWS

Répartition des avantages

  • Allocation d'avantages activée : lorsqu'une allocation d'avantages est créée ou mise à jour pour revenir à Activée par un service interne.

  • Allocation d'avantages désactivée : Cet événement se produit lorsqu'un réviseur interne met à jour le statut d'allocation ou lorsqu'une allocation d'avantages expire automatiquement.

  • Affectation des avantages exécutée : Cet événement se produit lorsqu'un réviseur interne met à jour le statut de l'allocation pour indiquer que l'allocation a été entièrement utilisée.

Exemples d’événements

Les sections suivantes fournissent des exemples des événements répertoriés précédemment dans la section précédente.

Demande de prestations créée

Contexte de déclenchement

L'événement Benefit Application Created est publié sur Amazon EventBridge lorsqu'une nouvelle demande de prestations est créée avec succès via le Benefits Service. Cet événement se produit lorsque l'appel d' CreateBenefitApplication API aboutit, indiquant qu'un partenaire a lancé une demande pour un avantage spécifique.

Cet événement marque le début du cycle de vie des demandes d'avantages sociaux et fournit aux clients une notification immédiate lorsque de nouvelles demandes sont soumises sur leur compte.

Destinataires

Le compte propriétaire recevra l'événement pour l'allocation des avantages.

Exemple
{
  "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"]
    }
  }
}

Demande de prestations en cours d'examen

Contexte de déclenchement

L'événement Benefit Application In Review est publié sur Amazon EventBridge lorsqu'une demande d'avantages passe au statut IN_REVIEW via le service Benefits. Cet événement se produit lorsque :

  • Un partenaire soumet sa candidature via l'appel SubmitBenefitApplication d'API

  • Une application passe de ACTION_REQUIRED à IN_REVIEW une fois que le partenaire a répondu aux commentaires

  • Une demande est rappelée puis soumise à nouveau

Cet événement indique que la demande est entrée dans le processus d'examen officiel et qu'elle est en cours d'évaluation par des équipes AWS internes.

Destinataires

Le compte propriétaire recevra l'événement pour l'allocation des avantages.

Exemple
{
  "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 requise pour présenter une demande de prestations

Contexte de déclenchement

L'événement Action Required Benefit Application est publié sur Amazon EventBridge lorsqu'une demande de prestations passe au statut ACTION_REQUIRED via le service Benefits. Cet événement se produit lorsqu'un réviseur interne met à jour le statut de la demande via l' UpdateBenefitApplicationInternal API pour indiquer que le partenaire doit fournir des informations supplémentaires, des éclaircissements ou des modifications avant que l'examen ne puisse se poursuivre.

Cet événement représente un point critique du cycle de vie de la demande où l'intervention d'un partenaire est nécessaire pour faire avancer la demande dans le processus d'évaluation.

Destinataires

Le compte propriétaire recevra l'événement pour l'allocation des avantages

Exemple
{
  "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"]
    }
  }
}

Demande de prestations rejetée

Contexte de déclenchement

L'événement Rejeté de la demande de prestations est publié sur Amazon EventBridge lorsqu'une demande d'avantages passe au statut REJETÉE via le Service des avantages. Cet événement se produit lorsqu'un réviseur interne met à jour le statut de la demande via l' UpdateBenefitApplicationInternal API pour indiquer que la demande ne répond pas aux critères ou aux exigences en matière d'avantages et qu'elle a été refusée.

Cet événement représente un état terminal du cycle de vie de l'application, dans lequel celle-ci a été officiellement refusée et ne sera pas affectée à l'allocation des avantages.

Destinataires

Le compte propriétaire recevra l'événement pour l'allocation des avantages.

Exemple
{
  "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"]
    }
  }
}

Demande de prestations approuvée

Contexte de déclenchement

L'événement Approved Benefits Application est publié sur Amazon EventBridge lorsqu'une demande d'avantages passe au statut APPROUVÉE via le Service des avantages. Cet événement se produit lorsqu'un réviseur interne met à jour le statut de la demande via l' UpdateBenefitApplicationInternal API pour indiquer que la demande répond à tous les critères et exigences en matière d'avantages et que l'attribution des avantages a été approuvée.

Cet événement représente la réussite du processus d'examen des demandes et déclenche généralement la création d'une allocation d'avantages correspondante.

Destinataires

Le compte propriétaire recevra l'événement pour l'allocation des avantages.

Exemple
{
  "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"]
    }
  }
}

Modification de l'étape de demande de prestations

Contexte de déclenchement

L'événement Benefit Application Stage Changed est publié sur Amazon EventBridge lorsque l'étape de révision d'une demande de prestations est mise à jour via le service Benefits. Cet événement se produit lorsqu'un réviseur interne met à jour le stade de l'application avec l'une des valeurs Enum possibles (FINANCE_REVIEW, BUSINESS_REVIEW, TECH_REVIEW et _REVIEW).AWS

Contrairement aux changements de statut, les changements d'étape sont des mises à jour informatives en lecture seule qui fournissent une visibilité sur la progression du flux de travail de révision interne sans que l'intervention du partenaire ne soit nécessaire.

Destinataires

Le compte propriétaire recevra l'événement pour l'allocation des avantages.

Exemple
{
  "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"]
    }
  }
}

Affectation des avantages activée

Contexte de déclenchement

L'événement Benefit Allocation Activated est publié sur Amazon EventBridge lorsqu'une allocation d'avantages passe au statut ACTIF via le service Benefits. Cet événement se produit lorsqu'un réviseur interne met à jour le statut de l'allocation via l' UpdateBenefitAllocationInternal API pour réactiver une allocation précédemment inactive.

Cet événement se produit généralement lorsqu'une allocation temporairement inactivée (en raison d'une expiration, de modifications de politique ou pour des raisons administratives) redevient active, ce qui permet aux partenaires d'utiliser à nouveau les avantages.

Destinataires

Le AWS compte appartenant au partenaire recevra le message. En d'autres termes, le AWS compte propriétaire de la ressource.

Exemple d'événement
{  
  "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"]
    }
  }
}

Répartition des avantages désactivée

Contexte de déclenchement

L'événement Inactivation de l'allocation d'avantages est publié sur Amazon EventBridge lorsqu'une allocation d'avantages passe au statut INACTIF via le service Benefits. Cet événement se produit lorsqu'un réviseur interne met à jour le statut de l'allocation via l' UpdateBenefitAllocationInternal API ou lorsqu'une allocation d'avantages expire automatiquement.

Cet événement se produit généralement lorsqu'une allocation est temporairement suspendue (en raison d'une expiration, de modifications de politique, de problèmes de conformité ou pour des raisons administratives), rendant les avantages inutilisables par les partenaires jusqu'à ce qu'ils soient réactivés.

Destinataires

Le AWS compte appartenant au partenaire recevra le message. En d'autres termes, le AWS compte propriétaire de la ressource.

Exemple d'événement
{  
  "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"]
    }
  }
}

Répartition des avantages réalisée

Contexte de déclenchement

L'événement Benefit Allocation Fulfilled est publié sur Amazon EventBridge lorsqu'une allocation d'avantages passe au statut FULFILLED via le service Benefits. Cet événement se produit lorsqu'un réviseur interne met à jour le statut de l'allocation via l' UpdateBenefitAllocationInternal API pour indiquer que l'allocation a été complètement utilisée ou que les conditions des avantages ont été satisfaites.

Cet événement représente la fin du cycle de vie des avantages, indiquant que le partenaire a utilisé avec succès l'avantage alloué ou que l'allocation a atteint son terme naturel.

Destinataires

Le AWS compte appartenant au partenaire recevra le message. En d'autres termes, le AWS compte propriétaire de la ressource.

Exemple d'événement
{  
  "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"]
    }
  }
}