amazon s3 connector

Description - Adds an object to a bucket. From document.

Runtime Class - com.ibi.agents.XDCreateObjectAgent


Configuration

This action requires a Amazon S3 Generic as well as the following required parameters.

Parameter Groups

 ParameterTypeDescription
*Bucket Name:stringBucket name.
*Key:stringSpecify the key name, which uniquely identifies the object in the bucket.There is no hierarchy of subbuckets or subfolders; however, you can infer logical hierarchy using key name prefixes and delimiters.
Encoding:stringServer-side encryption
Content Type:stringThe content type of new object.
* - denotes required
 ParameterTypeDescription
Canned ACL:string

Select from one of the following options:
  • private {Private} - Specifies that the owner is granted Permission.FullControl.
  • public-read {PublicRead} - Specifies that the owner is granted Permission.FullControl and the GroupGrantee.AllUsers group grantee is granted Permission.Read access.
  • public-read-write {PublicReadWrite} - Specifies that the owner is granted Permission.FullControl and the GroupGrantee.AllUsers group grantee is granted Permission.Read and Permission.Write access.
  • authenticated-read {AuthenticatedRead} - Specifies that the owner is granted Permission.FullControl and the GroupGrantee.AuthenticatedUsers group grantee is granted Permission.Read access.
  • log-delivery-write {LogDeliveryWrite} - Specifies that the owner is granted Permission.FullControl and the GroupGrantee.LogDelivery group grantee is granted Permission.Write access, so that access logs can be delivered.
  • bucket-owner-read {BucketOwnerRead} - Specifies that the owner of the bucket is granted Permission.Read. The owner of the bucket is not necessarily the same as the owner of the object.
  • bucket-owner-full-control {BucketOwnerFullControl} - Specifies that the owner of the bucket is granted Permission.FullControl. The owner of the bucket is not necessarily the same as the owner of the object.
  • aws-exec-read {AwsExecRead} - Owner gets FULL_CONTROL. Amazon EC2 gets READ access to GET an Amazon Machine Image (AMI) bundle from Amazon S3.
*Storage Class:string

Select from one of the following options:
  • STANDARD {Standard}
  • REDUCED_REDUNDANCY {ReducedRedundancy}
  • GLACIER {Glacier}
  • STANDARD_IA {StandardInfrequentAccess}
* - denotes required

Output Events

NameDescription
onInvalidStorageClassThe storage class you specified is not valid.
onInvalidObjectContentThis request does not support content.
onNoSuchBucketThe specified bucket does not exist.
onFailUnreachableThe host was located but cannot be reached.
onFailConnectCould not connect to the external system.
onInvalidVersionInvalid Version
onFailTimeoutThe operation timed out.
onInvalidObjectSizeYour object is either too small or too big.
onNoSuchKeyThe specified key does not exist.
onInvalidAccessKeyIDThe AWS access key ID you provided does not exist in our records.
Description - Retrieves objects from Amazon S3.

Runtime Class - com.ibi.agents.XDGetObjectAgent


Configuration

This action requires a Amazon S3 Generic as well as the following required parameters.

Parameter Groups

 ParameterTypeDescription
*Name:stringThe name of the bucket containing the desired object.
*Key:stringThe key in the specified bucket under which the object is stored.
Version Id:stringThe Amazon S3 version ID specifying a specific version of the object.
Last Modified:string Returns the object that has been modified after the specified date.Format yyyy-MM-dd
* - denotes required
 ParameterTypeDescription
Directory:stringThe target output directory
File Name:stringThe output file name, which can contain a '*' to generate unique timestamp
* - denotes required
 ParameterTypeDescription
Output Document:stringDocument returned by object

Select from one of the following options:
  • Results Document {result} - Returns the result or status document of the execution.
  • Input Document {input} - Returns the input document of the object.
* - denotes required

Output Events

NameDescription
no_such_bucketno_such_bucket
successThe operation was successful.
fail_unreachableThe host was located but cannot be reached.
fail_connectCould not connect to the external system.
invalid_versioninvalid_version
fail_timeoutThe operation timed out.
no_such_keyno_such_key
invalid_accessKey_idinvalid_accessKey_id
Description - You can use the versions subresource to list metadata about all of the versions of objects in a bucket.

Runtime Class - com.ibi.agents.XDListObjectVersionsAgent


Configuration

This action requires a Amazon S3 Generic as well as the following required parameters.

Parameter Groups

 ParameterTypeDescription
*Name:stringSets the name of the Amazon S3 bucket whose versions are to be listed
* - denotes required
 ParameterTypeDescription
Delimiter:stringA delimiter is a character that you specify to group keys. All keys that contain the same string between the prefix and the first occurrence of the delimiter are grouped under a single result element in CommonPrefixes. These groups are counted as one result against the max-keys limitation. These keys are not returned elsewhere in the response. Also, see prefix.
Key Marker:stringSpecifies the key in the bucket that you want to start listing from. Also, see version-id-marker.
Version ID Marker:stringSpecifies the object version you want to start listing from.
* - denotes required
 ParameterTypeDescription
Max Results:integerIndicating the maximum number of results to include in the response.
Next Batch:booleanIf the result is truncated, this check provides an easy way to continue a truncated version listing and retrieve the next page of results.
Prefix:stringUse this parameter to select only those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different groupings of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.) You can use prefix with delimiter to roll up numerous objects into a single result under CommonPrefixes.
Encoding Type:stringRequests Amazon S3 to encode the response and specifies the encoding method to use.An object key can contain any Unicode character. However, XML 1.0 parsers cannot parse some characters, such as characters with an ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response.

Select from one of the following options:
  • url
* - denotes required
 ParameterTypeDescription
Output Document:stringDocument returned by object

Select from one of the following options:
  • Results Document {result} - Returns the result or status document of the execution.
  • Input Document {input} - Returns the input document of the object.
* - denotes required

Output Events

NameDescription
no_such_bucketno_such_bucket
successThe operation was successful.
fail_unreachableThe host was located but cannot be reached.
fail_connectCould not connect to the external system.
invalid_versioninvalid_version
fail_timeoutThe operation timed out.
no_such_keyno_such_key
invalid_accessKey_idinvalid_accessKey_id
Description - Returns some or all (up to 1000) of the objects in a bucket.

Runtime Class - com.ibi.agents.XDListObjectsAgent


Configuration

This action requires a Amazon S3 Generic as well as the following required parameters.

Parameter Groups

 ParameterTypeDescription
*NamestringThe name of the bucket whose objects are to be listed.
* - denotes required
 ParameterTypeDescription
Delimiter:stringA delimiter is a character that you specify to group keys. All keys that contain the same string between the prefix and the first occurrence of the delimiter are grouped under a single result element in CommonPrefixes. These groups are counted as one result against the max-keys limitation. These keys are not returned elsewhere in the response. Also, see prefix.
Key Marker:stringSpecifies the key in the bucket that you want to start listing from. Also, see version-id-marker.
* - denotes required
 ParameterTypeDescription
Max Results:integerIndicating the maximum number of results to include in the response.
Next Batch:booleanIf the result is truncated, this check provides an easy way to continue a truncated object listing and retrieve the next page of results.
Encoding Type:stringRequests Amazon S3 to encode the response and specifies the encoding method to use.An object key can contain any Unicode character. However, XML 1.0 parsers cannot parse some characters, such as characters with an ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response.

Select from one of the following options:
  • url
* - denotes required
 ParameterTypeDescription
Output Document:stringDocument returned by object

Select from one of the following options:
  • Results Document {result} - Returns the result or status document of the execution.
  • Input Document {input} - Returns the input document of the object.
* - denotes required

Output Events

NameDescription
no_such_bucketno_such_bucket
successThe operation was successful.
fail_unreachableThe host was located but cannot be reached.
fail_connectCould not connect to the external system.
invalid_versioninvalid_version
fail_timeoutThe operation timed out.
no_such_keyno_such_key
invalid_accessKey_idinvalid_accessKey_id
Description - Creates a copy of an object that is already stored in Amazon S3.

Runtime Class - com.ibi.agents.XDCopyObjectAgent


Configuration

This action requires a Amazon S3 Generic as well as the following required parameters.

Parameter Groups

 ParameterTypeDescription
*Bucket Name:string The name of the S3 bucket containing the object to copy.
*Key:stringThe location, key which points to the object within the specified bucket.
Version ID:stringThe S3 version ID which uniquely identifies a specific version of the source object to copy.
Modified Since:string The modified constraint that restricts this action to executing only if the source object has been modified after the specified date.
* - denotes required
 ParameterTypeDescription
*Bucket Name:stringThe name of the S3 bucket to which the new object will be copied.
*Key:stringThe location, key which points to the object within the specified bucket.
ACL:stringAccess Control List for the new bucket.

Select from one of the following options:
  • private {Private} - Specifies that the owner is granted Permission.FullControl.
  • public-read {PublicRead} - Specifies that the owner is granted Permission.FullControl and the GroupGrantee.AllUsers group grantee is granted Permission.Read access.
  • public-read-write {PublicReadWrite} - Specifies that the owner is granted Permission.FullControl and the GroupGrantee.AllUsers group grantee is granted Permission.Read and Permission.Write access.
  • authenticated-read {AuthenticatedRead} - Specifies that the owner is granted Permission.FullControl and the GroupGrantee.AuthenticatedUsers group grantee is granted Permission.Read access.
  • log-delivery-write {LogDeliveryWrite} - Specifies that the owner is granted Permission.FullControl and the GroupGrantee.LogDelivery group grantee is granted Permission.Write access, so that access logs can be delivered.
  • bucket-owner-read {BucketOwnerRead} - Specifies that the owner of the bucket is granted Permission.Read. The owner of the bucket is not necessarily the same as the owner of the object.
  • bucket-owner-full-control {BucketOwnerFullControl} - Specifies that the owner of the bucket is granted Permission.FullControl. The owner of the bucket is not necessarily the same as the owner of the object.
  • aws-exec-read {AwsExecRead} - Owner gets FULL_CONTROL. Amazon EC2 gets READ access to GET an Amazon Machine Image (AMI) bundle from Amazon S3.
Destination Storage Class:stringAmazon S3 storage class to use when storing the newly copied object

Select from one of the following options:
  • STANDARD {Standard}
  • REDUCED_REDUNDANCY {ReducedRedundancy}
  • GLACIER {Glacier}
  • STANDARD_IA {StandardInfrequentAccess}
* - denotes required

Output Events

NameDescription
onFailOperationCould not perform the operation requested.
onInvalidStorageClassThe storage class you specified is not valid.
onNoSuchBucketThe specified bucket does not exist.
onFailUnreachableThe host was located but cannot be reached.
onFailConnectCould not connect to the external system.
onInvalidVersionInvalid Version
onFailTimeoutThe operation timed out.
onNoSuchKeyThe specified key does not exist.
onInvalidAccessKeyIDThe AWS access key ID you provided does not exist in our records.
Description - Returns a URL which can be used to create an object.

Runtime Class - com.ibi.agents.XDCreateObjectPresignedUrlAgent


Configuration

This action requires a Amazon S3 Generic as well as the following required parameters.

Parameter Groups

 ParameterTypeDescription
*Name:stringThe name of the bucket containing the desired Amazon S3 object.
*Key:stringThe key under which the desired Amazon S3 object is stored
Expiration Date:stringDate format yyyy-MM-dd HH:mm:ss
* - denotes required
 ParameterTypeDescription
*Method:string The HTTP method (GET, PUT, DELETE, HEAD) to be used in the request when the pre-signed URL is used

Select from one of the following options:
  • GET
  • POST
  • PUT
  • DELETE
  • HEAD
  • PATCH
* - denotes required
 ParameterTypeDescription
Output Document:stringDocument returned by object. Result value also will be stored in a special register named aws.signed.url

Select from one of the following options:
  • Results Document {result} - Returns the result or status document of the execution.
  • Input Document {input} - Returns the input document of the object.
* - denotes required

Output Events

NameDescription
onMethodNotAllowedThe specified method is not allowed against this resource.
onNoSuchBucketThe specified bucket does not exist.
onFailUnreachableThe host was located but cannot be reached.
onFailConnectCould not connect to the external system.
onInvalidVersionInvalid Version
onFailTimeoutThe operation timed out.
onNoSuchKeyThe specified key does not exist.
onInvalidAccessKeyIDThe AWS access key ID you provided does not exist in our records.
Description - Sets or updates an objects storage class.

Runtime Class - com.ibi.agents.XDPutObjectStorageClassAgent


Configuration

This action requires a Amazon S3 Generic as well as the following required parameters.

Parameter Groups

 ParameterTypeDescription
*Name:stringThe name of the bucket to set its objects ACL.
*Key:stringThe location, key which points to the object within the specified bucket.
* - denotes required
 ParameterTypeDescription
*Storage Class:string

Select from one of the following options:
  • STANDARD {Standard} - The default storage class. If you don't specify the storage class when you upload an object, Amazon S3 assigns the STANDARD storage class.
  • REDUCED_REDUNDANCY {ReducedRedundancy} - The Reduced Redundancy Storage (RRS) storage class is designed for noncritical, reproducible data that can be stored with less redundancy than the STANDARD storage class.
  • GLACIER {Glacier} - The GLACIER storage class is suitable for archiving data where data access is infrequent.
  • STANDARD_IA {StandardInfrequentAccess} - Amazon S3 stores the object data redundantly across multiple geographically separated Availability Zones (similar to STANDARD storage class).
* - denotes required

Output Events

NameDescription
invalid_storage_classinvalid_storage_class
no_such_bucketno_such_bucket
successThe operation was successful.
fail_unreachableThe host was located but cannot be reached.
fail_connectCould not connect to the external system.
invalid_versioninvalid_version
fail_timeoutThe operation timed out.
no_such_keyno_such_key
invalid_accessKey_idinvalid_accessKey_id
Description - Adds an object to a bucket. You must have WRITE permissions on a bucket to add an object to it.

Runtime Class - com.ibi.agents.XDCreateObjectAgent


Configuration

This action requires a Amazon S3 Generic as well as the following required parameters.

Parameter Groups

 ParameterTypeDescription
*Bucket Name:stringBucket name.
Key:stringIf blank, file name will set as a key. Specify the key name, which uniquely identifies the object in the bucket.There is no hierarchy of subbuckets or subfolders; however, you can infer logical hierarchy using key name prefixes and delimiters.
Encoding:stringServer-side encryption
Content Type:stringThe content type of new object.
* - denotes required
 ParameterTypeDescription
*File:stringUpload a file to an Amazon S3 bucket.
* - denotes required
 ParameterTypeDescription
Canned ACL:string

Select from one of the following options:
  • private {Private} - Specifies that the owner is granted Permission.FullControl.
  • public-read {PublicRead} - Specifies that the owner is granted Permission.FullControl and the GroupGrantee.AllUsers group grantee is granted Permission.Read access.
  • public-read-write {PublicReadWrite} - Specifies that the owner is granted Permission.FullControl and the GroupGrantee.AllUsers group grantee is granted Permission.Read and Permission.Write access.
  • authenticated-read {AuthenticatedRead} - Specifies that the owner is granted Permission.FullControl and the GroupGrantee.AuthenticatedUsers group grantee is granted Permission.Read access.
  • log-delivery-write {LogDeliveryWrite} - Specifies that the owner is granted Permission.FullControl and the GroupGrantee.LogDelivery group grantee is granted Permission.Write access, so that access logs can be delivered.
  • bucket-owner-read {BucketOwnerRead} - Specifies that the owner of the bucket is granted Permission.Read. The owner of the bucket is not necessarily the same as the owner of the object.
  • bucket-owner-full-control {BucketOwnerFullControl} - Specifies that the owner of the bucket is granted Permission.FullControl. The owner of the bucket is not necessarily the same as the owner of the object.
  • aws-exec-read {AwsExecRead} - Owner gets FULL_CONTROL. Amazon EC2 gets READ access to GET an Amazon Machine Image (AMI) bundle from Amazon S3.
*Storage Class:string

Select from one of the following options:
  • STANDARD {Standard}
  • REDUCED_REDUNDANCY {ReducedRedundancy}
  • GLACIER {Glacier}
  • STANDARD_IA {StandardInfrequentAccess}
* - denotes required

Output Events

NameDescription
onInvalidStorageClassThe storage class you specified is not valid.
onInvalidObjectContentThis request does not support content.
onNoSuchBucketThe specified bucket does not exist.
onFailUnreachableThe host was located but cannot be reached.
onFailConnectCould not connect to the external system.
onInvalidVersionInvalid Version
onFailTimeoutThe operation timed out.
onInvalidObjectSizeYour object is either too small or too big.
onNoSuchKeyThe specified key does not exist.
onInvalidAccessKeyIDThe AWS access key ID you provided does not exist in our records.
Description - Uses the acl subresource to set the access control list (ACL) permissions for an object that already exists in a bucket.

Runtime Class - com.ibi.agents.XDPutObjectAclAgent


Configuration

This action requires a Amazon S3 Generic as well as the following required parameters.

Parameter Groups

 ParameterTypeDescription
*Name:stringThe name of the bucket to set its objects ACL.
*Key:stringThe location, key which points to the object within the specified bucket.
* - denotes required
 ParameterTypeDescription
*ACL Policy:Table (as described below) Access control lists (ACLs) is a legacy access policy option to grant basic read/write permissions to other AWS accounts.
* - denotes required

ACL Policy:
 ColumnTypeDescription
Email AddressEmail address of the grantee.
WritebooleanAllows grantee to create and delete objects in the bucke.
ReadbooleanAllows grantee to read the bucket ACL
* - denotes required

Output Events

NameDescription
onInvalidStorageClassThe storage class you specified is not valid.
onNoSuchBucketThe specified bucket does not exist.
onFailUnreachableThe host was located but cannot be reached.
onFailConnectCould not connect to the external system.
onInvalidVersionInvalid Version
onFailTimeoutThe operation timed out.
onNoSuchKeyThe specified key does not exist.
onInvalidAccessKeyIDThe AWS access key ID you provided does not exist in our records.
Description - Sets a website configuration for a bucket which allows you treat a bucket as a deployed website.

Runtime Class - com.ibi.agents.XDPutBucketWebsiteConfigurationAgent


Configuration

This action requires a Amazon S3 Generic as well as the following required parameters.

Parameter Groups

 ParameterTypeDescription
*Name:stringName of the bucket to treat as a website.
* - denotes required
 ParameterTypeDescription
*Index Document:stringThis is the webpage that Amazon S3 returns when it receives a request to the root of your website, or one of its subdirectories. Amazon S3 supports index documents in subdirectories.
Error Document:stringWhen specified, Amazon S3 returns your custom error document when an HTTP 4XX class error occurs.
* - denotes required

Output Events

NameDescription
onNoSuchBucketThe specified bucket does not exist.
onFailUnreachableThe host was located but cannot be reached.
onFailConnectCould not connect to the external system.
onInvalidVersionInvalid Version
onFailTimeoutThe operation timed out.
onNoSuchKeyThe specified key does not exist.
onInvalidAccessKeyIDThe AWS access key ID you provided does not exist in our records.