Amazon S3

Entidades, operações e ações

Todos os Integration Connectors fornecem uma camada de abstração para os objetos do aplicativo conectado. Só é possível acessar os objetos de um aplicativo por esta abstração. A abstração é exposta a você como entidades, operações e ações.

• Entidade: uma entidade pode ser considerada um objeto ou um conjunto de propriedades no aplicativo ou serviço conectado. A definição de uma entidade difere de um conector para outro. Por exemplo, em um conector de banco de dados, as tabelas são as entidades, em um conector de servidor de arquivos, as pastas são as entidades e, em um conector de sistema de mensagens, as filas são as entidades.

  No entanto, é possível que um conector não aceite ou não tenha entidades. Nesse caso, a lista Entities estará vazia.

• Operação: uma operação é a atividade que pode ser realizada em uma entidade. É possível executar qualquer uma das seguintes operações em uma entidade:
  • Lista
  • Receber
  • Criar
  • Atualizar
  • Excluir

  Selecionar uma entidade na lista disponível gera uma lista de operações disponíveis para ela. Para uma descrição detalhada das operações, consulte as operações de entidades da tarefa "Conectores". No entanto, se um conector não oferecer suporte a nenhuma das operações de entidade, essas operações não serão listadas na lista Operations.

• Ação: uma ação é uma função de primeira classe disponibilizada para a integração por meio da interface do conector. Uma ação permite fazer alterações em uma ou mais entidades e varia de um conector para outro. Normalmente, uma ação tem alguns parâmetros de entrada e um parâmetro de saída. No entanto, é possível que o conector não ofereça suporte a nenhuma ação. Nesse caso, a lista Actions estará vazia.

Ações

Esta seção lista algumas das ações compatíveis com o conector. Para entender como configurar as ações, consulte Exemplos de ações.

Ação CopyObject

Com essa ação, é possível copiar um objeto de um bucket para outro ou dentro do mesmo bucket.

Parâmetros de entrada da ação CopyObject

Parâmetros de saída da ação CopyObject

Essa ação retorna o status 200 (OK) se a cópia for bem-sucedida.

Para entender como configurar a ação CopyObject, consulte Exemplos de ações.

Ação DownloadObjects

Essa ação recebe mais um objeto de um bucket.

Parâmetros de entrada da ação DownloadObjects

Parâmetros de saída da ação DownloadObjects

Essa ação retorna o status 200 (OK) se o download for bem-sucedido.

Para entender como configurar a ação DownloadObjects, consulte Exemplos de ações.

Ação UploadObject

Com essa ação, é possível fazer upload de um objeto para um bucket.

Parâmetros de entrada da ação UploadObject

Parâmetros de saída da ação UploadObject

Essa ação retorna o status 200 (OK) se o upload do objeto for bem-sucedido.

Para entender como configurar a ação UploadObject, consulte Exemplos de ações.

Ação DeleteObject

Essa ação permite excluir um objeto de um bucket.

Parâmetros de entrada da ação DeleteObject

Parâmetros de saída da ação DeleteObject

Essa ação retorna o status 200 (OK) se a exclusão for bem-sucedida.

Para entender como configurar a ação DeleteObject, consulte Exemplos de ações.

Ação MoveObject

Essa ação permite que os usuários movam um objeto de um bucket específico para outro ou para o mesmo bucket.

Parâmetros de entrada da ação MoveObject

Parâmetros de saída da ação MoveObject

Essa ação retorna o status 200 (OK) se a operação de movimentação for bem-sucedida.

Para entender como configurar a ação MoveObject, consulte Exemplos de ações.

Ação PutBucketAcl

Com essa ação, é possível atualizar a lista de controle de acesso (ACL) de um bucket.

Parâmetros de entrada da ação PutBucketAcl

Parâmetros de saída da ação PutBucketAcl

Essa ação retorna o status 200 (OK) se a atualização da ACL do bucket for bem-sucedida.

Para entender como configurar a ação PutBucketAcl, consulte Exemplos de ações.

Ação PutObjectAcl

Essa ação permite atualizar a lista de controle de acesso (ACL) de um objeto em um bucket.

Parâmetros de entrada da ação PutObjectAcl

Parâmetros de saída da ação PutObjectAcl

Essa ação retorna o status 200 (OK) se a atualização da ACL do objeto for bem-sucedida.

Para entender como configurar a ação PutObjectAcl, consulte Exemplos de ações.

Exemplos de ações

Nesta seção, descrevemos como executar algumas das ações neste conector.

Exemplo: copiar um objeto

Este exemplo copia um objeto de um bucket para outro.

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação CopyObject e clique em Concluído.
3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:

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

Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa CopyObject terá um valor semelhante a este:

[{
"Status": "Success"
}]

Exemplo: fazer o download de um objeto

Este exemplo faz o download de um objeto do bucket especificado.

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação DownloadObjects e clique em Concluído.
3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:

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

Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa DownloadObjects terá um valor semelhante a este:

[{
"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=="
}]

Exemplo: fazer upload de um objeto

Este exemplo faz upload de um objeto para o bucket especificado.

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação UploadObject e clique em Concluído.
3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:

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

Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa UploadObject terá um valor semelhante a este:

[{
"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"
}]

Exemplo: excluir um objeto

Este exemplo exclui um objeto do bucket especificado.

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação DeleteObject e clique em Concluído.
3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:

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

Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa DeleteObject terá um valor semelhante a este:

[{
"Status": "Success"
}]

Exemplo: mover um objeto

Este exemplo move um objeto de um bucket para outro.

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação MoveObject e clique em Concluído.
3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:

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

Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa MoveObject terá um valor semelhante a este:

[{
"Status": "Success"
}]

Exemplo: atualizar a ACL de um bucket

Este exemplo atualiza as permissões de controle de acesso de um bucket.

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação PutBucketAcl e clique em Concluído.
3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:

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

Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa PutBucketAcl terá um valor semelhante a este:

[{
"Status": "Success"
}]

Exemplo: atualizar a ACL de um objeto

Este exemplo atualiza as permissões de controle de acesso de um objeto em um bucket.

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação PutObjectAcl e clique em Concluído.
3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:

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

Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa PutObjectAcl terá um valor semelhante a este:

[{
"Status": "Success"
}]

Exemplos de operações de entidade

Nesta seção, mostramos como realizar algumas das operações de entidade neste conector.

Exemplo: listar metadados de todos os objetos

Este exemplo busca os metadados de todos os objetos na entidade Object.

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione Object na lista Entity.
3. Selecione a operação List e clique em Concluído.
4. Se quiser, na seção Entrada de tarefa da tarefa Conectores, é possível filtrar o conjunto de resultados especificando uma cláusula de filtro. Sempre especifique o valor da cláusula de filtro entre aspas simples ('). Por exemplo, Bucket='test-bucket'. Também é possível especificar várias condições de filtro usando os operadores lógicos. Por exemplo, Bucket='test-bucket' and OwnerId='b1ecc809ad8467088afb'.

Exemplo: receber metadados de um bucket

Este exemplo recebe os metadados do bucket com o ID especificado da entidade Bucket.

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione Bucket na lista Entity.
3. Selecione a operação Get e clique em Concluído.
4. Na seção Entrada da tarefa da tarefa Conectores, clique em EntityId e insira demo_replication no campo Valor padrão.

   Aqui, demo_replication é um ID do bucket exclusivo na entidade Bucket.

Exemplo: criar um bucket

Este exemplo cria um bucket na entidade Bucket.

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione Bucket na lista Entity.
3. Selecione a operação Create e clique em Concluído.
4. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:

   {
   "Bucket": "Demo1697528098686"
   }

   Se a integração for bem-sucedida, o campo connectorOutputPayload da tarefa do conector terá um valor semelhante a este:

   [{
   "Bucket": "Demo1697528098686"
   }]

Exemplo: excluir um bucket

Este exemplo exclui o bucket com o ID especificado na entidade Bucket.

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione Bucket na lista Entity.
3. Selecione a operação Delete e clique em Concluído.
4. Na seção Entrada da tarefa da tarefa Conectores, clique em entityId e insira demo1697528098686 no campo Valor padrão.