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

Amazonka.ImportExport.GetStatus

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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.

Synopsis

data GetStatus = GetStatus' {
- aPIVersion :: Maybe Text
- jobId :: Text
}
newGetStatus :: Text -> GetStatus
getStatus_aPIVersion :: Lens' GetStatus (Maybe Text)
getStatus_jobId :: Lens' GetStatus Text
data GetStatusResponse = GetStatusResponse' {
- artifactList :: Maybe [Artifact]
- carrier :: Maybe Text
- creationDate :: Maybe ISO8601
- currentManifest :: Maybe Text
- errorCount :: Maybe Int
- jobId :: Maybe Text
- jobType :: Maybe JobType
- locationCode :: Maybe Text
- locationMessage :: Maybe Text
- logBucket :: Maybe Text
- logKey :: Maybe Text
- progressCode :: Maybe Text
- progressMessage :: Maybe Text
- signature :: Maybe Text
- signatureFileContents :: Maybe Text
- trackingNumber :: Maybe Text
- httpStatus :: Int
}
newGetStatusResponse :: Int -> GetStatusResponse
getStatusResponse_artifactList :: Lens' GetStatusResponse (Maybe [Artifact])
getStatusResponse_carrier :: Lens' GetStatusResponse (Maybe Text)
getStatusResponse_creationDate :: Lens' GetStatusResponse (Maybe UTCTime)
getStatusResponse_currentManifest :: Lens' GetStatusResponse (Maybe Text)
getStatusResponse_errorCount :: Lens' GetStatusResponse (Maybe Int)
getStatusResponse_jobId :: Lens' GetStatusResponse (Maybe Text)
getStatusResponse_jobType :: Lens' GetStatusResponse (Maybe JobType)
getStatusResponse_locationCode :: Lens' GetStatusResponse (Maybe Text)
getStatusResponse_locationMessage :: Lens' GetStatusResponse (Maybe Text)
getStatusResponse_logBucket :: Lens' GetStatusResponse (Maybe Text)
getStatusResponse_logKey :: Lens' GetStatusResponse (Maybe Text)
getStatusResponse_progressCode :: Lens' GetStatusResponse (Maybe Text)
getStatusResponse_progressMessage :: Lens' GetStatusResponse (Maybe Text)
getStatusResponse_signature :: Lens' GetStatusResponse (Maybe Text)
getStatusResponse_signatureFileContents :: Lens' GetStatusResponse (Maybe Text)
getStatusResponse_trackingNumber :: Lens' GetStatusResponse (Maybe Text)
getStatusResponse_httpStatus :: Lens' GetStatusResponse Int

Creating a Request

data GetStatus Source #

Input structure for the GetStatus operation.

See: newGetStatus smart constructor.

Constructors

GetStatus'
Fields aPIVersion :: Maybe Text jobId :: Text

Instances

Instances details

ToHeaders GetStatus Source #
Instance details Defined in Amazonka.ImportExport.GetStatus Methods toHeaders :: GetStatus -> [Header] #
ToPath GetStatus Source #
Instance details Defined in Amazonka.ImportExport.GetStatus Methods toPath :: GetStatus -> ByteString #
ToQuery GetStatus Source #
Instance details Defined in Amazonka.ImportExport.GetStatus Methods toQuery :: GetStatus -> QueryString #
AWSRequest GetStatus Source #
Instance details Defined in Amazonka.ImportExport.GetStatus Associated Types type AWSResponse GetStatus # Methods request :: (Service -> Service) -> GetStatus -> Request GetStatus # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetStatus -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetStatus))) #
Generic GetStatus Source #
Instance details Defined in Amazonka.ImportExport.GetStatus Associated Types type Rep GetStatus :: Type -> Type # Methods from :: GetStatus -> Rep GetStatus x # to :: Rep GetStatus x -> GetStatus #
Read GetStatus Source #
Instance details Defined in Amazonka.ImportExport.GetStatus Methods readsPrec :: Int -> ReadS GetStatus # readList :: ReadS [GetStatus] # readPrec :: ReadPrec GetStatus # readListPrec :: ReadPrec [GetStatus] #
Show GetStatus Source #
Instance details Defined in Amazonka.ImportExport.GetStatus Methods showsPrec :: Int -> GetStatus -> ShowS # show :: GetStatus -> String # showList :: [GetStatus] -> ShowS #
NFData GetStatus Source #
Instance details Defined in Amazonka.ImportExport.GetStatus Methods rnf :: GetStatus -> () #
Eq GetStatus Source #
Instance details Defined in Amazonka.ImportExport.GetStatus Methods (==) :: GetStatus -> GetStatus -> Bool # (/=) :: GetStatus -> GetStatus -> Bool #
Hashable GetStatus Source #
Instance details Defined in Amazonka.ImportExport.GetStatus Methods hashWithSalt :: Int -> GetStatus -> Int # hash :: GetStatus -> Int #
type AWSResponse GetStatus Source #
Instance details Defined in Amazonka.ImportExport.GetStatus type AWSResponse GetStatus = GetStatusResponse
type Rep GetStatus Source #
Instance details Defined in Amazonka.ImportExport.GetStatus type Rep GetStatus = D1 ('MetaData "GetStatus" "Amazonka.ImportExport.GetStatus" "amazonka-importexport-2.0-Jy65964a2E2FHiikVjI7dI" 'False) (C1 ('MetaCons "GetStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "aPIVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newGetStatus Source #

Arguments

:: Text	`GetStatus`
-> GetStatus

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.

Request Lenses

getStatus_aPIVersion :: Lens' GetStatus (Maybe Text) Source #

Undocumented member.

getStatus_jobId :: Lens' GetStatus Text Source #

Undocumented member.

Destructuring the Response

data GetStatusResponse Source #

Output structure for the GetStatus operation.

See: newGetStatusResponse smart constructor.

Constructors

GetStatusResponse'

Fields

artifactList :: Maybe [Artifact]
carrier :: Maybe Text
creationDate :: Maybe ISO8601
currentManifest :: Maybe Text
errorCount :: Maybe Int
jobId :: Maybe Text
jobType :: Maybe JobType
locationCode :: Maybe Text
locationMessage :: Maybe Text
logBucket :: Maybe Text
logKey :: Maybe Text
progressCode :: Maybe Text
progressMessage :: Maybe Text
signature :: Maybe Text
signatureFileContents :: Maybe Text
trackingNumber :: Maybe Text
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic GetStatusResponse Source #
Instance details Defined in Amazonka.ImportExport.GetStatus Associated Types type Rep GetStatusResponse :: Type -> Type # Methods from :: GetStatusResponse -> Rep GetStatusResponse x # to :: Rep GetStatusResponse x -> GetStatusResponse #
Read GetStatusResponse Source #
Instance details Defined in Amazonka.ImportExport.GetStatus Methods readsPrec :: Int -> ReadS GetStatusResponse # readList :: ReadS [GetStatusResponse] # readPrec :: ReadPrec GetStatusResponse # readListPrec :: ReadPrec [GetStatusResponse] #
Show GetStatusResponse Source #
Instance details Defined in Amazonka.ImportExport.GetStatus Methods showsPrec :: Int -> GetStatusResponse -> ShowS # show :: GetStatusResponse -> String # showList :: [GetStatusResponse] -> ShowS #
NFData GetStatusResponse Source #
Instance details Defined in Amazonka.ImportExport.GetStatus Methods rnf :: GetStatusResponse -> () #
Eq GetStatusResponse Source #
Instance details Defined in Amazonka.ImportExport.GetStatus Methods (==) :: GetStatusResponse -> GetStatusResponse -> Bool # (/=) :: GetStatusResponse -> GetStatusResponse -> Bool #
type Rep GetStatusResponse Source #
Instance details Defined in Amazonka.ImportExport.GetStatus type Rep GetStatusResponse = D1 ('MetaData "GetStatusResponse" "Amazonka.ImportExport.GetStatus" "amazonka-importexport-2.0-Jy65964a2E2FHiikVjI7dI" 'False) (C1 ('MetaCons "GetStatusResponse'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "artifactList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Artifact])) :: S1 ('MetaSel ('Just "carrier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "creationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :: S1 ('MetaSel ('Just "currentManifest") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "errorCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "jobType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobType)) :: S1 ('MetaSel ('Just "locationCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: (((S1 ('MetaSel ('Just "locationMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "logBucket") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "logKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "progressCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "progressMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "signature") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "signatureFileContents") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "trackingNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))))