Amazonka.IoT.CreateJobTemplate

Creates a job template.

Requires permission to access the CreateJobTemplate action.

Creating a Request

data CreateJobTemplate

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

ToJSON CreateJobTemplate

Defined in Amazonka.IoT.CreateJobTemplate

Methods

toJSON :: CreateJobTemplate -> Value

toEncoding :: CreateJobTemplate -> Encoding

toJSONList :: [CreateJobTemplate] -> Value

toEncodingList :: [CreateJobTemplate] -> Encoding

ToHeaders CreateJobTemplate

Defined in Amazonka.IoT.CreateJobTemplate

Methods

toHeaders :: CreateJobTemplate -> [Header]

ToPath CreateJobTemplate

Defined in Amazonka.IoT.CreateJobTemplate

Methods

toPath :: CreateJobTemplate -> ByteString

ToQuery CreateJobTemplate

Defined in Amazonka.IoT.CreateJobTemplate

Methods

toQuery :: CreateJobTemplate -> QueryString

AWSRequest CreateJobTemplate

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

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

Defined in Amazonka.IoT.CreateJobTemplate

Methods

readsPrec :: Int -> ReadS CreateJobTemplate

readList :: ReadS [CreateJobTemplate]

readPrec :: ReadPrec CreateJobTemplate

readListPrec :: ReadPrec [CreateJobTemplate]

Show CreateJobTemplate

Defined in Amazonka.IoT.CreateJobTemplate

Methods

showsPrec :: Int -> CreateJobTemplate -> ShowS

show :: CreateJobTemplate -> String

showList :: [CreateJobTemplate] -> ShowS

NFData CreateJobTemplate

Defined in Amazonka.IoT.CreateJobTemplate

Methods

rnf :: CreateJobTemplate -> ()

Eq CreateJobTemplate

Defined in Amazonka.IoT.CreateJobTemplate

Methods

(==) :: CreateJobTemplate -> CreateJobTemplate -> Bool

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

Hashable CreateJobTemplate

Defined in Amazonka.IoT.CreateJobTemplate

Methods

hashWithSalt :: Int -> CreateJobTemplate -> Int

hash :: CreateJobTemplate -> Int

type AWSResponse CreateJobTemplate

Defined in Amazonka.IoT.CreateJobTemplate

type AWSResponse CreateJobTemplate = CreateJobTemplateResponse

type Rep CreateJobTemplate

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

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)

Undocumented member.

createJobTemplate_document :: Lens' CreateJobTemplate (Maybe Text)

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

createJobTemplate_documentSource :: Lens' CreateJobTemplate (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.

createJobTemplate_jobArn :: Lens' CreateJobTemplate (Maybe Text)

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

createJobTemplate_jobExecutionsRetryConfig :: Lens' CreateJobTemplate (Maybe JobExecutionsRetryConfig)

Allows you to create the criteria to retry a job.

createJobTemplate_jobExecutionsRolloutConfig :: Lens' CreateJobTemplate (Maybe JobExecutionsRolloutConfig)

Undocumented member.

createJobTemplate_presignedUrlConfig :: Lens' CreateJobTemplate (Maybe PresignedUrlConfig)

Undocumented member.

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

Metadata that can be used to manage the job template.

createJobTemplate_timeoutConfig :: Lens' CreateJobTemplate (Maybe TimeoutConfig)

Undocumented member.

createJobTemplate_jobTemplateId :: Lens' CreateJobTemplate Text

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

A description of the job document.

Destructuring the Response

data CreateJobTemplateResponse

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

Generic CreateJobTemplateResponse

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

Defined in Amazonka.IoT.CreateJobTemplate

Methods

readsPrec :: Int -> ReadS CreateJobTemplateResponse

readList :: ReadS [CreateJobTemplateResponse]

readPrec :: ReadPrec CreateJobTemplateResponse

readListPrec :: ReadPrec [CreateJobTemplateResponse]

Show CreateJobTemplateResponse

Defined in Amazonka.IoT.CreateJobTemplate

Methods

showsPrec :: Int -> CreateJobTemplateResponse -> ShowS

show :: CreateJobTemplateResponse -> String

showList :: [CreateJobTemplateResponse] -> ShowS

NFData CreateJobTemplateResponse

Defined in Amazonka.IoT.CreateJobTemplate

Methods

rnf :: CreateJobTemplateResponse -> ()

Eq CreateJobTemplateResponse

Defined in Amazonka.IoT.CreateJobTemplate

Methods

(==) :: CreateJobTemplateResponse -> CreateJobTemplateResponse -> Bool

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

type Rep CreateJobTemplateResponse

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

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)

The ARN of the job template.

createJobTemplateResponse_jobTemplateId :: Lens' CreateJobTemplateResponse (Maybe Text)

The unique identifier of the job template.

createJobTemplateResponse_httpStatus :: Lens' CreateJobTemplateResponse Int

The response's http status code.