GlacierJobDescription

public struct GlacierJobDescription : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

  • The job type. This value is either ArchiveRetrieval, InventoryRetrieval, or Select.

    Declaration

    Swift

    public let action: ActionCode?

  • The archive ID requested for a select job or archive retrieval. Otherwise, this field is null.

    Declaration

    Swift

    public let archiveId: String?

  • The SHA256 tree hash of the entire archive for an archive retrieval. For inventory retrieval or select jobs, this field is null.

    Declaration

    Swift

    public let archiveSHA256TreeHash: String?

  • For an archive retrieval job, this value is the size in bytes of the archive being requested for download. For an inventory retrieval or select job, this value is null.

    Declaration

    Swift

    public let archiveSizeInBytes: Int64?

  • The job status. When a job is completed, you get the job’s output using Get Job Output (GET output).

    Declaration

    Swift

    public let completed: Bool?

  • The UTC time that the job request completed. While the job is in progress, the value is null.

    Declaration

    Swift

    public let completionDate: String?

  • The UTC date when the job was created. This value is a string representation of ISO 8601 date format, for example “2012-03-20T17:03:43.221Z”.

    Declaration

    Swift

    public let creationDate: String?

  • Parameters used for range inventory retrieval.

    Declaration

    Swift

    public let inventoryRetrievalParameters: InventoryRetrievalJobDescription?

  • For an inventory retrieval job, this value is the size in bytes of the inventory requested for download. For an archive retrieval or select job, this value is null.

    Declaration

    Swift

    public let inventorySizeInBytes: Int64?

  • The job description provided when initiating the job.

    Declaration

    Swift

    public let jobDescription: String?

  • An opaque string that identifies an Amazon S3 Glacier job.

    Declaration

    Swift

    public let jobId: String?

  • Contains the job output location.

    Declaration

    Swift

    public let jobOutputPath: String?

  • Contains the location where the data from the select job is stored.

    Declaration

    Swift

    public let outputLocation: OutputLocation?

  • The retrieved byte range for archive retrieval jobs in the form StartByteValue-EndByteValue. If no range was specified in the archive retrieval, then the whole archive is retrieved. In this case, StartByteValue equals 0 and EndByteValue equals the size of the archive minus 1. For inventory retrieval or select jobs, this field is null.

    Declaration

    Swift

    public let retrievalByteRange: String?

  • Contains the parameters used for a select.

    Declaration

    Swift

    public let selectParameters: SelectParameters?

  • For an archive retrieval job, this value is the checksum of the archive. Otherwise, this value is null. The SHA256 tree hash value for the requested range of an archive. If the InitiateJob request for an archive specified a tree-hash aligned range, then this field returns a value. If the whole archive is retrieved, this value is the same as the ArchiveSHA256TreeHash value. This field is null for the following: Archive retrieval jobs that specify a range that is not tree-hash aligned Archival jobs that specify a range that is equal to the whole archive, when the job status is InProgress Inventory jobs Select jobs

    Declaration

    Swift

    public let sHA256TreeHash: String?

  • An Amazon SNS topic that receives notification.

    Declaration

    Swift

    public let sNSTopic: String?

  • The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.

    Declaration

    Swift

    public let statusCode: StatusCode?

  • A friendly message that describes the job status.

    Declaration

    Swift

    public let statusMessage: String?

  • The tier to use for a select or an archive retrieval. Valid values are Expedited, Standard, or Bulk. Standard is the default.

    Declaration

    Swift

    public let tier: String?

  • The Amazon Resource Name (ARN) of the vault from which an archive retrieval was requested.

    Declaration

    Swift

    public let vaultARN: String?

  • Undocumented

    Declaration

    Swift

    public init(action: ActionCode? = nil, archiveId: String? = nil, archiveSHA256TreeHash: String? = nil, archiveSizeInBytes: Int64? = nil, completed: Bool? = nil, completionDate: String? = nil, creationDate: String? = nil, inventoryRetrievalParameters: InventoryRetrievalJobDescription? = nil, inventorySizeInBytes: Int64? = nil, jobDescription: String? = nil, jobId: String? = nil, jobOutputPath: String? = nil, outputLocation: OutputLocation? = nil, retrievalByteRange: String? = nil, selectParameters: SelectParameters? = nil, sHA256TreeHash: String? = nil, sNSTopic: String? = nil, statusCode: StatusCode? = nil, statusMessage: String? = nil, tier: String? = nil, vaultARN: String? = nil)