AmazonGlacier Component

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

nsoftware.CloudStorage.Amazonglacier

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

• C#
• VB.NET

public string AccessKey { get; set; }

Public Property AccessKey As String

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.

ArchiveData Property (AmazonGlacier Component)

Holds the archive data.

Syntax

• C#
• VB.NET

public string ArchiveData { get; set; }
public byte[] ArchiveDataB { get; set; }

Public Property ArchiveData As String
Public Property ArchiveDataB As Byte()

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.

EncryptionAlgorithm Property (AmazonGlacier Component)

The encryption algorithm.

Syntax

• C#
• VB.NET

public AmazonglacierEncryptionAlgorithms EncryptionAlgorithm { get; set; }

enum AmazonglacierEncryptionAlgorithms {
  eaAES,
  eaBlowfish,
  eaCAST,
  eaDES,
  eaIDEA,
  eaRC2,
  eaRC4,
  eaTEA,
  eaTripleDES,
  eaTwofish,
  eaRijndael,
  eaChaCha,
  eaXSalsa20
}

Public Property EncryptionAlgorithm As AmazonglacierEncryptionAlgorithms

Enum AmazonglacierEncryptionAlgorithms
  eaAES
  eaBlowfish
  eaCAST
  eaDES
  eaIDEA
  eaRC2
  eaRC4
  eaTEA
  eaTripleDES
  eaTwofish
  eaRijndael
  eaChaCha
  eaXSalsa20
End Enum

Default Value

0

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:

EncryptionPassword Property (AmazonGlacier Component)

The encryption password.

Syntax

• C#
• VB.NET

public string EncryptionPassword { get; set; }

Public Property EncryptionPassword As String

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.

Firewall Property (AmazonGlacier Component)

A set of properties related to firewall access.

Syntax

• C#
• VB.NET

public Firewall Firewall { get; set; }

Public Property Firewall As Firewall

Remarks

This is a Firewall-type property, which contains fields describing the firewall through which the component will attempt to connect.

Idle Property (AmazonGlacier Component)

The current status of the component.

Syntax

• C#
• VB.NET

public bool Idle { get; }

Public ReadOnly Property Idle As Boolean

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.

InventoryData Property (AmazonGlacier Component)

Holds the inventory data.

Syntax

• C#
• VB.NET

public string InventoryData { get; }
public byte[] InventoryDataB { get; }

Public ReadOnly Property InventoryData As String
Public ReadOnly Property InventoryDataB As Byte()

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.

JobMarker Property (AmazonGlacier Component)

A marker used to get the next page of results.

Syntax

• C#
• VB.NET

public string JobMarker { get; set; }

Public Property JobMarker As String

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.

Jobs Property (AmazonGlacier Component)

A collection providing details about the jobs.

Syntax

• C#
• VB.NET

public GlacierJobList Jobs { get; }

Public ReadOnly Property Jobs As GlacierJobList

Remarks

This collection is populated after calling GetJobInfo or ListJobs. It holds details about the jobs.

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

LocalFile Property (AmazonGlacier Component)

The path to a local file for uploading or downloading.

Syntax

• C#
• VB.NET

public string LocalFile { get; set; }

Public Property LocalFile As String

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.

LocalHost Property (AmazonGlacier Component)

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

Syntax

• C#
• VB.NET

public string LocalHost { get; set; }

Public Property LocalHost As String

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.

MultipartUploadMarker Property (AmazonGlacier Component)

A marker used to get the next page of results.

Syntax

• C#
• VB.NET

public string MultipartUploadMarker { get; set; }

Public Property MultipartUploadMarker As String

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.

MultipartUploads Property (AmazonGlacier Component)

A collection of multipart upload details.

Syntax

• C#
• VB.NET

public GlacierMultipartUploadList MultipartUploads { get; }

Public ReadOnly Property MultipartUploads As GlacierMultipartUploadList

Remarks

This collection is populated after calling ListMultipartUploads. It holds information about the current multipart uploads.

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

NotificationInfo Property (AmazonGlacier Component)

Holds information about the notification settings for a vault.

Syntax

• C#
• VB.NET

public GlacierNotification NotificationInfo { get; set; }

Public Property NotificationInfo As GlacierNotification

Remarks

This property holds notification settings for a vault. It is populated automatically after calling GetNotificationInfo. When calling SetNotificationInfo this specifies the values that will be set.

This property is not available at design time.

OtherHeaders Property (AmazonGlacier Component)

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

Syntax

• C#
• VB.NET

public string OtherHeaders { get; set; }

Public Property OtherHeaders As String

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.

Overwrite Property (AmazonGlacier Component)

Whether or not the component should overwrite files during transfer.

Syntax

• C#
• VB.NET

public bool Overwrite { get; set; }

Public Property Overwrite As Boolean

Default Value

False

Remarks

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

ParsedHeaders Property (AmazonGlacier Component)

This property includes a collection of headers returned from the last request.

Syntax

• C#
• VB.NET

public HeaderList ParsedHeaders { get; }

Public ReadOnly Property ParsedHeaders As HeaderList

Remarks

This property contains a collection of headers returned from the last request. Whenever headers are returned from the server, the headers are parsed into a collection of headers. Each Header in this collection contains information describing that header.

MaxHeaders can be used to control the maximum number of headers saved.

This collection is indexed from 0 to count -1.

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

PartMarker Property (AmazonGlacier Component)

A marker used to get the next page of results.

Syntax

• C#
• VB.NET

public string PartMarker { get; set; }

Public Property PartMarker As String

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.

Parts Property (AmazonGlacier Component)

A collection of multipart upload parts.

Syntax

• C#
• VB.NET

public GlacierPartList Parts { get; }

Public ReadOnly Property Parts As GlacierPartList

Remarks

This collection holds details about each of the parts in a multipart upload. It is populated after a call to ListParts.

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

Proxy Property (AmazonGlacier Component)

A set of properties related to proxy access.

Syntax

• C#
• VB.NET

public Proxy Proxy { get; set; }

Public Property Proxy As Proxy

Remarks

This property contains fields describing the proxy through which the component will attempt to connect.

Region Property (AmazonGlacier Component)

The region the component will make requests against.

Syntax

• C#
• VB.NET

public string Region { get; set; }

Public Property Region As String

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.

SecretKey Property (AmazonGlacier Component)

The secret key to use for authentication.

Syntax

• C#
• VB.NET

public string SecretKey { get; set; }

Public Property SecretKey As String

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.

SSLAcceptServerCert Property (AmazonGlacier Component)

Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.

Syntax

• C#
• VB.NET

public Certificate SSLAcceptServerCert { get; set; }

Public Property SSLAcceptServerCert As Certificate

Remarks

If it finds any issues with the certificate presented by the server, the component will normally terminate the connection with an error.

You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

Please note that this functionality is provided only for cases where you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.

SSLCert Property (AmazonGlacier Component)

The certificate to be used during SSL negotiation.

Syntax

• C#
• VB.NET

public Certificate SSLCert { get; set; }

Public Property SSLCert As Certificate

Remarks

The digital certificate that the component will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.

SSLProvider Property (AmazonGlacier Component)

This specifies the SSL/TLS implementation to use.

Syntax

• C#
• VB.NET

public AmazonglacierSSLProviders SSLProvider { get; set; }

enum AmazonglacierSSLProviders {
  sslpAutomatic,
  sslpPlatform,
  sslpInternal
}

Public Property SSLProvider As AmazonglacierSSLProviders

Enum AmazonglacierSSLProviders
  sslpAutomatic
  sslpPlatform
  sslpInternal
End Enum

Default Value

0

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, on Windows the component will use the platform implementation. On Linux/macOS the component will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used on all platforms.

The .NET Standard library will always use the internal implementation on all platforms.

SSLServerCert Property (AmazonGlacier Component)

The server certificate for the last established connection.

Syntax

• C#
• VB.NET

public Certificate SSLServerCert { get; }

Public ReadOnly Property SSLServerCert As Certificate

Remarks

SSLServerCert contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

Timeout Property (AmazonGlacier Component)

A timeout for the component.

Syntax

• C#
• VB.NET

public int Timeout { get; set; }

Public Property Timeout As Integer

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 throws 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.

UseSSL Property (AmazonGlacier Component)

Whether to use SSL/TLS when connecting.

Syntax

• C#
• VB.NET

public bool UseSSL { get; set; }

Public Property UseSSL As Boolean

Default Value

True

Remarks

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

This property is not available at design time.

VaultMarker Property (AmazonGlacier Component)

A marker used to get the next page of results.

Syntax

• C#
• VB.NET

public string VaultMarker { get; set; }

Public Property VaultMarker As String

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.

Vaults Property (AmazonGlacier Component)

A collection of vault information.

Syntax

• C#
• VB.NET

public GlacierVaultList Vaults { get; }

Public ReadOnly Property Vaults As GlacierVaultList

Remarks

This collection is populated after calling ListVaults and GetVaultInfo.

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

AbortMultipartUpload Method (AmazonGlacier Component)

Aborts a multipart upload.

Syntax

• C#
• VB.NET

public void AbortMultipartUpload(string vaultName, string uploadId);

Async Version
public async Task AbortMultipartUpload(string vaultName, string uploadId);
public async Task AbortMultipartUpload(string vaultName, string uploadId, CancellationToken cancellationToken);

Public Sub AbortMultipartUpload(ByVal VaultName As String, ByVal UploadId As String)

Async Version
Public Sub AbortMultipartUpload(ByVal VaultName As String, ByVal UploadId As String) As Task
Public Sub AbortMultipartUpload(ByVal VaultName As String, ByVal UploadId As String, cancellationToken As CancellationToken) As Task

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

• C#
• VB.NET

public string CompleteMultipartUpload(string vaultName, string uploadId);

Async Version
public async Task<string> CompleteMultipartUpload(string vaultName, string uploadId);
public async Task<string> CompleteMultipartUpload(string vaultName, string uploadId, CancellationToken cancellationToken);

Public Function CompleteMultipartUpload(ByVal VaultName As String, ByVal UploadId As String) As String

Async Version
Public Function CompleteMultipartUpload(ByVal VaultName As String, ByVal UploadId As String) As Task(Of String)
Public Function CompleteMultipartUpload(ByVal VaultName As String, ByVal UploadId As String, cancellationToken As CancellationToken) As Task(Of String)

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

• C#
• VB.NET

public string Config(string configurationString);

Async Version
public async Task<string> Config(string configurationString);
public async Task<string> Config(string configurationString, CancellationToken cancellationToken);

Public Function Config(ByVal ConfigurationString As String) As String

Async Version
Public Function Config(ByVal ConfigurationString As String) As Task(Of String)
Public Function Config(ByVal ConfigurationString As String, cancellationToken As CancellationToken) As Task(Of String)

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

• C#
• VB.NET

public string CreateJob(string vaultName, int jobType, string archiveId, string SNSTopic);

Async Version
public async Task<string> CreateJob(string vaultName, int jobType, string archiveId, string SNSTopic);
public async Task<string> CreateJob(string vaultName, int jobType, string archiveId, string SNSTopic, CancellationToken cancellationToken);

Public Function CreateJob(ByVal VaultName As String, ByVal JobType As Integer, ByVal ArchiveId As String, ByVal SNSTopic As String) As String

Async Version
Public Function CreateJob(ByVal VaultName As String, ByVal JobType As Integer, ByVal ArchiveId As String, ByVal SNSTopic As String) As Task(Of String)
Public Function CreateJob(ByVal VaultName As String, ByVal JobType As Integer, ByVal ArchiveId As String, ByVal SNSTopic As String, cancellationToken As CancellationToken) As Task(Of String)

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

• C#
• VB.NET

public void CreateVault(string vaultName);

Async Version
public async Task CreateVault(string vaultName);
public async Task CreateVault(string vaultName, CancellationToken cancellationToken);

Public Sub CreateVault(ByVal VaultName As String)

Async Version
Public Sub CreateVault(ByVal VaultName As String) As Task
Public Sub CreateVault(ByVal VaultName As String, cancellationToken As CancellationToken) As Task

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

• C#
• VB.NET

public void DeleteArchive(string vaultName, string archiveId);

Async Version
public async Task DeleteArchive(string vaultName, string archiveId);
public async Task DeleteArchive(string vaultName, string archiveId, CancellationToken cancellationToken);

Public Sub DeleteArchive(ByVal VaultName As String, ByVal ArchiveId As String)

Async Version
Public Sub DeleteArchive(ByVal VaultName As String, ByVal ArchiveId As String) As Task
Public Sub DeleteArchive(ByVal VaultName As String, ByVal ArchiveId As String, cancellationToken As CancellationToken) As Task

Remarks

This method deletes the archive specified by the ArchiveId parameter.

DeleteNotificationInfo Method (AmazonGlacier Component)

Deletes the notification information for the vault.

Syntax

• C#
• VB.NET

public void DeleteNotificationInfo(string vaultName);

Async Version
public async Task DeleteNotificationInfo(string vaultName);
public async Task DeleteNotificationInfo(string vaultName, CancellationToken cancellationToken);

Public Sub DeleteNotificationInfo(ByVal VaultName As String)

Async Version
Public Sub DeleteNotificationInfo(ByVal VaultName As String) As Task
Public Sub DeleteNotificationInfo(ByVal VaultName As String, cancellationToken As CancellationToken) As Task

Remarks

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

DeleteVault Method (AmazonGlacier Component)

Deletes the specified vault.

Syntax

• C#
• VB.NET

public void DeleteVault(string vaultName);

Async Version
public async Task DeleteVault(string vaultName);
public async Task DeleteVault(string vaultName, CancellationToken cancellationToken);

Public Sub DeleteVault(ByVal VaultName As String)

Async Version
Public Sub DeleteVault(ByVal VaultName As String) As Task
Public Sub DeleteVault(ByVal VaultName As String, cancellationToken As CancellationToken) As Task

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

• C#
• VB.NET

public void DoEvents();

Async Version
public async Task DoEvents();
public async Task DoEvents(CancellationToken cancellationToken);

Public Sub DoEvents()

Async Version
Public Sub DoEvents() As Task
Public Sub DoEvents(cancellationToken As CancellationToken) As Task

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

• C#
• VB.NET

public void GetJobInfo(string vaultName, string jobId);

Async Version
public async Task GetJobInfo(string vaultName, string jobId);
public async Task GetJobInfo(string vaultName, string jobId, CancellationToken cancellationToken);

Public Sub GetJobInfo(ByVal VaultName As String, ByVal JobId As String)

Async Version
Public Sub GetJobInfo(ByVal VaultName As String, ByVal JobId As String) As Task
Public Sub GetJobInfo(ByVal VaultName As String, ByVal JobId As String, cancellationToken As CancellationToken) As Task

Remarks

This method retrieves information about the job specified by JobId. The Jobs collection will be populated with information about the job.

GetJobOutput Method (AmazonGlacier Component)

Retrieves the output from the job.

Syntax

• C#
• VB.NET

public void GetJobOutput(string vaultName, string jobId);

Async Version
public async Task GetJobOutput(string vaultName, string jobId);
public async Task GetJobOutput(string vaultName, string jobId, CancellationToken cancellationToken);

Public Sub GetJobOutput(ByVal VaultName As String, ByVal JobId As String)

Async Version
Public Sub GetJobOutput(ByVal VaultName As String, ByVal JobId As String) As Task
Public Sub GetJobOutput(ByVal VaultName As String, ByVal JobId As String, cancellationToken As CancellationToken) As Task

Remarks

This method retrieves the output from a completed job. If SetDownloadStream has been called the data will be written to the stream. 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

• C#
• VB.NET

public void GetNotificationInfo(string vaultName);

Async Version
public async Task GetNotificationInfo(string vaultName);
public async Task GetNotificationInfo(string vaultName, CancellationToken cancellationToken);

Public Sub GetNotificationInfo(ByVal VaultName As String)

Async Version
Public Sub GetNotificationInfo(ByVal VaultName As String) As Task
Public Sub GetNotificationInfo(ByVal VaultName As String, cancellationToken As CancellationToken) As Task

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 property.

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

GetVaultInfo Method (AmazonGlacier Component)

Retrieves vault details.

Syntax

• C#
• VB.NET

public void GetVaultInfo(string vaultName);

Async Version
public async Task GetVaultInfo(string vaultName);
public async Task GetVaultInfo(string vaultName, CancellationToken cancellationToken);

Public Sub GetVaultInfo(ByVal VaultName As String)

Async Version
Public Sub GetVaultInfo(ByVal VaultName As String) As Task
Public Sub GetVaultInfo(ByVal VaultName As String, cancellationToken As CancellationToken) As Task

Remarks

This method gets information about the vault specified by VaultName. The Vaults property will be populated with the results. The following fields are populated:

• ArchiveCount
• Arn
• CreationDate
• LastInventoryDate
• Name
• Size

Interrupt Method (AmazonGlacier Component)

Interrupt the current method.

Syntax

• C#
• VB.NET

public void Interrupt();

Async Version
public async Task Interrupt();
public async Task Interrupt(CancellationToken cancellationToken);

Public Sub Interrupt()

Async Version
Public Sub Interrupt() As Task
Public Sub Interrupt(cancellationToken As CancellationToken) As Task

Remarks

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

ListJobs Method (AmazonGlacier Component)

Lists the jobs in a vault.

Syntax

• C#
• VB.NET

public void ListJobs(string vaultName);

Async Version
public async Task ListJobs(string vaultName);
public async Task ListJobs(string vaultName, CancellationToken cancellationToken);

Public Sub ListJobs(ByVal VaultName As String)

Async Version
Public Sub ListJobs(ByVal VaultName As String) As Task
Public Sub ListJobs(ByVal VaultName As String, cancellationToken As CancellationToken) As Task

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 Jobs collection 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

• C#
• VB.NET

public void ListMultipartUploads(string vaultName);

Async Version
public async Task ListMultipartUploads(string vaultName);
public async Task ListMultipartUploads(string vaultName, CancellationToken cancellationToken);

Public Sub ListMultipartUploads(ByVal VaultName As String)

Async Version
Public Sub ListMultipartUploads(ByVal VaultName As String) As Task
Public Sub ListMultipartUploads(ByVal VaultName As String, cancellationToken As CancellationToken) As Task

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 MultipartUploads collection 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

• C#
• VB.NET

public void ListParts(string vaultName, string uploadId);

Async Version
public async Task ListParts(string vaultName, string uploadId);
public async Task ListParts(string vaultName, string uploadId, CancellationToken cancellationToken);

Public Sub ListParts(ByVal VaultName As String, ByVal UploadId As String)

Async Version
Public Sub ListParts(ByVal VaultName As String, ByVal UploadId As String) As Task
Public Sub ListParts(ByVal VaultName As String, ByVal UploadId As String, cancellationToken As CancellationToken) As Task

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 collection 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

• C#
• VB.NET

public void ListVaults();

Async Version
public async Task ListVaults();
public async Task ListVaults(CancellationToken cancellationToken);

Public Sub ListVaults()

Async Version
Public Sub ListVaults() As Task
Public Sub ListVaults(cancellationToken As CancellationToken) As Task

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

• C#
• VB.NET

public void Reset();

Async Version
public async Task Reset();
public async Task Reset(CancellationToken cancellationToken);

Public Sub Reset()

Async Version
Public Sub Reset() As Task
Public Sub Reset(cancellationToken As CancellationToken) As Task

Remarks

This method resets the component to its initial state.

SetDownloadStream Method (AmazonGlacier Component)

Sets the stream to which the downloaded data from the server will be written.

Syntax

• C#
• VB.NET

public void SetDownloadStream(System.IO.Stream downloadStream);

Async Version
public async Task SetDownloadStream(System.IO.Stream downloadStream);
public async Task SetDownloadStream(System.IO.Stream downloadStream, CancellationToken cancellationToken);

Public Sub SetDownloadStream(ByVal DownloadStream As System.IO.Stream)

Async Version
Public Sub SetDownloadStream(ByVal DownloadStream As System.IO.Stream) As Task
Public Sub SetDownloadStream(ByVal DownloadStream As System.IO.Stream, cancellationToken As CancellationToken) As Task

Remarks

If a download stream is set before calling GetJobOutput the downloaded data will be written to the stream. The stream should be open and normally set to position 0.

SetNotificationInfo Method (AmazonGlacier Component)

Sets notification information for a vault.

Syntax

• C#
• VB.NET

public void SetNotificationInfo(string vaultName);

Async Version
public async Task SetNotificationInfo(string vaultName);
public async Task SetNotificationInfo(string vaultName, CancellationToken cancellationToken);

Public Sub SetNotificationInfo(ByVal VaultName As String)

Async Version
Public Sub SetNotificationInfo(ByVal VaultName As String) As Task
Public Sub SetNotificationInfo(ByVal VaultName As String, cancellationToken As CancellationToken) As Task

Remarks

This method sets the notification settings for the vault specified by VaultName. The SNSTopic field must be set before calling this method. Optionally, the EventType may also be set.

SetUploadStream Method (AmazonGlacier Component)

Sets the stream to be uploaded to the server.

Syntax

• C#
• VB.NET

public void SetUploadStream(System.IO.Stream uploadStream);

Async Version
public async Task SetUploadStream(System.IO.Stream uploadStream);
public async Task SetUploadStream(System.IO.Stream uploadStream, CancellationToken cancellationToken);

Public Sub SetUploadStream(ByVal UploadStream As System.IO.Stream)

Async Version
Public Sub SetUploadStream(ByVal UploadStream As System.IO.Stream) As Task
Public Sub SetUploadStream(ByVal UploadStream As System.IO.Stream, cancellationToken As CancellationToken) As Task

Remarks

If an upload stream is set before calling UploadArchive the data will be read from this stream. The stream should be open and normally set to position 0.

StartMultipartUpload Method (AmazonGlacier Component)

Starts a multipart upload.

Syntax

• C#
• VB.NET

public string StartMultipartUpload(string vaultName, string archiveDesc);

Async Version
public async Task<string> StartMultipartUpload(string vaultName, string archiveDesc);
public async Task<string> StartMultipartUpload(string vaultName, string archiveDesc, CancellationToken cancellationToken);

Public Function StartMultipartUpload(ByVal VaultName As String, ByVal ArchiveDesc As String) As String

Async Version
Public Function StartMultipartUpload(ByVal VaultName As String, ByVal ArchiveDesc As String) As Task(Of String)
Public Function StartMultipartUpload(ByVal VaultName As String, ByVal ArchiveDesc As String, cancellationToken As CancellationToken) As Task(Of String)

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

• C#
• VB.NET

public string UploadArchive(string vaultName, string archiveDesc);

Async Version
public async Task<string> UploadArchive(string vaultName, string archiveDesc);
public async Task<string> UploadArchive(string vaultName, string archiveDesc, CancellationToken cancellationToken);

Public Function UploadArchive(ByVal VaultName As String, ByVal ArchiveDesc As String) As String

Async Version
Public Function UploadArchive(ByVal VaultName As String, ByVal ArchiveDesc As String) As Task(Of String)
Public Function UploadArchive(ByVal VaultName As String, ByVal ArchiveDesc As String, cancellationToken As CancellationToken) As Task(Of String)

Remarks

This method uploads an archive to the vault specified by VaultName. If SetUploadStream was used to specify a valid stream, the archive data will be read from there. 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

• C#
• VB.NET

public void UploadPart(string vaultName, string uploadId, int partNumber);

Async Version
public async Task UploadPart(string vaultName, string uploadId, int partNumber);
public async Task UploadPart(string vaultName, string uploadId, int partNumber, CancellationToken cancellationToken);

Public Sub UploadPart(ByVal VaultName As String, ByVal UploadId As String, ByVal PartNumber As Integer)

Async Version
Public Sub UploadPart(ByVal VaultName As String, ByVal UploadId As String, ByVal PartNumber As Integer) As Task
Public Sub UploadPart(ByVal VaultName As String, ByVal UploadId As String, ByVal PartNumber As Integer, cancellationToken As CancellationToken) As Task

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 SetUploadStream was used to specify a valid stream, the part data will be read from there. 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

• C#
• VB.NET

public event OnEndTransferHandler OnEndTransfer;

public delegate void OnEndTransferHandler(object sender, AmazonglacierEndTransferEventArgs e);

public class AmazonglacierEndTransferEventArgs : EventArgs {
  public int Direction { get; }
}

Public Event OnEndTransfer As OnEndTransferHandler

Public Delegate Sub OnEndTransferHandler(sender As Object, e As AmazonglacierEndTransferEventArgs)

Public Class AmazonglacierEndTransferEventArgs Inherits EventArgs
  Public ReadOnly Property Direction As Integer
End Class

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

• C#
• VB.NET

public event OnErrorHandler OnError;

public delegate void OnErrorHandler(object sender, AmazonglacierErrorEventArgs e);

public class AmazonglacierErrorEventArgs : EventArgs {
  public int ErrorCode { get; }
  public string Description { get; }
}

Public Event OnError As OnErrorHandler

Public Delegate Sub OnErrorHandler(sender As Object, e As AmazonglacierErrorEventArgs)

Public Class AmazonglacierErrorEventArgs Inherits EventArgs
  Public ReadOnly Property ErrorCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the component throws 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

• C#
• VB.NET

public event OnHeaderHandler OnHeader;

public delegate void OnHeaderHandler(object sender, AmazonglacierHeaderEventArgs e);

public class AmazonglacierHeaderEventArgs : EventArgs {
  public string Field { get; }
  public string Value { get; }
}

Public Event OnHeader As OnHeaderHandler

Public Delegate Sub OnHeaderHandler(sender As Object, e As AmazonglacierHeaderEventArgs)

Public Class AmazonglacierHeaderEventArgs Inherits EventArgs
  Public ReadOnly Property Field As String
  Public ReadOnly Property Value As String
End Class

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

• C#
• VB.NET

public event OnJobListHandler OnJobList;

public delegate void OnJobListHandler(object sender, AmazonglacierJobListEventArgs e);

public class AmazonglacierJobListEventArgs : EventArgs {
  public int JobType { get; }
  public string ArchiveId { get; }
  public long ArchiveSize { get; }
  public string ArchiveSHA256TreeHash { get; }
  public bool Completed { get; }
  public string CompletionDate { get; }
  public string CreationDate { get; }
  public string Description { get; }
  public string JobId { get; }
  public string SNSTopic { get; }
  public string SHA256TreeHash { get; }
  public int StatusCode { get; }
  public string StatusMessage { get; }
  public string VaultArn { get; }
  public long InventorySize { get; }
}

Public Event OnJobList As OnJobListHandler

Public Delegate Sub OnJobListHandler(sender As Object, e As AmazonglacierJobListEventArgs)

Public Class AmazonglacierJobListEventArgs Inherits EventArgs
  Public ReadOnly Property JobType As Integer
  Public ReadOnly Property ArchiveId As String
  Public ReadOnly Property ArchiveSize As Long
  Public ReadOnly Property ArchiveSHA256TreeHash As String
  Public ReadOnly Property Completed As Boolean
  Public ReadOnly Property CompletionDate As String
  Public ReadOnly Property CreationDate As String
  Public ReadOnly Property Description As String
  Public ReadOnly Property JobId As String
  Public ReadOnly Property SNSTopic As String
  Public ReadOnly Property SHA256TreeHash As String
  Public ReadOnly Property StatusCode As Integer
  Public ReadOnly Property StatusMessage As String
  Public ReadOnly Property VaultArn As String
  Public ReadOnly Property InventorySize As Long
End Class

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

• C#
• VB.NET

public event OnLogHandler OnLog;

public delegate void OnLogHandler(object sender, AmazonglacierLogEventArgs e);

public class AmazonglacierLogEventArgs : EventArgs {
  public int LogLevel { get; }
  public string Message { get; }
  public string LogType { get; }
}

Public Event OnLog As OnLogHandler

Public Delegate Sub OnLogHandler(sender As Object, e As AmazonglacierLogEventArgs)

Public Class AmazonglacierLogEventArgs Inherits EventArgs
  Public ReadOnly Property LogLevel As Integer
  Public ReadOnly Property Message As String
  Public ReadOnly Property LogType As String
End Class

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

• C#
• VB.NET

public event OnMultipartUploadListHandler OnMultipartUploadList;

public delegate void OnMultipartUploadListHandler(object sender, AmazonglacierMultipartUploadListEventArgs e);

public class AmazonglacierMultipartUploadListEventArgs : EventArgs {
  public string ArchiveDescription { get; }
  public string CreationDate { get; }
  public string UploadId { get; }
  public string VaultArn { get; }
  public int PartSize { get; }
}

Public Event OnMultipartUploadList As OnMultipartUploadListHandler

Public Delegate Sub OnMultipartUploadListHandler(sender As Object, e As AmazonglacierMultipartUploadListEventArgs)

Public Class AmazonglacierMultipartUploadListEventArgs Inherits EventArgs
  Public ReadOnly Property ArchiveDescription As String
  Public ReadOnly Property CreationDate As String
  Public ReadOnly Property UploadId As String
  Public ReadOnly Property VaultArn As String
  Public ReadOnly Property PartSize As Integer
End Class

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

• C#
• VB.NET

public event OnPartListHandler OnPartList;

public delegate void OnPartListHandler(object sender, AmazonglacierPartListEventArgs e);

public class AmazonglacierPartListEventArgs : EventArgs {
  public string ArchiveDescription { get; }
  public string CreationDate { get; }
  public string UploadId { get; }
  public long StartPosition { get; }
  public long Size { get; }
  public string SHA256TreeHash { get; }
  public string VaultArn { get; }
}

Public Event OnPartList As OnPartListHandler

Public Delegate Sub OnPartListHandler(sender As Object, e As AmazonglacierPartListEventArgs)

Public Class AmazonglacierPartListEventArgs Inherits EventArgs
  Public ReadOnly Property ArchiveDescription As String
  Public ReadOnly Property CreationDate As String
  Public ReadOnly Property UploadId As String
  Public ReadOnly Property StartPosition As Long
  Public ReadOnly Property Size As Long
  Public ReadOnly Property SHA256TreeHash As String
  Public ReadOnly Property VaultArn As String
End Class

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

• C#
• VB.NET

public event OnProgressHandler OnProgress;

public delegate void OnProgressHandler(object sender, AmazonglacierProgressEventArgs e);

public class AmazonglacierProgressEventArgs : EventArgs {
  public int Direction { get; }
  public long BytesTransferred { get; }
  public long TotalBytes { get; }
  public int PercentDone { get; }
}

Public Event OnProgress As OnProgressHandler

Public Delegate Sub OnProgressHandler(sender As Object, e As AmazonglacierProgressEventArgs)

Public Class AmazonglacierProgressEventArgs Inherits EventArgs
  Public ReadOnly Property Direction As Integer
  Public ReadOnly Property BytesTransferred As Long
  Public ReadOnly Property TotalBytes As Long
  Public ReadOnly Property PercentDone As Integer
End Class

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

• C#
• VB.NET

public event OnSSLServerAuthenticationHandler OnSSLServerAuthentication;

public delegate void OnSSLServerAuthenticationHandler(object sender, AmazonglacierSSLServerAuthenticationEventArgs e);

public class AmazonglacierSSLServerAuthenticationEventArgs : EventArgs {
  public string CertEncoded { get; }
  public byte[] CertEncodedB { get; }
  public string CertSubject { get; }
  public string CertIssuer { get; }
  public string Status { get; }
  public bool Accept { get; set; }
}

Public Event OnSSLServerAuthentication As OnSSLServerAuthenticationHandler

Public Delegate Sub OnSSLServerAuthenticationHandler(sender As Object, e As AmazonglacierSSLServerAuthenticationEventArgs)

Public Class AmazonglacierSSLServerAuthenticationEventArgs Inherits EventArgs
  Public ReadOnly Property CertEncoded As String
  Public ReadOnly Property CertEncodedB As Byte()
  Public ReadOnly Property CertSubject As String
  Public ReadOnly Property CertIssuer As String
  Public ReadOnly Property Status As String
  Public Property Accept As Boolean
End Class

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

• C#
• VB.NET

public event OnSSLStatusHandler OnSSLStatus;

public delegate void OnSSLStatusHandler(object sender, AmazonglacierSSLStatusEventArgs e);

public class AmazonglacierSSLStatusEventArgs : EventArgs {
  public string Message { get; }
}

Public Event OnSSLStatus As OnSSLStatusHandler

Public Delegate Sub OnSSLStatusHandler(sender As Object, e As AmazonglacierSSLStatusEventArgs)

Public Class AmazonglacierSSLStatusEventArgs Inherits EventArgs
  Public ReadOnly Property Message As String
End Class

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

• C#
• VB.NET

public event OnStartTransferHandler OnStartTransfer;

public delegate void OnStartTransferHandler(object sender, AmazonglacierStartTransferEventArgs e);

public class AmazonglacierStartTransferEventArgs : EventArgs {
  public int Direction { get; }
}

Public Event OnStartTransfer As OnStartTransferHandler

Public Delegate Sub OnStartTransferHandler(sender As Object, e As AmazonglacierStartTransferEventArgs)

Public Class AmazonglacierStartTransferEventArgs Inherits EventArgs
  Public ReadOnly Property Direction As Integer
End Class

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

• C#
• VB.NET

public event OnTransferHandler OnTransfer;

public delegate void OnTransferHandler(object sender, AmazonglacierTransferEventArgs e);

public class AmazonglacierTransferEventArgs : EventArgs {
  public int Direction { get; }
  public long BytesTransferred { get; }
  public int PercentDone { get; }
  public string Text { get; }
  public byte[] TextB { get; }
}

Public Event OnTransfer As OnTransferHandler

Public Delegate Sub OnTransferHandler(sender As Object, e As AmazonglacierTransferEventArgs)

Public Class AmazonglacierTransferEventArgs Inherits EventArgs
  Public ReadOnly Property Direction As Integer
  Public ReadOnly Property BytesTransferred As Long
  Public ReadOnly Property PercentDone As Integer
  Public ReadOnly Property Text As String
  Public ReadOnly Property TextB As Byte()
End Class

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

• C#
• VB.NET

public event OnVaultListHandler OnVaultList;

public delegate void OnVaultListHandler(object sender, AmazonglacierVaultListEventArgs e);

public class AmazonglacierVaultListEventArgs : EventArgs {
  public string CreationDate { get; }
  public string LastInventoryDate { get; }
  public string VaultArn { get; }
  public string VaultName { get; }
  public int ArchiveCount { get; }
  public long Size { get; }
}

Public Event OnVaultList As OnVaultListHandler

Public Delegate Sub OnVaultListHandler(sender As Object, e As AmazonglacierVaultListEventArgs)

Public Class AmazonglacierVaultListEventArgs Inherits EventArgs
  Public ReadOnly Property CreationDate As String
  Public ReadOnly Property LastInventoryDate As String
  Public ReadOnly Property VaultArn As String
  Public ReadOnly Property VaultName As String
  Public ReadOnly Property ArchiveCount As Integer
  Public ReadOnly Property Size As Long
End Class

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.

Certificate Type

This is the digital certificate being used.

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

Fields

Constructors

• C#
• VB.NET

public Certificate();

Public Certificate()

Creates a Certificate instance whose properties can be set. This is useful for use with CERTMGR when generating new certificates.

• C#
• VB.NET

public Certificate(string certificateFile);

Public Certificate(ByVal CertificateFile As String)

Opens CertificateFile and reads out the contents as an X.509 public key.

• C#
• VB.NET

public Certificate(byte[] certificateData);

Public Certificate(ByVal CertificateData As Byte())

Parses CertificateData as an X.509 public key.

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, string store, string storePassword, string subject);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String)

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN).

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, string store, string storePassword, string subject, string configurationString);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. ConfigurationString is a newline separated list of name-value pairs that may be used to modify the default behavior. Possible values include "PersistPFXKey", which shows whether or not the PFX key is persisted after performing operations with the private key. This correlates to the PKCS12_NO_PERSIST_KEY CryptoAPI option. The default value is True (the key is persisted). "Thumbprint" - an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to cstUser, cstMachine, cstPublicKeyFile, and cstPFXFile store types. "UseInternalSecurityAPI" shows whether the platform (default) or the internal security API is used when performing certificate-related operations. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN).

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, string store, string storePassword, byte[] encoded);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Encoded As Byte())

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will load Encoded as an X.509 certificate and search the opened store for a corresponding private key.

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, byte[] storeBlob, string storePassword, string subject);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal StoreBlob As Byte(), ByVal StorePassword As String, ByVal Subject As String)

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or Base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN).

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, byte[] storeBlob, string storePassword, string subject, string configurationString);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal StoreBlob As Byte(), ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or Base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN).

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, byte[] storeBlob, string storePassword, byte[] encoded);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal StoreBlob As Byte(), ByVal StorePassword As String, ByVal Encoded As Byte())

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or Base64-encoded) containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will load Encoded as an X.509 certificate and search the opened store for a corresponding private key.

Firewall Type

The firewall the component will connect through.

Remarks

When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall Host and the FirewallType.

Fields

Constructors

• C#
• VB.NET

public Firewall();

Public Firewall()

GlacierJob Type

This type holds details about the job.

Remarks

This type holds details about the job.

Fields

Constructors

• C#
• VB.NET

public GlacierJob();

Public GlacierJob()

• C#
• VB.NET

public GlacierJob(int type, string archiveId, long archiveSize, string archiveSHA256TreeHash, bool completed, string completionDate, string creationDate, string description, string jobId, string SNSTopic, string SHA256TreeHash, int statusCode, string statusMessage, string vaultArn, long inventorySize);

Public GlacierJob(ByVal Type As Integer, ByVal ArchiveId As String, ByVal ArchiveSize As Long, ByVal ArchiveSHA256TreeHash As String, ByVal Completed As Boolean, ByVal CompletionDate As String, ByVal CreationDate As String, ByVal Description As String, ByVal JobId As String, ByVal SNSTopic As String, ByVal SHA256TreeHash As String, ByVal StatusCode As Integer, ByVal StatusMessage As String, ByVal VaultArn As String, ByVal InventorySize As Long)

GlacierMultipartUpload Type

This type holds details about the multipart upload.

Remarks

This type holds details about the multipart upload.

Fields

Constructors

• C#
• VB.NET

public GlacierMultipartUpload();

Public GlacierMultipartUpload()

• C#
• VB.NET

public GlacierMultipartUpload(string archiveDescription, string creationDate, string uploadId, string vaultArn, int partSize);

Public GlacierMultipartUpload(ByVal ArchiveDescription As String, ByVal CreationDate As String, ByVal UploadId As String, ByVal VaultArn As String, ByVal PartSize As Integer)

GlacierNotification Type

This type holds notification information.

Remarks

This type holds notification information.

Fields

Constructors

• C#
• VB.NET

public GlacierNotification();

Public GlacierNotification()

• C#
• VB.NET

public GlacierNotification(int eventType, string SNSTopic);

Public GlacierNotification(ByVal EventType As Integer, ByVal SNSTopic As String)

GlacierPart Type

This type holds details about the part.

Remarks

This type holds details about the part.

Fields

Constructors

• C#
• VB.NET

public GlacierPart();

Public GlacierPart()

• C#
• VB.NET

public GlacierPart(string archiveDescription, string creationDate, string uploadId, long startPosition, long size, string SHA256TreeHash, string vaultArn);

Public GlacierPart(ByVal ArchiveDescription As String, ByVal CreationDate As String, ByVal UploadId As String, ByVal StartPosition As Long, ByVal Size As Long, ByVal SHA256TreeHash As String, ByVal VaultArn As String)

GlacierVault Type

This type holds vault information.

Remarks

This type holds vault information.

Fields

Constructors

• C#
• VB.NET

public GlacierVault();

Public GlacierVault()

• C#
• VB.NET

public GlacierVault(string arn, string name, string creationDate, string lastInventoryDate, int archiveCount, long size);

Public GlacierVault(ByVal Arn As String, ByVal Name As String, ByVal CreationDate As String, ByVal LastInventoryDate As String, ByVal ArchiveCount As Integer, ByVal Size As Long)

Header Type

This is an HTTP header as it is received from the server.

Remarks

When a header is received through a Header event, it is parsed into a Header type. This type contains a Field, and its corresponding Value.

Fields

Constructors

• C#
• VB.NET

public Header();

Public Header()

• C#
• VB.NET

public Header(string field, string value);

Public Header(ByVal Field As String, ByVal Value As String)

Proxy Type

The proxy the component will connect to.

Remarks

When connecting through a proxy, this type is used to specify different properties of the proxy, such as the Server and the AuthScheme.

Fields

Constructors

• C#
• VB.NET

public Proxy();

Public Proxy()

• C#
• VB.NET

public Proxy(string server, int port);

Public Proxy(ByVal Server As String, ByVal Port As Integer)

• C#
• VB.NET

public Proxy(string server, int port, string user, string password);

Public Proxy(ByVal Server As String, ByVal Port As Integer, ByVal User As String, ByVal Password As String)

Config Settings (AmazonGlacier Component)

AmazonGlacier Config Settings

HTTP Config Settings

TCPClient Config Settings