Ações do AWS S3

Esta página fornece uma referência para as ações do AWS S3 disponíveis no catálogo de ações de automação de fluxo de trabalho. Use essas ações para listar, recuperar, fazer upload e excluir objetos em buckets do Amazon S3.

Pré-requisitos

Para pré-requisitos e configuração de credenciais, consulte Configurar credenciais da AWS.

Listar objetos em um bucket

O identificador da ação é aws.s3.listObjectsV2.

Retorna alguns ou todos (até 1.000) os objetos em um bucket com seus metadados. É a versão recomendada de listObjects.

A tabela a seguir descreve os campos de entrada para esta ação.

Entrada	Tipo	Descrição	Exemplo
`awsRoleArn`	Corda	Opcional. ARN da função do IAM a ser assumida para chamadas de API da AWS.	`arn:aws:iam::123456789012:role/my-workflow-role`
`awsAccessKeyId`	Corda	Opcional. ID da chave de acesso da AWS. Passe como um segredo.	`${{ :secrets:awsAccessKeyId }}`
`awsSecretAccessKey`	Corda	Opcional. Chave de acesso secreta da AWS. Passe como um segredo.	`${{ :secrets:awsSecretAccessKey }}`
`awsSessionToken`	Corda	Opcional. Token de sessão temporário para autenticação STS. Passe como um segredo.	`${{ :secrets:awsSessionToken }}`
`region`	Corda	Obrigatório. Região da AWS do bucket de destino.	`us-east-2`
`bucket`	Corda	Obrigatório. Nome do bucket do S3 do qual listar objetos.	`examplebucket`
`prefix`	Corda	Opcional. Limita a resposta às chaves que começam com este prefixo.	`path/to/folder/`
`maxKeys`	Inteiro	Opcional. Número máximo de chaves a retornar (até 1.000).	`100`
`continuationToken`	Corda	Opcional. Token de uma resposta anterior para recuperar a próxima página de resultados.	`some-token`
`parameters`	Mapa	Opcional. Parâmetros adicionais do boto3 a serem passados para a chamada de API.	`{"Delimiter": "/"}`
`selectors`	Lista	Opcional. Seletores JQ para extrair campos específicos da saída da ação.	`[{"name": "response", "expression": ".response"}]`

Campos opcionais adicionais do boto3 (EncodingType, FetchOwner, StartAfter, RequestPayer, ExpectedBucketOwner, OptionalObjectAttributes, Delimiter) estão disponíveis por meio da entrada parameters. Consulte a referência do boto3 list_objects_v2 para obter detalhes.

A tabela a seguir descreve os campos de saída para esta ação.

Saída	Tipo	Exemplo
`response`	Objeto	Consulte a referência list_objects_v2 do boto3 .
`success`	Boleano	`true` ou `false`
`errorMessage`	Corda	`"Parameter validation failed: Invalid bucket name"`

Saída

Tipo

Exemplo

response

Objeto

Consulte a

referência list_objects_v2 do boto3

success

Boleano

true

false

errorMessage

Corda

"Parameter validation failed: Invalid bucket name"

Exemplo de fluxo de trabalho

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

Excluir um objeto de um bucket

O identificador da ação é aws.s3.deleteObject.

Remove permanentemente um único objeto de um bucket. Para buckets versionados, esta operação insere um marcador de exclusão, que oculta o objeto sem excluí-lo permanentemente, a menos que um VersionId seja especificado.

A tabela a seguir descreve os campos de entrada para esta ação.

Entrada	Tipo	Descrição	Exemplo
`awsRoleArn`	Corda	Opcional. ARN da função do IAM a ser assumida para chamadas de API da AWS.	`arn:aws:iam::123456789012:role/my-workflow-role`
`awsAccessKeyId`	Corda	Opcional. ID da chave de acesso da AWS. Passe como um segredo.	`${{ :secrets:awsAccessKeyId }}`
`awsSecretAccessKey`	Corda	Opcional. Chave de acesso secreta da AWS. Passe como um segredo.	`${{ :secrets:awsSecretAccessKey }}`
`awsSessionToken`	Corda	Opcional. Token de sessão temporário para autenticação STS. Passe como um segredo.	`${{ :secrets:awsSessionToken }}`
`region`	Corda	Obrigatório. Região da AWS do bucket de destino.	`us-east-2`
`bucket`	Corda	Obrigatório. Nome do bucket do S3 que contém o objeto.	`examplebucket`
`key`	Corda	Obrigatório. Chave completa (caminho) do objeto a ser excluído.	`path/to/object.txt`
`parameters`	Mapa	Opcional. Parâmetros adicionais do boto3 a serem passados para a chamada de API.	`{"VersionId": "testVersion", "MFA": "Test"}`
`selectors`	Lista	Opcional. Seletores JQ para extrair campos específicos da saída da ação.	`[{"name": "response", "expression": ".response"}]`

Campos opcionais adicionais do boto3 (RequestPayer, BypassGovernanceRetention, ExpectedBucketOwner, IfMatch, VersionId, MFA) estão disponíveis por meio da entrada parameters. Consulte a referência do boto3 para delete_object para obter detalhes.

A tabela a seguir descreve os campos de saída para esta ação.

Saída	Tipo	Exemplo
`response`	Objeto	Consulte a referência delete_object do boto3 .
`success`	Boleano	`true` ou `false`
`errorMessage`	Corda	`"Parameter validation failed: Invalid bucket name"`

Saída

Tipo

Exemplo

response

Objeto

Consulte a

referência delete_object do boto3

success

Boleano

true

false

errorMessage

Corda

"Parameter validation failed: Invalid bucket name"

Exemplo de fluxo de trabalho

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

Adicionar um objeto a um bucket

O identificador da ação é aws.s3.putObject.

Adiciona um objeto a um bucket. O Amazon S3 é um sistema distribuído — se receber múltiplos requests de gravação para o mesmo objeto simultaneamente, ele sobrescreve todos, exceto o último objeto gravado.

A tabela a seguir descreve os campos de entrada para esta ação.

Entrada	Tipo	Descrição	Exemplo
`awsRoleArn`	Corda	Opcional. ARN da função do IAM a ser assumida para chamadas de API da AWS.	`arn:aws:iam::123456789012:role/my-workflow-role`
`awsAccessKeyId`	Corda	Opcional. ID da chave de acesso da AWS. Passe como um segredo.	`${{ :secrets:awsAccessKeyId }}`
`awsSecretAccessKey`	Corda	Opcional. Chave de acesso secreta da AWS. Passe como um segredo.	`${{ :secrets:awsSecretAccessKey }}`
`awsSessionToken`	Corda	Opcional. Token de sessão temporário para autenticação STS. Passe como um segredo.	`${{ :secrets:awsSessionToken }}`
`region`	Corda	Obrigatório. Região da AWS do bucket de destino.	`us-east-2`
`bucket`	Corda	Obrigatório. Nome do bucket do S3 para o qual fazer o upload do objeto.	`examplebucket`
`key`	Corda	Obrigatório. Chave completa (caminho) do objeto no bucket.	`path/to/object.txt`
`body`	Corda	Obrigatório. Os dados do objeto a serem enviados.	`file content`
`contentType`	Corda	Obrigatório. Tipo MIME padrão do objeto.	`plain/text`
`tagging`	Corda	Opcional. Conjunto de tags codificado em URL a ser aplicado ao objeto.	`key1=value1`
`parameters`	Mapa	Opcional. Parâmetros adicionais do boto3 a serem passados para a chamada de API.	`{"ServerSideEncryption": "AES256", "Metadata": {"metadata1": "value1"}}`
`selectors`	Lista	Opcional. Seletores JQ para extrair campos específicos da saída da ação.	`[{"name": "response", "expression": ".response"}]`

Campos opcionais adicionais do boto3 estão disponíveis por meio da entrada parameters. Consulte a referência do put_object boto3 para obter a lista completa.

A tabela a seguir descreve os campos de saída para esta ação.

Saída	Tipo	Exemplo
`response`	Objeto	Consulte a referência do put_object do boto3 .
`success`	Boleano	`true` ou `false`
`errorMessage`	Corda	`"An error occurred (NoSuchBucket) when calling the PutObject operation: The specified bucket does not exist"`

Saída

Tipo

Exemplo

response

Objeto

Consulte a

referência do put_object do boto3

success

Boleano

true

false

errorMessage

Corda

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

Exemplo de fluxo de trabalho

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 um objeto de um bucket

O identificador da ação é aws.s3.getObject.

Recupera um objeto do Amazon S3. Especifique o nome completo da chave para o objeto na solicitação.

Importante

Esta ação falha se o objeto for maior que 100 KB.

A tabela a seguir descreve os campos de entrada para esta ação.

Entrada	Tipo	Descrição	Exemplo
`awsRoleArn`	Corda	Opcional. ARN da função do IAM a ser assumida para chamadas de API da AWS.	`arn:aws:iam::123456789012:role/my-workflow-role`
`awsAccessKeyId`	Corda	Opcional. ID da chave de acesso da AWS. Passe como um segredo.	`${{ :secrets:awsAccessKeyId }}`
`awsSecretAccessKey`	Corda	Opcional. Chave de acesso secreta da AWS. Passe como um segredo.	`${{ :secrets:awsSecretAccessKey }}`
`awsSessionToken`	Corda	Opcional. Token de sessão temporário para autenticação STS. Passe como um segredo.	`${{ :secrets:awsSessionToken }}`
`region`	Corda	Obrigatório. Região da AWS do bucket de destino.	`us-east-2`
`bucket`	Corda	Obrigatório. Nome do bucket do S3 que contém o objeto.	`examplebucket`
`key`	Corda	Obrigatório. Chave completa (caminho) do objeto a ser recuperado.	`path/to/object.txt`
`versionId`	Corda	Opcional. ID da versão do objeto a ser recuperado. Se omitido, a versão atual é retornada.	`some-version-id`
`range`	Corda	Opcional. Cabeçalho de intervalo HTTP para recuperar um intervalo de bytes específico do objeto.	`bytes=0-99`
`parameters`	Mapa	Opcional. Parâmetros adicionais do boto3 a serem passados para a chamada de API.	`{"ChecksumMode": "ENABLED"}`
`selectors`	Lista	Opcional. Seletores JQ para extrair campos específicos da saída da ação.	`[{"name": "response", "expression": ".response"}]`

Campos opcionais adicionais do boto3 estão disponíveis por meio da entrada parameters. Consulte a referência do get_object do boto3 para obter a lista completa.

A tabela a seguir descreve os campos de saída para esta ação.

Saída	Tipo	Exemplo
`response`	Objeto	Consulte a referência do get_object do boto3 .
`success`	Boleano	`true` ou `false`
`errorMessage`	Corda	`"An error occurred (InvalidArgument) when calling the GetObject operation: Invalid version id specified"`

Saída

Tipo

Exemplo

response

Objeto

Consulte a

referência do get_object do boto3

success

Boleano

true

false

errorMessage

Corda

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

Exemplo de fluxo de trabalho

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

Esta tradução de máquina é fornecida para sua comodidade.

Pré-requisitos.css-21sua1{background:none;border:none;width:0;padding:0;}

Listar objetos em um bucket

Excluir um objeto de um bucket

Adicionar um objeto a um bucket

Recuperar um objeto de um bucket

Importante

Pré-requisitos