Création d'une subvention de données sur AWS Data Exchange contenant des API

Ajoutez la politique suivante à la politique de ressources de votre API :

{
"Effect": "Allow",
"Principal": {"Service": "dataexchange.amazonaws.com"},
"Action": "execute-api:Invoke",
"Resource": "*",
"Condition": {"StringEquals": {"aws:SourceAccount": "<account-id>"}}
}

account-idRemplacez-le par le compte qui créera l'ensemble de données d'API.

Le compte contenant la ressource API Gateway n'a pas besoin d'appartenir au même compte que celui qui crée l'ensemble de données.

Ouvrez votre navigateur Web et connectez-vous à la AWS Data Exchange console.

Dans le volet de navigation de gauche, sous Mes données, sélectionnez Ensembles de données détenus.

Dans Ensembles de données détenus, choisissez Créer un ensemble de données pour ouvrir l'assistant Étapes de création d'un ensemble de données.

Dans Sélectionnez le type d'ensemble de données, choisissez l'API Amazon API Gateway.

Dans Définir un ensemble de données, entrez un nom et une description pour votre ensemble de données. Pour de plus amples informations, veuillez consulter Meilleures pratiques en matière d'ensembles de données.

(Facultatif) Sous Ajouter des balises — facultatif, ajoutez des balises.

Choisissez Créer.

Utilisez la create-data-set commande pour créer un ensemble de données d'API :

$ AWS dataexchange create-data-set \
-\\-asset-type API_GATEWAY_API \
-\\-description 'Data Set Description' \
-\\-name 'Data Set Name'

{
"Arn": "arn:aws:dataexchange:us-east-1:123456789012:data-sets/$DATA_SET_ID",
"AssetType": "API_GATEWAY_API",
"CreatedAt": "2021-09-11T00:16:46.349000+00:00",
"Description": "Data Set Description",
"Id": "$DATA_SET_ID",
"Name": "Data Set Name",
"Origin": "OWNED",
"UpdatedAt": "2021-09-11T00:16:46.349000+00:00"
}

Notez le nouveau type d'actif deAPI_GATEWAY_API.

Dans la section Présentation de l'ensemble de données de la page des détails de l'ensemble de données :

1. (Facultatif) Choisissez Modifier le nom pour modifier les informations relatives à votre ensemble de données.

2. (Facultatif) Choisissez Supprimer pour supprimer l'ensemble de données.

Dans la section Révisions, choisissez Créer une révision.

Sous Définir la révision, fournissez un commentaire facultatif pour votre révision qui décrit l'objectif de la révision.

(Facultatif) Sous Ajouter des balises — facultatif, ajoutez des balises associées à la ressource.

Choisissez Créer une révision.

Vérifiez, modifiez ou supprimez les modifications apportées à l'étape précédente.

Utilisez la create-revision commande pour créer une révision :

$ AWS dataexchange create-revision \
-\\-data-set-id $DATA_SET_ID \
-\\-comment 'First Atlas Revision'
{
"Arn": "arn:aws:dataexchange:us-east-1:123456789012:data-sets/$DATA_SET_ID/revisions/$REVISION_ID",
"Comment": "First Atlas Revision",
"CreatedAt": "2021-09-11T00:18:49.160000+00:00",
"DataSetId": "$DATA_SET_ID",
"Finalized": false,
"Id": "$REVISION_ID",
"UpdatedAt": "2021-09-11T00:18:49.160000+00:00"
}

Ajoutez les actifs de l'API à la révision.

Dans la section Ressources d'API de la page de détails de l'ensemble de données, choisissez Ajouter une étape d'API.

Dans Sélectionner un stage d'API, pour l'API Amazon API Gateway, entrez une API dans la zone de saisie ou choisissez l'une des options suivantes dans la liste déroulante :

1. Si vous avez choisi API dans un autre Compte AWS, entrez l'ID de l'API et le nom de l'étape de l'API dans les zones de saisie.

2. Si vous avez choisi Dans cette option Compte AWS, choisissez le nom de l'étape de l'API dans la liste déroulante

Dans Configuration avancée — facultatif, vous pouvez choisir de connecter le plan d'utilisation Amazon API Gateway existant pour utiliser les limites de limitation et de quota définies dans le plan d'utilisation existant, puis saisir la clé API.

Sous Document API pour les abonnés, fournissez des informations sur l'API que les destinataires verront une fois qu'ils auront accepté l'attribution des données.

1. Dans le champ Nom de l'API, entrez un nom que les destinataires peuvent utiliser pour identifier l'actif de l'API.

   Note

   Si un champ In Compte AWS est sélectionné, le nom de l'API est automatiquement renseigné et vous pouvez le modifier si nécessaire.

   Si une API Compte AWS a été sélectionnée dans une autre API, le nom de l'API est renseigné avec un nom par défaut, que vous devez modifier pour que le destinataire puisse facilement comprendre de quoi il s'agit.

2. Pour la spécification OpenAPI 3.0, soit :

   1. Entrez ou copiez et collez le fichier de spécification OpenAPI 3.0.

   2. Choisissez Importer depuis un fichier .JSON, puis sélectionnez le fichier .json à importer depuis votre ordinateur local.

      La spécification importée apparaît dans la boîte.

   3. Choisissez Importer depuis Amazon API Gateway, puis choisissez une spécification à importer.

      La spécification importée apparaît dans la boîte.

3. Pour la documentation supplémentaire (facultatif), entrez toute information supplémentaire utile à l'abonné à propos de votre API. Markdown est pris en charge.

Choisissez Ajouter une étape d'API.

Une tâche est lancée pour importer votre actif (dans ce cas, l'API) dans votre ensemble de données.

Une fois la tâche terminée, le champ État de la section Tâches est mis à jour et devient Terminé.

Si vous avez d'autres API à ajouter, répétez l'étape 2.

Sous Aperçu des révisions, passez en revue votre révision et ses actifs.

Choisissez Finaliser.

Utilisez la create-job commande pour ajouter des actifs d'API à la révision :

$ AWS dataexchange create-job \
  -\\-type IMPORT_ASSET_FROM_API_GATEWAY_API \
  -\\-details '{"ImportAssetFromApiGatewayApi":{"DataSetId":"$DATA_SET_ID","RevisionId":"$REVISION_ID","ApiId":"$API_ID","Stage":"$API_STAGE","ProtocolType":"REST"}}'
{
    "Arn": "arn:aws:dataexchange:us-east-1:123456789012:jobs/$JOB_ID",
    "CreatedAt": "2021-09-11T00:38:19.875000+00:00",
    "Details": {
        "ImportAssetFromApiGatewayApi": {
            "ApiId": "$API_ID",
            "DataSetId": "$DATA_SET_ID",
            "ProtocolType": "REST",
            "RevisionId": "$REVISION_ID",
            "Stage": "$API_STAGE"
        }
    },
    "Id": "$JOB_ID",
    "State": "WAITING",
    "Type": "IMPORT_ASSET_FROM_API_GATEWAY_API",
    "UpdatedAt": "2021-09-11T00:38:19.875000+00:00"
}

$ AWS dataexchange start-job -\\-job-id $JOB_ID
$ AWS dataexchange get-job -\\-job-id $JOB_ID
{
    "Arn": "arn:aws:dataexchange:us-east-1:0123456789012:jobs/$JOB_ID",
    "CreatedAt": "2021-09-11T00:38:19.875000+00:00",
    "Details": {
        "ImportAssetFromApiGatewayApi": {
            "ApiId": "$API_ID",
            "DataSetId": "$DATA_SET_ID",
            "ProtocolType": "REST",
            "RevisionId": "$REVISION_ID",
            "Stage": "$API_STAGE"
            "ApiEndpoint": "string",
            "ApiKey": "string",
            "ApiName": "string",            
            "ApiDescription": "string",
            "ApiSpecificationDownloadUrl": "string",
            "ApiSpecificationDownloadUrlExpiresAt": "string"
        }
    },
    "Id": "$JOB_ID",
    "State": "COMPLETED",
    "Type": "IMPORT_ASSET_FROM_API_GATEWAY_API",
    "UpdatedAt": "2021-09-11T00:38:52.538000+00:00"
}

Utilisez la list-revision-assets commande pour confirmer que la nouvelle ressource a été créée correctement :

$ AWS dataexchange list-revision-assets \
  -\\-data-set-id $DATA_SET_ID \
  -\\-revision-id $REVISION_ID
{
    "Assets": [
    {
        "Arn": "arn:aws:dataexchange:us-east-1:123456789012:data-sets/$DATA_SET_ID/revisions/$REVISION_ID/assets/$ASSET_ID",
        "AssetDetails": {
            "ApiGatewayApiAsset": {
                "ApiEndpoint": "https://$API_ID.execute-api.us-east-1.amazonaws.com/$API_STAGE",
                "ApiId": "$API_ID",
                "ProtocolType": "REST",
                "Stage": "$API_STAGE"
            }
        },
        "AssetType": "API_GATEWAY_API",
        "CreatedAt": "2021-09-11T00:38:52.457000+00:00",
        "DataSetId": "$DATA_SET_ID",
        "Id": "$ASSET_ID",
        "Name": "$ASSET_ID/$API_STAGE",
        "RevisionId": "$REVISION_ID",
        "UpdatedAt": "2021-09-11T00:38:52.457000+00:00"
    }
    ]
}

Dans la vue d'ensemble des révisions, choisissez De-finalize.

Un message s'affiche indiquant que la révision n'est plus à l'état finalisé.

Pour modifier la révision, dans Aperçu des révisions, choisissez Actions, puis Modifier.

Apportez vos modifications, puis choisissez Mettre à jour.

Passez en revue vos modifications, puis choisissez Finaliser.

Dans la vue d'ensemble des révisions, choisissez Supprimer.

Tapez Delete dans la boîte de dialogue Supprimer la révision, puis choisissez Supprimer.

Dans le volet de navigation de gauche de la AWS Data Exchange console, sous Accordations de données échangées, sélectionnez Autorisations de données envoyées.

Dans Autorisations de données envoyées, choisissez Créer une autorisation de données pour ouvrir l'assistant de définition de l'autorisation de données.

Dans la section Sélectionner l'ensemble de données détenu, cochez la case à côté de l'ensemble de données que vous souhaitez ajouter.

Dans la section Aperçu de la subvention, entrez les informations que le destinataire verra concernant votre autorisation de données, y compris le nom de la subvention de données et la description de la subvention de données.

Choisissez Suivant.

Dans la section Informations d'accès du destinataire, sous Compte AWS ID, entrez l' Compte AWS ID du compte destinataire qui doit recevoir l'autorisation de données.

De plus, dans la section Informations d'accès du destinataire, sous Date de fin d'accès, choisissez si l'octroi des données doit être perpétuel, en sélectionnant Aucune date de fin, ou s'il doit avoir une date de fin, en sélectionnant Date de fin spécifique et en choisissant la date de fin souhaitée.

Choisissez Suivant.

Dans la section Réviser et envoyer, passez en revue les informations relatives à l'octroi de vos données.

Si vous êtes sûr de vouloir créer l'autorisation de données et l'envoyer au destinataire choisi, choisissez Créer et envoyer l'autorisation de données.