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.DescribeManagedJobTemplate

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

View details of a managed job template.

Synopsis

Creating a Request

data DescribeManagedJobTemplate Source #

See: newDescribeManagedJobTemplate smart constructor.

Constructors

DescribeManagedJobTemplate'
Fields templateVersion :: Maybe Text An optional parameter to specify version of a managed template. If not specified, the pre-defined default version is returned. templateName :: Text The unique name of a managed job template, which is required.

Instances

Instances details

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

newDescribeManagedJobTemplate Source #

Arguments

:: Text	`DescribeManagedJobTemplate`
-> DescribeManagedJobTemplate

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

DescribeManagedJobTemplate, describeManagedJobTemplate_templateVersion - An optional parameter to specify version of a managed template. If not specified, the pre-defined default version is returned.

DescribeManagedJobTemplate, describeManagedJobTemplate_templateName - The unique name of a managed job template, which is required.

Request Lenses

describeManagedJobTemplate_templateVersion :: Lens' DescribeManagedJobTemplate (Maybe Text) Source #

An optional parameter to specify version of a managed template. If not specified, the pre-defined default version is returned.

describeManagedJobTemplate_templateName :: Lens' DescribeManagedJobTemplate Text Source #

The unique name of a managed job template, which is required.

Destructuring the Response

data DescribeManagedJobTemplateResponse Source #

See: newDescribeManagedJobTemplateResponse smart constructor.

Constructors

DescribeManagedJobTemplateResponse'

Fields

description :: Maybe Text
The unique description of a managed template.
document :: Maybe Text
The document schema for a managed job template.
documentParameters :: Maybe [DocumentParameter]
A map of key-value pairs that you can use as guidance to specify the inputs for creating a job from a managed template.
documentParameters can only be used when creating jobs from Amazon Web Services managed templates. This parameter can't be used with custom job templates or to create jobs from them.
environments :: Maybe [Text]
A list of environments that are supported with the managed job template.
templateArn :: Maybe Text
The unique Amazon Resource Name (ARN) of the managed template.
templateName :: Maybe Text
The unique name of a managed template, such as AWS-Reboot.
templateVersion :: Maybe Text
The version for a managed template.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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

newDescribeManagedJobTemplateResponse Source #

Arguments

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

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

DescribeManagedJobTemplateResponse, describeManagedJobTemplateResponse_description - The unique description of a managed template.

$sel:document:DescribeManagedJobTemplateResponse', describeManagedJobTemplateResponse_document - The document schema for a managed job template.

DescribeManagedJobTemplateResponse, describeManagedJobTemplateResponse_documentParameters - A map of key-value pairs that you can use as guidance to specify the inputs for creating a job from a managed template.

documentParameters can only be used when creating jobs from Amazon Web Services managed templates. This parameter can't be used with custom job templates or to create jobs from them.

DescribeManagedJobTemplateResponse, describeManagedJobTemplateResponse_environments - A list of environments that are supported with the managed job template.

DescribeManagedJobTemplateResponse, describeManagedJobTemplateResponse_templateArn - The unique Amazon Resource Name (ARN) of the managed template.

DescribeManagedJobTemplate, describeManagedJobTemplateResponse_templateName - The unique name of a managed template, such as AWS-Reboot.

DescribeManagedJobTemplate, describeManagedJobTemplateResponse_templateVersion - The version for a managed template.

$sel:httpStatus:DescribeManagedJobTemplateResponse', describeManagedJobTemplateResponse_httpStatus - The response's http status code.

Response Lenses

describeManagedJobTemplateResponse_description :: Lens' DescribeManagedJobTemplateResponse (Maybe Text) Source #

The unique description of a managed template.

describeManagedJobTemplateResponse_document :: Lens' DescribeManagedJobTemplateResponse (Maybe Text) Source #

The document schema for a managed job template.

describeManagedJobTemplateResponse_documentParameters :: Lens' DescribeManagedJobTemplateResponse (Maybe [DocumentParameter]) Source #

A map of key-value pairs that you can use as guidance to specify the inputs for creating a job from a managed template.

documentParameters can only be used when creating jobs from Amazon Web Services managed templates. This parameter can't be used with custom job templates or to create jobs from them.

describeManagedJobTemplateResponse_environments :: Lens' DescribeManagedJobTemplateResponse (Maybe [Text]) Source #

A list of environments that are supported with the managed job template.

describeManagedJobTemplateResponse_templateArn :: Lens' DescribeManagedJobTemplateResponse (Maybe Text) Source #

The unique Amazon Resource Name (ARN) of the managed template.

describeManagedJobTemplateResponse_templateName :: Lens' DescribeManagedJobTemplateResponse (Maybe Text) Source #

The unique name of a managed template, such as AWS-Reboot.

describeManagedJobTemplateResponse_templateVersion :: Lens' DescribeManagedJobTemplateResponse (Maybe Text) Source #

The version for a managed template.

describeManagedJobTemplateResponse_httpStatus :: Lens' DescribeManagedJobTemplateResponse Int Source #

The response's http status code.