Acciones de AWS S3

Esta página proporciona una referencia de las acciones de AWS S3 disponibles en el catálogo de acciones de automatización de flujo de trabajo. Utilice estas acciones para listar, recuperar, cargar y eliminar objetos en buckets de Amazon S3.

Requisitos previos

Para los requisitos previos y la configuración de credenciales, consulte Configurar las credenciales de AWS.

Listar objetos en un bucket

El identificador de la acción es aws.s3.listObjectsV2.

Devuelve algunos o todos (hasta 1000) los objetos de un bucket con sus metadatos. Es la versión recomendada de listObjects.

La siguiente tabla describe los campos de entrada para esta acción.

Aporte	Tipo	Descripción	Ejemplo
`awsRoleArn`	Cadena	Opcional. ARN del rol de IAM que se debe asumir para las llamadas API de AWS.	`arn:aws:iam::123456789012:role/my-workflow-role`
`awsAccessKeyId`	Cadena	Opcional. ID de clave de acceso de AWS. Páselo como un secreto.	`${{ :secrets:awsAccessKeyId }}`
`awsSecretAccessKey`	Cadena	Opcional. Clave de acceso secreta de AWS. Páselo como un secreto.	`${{ :secrets:awsSecretAccessKey }}`
`awsSessionToken`	Cadena	Opcional. Token de sesión temporal para la autenticación STS. Páselo como un secreto.	`${{ :secrets:awsSessionToken }}`
`region`	Cadena	Requerido. Región de AWS del bucket objetivo.	`us-east-2`
`bucket`	Cadena	Requerido. Nombre del bucket de S3 del cual listar objetos.	`examplebucket`
`prefix`	Cadena	Opcional. Limita la respuesta a las claves que comienzan con este prefijo.	`path/to/folder/`
`maxKeys`	Entero	Opcional. Número máximo de claves a devolver (hasta 1000).	`100`
`continuationToken`	Cadena	Opcional. Token de una respuesta anterior para recuperar la siguiente página de resultados.	`some-token`
`parameters`	Mapa	Opcional. Parámetros adicionales de boto3 para pasar a la llamada API.	`{"Delimiter": "/"}`
`selectors`	Lista	Opcional. Selectores JQ para extraer campos específicos de la salida de la acción.	`[{"name": "response", "expression": ".response"}]`

Los campos opcionales adicionales de boto3 (EncodingType, FetchOwner, StartAfter, RequestPayer, ExpectedBucketOwner, OptionalObjectAttributes, Delimiter) están disponibles a través de la entrada parameters. Consulte la referencia de boto3 de list_objects_v2 para obtener más detalles.

La siguiente tabla describe los campos de salida para esta acción.

Producción	Tipo	Ejemplo
`response`	Objeto	Consulte la referencia de list_objects_v2 de boto3 .
`success`	Booleano	`true` o `false`
`errorMessage`	Cadena	`"Parameter validation failed: Invalid bucket name"`

Producción

Tipo

Ejemplo

response

Objeto

Consulte la

referencia de list_objects_v2 de boto3

success

Booleano

true

false

errorMessage

Cadena

"Parameter validation failed: Invalid bucket name"

Flujo de trabajo de ejemplo

name: aws-s3-list-objects-v2
description: 'List Objects in an AWS S3 Bucket'
steps:
  - name: aws_s3_listObjectsV2_1
    type: action
    action: aws.s3.listObjectsV2
    version: '1'
    inputs:
      awsRoleArn: "arn:aws:iam::123456789012:role/my-workflow-role"
      region: "us-east-2"
      bucket: "examplebucket"
      prefix: "path/to/folder/"
      maxKeys: 100
    next: end

Eliminar un objeto de un bucket

El identificador de la acción es aws.s3.deleteObject.

Elimina permanentemente un único objeto de un bucket. Para los buckets versionados, esta operación inserta un marcador de eliminación, que oculta el objeto sin eliminarlo permanentemente a menos que se especifique un VersionId.

La siguiente tabla describe los campos de entrada para esta acción.

Aporte	Tipo	Descripción	Ejemplo
`awsRoleArn`	Cadena	Opcional. ARN del rol de IAM que se debe asumir para las llamadas API de AWS.	`arn:aws:iam::123456789012:role/my-workflow-role`
`awsAccessKeyId`	Cadena	Opcional. ID de clave de acceso de AWS. Páselo como un secreto.	`${{ :secrets:awsAccessKeyId }}`
`awsSecretAccessKey`	Cadena	Opcional. Clave de acceso secreta de AWS. Páselo como un secreto.	`${{ :secrets:awsSecretAccessKey }}`
`awsSessionToken`	Cadena	Opcional. Token de sesión temporal para la autenticación STS. Páselo como un secreto.	`${{ :secrets:awsSessionToken }}`
`region`	Cadena	Requerido. Región de AWS del bucket objetivo.	`us-east-2`
`bucket`	Cadena	Requerido. Nombre del bucket de S3 que contiene el objeto.	`examplebucket`
`key`	Cadena	Requerido. Clave completa (ruta) del objeto a eliminar.	`path/to/object.txt`
`parameters`	Mapa	Opcional. Parámetros adicionales de boto3 para pasar a la llamada API.	`{"VersionId": "testVersion", "MFA": "Test"}`
`selectors`	Lista	Opcional. Selectores JQ para extraer campos específicos de la salida de la acción.	`[{"name": "response", "expression": ".response"}]`

Los campos opcionales adicionales de boto3 (RequestPayer, BypassGovernanceRetention, ExpectedBucketOwner, IfMatch, VersionId, MFA) están disponibles a través de la entrada parameters. Consulte la referencia de boto3 de delete_object para obtener más detalles.

La siguiente tabla describe los campos de salida para esta acción.

Producción	Tipo	Ejemplo
`response`	Objeto	Consulte la referencia de boto3 de delete_object .
`success`	Booleano	`true` o `false`
`errorMessage`	Cadena	`"Parameter validation failed: Invalid bucket name"`

Producción

Tipo

Ejemplo

response

Objeto

Consulte la

referencia de boto3 de delete_object

success

Booleano

true

false

errorMessage

Cadena

"Parameter validation failed: Invalid bucket name"

Flujo de trabajo de ejemplo

name: aws-s3-delete-object
description: 'Delete an AWS S3 Object'
steps:
  - name: aws_s3_deleteObject_1
    type: action
    action: aws.s3.deleteObject
    version: '1'
    inputs:
      awsRoleArn: "arn:aws:iam::123456789012:role/my-workflow-role"
      region: "us-west-2"
      bucket: "my-bucket"
      key: "path/to/object.txt"
    next: end

Agregar un objeto a un bucket

El identificador de la acción es aws.s3.putObject.

Agrega un objeto a un bucket. Amazon S3 es un sistema distribuido —si recibe múltiples requests de escritura para el mismo objeto simultáneamente, sobrescribe todos excepto el último objeto escrito.

La siguiente tabla describe los campos de entrada para esta acción.

Aporte	Tipo	Descripción	Ejemplo
`awsRoleArn`	Cadena	Opcional. ARN del rol de IAM que se debe asumir para las llamadas API de AWS.	`arn:aws:iam::123456789012:role/my-workflow-role`
`awsAccessKeyId`	Cadena	Opcional. ID de clave de acceso de AWS. Páselo como un secreto.	`${{ :secrets:awsAccessKeyId }}`
`awsSecretAccessKey`	Cadena	Opcional. Clave de acceso secreta de AWS. Páselo como un secreto.	`${{ :secrets:awsSecretAccessKey }}`
`awsSessionToken`	Cadena	Opcional. Token de sesión temporal para la autenticación STS. Páselo como un secreto.	`${{ :secrets:awsSessionToken }}`
`region`	Cadena	Requerido. Región de AWS del bucket objetivo.	`us-east-2`
`bucket`	Cadena	Requerido. Nombre del bucket de S3 al que cargar el objeto.	`examplebucket`
`key`	Cadena	Requerido. Clave completa (ruta) para el objeto en el bucket.	`path/to/object.txt`
`body`	Cadena	Requerido. Los datos del objeto a cargar.	`file content`
`contentType`	Cadena	Requerido. Tipo MIME estándar del objeto.	`plain/text`
`tagging`	Cadena	Opcional. Conjunto de etiquetas codificado en URL a aplicar al objeto.	`key1=value1`
`parameters`	Mapa	Opcional. Parámetros adicionales de boto3 para pasar a la llamada API.	`{"ServerSideEncryption": "AES256", "Metadata": {"metadata1": "value1"}}`
`selectors`	Lista	Opcional. Selectores JQ para extraer campos específicos de la salida de la acción.	`[{"name": "response", "expression": ".response"}]`

Los campos opcionales adicionales de boto3 están disponibles a través de la entrada parameters. Consulte la referencia de boto3 de put_object para ver la lista completa.

La siguiente tabla describe los campos de salida para esta acción.

Producción	Tipo	Ejemplo
`response`	Objeto	Consulte la referencia de boto3 de put_object .
`success`	Booleano	`true` o `false`
`errorMessage`	Cadena	`"An error occurred (NoSuchBucket) when calling the PutObject operation: The specified bucket does not exist"`

Producción

Tipo

Ejemplo

response

Objeto

Consulte la

referencia de boto3 de put_object

success

Booleano

true

false

errorMessage

Cadena

"An error occurred (NoSuchBucket) when calling the PutObject operation: The specified bucket does not exist"

Flujo de trabajo de ejemplo

name: s3-put-object
description: 'Put an AWS S3 Object'
steps:
  - name: aws_s3_putObject_1
    type: action
    action: aws.s3.putObject
    version: '1'
    inputs:
      awsRoleArn: "arn:aws:iam::123456789012:role/my-workflow-role"
      region: "us-east-2"
      bucket: "examplebucket"
      key: "path/to/object.txt"
      body: "Hello world"
      contentType: "plain/text"
      tagging: "key1=value1"
    next: end

Recuperar un objeto de un bucket

El identificador de la acción es aws.s3.getObject.

Recupera un objeto de Amazon S3. Especifique el nombre completo de la clave para el objeto en la solicitud.

Importante

Esta acción falla si el objeto es mayor a 100 KB.

La siguiente tabla describe los campos de entrada para esta acción.

Aporte	Tipo	Descripción	Ejemplo
`awsRoleArn`	Cadena	Opcional. ARN del rol de IAM que se debe asumir para las llamadas API de AWS.	`arn:aws:iam::123456789012:role/my-workflow-role`
`awsAccessKeyId`	Cadena	Opcional. ID de clave de acceso de AWS. Páselo como un secreto.	`${{ :secrets:awsAccessKeyId }}`
`awsSecretAccessKey`	Cadena	Opcional. Clave de acceso secreta de AWS. Páselo como un secreto.	`${{ :secrets:awsSecretAccessKey }}`
`awsSessionToken`	Cadena	Opcional. Token de sesión temporal para la autenticación STS. Páselo como un secreto.	`${{ :secrets:awsSessionToken }}`
`region`	Cadena	Requerido. Región de AWS del bucket objetivo.	`us-east-2`
`bucket`	Cadena	Requerido. Nombre del bucket de S3 que contiene el objeto.	`examplebucket`
`key`	Cadena	Requerido. Clave completa (ruta) del objeto a recuperar.	`path/to/object.txt`
`versionId`	Cadena	Opcional. ID de versión del objeto a recuperar. Si se omite, se devuelve la versión actual.	`some-version-id`
`range`	Cadena	Opcional. Encabezado de rango HTTP para recuperar un rango de bytes específico del objeto.	`bytes=0-99`
`parameters`	Mapa	Opcional. Parámetros adicionales de boto3 para pasar a la llamada API.	`{"ChecksumMode": "ENABLED"}`
`selectors`	Lista	Opcional. Selectores JQ para extraer campos específicos de la salida de la acción.	`[{"name": "response", "expression": ".response"}]`

Los campos opcionales adicionales de boto3 están disponibles a través de la entrada parameters. Consulte la referencia de boto3 de get_object para ver la lista completa.

La siguiente tabla describe los campos de salida para esta acción.

Producción	Tipo	Ejemplo
`response`	Objeto	Consulte la referencia de boto3 de get_object .
`success`	Booleano	`true` o `false`
`errorMessage`	Cadena	`"An error occurred (InvalidArgument) when calling the GetObject operation: Invalid version id specified"`

Producción

Tipo

Ejemplo

response

Objeto

Consulte la

referencia de boto3 de get_object

success

Booleano

true

false

errorMessage

Cadena

"An error occurred (InvalidArgument) when calling the GetObject operation: Invalid version id specified"

Flujo de trabajo de ejemplo

name: s3-get-object
description: 'Get an AWS S3 Object'
steps:
  - name: aws_s3_getObject_1
    type: action
    action: aws.s3.getObject
    version: '1'
    inputs:
      awsRoleArn: "arn:aws:iam::123456789012:role/my-workflow-role"
      region: "us-east-2"
      bucket: "examplebucket"
      key: "path/to/object.txt"
    next: end

Te ofrecemos esta traducción automática para facilitar la lectura.

Requisitos previos.css-21sua1{background:none;border:none;width:0;padding:0;}

Listar objetos en un bucket

Eliminar un objeto de un bucket

Agregar un objeto a un bucket

Recuperar un objeto de un bucket

Importante

Requisitos previos