importexport

Documentation

Overview

Package importexport provides a client for AWS Import/Export.

Index

• Constants
• type CancelJobInput
• type CancelJobOutput
• type CancelJobResult
• type CreateJobInput
• type CreateJobOutput
• type CreateJobResult
• type GetStatusInput
• type GetStatusOutput
• type GetStatusResult
• type ImportExport
  • func New(creds aws.CredentialsProvider, region string, client *http.Client) *ImportExport
  • func (c *ImportExport) CancelJob(req *CancelJobInput) (resp *CancelJobResult, err error)
  • func (c *ImportExport) CreateJob(req *CreateJobInput) (resp *CreateJobResult, err error)
  • func (c *ImportExport) GetStatus(req *GetStatusInput) (resp *GetStatusResult, err error)
  • func (c *ImportExport) ListJobs(req *ListJobsInput) (resp *ListJobsResult, err error)
  • func (c *ImportExport) UpdateJob(req *UpdateJobInput) (resp *UpdateJobResult, err error)
• type Job
• type ListJobsInput
• type ListJobsOutput
• type ListJobsResult
• type UpdateJobInput
• type UpdateJobOutput
• type UpdateJobResult

Constants

const (
	JobTypeExport = "Export"
	JobTypeImport = "Import"
)

Possible values for ImportExport.

Types

type CancelJobInput

type CancelJobInput struct {
	JobID aws.StringValue `query:"JobId" xml:"JobId"`
}

CancelJobInput is undocumented.

type CancelJobOutput

type CancelJobOutput struct {
	Success aws.BooleanValue `query:"Success" xml:"CancelJobResult>Success"`
}

CancelJobOutput is undocumented.

type CancelJobResult

type CancelJobResult struct {
	Success aws.BooleanValue `query:"Success" xml:"CancelJobResult>Success"`
}

CancelJobResult is a wrapper for CancelJobOutput.

type CreateJobInput

type CreateJobInput struct {
	JobType          aws.StringValue  `query:"JobType" xml:"JobType"`
	Manifest         aws.StringValue  `query:"Manifest" xml:"Manifest"`
	ManifestAddendum aws.StringValue  `query:"ManifestAddendum" xml:"ManifestAddendum"`
	ValidateOnly     aws.BooleanValue `query:"ValidateOnly" xml:"ValidateOnly"`
}

CreateJobInput is undocumented.

type CreateJobOutput

type CreateJobOutput struct {
	AWSShippingAddress    aws.StringValue `query:"AwsShippingAddress" xml:"CreateJobResult>AwsShippingAddress"`
	JobID                 aws.StringValue `query:"JobId" xml:"CreateJobResult>JobId"`
	JobType               aws.StringValue `query:"JobType" xml:"CreateJobResult>JobType"`
	Signature             aws.StringValue `query:"Signature" xml:"CreateJobResult>Signature"`
	SignatureFileContents aws.StringValue `query:"SignatureFileContents" xml:"CreateJobResult>SignatureFileContents"`
	WarningMessage        aws.StringValue `query:"WarningMessage" xml:"CreateJobResult>WarningMessage"`
}

CreateJobOutput is undocumented.

type CreateJobResult

type CreateJobResult struct {
	AWSShippingAddress    aws.StringValue `query:"AwsShippingAddress" xml:"CreateJobResult>AwsShippingAddress"`
	JobID                 aws.StringValue `query:"JobId" xml:"CreateJobResult>JobId"`
	JobType               aws.StringValue `query:"JobType" xml:"CreateJobResult>JobType"`
	Signature             aws.StringValue `query:"Signature" xml:"CreateJobResult>Signature"`
	SignatureFileContents aws.StringValue `query:"SignatureFileContents" xml:"CreateJobResult>SignatureFileContents"`
	WarningMessage        aws.StringValue `query:"WarningMessage" xml:"CreateJobResult>WarningMessage"`
}

CreateJobResult is a wrapper for CreateJobOutput.

type GetStatusInput

type GetStatusInput struct {
	JobID aws.StringValue `query:"JobId" xml:"JobId"`
}

GetStatusInput is undocumented.

type GetStatusOutput

type GetStatusOutput struct {
	AWSShippingAddress    aws.StringValue  `query:"AwsShippingAddress" xml:"GetStatusResult>AwsShippingAddress"`
	Carrier               aws.StringValue  `query:"Carrier" xml:"GetStatusResult>Carrier"`
	CreationDate          time.Time        `query:"CreationDate" xml:"GetStatusResult>CreationDate"`
	CurrentManifest       aws.StringValue  `query:"CurrentManifest" xml:"GetStatusResult>CurrentManifest"`
	ErrorCount            aws.IntegerValue `query:"ErrorCount" xml:"GetStatusResult>ErrorCount"`
	JobID                 aws.StringValue  `query:"JobId" xml:"GetStatusResult>JobId"`
	JobType               aws.StringValue  `query:"JobType" xml:"GetStatusResult>JobType"`
	LocationCode          aws.StringValue  `query:"LocationCode" xml:"GetStatusResult>LocationCode"`
	LocationMessage       aws.StringValue  `query:"LocationMessage" xml:"GetStatusResult>LocationMessage"`
	LogBucket             aws.StringValue  `query:"LogBucket" xml:"GetStatusResult>LogBucket"`
	LogKey                aws.StringValue  `query:"LogKey" xml:"GetStatusResult>LogKey"`
	ProgressCode          aws.StringValue  `query:"ProgressCode" xml:"GetStatusResult>ProgressCode"`
	ProgressMessage       aws.StringValue  `query:"ProgressMessage" xml:"GetStatusResult>ProgressMessage"`
	Signature             aws.StringValue  `query:"Signature" xml:"GetStatusResult>Signature"`
	SignatureFileContents aws.StringValue  `query:"SignatureFileContents" xml:"GetStatusResult>SignatureFileContents"`
	TrackingNumber        aws.StringValue  `query:"TrackingNumber" xml:"GetStatusResult>TrackingNumber"`
}

GetStatusOutput is undocumented.

type GetStatusResult

type GetStatusResult struct {
	AWSShippingAddress    aws.StringValue  `query:"AwsShippingAddress" xml:"GetStatusResult>AwsShippingAddress"`
	Carrier               aws.StringValue  `query:"Carrier" xml:"GetStatusResult>Carrier"`
	CreationDate          time.Time        `query:"CreationDate" xml:"GetStatusResult>CreationDate"`
	CurrentManifest       aws.StringValue  `query:"CurrentManifest" xml:"GetStatusResult>CurrentManifest"`
	ErrorCount            aws.IntegerValue `query:"ErrorCount" xml:"GetStatusResult>ErrorCount"`
	JobID                 aws.StringValue  `query:"JobId" xml:"GetStatusResult>JobId"`
	JobType               aws.StringValue  `query:"JobType" xml:"GetStatusResult>JobType"`
	LocationCode          aws.StringValue  `query:"LocationCode" xml:"GetStatusResult>LocationCode"`
	LocationMessage       aws.StringValue  `query:"LocationMessage" xml:"GetStatusResult>LocationMessage"`
	LogBucket             aws.StringValue  `query:"LogBucket" xml:"GetStatusResult>LogBucket"`
	LogKey                aws.StringValue  `query:"LogKey" xml:"GetStatusResult>LogKey"`
	ProgressCode          aws.StringValue  `query:"ProgressCode" xml:"GetStatusResult>ProgressCode"`
	ProgressMessage       aws.StringValue  `query:"ProgressMessage" xml:"GetStatusResult>ProgressMessage"`
	Signature             aws.StringValue  `query:"Signature" xml:"GetStatusResult>Signature"`
	SignatureFileContents aws.StringValue  `query:"SignatureFileContents" xml:"GetStatusResult>SignatureFileContents"`
	TrackingNumber        aws.StringValue  `query:"TrackingNumber" xml:"GetStatusResult>TrackingNumber"`
}

GetStatusResult is a wrapper for GetStatusOutput.

type ImportExport

type ImportExport struct {
	// contains filtered or unexported fields
}

ImportExport is a client for AWS Import/Export.

func New

func New(creds aws.CredentialsProvider, region string, client *http.Client) *ImportExport

New returns a new ImportExport client.

func (*ImportExport) CancelJob

func (c *ImportExport) CancelJob(req *CancelJobInput) (resp *CancelJobResult, err error)

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

func (*ImportExport) CreateJob

func (c *ImportExport) CreateJob(req *CreateJobInput) (resp *CreateJobResult, err error)

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

func (*ImportExport) GetStatus

func (c *ImportExport) GetStatus(req *GetStatusInput) (resp *GetStatusResult, err error)

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

func (*ImportExport) ListJobs

func (c *ImportExport) ListJobs(req *ListJobsInput) (resp *ListJobsResult, err error)

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

func (*ImportExport) UpdateJob

func (c *ImportExport) UpdateJob(req *UpdateJobInput) (resp *UpdateJobResult, err error)

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

type Job

type Job struct {
	CreationDate time.Time        `query:"CreationDate" xml:"CreationDate"`
	IsCanceled   aws.BooleanValue `query:"IsCanceled" xml:"IsCanceled"`
	JobID        aws.StringValue  `query:"JobId" xml:"JobId"`
	JobType      aws.StringValue  `query:"JobType" xml:"JobType"`
}

Job is undocumented.

type ListJobsInput

type ListJobsInput struct {
	Marker  aws.StringValue  `query:"Marker" xml:"Marker"`
	MaxJobs aws.IntegerValue `query:"MaxJobs" xml:"MaxJobs"`
}

ListJobsInput is undocumented.

type ListJobsOutput

type ListJobsOutput struct {
	IsTruncated aws.BooleanValue `query:"IsTruncated" xml:"ListJobsResult>IsTruncated"`
	Jobs        []Job            `query:"Jobs.member" xml:"ListJobsResult>Jobs>member"`
}

ListJobsOutput is undocumented.

type ListJobsResult

type ListJobsResult struct {
	IsTruncated aws.BooleanValue `query:"IsTruncated" xml:"ListJobsResult>IsTruncated"`
	Jobs        []Job            `query:"Jobs.member" xml:"ListJobsResult>Jobs>member"`
}

ListJobsResult is a wrapper for ListJobsOutput.

type UpdateJobInput

type UpdateJobInput struct {
	JobID        aws.StringValue  `query:"JobId" xml:"JobId"`
	JobType      aws.StringValue  `query:"JobType" xml:"JobType"`
	Manifest     aws.StringValue  `query:"Manifest" xml:"Manifest"`
	ValidateOnly aws.BooleanValue `query:"ValidateOnly" xml:"ValidateOnly"`
}

UpdateJobInput is undocumented.

type UpdateJobOutput

type UpdateJobOutput struct {
	Success        aws.BooleanValue `query:"Success" xml:"UpdateJobResult>Success"`
	WarningMessage aws.StringValue  `query:"WarningMessage" xml:"UpdateJobResult>WarningMessage"`
}

UpdateJobOutput is undocumented.

type UpdateJobResult

type UpdateJobResult struct {
	Success        aws.BooleanValue `query:"Success" xml:"UpdateJobResult>Success"`
	WarningMessage aws.StringValue  `query:"WarningMessage" xml:"UpdateJobResult>WarningMessage"`
}

UpdateJobResult is a wrapper for UpdateJobOutput.