amazonka-panorama-2.0: Amazon Panorama SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Panorama.Lens

Description

 
Synopsis

Operations

CreateApplicationInstance

createApplicationInstance_applicationInstanceIdToReplace :: Lens' CreateApplicationInstance (Maybe Text) Source #

The ID of an application instance to replace with the new instance.

createApplicationInstance_runtimeRoleArn :: Lens' CreateApplicationInstance (Maybe Text) Source #

The ARN of a runtime role for the application instance.

CreateJobForDevices

createJobForDevices_deviceJobConfig :: Lens' CreateJobForDevices (Maybe DeviceJobConfig) Source #

Configuration settings for a software update job.

CreateNodeFromTemplateJob

CreatePackage

CreatePackageImportJob

createPackageImportJob_clientToken :: Lens' CreatePackageImportJob Text Source #

A client token for the package import job.

DeleteDevice

DeletePackage

deletePackage_forceDelete :: Lens' DeletePackage (Maybe Bool) Source #

Delete the package even if it has artifacts stored in its access point. Deletes the package's artifacts from Amazon S3.

DeregisterPackageVersion

deregisterPackageVersion_updatedLatestPatchVersion :: Lens' DeregisterPackageVersion (Maybe Text) Source #

If the version was marked latest, the new version to maker as latest.

DescribeApplicationInstance

DescribeApplicationInstanceDetails

DescribeDevice

describeDeviceResponse_deviceAggregatedStatus :: Lens' DescribeDeviceResponse (Maybe DeviceAggregatedStatus) Source #

A device's aggregated status. Including the device's connection status, provisioning status, and lease status.

describeDeviceResponse_latestDeviceJob :: Lens' DescribeDeviceResponse (Maybe LatestDeviceJob) Source #

A device's latest job. Includes the target image version, and the job status.

describeDeviceResponse_latestSoftware :: Lens' DescribeDeviceResponse (Maybe Text) Source #

The latest software version available for the device.

DescribeDeviceJob

describeDeviceJobResponse_imageVersion :: Lens' DescribeDeviceJobResponse (Maybe Text) Source #

For an OTA job, the target version of the device software.

DescribeNode

describeNode_ownerAccount :: Lens' DescribeNode (Maybe Text) Source #

The account ID of the node's owner.

DescribeNodeFromTemplateJob

DescribePackage

describePackageResponse_readAccessPrincipalArns :: Lens' DescribePackageResponse (Maybe [Text]) Source #

ARNs of accounts that have read access to the package.

describePackageResponse_writeAccessPrincipalArns :: Lens' DescribePackageResponse (Maybe [Text]) Source #

ARNs of accounts that have write access to the package.

DescribePackageImportJob

DescribePackageVersion

ListApplicationInstanceDependencies

listApplicationInstanceDependencies_maxResults :: Lens' ListApplicationInstanceDependencies (Maybe Natural) Source #

The maximum number of application instance dependencies to return in one page of results.

listApplicationInstanceDependencies_nextToken :: Lens' ListApplicationInstanceDependencies (Maybe Text) Source #

Specify the pagination token from a previous request to retrieve the next page of results.

ListApplicationInstanceNodeInstances

listApplicationInstanceNodeInstances_maxResults :: Lens' ListApplicationInstanceNodeInstances (Maybe Natural) Source #

The maximum number of node instances to return in one page of results.

listApplicationInstanceNodeInstances_nextToken :: Lens' ListApplicationInstanceNodeInstances (Maybe Text) Source #

Specify the pagination token from a previous request to retrieve the next page of results.

ListApplicationInstances

listApplicationInstances_maxResults :: Lens' ListApplicationInstances (Maybe Natural) Source #

The maximum number of application instances to return in one page of results.

listApplicationInstances_nextToken :: Lens' ListApplicationInstances (Maybe Text) Source #

Specify the pagination token from a previous request to retrieve the next page of results.

listApplicationInstancesResponse_nextToken :: Lens' ListApplicationInstancesResponse (Maybe Text) Source #

A pagination token that's included if more results are available.

ListDevices

listDevices_maxResults :: Lens' ListDevices (Maybe Natural) Source #

The maximum number of devices to return in one page of results.

listDevices_nameFilter :: Lens' ListDevices (Maybe Text) Source #

Filter based on device's name. Prefixes supported.

listDevices_nextToken :: Lens' ListDevices (Maybe Text) Source #

Specify the pagination token from a previous request to retrieve the next page of results.

listDevices_sortBy :: Lens' ListDevices (Maybe ListDevicesSortBy) Source #

The target column to be sorted on. Default column sort is CREATED_TIME.

listDevices_sortOrder :: Lens' ListDevices (Maybe SortOrder) Source #

The sorting order for the returned list. SortOrder is DESCENDING by default based on CREATED_TIME. Otherwise, SortOrder is ASCENDING.

listDevicesResponse_nextToken :: Lens' ListDevicesResponse (Maybe Text) Source #

A pagination token that's included if more results are available.

ListDevicesJobs

listDevicesJobs_deviceId :: Lens' ListDevicesJobs (Maybe Text) Source #

Filter results by the job's target device ID.

listDevicesJobs_maxResults :: Lens' ListDevicesJobs (Maybe Natural) Source #

The maximum number of device jobs to return in one page of results.

listDevicesJobs_nextToken :: Lens' ListDevicesJobs (Maybe Text) Source #

Specify the pagination token from a previous request to retrieve the next page of results.

listDevicesJobsResponse_nextToken :: Lens' ListDevicesJobsResponse (Maybe Text) Source #

A pagination token that's included if more results are available.

ListNodeFromTemplateJobs

listNodeFromTemplateJobs_maxResults :: Lens' ListNodeFromTemplateJobs (Maybe Natural) Source #

The maximum number of node from template jobs to return in one page of results.

listNodeFromTemplateJobs_nextToken :: Lens' ListNodeFromTemplateJobs (Maybe Text) Source #

Specify the pagination token from a previous request to retrieve the next page of results.

listNodeFromTemplateJobsResponse_nextToken :: Lens' ListNodeFromTemplateJobsResponse (Maybe Text) Source #

A pagination token that's included if more results are available.

ListNodes

listNodes_category :: Lens' ListNodes (Maybe NodeCategory) Source #

Search for nodes by category.

listNodes_maxResults :: Lens' ListNodes (Maybe Natural) Source #

The maximum number of nodes to return in one page of results.

listNodes_nextToken :: Lens' ListNodes (Maybe Text) Source #

Specify the pagination token from a previous request to retrieve the next page of results.

listNodes_ownerAccount :: Lens' ListNodes (Maybe Text) Source #

Search for nodes by the account ID of the nodes' owner.

listNodes_packageName :: Lens' ListNodes (Maybe Text) Source #

Search for nodes by name.

listNodes_packageVersion :: Lens' ListNodes (Maybe Text) Source #

Search for nodes by version.

listNodes_patchVersion :: Lens' ListNodes (Maybe Text) Source #

Search for nodes by patch version.

listNodesResponse_nextToken :: Lens' ListNodesResponse (Maybe Text) Source #

A pagination token that's included if more results are available.

listNodesResponse_httpStatus :: Lens' ListNodesResponse Int Source #

The response's http status code.

ListPackageImportJobs

listPackageImportJobs_maxResults :: Lens' ListPackageImportJobs (Maybe Natural) Source #

The maximum number of package import jobs to return in one page of results.

listPackageImportJobs_nextToken :: Lens' ListPackageImportJobs (Maybe Text) Source #

Specify the pagination token from a previous request to retrieve the next page of results.

listPackageImportJobsResponse_nextToken :: Lens' ListPackageImportJobsResponse (Maybe Text) Source #

A pagination token that's included if more results are available.

ListPackages

listPackages_maxResults :: Lens' ListPackages (Maybe Natural) Source #

The maximum number of packages to return in one page of results.

listPackages_nextToken :: Lens' ListPackages (Maybe Text) Source #

Specify the pagination token from a previous request to retrieve the next page of results.

listPackagesResponse_nextToken :: Lens' ListPackagesResponse (Maybe Text) Source #

A pagination token that's included if more results are available.

ListTagsForResource

ProvisionDevice

provisionDeviceResponse_certificates :: Lens' ProvisionDeviceResponse (Maybe ByteString) Source #

The device's configuration bundle.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

RegisterPackageVersion

registerPackageVersion_markLatest :: Lens' RegisterPackageVersion (Maybe Bool) Source #

Whether to mark the new version as the latest version.

RemoveApplicationInstance

SignalApplicationInstanceNodeInstances

TagResource

UntagResource

UpdateDeviceMetadata

Types

AlternateSoftwareMetadata

ApplicationInstance

applicationInstance_arn :: Lens' ApplicationInstance (Maybe Text) Source #

The application instance's ARN.

applicationInstance_createdTime :: Lens' ApplicationInstance (Maybe UTCTime) Source #

When the application instance was created.

applicationInstance_description :: Lens' ApplicationInstance (Maybe Text) Source #

The application instance's description.

applicationInstance_name :: Lens' ApplicationInstance (Maybe Text) Source #

The application instance's name.

applicationInstance_statusDescription :: Lens' ApplicationInstance (Maybe Text) Source #

The application instance's status description.

Device

device_createdTime :: Lens' Device (Maybe UTCTime) Source #

When the device was created.

device_currentSoftware :: Lens' Device (Maybe Text) Source #

A device's current software.

device_description :: Lens' Device (Maybe Text) Source #

A description for the device.

device_deviceAggregatedStatus :: Lens' Device (Maybe DeviceAggregatedStatus) Source #

A device's aggregated status. Including the device's connection status, provisioning status, and lease status.

device_lastUpdatedTime :: Lens' Device (Maybe UTCTime) Source #

When the device was updated.

device_latestDeviceJob :: Lens' Device (Maybe LatestDeviceJob) Source #

A device's latest job. Includes the target image version, and the update job status.

device_leaseExpirationTime :: Lens' Device (Maybe UTCTime) Source #

The device's lease expiration time.

device_name :: Lens' Device (Maybe Text) Source #

The device's name.

device_provisioningStatus :: Lens' Device (Maybe DeviceStatus) Source #

The device's provisioning status.

device_tags :: Lens' Device (Maybe (HashMap Text Text)) Source #

The device's tags.

DeviceJob

deviceJob_createdTime :: Lens' DeviceJob (Maybe UTCTime) Source #

When the job was created.

deviceJob_deviceId :: Lens' DeviceJob (Maybe Text) Source #

The ID of the target device.

deviceJob_deviceName :: Lens' DeviceJob (Maybe Text) Source #

The name of the target device

DeviceJobConfig

deviceJobConfig_oTAJobConfig :: Lens' DeviceJobConfig (Maybe OTAJobConfig) Source #

A configuration for an over-the-air (OTA) upgrade. Required for OTA jobs.

EthernetPayload

EthernetStatus

ethernetStatus_hwAddress :: Lens' EthernetStatus (Maybe Text) Source #

The device's physical address.

Job

job_deviceId :: Lens' Job (Maybe Text) Source #

The target device's ID.

job_jobId :: Lens' Job (Maybe Text) Source #

The job's ID.

JobResourceTags

LatestDeviceJob

latestDeviceJob_imageVersion :: Lens' LatestDeviceJob (Maybe Text) Source #

The target version of the device software.

ManifestOverridesPayload

ManifestPayload

NetworkPayload

networkPayload_ntp :: Lens' NetworkPayload (Maybe NtpPayload) Source #

Network time protocol (NTP) server settings.

NetworkStatus

networkStatus_ntpStatus :: Lens' NetworkStatus (Maybe NtpStatus) Source #

Details about a network time protocol (NTP) server connection.

Node

node_description :: Lens' Node (Maybe Text) Source #

The node's description.

node_ownerAccount :: Lens' Node (Maybe Text) Source #

The account ID of the node's owner.

node_category :: Lens' Node NodeCategory Source #

The node's category.

node_createdTime :: Lens' Node UTCTime Source #

When the node was created.

node_name :: Lens' Node Text Source #

The node's name.

node_nodeId :: Lens' Node Text Source #

The node's ID.

node_packageId :: Lens' Node Text Source #

The node's package ID.

node_packageName :: Lens' Node Text Source #

The node's package name.

node_packageVersion :: Lens' Node Text Source #

The node's package version.

node_patchVersion :: Lens' Node Text Source #

The node's patch version.

NodeFromTemplateJob

NodeInputPort

nodeInputPort_defaultValue :: Lens' NodeInputPort (Maybe Text) Source #

The input port's default value.

nodeInputPort_description :: Lens' NodeInputPort (Maybe Text) Source #

The input port's description.

nodeInputPort_maxConnections :: Lens' NodeInputPort (Maybe Int) Source #

The input port's max connections.

NodeInstance

nodeInstance_packageName :: Lens' NodeInstance (Maybe Text) Source #

The instance's package name.

nodeInstance_packagePatchVersion :: Lens' NodeInstance (Maybe Text) Source #

The instance's package patch version.

nodeInstance_packageVersion :: Lens' NodeInstance (Maybe Text) Source #

The instance's package version.

NodeInterface

NodeOutputPort

nodeOutputPort_description :: Lens' NodeOutputPort (Maybe Text) Source #

The output port's description.

NodeSignal

nodeSignal_nodeInstanceId :: Lens' NodeSignal Text Source #

The camera node's name, from the application manifest.

NtpPayload

ntpPayload_ntpServers :: Lens' NtpPayload [Text] Source #

NTP servers to use, in order of preference.

NtpStatus

ntpStatus_ipAddress :: Lens' NtpStatus (Maybe Text) Source #

The IP address of the server.

ntpStatus_ntpServerName :: Lens' NtpStatus (Maybe Text) Source #

The domain name of the server.

OTAJobConfig

oTAJobConfig_imageVersion :: Lens' OTAJobConfig Text Source #

The target version of the device software.

OutPutS3Location

PackageImportJob

PackageImportJobInputConfig

PackageImportJobOutput

PackageImportJobOutputConfig

PackageListItem

PackageObject

PackageVersionInputConfig

PackageVersionOutputConfig

packageVersionOutputConfig_markLatest :: Lens' PackageVersionOutputConfig (Maybe Bool) Source #

Indicates that the version is recommended for all users.

ReportedRuntimeContextState

S3Location

StaticIpConnectionInfo

StorageLocation