Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
- Service Configuration
- Errors
- BucketPermissionException
- CanceledJobIdException
- CreateJobQuotaExceededException
- ExpiredJobIdException
- InvalidAccessKeyIdException
- InvalidAddressException
- InvalidCustomsException
- InvalidFileSystemException
- InvalidJobIdException
- InvalidManifestFieldException
- InvalidParameterException
- InvalidVersionException
- MalformedManifestException
- MissingCustomsException
- MissingManifestFieldException
- MissingParameterException
- MultipleRegionsException
- NoSuchBucketException
- UnableToCancelJobIdException
- UnableToUpdateJobIdException
- Waiters
- Operations
- Types
Derived from API version 2010-06-01
of the AWS service descriptions, licensed under Apache 2.0.
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.
Synopsis
- defaultService :: Service
- _BucketPermissionException :: AsError a => Fold a ServiceError
- _CanceledJobIdException :: AsError a => Fold a ServiceError
- _CreateJobQuotaExceededException :: AsError a => Fold a ServiceError
- _ExpiredJobIdException :: AsError a => Fold a ServiceError
- _InvalidAccessKeyIdException :: AsError a => Fold a ServiceError
- _InvalidAddressException :: AsError a => Fold a ServiceError
- _InvalidCustomsException :: AsError a => Fold a ServiceError
- _InvalidFileSystemException :: AsError a => Fold a ServiceError
- _InvalidJobIdException :: AsError a => Fold a ServiceError
- _InvalidManifestFieldException :: AsError a => Fold a ServiceError
- _InvalidParameterException :: AsError a => Fold a ServiceError
- _InvalidVersionException :: AsError a => Fold a ServiceError
- _MalformedManifestException :: AsError a => Fold a ServiceError
- _MissingCustomsException :: AsError a => Fold a ServiceError
- _MissingManifestFieldException :: AsError a => Fold a ServiceError
- _MissingParameterException :: AsError a => Fold a ServiceError
- _MultipleRegionsException :: AsError a => Fold a ServiceError
- _NoSuchBucketException :: AsError a => Fold a ServiceError
- _UnableToCancelJobIdException :: AsError a => Fold a ServiceError
- _UnableToUpdateJobIdException :: AsError a => Fold a ServiceError
- data CancelJob = CancelJob' (Maybe Text) Text
- newCancelJob :: Text -> CancelJob
- data CancelJobResponse = CancelJobResponse' (Maybe Bool) Int
- newCancelJobResponse :: Int -> CancelJobResponse
- data CreateJob = CreateJob' (Maybe Text) (Maybe Text) JobType Text Bool
- newCreateJob :: JobType -> Text -> Bool -> CreateJob
- data CreateJobResponse = CreateJobResponse' (Maybe [Artifact]) (Maybe Text) (Maybe JobType) (Maybe Text) (Maybe Text) (Maybe Text) Int
- newCreateJobResponse :: Int -> CreateJobResponse
- data GetShippingLabel = GetShippingLabel' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) [Text]
- newGetShippingLabel :: GetShippingLabel
- data GetShippingLabelResponse = GetShippingLabelResponse' (Maybe Text) (Maybe Text) Int
- newGetShippingLabelResponse :: Int -> GetShippingLabelResponse
- data GetStatus = GetStatus' (Maybe Text) Text
- newGetStatus :: Text -> GetStatus
- data GetStatusResponse = GetStatusResponse' (Maybe [Artifact]) (Maybe Text) (Maybe ISO8601) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe JobType) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Int
- newGetStatusResponse :: Int -> GetStatusResponse
- data ListJobs = ListJobs' (Maybe Text) (Maybe Text) (Maybe Int)
- newListJobs :: ListJobs
- data ListJobsResponse = ListJobsResponse' (Maybe Bool) (Maybe [Job]) Int
- newListJobsResponse :: Int -> ListJobsResponse
- data UpdateJob = UpdateJob' (Maybe Text) Text Text JobType Bool
- newUpdateJob :: Text -> Text -> JobType -> Bool -> UpdateJob
- data UpdateJobResponse = UpdateJobResponse' (Maybe [Artifact]) (Maybe Bool) (Maybe Text) Int
- newUpdateJobResponse :: Int -> UpdateJobResponse
- newtype JobType where
- JobType' {
- fromJobType :: Text
- pattern JobType_Export :: JobType
- pattern JobType_Import :: JobType
- JobType' {
- data Artifact = Artifact' (Maybe Text) (Maybe Text)
- newArtifact :: Artifact
- data Job = Job' JobType Text Bool ISO8601
- newJob :: JobType -> Text -> Bool -> UTCTime -> Job
Service Configuration
defaultService :: Service Source #
API version 2010-06-01
of the Amazon Import/Export SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by ImportExport
.
BucketPermissionException
_BucketPermissionException :: AsError a => Fold a ServiceError Source #
The account specified does not have the appropriate bucket permissions.
CanceledJobIdException
_CanceledJobIdException :: AsError a => Fold a ServiceError Source #
The specified job ID has been canceled and is no longer valid.
CreateJobQuotaExceededException
_CreateJobQuotaExceededException :: AsError a => Fold a ServiceError Source #
Each account can create only a certain number of jobs per day. If you need to create more than this, please contact awsimportexport@amazon.com to explain your particular use case.
ExpiredJobIdException
_ExpiredJobIdException :: AsError a => Fold a ServiceError Source #
Indicates that the specified job has expired out of the system.
InvalidAccessKeyIdException
_InvalidAccessKeyIdException :: AsError a => Fold a ServiceError Source #
The AWS Access Key ID specified in the request did not match the manifest's accessKeyId value. The manifest and the request authentication must use the same AWS Access Key ID.
InvalidAddressException
_InvalidAddressException :: AsError a => Fold a ServiceError Source #
The address specified in the manifest is invalid.
InvalidCustomsException
_InvalidCustomsException :: AsError a => Fold a ServiceError Source #
One or more customs parameters was invalid. Please correct and resubmit.
InvalidFileSystemException
_InvalidFileSystemException :: AsError a => Fold a ServiceError Source #
File system specified in export manifest is invalid.
InvalidJobIdException
_InvalidJobIdException :: AsError a => Fold a ServiceError Source #
The JOBID was missing, not found, or not associated with the AWS account.
InvalidManifestFieldException
_InvalidManifestFieldException :: AsError a => Fold a ServiceError Source #
One or more manifest fields was invalid. Please correct and resubmit.
InvalidParameterException
_InvalidParameterException :: AsError a => Fold a ServiceError Source #
One or more parameters had an invalid value.
InvalidVersionException
_InvalidVersionException :: AsError a => Fold a ServiceError Source #
The client tool version is invalid.
MalformedManifestException
_MalformedManifestException :: AsError a => Fold a ServiceError Source #
Your manifest is not well-formed.
MissingCustomsException
_MissingCustomsException :: AsError a => Fold a ServiceError Source #
One or more required customs parameters was missing from the manifest.
MissingManifestFieldException
_MissingManifestFieldException :: AsError a => Fold a ServiceError Source #
One or more required fields were missing from the manifest file. Please correct and resubmit.
MissingParameterException
_MissingParameterException :: AsError a => Fold a ServiceError Source #
One or more required parameters was missing from the request.
MultipleRegionsException
_MultipleRegionsException :: AsError a => Fold a ServiceError Source #
Your manifest file contained buckets from multiple regions. A job is restricted to buckets from one region. Please correct and resubmit.
NoSuchBucketException
_NoSuchBucketException :: AsError a => Fold a ServiceError Source #
The specified bucket does not exist. Create the specified bucket or change the manifest's bucket, exportBucket, or logBucket field to a bucket that the account, as specified by the manifest's Access Key ID, has write permissions to.
UnableToCancelJobIdException
_UnableToCancelJobIdException :: AsError a => Fold a ServiceError Source #
AWS Import/Export cannot cancel the job
UnableToUpdateJobIdException
_UnableToUpdateJobIdException :: AsError a => Fold a ServiceError Source #
AWS Import/Export cannot update the job
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait
specification is fulfilled. The Wait
specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects
operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager
instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
CancelJob
Input structure for the CancelJob operation.
See: newCancelJob
smart constructor.
Instances
Create a value of CancelJob
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:aPIVersion:CancelJob'
, cancelJob_aPIVersion
- Undocumented member.
CancelJob
, cancelJob_jobId
- Undocumented member.
data CancelJobResponse Source #
Output structure for the CancelJob operation.
See: newCancelJobResponse
smart constructor.
Instances
Create a value of CancelJobResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:success:CancelJobResponse'
, cancelJobResponse_success
- Undocumented member.
$sel:httpStatus:CancelJobResponse'
, cancelJobResponse_httpStatus
- The response's http status code.
CreateJob
Input structure for the CreateJob operation.
See: newCreateJob
smart constructor.
Instances
Create a value of CreateJob
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:aPIVersion:CreateJob'
, createJob_aPIVersion
- Undocumented member.
$sel:manifestAddendum:CreateJob'
, createJob_manifestAddendum
- Undocumented member.
CreateJob
, createJob_jobType
- Undocumented member.
$sel:manifest:CreateJob'
, createJob_manifest
- Undocumented member.
$sel:validateOnly:CreateJob'
, createJob_validateOnly
- Undocumented member.
data CreateJobResponse Source #
Output structure for the CreateJob operation.
See: newCreateJobResponse
smart constructor.
CreateJobResponse' (Maybe [Artifact]) (Maybe Text) (Maybe JobType) (Maybe Text) (Maybe Text) (Maybe Text) Int |
Instances
Create a value of CreateJobResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:artifactList:CreateJobResponse'
, createJobResponse_artifactList
- Undocumented member.
CreateJobResponse
, createJobResponse_jobId
- Undocumented member.
CreateJob
, createJobResponse_jobType
- Undocumented member.
$sel:signature:CreateJobResponse'
, createJobResponse_signature
- Undocumented member.
$sel:signatureFileContents:CreateJobResponse'
, createJobResponse_signatureFileContents
- Undocumented member.
$sel:warningMessage:CreateJobResponse'
, createJobResponse_warningMessage
- Undocumented member.
$sel:httpStatus:CreateJobResponse'
, createJobResponse_httpStatus
- The response's http status code.
GetShippingLabel
data GetShippingLabel Source #
See: newGetShippingLabel
smart constructor.
GetShippingLabel' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) [Text] |
Instances
newGetShippingLabel :: GetShippingLabel Source #
Create a value of GetShippingLabel
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:aPIVersion:GetShippingLabel'
, getShippingLabel_aPIVersion
- Undocumented member.
$sel:city:GetShippingLabel'
, getShippingLabel_city
- Undocumented member.
$sel:company:GetShippingLabel'
, getShippingLabel_company
- Undocumented member.
$sel:country:GetShippingLabel'
, getShippingLabel_country
- Undocumented member.
$sel:name:GetShippingLabel'
, getShippingLabel_name
- Undocumented member.
$sel:phoneNumber:GetShippingLabel'
, getShippingLabel_phoneNumber
- Undocumented member.
$sel:postalCode:GetShippingLabel'
, getShippingLabel_postalCode
- Undocumented member.
$sel:stateOrProvince:GetShippingLabel'
, getShippingLabel_stateOrProvince
- Undocumented member.
$sel:street1:GetShippingLabel'
, getShippingLabel_street1
- Undocumented member.
$sel:street2:GetShippingLabel'
, getShippingLabel_street2
- Undocumented member.
$sel:street3:GetShippingLabel'
, getShippingLabel_street3
- Undocumented member.
$sel:jobIds:GetShippingLabel'
, getShippingLabel_jobIds
- Undocumented member.
data GetShippingLabelResponse Source #
See: newGetShippingLabelResponse
smart constructor.
Instances
newGetShippingLabelResponse Source #
Create a value of GetShippingLabelResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:shippingLabelURL:GetShippingLabelResponse'
, getShippingLabelResponse_shippingLabelURL
- Undocumented member.
$sel:warning:GetShippingLabelResponse'
, getShippingLabelResponse_warning
- Undocumented member.
$sel:httpStatus:GetShippingLabelResponse'
, getShippingLabelResponse_httpStatus
- The response's http status code.
GetStatus
Input structure for the GetStatus operation.
See: newGetStatus
smart constructor.
Instances
Create a value of GetStatus
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:aPIVersion:GetStatus'
, getStatus_aPIVersion
- Undocumented member.
GetStatus
, getStatus_jobId
- Undocumented member.
data GetStatusResponse Source #
Output structure for the GetStatus operation.
See: newGetStatusResponse
smart constructor.
GetStatusResponse' (Maybe [Artifact]) (Maybe Text) (Maybe ISO8601) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe JobType) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Int |
Instances
Create a value of GetStatusResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:artifactList:GetStatusResponse'
, getStatusResponse_artifactList
- Undocumented member.
$sel:carrier:GetStatusResponse'
, getStatusResponse_carrier
- Undocumented member.
GetStatusResponse
, getStatusResponse_creationDate
- Undocumented member.
$sel:currentManifest:GetStatusResponse'
, getStatusResponse_currentManifest
- Undocumented member.
$sel:errorCount:GetStatusResponse'
, getStatusResponse_errorCount
- Undocumented member.
GetStatus
, getStatusResponse_jobId
- Undocumented member.
GetStatusResponse
, getStatusResponse_jobType
- Undocumented member.
$sel:locationCode:GetStatusResponse'
, getStatusResponse_locationCode
- Undocumented member.
$sel:locationMessage:GetStatusResponse'
, getStatusResponse_locationMessage
- Undocumented member.
$sel:logBucket:GetStatusResponse'
, getStatusResponse_logBucket
- Undocumented member.
$sel:logKey:GetStatusResponse'
, getStatusResponse_logKey
- Undocumented member.
$sel:progressCode:GetStatusResponse'
, getStatusResponse_progressCode
- Undocumented member.
$sel:progressMessage:GetStatusResponse'
, getStatusResponse_progressMessage
- Undocumented member.
$sel:signature:GetStatusResponse'
, getStatusResponse_signature
- Undocumented member.
$sel:signatureFileContents:GetStatusResponse'
, getStatusResponse_signatureFileContents
- Undocumented member.
$sel:trackingNumber:GetStatusResponse'
, getStatusResponse_trackingNumber
- Undocumented member.
$sel:httpStatus:GetStatusResponse'
, getStatusResponse_httpStatus
- The response's http status code.
ListJobs (Paginated)
Input structure for the ListJobs operation.
See: newListJobs
smart constructor.
Instances
newListJobs :: ListJobs Source #
Create a value of ListJobs
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:aPIVersion:ListJobs'
, listJobs_aPIVersion
- Undocumented member.
$sel:marker:ListJobs'
, listJobs_marker
- Undocumented member.
$sel:maxJobs:ListJobs'
, listJobs_maxJobs
- Undocumented member.
data ListJobsResponse Source #
Output structure for the ListJobs operation.
See: newListJobsResponse
smart constructor.
Instances
Create a value of ListJobsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:isTruncated:ListJobsResponse'
, listJobsResponse_isTruncated
- Undocumented member.
$sel:jobs:ListJobsResponse'
, listJobsResponse_jobs
- Undocumented member.
$sel:httpStatus:ListJobsResponse'
, listJobsResponse_httpStatus
- The response's http status code.
UpdateJob
Input structure for the UpateJob operation.
See: newUpdateJob
smart constructor.
Instances
Create a value of UpdateJob
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:aPIVersion:UpdateJob'
, updateJob_aPIVersion
- Undocumented member.
UpdateJob
, updateJob_jobId
- Undocumented member.
$sel:manifest:UpdateJob'
, updateJob_manifest
- Undocumented member.
UpdateJob
, updateJob_jobType
- Undocumented member.
$sel:validateOnly:UpdateJob'
, updateJob_validateOnly
- Undocumented member.
data UpdateJobResponse Source #
Output structure for the UpateJob operation.
See: newUpdateJobResponse
smart constructor.
Instances
Create a value of UpdateJobResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:artifactList:UpdateJobResponse'
, updateJobResponse_artifactList
- Undocumented member.
$sel:success:UpdateJobResponse'
, updateJobResponse_success
- Undocumented member.
$sel:warningMessage:UpdateJobResponse'
, updateJobResponse_warningMessage
- Undocumented member.
$sel:httpStatus:UpdateJobResponse'
, updateJobResponse_httpStatus
- The response's http status code.
Types
JobType
Specifies whether the job to initiate is an import or export job.
pattern JobType_Export :: JobType | |
pattern JobType_Import :: JobType |
Instances
Artifact
A discrete item that contains the description and URL of an artifact (such as a PDF).
See: newArtifact
smart constructor.
Instances
FromXML Artifact Source # | |
Generic Artifact Source # | |
Read Artifact Source # | |
Show Artifact Source # | |
NFData Artifact Source # | |
Defined in Amazonka.ImportExport.Types.Artifact | |
Eq Artifact Source # | |
Hashable Artifact Source # | |
Defined in Amazonka.ImportExport.Types.Artifact | |
type Rep Artifact Source # | |
Defined in Amazonka.ImportExport.Types.Artifact type Rep Artifact = D1 ('MetaData "Artifact" "Amazonka.ImportExport.Types.Artifact" "amazonka-importexport-2.0-Jy65964a2E2FHiikVjI7dI" 'False) (C1 ('MetaCons "Artifact'" 'PrefixI 'True) (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "url") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) |
newArtifact :: Artifact Source #
Create a value of Artifact
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:description:Artifact'
, artifact_description
- Undocumented member.
$sel:url:Artifact'
, artifact_url
- Undocumented member.
Job
Representation of a job returned by the ListJobs operation.
See: newJob
smart constructor.
Instances
FromXML Job Source # | |
Generic Job Source # | |
Read Job Source # | |
Show Job Source # | |
NFData Job Source # | |
Defined in Amazonka.ImportExport.Types.Job | |
Eq Job Source # | |
Hashable Job Source # | |
Defined in Amazonka.ImportExport.Types.Job | |
type Rep Job Source # | |
Defined in Amazonka.ImportExport.Types.Job type Rep Job = D1 ('MetaData "Job" "Amazonka.ImportExport.Types.Job" "amazonka-importexport-2.0-Jy65964a2E2FHiikVjI7dI" 'False) (C1 ('MetaCons "Job'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "jobType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 JobType) :*: S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "isCanceled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :*: S1 ('MetaSel ('Just "creationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ISO8601)))) |
Create a value of Job
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:jobType:Job'
, job_jobType
- Undocumented member.
$sel:jobId:Job'
, job_jobId
- Undocumented member.
$sel:isCanceled:Job'
, job_isCanceled
- Undocumented member.
$sel:creationDate:Job'
, job_creationDate
- Undocumented member.