CreateJob Method

Creates a new job.

Syntax

• C++
• Objective-C
• C

ANSI (Cross Platform)
char* CreateJob(const char* lpszVaultName, int iJobType, const char* lpszArchiveId, const char* lpszSNSTopic);

Unicode (Windows)
LPWSTR CreateJob(LPCWSTR lpszVaultName, INT iJobType, LPCWSTR lpszArchiveId, LPCWSTR lpszSNSTopic);

- (NSString*)createJob:(NSString*)vaultName :(int)jobType :(NSString*)archiveId :(NSString*)SNSTopic;

#define MID_AMAZONGLACIER_CREATEJOB 5

IPWORKSCLOUD_EXTERNAL int IPWORKSCLOUD_CALL IPWorksCloud_AmazonGlacier_Do(void *lpObj, int methid, int cparam, void *param[], int cbparam[], int64 *lpllVal);

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

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.