Connectors of org.wso2.ballerina.connectors.amazons3 package
connector ClientConnector (string accessKeyId, string secretAccessKey, string region)
Amazon S3 client connector
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
accessKeyId | string | The access key ID of the Amazon Account |
secretAccessKey | string | The secret access key of the Amazon Account |
region | string | The region to which the request is made |
action createBucket()
Create new Bucket
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
s3Connector | ClientConnector | The amazonS3 Connector instance |
bucketName | string | The relevant bucket name |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
message | response object |
action deleteBucket()
Delete a Bucket
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
s3Connector | ClientConnector | The amazonS3 Connector instance |
bucketName | string | The relevant bucket name |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
message | response object |
action deleteObject()
Delete an Object
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
s3Connector | ClientConnector | The amazonS3 Connector instance |
bucketName | string | The relevant bucket name |
objectName | string | The relevant object name |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
message | response object |
action getBucketList()
Get List of Buckets
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
s3Connector | ClientConnector | The amazonS3 Connector instance |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
message | response object |
action getObject()
Get an Object
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
s3Connector | ClientConnector | The amazonS3 Connector instance |
bucketName | string | The relevant bucket name |
objectName | string | The relevant object name |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
message | response object |
action getObjectList()
Get List of Objects in a bucket
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
s3Connector | ClientConnector | The amazonS3 Connector instance |
bucketName | string | The relevant bucket name |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
message | response object |
action putObject()
Put an Object
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
s3Connector | ClientConnector | The amazonS3 Connector instance |
bucketName | string | The relevant bucket name |
objectName | string | The relevant object name |
payload | string | The file that needed to be uploaded |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
message | response object |