AmazonGlacier Component

Properties   Methods   Events   Config Settings   Errors  

The AmazonGlacier component provides a quick way to interface with Amazon's Glacier service.

Syntax

TcsAmazonGlacier

Remarks

The AmazonGlacier component allows you to simply access Amazon's Glacier service. Glacier allows you to create vaults and store archives.

Before using the component you must first have an AWS account and sign up for the Glacier service. To use the component first set AccessKey and SecretKey.

To create a vault call CreateVault. Once the vault is created you are ready to upload archives to store in the vault. Set LocalFile to the file you want to upload and call UploadArchive.

To retrieve an archive you must create a job. Jobs are long running operations and Amazon will notify you when the job is complete. To create a job call CreateJob. Use the SetNotificationInfo method to set notification options at the vault level. You may also supply an Amazon SNS topic to CreateJob to which Amazon will publish notification about the job status.

You can also call CreateJob to create an Inventory Retrieval job to list the contents of a vault.

After the job is complete use GetJobOutput to retrieve the data.

Additionally, multipart uploads are supported through the StartMultipartUpload and CompleteMultipartUpload methods. Various other operations such as DeleteArchive, GetJobInfo, ListJobs, ListMultipartUploads, ListVaults, and more provide additional functionality.

Property List

The following is the full list of the properties of the component with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the component with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the component with short descriptions. Click on the links for further details.

AccessKey Property (AmazonGlacier Component)

The access key to use for authentication.

Syntax

__property String AccessKey = { read=FAccessKey, write=FSetAccessKey };

Default Value

""

Remarks

This property specifies the access key that should be used for authentication. Both this property and SecretKey must be set before attempting any operations which connect to the server.

Data Type

String

ArchiveData Property (AmazonGlacier Component)

Holds the archive data.

Syntax

__property String ArchiveData = { read=FArchiveData, write=FSetArchiveData };
__property DynamicArray<Byte> ArchiveDataB = { read=FArchiveDataB, write=FSetArchiveDataB };

Default Value

""

Remarks

This property holds the archive data. It is populated after calling GetJobOutput when the job is an archive retrieval. It may be set to archive data before calling UploadArchive.

This property is not available at design time.

Data Type

Byte Array

EncryptionAlgorithm Property (AmazonGlacier Component)

The encryption algorithm.

Syntax

__property TcsAmazonGlacierEncryptionAlgorithms EncryptionAlgorithm = { read=FEncryptionAlgorithm, write=FSetEncryptionAlgorithm };

enum TcsAmazonGlacierEncryptionAlgorithms {
  eaAES=0,
  eaBlowfish=1,
  eaCAST=2,
  eaDES=3,
  eaIDEA=4,
  eaRC2=5,
  eaRC4=6,
  eaTEA=7,
  eaTripleDES=8,
  eaTwofish=9,
  eaRijndael=10,
  eaChaCha=11,
  eaXSalsa20=12
};

Default Value

eaAES

Remarks

This property specifies the encryption algorithm to be used. The maximum allowable key size is automatically used for the selected algorithm. Possible values are:

Data Type

Integer

EncryptionPassword Property (AmazonGlacier Component)

The encryption password.

Syntax

__property String EncryptionPassword = { read=FEncryptionPassword, write=FSetEncryptionPassword };

Default Value

""

Remarks

If this property is populated when UploadFile or DownloadFile is called, the component will attempt to encrypt or decrypt the data before uploading or after downloading it.

The component uses the value specified here to generate the necessary encryption Key and IV values using the PKCS5 password digest algorithm. This provides a simpler alternative to creating and managing Key and IV values directly.

However, it is also possible to explicitly specify the Key and IV values to use by setting the EncryptionKey and EncryptionIV configuration settings. This may be necessary if, e.g., the data needs to be encrypted/decrypted by another utility which generates Key and IV values differently.

This property is not available at design time.

Data Type

String

FirewallAutoDetect Property (AmazonGlacier Component)

This property tells the component whether or not to automatically detect and use firewall system settings, if available.

Syntax

__property bool FirewallAutoDetect = { read=FFirewallAutoDetect, write=FSetFirewallAutoDetect };

Default Value

False

Remarks

This property tells the component whether or not to automatically detect and use firewall system settings, if available.

Data Type

Boolean

FirewallType Property (AmazonGlacier Component)

This property determines the type of firewall to connect through.

Syntax

__property TcsAmazonGlacierFirewallTypes FirewallType = { read=FFirewallType, write=FSetFirewallType };

enum TcsAmazonGlacierFirewallTypes {
  fwNone=0,
  fwTunnel=1,
  fwSOCKS4=2,
  fwSOCKS5=3,
  fwSOCKS4A=10
};

Default Value

fwNone

Remarks

This property determines the type of firewall to connect through. The applicable values are as follows:

Data Type

Integer

FirewallHost Property (AmazonGlacier Component)

This property contains the name or IP address of firewall (optional).

Syntax

__property String FirewallHost = { read=FFirewallHost, write=FSetFirewallHost };

Default Value

""

Remarks

This property contains the name or IP address of firewall (optional). If a FirewallHost is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the component raises an exception.

Data Type

String

FirewallPassword Property (AmazonGlacier Component)

This property contains a password if authentication is to be used when connecting through the firewall.

Syntax

__property String FirewallPassword = { read=FFirewallPassword, write=FSetFirewallPassword };

Default Value

""

Remarks

This property contains a password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the component raises an exception.

Data Type

String

FirewallPort Property (AmazonGlacier Component)

This property contains the transmission control protocol (TCP) port for the firewall Host .

Syntax

__property int FirewallPort = { read=FFirewallPort, write=FSetFirewallPort };

Default Value

0

Remarks

This property contains the transmission control protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.

Note: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.

Data Type

Integer

FirewallUser Property (AmazonGlacier Component)

This property contains a user name if authentication is to be used connecting through a firewall.

Syntax

__property String FirewallUser = { read=FFirewallUser, write=FSetFirewallUser };

Default Value

""

Remarks

This property contains a user name if authentication is to be used connecting through a firewall. If the FirewallHost is specified, this property and FirewallPassword properties are used to connect and authenticate to the given Firewall. If the authentication fails, the component raises an exception.

Data Type

String

Idle Property (AmazonGlacier Component)

The current status of the component.

Syntax

__property bool Idle = { read=FIdle };

Default Value

True

Remarks

Idle will be False if the component is currently busy (communicating and/or waiting for an answer), and True at all other times.

This property is read-only.

Data Type

Boolean

InventoryData Property (AmazonGlacier Component)

Holds the inventory data.

Syntax

__property String InventoryData = { read=FInventoryData };
__property DynamicArray<Byte> InventoryDataB = { read=FInventoryDataB };

Default Value

""

Remarks

This property holds the inventory data and is populated after calling GetJobOutput if the job is an inventory retrieval job.

This property is read-only and not available at design time.

Data Type

Byte Array

JobMarker Property (AmazonGlacier Component)

A marker used to get the next page of results.

Syntax

__property String JobMarker = { read=FJobMarker, write=FSetJobMarker };

Default Value

""

Remarks

This property is populated after calling ListJobs if the results are paged. This property holds the marker that will be sent in the next call to ListJobs to get the next page of results.

This property is not available at design time.

Data Type

String

JobCount Property (AmazonGlacier Component)

The number of records in the Job arrays.

Syntax

__property int JobCount = { read=FJobCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• JobArchiveId
• JobArchiveSHA256TreeHash
• JobArchiveSize
• JobCompleted
• JobCompletionDate
• JobCreationDate
• JobDescription
• JobId
• JobInventorySize
• JobSHA256TreeHash
• JobSNSTopic
• JobStatusCode
• JobStatusMessage
• JobType
• JobVaultArn

The array indices start at 0 and end at JobCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

JobArchiveId Property (AmazonGlacier Component)

This property is populated with the ArchiveId associated with the Job.

Syntax

__property String JobArchiveId[int JobIndex] = { read=FJobArchiveId };

Default Value

""

Remarks

This property is populated with the ArchiveId associated with the Job.

This is only applicable when JobType is 0 (archive retrieval).

The JobIndex parameter specifies the index of the item in the array. The size of the array is controlled by the JobCount property.

This property is read-only and not available at design time.

Data Type

String

JobArchiveSHA256TreeHash Property (AmazonGlacier Component)

The SHA256 tree hash of the entire archive for an archive retrieval job.

Syntax

__property String JobArchiveSHA256TreeHash[int JobIndex] = { read=FJobArchiveSHA256TreeHash };

Default Value

""

Remarks

The SHA256 tree hash of the entire archive for an archive retrieval job.

This is only applicable when JobType is 0 (archive retrieval).

The JobIndex parameter specifies the index of the item in the array. The size of the array is controlled by the JobCount property.

This property is read-only and not available at design time.

Data Type

String

JobArchiveSize Property (AmazonGlacier Component)

The size of the archive in bytes.

Syntax

__property __int64 JobArchiveSize[int JobIndex] = { read=FJobArchiveSize };

Default Value

0

Remarks

The size of the archive in bytes.

This is only applicable when JobType is 0 (archive retrieval).

The JobIndex parameter specifies the index of the item in the array. The size of the array is controlled by the JobCount property.

This property is read-only and not available at design time.

Data Type

Long64

JobCompleted Property (AmazonGlacier Component)

Indicates the completion status of the job.

Syntax

__property bool JobCompleted[int JobIndex] = { read=FJobCompleted };

Default Value

False

Remarks

Indicates the completion status of the job. By default both incomplete jobs and recently completed jobs are returned when calling ListJobs. See JobCompletionFilter for more options.

The JobIndex parameter specifies the index of the item in the array. The size of the array is controlled by the JobCount property.

This property is read-only and not available at design time.

Data Type

Boolean

JobCompletionDate Property (AmazonGlacier Component)

The UTC time that the job completed.

Syntax

__property String JobCompletionDate[int JobIndex] = { read=FJobCompletionDate };

Default Value

""

Remarks

The UTC time that the job completed.

The JobIndex parameter specifies the index of the item in the array. The size of the array is controlled by the JobCount property.

This property is read-only and not available at design time.

Data Type

String

JobCreationDate Property (AmazonGlacier Component)

The UTC time that the job was created.

Syntax

__property String JobCreationDate[int JobIndex] = { read=FJobCreationDate };

Default Value

""

Remarks

The UTC time that the job was created. This is a string representation of ISO 8601 date format, for example: "2012-03-20T17:03:43.221Z".

The JobIndex parameter specifies the index of the item in the array. The size of the array is controlled by the JobCount property.

This property is read-only and not available at design time.

Data Type

String

JobDescription Property (AmazonGlacier Component)

The user supplied description.

Syntax

__property String JobDescription[int JobIndex] = { read=FJobDescription };

Default Value

""

Remarks

The user supplied description. This is specified by the JobDescription setting before calling CreateJob.

The JobIndex parameter specifies the index of the item in the array. The size of the array is controlled by the JobCount property.

This property is read-only and not available at design time.

Data Type

String

JobInventorySize Property (AmazonGlacier Component)

The size in bytes of the inventory data.

Syntax

__property __int64 JobInventorySize[int JobIndex] = { read=FJobInventorySize };

Default Value

0

Remarks

The size in bytes of the inventory data. This is only applicable when JobType is 1 (inventory retrieval).

The JobIndex parameter specifies the index of the item in the array. The size of the array is controlled by the JobCount property.

This property is read-only and not available at design time.

Data Type

Long64

JobId Property (AmazonGlacier Component)

The Amazon assigned JobId.

Syntax

__property String JobId[int JobIndex] = { read=FJobId };

Default Value

""

Remarks

The Amazon assigned JobId.

The JobIndex parameter specifies the index of the item in the array. The size of the array is controlled by the JobCount property.

This property is read-only and not available at design time.

Data Type

String

JobSHA256TreeHash Property (AmazonGlacier Component)

The SHA256 tree hash value for the requested range of an archive.

Syntax

__property String JobSHA256TreeHash[int JobIndex] = { read=FJobSHA256TreeHash };

Default Value

""

Remarks

The SHA256 tree hash value for the requested range of an archive. This is only applicable when JobType is 0 (archive retrieval) and a JobRetrievalByteRange is set to a tree-hash aligned range.

When the whole archive is retrieved this values is the same as JobArchiveSHA256TreeHash.

The JobIndex parameter specifies the index of the item in the array. The size of the array is controlled by the JobCount property.

This property is read-only and not available at design time.

Data Type

String

JobSNSTopic Property (AmazonGlacier Component)

The Amazon SNS topic that will receive notifications about the job status.

Syntax

__property String JobSNSTopic[int JobIndex] = { read=FJobSNSTopic };

Default Value

""

Remarks

The Amazon SNS topic that will receive notifications about the job status.

The JobIndex parameter specifies the index of the item in the array. The size of the array is controlled by the JobCount property.

This property is read-only and not available at design time.

Data Type

String

JobStatusCode Property (AmazonGlacier Component)

The current status of the job.

Syntax

__property TcsAmazonGlacierJobStatusCodes JobStatusCode[int JobIndex] = { read=FJobStatusCode };

enum TcsAmazonGlacierJobStatusCodes {
  jsNone=0,
  jsInProgress=1,
  jsSucceeded=2,
  jsFailed=3
};

Default Value

jsNone

Remarks

The current status of the job. Possible values are:

• jsNone (0)
• jsInProgress (1)
• jsSucceeded (2)
• jsFailed (3)

The JobIndex parameter specifies the index of the item in the array. The size of the array is controlled by the JobCount property.

This property is read-only and not available at design time.

Data Type

Integer

JobStatusMessage Property (AmazonGlacier Component)

A user friendly description of the status.

Syntax

__property String JobStatusMessage[int JobIndex] = { read=FJobStatusMessage };

Default Value

""

Remarks

A user friendly description of the status.

The JobIndex parameter specifies the index of the item in the array. The size of the array is controlled by the JobCount property.

This property is read-only and not available at design time.

Data Type

String

JobType Property (AmazonGlacier Component)

The type of the current job.

Syntax

__property TcsAmazonGlacierJobTypes JobType[int JobIndex] = { read=FJobType };

enum TcsAmazonGlacierJobTypes {
  jtArchiveRetrieval=0,
  jtInventoryRetrieval=1
};

Default Value

jtArchiveRetrieval

Remarks

The type of the current job. Possible values are:

• jtArchiveRetrieval (0)
• jtInventoryRetrieval (1)

The JobIndex parameter specifies the index of the item in the array. The size of the array is controlled by the JobCount property.

This property is read-only and not available at design time.

Data Type

Integer

JobVaultArn Property (AmazonGlacier Component)

The Amazon Resource Name (ARN) of the vault from which the archive retrieval or inventory retrieval was requested.

Syntax

__property String JobVaultArn[int JobIndex] = { read=FJobVaultArn };

Default Value

""

Remarks

The Amazon Resource Name (ARN) of the vault from which the archive retrieval or inventory retrieval was requested.

The JobIndex parameter specifies the index of the item in the array. The size of the array is controlled by the JobCount property.

This property is read-only and not available at design time.

Data Type

String

LocalFile Property (AmazonGlacier Component)

The path to a local file for uploading or downloading.

Syntax

__property String LocalFile = { read=FLocalFile, write=FSetLocalFile };

Default Value

""

Remarks

This property is used to specify a local file that will be used for uploading or downloading. Set this to a local file before calling GetJobOutput. Set this to a local file to upload before calling UploadArchive.

This property is not available at design time.

Data Type

String

LocalHost Property (AmazonGlacier Component)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

__property String LocalHost = { read=FLocalHost, write=FSetLocalHost };

Default Value

""

Remarks

The LocalHost property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the component initiate connections (or accept in the case of server components) only through that interface.

If the component is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).

NOTE: LocalHost is not persistent. You must always set it in code, and never in the property window.

Data Type

String

MultipartUploadMarker Property (AmazonGlacier Component)

A marker used to get the next page of results.

Syntax

__property String MultipartUploadMarker = { read=FMultipartUploadMarker, write=FSetMultipartUploadMarker };

Default Value

""

Remarks

This property is populated after calling ListMultipartUploads if the results are paged. This property holds the marker that will be sent in the next call to ListMultipartUploads to get the next page of results.

This property is not available at design time.

Data Type

String

MultipartUploadCount Property (AmazonGlacier Component)

The number of records in the MultipartUpload arrays.

Syntax

__property int MultipartUploadCount = { read=FMultipartUploadCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• MultipartUploadArchiveDescription
• MultipartUploadCreationDate
• MultipartUploadId
• MultipartUploadPartSize
• MultipartUploadVaultArn

The array indices start at 0 and end at MultipartUploadCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

MultipartUploadArchiveDescription Property (AmazonGlacier Component)

The description of the archive (if any).

Syntax

__property String MultipartUploadArchiveDescription[int MultipartUploadIndex] = { read=FMultipartUploadArchiveDescription };

Default Value

""

Remarks

The description of the archive (if any).

The MultipartUploadIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MultipartUploadCount property.

This property is read-only and not available at design time.

Data Type

String

MultipartUploadCreationDate Property (AmazonGlacier Component)

The UTC time that the multipart upload was started.

Syntax

__property String MultipartUploadCreationDate[int MultipartUploadIndex] = { read=FMultipartUploadCreationDate };

Default Value

""

Remarks

The UTC time that the multipart upload was started. This is a string representation of ISO 8601 date format. For example: "2012-03-20T17:03:43.221Z".

The MultipartUploadIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MultipartUploadCount property.

This property is read-only and not available at design time.

Data Type

String

MultipartUploadPartSize Property (AmazonGlacier Component)

The part size in bytes.

Syntax

__property int MultipartUploadPartSize[int MultipartUploadIndex] = { read=FMultipartUploadPartSize };

Default Value

0

Remarks

The part size in bytes. This is specified by the PartSize setting and is used when StartMultipartUpload is called.

The MultipartUploadIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MultipartUploadCount property.

This property is read-only and not available at design time.

Data Type

Integer

MultipartUploadId Property (AmazonGlacier Component)

The Id of the multipart upload.

Syntax

__property String MultipartUploadId[int MultipartUploadIndex] = { read=FMultipartUploadId };

Default Value

""

Remarks

The Id of the multipart upload.

The MultipartUploadIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MultipartUploadCount property.

This property is read-only and not available at design time.

Data Type

String

MultipartUploadVaultArn Property (AmazonGlacier Component)

The Amazon Resource Name (ARN) of the Vault in which the archive is created.

Syntax

__property String MultipartUploadVaultArn[int MultipartUploadIndex] = { read=FMultipartUploadVaultArn };

Default Value

""

Remarks

The Amazon Resource Name (ARN) of the Vault in which the archive is created.

The MultipartUploadIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MultipartUploadCount property.

This property is read-only and not available at design time.

Data Type

String

NotifyEventType Property (AmazonGlacier Component)

This property specifies the type of enabled notifications for the vault.

Syntax

__property TcsAmazonGlacierNotifyEventTypes NotifyEventType = { read=FNotifyEventType, write=FSetNotifyEventType };

enum TcsAmazonGlacierNotifyEventTypes {
  etBoth=0,
  etArchiveRetrievalCompleted=1,
  etInventoryRetrievalCompleted=2
};

Default Value

etBoth

Remarks

This property specifies the type of enabled notifications for the vault. Possible values are:

This property is not available at design time.

Data Type

Integer

NotifySNSTopic Property (AmazonGlacier Component)

This property specifies the Amazon SNS Topic ARN that is used to deliver notifications.

Syntax

__property String NotifySNSTopic = { read=FNotifySNSTopic, write=FSetNotifySNSTopic };

Default Value

""

Remarks

This property specifies the Amazon SNS Topic ARN that is used to deliver notifications. The topic must already exist.

This property is not available at design time.

Data Type

String

OtherHeaders Property (AmazonGlacier Component)

This property includes other headers as determined by the user (optional).

Syntax

__property String OtherHeaders = { read=FOtherHeaders, write=FSetOtherHeaders };

Default Value

""

Remarks

This property can be set to a string of headers to be appended to the HTTP request headers created from other properties like ContentType and From.

The headers must follow the format Header: Value as described in the HTTP specifications. Header lines should be separated by CRLF ("\r\n") .

Use this property with caution. If this property contains invalid headers, HTTP requests may fail.

This property is useful for extending the functionality of the component beyond what is provided.

This property is not available at design time.

Data Type

String

Overwrite Property (AmazonGlacier Component)

Whether or not the component should overwrite files during transfer.

Syntax

__property bool Overwrite = { read=FOverwrite, write=FSetOverwrite };

Default Value

false

Remarks

This property is a indicates whether or not the component should overwrite downloaded data. If Overwrite is false, the component raises an exception whenever LocalFile exists and GetJobOutput is called.

Data Type

Boolean

ParsedHeaderCount Property (AmazonGlacier Component)

The number of records in the ParsedHeader arrays.

Syntax

__property int ParsedHeaderCount = { read=FParsedHeaderCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• ParsedHeaderField
• ParsedHeaderValue

The array indices start at 0 and end at ParsedHeaderCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

ParsedHeaderField Property (AmazonGlacier Component)

This property contains the name of the HTTP header (this is the same case as it is delivered).

Syntax

__property String ParsedHeaderField[int ParsedHeaderIndex] = { read=FParsedHeaderField };

Default Value

""

Remarks

This property contains the name of the HTTP Header (this is the same case as it is delivered).

The ParsedHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ParsedHeaderCount property.

This property is read-only and not available at design time.

Data Type

String

ParsedHeaderValue Property (AmazonGlacier Component)

This property contains the header contents.

Syntax

__property String ParsedHeaderValue[int ParsedHeaderIndex] = { read=FParsedHeaderValue };

Default Value

""

Remarks

This property contains the Header contents.

The ParsedHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ParsedHeaderCount property.

This property is read-only and not available at design time.

Data Type

String

PartMarker Property (AmazonGlacier Component)

A marker used to get the next page of results.

Syntax

__property String PartMarker = { read=FPartMarker, write=FSetPartMarker };

Default Value

""

Remarks

This property is populated after calling ListParts if the results are paged. This property holds the marker that will be sent in the next call to ListParts to get the next page of results.

This property is not available at design time.

Data Type

String

PartCount Property (AmazonGlacier Component)

The number of records in the Part arrays.

Syntax

__property int PartCount = { read=FPartCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• PartArchiveDescription
• PartCreationDate
• PartSHA256TreeHash
• PartSize
• PartStartPosition
• PartUploadId
• PartVaultArn

The array indices start at 0 and end at PartCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

PartArchiveDescription Property (AmazonGlacier Component)

The description of the archive (if any).

Syntax

__property String PartArchiveDescription[int PartIndex] = { read=FPartArchiveDescription };

Default Value

""

Remarks

The description of the archive (if any).

The PartIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PartCount property.

This property is read-only and not available at design time.

Data Type

String

PartCreationDate Property (AmazonGlacier Component)

The UTC time that the multipart upload was started.

Syntax

__property String PartCreationDate[int PartIndex] = { read=FPartCreationDate };

Default Value

""

Remarks

The UTC time that the multipart upload was started. This is a string representation of ISO 8601 date format. For example: "2012-03-20T17:03:43.221Z".

The PartIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PartCount property.

This property is read-only and not available at design time.

Data Type

String

PartSHA256TreeHash Property (AmazonGlacier Component)

The SHA256 tree hash value that Amazon calculated for the part.

Syntax

__property String PartSHA256TreeHash[int PartIndex] = { read=FPartSHA256TreeHash };

Default Value

""

Remarks

The SHA256 tree hash value that Amazon calculated for the part.

The PartIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PartCount property.

This property is read-only and not available at design time.

Data Type

String

PartSize Property (AmazonGlacier Component)

The part size in bytes.

Syntax

__property __int64 PartSize[int PartIndex] = { read=FPartSize };

Default Value

0

Remarks

The part size in bytes.

The PartIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PartCount property.

This property is read-only and not available at design time.

Data Type

Long64

PartStartPosition Property (AmazonGlacier Component)

The byte offset in the archive of the current part.

Syntax

__property __int64 PartStartPosition[int PartIndex] = { read=FPartStartPosition };

Default Value

0

Remarks

The byte offset in the archive of the current part.

The PartIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PartCount property.

This property is read-only and not available at design time.

Data Type

Long64

PartUploadId Property (AmazonGlacier Component)

The Id of the multipart upload associated with this part.

Syntax

__property String PartUploadId[int PartIndex] = { read=FPartUploadId };

Default Value

""

Remarks

The Id of the multipart upload associated with this part.

The PartIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PartCount property.

This property is read-only and not available at design time.

Data Type

String

PartVaultArn Property (AmazonGlacier Component)

The Amazon Resource Name (ARN) of the Vault in which the archive is created.

Syntax

__property String PartVaultArn[int PartIndex] = { read=FPartVaultArn };

Default Value

""

Remarks

The Amazon Resource Name (ARN) of the Vault in which the archive is created.

The PartIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PartCount property.

This property is read-only and not available at design time.

Data Type

String

ProxyAuthScheme Property (AmazonGlacier Component)

This property is used to tell the component which type of authorization to perform when connecting to the proxy.

Syntax

__property TcsAmazonGlacierProxyAuthSchemes ProxyAuthScheme = { read=FProxyAuthScheme, write=FSetProxyAuthScheme };

enum TcsAmazonGlacierProxyAuthSchemes {
  authBasic=0,
  authDigest=1,
  authProprietary=2,
  authNone=3,
  authNtlm=4,
  authNegotiate=5
};

Default Value

authBasic

Remarks

This property is used to tell the component which type of authorization to perform when connecting to the proxy. This is used only when the ProxyUser and ProxyPassword properties are set.

ProxyAuthScheme should be set to authNone (3) when no authentication is expected.

By default, ProxyAuthScheme is authBasic (0), and if the ProxyUser and ProxyPassword properties are set, the component will attempt basic authentication.

If ProxyAuthScheme is set to authDigest (1), digest authentication will be attempted instead.

If ProxyAuthScheme is set to authProprietary (2), then the authorization token will not be generated by the component. Look at the configuration file for the component being used to find more information about manually setting this token.

If ProxyAuthScheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of ProxyUser and ProxyPassword.

Data Type

Integer

ProxyAutoDetect Property (AmazonGlacier Component)

This property tells the component whether or not to automatically detect and use proxy system settings, if available.

Syntax

__property bool ProxyAutoDetect = { read=FProxyAutoDetect, write=FSetProxyAutoDetect };

Default Value

False

Remarks

This property tells the component whether or not to automatically detect and use proxy system settings, if available. The default value is false.

Data Type

Boolean

ProxyPassword Property (AmazonGlacier Component)

This property contains a password if authentication is to be used for the proxy.

Syntax

__property String ProxyPassword = { read=FProxyPassword, write=FSetProxyPassword };

Default Value

""

Remarks

This property contains a password if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

ProxyPort Property (AmazonGlacier Component)

This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Syntax

__property int ProxyPort = { read=FProxyPort, write=FSetProxyPort };

Default Value

80

Remarks

This property contains the Transmission Control Protocol (TCP) port for the proxy ProxyServer (default 80). See the description of the ProxyServer property for details.

Data Type

Integer

ProxyServer Property (AmazonGlacier Component)

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

Syntax

__property String ProxyServer = { read=FProxyServer, write=FSetProxyServer };

Default Value

""

Remarks

If a proxy ProxyServer is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the ProxyServer property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the ProxyServer property is set to the corresponding address. If the search is not successful, an error is returned.

Data Type

String

ProxySSL Property (AmazonGlacier Component)

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Syntax

__property TcsAmazonGlacierProxySSLs ProxySSL = { read=FProxySSL, write=FSetProxySSL };

enum TcsAmazonGlacierProxySSLs {
  psAutomatic=0,
  psAlways=1,
  psNever=2,
  psTunnel=3
};

Default Value

psAutomatic

Remarks

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:

Data Type

Integer

ProxyUser Property (AmazonGlacier Component)

This property contains a username if authentication is to be used for the proxy.

Syntax

__property String ProxyUser = { read=FProxyUser, write=FSetProxyUser };

Default Value

""

Remarks

This property contains a username if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

Region Property (AmazonGlacier Component)

The region the component will make requests against.

Syntax

__property String Region = { read=FRegion, write=FSetRegion };

Default Value

"us-east-1"

Remarks

This property controls which region the component will make requests against. By default the component uses us-east-1, the US East (N. Virginia) region. This property should be changed to create or access resources in other regions.

Regions:

The component will always convert this property's value to lowercase. If this property is cleared, the component will reset it to the default value.

Data Type

String

SecretKey Property (AmazonGlacier Component)

The secret key to use for authentication.

Syntax

__property String SecretKey = { read=FSecretKey, write=FSetSecretKey };

Default Value

""

Remarks

This property specifies the secret key that should be used for authentication. Both this property and AccessKey must be set before attempting any operations which connect to the server.

Data Type

String

SSLAcceptServerCertEncoded Property (AmazonGlacier Component)

This is the certificate (PEM/Base64 encoded).

Syntax

__property String SSLAcceptServerCertEncoded = { read=FSSLAcceptServerCertEncoded, write=FSetSSLAcceptServerCertEncoded };
__property DynamicArray<Byte> SSLAcceptServerCertEncodedB = { read=FSSLAcceptServerCertEncodedB, write=FSetSSLAcceptServerCertEncodedB };

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.

When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Byte Array

SSLCertEncoded Property (AmazonGlacier Component)

This is the certificate (PEM/Base64 encoded).

Syntax

__property String SSLCertEncoded = { read=FSSLCertEncoded, write=FSetSSLCertEncoded };
__property DynamicArray<Byte> SSLCertEncodedB = { read=FSSLCertEncodedB, write=FSetSSLCertEncodedB };

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Byte Array

SSLCertStore Property (AmazonGlacier Component)

This is the name of the certificate store for the client certificate.

Syntax

__property String SSLCertStore = { read=FSSLCertStore, write=FSetSSLCertStore };
__property DynamicArray<Byte> SSLCertStoreB = { read=FSSLCertStoreB, write=FSetSSLCertStoreB };

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Byte Array

SSLCertStorePassword Property (AmazonGlacier Component)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

__property String SSLCertStorePassword = { read=FSSLCertStorePassword, write=FSetSSLCertStorePassword };

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLCertStoreType Property (AmazonGlacier Component)

This is the type of certificate store for this certificate.

Syntax

__property TcsAmazonGlacierSSLCertStoreTypes SSLCertStoreType = { read=FSSLCertStoreType, write=FSetSSLCertStoreType };

enum TcsAmazonGlacierSSLCertStoreTypes {
  cstUser=0,
  cstMachine=1,
  cstPFXFile=2,
  cstPFXBlob=3,
  cstJKSFile=4,
  cstJKSBlob=5,
  cstPEMKeyFile=6,
  cstPEMKeyBlob=7,
  cstPublicKeyFile=8,
  cstPublicKeyBlob=9,
  cstSSHPublicKeyBlob=10,
  cstP7BFile=11,
  cstP7BBlob=12,
  cstSSHPublicKeyFile=13,
  cstPPKFile=14,
  cstPPKBlob=15,
  cstXMLFile=16,
  cstXMLBlob=17,
  cstJWKFile=18,
  cstJWKBlob=19,
  cstSecurityKey=20,
  cstBCFKSFile=21,
  cstBCFKSBlob=22,
  cstPKCS11=23,
  cstAuto=99
};

Default Value

cstUser

Remarks

This is the type of certificate store for this certificate.

The component supports both public and private keys in a variety of formats. When the cstAuto value is used, the component will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SSLCertSubject Property (AmazonGlacier Component)

This is the subject of the certificate used for client authentication.

Syntax

__property String SSLCertSubject = { read=FSSLCertSubject, write=FSetSSLCertSubject };

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

SSLProvider Property (AmazonGlacier Component)

This specifies the SSL/TLS implementation to use.

Syntax

__property TcsAmazonGlacierSSLProviders SSLProvider = { read=FSSLProvider, write=FSetSSLProvider };

enum TcsAmazonGlacierSSLProviders {
  sslpAutomatic=0,
  sslpPlatform=1,
  sslpInternal=2
};

Default Value

sslpAutomatic

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic) the component will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are:

In most cases using the default value (Automatic) is recommended. The component will select a provider depending on the current platform.

When Automatic is selected the platform implementation is used by default. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used.

Data Type

Integer

SSLServerCertEncoded Property (AmazonGlacier Component)

This is the certificate (PEM/Base64 encoded).

Syntax

__property String SSLServerCertEncoded = { read=FSSLServerCertEncoded };
__property DynamicArray<Byte> SSLServerCertEncodedB = { read=FSSLServerCertEncodedB };

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.

When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.

This property is read-only and not available at design time.

Data Type

Byte Array

Timeout Property (AmazonGlacier Component)

A timeout for the component.

Syntax

__property int Timeout = { read=FTimeout, write=FSetTimeout };

Default Value

60

Remarks

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If Timeout is set to a positive value, the component will wait for the operation to complete before returning control.

The component will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.

If Timeout expires, and the operation is not yet complete, the component raises an exception.

Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

Data Type

Integer

UseSSL Property (AmazonGlacier Component)

Whether to use SSL/TLS when connecting.

Syntax

__property bool UseSSL = { read=FUseSSL, write=FSetUseSSL };

Default Value

true

Remarks

This property specifies whether the component should use SSL/TLS when connecting.

This property is not available at design time.

Data Type

Boolean

VaultMarker Property (AmazonGlacier Component)

A marker used to get the next page of results.

Syntax

__property String VaultMarker = { read=FVaultMarker, write=FSetVaultMarker };

Default Value

""

Remarks

This property is populated after calling ListVaults if the results are paged. This property holds the marker that will be sent in the next call to ListVaults to get the next page of results.

This property is not available at design time.

Data Type

String

VaultCount Property (AmazonGlacier Component)

The number of records in the Vault arrays.

Syntax

__property int VaultCount = { read=FVaultCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• VaultArchiveCount
• VaultArn
• VaultCreationDate
• VaultLastInventoryDate
• VaultName
• VaultSize

The array indices start at 0 and end at VaultCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

VaultArchiveCount Property (AmazonGlacier Component)

The number of archives in the vault as of LastInventoryDate .

Syntax

__property int VaultArchiveCount[int VaultIndex] = { read=FVaultArchiveCount };

Default Value

0

Remarks

The number of archives in the vault as of VaultLastInventoryDate.

The VaultIndex parameter specifies the index of the item in the array. The size of the array is controlled by the VaultCount property.

This property is read-only and not available at design time.

Data Type

Integer

VaultArn Property (AmazonGlacier Component)

The Amazon Resource Name (ARN) of the vault.

Syntax

__property String VaultArn[int VaultIndex] = { read=FVaultArn };

Default Value

""

Remarks

The Amazon Resource Name (ARN) of the vault.

The VaultIndex parameter specifies the index of the item in the array. The size of the array is controlled by the VaultCount property.

This property is read-only and not available at design time.

Data Type

String

VaultCreationDate Property (AmazonGlacier Component)

The date the vault was created, in Coordinated Universal Time (UTC).

Syntax

__property String VaultCreationDate[int VaultIndex] = { read=FVaultCreationDate };

Default Value

""

Remarks

The date the vault was created, in Coordinated Universal Time (UTC). This is a string representation of ISO 8601 date format, for example: 2012-03-20T17:03:43.221Z.

The VaultIndex parameter specifies the index of the item in the array. The size of the array is controlled by the VaultCount property.

This property is read-only and not available at design time.

Data Type

String

VaultLastInventoryDate Property (AmazonGlacier Component)

The date of the last vault inventory, in Coordinated Universal Time (UTC).

Syntax

__property String VaultLastInventoryDate[int VaultIndex] = { read=FVaultLastInventoryDate };

Default Value

""

Remarks

The date of the last vault inventory, in Coordinated Universal Time (UTC). This is a string representation of ISO 8601 date format, for example: 2012-03-20T17:03:43.221Z.

The VaultIndex parameter specifies the index of the item in the array. The size of the array is controlled by the VaultCount property.

This property is read-only and not available at design time.

Data Type

String

VaultName Property (AmazonGlacier Component)

The name of the vault.

Syntax

__property String VaultName[int VaultIndex] = { read=FVaultName };

Default Value

""

Remarks

The name of the vault.

The VaultIndex parameter specifies the index of the item in the array. The size of the array is controlled by the VaultCount property.

This property is read-only and not available at design time.

Data Type

String

VaultSize Property (AmazonGlacier Component)

The size of all the archives (including any per-archive overhead) in the vault, as of the last inventory date.

Syntax

__property __int64 VaultSize[int VaultIndex] = { read=FVaultSize };

Default Value

0

Remarks

The size of all the archives (including any per-archive overhead) in the vault, as of the last inventory date.

The VaultIndex parameter specifies the index of the item in the array. The size of the array is controlled by the VaultCount property.

This property is read-only and not available at design time.

Data Type

Long64

AbortMultipartUpload Method (AmazonGlacier Component)

Aborts a multipart upload.

Syntax

void __fastcall AbortMultipartUpload(String VaultName, String UploadId);

Remarks

This method aborts a multipart upload specified by UploadId. UploadId is returned from the StartMultipartUpload method.

VaultName specifies the vault in which the archive is created.

Only multipart uploads that are not yet completed can be aborted.

CompleteMultipartUpload Method (AmazonGlacier Component)

Completes a multipart upload.

Syntax

String __fastcall CompleteMultipartUpload(String VaultName, String UploadId);

Remarks

This method completes the current multipart upload specified by UploadId.

VaultName specifies the vault in which the archive was created.

This method returns the ArchiveId which identifies the newly created archive. If you call this method twice for the same multipart upload within a short period of time, the same ArchiveId will be returned.

If parts of the archive were uploaded using separate instances of the component you must first list all parts of the archive by calling ListParts until PartMarker is empty (all parts are returned). Information about the parts is required when completing the multipart upload.

Config Method (AmazonGlacier Component)

Sets or retrieves a configuration setting.

Syntax

String __fastcall Config(String ConfigurationString);

Remarks

Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

CreateJob Method (AmazonGlacier Component)

Creates a new job.

Syntax

String __fastcall CreateJob(String VaultName, int JobType, String ArchiveId, String SNSTopic);

Remarks

This method creates a new job. There are two types of jobs, archive retrieval and inventory retrieval. After the job is created this method will return the JobId. Amazon will then execute the job (which may take hours) and then notify you when it is complete.

VaultName specifies the name of the vault.

JobType specifies the operation. Possible values are:

ArchiveId specifies the archive to retrieve when JobType is set to 0 (archive retrieval).

SNSTopic specifies the SNS topic to which the notification will be posted when the operation is complete.

The GetJobInfo method may be called with the returned JobId to check the status of the job. Once the job is completed use the GetJobOutput method to retrieve the data.

Note: JobDescription may optionally be set. JobRetrievalByteRange may be set when JobType is 0 (archive retrieval). JobInventoryFormat may be set when JobType is set to 1 (inventory retrieval).

CreateVault Method (AmazonGlacier Component)

Creates a new vault.

Syntax

void __fastcall CreateVault(String VaultName);

Remarks

This method creates a new vault with the name specified by the VaultName parameter.

Names can be between 1 and 255 characters long. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), and '.' (period).

The region in which the vault is created is controlled by the Region property.

DeleteArchive Method (AmazonGlacier Component)

Deletes an archive.

Syntax

void __fastcall DeleteArchive(String VaultName, String ArchiveId);

Remarks

This method deletes the archive specified by the ArchiveId parameter.

DeleteNotificationInfo Method (AmazonGlacier Component)

Deletes the notification information for the vault.

Syntax

void __fastcall DeleteNotificationInfo(String VaultName);

Remarks

This method deletes the notification information associated with the vault specified by VaultName.

DeleteVault Method (AmazonGlacier Component)

Deletes the specified vault.

Syntax

void __fastcall DeleteVault(String VaultName);

Remarks

This method deletes the vault specified by VaultName. If the vault is not empty Amazon will return an error.

Call GetVaultInfo to get information about the archive including the number of archives it contains.

DoEvents Method (AmazonGlacier Component)

Processes events from the internal message queue.

Syntax

void __fastcall DoEvents();

Remarks

When DoEvents is called, the component processes any available events. If no events are available, it waits for a preset period of time, and then returns.

GetJobInfo Method (AmazonGlacier Component)

Retrieves information about the specified job.

Syntax

void __fastcall GetJobInfo(String VaultName, String JobId);

Remarks

This method retrieves information about the job specified by JobId. The Job* properties will be populated with information about the job.

GetJobOutput Method (AmazonGlacier Component)

Retrieves the output from the job.

Syntax

void __fastcall GetJobOutput(String VaultName, String JobId);

Remarks

This method retrieves the output from a completed job. If LocalFile is set, the data will be written to the specified file. If LocalFile is not set the data will be written to either InventoryData or ArchiveData depending on the type of job.

GetNotificationInfo Method (AmazonGlacier Component)

Retrieves the notification information for the vault.

Syntax

void __fastcall GetNotificationInfo(String VaultName);

Remarks

This method retrieves the notification information for the vault specified by VaultName. After this method returns, the results will be available in the NotificationInfo* properties.

If no notification settings exist for the vault the component raises an exception.

GetVaultInfo Method (AmazonGlacier Component)

Retrieves vault details.

Syntax

void __fastcall GetVaultInfo(String VaultName);

Remarks

This method gets information about the vault specified by VaultName. The Vault* properties will be populated with the results. The following properties are populated:

• VaultArchiveCount
• VaultArn
• VaultCreationDate
• VaultLastInventoryDate
• VaultName
• VaultSize

Interrupt Method (AmazonGlacier Component)

Interrupt the current method.

Syntax

void __fastcall Interrupt();

Remarks

If there is no method in progress, Interrupt simply returns, doing nothing.

ListJobs Method (AmazonGlacier Component)

Lists the jobs in a vault.

Syntax

void __fastcall ListJobs(String VaultName);

Remarks

This method lists the jobs in the vault specified by VaultName.

The JobList event will fire once for each Job returned. In addition, the Job* properties will be populated.

By default up to 1000 jobs will be returned in a single set of results. The maximum number of results can be specified by setting MaxListJobResults. If the number of results exceeds the maximum the results are paged. The IsJobPaged setting will be set to true and JobMarker will be populated.

To get all results simply call ListJobs again until IsJobPaged returns False and JobMarker is empty string.

Note: The settings JobCompletionFilter and JobStatusFilter may be set to control what type of jobs are returned.

ListMultipartUploads Method (AmazonGlacier Component)

Lists multipart uploads.

Syntax

void __fastcall ListMultipartUploads(String VaultName);

Remarks

This method lists the current multipart uploads for the vault specified by VaultName. The MultipartUploadList event will fire once for each multipart upload returned. In addition, the MultipartUpload* properties will be populated.

By default up to 1000 multipart uploads will be returned in a single set of results. The maximum number of results can be specified by setting MaxListMultipartUploadResults. If the number of results exceeds the maximum the results are paged. The IsMultipartUploadPaged setting will be set to true and MultipartUploadMarker will be populated.

To get all results simply call ListMultipartUploads again until IsMultipartUploadPaged returns False and MultipartUploadMarker is empty string.

ListParts Method (AmazonGlacier Component)

Lists the parts of a multipart upload.

Syntax

void __fastcall ListParts(String VaultName, String UploadId);

Remarks

This method lists the parts of a multipart upload specified by UploadId.

VaultName identifies the vault in which the archive is created.

The PartList event will fire once for each Part returned. In addition, the Parts* properties will be populated.

By default up to 1000 parts will be returned in a single set of results. The maximum number of results can be specified by setting MaxListPartResults. If the number of results exceeds the maximum the results are paged. The IsPartPaged setting will be set to true and PartMarker will be populated.

To get all results simply call ListParts again until IsPartPaged returns False and PartMarker is empty string.

ListVaults Method (AmazonGlacier Component)

Lists the vaults.

Syntax

void __fastcall ListVaults();

Remarks

This method lists the vaults for an account.

By default up to 1000 vaults will be returned in a single set of results. This maximum number of results can be specified by setting MaxListVaultResults. If the number of results exceeds the maximum the results are paged. The IsVaultPaged setting will be set to true and VaultMarker will be populated.

To get all results simply call ListVaults again until IsVaultPaged returns False and VaultMarker is empty string.

Reset Method (AmazonGlacier Component)

Resets the component to its initial state.

Syntax

void __fastcall Reset();

Remarks

This method resets the component to its initial state.

SetNotificationInfo Method (AmazonGlacier Component)

Sets notification information for a vault.

Syntax

void __fastcall SetNotificationInfo(String VaultName);

Remarks

This method sets the notification settings for the vault specified by VaultName. The NotifySNSTopic property must be set before calling this method. Optionally, the NotifyEventType may also be set.

StartMultipartUpload Method (AmazonGlacier Component)

Starts a multipart upload.

Syntax

String __fastcall StartMultipartUpload(String VaultName, String ArchiveDesc);

Remarks

This method initiates a multipart upload operation. Multipart uploads are beneficial in situations where you wish to upload a large amount of data, or do not know how large the data will be when you begin uploading.

This method returns an UploadId that must be saved. This will be used to perform other operations with this upload.

ArchiveDesc may be set to a user friendly description of the archive, or empty string.

VaultName is the vault in which the archive will be created.

The data must be split into parts with a size (in megabytes) specified by PartSize. The part size must be a megabyte multiplied by a power of 2. For instance 1, 2, 4, and 8 are valid sizes. The minimum part size is 1, the maximum is 4096 (4GB). The default value of PartSize is 1.

Each part must be exactly PartSize megabytes in size except the last part. The last part will be smaller. For instance with a part size of 1, uploading a 10.2 megabyte file will have 11 parts. There will be 10 parts of size 1 MB, and 1 part of size .2 MB.

Parts may be uploaded in parallel by using separate component instances. When uploading a part with UploadPart a part number is specified so the data can be properly re-assembled in order when it reaches the server.

After all parts are uploaded call CompleteMultipartUpload to complete the operation. If parts of the archive were uploaded using separate instances of the component you must first list all parts of the archive by calling ListParts until PartMarker is empty (all parts are returned). Information about the parts is required when completing the multipart upload.

To cancel the operation, call AbortMultipartUpload.

UploadArchive Method (AmazonGlacier Component)

Uploads an archive to a vault.

Syntax

String __fastcall UploadArchive(String VaultName, String ArchiveDesc);

Remarks

This method uploads an archive to the vault specified by VaultName. If LocalFile is set, the archive data will be read from the specified file. If LocalFile is not set, the data set in ArchiveData will be used.

The ArchiveDesc parameter may be set to a user friendly description of the archive. The description must be less than or equal to 1,024 characters. The allowable characters are 7-bit ASCII without control codes, specifically ASCII values 32-126 decimal or 0x20-0x7E hexadecimal.

This method returns the ArchiveId if the data was successfully uploaded.

UploadPart Method (AmazonGlacier Component)

Uploads a single part in a multipart upload.

Syntax

void __fastcall UploadPart(String VaultName, String UploadId, int PartNumber);

Remarks

This method uploads a single part of the multipart upload specified by UploadId.

VaultName is the vault in which the archive is created.

PartNumber identifies this specific part. The first part number is 0. Amazon will re-assemble the archive in the order specified by part numbers.

If LocalFile is set, the part data will be read from the specified file. If LocalFile is not set, the data set in ArchiveData will be used.

EndTransfer Event (AmazonGlacier Component)

This event fires when a document finishes transferring.

Syntax

typedef struct {
  int Direction;
} TcsAmazonGlacierEndTransferEventParams;
typedef void __fastcall (__closure *TcsAmazonGlacierEndTransferEvent)(System::TObject* Sender, TcsAmazonGlacierEndTransferEventParams *e);
__property TcsAmazonGlacierEndTransferEvent OnEndTransfer = { read=FOnEndTransfer, write=FOnEndTransfer };

Remarks

The EndTransfer event is fired when the document text finishes transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

Error Event (AmazonGlacier Component)

Fired when information is available about errors during data delivery.

Syntax

typedef struct {
  int ErrorCode;
  String Description;
} TcsAmazonGlacierErrorEventParams;
typedef void __fastcall (__closure *TcsAmazonGlacierErrorEvent)(System::TObject* Sender, TcsAmazonGlacierErrorEventParams *e);
__property TcsAmazonGlacierErrorEvent OnError = { read=FOnError, write=FOnError };

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the component raises an exception.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

Header Event (AmazonGlacier Component)

This event is fired every time a header line comes in.

Syntax

typedef struct {
  String Field;
  String Value;
} TcsAmazonGlacierHeaderEventParams;
typedef void __fastcall (__closure *TcsAmazonGlacierHeaderEvent)(System::TObject* Sender, TcsAmazonGlacierHeaderEventParams *e);
__property TcsAmazonGlacierHeaderEvent OnHeader = { read=FOnHeader, write=FOnHeader };

Remarks

The Field parameter contains the name of the HTTP header (which is the same as it is delivered). The Value parameter contains the header contents.

If the header line being retrieved is a continuation header line, then the Field parameter contains "" (empty string).

JobList Event (AmazonGlacier Component)

Fires once for each job returned when calling ListJobs or GetJobInfo.

Syntax

typedef struct {
  int JobType;
  String ArchiveId;
  __int64 ArchiveSize;
  String ArchiveSHA256TreeHash;
  bool Completed;
  String CompletionDate;
  String CreationDate;
  String Description;
  String JobId;
  String SNSTopic;
  String SHA256TreeHash;
  int StatusCode;
  String StatusMessage;
  String VaultArn;
  __int64 InventorySize;
} TcsAmazonGlacierJobListEventParams;
typedef void __fastcall (__closure *TcsAmazonGlacierJobListEvent)(System::TObject* Sender, TcsAmazonGlacierJobListEventParams *e);
__property TcsAmazonGlacierJobListEvent OnJobList = { read=FOnJobList, write=FOnJobList };

Remarks

This event fires once for each job returned when calling ListJobs. When calling GetJobInfo this event will fire once since only one job is returned.

JobType indicates the type of job. Possible values are:

ArchiveId is the Id of the archive associated with the job.

ArchiveSize is the size in bytes of the archive.

ArchiveSHA256TreeHash is the SHA256 tree hash of the entire archive for an archive retrieval job.

Completed indicates the status of the job.

CompletionDate is the UTC time that the job completed.

CreationDate is the UTC time that the job was created. This is a string representation of ISO 8601 date format, for example: "2012-03-20T17:03:43.221Z".

Description is the user supplied description. This is specified by the JobDescription setting before calling CreateJob.

JobId is the Amazon assigned Id for the job.

SNSTopic is the Amazon SNS topic that will receive notification about the job status.

SHA256TreeHash is the SHA256 tree hash value for the requested range of an archive. This is only applicable when JobType is 0 (archive retrieval) and a JobRetrievalByteRange is set to a tree-hash aligned range.

StatusCode is the current status of the job. Possible values are:

StatusMessage is a user friendly description of the status.

VaultArn is the Amazon Resource Name (ARN) of the vault from which the archive retrieval or inventory retrieval was requested.

InventorySize is the size in bytes of the inventory data.

Log Event (AmazonGlacier Component)

This event fires once for each log message.

Syntax

typedef struct {
  int LogLevel;
  String Message;
  String LogType;
} TcsAmazonGlacierLogEventParams;
typedef void __fastcall (__closure *TcsAmazonGlacierLogEvent)(System::TObject* Sender, TcsAmazonGlacierLogEventParams *e);
__property TcsAmazonGlacierLogEvent OnLog = { read=FOnLog, write=FOnLog };

Remarks

This event fires once for each log message generated by the component. The verbosity is controlled by the LogLevel setting.

LogLevel indicates the level of message. Possible values are as follows:

The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.

The value 2 (Verbose) logs additional information about the request and response.

The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).

Message is the log entry.

LogType identifies the type of log entry. Possible values are as follows:

• "Info"
• "RequestHeaders"
• "ResponseHeaders"
• "RequestBody"
• "ResponseBody"
• "ProxyRequest"
• "ProxyResponse"
• "FirewallRequest"
• "FirewallResponse"

MultipartUploadList Event (AmazonGlacier Component)

Fires once for each multipart upload when ListMultipartUploads is called.

Syntax

typedef struct {
  String ArchiveDescription;
  String CreationDate;
  String UploadId;
  String VaultArn;
  int PartSize;
} TcsAmazonGlacierMultipartUploadListEventParams;
typedef void __fastcall (__closure *TcsAmazonGlacierMultipartUploadListEvent)(System::TObject* Sender, TcsAmazonGlacierMultipartUploadListEventParams *e);
__property TcsAmazonGlacierMultipartUploadListEvent OnMultipartUploadList = { read=FOnMultipartUploadList, write=FOnMultipartUploadList };

Remarks

This event fires for each multipart upload returned when calling ListMultipartUploads.

ArchiveDescription is the archive description (if any).

CreationDate is the UTC time that the multipart upload was started. This is a string representation of ISO 8601 date format. For example: "2012-03-20T17:03:43.221Z".

UploadId is the Id of the multipart upload.

VaultArn is the Amazon Resource Name (ARN) of the Vault in which the archive is created.

PartSize is the part size in bytes. This is specified by the PartSize setting and is used when StartMultipartUpload is called.

PartList Event (AmazonGlacier Component)

Fires once for each part when calling ListParts.

Syntax

typedef struct {
  String ArchiveDescription;
  String CreationDate;
  String UploadId;
  __int64 StartPosition;
  __int64 Size;
  String SHA256TreeHash;
  String VaultArn;
} TcsAmazonGlacierPartListEventParams;
typedef void __fastcall (__closure *TcsAmazonGlacierPartListEvent)(System::TObject* Sender, TcsAmazonGlacierPartListEventParams *e);
__property TcsAmazonGlacierPartListEvent OnPartList = { read=FOnPartList, write=FOnPartList };

Remarks

This event fires once for each part when calling ListParts.

ArchiveDescription is the description of the archive (if any).

CreationDate is the UTC time that the multipart upload was started. This is a string representation of ISO 8601 date format. For example: "2012-03-20T17:03:43.221Z".

UploadId is the Id of the multipart upload associated with this part.

StartPosition is the byte offset in the archive of the current part.

Size is the part size in bytes.

SHA256TreeHash is the SHA256 tree hash value that Amazon calculated for the part.

VaultArn is the Amazon Resource Name (ARN) of the Vault in which the archive is created.

Progress Event (AmazonGlacier Component)

Fires during an upload or download to indicate transfer progress.

Syntax

typedef struct {
  int Direction;
  __int64 BytesTransferred;
  __int64 TotalBytes;
  int PercentDone;
} TcsAmazonGlacierProgressEventParams;
typedef void __fastcall (__closure *TcsAmazonGlacierProgressEvent)(System::TObject* Sender, TcsAmazonGlacierProgressEventParams *e);
__property TcsAmazonGlacierProgressEvent OnProgress = { read=FOnProgress, write=FOnProgress };

Remarks

This event fires during an upload or download to indicate the progress of the transfer of the entire request. By default, this event will fire each time PercentDone increases by one percent; the ProgressStep configuration setting can be used to alter this behavior.

Direction indicates whether the transfer is an upload (0) or a download (1).

BytesTransferred reflects the number of bytes that have been transferred so far, or 0 if the transfer is starting (however, see note below).

TotalBytes reflects the total number of bytes that are to be transferred, or -1 if the total is unknown. This amount includes the size of everything in the request like HTTP headers.

PercentDone reflects the overall progress of the transfer, or -1 if the progress cannot be calculated.

Note: By default, the component tracks transfer progress absolutely. If a transfer is interrupted and later resumed, the values reported by this event upon and after resumption will account for the data that was transferred before the interruption.

For example, if 10MB of data was successfully transferred before the interruption, then this event will fire with a BytesTransferred value of 10485760 (10MB) when the transfer is first resumed, and then continue to fire with successively greater values as usual.

This behavior can be changed by disabling the ProgressAbsolute configuration setting, in which case the component will treat resumed transfers as "new" transfers. In this case, the BytesTransferred parameter will always be 0 the first time this event fires, regardless of whether the transfer is new or being resumed.

SSLServerAuthentication Event (AmazonGlacier Component)

Fired after the server presents its certificate to the client.

Syntax

typedef struct {
  String CertEncoded;
  DynamicArray<Byte> CertEncodedB;
  String CertSubject;
  String CertIssuer;
  String Status;
  bool Accept;
} TcsAmazonGlacierSSLServerAuthenticationEventParams;
typedef void __fastcall (__closure *TcsAmazonGlacierSSLServerAuthenticationEvent)(System::TObject* Sender, TcsAmazonGlacierSSLServerAuthenticationEventParams *e);
__property TcsAmazonGlacierSSLServerAuthenticationEvent OnSSLServerAuthentication = { read=FOnSSLServerAuthentication, write=FOnSSLServerAuthentication };

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (AmazonGlacier Component)

Fired when secure connection progress messages are available.

Syntax

typedef struct {
  String Message;
} TcsAmazonGlacierSSLStatusEventParams;
typedef void __fastcall (__closure *TcsAmazonGlacierSSLStatusEvent)(System::TObject* Sender, TcsAmazonGlacierSSLStatusEventParams *e);
__property TcsAmazonGlacierSSLStatusEvent OnSSLStatus = { read=FOnSSLStatus, write=FOnSSLStatus };

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

StartTransfer Event (AmazonGlacier Component)

This event fires when a document starts transferring (after the headers).

Syntax

typedef struct {
  int Direction;
} TcsAmazonGlacierStartTransferEventParams;
typedef void __fastcall (__closure *TcsAmazonGlacierStartTransferEvent)(System::TObject* Sender, TcsAmazonGlacierStartTransferEventParams *e);
__property TcsAmazonGlacierStartTransferEvent OnStartTransfer = { read=FOnStartTransfer, write=FOnStartTransfer };

Remarks

The StartTransfer event is fired when the document text starts transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

Transfer Event (AmazonGlacier Component)

This event is fired while a document transfers (delivers document).

Syntax

typedef struct {
  int Direction;
  __int64 BytesTransferred;
  int PercentDone;
  String Text;
  DynamicArray<Byte> TextB;
} TcsAmazonGlacierTransferEventParams;
typedef void __fastcall (__closure *TcsAmazonGlacierTransferEvent)(System::TObject* Sender, TcsAmazonGlacierTransferEventParams *e);
__property TcsAmazonGlacierTransferEvent OnTransfer = { read=FOnTransfer, write=FOnTransfer };

Remarks

The Text parameter contains the portion of the document text being received. It is empty if data are being posted to the server.

The BytesTransferred parameter contains the number of bytes transferred in this Direction since the beginning of the document text (excluding HTTP response headers).

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.

Note: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.

VaultList Event (AmazonGlacier Component)

Fires once for each vault returned when calling ListVaults.

Syntax

typedef struct {
  String CreationDate;
  String LastInventoryDate;
  String VaultArn;
  String VaultName;
  int ArchiveCount;
  __int64 Size;
} TcsAmazonGlacierVaultListEventParams;
typedef void __fastcall (__closure *TcsAmazonGlacierVaultListEvent)(System::TObject* Sender, TcsAmazonGlacierVaultListEventParams *e);
__property TcsAmazonGlacierVaultListEvent OnVaultList = { read=FOnVaultList, write=FOnVaultList };

Remarks

This event fires once for each vault returned when calling ListVaults.

CreationDate is the date the vault was created, in Coordinated Universal Time (UTC). This is a string representation of ISO 8601 date format, for example: 2012-03-20T17:03:43.221Z.

LastInventoryDate is the date of the last vault inventory, in Coordinated Universal Time (UTC). This is a string representation of ISO 8601 date format, for example: 2012-03-20T17:03:43.221Z.

VaultArn is the Amazon Resource Name (ARN) of the vault.

VaultName is the name of the vault.

ArchiveCount is the number of archives in the vault as of LastInventoryDate.

Size is the size of all the archives (including any per-archive overhead) in the vault, as of the last inventory date.

Config Settings (AmazonGlacier Component)

AmazonGlacier Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

Socket Config Settings

Base Config Settings

Trappable Errors (AmazonGlacier Component)

Common Errors

The component may also return one of the following error codes, which are inherited from other components.

HTTP Errors

The component may also return one of the following error codes, which are inherited from other components.

TCPClient Errors

SSL Errors

TCP/IP Errors