Twoorb Plugins  1.0
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Package Twoorb.AWS

A series of classes created to communicate with our modified version of the AWSSDK for .NET. We recommend that you only use these classes to communicate with AWS from your project. More...

Classes

class  State< T >
 
class  StateMachine< T >
 
class  DynamoDBUtility
 A runtime utility class for the DynamoDB service to make it easier to use its features. If you need to communicate with DynamoDB in the editor instead of at runtime, we recommend that you use the NETDynamoDB class. More...
 
class  NETDynamoDB
 Helper class to communicate with .NET DynamoDBv2 methods in the AWSSDK More...
 
class  AmazonS3Utility
 A runtime utility class for the AmazonS3 service to make it easier to use its features. If you need to communicate with AmazonS3 in the editor instead of at runtime, we recommend that you use the NETAWSS3 class. More...
 
class  NETAWSS3
 Helper class to communicate with .NET S3 methods in the AWSSDK More...
 

Enumerations

enum  EAWSRegion {
  EAWSRegion.APNortheast1, EAWSRegion.APSoutheast1, EAWSRegion.APSoutheast2, EAWSRegion.EUWest1,
  EAWSRegion.SAEast1, EAWSRegion.USEast1, EAWSRegion.USWest1, EAWSRegion.USWest2
}
 Enum representing the different regions available in AWS More...
 
enum  EDynamoDBState { EDynamoDBState.Dormant, EDynamoDBState.Initializing, EDynamoDBState.ReadyToUse, EDynamoDBState.Closing }
 The different states the DynamoDB utility can be in. More...
 
enum  EAmazonS3State { EAmazonS3State.Dormant, EAmazonS3State.Initializing, EAmazonS3State.ReadyToUse, EAmazonS3State.Closing }
 The different states the AmazonS3 utility can be in. More...
 

Functions

delegate void ActionEventHandler ()
 
delegate void DynamoDBInitializeEventHandler (bool success)
 Event handler for initializing the DynamoDB service More...
 
delegate void DynamoDBListTablesEventHandler (bool success, ListTablesResponse response)
 Event handler for listing the available tables More...
 
delegate void DynamoDBCreateTableEventHandler (bool success, string tableName, CreateTableResponse response)
 Event handler for creating a new table More...
 
delegate void DynamoDBDeleteTableEventHandler (bool success, string tableName, DeleteTableResponse response)
 Event handler for deleting a table More...
 
delegate void DynamoDBDescribeTableEventHandler (bool success, string tableName, DescribeTableResponse response)
 Event handler for describing a table More...
 
delegate void DynamoDBUpdateTableEventHandler (bool success, string tableName, UpdateTableResponse response)
 Event handler for updating a table More...
 
delegate void DynamoDBCreateItemEventHandler (bool success, string tableName, PutItemResult itemResult)
 Event handler for creating an item More...
 
delegate void DynamoDBGetItemEventHandler (bool success, string tableName, GetItemResult itemResult)
 Event handler for getting an item from a table More...
 
delegate void DynamoDBDeleteItemEventHandler (bool success, string tableName, DeleteItemResult itemResult)
 Event handler for deleting an item in a table More...
 
delegate void DynamoDBUpdateItemEventHandler (bool success, string tableName, UpdateItemResult itemResult)
 Event handler for Updating an item in a table More...
 
delegate void DynamoDBBatchWriteItemEventHandler (bool success, BatchWriteItemResult itemResult)
 Event handler for batch writing items. More...
 
delegate void DynamoDBBatchGetItemEventHandler (bool success, BatchGetItemResult itemResult)
 Event handler for batch getting items. More...
 
delegate void DynamoDBQueryHandler (bool success, QueryResult result)
 Event handler for Querying a table More...
 
delegate void DynamoDBScanHandler (bool success, ScanResult result)
 Event handler for scanning a table. More...
 
delegate void S3InitializeEventHandler (bool success)
 Event handler for initializing the Amazon S3 service More...
 
delegate void S3CloseEventHandler (bool success)
 Event handler for closing the Amazon S3 service More...
 
delegate void S3ListBucketsEventHandler (bool success, List< string > availableBuckets)
 Event handler for listing available buckets. More...
 
delegate void S3CreateBucketEventHandler (bool success, string bucketName)
 Event handler for creating a bucket More...
 
delegate void S3DeleteBucketEventHandler (bool success, string bucketName)
 Event handler for deleting a bucket More...
 
delegate void S3ListObjectsEventHandler (bool success, string bucketName, List< string > objectsInBucket)
 Event handler for listing objects in a bucket More...
 
delegate void S3UploadFileEventHandler (bool success, string objectName)
 Event handler for uploading a file to a bucket More...
 
delegate void S3UploadDirectoryEventHandler (bool success, string directoryName)
 Event handler for uploading a directory to a bucket More...
 
delegate void S3DeleteFileEventHandler (bool success, string objectName)
 Event handler for deleting a file in a bucket More...
 
delegate void S3DownloadFileEventHandler (bool success, string key)
 Event handler for downloading a file from bucket More...
 
delegate void S3DownloadDirectoryEventHandler (bool success, string s3DirectoryName)
 Event handler for downloading a directory More...
 
delegate void S3GetDownloadUrlEventHandler (bool success, string key, string downloadUrl)
 Event handler for getting a pre-signed download url More...
 

Detailed Description

A series of classes created to communicate with our modified version of the AWSSDK for .NET. We recommend that you only use these classes to communicate with AWS from your project.

Enumeration Type Documentation

The different states the AmazonS3 utility can be in.

Enumerator
Dormant 

Dormant state. This is the initial state of the S3 Utility. Call Initialize to get out of this state

Initializing 

The Amazon Utility is currently initializing if this state is current

ReadyToUse 

If this state is current, the Amazon S3 Utility is ready to use

Closing 

The Amazon Utility is currently closing if this state is current

Enum representing the different regions available in AWS

Enumerator
APNortheast1 

Asia Pacific (Tokyo) Region

APSoutheast1 

Asia Pacific (Singapore) Region

APSoutheast2 

Asia Pacific (Sydney) Region

EUWest1 

EU (Ireland) Region

SAEast1 

South America (Sao Paulo) Region

USEast1 

US Standard

USWest1 

US West (Northern California) Region

USWest2 

US West (Oregon) Region

The different states the DynamoDB utility can be in.

Enumerator
Dormant 

Dormant state. This is the initial state of the DynamoDB Utility. Call Initialize to get out of this state

Initializing 

The DynamoDB Utility is currently initializing

ReadyToUse 

The DynamoDB Utility is ready to use

Closing 

The DynamoDB Utility is currently closing

Function Documentation

delegate void Twoorb.AWS.DynamoDBBatchGetItemEventHandler ( bool  success,
BatchGetItemResult  itemResult 
)

Event handler for batch getting items.

Parameters
successIf the batch get items operation was successful
itemResultThe BatchGetItemResult object. Will be null if success is false
delegate void Twoorb.AWS.DynamoDBBatchWriteItemEventHandler ( bool  success,
BatchWriteItemResult  itemResult 
)

Event handler for batch writing items.

Parameters
successIf the batch write operation was successful
itemResultThe BatchWriteItemResult object. Will be null if success is false.
delegate void Twoorb.AWS.DynamoDBCreateItemEventHandler ( bool  success,
string  tableName,
PutItemResult  itemResult 
)

Event handler for creating an item

Parameters
successIf the item was created successfully
tableNameThe name of the table the item was created in
itemResultThe PutItemResult. Will be null if success is false
delegate void Twoorb.AWS.DynamoDBCreateTableEventHandler ( bool  success,
string  tableName,
CreateTableResponse  response 
)

Event handler for creating a new table

Parameters
successIf the table was created successfully
tableNameThe name of the created table
responseThe CreateTableResponse. Will be null if success is false
delegate void Twoorb.AWS.DynamoDBDeleteItemEventHandler ( bool  success,
string  tableName,
DeleteItemResult  itemResult 
)

Event handler for deleting an item in a table

Parameters
successIf the item was deleted successfully
tableNameThe name of the table the item resides in
itemResultThe DeleteItemResult object. Will be null if success is false.
delegate void Twoorb.AWS.DynamoDBDeleteTableEventHandler ( bool  success,
string  tableName,
DeleteTableResponse  response 
)

Event handler for deleting a table

Parameters
successIf the table was deleted successfully
tableNameThe name of the deleted table
responseThe DeleteTableResponse. Will be null if success is false.
delegate void Twoorb.AWS.DynamoDBDescribeTableEventHandler ( bool  success,
string  tableName,
DescribeTableResponse  response 
)

Event handler for describing a table

Parameters
successIf the table was described successfully
tableNameThe name of the described table
responseThe DescribeTableResponse. Will be null if success is false.
delegate void Twoorb.AWS.DynamoDBGetItemEventHandler ( bool  success,
string  tableName,
GetItemResult  itemResult 
)

Event handler for getting an item from a table

Parameters
successIf the item was fetched successfully
tableNameThe name of the table operated on.
itemResultThe GetItemResult object. Will be null if success is false
delegate void Twoorb.AWS.DynamoDBInitializeEventHandler ( bool  success)

Event handler for initializing the DynamoDB service

Parameters
successIf the initialization was successful
delegate void Twoorb.AWS.DynamoDBListTablesEventHandler ( bool  success,
ListTablesResponse  response 
)

Event handler for listing the available tables

Parameters
successIf the operation was a success
responseThe ListTablesRespone. Will be null if success is false.
delegate void Twoorb.AWS.DynamoDBQueryHandler ( bool  success,
QueryResult  result 
)

Event handler for Querying a table

Parameters
successIf the query was a success
resultThe QueryResult object. Will be null if success is false.
delegate void Twoorb.AWS.DynamoDBScanHandler ( bool  success,
ScanResult  result 
)

Event handler for scanning a table.

Parameters
successIf the scan was a success
resultThe ScanResult object. Will be null if success is false.
delegate void Twoorb.AWS.DynamoDBUpdateItemEventHandler ( bool  success,
string  tableName,
UpdateItemResult  itemResult 
)

Event handler for Updating an item in a table

Parameters
successIf the update was a success
tableNameThe name of the table the item resides in
itemResultThe UpdateItemResult object. Will be null if success is false
delegate void Twoorb.AWS.DynamoDBUpdateTableEventHandler ( bool  success,
string  tableName,
UpdateTableResponse  response 
)

Event handler for updating a table

Parameters
successIf the table update was a success
tableNameThe name of the updated table
responseThe update table response. Will be null if success is false.
delegate void Twoorb.AWS.S3CloseEventHandler ( bool  success)

Event handler for closing the Amazon S3 service

Parameters
successIf the closing was successful
delegate void Twoorb.AWS.S3CreateBucketEventHandler ( bool  success,
string  bucketName 
)

Event handler for creating a bucket

Parameters
successIf the bucklet was created successfully
bucketNameThe name of the bucket
delegate void Twoorb.AWS.S3DeleteBucketEventHandler ( bool  success,
string  bucketName 
)

Event handler for deleting a bucket

Parameters
successIf the bucket was deleted successfully
bucketNameThe name of the bucket
delegate void Twoorb.AWS.S3DeleteFileEventHandler ( bool  success,
string  objectName 
)

Event handler for deleting a file in a bucket

Parameters
successIf the file was deleted successfully
objectNameThe name of the deleted object
delegate void Twoorb.AWS.S3DownloadDirectoryEventHandler ( bool  success,
string  s3DirectoryName 
)

Event handler for downloading a directory

Parameters
successIf the directory was downloaded successfully
s3DirectoryNameThe name of the downloaded directory
delegate void Twoorb.AWS.S3DownloadFileEventHandler ( bool  success,
string  key 
)

Event handler for downloading a file from bucket

Parameters
successIf the file was downloaded successfully
keyThe key of the downloaded file
delegate void Twoorb.AWS.S3GetDownloadUrlEventHandler ( bool  success,
string  key,
string  downloadUrl 
)

Event handler for getting a pre-signed download url

Parameters
successIf the operation was a success
keyThe key of the object to get the download url
downloadUrlThe pre-signed download url to the specified object.
delegate void Twoorb.AWS.S3InitializeEventHandler ( bool  success)

Event handler for initializing the Amazon S3 service

Parameters
successIf the initialization was successful
delegate void Twoorb.AWS.S3ListBucketsEventHandler ( bool  success,
List< string >  availableBuckets 
)

Event handler for listing available buckets.

Parameters
successIf the list buckets action was a success
availableBucketsA list of the available buckets. Is null if success is false
delegate void Twoorb.AWS.S3ListObjectsEventHandler ( bool  success,
string  bucketName,
List< string >  objectsInBucket 
)

Event handler for listing objects in a bucket

Parameters
successIf the list objects in bucket operation was a success
bucketNameThe name of the bucket
objectsInBucketThe list of objects in the bucket. Is null if success if false.
delegate void Twoorb.AWS.S3UploadDirectoryEventHandler ( bool  success,
string  directoryName 
)

Event handler for uploading a directory to a bucket

Parameters
successIf the directory was uploaded successfully
directoryNameThe name of the uploaded directory
delegate void Twoorb.AWS.S3UploadFileEventHandler ( bool  success,
string  objectName 
)

Event handler for uploading a file to a bucket

Parameters
successIf the file was uploaded successfully
objectNameThe name of the uploaded object