Ballerina API Documentation

Connectors of org.ballerinalang.connectors.amazons3 package

connector ClientConnector (string accessKeyId, string secretAccessKey, string region)

Amazon S3 client connector

Parameters:

Parameter NameData TypeDescription
accessKeyIdstringThe access key ID of the Amazon Account
secretAccessKeystringThe secret access key of the Amazon Account
regionstringThe region to which the request is made

Actions:

action getBucketList()

Get List of Buckets

Parameters:

Parameter NameData TypeDescription
s3ConnectorClientConnector

Return Parameters:

Return VariableData TypeDescription
messageresponse object

action getObjectList()

Get List of Objects in a bucket

Parameters:

Parameter NameData TypeDescription
s3ConnectorClientConnectorbucketName: The relevant bucket name
bucketNamestringThe relevant bucket name

Return Parameters:

Return VariableData TypeDescription
messageresponse object

action createBucket()

Create new Bucket

Parameters:

Parameter NameData TypeDescription
s3ConnectorClientConnectorbucketName: The relevant bucket name
bucketNamestringThe relevant bucket name

Return Parameters:

Return VariableData TypeDescription
messageresponse object

action deleteBucket()

Delete a Bucket

Parameters:

Parameter NameData TypeDescription
s3ConnectorClientConnectorbucketName: The relevant bucket name
bucketNamestringThe relevant bucket name

Return Parameters:

Return VariableData TypeDescription
messageresponse object

action getObject()

Get an Object

Parameters:

Parameter NameData TypeDescription
s3ConnectorClientConnectorbucketName: The relevant bucket name
bucketNamestringThe relevant bucket name
objectNamestringThe relevant object name

Return Parameters:

Return VariableData TypeDescription
messageresponse object

action deleteObject()

Delete an Object

Parameters:

Parameter NameData TypeDescription
s3ConnectorClientConnectorbucketName: The relevant bucket name
bucketNamestringThe relevant bucket name
objectNamestringThe relevant object name

Return Parameters:

Return VariableData TypeDescription
messageresponse object

action putObject()

Put an Object

Parameters:

Parameter NameData TypeDescription
s3ConnectorClientConnectorbucketName: The relevant bucket name
bucketNamestringThe relevant bucket name
objectNamestringThe relevant object name
payloadstringThe file that needed to be uploaded

Return Parameters:

Return VariableData TypeDescription
messageresponse object


Menu

  • Connectors
    • ClientConnector (string accessKeyId, string secretAccessKey, string region)
      • getBucketList(ClientConnector s3Connector)
      • getObjectList(ClientConnector s3Connector, string bucketName)
      • createBucket(ClientConnector s3Connector, string bucketName)
      • deleteBucket(ClientConnector s3Connector, string bucketName)
      • getObject(ClientConnector s3Connector, string bucketName, string objectName)
      • deleteObject(ClientConnector s3Connector, string bucketName, string objectName)
      • putObject(ClientConnector s3Connector, string bucketName, string objectName, string payload)

Copyright 2017 Ballerina API Documentation