IPWorks Cloud 2020 .NET Edition

Questions / Feedback?

JobList Event

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

Syntax

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:

0Archive Retrieval
1Inventory Retrieval

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:

0 None
1 In Progress
2 Succeeded
3 Failed

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.

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks Cloud 2020 .NET Edition - Version 20.0 [Build 8265]