Amazon API

Overview

These public interfaces are used in Amazon related services components. They are provided for implementing advanced functionality in your scripts. In order for you to use these interfaces in your project, you have to reference CozyRoc.SSISPlus.dll library.

IAmazonS3Connection

When you call Amazon S3 Connection Manager AcquireConnection method, it returns object implementing IAmazonS3Connection interface. This is the interface used for interaction with Amazon S3 service.

GetBucketsList method

Retrieves list of available buckets. The method result is array of strings.

GetBucketContent method

Retrieves list of available objects in a bucket. The method result is array of IFileInfo objects. These are the method parameters:

  • bucket (string) - name of bucket.
GetObject method

Downloads object from Amazon S3 service. The method result is Stream to object. These are the method parameters:

  • bucket (string) - name of bucket.
  • name (string) - name of object.
SendObject method

Uploads object to Amazon S3 service. These are the method parameters:

  • bucket (string) - name of bucket.
  • name (string) - name of object.
  • stream (Stream) - stream to uploaded object.
  • contentType (string) - MIME content type of object.
  • acl (string) - access control of object. This parameter has the options listed in the following table (from Amazon S3 documentation).
    Value Description
    private Owner gets FULL_CONTROL.
    public-read Owner gets FULL_CONTROL and the anonymous principal is granted READ access.
    public-read-write Owner gets FULL_CONTROL, the anonymous principal is granted READ and WRITE access.
    authenticated-read Owner gets FULL_CONTROL, and any principal authenticated as a registered Amazon S3 user is granted READ access.
RemoveObject method

Removes object from Amazon S3 service. These are the method parameters:

  • bucket (string) - name of bucket.
  • name (string) - name of object.
CopyObject method (1.6 SR-1)

Copies object from Amazon S3 bucket to another. These are the method parameters:

  • srcBucket (string) - name of source bucket.
  • name (string) - name of source object.
  • destBucket (string) - name of destination bucket.
  • destName (string) - name of destination object.
ServerHost property (string)

Specify the name or IP address of the Amazon S3 service.

ServerSecure property (bool)

Specify to establish secure HTTPS connection with Amazon S3 service on port 443.

ServerRegularCalling property (bool)

Specify to connect to Amazon S3 service, using regular calling format. Set to false, when connecting to EU Amazon S3 service.

ServerUser property (string)

Specify access key for Amazon S3 service.

ServerPassword property (string)

Specify secret key for Amazon S3 service.

ServerTimeout property (int)

Specify the number of seconds before timing out session connect. The default value of this property is 100.

UseProxy property (bool)

Set to true to use proxy.

ProxyHost property (string)

Specify the name or IP address of the proxy server.

ProxyPort property (int)

Specify the port number on the proxy server to use for the connection. The default value of this property is 80.

ProxyUser property (string)

Specify user name to access the proxy server.

ProxyPassword property (string)

Specify password to access the proxy server.