JobList Event

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

Syntax

• C++
• Objective-C
• C

ANSI (Cross Platform)
virtual int FireJobList(AmazonGlacierJobListEventParams *e);

typedef struct {
  int JobType;
  const char *ArchiveId;
  int64 ArchiveSize;
  const char *ArchiveSHA256TreeHash;
  int Completed;
  const char *CompletionDate;
  const char *CreationDate;
  const char *Description;
  const char *JobId;
  const char *SNSTopic;
  const char *SHA256TreeHash;
  int StatusCode;
  const char *StatusMessage;
  const char *VaultArn;
  int64 InventorySize;
  int reserved;
} AmazonGlacierJobListEventParams;

Unicode (Windows)
virtual INT FireJobList(AmazonGlacierJobListEventParams *e);

typedef struct {
  INT JobType;
  LPCWSTR ArchiveId;
  LONG64 ArchiveSize;
  LPCWSTR ArchiveSHA256TreeHash;
  BOOL Completed;
  LPCWSTR CompletionDate;
  LPCWSTR CreationDate;
  LPCWSTR Description;
  LPCWSTR JobId;
  LPCWSTR SNSTopic;
  LPCWSTR SHA256TreeHash;
  INT StatusCode;
  LPCWSTR StatusMessage;
  LPCWSTR VaultArn;
  LONG64 InventorySize;
  INT reserved;
} AmazonGlacierJobListEventParams;

- (void)onJobList:(int)jobType :(NSString*)archiveId :(long long)archiveSize :(NSString*)archiveSHA256TreeHash :(BOOL)completed :(NSString*)completionDate :(NSString*)creationDate :(NSString*)description :(NSString*)jobId :(NSString*)SNSTopic :(NSString*)SHA256TreeHash :(int)statusCode :(NSString*)statusMessage :(NSString*)vaultArn :(long long)inventorySize;

#define EID_AMAZONGLACIER_JOBLIST 4

virtual INT IPWORKSCLOUD_CALL FireJobList(INT &iJobType, LPSTR &lpszArchiveId, LONG64 &lArchiveSize, LPSTR &lpszArchiveSHA256TreeHash, BOOL &bCompleted, LPSTR &lpszCompletionDate, LPSTR &lpszCreationDate, LPSTR &lpszDescription, LPSTR &lpszJobId, LPSTR &lpszSNSTopic, LPSTR &lpszSHA256TreeHash, INT &iStatusCode, LPSTR &lpszStatusMessage, LPSTR &lpszVaultArn, LONG64 &lInventorySize);

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.