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.HoneyCode.DescribeTableDataImportJob

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

The DescribeTableDataImportJob API allows you to retrieve the status and details of a table data import job.

Synopsis

Creating a Request

data DescribeTableDataImportJob Source #

See: newDescribeTableDataImportJob smart constructor.

Constructors

DescribeTableDataImportJob'

Fields

workbookId :: Text
The ID of the workbook into which data was imported.
If a workbook with the specified id could not be found, this API throws ResourceNotFoundException.
tableId :: Text
The ID of the table into which data was imported.
If a table with the specified id could not be found, this API throws ResourceNotFoundException.
jobId :: Text
The ID of the job that was returned by the StartTableDataImportJob request.
If a job with the specified id could not be found, this API throws ResourceNotFoundException.

Instances

Instances details

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

newDescribeTableDataImportJob Source #

Arguments

:: Text	`$sel:workbookId:DescribeTableDataImportJob'`
-> Text	`DescribeTableDataImportJob`
-> Text	`$sel:jobId:DescribeTableDataImportJob'`
-> DescribeTableDataImportJob

Create a value of DescribeTableDataImportJob 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:workbookId:DescribeTableDataImportJob', describeTableDataImportJob_workbookId - The ID of the workbook into which data was imported.

If a workbook with the specified id could not be found, this API throws ResourceNotFoundException.

DescribeTableDataImportJob, describeTableDataImportJob_tableId - The ID of the table into which data was imported.

If a table with the specified id could not be found, this API throws ResourceNotFoundException.

$sel:jobId:DescribeTableDataImportJob', describeTableDataImportJob_jobId - The ID of the job that was returned by the StartTableDataImportJob request.

If a job with the specified id could not be found, this API throws ResourceNotFoundException.

Request Lenses

describeTableDataImportJob_workbookId :: Lens' DescribeTableDataImportJob Text Source #

The ID of the workbook into which data was imported.

If a workbook with the specified id could not be found, this API throws ResourceNotFoundException.

describeTableDataImportJob_tableId :: Lens' DescribeTableDataImportJob Text Source #

The ID of the table into which data was imported.

If a table with the specified id could not be found, this API throws ResourceNotFoundException.

describeTableDataImportJob_jobId :: Lens' DescribeTableDataImportJob Text Source #

The ID of the job that was returned by the StartTableDataImportJob request.

If a job with the specified id could not be found, this API throws ResourceNotFoundException.

Destructuring the Response

data DescribeTableDataImportJobResponse Source #

See: newDescribeTableDataImportJobResponse smart constructor.

Constructors

DescribeTableDataImportJobResponse'

Fields

errorCode :: Maybe ErrorCode
If job status is failed, error code to understand reason for the failure.
httpStatus :: Int
The response's http status code.
jobStatus :: TableDataImportJobStatus
The current status of the import job.
message :: Text
A message providing more details about the current status of the import job.
jobMetadata :: TableDataImportJobMetadata
The metadata about the job that was submitted for import.

Instances

Instances details

Generic DescribeTableDataImportJobResponse Source #
Instance details Defined in Amazonka.HoneyCode.DescribeTableDataImportJob Associated Types type Rep DescribeTableDataImportJobResponse :: Type -> Type # Methods from :: DescribeTableDataImportJobResponse -> Rep DescribeTableDataImportJobResponse x # to :: Rep DescribeTableDataImportJobResponse x -> DescribeTableDataImportJobResponse #
Show DescribeTableDataImportJobResponse Source #
Instance details Defined in Amazonka.HoneyCode.DescribeTableDataImportJob Methods showsPrec :: Int -> DescribeTableDataImportJobResponse -> ShowS # show :: DescribeTableDataImportJobResponse -> String # showList :: [DescribeTableDataImportJobResponse] -> ShowS #
NFData DescribeTableDataImportJobResponse Source #
Instance details Defined in Amazonka.HoneyCode.DescribeTableDataImportJob Methods rnf :: DescribeTableDataImportJobResponse -> () #
Eq DescribeTableDataImportJobResponse Source #
Instance details Defined in Amazonka.HoneyCode.DescribeTableDataImportJob Methods (==) :: DescribeTableDataImportJobResponse -> DescribeTableDataImportJobResponse -> Bool # (/=) :: DescribeTableDataImportJobResponse -> DescribeTableDataImportJobResponse -> Bool #
type Rep DescribeTableDataImportJobResponse Source #
Instance details Defined in Amazonka.HoneyCode.DescribeTableDataImportJob type Rep DescribeTableDataImportJobResponse = D1 ('MetaData "DescribeTableDataImportJobResponse" "Amazonka.HoneyCode.DescribeTableDataImportJob" "amazonka-honeycode-2.0-IdtoOmZm6eT6kjUDWwPe6X" 'False) (C1 ('MetaCons "DescribeTableDataImportJobResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "errorCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ErrorCode)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)) :: (S1 ('MetaSel ('Just "jobStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 TableDataImportJobStatus) :: (S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "jobMetadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 TableDataImportJobMetadata)))))

newDescribeTableDataImportJobResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeTableDataImportJobResponse'`
-> TableDataImportJobStatus	`$sel:jobStatus:DescribeTableDataImportJobResponse'`
-> Text	`$sel:message:DescribeTableDataImportJobResponse'`
-> TableDataImportJobMetadata	`$sel:jobMetadata:DescribeTableDataImportJobResponse'`
-> DescribeTableDataImportJobResponse

Create a value of DescribeTableDataImportJobResponse 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:errorCode:DescribeTableDataImportJobResponse', describeTableDataImportJobResponse_errorCode - If job status is failed, error code to understand reason for the failure.

$sel:httpStatus:DescribeTableDataImportJobResponse', describeTableDataImportJobResponse_httpStatus - The response's http status code.

$sel:jobStatus:DescribeTableDataImportJobResponse', describeTableDataImportJobResponse_jobStatus - The current status of the import job.

$sel:message:DescribeTableDataImportJobResponse', describeTableDataImportJobResponse_message - A message providing more details about the current status of the import job.

$sel:jobMetadata:DescribeTableDataImportJobResponse', describeTableDataImportJobResponse_jobMetadata - The metadata about the job that was submitted for import.

Response Lenses

describeTableDataImportJobResponse_errorCode :: Lens' DescribeTableDataImportJobResponse (Maybe ErrorCode) Source #

If job status is failed, error code to understand reason for the failure.

describeTableDataImportJobResponse_httpStatus :: Lens' DescribeTableDataImportJobResponse Int Source #

The response's http status code.

describeTableDataImportJobResponse_jobStatus :: Lens' DescribeTableDataImportJobResponse TableDataImportJobStatus Source #

The current status of the import job.

describeTableDataImportJobResponse_message :: Lens' DescribeTableDataImportJobResponse Text Source #

A message providing more details about the current status of the import job.

describeTableDataImportJobResponse_jobMetadata :: Lens' DescribeTableDataImportJobResponse TableDataImportJobMetadata Source #

The metadata about the job that was submitted for import.