Amazonka.Panorama.CreateJobForDevices

Creates a job to run on one or more devices. A job can update a device's software or reboot it.

Creating a Request

data CreateJobForDevices

See: newCreateJobForDevices smart constructor.

Constructors

CreateJobForDevices'

Fields

• deviceJobConfig :: Maybe DeviceJobConfig

  Configuration settings for a software update job.

• deviceIds :: NonEmpty Text

  IDs of target devices.

• jobType :: JobType

  The type of job to run.

Instances

ToJSON CreateJobForDevices

Defined in Amazonka.Panorama.CreateJobForDevices

Methods

toJSON :: CreateJobForDevices -> Value

toEncoding :: CreateJobForDevices -> Encoding

toJSONList :: [CreateJobForDevices] -> Value

toEncodingList :: [CreateJobForDevices] -> Encoding

ToHeaders CreateJobForDevices

Defined in Amazonka.Panorama.CreateJobForDevices

Methods

toHeaders :: CreateJobForDevices -> [Header]

ToPath CreateJobForDevices

Defined in Amazonka.Panorama.CreateJobForDevices

Methods

toPath :: CreateJobForDevices -> ByteString

ToQuery CreateJobForDevices

Defined in Amazonka.Panorama.CreateJobForDevices

Methods

toQuery :: CreateJobForDevices -> QueryString

AWSRequest CreateJobForDevices

Defined in Amazonka.Panorama.CreateJobForDevices

Associated Types

type AWSResponse CreateJobForDevices

Methods

request :: (Service -> Service) -> CreateJobForDevices -> Request CreateJobForDevices

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateJobForDevices -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateJobForDevices)))

Generic CreateJobForDevices

Defined in Amazonka.Panorama.CreateJobForDevices

Associated Types

type Rep CreateJobForDevices :: Type -> Type

Methods

from :: CreateJobForDevices -> Rep CreateJobForDevices x

to :: Rep CreateJobForDevices x -> CreateJobForDevices

Read CreateJobForDevices

Defined in Amazonka.Panorama.CreateJobForDevices

Methods

readsPrec :: Int -> ReadS CreateJobForDevices

readList :: ReadS [CreateJobForDevices]

readPrec :: ReadPrec CreateJobForDevices

readListPrec :: ReadPrec [CreateJobForDevices]

Show CreateJobForDevices

Defined in Amazonka.Panorama.CreateJobForDevices

Methods

showsPrec :: Int -> CreateJobForDevices -> ShowS

show :: CreateJobForDevices -> String

showList :: [CreateJobForDevices] -> ShowS

NFData CreateJobForDevices

Defined in Amazonka.Panorama.CreateJobForDevices

Methods

rnf :: CreateJobForDevices -> ()

Eq CreateJobForDevices

Defined in Amazonka.Panorama.CreateJobForDevices

Methods

(==) :: CreateJobForDevices -> CreateJobForDevices -> Bool

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

Hashable CreateJobForDevices

Defined in Amazonka.Panorama.CreateJobForDevices

Methods

hashWithSalt :: Int -> CreateJobForDevices -> Int

hash :: CreateJobForDevices -> Int

type AWSResponse CreateJobForDevices

Defined in Amazonka.Panorama.CreateJobForDevices

type AWSResponse CreateJobForDevices = CreateJobForDevicesResponse

type Rep CreateJobForDevices

Defined in Amazonka.Panorama.CreateJobForDevices

type Rep CreateJobForDevices = D1 ('MetaData "CreateJobForDevices" "Amazonka.Panorama.CreateJobForDevices" "amazonka-panorama-2.0-9Y2Sxd8ToqsBjPczgPI6n1" 'False) (C1 ('MetaCons "CreateJobForDevices'" 'PrefixI 'True) (S1 ('MetaSel ('Just "deviceJobConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DeviceJobConfig)) :*: (S1 ('MetaSel ('Just "deviceIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Text)) :*: S1 ('MetaSel ('Just "jobType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 JobType))))

newCreateJobForDevices

Arguments

:: NonEmpty Text

$sel:deviceIds:CreateJobForDevices'

-> JobType

CreateJobForDevices

-> CreateJobForDevices

Create a value of CreateJobForDevices 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:deviceJobConfig:CreateJobForDevices', createJobForDevices_deviceJobConfig - Configuration settings for a software update job.

$sel:deviceIds:CreateJobForDevices', createJobForDevices_deviceIds - IDs of target devices.

CreateJobForDevices, createJobForDevices_jobType - The type of job to run.

Request Lenses

createJobForDevices_deviceJobConfig :: Lens' CreateJobForDevices (Maybe DeviceJobConfig)

Configuration settings for a software update job.

createJobForDevices_deviceIds :: Lens' CreateJobForDevices (NonEmpty Text)

IDs of target devices.

createJobForDevices_jobType :: Lens' CreateJobForDevices JobType

The type of job to run.

Destructuring the Response

data CreateJobForDevicesResponse

See: newCreateJobForDevicesResponse smart constructor.

Constructors

CreateJobForDevicesResponse'

Fields

• httpStatus :: Int

  The response's http status code.

• jobs :: [Job]

  A list of jobs.

Instances

Generic CreateJobForDevicesResponse

Defined in Amazonka.Panorama.CreateJobForDevices

Associated Types

type Rep CreateJobForDevicesResponse :: Type -> Type

Methods

from :: CreateJobForDevicesResponse -> Rep CreateJobForDevicesResponse x

to :: Rep CreateJobForDevicesResponse x -> CreateJobForDevicesResponse

Read CreateJobForDevicesResponse

Defined in Amazonka.Panorama.CreateJobForDevices

Methods

readsPrec :: Int -> ReadS CreateJobForDevicesResponse

readList :: ReadS [CreateJobForDevicesResponse]

readPrec :: ReadPrec CreateJobForDevicesResponse

readListPrec :: ReadPrec [CreateJobForDevicesResponse]

Show CreateJobForDevicesResponse

Defined in Amazonka.Panorama.CreateJobForDevices

Methods

showsPrec :: Int -> CreateJobForDevicesResponse -> ShowS

show :: CreateJobForDevicesResponse -> String

showList :: [CreateJobForDevicesResponse] -> ShowS

NFData CreateJobForDevicesResponse

Defined in Amazonka.Panorama.CreateJobForDevices

Methods

rnf :: CreateJobForDevicesResponse -> ()

Eq CreateJobForDevicesResponse

Defined in Amazonka.Panorama.CreateJobForDevices

Methods

(==) :: CreateJobForDevicesResponse -> CreateJobForDevicesResponse -> Bool

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

type Rep CreateJobForDevicesResponse

Defined in Amazonka.Panorama.CreateJobForDevices

type Rep CreateJobForDevicesResponse = D1 ('MetaData "CreateJobForDevicesResponse" "Amazonka.Panorama.CreateJobForDevices" "amazonka-panorama-2.0-9Y2Sxd8ToqsBjPczgPI6n1" 'False) (C1 ('MetaCons "CreateJobForDevicesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "jobs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Job])))

newCreateJobForDevicesResponse

Arguments

:: Int

$sel:httpStatus:CreateJobForDevicesResponse'

-> CreateJobForDevicesResponse

Create a value of CreateJobForDevicesResponse 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:httpStatus:CreateJobForDevicesResponse', createJobForDevicesResponse_httpStatus - The response's http status code.

$sel:jobs:CreateJobForDevicesResponse', createJobForDevicesResponse_jobs - A list of jobs.

Response Lenses

createJobForDevicesResponse_httpStatus :: Lens' CreateJobForDevicesResponse Int

The response's http status code.

createJobForDevicesResponse_jobs :: Lens' CreateJobForDevicesResponse [Job]

A list of jobs.