Amazon S3 Simple Storage Connector

This adapter manages data and its structures in Amazon S3 Blob Storage. It also persits data in cloud environments.

Properties

Parameters

Status values

Input

The adapter expects any input document, e.g. binary document or a base-64 document (XML or text).

• Operation Upload:  If parameter path is specified, no input document is required. In all other cases an input document is needed.
• Operation Download and Search:  No input document is required.

• Operation AddGrantsPermission:

  Sample input for the operation AddGrantsPermission

  XML

  <?xml version='1.0' encoding='UTF-8'?>
  <RootElement>
      <Grant id="Canonical User ID">
          <permission> Read </permission>
  		<permission> Write </permission>
  		<permission> WriteAcp </permission>
  		<permission> ReadAcp </permission>
  		<permission> FullControl </permission>
      </Grant>
  </RootElement>

   To add object permissions, the parameters bucket and file are required. To add bucket permissions, the parameter bucket is required and file has to be empty.

• Operation RevokeGrantsPermission:

  Sample input for the operation RevokeGrantsPermission

  XML

  <?xml version='1.0' encoding='UTF-8'?>
  <RootElement>
      <Grant id="Canonical User ID">
      </Grant>
  </RootElement>

   To add object permissions, the parameters bucket and file are required. To add bucket permissions, the parameter bucket is required and file has to be empty.

• For the operation AddBucketPolicy the input must have Json format.
   Find additional information such as sample bucket policies, permissions in a policy  and conditions in a policy.

• Operation DeleteMultiFiles:

  Sample input for the operation DeleteMultiFiles

  XML

  <?xml version='1.0' encoding='UTF-8'?>
  <RootElement>
      <Object name="File Name"></Object>
  	<Object name="File Name"></Object>
  	<Object name="File Name"></Object>
  	<Object name="File Name"></Object>
  </RootElement>

Output

The adapter returns different kind of documents depending on the executed operation:

• Operation Upload: 
  
  • If the adapter was executed successfully (status 1), the adapter returns an XML document.

  • If an error occurred during the adapter's execution (status -1), the adapter does not return anything.

• Operation Search:

  • If the adapter was executed successfully (status 1), the adapter returns an XML document with the used filters.

    Sample output for operation SEARCH

    XML

    <?xml version='1.0' encoding='UTF-8'?>
    <ListBucket>
        <Bucket name="test-malaga2" region="eu-west-1">
            <Object name="myFile.xml" url="https://s3-eu-west-1.amazonaws.com/test-malaga2/myFile.xml"/>
            <Object name="myFile2.xml" url="https://s3-eu-west-1.amazonaws.com/test-malaga2/myFile2.xml"/>
            <Object name="pic2.jpg" url="https://s3-eu-west-1.amazonaws.com/test-malaga2/pic2.jpg"/>
            <Object name="testing_folders/" url="https://s3-eu-west-1.amazonaws.com/test-malaga2/testing_folders/"/>
            <Object name="testing_folders/personalData.txt" url="https://s3-eu-west-1.amazonaws.com/test-malaga2/testing_folders/personalData.txt"/>
        </Bucket>
    </ListBucket>

  • If the adapter was executed successfully (status 1) and the parameter IncludeObjectsMetada is selected, the metadata for each object are output additionally:

    Sample output for operation SEARCH including metadata

    XML

    <?xml version='1.0' encoding='UTF-8'?>
    <ListBucket>
        <Bucket name="test-malaga2" region="eu-west-1">
            <Object name="myFile.xml" url="https://s3-eu-west-1.amazonaws.com/test-malaga2/myFile.xml">
                <Metadata lastModified="2018-12-10 13:42:38.000 +0100" instanceLength="158" eTag="a933d9ca99b473c7921c496727a32f91" contentType="application/octet-stream" contentLength="158"/>
            </Object>
            <Object name="myFile2.xml" url="https://s3-eu-west-1.amazonaws.com/test-malaga2/myFile2.xml">
                <Metadata lastModified="2018-12-10 12:02:07.000 +0100" instanceLength="158" eTag="a933d9ca99b473c7921c496727a32f91" contentType="application/octet-stream" contentLength="158" contentLanguage="English"/>
            </Object>
            <Object name="pic2.jpg" url="https://s3-eu-west-1.amazonaws.com/test-malaga2/pic2.jpg">
                <Metadata lastModified="2018-12-10 11:37:52.000 +0100" instanceLength="59580" eTag="fb913694d969758b431277b366f53d7" contentType="image/jpeg" contentLength="59580" contentLanguage="Spanish"/>
            </Object>
            <Object name="testing_folders/" url="https://s3-eu-west-1.amazonaws.com/test-malaga2/testing_folders/">
                <Metadata lastModified="2018-12-10 12:24:54.000 +0100" eTag="d41d8cd98f00b204e9800998ecf8427e" contentType="application/x-directory"/>
            </Object>
            <Object name="testing_folders/personalData.txt" url="https://s3-eu-west-1.amazonaws.com/test-malaga2/testing_folders/personalData.txt">
                <Metadata lastModified="2018-12-10 12:30:35.000 +0100" instanceLength="33" eTag="7960fb01e91834eb9d5ccbacdf45d0e5" contentType="application/octet-stream" contentLength="33" contentLanguage="Spanish"/>
            </Object>
        </Bucket>
    </ListBucket>

  • If an error occurred during the adapter's execution (status -1), the adapter does not return anything.

• Operation Download:
  • If the adapter was executed successfully (status 1), the adapter returns the downloaded blob (text, XML, binary doc etc.).
  • If the object or bucket do not exist the status -1 is returned.

• Operation GetAccessControlList:

  Sample output for the operation GetAccessControlList

  XML

  <AccessControlList>
      <Object Grant="e0188cd1cbfbb71222450e8e416e138172b036cdf3646ab51fb0ae6334d5ae51" Permission="FULL_CONTROL"/>
      <Object Grant="7779a9de4e188ca2c3fd5ef47f12f2a0fd3b9b30d283e343e0a55746d8df4802" Permission="READ"/>
  	<Object Grant="7779a9de4e188ca2c3fd5ef47f12f2a0fd3b9b30d283e343e0a55746d8df4802" Permission="READ_ACP"/>
  </AccessControlList>

• Operation GetBucketPolicy :

  JAVA

  {
  "Version":"2012-10-17", "Statement":[
  }
  "Sid":"AddPerm",
  "Effect":"Allow",
  "Principal":"*",
  "Action":"s3:GetObject",
  "Resource":"arn:aws:s3:::softprojectamazons3input/*"
  }
  ]
  }