Amazon S3

Entidades, operaciones y acciones

Todos los conectores de integración proporcionan una capa de abstracción para los objetos de la aplicación conectada. Solo puedes acceder a los objetos de una aplicación a través de esta abstracción. La abstracción se te muestra como entidades, operaciones y acciones.

• Entidad: una entidad se puede considerar como un objeto o un conjunto de propiedades en la aplicación o el servicio conectados. La definición de una entidad varía de un conector a otro. Por ejemplo, en un conector de base de datos, las tablas son las entidades; en un conector de servidor de archivos, las carpetas son las entidades; y en un conector de sistema de mensajería, las colas son las entidades.

  Sin embargo, es posible que un conector no admita o no tenga ninguna entidad. En ese caso, la lista Entities estará vacía.

• Operación: una operación es la actividad que puedes realizar en una entidad. Puedes realizar cualquiera de las siguientes operaciones en una entidad:
  • Mostrar
  • Obtener
  • Crear
  • Actualizar
  • Eliminar

  Al seleccionar una entidad de la lista disponible, se genera una lista de operaciones disponibles para la entidad. Para ver una descripción detallada de las operaciones, consulta las operaciones de entidades de la tarea Connectors. Sin embargo, si un conector no admite ninguna de las operaciones de entidad, esas operaciones no admitidas no se mostrarán en la lista Operations.

• Acción: una acción es una función de primera clase que se pone a disposición de la integración a través de la interfaz del conector. Una acción te permite hacer cambios en una o varias entidades y varía de un conector a otro. Normalmente, una acción tendrá algunos parámetros de entrada y un parámetro de salida. Sin embargo, es posible que un conector no admita ninguna acción, en cuyo caso la lista Actions estará vacía.

Acciones

En esta sección se enumeran algunas de las acciones que admite el conector. Para saber cómo configurar las acciones, consulta los ejemplos de acciones.

Acción CopyObject

Esta acción te permite copiar un objeto de un segmento a otro o dentro del mismo segmento.

Parámetros de entrada de la acción CopyObject

Parámetros de salida de la acción CopyObject

Esta acción devuelve el estado 200 (OK) si la copia se realiza correctamente.

Para saber cómo configurar la acción CopyObject, consulta los ejemplos de acciones.

Acción DownloadObjects

Esta acción obtiene un objeto más de un segmento.

Parámetros de entrada de la acción DownloadObjects

Parámetros de salida de la acción DownloadObjects

Esta acción devuelve el estado 200 (OK) si la descarga se realiza correctamente.

Para saber cómo configurar la acción DownloadObjects, consulta los ejemplos de acciones.

Acción UploadObject

Esta acción te permite subir un objeto a un segmento.

Parámetros de entrada de la acción UploadObject

Parámetros de salida de la acción UploadObject

Esta acción devuelve el estado 200 (OK) si la subida del objeto se realiza correctamente.

Para saber cómo configurar la acción UploadObject, consulta los ejemplos de acciones.

Acción DeleteObject

Esta acción te permite eliminar un objeto de un segmento.

Parámetros de entrada de la acción DeleteObject

Parámetros de salida de la acción DeleteObject

Esta acción devuelve el estado 200 (OK) si la eliminación se realiza correctamente.

Para saber cómo configurar la acción DeleteObject, consulta los ejemplos de acciones.

Acción MoveObject

Esta acción permite a los usuarios mover un objeto de un segmento específico a otro segmento o al mismo.

Parámetros de entrada de la acción MoveObject

Parámetros de salida de la acción MoveObject

Esta acción devuelve el estado 200 (OK) si la operación de movimiento se realiza correctamente.

Para saber cómo configurar la acción MoveObject, consulta los ejemplos de acciones.

Acción PutBucketAcl

Esta acción te permite actualizar la lista de control de acceso (LCA) de un segmento.

Parámetros de entrada de la acción PutBucketAcl

Parámetros de salida de la acción PutBucketAcl

Esta acción devuelve el estado 200 (OK) si la actualización de la LCA del contenedor se realiza correctamente.

Para saber cómo configurar la acción PutBucketAcl, consulta los ejemplos de acciones.

Acción PutObjectAcl

Esta acción te permite actualizar la lista de control de acceso (LCA) de un objeto de un segmento.

Parámetros de entrada de la acción PutObjectAcl

Parámetros de salida de la acción PutObjectAcl

Esta acción devuelve el estado 200 (OK) si la actualización de la LCA del objeto se realiza correctamente.

Para saber cómo configurar la acción PutObjectAcl, consulta los ejemplos de acciones.

Ejemplos de acciones

En esta sección se describe cómo realizar algunas de las acciones de este conector.

Ejemplo: copiar un objeto

En este ejemplo se copia un objeto de un segmento a otro.

1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
2. Seleccione la acción CopyObject y, a continuación, haga clic en Hecho.
3. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce un valor similar al siguiente en el campo Default Value:

   {
   "BucketSource": "aws-s3-bucket-source",
   "ObjectSource": "pic.jpg",
   "BucketDestination": "aws-s3-bucket-destination",
   "ObjectDestination": "new_pic.jpg"
   }

Si la acción se realiza correctamente, el parámetro connectorOutputPayload response de la tarea CopyObject tendrá un valor similar al siguiente:

[{
"Status": "Success"
}]

Ejemplo: descargar un objeto

En este ejemplo se descarga un objeto del segmento especificado.

1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
2. Seleccione la acción DownloadObjects y, a continuación, haga clic en Hecho.
3. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce un valor similar al siguiente en el campo Default Value:

   {
   "Bucket": "aws-s3-bucket-source",
   "HasBytes": true
   }

Si la acción se realiza correctamente, el parámetro connectorOutputPayload response de la tarea DownloadObjects tendrá un valor similar al siguiente:

[{
"Success": "True",
"RemoteFile": "prefix1%2Faws-s3-bucket-source%2Finventory-test-1%2F2023-09-10T01-00Z%2Fmanifest.json",
"ContentBytes": "ewogICJzb3VyY2VCdWNrZXQiIDogImF3cy1zMy1idWNrZXQtYmNvbmUiLAogICJnOK"
},
{
"Success": "True",
"RemoteFile": "upload1.txt",
"ContentBytes": "VGhpcyBpcyBhIHRlc3RpbmcgZmlsZQ=="
}]

Ejemplo: subir un objeto

En este ejemplo se sube un objeto al segmento especificado.

1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
2. Seleccione la acción UploadObject y, a continuación, haga clic en Hecho.
3. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce un valor similar al siguiente en el campo Default Value:

   {
   "Bucket": "aws-s3-bucket-source",
   "FileName": "upload_1.txt",
   "Content": "This is a testing file",
   "AccessPolicy": "PUBLIC"
   }

Si la acción se realiza correctamente, el parámetro connectorOutputPayload response de la tarea UploadObject tendrá un valor similar al siguiente:

[{
"Status": "success",
"bucket": "aws-s3-bucket-source",
"rss:title": "Object 'upload_1.txt' was created in the bucket: aws-s3-bucket-source",
"object": "upload_1.txt"
}]

Ejemplo: eliminar un objeto

En este ejemplo se elimina un objeto del segmento especificado.

1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
2. Seleccione la acción DeleteObject y, a continuación, haga clic en Hecho.
3. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce un valor similar al siguiente en el campo Default Value:

   {
   "Bucket": "aws-s3-bucket-source",
   "Object": "abc.png"
   }

Si la acción se realiza correctamente, el parámetro connectorOutputPayload response de la tarea DeleteObject tendrá un valor similar al siguiente:

[{
"Status": "Success"
}]

Ejemplo: mover un objeto

En este ejemplo se mueve un objeto de un segmento a otro.

1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
2. Seleccione la acción MoveObject y, a continuación, haga clic en Hecho.
3. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce un valor similar al siguiente en el campo Default Value:

   {
   "BucketSource": "aws-s3-bucket-source",
   "ObjectSource": "abc.png",
   "BucketDestination": "aws-s3-bucket-destination",
   "ObjectDestination": "moved.png"
   }

Si la acción se realiza correctamente, el parámetro connectorOutputPayload response de la tarea MoveObject tendrá un valor similar al siguiente:

[{
"Status": "Success"
}]

Ejemplo: actualizar la LCA de un segmento

En este ejemplo se actualizan los permisos de control de acceso de un segmento.

1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
2. Seleccione la acción PutBucketAcl y, a continuación, haga clic en Hecho.
3. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce un valor similar al siguiente en el campo Default Value:

   {
   "BucketSource": "aws-s3-bucket-source",
   "ACL": "public-read"
   }

Si la acción se realiza correctamente, el parámetro connectorOutputPayload response de la tarea PutBucketAcl tendrá un valor similar al siguiente:

[{
"Status": "Success"
}]

Ejemplo: actualizar la lista de control de acceso de un objeto

En este ejemplo se actualizan los permisos de control de acceso de un objeto de un segmento.

1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
2. Seleccione la acción PutObjectAcl y, a continuación, haga clic en Hecho.
3. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce un valor similar al siguiente en el campo Default Value:

   {
   "Bucket": "aws-s3-bucket-source",
   "ACL": "aws-exec-read",
   "Key": "AWS_S3_BusinessCase_V2.xlsx"
   }

Si la acción se realiza correctamente, el parámetro connectorOutputPayload response de la tarea PutObjectAcl tendrá un valor similar al siguiente:

[{
"Status": "Success"
}]

Ejemplos de operaciones de entidades

En esta sección se muestra cómo realizar algunas de las operaciones de entidad en este conector.

Ejemplo: listar los metadatos de todos los objetos

En este ejemplo se obtienen los metadatos de todos los objetos de la entidad Object.

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona Object en la lista Entity.
3. Selecciona la operación List y, a continuación, haz clic en Hecho.
4. Opcionalmente, en la sección Entrada de tarea de la tarea Conectores, puedes filtrar el conjunto de resultados especificando una cláusula de filtro. Especifique siempre el valor de la cláusula de filtro entre comillas simples ('). Por ejemplo, Bucket='test-bucket'. También puede especificar varias condiciones de filtro mediante operadores lógicos. Por ejemplo, Bucket='test-bucket' and OwnerId='b1ecc809ad8467088afb'.

Ejemplo: obtener los metadatos de un segmento

En este ejemplo se obtienen los metadatos del segmento con el ID especificado de la entidad Bucket.

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona Bucket en la lista Entity.
3. Selecciona la operación Get y, a continuación, haz clic en Hecho.
4. En la sección Entrada de tarea de la tarea Conectores, haga clic en EntityId y, a continuación, introduzca demo_replication en el campo Valor predeterminado.

   En este caso, demo_replication es un ID de contenedor único de la entidad Bucket.

Ejemplo: Crear un segmento

En este ejemplo se crea un segmento en la entidad Bucket.

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona Bucket en la lista Entity.
3. Selecciona la operación Create y, a continuación, haz clic en Hecho.
4. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce un valor similar al siguiente en el campo Default Value:

   {
   "Bucket": "Demo1697528098686"
   }

   Si la integración se realiza correctamente, el campo connectorOutputPayload de la tarea del conector tendrá un valor similar al siguiente:

   [{
   "Bucket": "Demo1697528098686"
   }]

Ejemplo: eliminar un segmento

En este ejemplo se elimina el segmento con el ID especificado de la entidad Bucket.

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona Bucket en la lista Entity.
3. Selecciona la operación Delete y, a continuación, haz clic en Hecho.
4. En la sección Entrada de tarea de la tarea Conectores, haga clic en entityId y, a continuación, introduzca demo1697528098686 en el campo Valor predeterminado.