Network.AWS.IoT.CreateJob

Creates a job.

Creating a Request

createJob

Arguments

:: Text

cjJobId

-> NonEmpty Text

cjTargets

-> CreateJob

Creates a value of CreateJob with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• cjJobExecutionsRolloutConfig - Allows you to create a staged rollout of the job.
• cjDocumentSource - An S3 link to the job document.
• cjDocumentParameters - Parameters for the job document.
• cjPresignedURLConfig - Configuration information for pre-signed S3 URLs.
• cjDocument - The job document.
• cjDescription - A short text description of the job.
• cjTargetSelection - Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a thing when the thing is added to a target group, even after the job was completed by all things originally in the group.
• cjJobId - A job identifier which must be unique for your AWS account. We recommend using a UUID. Alpha-numeric characters, "-" and "_" are valid for use here.
• cjTargets - A list of things and thing groups to which the job should be sent.

data CreateJob

See: createJob smart constructor.

Instances

Eq CreateJob

Methods

(==) :: CreateJob -> CreateJob -> Bool

(/=) :: CreateJob -> CreateJob -> Bool

Data CreateJob

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateJob -> c CreateJob

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateJob

toConstr :: CreateJob -> Constr

dataTypeOf :: CreateJob -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CreateJob)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateJob)

gmapT :: (forall b. Data b => b -> b) -> CreateJob -> CreateJob

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateJob -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateJob -> r

gmapQ :: (forall d. Data d => d -> u) -> CreateJob -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateJob -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateJob -> m CreateJob

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateJob -> m CreateJob

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateJob -> m CreateJob

Read CreateJob

Methods

readsPrec :: Int -> ReadS CreateJob

readList :: ReadS [CreateJob]

readPrec :: ReadPrec CreateJob

readListPrec :: ReadPrec [CreateJob]

Show CreateJob

Methods

showsPrec :: Int -> CreateJob -> ShowS

show :: CreateJob -> String

showList :: [CreateJob] -> ShowS

Generic CreateJob

Associated Types

type Rep CreateJob :: * -> *

Methods

from :: CreateJob -> Rep CreateJob x

to :: Rep CreateJob x -> CreateJob

Hashable CreateJob

Methods

hashWithSalt :: Int -> CreateJob -> Int

hash :: CreateJob -> Int

ToJSON CreateJob

Methods

toJSON :: CreateJob -> Value

toEncoding :: CreateJob -> Encoding

toJSONList :: [CreateJob] -> Value

toEncodingList :: [CreateJob] -> Encoding

NFData CreateJob

Methods

rnf :: CreateJob -> ()

AWSRequest CreateJob

Associated Types

type Rs CreateJob :: *

Methods

request :: CreateJob -> Request CreateJob

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * CreateJob -> ClientResponse -> m (Response CreateJob)

ToHeaders CreateJob

Methods

toHeaders :: CreateJob -> [Header]

ToPath CreateJob

Methods

toPath :: CreateJob -> ByteString

ToQuery CreateJob

Methods

toQuery :: CreateJob -> QueryString

type Rep CreateJob

type Rep CreateJob = D1 * (MetaData "CreateJob" "Network.AWS.IoT.CreateJob" "amazonka-iot-1.6.0-GZYdsKS1TEjHFZo6BqaYJk" False) (C1 * (MetaCons "CreateJob'" PrefixI True) ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_cjJobExecutionsRolloutConfig") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe JobExecutionsRolloutConfig))) (S1 * (MetaSel (Just Symbol "_cjDocumentSource") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_cjDocumentParameters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe (Map Text Text)))) (S1 * (MetaSel (Just Symbol "_cjPresignedURLConfig") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe PresignedURLConfig))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_cjDocument") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_cjDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_cjTargetSelection") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe TargetSelection))) ((:*:) * (S1 * (MetaSel (Just Symbol "_cjJobId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_cjTargets") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (List1 Text))))))))

type Rs CreateJob

type Rs CreateJob = CreateJobResponse

Request Lenses

cjJobExecutionsRolloutConfig :: Lens' CreateJob (Maybe JobExecutionsRolloutConfig)

Allows you to create a staged rollout of the job.

cjDocumentSource :: Lens' CreateJob (Maybe Text)

An S3 link to the job document.

cjDocumentParameters :: Lens' CreateJob (HashMap Text Text)

Parameters for the job document.

cjPresignedURLConfig :: Lens' CreateJob (Maybe PresignedURLConfig)

Configuration information for pre-signed S3 URLs.

cjDocument :: Lens' CreateJob (Maybe Text)

The job document.

cjDescription :: Lens' CreateJob (Maybe Text)

A short text description of the job.

cjTargetSelection :: Lens' CreateJob (Maybe TargetSelection)

Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a thing when the thing is added to a target group, even after the job was completed by all things originally in the group.

cjJobId :: Lens' CreateJob Text

A job identifier which must be unique for your AWS account. We recommend using a UUID. Alpha-numeric characters, "-" and "_" are valid for use here.

cjTargets :: Lens' CreateJob (NonEmpty Text)

A list of things and thing groups to which the job should be sent.

Destructuring the Response

createJobResponse

Arguments

:: Int

cjrsResponseStatus

-> CreateJobResponse

Creates a value of CreateJobResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• cjrsJobId - The unique identifier you assigned to this job.
• cjrsJobARN - The job ARN.
• cjrsDescription - The job description.
• cjrsResponseStatus - -- | The response status code.

data CreateJobResponse

See: createJobResponse smart constructor.

Instances

Eq CreateJobResponse

Methods

(==) :: CreateJobResponse -> CreateJobResponse -> Bool

(/=) :: CreateJobResponse -> CreateJobResponse -> Bool

Data CreateJobResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateJobResponse -> c CreateJobResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateJobResponse

toConstr :: CreateJobResponse -> Constr

dataTypeOf :: CreateJobResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CreateJobResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateJobResponse)

gmapT :: (forall b. Data b => b -> b) -> CreateJobResponse -> CreateJobResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateJobResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateJobResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> CreateJobResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateJobResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateJobResponse -> m CreateJobResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateJobResponse -> m CreateJobResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateJobResponse -> m CreateJobResponse

Read CreateJobResponse

Methods

readsPrec :: Int -> ReadS CreateJobResponse

readList :: ReadS [CreateJobResponse]

readPrec :: ReadPrec CreateJobResponse

readListPrec :: ReadPrec [CreateJobResponse]

Show CreateJobResponse

Methods

showsPrec :: Int -> CreateJobResponse -> ShowS

show :: CreateJobResponse -> String

showList :: [CreateJobResponse] -> ShowS

Generic CreateJobResponse

Associated Types

type Rep CreateJobResponse :: * -> *

Methods

from :: CreateJobResponse -> Rep CreateJobResponse x

to :: Rep CreateJobResponse x -> CreateJobResponse

NFData CreateJobResponse

Methods

rnf :: CreateJobResponse -> ()

type Rep CreateJobResponse

type Rep CreateJobResponse = D1 * (MetaData "CreateJobResponse" "Network.AWS.IoT.CreateJob" "amazonka-iot-1.6.0-GZYdsKS1TEjHFZo6BqaYJk" False) (C1 * (MetaCons "CreateJobResponse'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_cjrsJobId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_cjrsJobARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_cjrsDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_cjrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))

Response Lenses

cjrsJobId :: Lens' CreateJobResponse (Maybe Text)

The unique identifier you assigned to this job.

cjrsJobARN :: Lens' CreateJobResponse (Maybe Text)

The job ARN.

cjrsDescription :: Lens' CreateJobResponse (Maybe Text)

The job description.

cjrsResponseStatus :: Lens' CreateJobResponse Int

• - | The response status code.