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.Greengrass.CreateSoftwareUpdateJob

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a software update for a core or group of cores (specified as an IoT thing group.) Use this to update the OTA Agent as well as the Greengrass core software. It makes use of the IoT Jobs feature which provides additional commands to manage a Greengrass core software update job.

Synopsis

Creating a Request

data CreateSoftwareUpdateJob Source #

See: newCreateSoftwareUpdateJob smart constructor.

Constructors

CreateSoftwareUpdateJob'
Fields amznClientToken :: Maybe Text A client token used to correlate requests and responses. updateAgentLogLevel :: Maybe UpdateAgentLogLevel s3UrlSignerRole :: Text updateTargetsArchitecture :: UpdateTargetsArchitecture softwareToUpdate :: SoftwareToUpdate updateTargets :: [Text] updateTargetsOperatingSystem :: UpdateTargetsOperatingSystem

Instances

Instances details

ToJSON CreateSoftwareUpdateJob Source #
Instance details Defined in Amazonka.Greengrass.CreateSoftwareUpdateJob Methods toJSON :: CreateSoftwareUpdateJob -> Value # toEncoding :: CreateSoftwareUpdateJob -> Encoding # toJSONList :: [CreateSoftwareUpdateJob] -> Value # toEncodingList :: [CreateSoftwareUpdateJob] -> Encoding #
ToHeaders CreateSoftwareUpdateJob Source #
Instance details Defined in Amazonka.Greengrass.CreateSoftwareUpdateJob Methods toHeaders :: CreateSoftwareUpdateJob -> [Header] #
ToPath CreateSoftwareUpdateJob Source #
Instance details Defined in Amazonka.Greengrass.CreateSoftwareUpdateJob Methods toPath :: CreateSoftwareUpdateJob -> ByteString #
ToQuery CreateSoftwareUpdateJob Source #
Instance details Defined in Amazonka.Greengrass.CreateSoftwareUpdateJob Methods toQuery :: CreateSoftwareUpdateJob -> QueryString #
AWSRequest CreateSoftwareUpdateJob Source #
Instance details Defined in Amazonka.Greengrass.CreateSoftwareUpdateJob Associated Types type AWSResponse CreateSoftwareUpdateJob # Methods request :: (Service -> Service) -> CreateSoftwareUpdateJob -> Request CreateSoftwareUpdateJob # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateSoftwareUpdateJob -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateSoftwareUpdateJob))) #
Generic CreateSoftwareUpdateJob Source #
Instance details Defined in Amazonka.Greengrass.CreateSoftwareUpdateJob Associated Types type Rep CreateSoftwareUpdateJob :: Type -> Type # Methods from :: CreateSoftwareUpdateJob -> Rep CreateSoftwareUpdateJob x # to :: Rep CreateSoftwareUpdateJob x -> CreateSoftwareUpdateJob #
Read CreateSoftwareUpdateJob Source #
Instance details Defined in Amazonka.Greengrass.CreateSoftwareUpdateJob Methods readsPrec :: Int -> ReadS CreateSoftwareUpdateJob # readList :: ReadS [CreateSoftwareUpdateJob] # readPrec :: ReadPrec CreateSoftwareUpdateJob # readListPrec :: ReadPrec [CreateSoftwareUpdateJob] #
Show CreateSoftwareUpdateJob Source #
Instance details Defined in Amazonka.Greengrass.CreateSoftwareUpdateJob Methods showsPrec :: Int -> CreateSoftwareUpdateJob -> ShowS # show :: CreateSoftwareUpdateJob -> String # showList :: [CreateSoftwareUpdateJob] -> ShowS #
NFData CreateSoftwareUpdateJob Source #
Instance details Defined in Amazonka.Greengrass.CreateSoftwareUpdateJob Methods rnf :: CreateSoftwareUpdateJob -> () #
Eq CreateSoftwareUpdateJob Source #
Instance details Defined in Amazonka.Greengrass.CreateSoftwareUpdateJob Methods (==) :: CreateSoftwareUpdateJob -> CreateSoftwareUpdateJob -> Bool # (/=) :: CreateSoftwareUpdateJob -> CreateSoftwareUpdateJob -> Bool #
Hashable CreateSoftwareUpdateJob Source #
Instance details Defined in Amazonka.Greengrass.CreateSoftwareUpdateJob Methods hashWithSalt :: Int -> CreateSoftwareUpdateJob -> Int # hash :: CreateSoftwareUpdateJob -> Int #
type AWSResponse CreateSoftwareUpdateJob Source #
Instance details Defined in Amazonka.Greengrass.CreateSoftwareUpdateJob type AWSResponse CreateSoftwareUpdateJob = CreateSoftwareUpdateJobResponse
type Rep CreateSoftwareUpdateJob Source #
Instance details Defined in Amazonka.Greengrass.CreateSoftwareUpdateJob type Rep CreateSoftwareUpdateJob = D1 ('MetaData "CreateSoftwareUpdateJob" "Amazonka.Greengrass.CreateSoftwareUpdateJob" "amazonka-greengrass-2.0-KjUXjyW3l8XyfFjm5ZueR" 'False) (C1 ('MetaCons "CreateSoftwareUpdateJob'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "amznClientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "updateAgentLogLevel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UpdateAgentLogLevel)) :: S1 ('MetaSel ('Just "s3UrlSignerRole") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :: ((S1 ('MetaSel ('Just "updateTargetsArchitecture") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UpdateTargetsArchitecture) :: S1 ('MetaSel ('Just "softwareToUpdate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SoftwareToUpdate)) :: (S1 ('MetaSel ('Just "updateTargets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text]) :: S1 ('MetaSel ('Just "updateTargetsOperatingSystem") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UpdateTargetsOperatingSystem)))))

newCreateSoftwareUpdateJob Source #

Arguments

:: Text	`$sel:s3UrlSignerRole:CreateSoftwareUpdateJob'`
-> UpdateTargetsArchitecture	`$sel:updateTargetsArchitecture:CreateSoftwareUpdateJob'`
-> SoftwareToUpdate	`$sel:softwareToUpdate:CreateSoftwareUpdateJob'`
-> UpdateTargetsOperatingSystem	`$sel:updateTargetsOperatingSystem:CreateSoftwareUpdateJob'`
-> CreateSoftwareUpdateJob

Create a value of CreateSoftwareUpdateJob 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:amznClientToken:CreateSoftwareUpdateJob', createSoftwareUpdateJob_amznClientToken - A client token used to correlate requests and responses.

$sel:updateAgentLogLevel:CreateSoftwareUpdateJob', createSoftwareUpdateJob_updateAgentLogLevel - Undocumented member.

$sel:s3UrlSignerRole:CreateSoftwareUpdateJob', createSoftwareUpdateJob_s3UrlSignerRole - Undocumented member.

$sel:updateTargetsArchitecture:CreateSoftwareUpdateJob', createSoftwareUpdateJob_updateTargetsArchitecture - Undocumented member.

$sel:softwareToUpdate:CreateSoftwareUpdateJob', createSoftwareUpdateJob_softwareToUpdate - Undocumented member.

$sel:updateTargets:CreateSoftwareUpdateJob', createSoftwareUpdateJob_updateTargets - Undocumented member.

$sel:updateTargetsOperatingSystem:CreateSoftwareUpdateJob', createSoftwareUpdateJob_updateTargetsOperatingSystem - Undocumented member.

Request Lenses

createSoftwareUpdateJob_amznClientToken :: Lens' CreateSoftwareUpdateJob (Maybe Text) Source #

A client token used to correlate requests and responses.

createSoftwareUpdateJob_updateAgentLogLevel :: Lens' CreateSoftwareUpdateJob (Maybe UpdateAgentLogLevel) Source #

Undocumented member.

createSoftwareUpdateJob_s3UrlSignerRole :: Lens' CreateSoftwareUpdateJob Text Source #

Undocumented member.

createSoftwareUpdateJob_updateTargetsArchitecture :: Lens' CreateSoftwareUpdateJob UpdateTargetsArchitecture Source #

Undocumented member.

createSoftwareUpdateJob_softwareToUpdate :: Lens' CreateSoftwareUpdateJob SoftwareToUpdate Source #

Undocumented member.

createSoftwareUpdateJob_updateTargets :: Lens' CreateSoftwareUpdateJob [Text] Source #

Undocumented member.

createSoftwareUpdateJob_updateTargetsOperatingSystem :: Lens' CreateSoftwareUpdateJob UpdateTargetsOperatingSystem Source #

Undocumented member.

Destructuring the Response

data CreateSoftwareUpdateJobResponse Source #

See: newCreateSoftwareUpdateJobResponse smart constructor.

Constructors

CreateSoftwareUpdateJobResponse'
Fields iotJobArn :: Maybe Text The IoT Job ARN corresponding to this update. iotJobId :: Maybe Text The IoT Job Id corresponding to this update. platformSoftwareVersion :: Maybe Text The software version installed on the device or devices after the update. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateSoftwareUpdateJobResponse Source #
Instance details Defined in Amazonka.Greengrass.CreateSoftwareUpdateJob Associated Types type Rep CreateSoftwareUpdateJobResponse :: Type -> Type # Methods from :: CreateSoftwareUpdateJobResponse -> Rep CreateSoftwareUpdateJobResponse x # to :: Rep CreateSoftwareUpdateJobResponse x -> CreateSoftwareUpdateJobResponse #
Read CreateSoftwareUpdateJobResponse Source #
Instance details Defined in Amazonka.Greengrass.CreateSoftwareUpdateJob Methods readsPrec :: Int -> ReadS CreateSoftwareUpdateJobResponse # readList :: ReadS [CreateSoftwareUpdateJobResponse] # readPrec :: ReadPrec CreateSoftwareUpdateJobResponse # readListPrec :: ReadPrec [CreateSoftwareUpdateJobResponse] #
Show CreateSoftwareUpdateJobResponse Source #
Instance details Defined in Amazonka.Greengrass.CreateSoftwareUpdateJob Methods showsPrec :: Int -> CreateSoftwareUpdateJobResponse -> ShowS # show :: CreateSoftwareUpdateJobResponse -> String # showList :: [CreateSoftwareUpdateJobResponse] -> ShowS #
NFData CreateSoftwareUpdateJobResponse Source #
Instance details Defined in Amazonka.Greengrass.CreateSoftwareUpdateJob Methods rnf :: CreateSoftwareUpdateJobResponse -> () #
Eq CreateSoftwareUpdateJobResponse Source #
Instance details Defined in Amazonka.Greengrass.CreateSoftwareUpdateJob Methods (==) :: CreateSoftwareUpdateJobResponse -> CreateSoftwareUpdateJobResponse -> Bool # (/=) :: CreateSoftwareUpdateJobResponse -> CreateSoftwareUpdateJobResponse -> Bool #
type Rep CreateSoftwareUpdateJobResponse Source #
Instance details Defined in Amazonka.Greengrass.CreateSoftwareUpdateJob type Rep CreateSoftwareUpdateJobResponse = D1 ('MetaData "CreateSoftwareUpdateJobResponse" "Amazonka.Greengrass.CreateSoftwareUpdateJob" "amazonka-greengrass-2.0-KjUXjyW3l8XyfFjm5ZueR" 'False) (C1 ('MetaCons "CreateSoftwareUpdateJobResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "iotJobArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "iotJobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "platformSoftwareVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newCreateSoftwareUpdateJobResponse Source #

Arguments

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

Create a value of CreateSoftwareUpdateJobResponse 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:iotJobArn:CreateSoftwareUpdateJobResponse', createSoftwareUpdateJobResponse_iotJobArn - The IoT Job ARN corresponding to this update.

$sel:iotJobId:CreateSoftwareUpdateJobResponse', createSoftwareUpdateJobResponse_iotJobId - The IoT Job Id corresponding to this update.

$sel:platformSoftwareVersion:CreateSoftwareUpdateJobResponse', createSoftwareUpdateJobResponse_platformSoftwareVersion - The software version installed on the device or devices after the update.

$sel:httpStatus:CreateSoftwareUpdateJobResponse', createSoftwareUpdateJobResponse_httpStatus - The response's http status code.

Response Lenses

createSoftwareUpdateJobResponse_iotJobArn :: Lens' CreateSoftwareUpdateJobResponse (Maybe Text) Source #

The IoT Job ARN corresponding to this update.

createSoftwareUpdateJobResponse_iotJobId :: Lens' CreateSoftwareUpdateJobResponse (Maybe Text) Source #

The IoT Job Id corresponding to this update.

createSoftwareUpdateJobResponse_platformSoftwareVersion :: Lens' CreateSoftwareUpdateJobResponse (Maybe Text) Source #

The software version installed on the device or devices after the update.

createSoftwareUpdateJobResponse_httpStatus :: Lens' CreateSoftwareUpdateJobResponse Int Source #

The response's http status code.