IPWorks Cloud 2020 macOS Edition

Questions / Feedback?

CreateJob Method

Creates a new job.

Syntax

public func createJob(vaultName: String, jobType: Int32, archiveId: String, snsTopic: String) throws -> 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:

0Archive Retrieval
1Inventory Retrieval

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

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