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.IoT.CreateJobTemplate

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a job template.

Requires permission to access the CreateJobTemplate action.

Synopsis

data CreateJobTemplate = CreateJobTemplate' {
- abortConfig :: Maybe AbortConfig
- document :: Maybe Text
- documentSource :: Maybe Text
- jobArn :: Maybe Text
- jobExecutionsRetryConfig :: Maybe JobExecutionsRetryConfig
- jobExecutionsRolloutConfig :: Maybe JobExecutionsRolloutConfig
- presignedUrlConfig :: Maybe PresignedUrlConfig
- tags :: Maybe [Tag]
- timeoutConfig :: Maybe TimeoutConfig
- jobTemplateId :: Text
- description :: Text
}
newCreateJobTemplate :: Text -> Text -> CreateJobTemplate
createJobTemplate_abortConfig :: Lens' CreateJobTemplate (Maybe AbortConfig)
createJobTemplate_document :: Lens' CreateJobTemplate (Maybe Text)
createJobTemplate_documentSource :: Lens' CreateJobTemplate (Maybe Text)
createJobTemplate_jobArn :: Lens' CreateJobTemplate (Maybe Text)
createJobTemplate_jobExecutionsRetryConfig :: Lens' CreateJobTemplate (Maybe JobExecutionsRetryConfig)
createJobTemplate_jobExecutionsRolloutConfig :: Lens' CreateJobTemplate (Maybe JobExecutionsRolloutConfig)
createJobTemplate_presignedUrlConfig :: Lens' CreateJobTemplate (Maybe PresignedUrlConfig)
createJobTemplate_tags :: Lens' CreateJobTemplate (Maybe [Tag])
createJobTemplate_timeoutConfig :: Lens' CreateJobTemplate (Maybe TimeoutConfig)
createJobTemplate_jobTemplateId :: Lens' CreateJobTemplate Text
createJobTemplate_description :: Lens' CreateJobTemplate Text
data CreateJobTemplateResponse = CreateJobTemplateResponse' {
- jobTemplateArn :: Maybe Text
- jobTemplateId :: Maybe Text
- httpStatus :: Int
}
newCreateJobTemplateResponse :: Int -> CreateJobTemplateResponse
createJobTemplateResponse_jobTemplateArn :: Lens' CreateJobTemplateResponse (Maybe Text)
createJobTemplateResponse_jobTemplateId :: Lens' CreateJobTemplateResponse (Maybe Text)
createJobTemplateResponse_httpStatus :: Lens' CreateJobTemplateResponse Int

Creating a Request

data CreateJobTemplate Source #

See: newCreateJobTemplate smart constructor.

Constructors

CreateJobTemplate'

Fields

abortConfig :: Maybe AbortConfig
document :: Maybe Text
The job document. Required if you don't specify a value for documentSource.
documentSource :: Maybe Text
An S3 link to the job document to use in the template. Required if you don't specify a value for document.
If the job document resides in an S3 bucket, you must use a placeholder link when specifying the document.
The placeholder link is of the following form:
${aws:iot:s3-presigned-url:https://s3.amazonaws.com/bucket/key}
where bucket is your bucket name and key is the object in the bucket to which you are linking.
jobArn :: Maybe Text
The ARN of the job to use as the basis for the job template.
jobExecutionsRetryConfig :: Maybe JobExecutionsRetryConfig
Allows you to create the criteria to retry a job.
jobExecutionsRolloutConfig :: Maybe JobExecutionsRolloutConfig
presignedUrlConfig :: Maybe PresignedUrlConfig
tags :: Maybe [Tag]
Metadata that can be used to manage the job template.
timeoutConfig :: Maybe TimeoutConfig
jobTemplateId :: Text
A unique identifier for the job template. We recommend using a UUID. Alpha-numeric characters, "-", and "_" are valid for use here.
description :: Text
A description of the job document.

Instances

Instances details

ToJSON CreateJobTemplate Source #
Instance details Defined in Amazonka.IoT.CreateJobTemplate Methods toJSON :: CreateJobTemplate -> Value # toEncoding :: CreateJobTemplate -> Encoding # toJSONList :: [CreateJobTemplate] -> Value # toEncodingList :: [CreateJobTemplate] -> Encoding #
ToHeaders CreateJobTemplate Source #
Instance details Defined in Amazonka.IoT.CreateJobTemplate Methods toHeaders :: CreateJobTemplate -> [Header] #
ToPath CreateJobTemplate Source #
Instance details Defined in Amazonka.IoT.CreateJobTemplate Methods toPath :: CreateJobTemplate -> ByteString #
ToQuery CreateJobTemplate Source #
Instance details Defined in Amazonka.IoT.CreateJobTemplate Methods toQuery :: CreateJobTemplate -> QueryString #
AWSRequest CreateJobTemplate Source #
Instance details Defined in Amazonka.IoT.CreateJobTemplate Associated Types type AWSResponse CreateJobTemplate # Methods request :: (Service -> Service) -> CreateJobTemplate -> Request CreateJobTemplate # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateJobTemplate -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateJobTemplate))) #
Generic CreateJobTemplate Source #
Instance details Defined in Amazonka.IoT.CreateJobTemplate Associated Types type Rep CreateJobTemplate :: Type -> Type # Methods from :: CreateJobTemplate -> Rep CreateJobTemplate x # to :: Rep CreateJobTemplate x -> CreateJobTemplate #
Read CreateJobTemplate Source #
Instance details Defined in Amazonka.IoT.CreateJobTemplate Methods readsPrec :: Int -> ReadS CreateJobTemplate # readList :: ReadS [CreateJobTemplate] # readPrec :: ReadPrec CreateJobTemplate # readListPrec :: ReadPrec [CreateJobTemplate] #
Show CreateJobTemplate Source #
Instance details Defined in Amazonka.IoT.CreateJobTemplate Methods showsPrec :: Int -> CreateJobTemplate -> ShowS # show :: CreateJobTemplate -> String # showList :: [CreateJobTemplate] -> ShowS #
NFData CreateJobTemplate Source #
Instance details Defined in Amazonka.IoT.CreateJobTemplate Methods rnf :: CreateJobTemplate -> () #
Eq CreateJobTemplate Source #
Instance details Defined in Amazonka.IoT.CreateJobTemplate Methods (==) :: CreateJobTemplate -> CreateJobTemplate -> Bool # (/=) :: CreateJobTemplate -> CreateJobTemplate -> Bool #
Hashable CreateJobTemplate Source #
Instance details Defined in Amazonka.IoT.CreateJobTemplate Methods hashWithSalt :: Int -> CreateJobTemplate -> Int # hash :: CreateJobTemplate -> Int #
type AWSResponse CreateJobTemplate Source #
Instance details Defined in Amazonka.IoT.CreateJobTemplate type AWSResponse CreateJobTemplate = CreateJobTemplateResponse
type Rep CreateJobTemplate Source #
Instance details Defined in Amazonka.IoT.CreateJobTemplate type Rep CreateJobTemplate = D1 ('MetaData "CreateJobTemplate" "Amazonka.IoT.CreateJobTemplate" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "CreateJobTemplate'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "abortConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AbortConfig)) :: S1 ('MetaSel ('Just "document") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "documentSource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "jobArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "jobExecutionsRetryConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobExecutionsRetryConfig))))) :: ((S1 ('MetaSel ('Just "jobExecutionsRolloutConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobExecutionsRolloutConfig)) :: (S1 ('MetaSel ('Just "presignedUrlConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PresignedUrlConfig)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])))) :: (S1 ('MetaSel ('Just "timeoutConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TimeoutConfig)) :: (S1 ('MetaSel ('Just "jobTemplateId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newCreateJobTemplate Source #

Arguments

:: Text	`CreateJobTemplate`
-> Text	`CreateJobTemplate`
-> CreateJobTemplate

Create a value of CreateJobTemplate 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:

CreateJobTemplate, createJobTemplate_abortConfig - Undocumented member.

$sel:document:CreateJobTemplate', createJobTemplate_document - The job document. Required if you don't specify a value for documentSource.

$sel:documentSource:CreateJobTemplate', createJobTemplate_documentSource - An S3 link to the job document to use in the template. Required if you don't specify a value for document.

If the job document resides in an S3 bucket, you must use a placeholder link when specifying the document.

The placeholder link is of the following form:

${aws:iot:s3-presigned-url:https://s3.amazonaws.com/bucket/key}

where bucket is your bucket name and key is the object in the bucket to which you are linking.

CreateJobTemplate, createJobTemplate_jobArn - The ARN of the job to use as the basis for the job template.

CreateJobTemplate, createJobTemplate_jobExecutionsRetryConfig - Allows you to create the criteria to retry a job.

CreateJobTemplate, createJobTemplate_jobExecutionsRolloutConfig - Undocumented member.

CreateJobTemplate, createJobTemplate_presignedUrlConfig - Undocumented member.

$sel:tags:CreateJobTemplate', createJobTemplate_tags - Metadata that can be used to manage the job template.

CreateJobTemplate, createJobTemplate_timeoutConfig - Undocumented member.

CreateJobTemplate, createJobTemplate_jobTemplateId - A unique identifier for the job template. We recommend using a UUID. Alpha-numeric characters, "-", and "_" are valid for use here.

CreateJobTemplate, createJobTemplate_description - A description of the job document.

Request Lenses

createJobTemplate_abortConfig :: Lens' CreateJobTemplate (Maybe AbortConfig) Source #

Undocumented member.

createJobTemplate_document :: Lens' CreateJobTemplate (Maybe Text) Source #

The job document. Required if you don't specify a value for documentSource.

createJobTemplate_documentSource :: Lens' CreateJobTemplate (Maybe Text) Source #

An S3 link to the job document to use in the template. Required if you don't specify a value for document.

If the job document resides in an S3 bucket, you must use a placeholder link when specifying the document.

The placeholder link is of the following form:

${aws:iot:s3-presigned-url:https://s3.amazonaws.com/bucket/key}

where bucket is your bucket name and key is the object in the bucket to which you are linking.

createJobTemplate_jobArn :: Lens' CreateJobTemplate (Maybe Text) Source #

The ARN of the job to use as the basis for the job template.

createJobTemplate_jobExecutionsRetryConfig :: Lens' CreateJobTemplate (Maybe JobExecutionsRetryConfig) Source #

Allows you to create the criteria to retry a job.

createJobTemplate_jobExecutionsRolloutConfig :: Lens' CreateJobTemplate (Maybe JobExecutionsRolloutConfig) Source #

Undocumented member.

createJobTemplate_presignedUrlConfig :: Lens' CreateJobTemplate (Maybe PresignedUrlConfig) Source #

Undocumented member.

createJobTemplate_tags :: Lens' CreateJobTemplate (Maybe [Tag]) Source #

Metadata that can be used to manage the job template.

createJobTemplate_timeoutConfig :: Lens' CreateJobTemplate (Maybe TimeoutConfig) Source #

Undocumented member.

createJobTemplate_jobTemplateId :: Lens' CreateJobTemplate Text Source #

A unique identifier for the job template. We recommend using a UUID. Alpha-numeric characters, "-", and "_" are valid for use here.

createJobTemplate_description :: Lens' CreateJobTemplate Text Source #

A description of the job document.

Destructuring the Response

data CreateJobTemplateResponse Source #

See: newCreateJobTemplateResponse smart constructor.

Constructors

CreateJobTemplateResponse'
Fields jobTemplateArn :: Maybe Text The ARN of the job template. jobTemplateId :: Maybe Text The unique identifier of the job template. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateJobTemplateResponse Source #
Instance details Defined in Amazonka.IoT.CreateJobTemplate Associated Types type Rep CreateJobTemplateResponse :: Type -> Type # Methods from :: CreateJobTemplateResponse -> Rep CreateJobTemplateResponse x # to :: Rep CreateJobTemplateResponse x -> CreateJobTemplateResponse #
Read CreateJobTemplateResponse Source #
Instance details Defined in Amazonka.IoT.CreateJobTemplate Methods readsPrec :: Int -> ReadS CreateJobTemplateResponse # readList :: ReadS [CreateJobTemplateResponse] # readPrec :: ReadPrec CreateJobTemplateResponse # readListPrec :: ReadPrec [CreateJobTemplateResponse] #
Show CreateJobTemplateResponse Source #
Instance details Defined in Amazonka.IoT.CreateJobTemplate Methods showsPrec :: Int -> CreateJobTemplateResponse -> ShowS # show :: CreateJobTemplateResponse -> String # showList :: [CreateJobTemplateResponse] -> ShowS #
NFData CreateJobTemplateResponse Source #
Instance details Defined in Amazonka.IoT.CreateJobTemplate Methods rnf :: CreateJobTemplateResponse -> () #
Eq CreateJobTemplateResponse Source #
Instance details Defined in Amazonka.IoT.CreateJobTemplate Methods (==) :: CreateJobTemplateResponse -> CreateJobTemplateResponse -> Bool # (/=) :: CreateJobTemplateResponse -> CreateJobTemplateResponse -> Bool #
type Rep CreateJobTemplateResponse Source #
Instance details Defined in Amazonka.IoT.CreateJobTemplate type Rep CreateJobTemplateResponse = D1 ('MetaData "CreateJobTemplateResponse" "Amazonka.IoT.CreateJobTemplate" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "CreateJobTemplateResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobTemplateArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "jobTemplateId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newCreateJobTemplateResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateJobTemplateResponse'`
-> CreateJobTemplateResponse

Create a value of CreateJobTemplateResponse 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:

CreateJobTemplateResponse, createJobTemplateResponse_jobTemplateArn - The ARN of the job template.

CreateJobTemplate, createJobTemplateResponse_jobTemplateId - The unique identifier of the job template.

$sel:httpStatus:CreateJobTemplateResponse', createJobTemplateResponse_httpStatus - The response's http status code.

Response Lenses

createJobTemplateResponse_jobTemplateArn :: Lens' CreateJobTemplateResponse (Maybe Text) Source #

The ARN of the job template.

createJobTemplateResponse_jobTemplateId :: Lens' CreateJobTemplateResponse (Maybe Text) Source #

The unique identifier of the job template.

createJobTemplateResponse_httpStatus :: Lens' CreateJobTemplateResponse Int Source #

The response's http status code.