Amazon S3 Extension

You're viewing Apigee Edge documentation.
Go to the Apigee X documentation. info

Version: 1.1.0

Manage files in an Amazon S3 bucket. With this extension, you can list, download, and delete files. You can also generate a signed URL for downloading a file.

Each configured instance of this extension works with a specific bucket. For multiple buckets, use a configured instance of this extension for each bucket.

Prerequisites

Before using the extension from an API proxy using the ExtensionCallout policy, you must:

• Get the access key ID and secret access key for the Amazon S3 bucket you'll be working with.

  You'll need these, along with the AWS bucket name and AWS region, to configure this extension.

About Amazon S3

Amazon Simple Storage Service (Amazon S3) is an object storage service.

Actions

deleteFile

Deletes the specified file from an S3 bucket.

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

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

Request parameters

Response

None.

Response properties

None.

downloadFile

Downloads the specified file from an S3 bucket.

<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>

Request parameters

Response

JSON with a content property containing the file's content.

{
  "content":"Hello World!"
}

Response properties

generateSignedURL

Generates a signed URL for downloading the specified file from an S3 bucket.

<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>

Request parameters

Response

JSON with a url string property containing the generated URL.

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

Response properties

listFiles

Invokes the execution of an AWS Lambda function.

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

You must specify parsed="false" on the <Output> element if you would like the variable to contain the raw JSON. Otherwise, the variable is not usable.

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

Request parameters

None.

Response

An array of S3 file names.

["hello_world.txt"]

Response properties

None.

Configuration Reference

Use the following when you're configuring and deploying this extension for use in API proxies. For steps to configure an extension using the Apigee console, see Adding and configuring an extension.

Common extension properties

The following properties are present for every extension.

Properties for this extension package

Specify values for the following configuration properties specific to this extension.