JobParameters

public struct JobParameters : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

  • The ID of the archive that you want to retrieve. This field is required only if Type is set to select or archive-retrievalcode>. An error occurs if you specify this request parameter for an inventory retrieval job request.

    Declaration

    Swift

    public let archiveId: String?

  • The optional description for the job. The description must be less than or equal to 1,024 bytes. The allowable characters are 7-bit ASCII without control codes-specifically, ASCII values 32-126 decimal or 0x20-0x7E hexadecimal.

    Declaration

    Swift

    public let description: String?

  • When initiating a job to retrieve a vault inventory, you can optionally add this parameter to your request to specify the output format. If you are initiating an inventory job and do not specify a Format field, JSON is the default format. Valid values are “CSV” and “JSON”.

    Declaration

    Swift

    public let format: String?

  • Input parameters used for range inventory retrieval.

    Declaration

    Swift

    public let inventoryRetrievalParameters: InventoryRetrievalJobInput?

  • Contains information about the location where the select job results are stored.

    Declaration

    Swift

    public let outputLocation: OutputLocation?

  • The byte range to retrieve for an archive retrieval. in the form “StartByteValue-EndByteValue” If not specified, the whole archive is retrieved. If specified, the byte range must be megabyte (1024*1024) aligned which means that StartByteValue must be divisible by 1 MB and EndByteValue plus 1 must be divisible by 1 MB or be the end of the archive specified as the archive byte size value minus 1. If RetrievalByteRange is not megabyte aligned, this operation returns a 400 response. An error occurs if you specify this field for an inventory retrieval job request.

    Declaration

    Swift

    public let retrievalByteRange: String?

  • Contains the parameters that define a job.

    Declaration

    Swift

    public let selectParameters: SelectParameters?

  • The Amazon SNS topic ARN to which Amazon S3 Glacier sends a notification when the job is completed and the output is ready for you to download. The specified topic publishes the notification to its subscribers. The SNS topic must exist.

    Declaration

    Swift

    public let sNSTopic: String?

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

    Declaration

    Swift

    public let tier: String?

  • The job type. You can initiate a job to perform a select query on an archive, retrieve an archive, or get an inventory of a vault. Valid values are “select”, “archive-retrieval” and “inventory-retrieval”.

    Declaration

    Swift

    public let type: String?

  • Undocumented

    Declaration

    Swift

    public init(archiveId: String? = nil, description: String? = nil, format: String? = nil, inventoryRetrievalParameters: InventoryRetrievalJobInput? = nil, outputLocation: OutputLocation? = nil, retrievalByteRange: String? = nil, selectParameters: SelectParameters? = nil, sNSTopic: String? = nil, tier: String? = nil, type: String? = nil)