Crear una concesión de datos al AWS Data Exchange contener APIs

Agregue la política siguiente a la política de recursos de la API:

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

Sustituya account-id por la cuenta que vaya a crear el conjunto de datos de la API.

No es necesario que la cuenta con el recurso de API Gateway esté en la misma cuenta que crea los conjuntos de datos.

Abra el navegador web e inicie sesión en la consola de AWS Data Exchange.

En el panel de navegación de la izquierda, en Mis datos, elija Conjuntos de datos propios.

En Conjuntos de datos propios, elija Crear conjunto de datos para abrir el asistente Pasos para crear un conjunto de datos.

En Seleccionar tipo de conjunto de datos, elija API de Amazon API Gateway.

En Definir conjunto de datos, introduzca un Nombre y una Descripción para el conjunto de datos. Para obtener más información, consulte Prácticas recomendadas con conjuntos de datos.

(Opcional) En Agregar etiquetas - opcional, agregue etiquetas.

Seleccione Crear.

Utilice el comando create-data-set para crear un conjunto de datos de 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"
}

Anote el nuevo tipo de activo de API_GATEWAY_API.

En la sección Información general sobre el conjunto de datos de la página de detalles del conjunto de datos:

1. (Opcional) Elija Editar nombre para editar la información sobre su conjunto de datos.

2. (Opcional) Elija Eliminar para eliminar el conjunto de datos.

En la sección Revisiones, elija Crear revisión.

En Definir revisión, proporcione un comentario opcional sobre la revisión que describa su finalidad.

(Opcional) En Agregar etiquetas: opcional, agregue las etiquetas asociadas al recurso.

Elija Crear revisión.

Revise, edite o elimine los cambios del paso anterior.

Utilice el comando create-revision para crear una revisión:

$ 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"
}

Añada los activos de la API a la revisión.

En la sección de Activos de API de la página de detalles del conjunto de datos, elija Agregar etapa de API.

En Seleccionar etapa de API, para la API de Amazon API Gateway, introduzca una API en el cuadro de entrada o elija una de las opciones siguientes en la lista desplegable:

1. Si has elegido una API en otra Cuenta de AWS, introduce el ID de la API y el nombre de la fase de la API en los cuadros de entrada.

2. Si seleccionó En esto Cuenta de AWS, elija el nombre de la etapa de API en la lista desplegable

En Configuración avanzada (opcional), puede optar por Conectar el plan de uso existente de Amazon API Gateway para utilizar los límites de limitación y cuota definidos en el plan de uso existente e introducir la Clave de API.

En API de documentos para suscriptores, proporcione detalles sobre la API que verán los receptores después de aceptar la concesión de datos.

1. En Nombre de la API, introduzca un nombre que los suscriptores puedan usar para identificar el activo de la API.

   nota

   Si se ha seleccionado En esta Cuenta de AWS, el Nombre de API se rellena automáticamente y es posible modificarlo si es necesario.

   Si se ha seleccionado API en otra Cuenta de AWS, el Nombre de la API se rellena con un nombre predeterminado, que es necesario modificar para que el receptor pueda entender fácilmente de qué se trata.

2. Para la Especificación OpenAPI 3.0, puede:

   1. Introducir o copiar y pegar el archivo de especificaciones de OpenAPI 3.0.

   2. Seleccione Importar desde un archivo JSON y, a continuación, seleccione el archivo .json de su ordenador local para importarlo.

      La especificación importada aparece en el cuadro.

   3. Elija Importar desde Amazon API Gateway y, a continuación, elija una especificación para importar.

      La especificación importada aparece en el cuadro.

3. En Documentación adicional (opcional), introduzca cualquier información adicional que sea útil para que el suscriptor conozca su API. Se admite Markdown.

Elija Agregar etapa de API.

Se inicia un trabajo para importar el activo (en este caso, la API) en el conjunto de datos.

Después de finalizar el trabajo, el campo Estado de la sección Trabajos se actualiza a Completado.

Si tiene más APIs para añadir, repita el paso 2.

En Información general sobre la revisión, revise la revisión y sus activos.

Elija Finalizar.

Utilice el comando create-job para agregar activos de API a la revisión:

$ 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"
}

Utilice el comando list-revision-assets para confirmar que se ha creado el nuevo activo correctamente:

$ 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"
    }
    ]
}

En Información general sobre la revisión, elija Revertir finalización.

Se muestra un mensaje que indica que la revisión ya no está en estado finalizador.

Para editar la revisión, en Información general sobre la revisión, elija Acciones, Editar.

Realice los cambios y elija Actualizar.

Revise los cambios y, a continuación, elija Finalizar.

En Información general sobre la revisión, elija Eliminar.

En el cuadro de diálogo Eliminar, escriba Delete y, a continuación, elija Eliminar.

En el panel de navegación izquierdo de la AWS Data Exchange consola, en Concesiones de datos intercambiados, seleccione Concesiones de datos enviadas.

En Concesiones de datos enviadas, elija Crear concesión de datos para abrir el asistente Definir concesión de datos.

En la sección Seleccionar conjunto de datos propio, active la casilla situada junto al conjunto de datos que desea agregar.

En la sección Descripción general de la concesión, introduzca la información que el receptor verá en relación con su concesión de datos, incluido el Nombre de la concesión de datos y la Descripción de la concesión de datos.

Elija Siguiente.

En la sección Información de acceso del destinatario, en Cuenta de AWS ID, introduce el Cuenta de AWS ID de la cuenta del destinatario que debe recibir la concesión de datos.

Además, en la sección Información de acceso del receptor, en Fecha de finalización del acceso, elija si la concesión de datos debe ser perpetua, seleccione Sin fecha de finalización o si debe tener una fecha de finalización, seleccione Fecha de finalización específica y elija la fecha de finalización deseada.

Elija Next (Siguiente).

En la sección Revisar y enviar, revise la información sobre la concesión de datos.

Si está seguro de que desea crear la concesión de datos y enviarla al receptor elegido, seleccione Crear y enviar concesión de datos.