libZSservicesZSamazonka-lookoutequipmentZSamazonka-lookoutequipment
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.LookoutEquipment.StartDataIngestionJob

Description

Starts a data ingestion job. Amazon Lookout for Equipment returns the job status.

Synopsis

Creating a Request

data StartDataIngestionJob Source #

See: newStartDataIngestionJob smart constructor.

Constructors

StartDataIngestionJob' 

Fields

  • datasetName :: Text

    The name of the dataset being used by the data ingestion job.

  • ingestionInputConfiguration :: IngestionInputConfiguration

    Specifies information for the input data for the data ingestion job, including dataset S3 location.

  • roleArn :: Text

    The Amazon Resource Name (ARN) of a role with permission to access the data source for the data ingestion job.

  • clientToken :: Text

    A unique identifier for the request. If you do not set the client request token, Amazon Lookout for Equipment generates one.

Instances

Instances details
Eq StartDataIngestionJob Source # 
Instance details

Defined in Amazonka.LookoutEquipment.StartDataIngestionJob

Methods

(==) :: StartDataIngestionJob -> StartDataIngestionJob -> Bool #

(/=) :: StartDataIngestionJob -> StartDataIngestionJob -> Bool #

Read StartDataIngestionJob Source # 
Instance details

Defined in Amazonka.LookoutEquipment.StartDataIngestionJob

Methods

readsPrec :: Int -> ReadS StartDataIngestionJob #

readList :: ReadS [StartDataIngestionJob] #

readPrec :: ReadPrec StartDataIngestionJob #

readListPrec :: ReadPrec [StartDataIngestionJob] #

Show StartDataIngestionJob Source # 
Instance details

Defined in Amazonka.LookoutEquipment.StartDataIngestionJob

Methods

showsPrec :: Int -> StartDataIngestionJob -> ShowS #

show :: StartDataIngestionJob -> String #

showList :: [StartDataIngestionJob] -> ShowS #

Generic StartDataIngestionJob Source # 
Instance details

Defined in Amazonka.LookoutEquipment.StartDataIngestionJob

Associated Types

type Rep StartDataIngestionJob :: Type -> Type #

Methods

from :: StartDataIngestionJob -> Rep StartDataIngestionJob x #

to :: Rep StartDataIngestionJob x -> StartDataIngestionJob #

NFData StartDataIngestionJob Source # 
Instance details

Defined in Amazonka.LookoutEquipment.StartDataIngestionJob

Methods

rnf :: StartDataIngestionJob -> () #

Hashable StartDataIngestionJob Source # 
Instance details

Defined in Amazonka.LookoutEquipment.StartDataIngestionJob

Methods

hashWithSalt :: Int -> StartDataIngestionJob -> Int #

hash :: StartDataIngestionJob -> Int #

ToJSON StartDataIngestionJob Source # 
Instance details

Defined in Amazonka.LookoutEquipment.StartDataIngestionJob

Methods

toJSON :: StartDataIngestionJob -> Value #

toEncoding :: StartDataIngestionJob -> Encoding #

toJSONList :: [StartDataIngestionJob] -> Value #

toEncodingList :: [StartDataIngestionJob] -> Encoding #

AWSRequest StartDataIngestionJob Source # 
Instance details

Defined in Amazonka.LookoutEquipment.StartDataIngestionJob

Associated Types

type AWSResponse StartDataIngestionJob #

Methods

request :: StartDataIngestionJob -> Request StartDataIngestionJob #

response :: MonadResource m => Logger -> Service -> Proxy StartDataIngestionJob -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StartDataIngestionJob))) #

ToHeaders StartDataIngestionJob Source # 
Instance details

Defined in Amazonka.LookoutEquipment.StartDataIngestionJob

Methods

toHeaders :: StartDataIngestionJob -> [Header] #

ToPath StartDataIngestionJob Source # 
Instance details

Defined in Amazonka.LookoutEquipment.StartDataIngestionJob

Methods

toPath :: StartDataIngestionJob -> ByteString #

ToQuery StartDataIngestionJob Source # 
Instance details

Defined in Amazonka.LookoutEquipment.StartDataIngestionJob

Methods

toQuery :: StartDataIngestionJob -> QueryString #

type Rep StartDataIngestionJob Source # 
Instance details

Defined in Amazonka.LookoutEquipment.StartDataIngestionJob

type Rep StartDataIngestionJob = D1 ('MetaData "StartDataIngestionJob" "Amazonka.LookoutEquipment.StartDataIngestionJob" "libZSservicesZSamazonka-lookoutequipmentZSamazonka-lookoutequipment" 'False) (C1 ('MetaCons "StartDataIngestionJob'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "datasetName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "ingestionInputConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 IngestionInputConfiguration)) :*: (S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse StartDataIngestionJob Source # 
Instance details

Defined in Amazonka.LookoutEquipment.StartDataIngestionJob

type AWSResponse StartDataIngestionJob = StartDataIngestionJobResponse

newStartDataIngestionJob Source #

Arguments

:: Text

$sel:datasetName:StartDataIngestionJob'

-> IngestionInputConfiguration

$sel:ingestionInputConfiguration:StartDataIngestionJob'

-> Text

$sel:roleArn:StartDataIngestionJob'

-> Text

$sel:clientToken:StartDataIngestionJob'

-> StartDataIngestionJob 

Create a value of StartDataIngestionJob 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:datasetName:StartDataIngestionJob', startDataIngestionJob_datasetName - The name of the dataset being used by the data ingestion job.

$sel:ingestionInputConfiguration:StartDataIngestionJob', startDataIngestionJob_ingestionInputConfiguration - Specifies information for the input data for the data ingestion job, including dataset S3 location.

$sel:roleArn:StartDataIngestionJob', startDataIngestionJob_roleArn - The Amazon Resource Name (ARN) of a role with permission to access the data source for the data ingestion job.

$sel:clientToken:StartDataIngestionJob', startDataIngestionJob_clientToken - A unique identifier for the request. If you do not set the client request token, Amazon Lookout for Equipment generates one.

Request Lenses

startDataIngestionJob_datasetName :: Lens' StartDataIngestionJob Text Source #

The name of the dataset being used by the data ingestion job.

startDataIngestionJob_ingestionInputConfiguration :: Lens' StartDataIngestionJob IngestionInputConfiguration Source #

Specifies information for the input data for the data ingestion job, including dataset S3 location.

startDataIngestionJob_roleArn :: Lens' StartDataIngestionJob Text Source #

The Amazon Resource Name (ARN) of a role with permission to access the data source for the data ingestion job.

startDataIngestionJob_clientToken :: Lens' StartDataIngestionJob Text Source #

A unique identifier for the request. If you do not set the client request token, Amazon Lookout for Equipment generates one.

Destructuring the Response

data StartDataIngestionJobResponse Source #

See: newStartDataIngestionJobResponse smart constructor.

Constructors

StartDataIngestionJobResponse' 

Fields

Instances

Instances details
Eq StartDataIngestionJobResponse Source # 
Instance details

Defined in Amazonka.LookoutEquipment.StartDataIngestionJob

Methods

(==) :: StartDataIngestionJobResponse -> StartDataIngestionJobResponse -> Bool #

(/=) :: StartDataIngestionJobResponse -> StartDataIngestionJobResponse -> Bool #

Read StartDataIngestionJobResponse Source # 
Instance details

Defined in Amazonka.LookoutEquipment.StartDataIngestionJob

Methods

readsPrec :: Int -> ReadS StartDataIngestionJobResponse #

readList :: ReadS [StartDataIngestionJobResponse] #

readPrec :: ReadPrec StartDataIngestionJobResponse #

readListPrec :: ReadPrec [StartDataIngestionJobResponse] #

Show StartDataIngestionJobResponse Source # 
Instance details

Defined in Amazonka.LookoutEquipment.StartDataIngestionJob

Methods

showsPrec :: Int -> StartDataIngestionJobResponse -> ShowS #

show :: StartDataIngestionJobResponse -> String #

showList :: [StartDataIngestionJobResponse] -> ShowS #

Generic StartDataIngestionJobResponse Source # 
Instance details

Defined in Amazonka.LookoutEquipment.StartDataIngestionJob

Associated Types

type Rep StartDataIngestionJobResponse :: Type -> Type #

Methods

from :: StartDataIngestionJobResponse -> Rep StartDataIngestionJobResponse x #

to :: Rep StartDataIngestionJobResponse x -> StartDataIngestionJobResponse #

NFData StartDataIngestionJobResponse Source # 
Instance details

Defined in Amazonka.LookoutEquipment.StartDataIngestionJob

Methods

rnf :: StartDataIngestionJobResponse -> () #

type Rep StartDataIngestionJobResponse Source # 
Instance details

Defined in Amazonka.LookoutEquipment.StartDataIngestionJob

type Rep StartDataIngestionJobResponse = D1 ('MetaData "StartDataIngestionJobResponse" "Amazonka.LookoutEquipment.StartDataIngestionJob" "libZSservicesZSamazonka-lookoutequipmentZSamazonka-lookoutequipment" 'False) (C1 ('MetaCons "StartDataIngestionJobResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IngestionJobStatus)) :*: (S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newStartDataIngestionJobResponse Source #

Arguments

:: Int

$sel:httpStatus:StartDataIngestionJobResponse'

-> StartDataIngestionJobResponse 

Create a value of StartDataIngestionJobResponse 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:status:StartDataIngestionJobResponse', startDataIngestionJobResponse_status - Indicates the status of the StartDataIngestionJob operation.

$sel:jobId:StartDataIngestionJobResponse', startDataIngestionJobResponse_jobId - Indicates the job ID of the data ingestion job.

$sel:httpStatus:StartDataIngestionJobResponse', startDataIngestionJobResponse_httpStatus - The response's http status code.

Response Lenses

startDataIngestionJobResponse_status :: Lens' StartDataIngestionJobResponse (Maybe IngestionJobStatus) Source #

Indicates the status of the StartDataIngestionJob operation.

startDataIngestionJobResponse_jobId :: Lens' StartDataIngestionJobResponse (Maybe Text) Source #

Indicates the job ID of the data ingestion job.

startDataIngestionJobResponse_httpStatus :: Lens' StartDataIngestionJobResponse Int Source #

The response's http status code.