Extensão do Amazon S3

Você está visualizando a documentação do Apigee Edge.
Acesse Documentação da Apigee X. informações

Versão: 1.1.1

Gerenciar arquivos em um bucket do Amazon S3. Com esta extensão, é possível listar, fazer o download e excluir arquivos. Também é possível gerar um URL assinado para fazer o download de um arquivo.

Cada instância configurada dessa extensão funciona com um bucket específico. Para vários buckets, use uma instância configurada dessa extensão para cada bucket.

Pré-requisitos

Antes de usar a extensão de um proxy de API usando a política ExtensionCallout, você precisa:

• Verifique o ID da chave de acesso e a chave de acesso secreta do bucket do Amazon S3 com que você vai trabalhar.

  Você precisará deles, junto com o nome do bucket da AWS e a região da AWS, para configurar a extensão.

Sobre o Amazon S3

O Amazon Simple Storage Service (Amazon S3) é um serviço de armazenamento de objetos.

Ações

deleteFile

Exclui o arquivo especificado de um bucket do S3.

<Action>deleteFile</Action>
<Input><![CDATA[
{
  "fileName" : "name-of-file-to-delete"
}
]]>
</Input>

<Action>deleteFile</Action>
<Input><![CDATA[
{
  "fileName" : "names.tmp"
}
]]>
</Input>

Parâmetros de solicitação

Resposta

Nenhum.

Propriedades da resposta

Nenhum.

downloadFile

Faz o download do arquivo especificado de um bucket do S3.

<Action>downloadFile</Action>
<Input><![CDATA[
{
  "fileName" : "filename"
}
]]>
</Input>
<Output>flow-variable</Output>

<Action>downloadFile</Action>
<Input><![CDATA[
{
  "fileName" : "product-sheet.pdf"
}
]]>
</Input>
<Output>downloaded.file</Output>

Parâmetros de solicitação

Resposta

JSON com uma propriedade content que inclui o conteúdo do arquivo.

{
  "content":"Hello World!"
}

Propriedades da resposta

generateSignedURL

Gera um URL assinado para fazer o download do arquivo especificado de um bucket do S3.

<Action>generateSignedURL</Action>
<Input><![CDATA[
{
  "fileName": "filename",
  "expiresIn": duration-in-seconds
}
]]>
</Input>
<Output>flow-variable</Output>

<Action>generateSignedURL</Action>
<Input><![CDATA[
{
  "fileName": "product-info.pdf",
  "expiresIn": 3600
}
]]>
</Input>
<Output>download.url</Output>

Parâmetros de solicitação

Resposta

JSON com uma propriedade de string url que contém o URL gerado.

{
  "url":"https://fake.s3.amazonaws.com/hello_world.txt?AWSAccessKeyId=123&Expires=1542753572&Signature=ABC"
}

Propriedades da resposta

listFiles

Invoca a execução de uma função do AWS Lambda.

<Action>listFiles</Action>
<Input><![CDATA[{}]]></Input>
<Output>flow-variable</Output>

Especifique parsed="false" no elemento <Output> se quiser a variável para conter o JSON bruto. Caso contrário, a variável não será utilizável.

<Action>listFiles</Action>
<Input><![CDATA[{}]]></Input>
<Output parsed="false">listFilesOutput</Output>

Parâmetros de solicitação

Nenhum.

Resposta

Uma matriz de nomes de arquivos do S3.

["hello_world.txt"]

Propriedades da resposta

Nenhum.

Referência de configuração

Use o seguinte ao configurar e implantar esta extensão para uso em proxies de API. Para saber como configurar uma extensão usando o console da Apigee, consulte Adicionar e configurar uma extensão.

Propriedades de extensão comuns

The following properties are present for every extension.

Propriedades deste pacote de extensão

Especifique valores para as seguintes propriedades de configuração específicas desta extensão.