ImportExport

public struct ImportExport

Client object for interacting with AWS ImportExport service.

AWS Import/Export Service AWS Import/Export accelerates transferring large amounts of data between the AWS cloud and portable storage devices that you mail to us. AWS Import/Export transfers data directly onto and off of your storage devices using Amazon’s high-speed internal network and bypassing the Internet. For large data sets, AWS Import/Export is often faster than Internet transfer and more cost effective than upgrading your connectivity.

Member variables

Initialization

  • Initialize the ImportExport client

    Declaration

    Swift

    public init(accessKeyId: String? = nil, secretAccessKey: String? = nil, sessionToken: String? = nil, region: AWSSDKSwiftCore.Region? = nil, endpoint: String? = nil, middlewares: [AWSServiceMiddleware] = [], eventLoopGroupProvider: AWSClient.EventLoopGroupProvider = .useAWSClientShared)

    Parameters

    accessKeyId

    Public access key provided by AWS
    secretAccessKey

    Private access key provided by AWS
    sessionToken

    Token provided by STS.AssumeRole() which allows access to another AWS account
    region

    Region of server you want to communicate with
    endpoint

    Custom endpoint URL to use instead of standard AWS servers
    middlewares

    Array of middlewares to apply to requests and responses
    eventLoopGroupProvider

    EventLoopGroup to use. Use useAWSClientShared if the client shall manage its own EventLoopGroup.

API Calls

  • This operation cancels a specified job. Only the job owner can cancel it. The operation fails if the job has already started or is complete.

    Declaration

    Swift

    public func cancelJob(_ input: CancelJobInput) -> EventLoopFuture<CancelJobOutput>

  • This operation initiates the process of scheduling an upload or download of your data. You include in the request a manifest that describes the data transfer specifics. The response to the request includes a job ID, which you can use in other operations, a signature that you use to identify your storage device, and the address where you should ship your storage device.

    Declaration

    Swift

    public func createJob(_ input: CreateJobInput) -> EventLoopFuture<CreateJobOutput>

  • This operation generates a pre-paid UPS shipping label that you will use to ship your device to AWS for processing.

    Declaration

    Swift

    public func getShippingLabel(_ input: GetShippingLabelInput) -> EventLoopFuture<GetShippingLabelOutput>

  • This operation returns information about a job, including where the job is in the processing pipeline, the status of the results, and the signature value associated with the job. You can only return information about jobs you own.

    Declaration

    Swift

    public func getStatus(_ input: GetStatusInput) -> EventLoopFuture<GetStatusOutput>

  • This operation returns the jobs associated with the requester. AWS Import/Export lists the jobs in reverse chronological order based on the date of creation. For example if Job Test1 was created 2009Dec30 and Test2 was created 2010Feb05, the ListJobs operation would return Test2 followed by Test1.

    Declaration

    Swift

    public func listJobs(_ input: ListJobsInput) -> EventLoopFuture<ListJobsOutput>

  • You use this operation to change the parameters specified in the original manifest file by supplying a new manifest file. The manifest file attached to this request replaces the original manifest file. You can only use the operation after a CreateJob request but before the data transfer starts and you can only use it on jobs you own.

    Declaration

    Swift

    public func updateJob(_ input: UpdateJobInput) -> EventLoopFuture<UpdateJobOutput>

Paginators

  • This operation returns the jobs associated with the requester. AWS Import/Export lists the jobs in reverse chronological order based on the date of creation. For example if Job Test1 was created 2009Dec30 and Test2 was created 2010Feb05, the ListJobs operation would return Test2 followed by Test1.

    Declaration

    Swift

    public func listJobsPaginator(_ input: ListJobsInput, onPage: @escaping (ListJobsOutput, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

Shapes

Enums

  • Undocumented

    See more

    Declaration

    Swift

    public enum JobType : String, CustomStringConvertible, Codable