Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.ImportExport.Types

Contents

Service Configuration
Errors
JobType
Artifact
Job

Description

Synopsis

defaultService :: Service
_InvalidJobIdException :: AsError a => Getting (First ServiceError) a ServiceError
_InvalidParameterException :: AsError a => Getting (First ServiceError) a ServiceError
_ExpiredJobIdException :: AsError a => Getting (First ServiceError) a ServiceError
_InvalidFileSystemException :: AsError a => Getting (First ServiceError) a ServiceError
_InvalidAccessKeyIdException :: AsError a => Getting (First ServiceError) a ServiceError
_UnableToUpdateJobIdException :: AsError a => Getting (First ServiceError) a ServiceError
_UnableToCancelJobIdException :: AsError a => Getting (First ServiceError) a ServiceError
_MultipleRegionsException :: AsError a => Getting (First ServiceError) a ServiceError
_InvalidVersionException :: AsError a => Getting (First ServiceError) a ServiceError
_MalformedManifestException :: AsError a => Getting (First ServiceError) a ServiceError
_MissingParameterException :: AsError a => Getting (First ServiceError) a ServiceError
_CanceledJobIdException :: AsError a => Getting (First ServiceError) a ServiceError
_BucketPermissionException :: AsError a => Getting (First ServiceError) a ServiceError
_NoSuchBucketException :: AsError a => Getting (First ServiceError) a ServiceError
_InvalidAddressException :: AsError a => Getting (First ServiceError) a ServiceError
_MissingCustomsException :: AsError a => Getting (First ServiceError) a ServiceError
_InvalidManifestFieldException :: AsError a => Getting (First ServiceError) a ServiceError
_InvalidCustomsException :: AsError a => Getting (First ServiceError) a ServiceError
_MissingManifestFieldException :: AsError a => Getting (First ServiceError) a ServiceError
_CreateJobQuotaExceededException :: AsError a => Getting (First ServiceError) a ServiceError
newtype JobType where
- JobType' {
  - fromJobType :: Text
  }
- pattern JobType_Export :: JobType
- pattern JobType_Import :: JobType
data Artifact = Artifact' {
- url :: Maybe Text
- description :: Maybe Text
}
newArtifact :: Artifact
artifact_url :: Lens' Artifact (Maybe Text)
artifact_description :: Lens' Artifact (Maybe Text)
data Job = Job' {
- jobType :: JobType
- jobId :: Text
- isCanceled :: Bool
- creationDate :: ISO8601
}
newJob :: JobType -> Text -> Bool -> UTCTime -> Job
job_jobType :: Lens' Job JobType
job_jobId :: Lens' Job Text
job_isCanceled :: Lens' Job Bool
job_creationDate :: Lens' Job UTCTime

Service Configuration

defaultService :: Service Source #

API version 2010-06-01 of the Amazon Import/Export SDK configuration.

Errors

_InvalidJobIdException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The JOBID was missing, not found, or not associated with the AWS account.

_InvalidParameterException :: AsError a => Getting (First ServiceError) a ServiceError Source #

One or more parameters had an invalid value.

_ExpiredJobIdException :: AsError a => Getting (First ServiceError) a ServiceError Source #

Indicates that the specified job has expired out of the system.

_InvalidFileSystemException :: AsError a => Getting (First ServiceError) a ServiceError Source #

File system specified in export manifest is invalid.

_InvalidAccessKeyIdException :: AsError a => Getting (First ServiceError) 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.

_UnableToUpdateJobIdException :: AsError a => Getting (First ServiceError) a ServiceError Source #

AWS Import/Export cannot update the job

_UnableToCancelJobIdException :: AsError a => Getting (First ServiceError) a ServiceError Source #

AWS Import/Export cannot cancel the job

_MultipleRegionsException :: AsError a => Getting (First ServiceError) a ServiceError Source #

Your manifest file contained buckets from multiple regions. A job is restricted to buckets from one region. Please correct and resubmit.

_InvalidVersionException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The client tool version is invalid.

_MalformedManifestException :: AsError a => Getting (First ServiceError) a ServiceError Source #

Your manifest is not well-formed.

_MissingParameterException :: AsError a => Getting (First ServiceError) a ServiceError Source #

One or more required parameters was missing from the request.

_CanceledJobIdException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The specified job ID has been canceled and is no longer valid.

_BucketPermissionException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The account specified does not have the appropriate bucket permissions.

_NoSuchBucketException :: AsError a => Getting (First ServiceError) 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.

_InvalidAddressException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The address specified in the manifest is invalid.

_MissingCustomsException :: AsError a => Getting (First ServiceError) a ServiceError Source #

One or more required customs parameters was missing from the manifest.

_InvalidManifestFieldException :: AsError a => Getting (First ServiceError) a ServiceError Source #

One or more manifest fields was invalid. Please correct and resubmit.

_InvalidCustomsException :: AsError a => Getting (First ServiceError) a ServiceError Source #

One or more customs parameters was invalid. Please correct and resubmit.

_MissingManifestFieldException :: AsError a => Getting (First ServiceError) a ServiceError Source #

One or more required fields were missing from the manifest file. Please correct and resubmit.

_CreateJobQuotaExceededException :: AsError a => Getting (First ServiceError) 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.

JobType

newtype JobType Source #

Specifies whether the job to initiate is an import or export job.

Constructors

JobType'
Fields fromJobType :: Text

Bundled Patterns

pattern JobType_Export :: JobType
pattern JobType_Import :: JobType

Instances

Instances details

Eq JobType Source #
Instance details Defined in Amazonka.ImportExport.Types.JobType Methods (==) :: JobType -> JobType -> Bool # (/=) :: JobType -> JobType -> Bool #
Ord JobType Source #
Instance details Defined in Amazonka.ImportExport.Types.JobType Methods compare :: JobType -> JobType -> Ordering # (<) :: JobType -> JobType -> Bool # (<=) :: JobType -> JobType -> Bool # (>) :: JobType -> JobType -> Bool # (>=) :: JobType -> JobType -> Bool # max :: JobType -> JobType -> JobType # min :: JobType -> JobType -> JobType #
Read JobType Source #
Instance details Defined in Amazonka.ImportExport.Types.JobType Methods readsPrec :: Int -> ReadS JobType # readList :: ReadS [JobType] # readPrec :: ReadPrec JobType # readListPrec :: ReadPrec [JobType] #
Show JobType Source #
Instance details Defined in Amazonka.ImportExport.Types.JobType Methods showsPrec :: Int -> JobType -> ShowS # show :: JobType -> String # showList :: [JobType] -> ShowS #
Generic JobType Source #
Instance details Defined in Amazonka.ImportExport.Types.JobType Associated Types type Rep JobType :: Type -> Type # Methods from :: JobType -> Rep JobType x # to :: Rep JobType x -> JobType #
NFData JobType Source #
Instance details Defined in Amazonka.ImportExport.Types.JobType Methods rnf :: JobType -> () #
Hashable JobType Source #
Instance details Defined in Amazonka.ImportExport.Types.JobType Methods hashWithSalt :: Int -> JobType -> Int # hash :: JobType -> Int #
ToJSON JobType Source #
Instance details Defined in Amazonka.ImportExport.Types.JobType Methods toJSON :: JobType -> Value # toEncoding :: JobType -> Encoding # toJSONList :: [JobType] -> Value # toEncodingList :: [JobType] -> Encoding #
ToJSONKey JobType Source #
Instance details Defined in Amazonka.ImportExport.Types.JobType Methods toJSONKey :: ToJSONKeyFunction JobType # toJSONKeyList :: ToJSONKeyFunction [JobType] #
FromJSON JobType Source #
Instance details Defined in Amazonka.ImportExport.Types.JobType Methods parseJSON :: Value -> Parser JobType # parseJSONList :: Value -> Parser [JobType] #
FromJSONKey JobType Source #
Instance details Defined in Amazonka.ImportExport.Types.JobType Methods fromJSONKey :: FromJSONKeyFunction JobType # fromJSONKeyList :: FromJSONKeyFunction [JobType] #
ToLog JobType Source #
Instance details Defined in Amazonka.ImportExport.Types.JobType Methods build :: JobType -> ByteStringBuilder #
ToHeader JobType Source #
Instance details Defined in Amazonka.ImportExport.Types.JobType Methods toHeader :: HeaderName -> JobType -> [Header] #
ToQuery JobType Source #
Instance details Defined in Amazonka.ImportExport.Types.JobType Methods toQuery :: JobType -> QueryString #
FromXML JobType Source #
Instance details Defined in Amazonka.ImportExport.Types.JobType Methods parseXML :: [Node] -> Either String JobType #
ToXML JobType Source #
Instance details Defined in Amazonka.ImportExport.Types.JobType Methods toXML :: JobType -> XML #
ToByteString JobType Source #
Instance details Defined in Amazonka.ImportExport.Types.JobType Methods toBS :: JobType -> ByteString #
FromText JobType Source #
Instance details Defined in Amazonka.ImportExport.Types.JobType Methods fromText :: Text -> Either String JobType #
ToText JobType Source #
Instance details Defined in Amazonka.ImportExport.Types.JobType Methods toText :: JobType -> Text #
type Rep JobType Source #
Instance details Defined in Amazonka.ImportExport.Types.JobType type Rep JobType = D1 ('MetaData "JobType" "Amazonka.ImportExport.Types.JobType" "libZSservicesZSamazonka-importexportZSamazonka-importexport" 'True) (C1 ('MetaCons "JobType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromJobType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

Artifact

data Artifact Source #

A discrete item that contains the description and URL of an artifact (such as a PDF).

See: newArtifact smart constructor.

Constructors

Artifact'
Fields url :: Maybe Text description :: Maybe Text

Instances

Instances details

Eq Artifact Source #
Instance details Defined in Amazonka.ImportExport.Types.Artifact Methods (==) :: Artifact -> Artifact -> Bool # (/=) :: Artifact -> Artifact -> Bool #
Read Artifact Source #
Instance details Defined in Amazonka.ImportExport.Types.Artifact Methods readsPrec :: Int -> ReadS Artifact # readList :: ReadS [Artifact] # readPrec :: ReadPrec Artifact # readListPrec :: ReadPrec [Artifact] #
Show Artifact Source #
Instance details Defined in Amazonka.ImportExport.Types.Artifact Methods showsPrec :: Int -> Artifact -> ShowS # show :: Artifact -> String # showList :: [Artifact] -> ShowS #
Generic Artifact Source #
Instance details Defined in Amazonka.ImportExport.Types.Artifact Associated Types type Rep Artifact :: Type -> Type # Methods from :: Artifact -> Rep Artifact x # to :: Rep Artifact x -> Artifact #
NFData Artifact Source #
Instance details Defined in Amazonka.ImportExport.Types.Artifact Methods rnf :: Artifact -> () #
Hashable Artifact Source #
Instance details Defined in Amazonka.ImportExport.Types.Artifact Methods hashWithSalt :: Int -> Artifact -> Int # hash :: Artifact -> Int #
FromXML Artifact Source #
Instance details Defined in Amazonka.ImportExport.Types.Artifact Methods parseXML :: [Node] -> Either String Artifact #
type Rep Artifact Source #
Instance details Defined in Amazonka.ImportExport.Types.Artifact type Rep Artifact = D1 ('MetaData "Artifact" "Amazonka.ImportExport.Types.Artifact" "libZSservicesZSamazonka-importexportZSamazonka-importexport" 'False) (C1 ('MetaCons "Artifact'" 'PrefixI 'True) (S1 ('MetaSel ('Just "url") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "description") '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:url:Artifact', artifact_url - Undocumented member.

$sel:description:Artifact', artifact_description - Undocumented member.

artifact_url :: Lens' Artifact (Maybe Text) Source #

Undocumented member.

artifact_description :: Lens' Artifact (Maybe Text) Source #

Undocumented member.

Job

data Job Source #

Representation of a job returned by the ListJobs operation.

See: newJob smart constructor.

Constructors

Job'
Fields jobType :: JobType jobId :: Text isCanceled :: Bool creationDate :: ISO8601

Instances

Instances details

Eq Job Source #
Instance details Defined in Amazonka.ImportExport.Types.Job Methods (==) :: Job -> Job -> Bool # (/=) :: Job -> Job -> Bool #
Read Job Source #
Instance details Defined in Amazonka.ImportExport.Types.Job Methods readsPrec :: Int -> ReadS Job # readList :: ReadS [Job] # readPrec :: ReadPrec Job # readListPrec :: ReadPrec [Job] #
Show Job Source #
Instance details Defined in Amazonka.ImportExport.Types.Job Methods showsPrec :: Int -> Job -> ShowS # show :: Job -> String # showList :: [Job] -> ShowS #
Generic Job Source #
Instance details Defined in Amazonka.ImportExport.Types.Job Associated Types type Rep Job :: Type -> Type # Methods from :: Job -> Rep Job x # to :: Rep Job x -> Job #
NFData Job Source #
Instance details Defined in Amazonka.ImportExport.Types.Job Methods rnf :: Job -> () #
Hashable Job Source #
Instance details Defined in Amazonka.ImportExport.Types.Job Methods hashWithSalt :: Int -> Job -> Int # hash :: Job -> Int #
FromXML Job Source #
Instance details Defined in Amazonka.ImportExport.Types.Job Methods parseXML :: [Node] -> Either String Job #
type Rep Job Source #
Instance details Defined in Amazonka.ImportExport.Types.Job type Rep Job = D1 ('MetaData "Job" "Amazonka.ImportExport.Types.Job" "libZSservicesZSamazonka-importexportZSamazonka-importexport" '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))))