Table of Contents
A low-level client representing AWS Panorama
Overview
This is the AWS Panorama API Reference . For an introduction to the service, see What is AWS Panorama? in the AWS Panorama Developer Guide .
import boto3
client = boto3.client('panorama')
These are the available methods:
Check if an operation can be paginated.
Creates an application instance and deploys it to a device.
See also: AWS API Documentation
Request Syntax
response = client.create_application_instance(
ApplicationInstanceIdToReplace='string',
DefaultRuntimeContextDevice='string',
Description='string',
ManifestOverridesPayload={
'PayloadData': 'string'
},
ManifestPayload={
'PayloadData': 'string'
},
Name='string',
RuntimeRoleArn='string',
Tags={
'string': 'string'
}
)
[REQUIRED]
A device's ID.
Setting overrides for the application manifest.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: PayloadData.
The overrides document.
[REQUIRED]
The application's manifest document.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: PayloadData.
The application manifest.
Tags for the application instance.
dict
Response Syntax
{
'ApplicationInstanceId': 'string'
}
Response Structure
(dict) --
ApplicationInstanceId (string) --
The application instance's ID.
Exceptions
Creates a job to run on one or more devices.
See also: AWS API Documentation
Request Syntax
response = client.create_job_for_devices(
DeviceIds=[
'string',
],
DeviceJobConfig={
'OTAJobConfig': {
'ImageVersion': 'string'
}
},
JobType='OTA'
)
[REQUIRED]
IDs of target devices.
[REQUIRED]
Configuration settings for the job.
A configuration for an over-the-air (OTA) upgrade. Required for OTA jobs.
The target version of the device software.
[REQUIRED]
The type of job to run.
dict
Response Syntax
{
'Jobs': [
{
'DeviceId': 'string',
'JobId': 'string'
},
]
}
Response Structure
(dict) --
Jobs (list) --
A list of jobs.
(dict) --
A job for a device.
DeviceId (string) --
The target device's ID.
JobId (string) --
The job's ID.
Exceptions
Creates a camera stream node.
See also: AWS API Documentation
Request Syntax
response = client.create_node_from_template_job(
JobTags=[
{
'ResourceType': 'PACKAGE',
'Tags': {
'string': 'string'
}
},
],
NodeDescription='string',
NodeName='string',
OutputPackageName='string',
OutputPackageVersion='string',
TemplateParameters={
'string': 'string'
},
TemplateType='RTSP_CAMERA_STREAM'
)
Tags for the job.
Tags for a job.
The job's type.
The job's tags.
[REQUIRED]
A name for the node.
[REQUIRED]
An output package name for the node.
[REQUIRED]
An output package version for the node.
[REQUIRED]
Template parameters for the node.
[REQUIRED]
The type of node.
dict
Response Syntax
{
'JobId': 'string'
}
Response Structure
(dict) --
JobId (string) --
The job's ID.
Exceptions
Creates a package and storage location in an Amazon S3 access point.
See also: AWS API Documentation
Request Syntax
response = client.create_package(
PackageName='string',
Tags={
'string': 'string'
}
)
[REQUIRED]
A name for the package.
Tags for the package.
dict
Response Syntax
{
'Arn': 'string',
'PackageId': 'string',
'StorageLocation': {
'BinaryPrefixLocation': 'string',
'Bucket': 'string',
'GeneratedPrefixLocation': 'string',
'ManifestPrefixLocation': 'string',
'RepoPrefixLocation': 'string'
}
}
Response Structure
(dict) --
Arn (string) --
The package's ARN.
PackageId (string) --
The package's ID.
StorageLocation (dict) --
The package's storage location.
BinaryPrefixLocation (string) --
The location's binary prefix.
Bucket (string) --
The location's bucket.
GeneratedPrefixLocation (string) --
The location's generated prefix.
ManifestPrefixLocation (string) --
The location's manifest prefix.
RepoPrefixLocation (string) --
The location's repo prefix.
Exceptions
Imports a node package.
See also: AWS API Documentation
Request Syntax
response = client.create_package_import_job(
ClientToken='string',
InputConfig={
'PackageVersionInputConfig': {
'S3Location': {
'BucketName': 'string',
'ObjectKey': 'string',
'Region': 'string'
}
}
},
JobTags=[
{
'ResourceType': 'PACKAGE',
'Tags': {
'string': 'string'
}
},
],
JobType='NODE_PACKAGE_VERSION'|'MARKETPLACE_NODE_PACKAGE_VERSION',
OutputConfig={
'PackageVersionOutputConfig': {
'MarkLatest': True|False,
'PackageName': 'string',
'PackageVersion': 'string'
}
}
)
[REQUIRED]
A client token for the package import job.
[REQUIRED]
An input config for the package import job.
The package version's input configuration.
A location in Amazon S3.
A bucket name.
An object key.
The bucket's Region.
Tags for the package import job.
Tags for a job.
The job's type.
The job's tags.
[REQUIRED]
A job type for the package import job.
[REQUIRED]
An output config for the package import job.
The package version's output configuration.
Indicates that the version is recommended for all users.
The output's package name.
The output's package version.
dict
Response Syntax
{
'JobId': 'string'
}
Response Structure
(dict) --
JobId (string) --
The job's ID.
Exceptions
Deletes a device.
See also: AWS API Documentation
Request Syntax
response = client.delete_device(
DeviceId='string'
)
[REQUIRED]
The device's ID.
{
'DeviceId': 'string'
}
Response Structure
The device's ID.
Exceptions
Deletes a package.
Note
To delete a package, you need permission to call s3:DeleteObject in addition to permissions for the AWS Panorama API.
See also: AWS API Documentation
Request Syntax
response = client.delete_package(
ForceDelete=True|False,
PackageId='string'
)
[REQUIRED]
The package's ID.
dict
Response Syntax
{}
Response Structure
Exceptions
Deregisters a package version.
See also: AWS API Documentation
Request Syntax
response = client.deregister_package_version(
OwnerAccount='string',
PackageId='string',
PackageVersion='string',
PatchVersion='string',
UpdatedLatestPatchVersion='string'
)
[REQUIRED]
A package ID.
[REQUIRED]
A package version.
[REQUIRED]
A patch version.
dict
Response Syntax
{}
Response Structure
Exceptions
Returns information about an application instance on a device.
See also: AWS API Documentation
Request Syntax
response = client.describe_application_instance(
ApplicationInstanceId='string'
)
[REQUIRED]
The application instance's ID.
{
'ApplicationInstanceId': 'string',
'ApplicationInstanceIdToReplace': 'string',
'Arn': 'string',
'CreatedTime': datetime(2015, 1, 1),
'DefaultRuntimeContextDevice': 'string',
'DefaultRuntimeContextDeviceName': 'string',
'Description': 'string',
'HealthStatus': 'RUNNING'|'ERROR'|'NOT_AVAILABLE',
'LastUpdatedTime': datetime(2015, 1, 1),
'Name': 'string',
'RuntimeRoleArn': 'string',
'Status': 'DEPLOYMENT_PENDING'|'DEPLOYMENT_REQUESTED'|'DEPLOYMENT_IN_PROGRESS'|'DEPLOYMENT_ERROR'|'DEPLOYMENT_SUCCEEDED'|'REMOVAL_PENDING'|'REMOVAL_REQUESTED'|'REMOVAL_IN_PROGRESS'|'REMOVAL_FAILED'|'REMOVAL_SUCCEEDED'|'DEPLOYMENT_FAILED',
'StatusDescription': 'string',
'Tags': {
'string': 'string'
}
}
Response Structure
The application instance's ID.
The ID of the application instance that this instance replaced.
The application instance's ARN.
When the application instance was created.
The device's ID.
The device's bane.
The application instance's description.
The application instance's health status.
The application instance was updated.
The application instance's name.
The application instance's runtime role ARN.
The application instance's status.
The application instance's status description.
The application instance's tags.
Exceptions
Returns information about an application instance's configuration manifest.
See also: AWS API Documentation
Request Syntax
response = client.describe_application_instance_details(
ApplicationInstanceId='string'
)
[REQUIRED]
The application instance's ID.
{
'ApplicationInstanceId': 'string',
'ApplicationInstanceIdToReplace': 'string',
'CreatedTime': datetime(2015, 1, 1),
'DefaultRuntimeContextDevice': 'string',
'Description': 'string',
'ManifestOverridesPayload': {
'PayloadData': 'string'
},
'ManifestPayload': {
'PayloadData': 'string'
},
'Name': 'string'
}
Response Structure
The application instance's ID.
The ID of the application instance that this instance replaced.
When the application instance was created.
The application instance's default runtime context device.
The application instance's description.
Parameter overrides for the configuration manifest.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: PayloadData. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
The overrides document.
The application instance's configuration manifest.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: PayloadData. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
The application manifest.
The application instance's name.
Exceptions
Returns information about a device.
See also: AWS API Documentation
Request Syntax
response = client.describe_device(
DeviceId='string'
)
[REQUIRED]
The device's ID.
{
'AlternateSoftwares': [
{
'Version': 'string'
},
],
'Arn': 'string',
'Brand': 'AWS_PANORAMA'|'LENOVO',
'CreatedTime': datetime(2015, 1, 1),
'CurrentNetworkingStatus': {
'Ethernet0Status': {
'ConnectionStatus': 'CONNECTED'|'NOT_CONNECTED'|'CONNECTING',
'HwAddress': 'string',
'IpAddress': 'string'
},
'Ethernet1Status': {
'ConnectionStatus': 'CONNECTED'|'NOT_CONNECTED'|'CONNECTING',
'HwAddress': 'string',
'IpAddress': 'string'
},
'LastUpdatedTime': datetime(2015, 1, 1),
'NtpStatus': {
'ConnectionStatus': 'CONNECTED'|'NOT_CONNECTED'|'CONNECTING',
'IpAddress': 'string',
'NtpServerName': 'string'
}
},
'CurrentSoftware': 'string',
'Description': 'string',
'DeviceConnectionStatus': 'ONLINE'|'OFFLINE'|'AWAITING_CREDENTIALS'|'NOT_AVAILABLE'|'ERROR',
'DeviceId': 'string',
'LatestAlternateSoftware': 'string',
'LatestSoftware': 'string',
'LeaseExpirationTime': datetime(2015, 1, 1),
'Name': 'string',
'NetworkingConfiguration': {
'Ethernet0': {
'ConnectionType': 'STATIC_IP'|'DHCP',
'StaticIpConnectionInfo': {
'DefaultGateway': 'string',
'Dns': [
'string',
],
'IpAddress': 'string',
'Mask': 'string'
}
},
'Ethernet1': {
'ConnectionType': 'STATIC_IP'|'DHCP',
'StaticIpConnectionInfo': {
'DefaultGateway': 'string',
'Dns': [
'string',
],
'IpAddress': 'string',
'Mask': 'string'
}
},
'Ntp': {
'NtpServers': [
'string',
]
}
},
'ProvisioningStatus': 'AWAITING_PROVISIONING'|'PENDING'|'SUCCEEDED'|'FAILED'|'ERROR'|'DELETING',
'SerialNumber': 'string',
'Tags': {
'string': 'string'
},
'Type': 'PANORAMA_APPLIANCE_DEVELOPER_KIT'|'PANORAMA_APPLIANCE'
}
Response Structure
Beta software releases available for the device.
Details about a beta appliance software update.
The appliance software version.
The device's ARN.
The device's maker.
When the device was created.
The device's networking status.
The status of Ethernet port 0.
The device's connection status.
The device's physical address.
The device's IP address.
The status of Ethernet port 1.
The device's connection status.
The device's physical address.
The device's IP address.
When the network status changed.
Details about a network time protocol (NTP) server connection.
The connection's status.
The IP address of the server.
The domain name of the server.
The device's current software version.
The device's description.
The device's connection status.
The device's ID.
The most recent beta software release.
The latest software version available for the device.
The device's lease expiration time.
The device's name.
The device's networking configuration.
Settings for Ethernet port 0.
How the device gets an IP address.
Network configuration for a static IP connection.
The connection's default gateway.
The connection's DNS address.
The connection's IP address.
The connection's DNS mask.
Settings for Ethernet port 1.
How the device gets an IP address.
Network configuration for a static IP connection.
The connection's default gateway.
The connection's DNS address.
The connection's IP address.
The connection's DNS mask.
Network time protocol (NTP) server settings.
NTP servers to use, in order of preference.
The device's provisioning status.
The device's serial number.
The device's tags.
The device's type.
Exceptions
Returns information about a device job.
See also: AWS API Documentation
Request Syntax
response = client.describe_device_job(
JobId='string'
)
[REQUIRED]
The job's ID.
{
'CreatedTime': datetime(2015, 1, 1),
'DeviceArn': 'string',
'DeviceId': 'string',
'DeviceName': 'string',
'DeviceType': 'PANORAMA_APPLIANCE_DEVELOPER_KIT'|'PANORAMA_APPLIANCE',
'ImageVersion': 'string',
'JobId': 'string',
'Status': 'PENDING'|'IN_PROGRESS'|'VERIFYING'|'REBOOTING'|'DOWNLOADING'|'COMPLETED'|'FAILED'
}
Response Structure
When the job was created.
The device's ARN.
The device's ID.
The device's name.
The device's type.
For an OTA job, the target version of the device software.
The job's ID.
The job's status.
Exceptions
Returns information about a node.
See also: AWS API Documentation
Request Syntax
response = client.describe_node(
NodeId='string',
OwnerAccount='string'
)
[REQUIRED]
The node's ID.
dict
Response Syntax
{
'AssetName': 'string',
'Category': 'BUSINESS_LOGIC'|'ML_MODEL'|'MEDIA_SOURCE'|'MEDIA_SINK',
'CreatedTime': datetime(2015, 1, 1),
'Description': 'string',
'LastUpdatedTime': datetime(2015, 1, 1),
'Name': 'string',
'NodeId': 'string',
'NodeInterface': {
'Inputs': [
{
'DefaultValue': 'string',
'Description': 'string',
'MaxConnections': 123,
'Name': 'string',
'Type': 'BOOLEAN'|'STRING'|'INT32'|'FLOAT32'|'MEDIA'
},
],
'Outputs': [
{
'Description': 'string',
'Name': 'string',
'Type': 'BOOLEAN'|'STRING'|'INT32'|'FLOAT32'|'MEDIA'
},
]
},
'OwnerAccount': 'string',
'PackageArn': 'string',
'PackageId': 'string',
'PackageName': 'string',
'PackageVersion': 'string',
'PatchVersion': 'string'
}
Response Structure
(dict) --
AssetName (string) --
The node's asset name.
Category (string) --
The node's category.
CreatedTime (datetime) --
When the node was created.
Description (string) --
The node's description.
LastUpdatedTime (datetime) --
When the node was updated.
Name (string) --
The node's name.
NodeId (string) --
The node's ID.
NodeInterface (dict) --
The node's interface.
Inputs (list) --
The node interface's inputs.
(dict) --
A node input port.
DefaultValue (string) --
The input port's default value.
Description (string) --
The input port's description.
MaxConnections (integer) --
The input port's max connections.
Name (string) --
The input port's name.
Type (string) --
The input port's type.
Outputs (list) --
The node interface's outputs.
(dict) --
A node output port.
Description (string) --
The output port's description.
Name (string) --
The output port's name.
Type (string) --
The output port's type.
OwnerAccount (string) --
The account ID of the node's owner.
PackageArn (string) --
The node's ARN.
PackageId (string) --
The node's package ID.
PackageName (string) --
The node's package name.
PackageVersion (string) --
The node's package version.
PatchVersion (string) --
The node's patch version.
Exceptions
Returns information about a job to create a camera stream node.
See also: AWS API Documentation
Request Syntax
response = client.describe_node_from_template_job(
JobId='string'
)
[REQUIRED]
The job's ID.
{
'CreatedTime': datetime(2015, 1, 1),
'JobId': 'string',
'JobTags': [
{
'ResourceType': 'PACKAGE',
'Tags': {
'string': 'string'
}
},
],
'LastUpdatedTime': datetime(2015, 1, 1),
'NodeDescription': 'string',
'NodeName': 'string',
'OutputPackageName': 'string',
'OutputPackageVersion': 'string',
'Status': 'PENDING'|'SUCCEEDED'|'FAILED',
'StatusMessage': 'string',
'TemplateParameters': {
'string': 'string'
},
'TemplateType': 'RTSP_CAMERA_STREAM'
}
Response Structure
When the job was created.
The job's ID.
The job's tags.
Tags for a job.
The job's type.
The job's tags.
When the job was updated.
The node's description.
The node's name.
The job's output package name.
The job's output package version.
The job's status.
The job's status message.
The job's template parameters.
The job's template type.
Exceptions
Returns information about a package.
See also: AWS API Documentation
Request Syntax
response = client.describe_package(
PackageId='string'
)
[REQUIRED]
The package's ID.
{
'Arn': 'string',
'CreatedTime': datetime(2015, 1, 1),
'PackageId': 'string',
'PackageName': 'string',
'ReadAccessPrincipalArns': [
'string',
],
'StorageLocation': {
'BinaryPrefixLocation': 'string',
'Bucket': 'string',
'GeneratedPrefixLocation': 'string',
'ManifestPrefixLocation': 'string',
'RepoPrefixLocation': 'string'
},
'Tags': {
'string': 'string'
},
'WriteAccessPrincipalArns': [
'string',
]
}
Response Structure
The package's ARN.
When the package was created.
The package's ID.
The package's name.
ARNs of accounts that have read access to the package.
The package's storage location.
The location's binary prefix.
The location's bucket.
The location's generated prefix.
The location's manifest prefix.
The location's repo prefix.
The package's tags.
ARNs of accounts that have write access to the package.
Exceptions
Returns information about a package import job.
See also: AWS API Documentation
Request Syntax
response = client.describe_package_import_job(
JobId='string'
)
[REQUIRED]
The job's ID.
{
'ClientToken': 'string',
'CreatedTime': datetime(2015, 1, 1),
'InputConfig': {
'PackageVersionInputConfig': {
'S3Location': {
'BucketName': 'string',
'ObjectKey': 'string',
'Region': 'string'
}
}
},
'JobId': 'string',
'JobTags': [
{
'ResourceType': 'PACKAGE',
'Tags': {
'string': 'string'
}
},
],
'JobType': 'NODE_PACKAGE_VERSION'|'MARKETPLACE_NODE_PACKAGE_VERSION',
'LastUpdatedTime': datetime(2015, 1, 1),
'Output': {
'OutputS3Location': {
'BucketName': 'string',
'ObjectKey': 'string'
},
'PackageId': 'string',
'PackageVersion': 'string',
'PatchVersion': 'string'
},
'OutputConfig': {
'PackageVersionOutputConfig': {
'MarkLatest': True|False,
'PackageName': 'string',
'PackageVersion': 'string'
}
},
'Status': 'PENDING'|'SUCCEEDED'|'FAILED',
'StatusMessage': 'string'
}
Response Structure
The job's client token.
When the job was created.
The job's input config.
The package version's input configuration.
A location in Amazon S3.
A bucket name.
An object key.
The bucket's Region.
The job's ID.
The job's tags.
Tags for a job.
The job's type.
The job's tags.
The job's type.
When the job was updated.
The job's output.
The package's output location.
The object's bucket.
The object's key.
The package's ID.
The package's version.
The package's patch version.
The job's output config.
The package version's output configuration.
Indicates that the version is recommended for all users.
The output's package name.
The output's package version.
The job's status.
The job's status message.
Exceptions
Returns information about a package version.
See also: AWS API Documentation
Request Syntax
response = client.describe_package_version(
OwnerAccount='string',
PackageId='string',
PackageVersion='string',
PatchVersion='string'
)
[REQUIRED]
The version's ID.
[REQUIRED]
The version's version.
dict
Response Syntax
{
'IsLatestPatch': True|False,
'OwnerAccount': 'string',
'PackageArn': 'string',
'PackageId': 'string',
'PackageName': 'string',
'PackageVersion': 'string',
'PatchVersion': 'string',
'RegisteredTime': datetime(2015, 1, 1),
'Status': 'REGISTER_PENDING'|'REGISTER_COMPLETED'|'FAILED'|'DELETING',
'StatusDescription': 'string'
}
Response Structure
(dict) --
IsLatestPatch (boolean) --
Whether the version is the latest available.
OwnerAccount (string) --
The account ID of the version's owner.
PackageArn (string) --
The ARN of the package.
PackageId (string) --
The version's ID.
PackageName (string) --
The version's name.
PackageVersion (string) --
The version's version.
PatchVersion (string) --
The version's patch version.
RegisteredTime (datetime) --
The version's registered time.
Status (string) --
The version's status.
StatusDescription (string) --
The version's status description.
Exceptions
Create a paginator for an operation.
Returns an object that can wait for some condition.
Returns a list of application instance dependencies.
See also: AWS API Documentation
Request Syntax
response = client.list_application_instance_dependencies(
ApplicationInstanceId='string',
MaxResults=123,
NextToken='string'
)
[REQUIRED]
The application instance's ID.
dict
Response Syntax
{
'NextToken': 'string',
'PackageObjects': [
{
'Name': 'string',
'PackageVersion': 'string',
'PatchVersion': 'string'
},
]
}
Response Structure
(dict) --
NextToken (string) --
A pagination token that's included if more results are available.
PackageObjects (list) --
A list of package objects.
(dict) --
A package object.
Name (string) --
The object's name.
PackageVersion (string) --
The object's package version.
PatchVersion (string) --
The object's patch version.
Exceptions
Returns a list of application node instances.
See also: AWS API Documentation
Request Syntax
response = client.list_application_instance_node_instances(
ApplicationInstanceId='string',
MaxResults=123,
NextToken='string'
)
[REQUIRED]
The node instances' application instance ID.
dict
Response Syntax
{
'NextToken': 'string',
'NodeInstances': [
{
'CurrentStatus': 'RUNNING'|'ERROR'|'NOT_AVAILABLE',
'NodeId': 'string',
'NodeInstanceId': 'string',
'NodeName': 'string',
'PackageName': 'string',
'PackagePatchVersion': 'string',
'PackageVersion': 'string'
},
]
}
Response Structure
(dict) --
NextToken (string) --
A pagination token that's included if more results are available.
NodeInstances (list) --
A list of node instances.
(dict) --
A node instance.
CurrentStatus (string) --
The instance's current status.
NodeId (string) --
The node's ID.
NodeInstanceId (string) --
The instance's ID.
NodeName (string) --
The instance's name.
PackageName (string) --
The instance's package name.
PackagePatchVersion (string) --
The instance's package patch version.
PackageVersion (string) --
The instance's package version.
Exceptions
Returns a list of application instances.
See also: AWS API Documentation
Request Syntax
response = client.list_application_instances(
DeviceId='string',
MaxResults=123,
NextToken='string',
StatusFilter='DEPLOYMENT_SUCCEEDED'|'DEPLOYMENT_ERROR'|'REMOVAL_SUCCEEDED'|'REMOVAL_FAILED'|'PROCESSING_DEPLOYMENT'|'PROCESSING_REMOVAL'|'DEPLOYMENT_FAILED'
)
dict
Response Syntax
{
'ApplicationInstances': [
{
'ApplicationInstanceId': 'string',
'Arn': 'string',
'CreatedTime': datetime(2015, 1, 1),
'DefaultRuntimeContextDevice': 'string',
'DefaultRuntimeContextDeviceName': 'string',
'Description': 'string',
'HealthStatus': 'RUNNING'|'ERROR'|'NOT_AVAILABLE',
'Name': 'string',
'Status': 'DEPLOYMENT_PENDING'|'DEPLOYMENT_REQUESTED'|'DEPLOYMENT_IN_PROGRESS'|'DEPLOYMENT_ERROR'|'DEPLOYMENT_SUCCEEDED'|'REMOVAL_PENDING'|'REMOVAL_REQUESTED'|'REMOVAL_IN_PROGRESS'|'REMOVAL_FAILED'|'REMOVAL_SUCCEEDED'|'DEPLOYMENT_FAILED',
'StatusDescription': 'string',
'Tags': {
'string': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ApplicationInstances (list) --
A list of application instances.
(dict) --
An application instance on a device.
ApplicationInstanceId (string) --
The application instance's ID.
Arn (string) --
The application instance's ARN.
CreatedTime (datetime) --
When the application instance was created.
DefaultRuntimeContextDevice (string) --
The device's ID.
DefaultRuntimeContextDeviceName (string) --
The device's name.
Description (string) --
The application instance's description.
HealthStatus (string) --
The application instance's health status.
Name (string) --
The application instance's name.
Status (string) --
The application instance's status.
StatusDescription (string) --
The application instance's status description.
Tags (dict) --
The application instance's tags.
NextToken (string) --
A pagination token that's included if more results are available.
Exceptions
Returns a list of devices.
See also: AWS API Documentation
Request Syntax
response = client.list_devices(
MaxResults=123,
NextToken='string'
)
dict
Response Syntax
{
'Devices': [
{
'Brand': 'AWS_PANORAMA'|'LENOVO',
'CreatedTime': datetime(2015, 1, 1),
'DeviceId': 'string',
'LastUpdatedTime': datetime(2015, 1, 1),
'LeaseExpirationTime': datetime(2015, 1, 1),
'Name': 'string',
'ProvisioningStatus': 'AWAITING_PROVISIONING'|'PENDING'|'SUCCEEDED'|'FAILED'|'ERROR'|'DELETING'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Devices (list) --
A list of devices.
(dict) --
A device.
Brand (string) --
The device's maker.
CreatedTime (datetime) --
When the device was created.
DeviceId (string) --
The device's ID.
LastUpdatedTime (datetime) --
When the device was updated.
LeaseExpirationTime (datetime) --
The device's lease expiration time.
Name (string) --
The device's name.
ProvisioningStatus (string) --
The device's provisioning status.
NextToken (string) --
A pagination token that's included if more results are available.
Exceptions
Returns a list of jobs.
See also: AWS API Documentation
Request Syntax
response = client.list_devices_jobs(
DeviceId='string',
MaxResults=123,
NextToken='string'
)
dict
Response Syntax
{
'DeviceJobs': [
{
'CreatedTime': datetime(2015, 1, 1),
'DeviceId': 'string',
'DeviceName': 'string',
'JobId': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
DeviceJobs (list) --
A list of jobs.
(dict) --
A job that runs on a device.
CreatedTime (datetime) --
When the job was created.
DeviceId (string) --
The ID of the target device.
DeviceName (string) --
The name of the target device
JobId (string) --
The job's ID.
NextToken (string) --
A pagination token that's included if more results are available.
Exceptions
Returns a list of camera stream node jobs.
See also: AWS API Documentation
Request Syntax
response = client.list_node_from_template_jobs(
MaxResults=123,
NextToken='string'
)
dict
Response Syntax
{
'NextToken': 'string',
'NodeFromTemplateJobs': [
{
'CreatedTime': datetime(2015, 1, 1),
'JobId': 'string',
'NodeName': 'string',
'Status': 'PENDING'|'SUCCEEDED'|'FAILED',
'StatusMessage': 'string',
'TemplateType': 'RTSP_CAMERA_STREAM'
},
]
}
Response Structure
(dict) --
NextToken (string) --
A pagination token that's included if more results are available.
NodeFromTemplateJobs (list) --
A list of jobs.
(dict) --
A job to create a camera stream node.
CreatedTime (datetime) --
When the job was created.
JobId (string) --
The job's ID.
NodeName (string) --
The node's name.
Status (string) --
The job's status.
StatusMessage (string) --
The job's status message.
TemplateType (string) --
The job's template type.
Exceptions
Returns a list of nodes.
See also: AWS API Documentation
Request Syntax
response = client.list_nodes(
Category='BUSINESS_LOGIC'|'ML_MODEL'|'MEDIA_SOURCE'|'MEDIA_SINK',
MaxResults=123,
NextToken='string',
OwnerAccount='string',
PackageName='string',
PackageVersion='string',
PatchVersion='string'
)
dict
Response Syntax
{
'NextToken': 'string',
'Nodes': [
{
'Category': 'BUSINESS_LOGIC'|'ML_MODEL'|'MEDIA_SOURCE'|'MEDIA_SINK',
'CreatedTime': datetime(2015, 1, 1),
'Description': 'string',
'Name': 'string',
'NodeId': 'string',
'OwnerAccount': 'string',
'PackageArn': 'string',
'PackageId': 'string',
'PackageName': 'string',
'PackageVersion': 'string',
'PatchVersion': 'string'
},
]
}
Response Structure
(dict) --
NextToken (string) --
A pagination token that's included if more results are available.
Nodes (list) --
A list of nodes.
(dict) --
An application node that represents a camera stream, a model, code, or output.
Category (string) --
The node's category.
CreatedTime (datetime) --
When the node was created.
Description (string) --
The node's description.
Name (string) --
The node's name.
NodeId (string) --
The node's ID.
OwnerAccount (string) --
The account ID of the node's owner.
PackageArn (string) --
The node's ARN.
PackageId (string) --
The node's package ID.
PackageName (string) --
The node's package name.
PackageVersion (string) --
The node's package version.
PatchVersion (string) --
The node's patch version.
Exceptions
Returns a list of package import jobs.
See also: AWS API Documentation
Request Syntax
response = client.list_package_import_jobs(
MaxResults=123,
NextToken='string'
)
dict
Response Syntax
{
'NextToken': 'string',
'PackageImportJobs': [
{
'CreatedTime': datetime(2015, 1, 1),
'JobId': 'string',
'JobType': 'NODE_PACKAGE_VERSION'|'MARKETPLACE_NODE_PACKAGE_VERSION',
'LastUpdatedTime': datetime(2015, 1, 1),
'Status': 'PENDING'|'SUCCEEDED'|'FAILED',
'StatusMessage': 'string'
},
]
}
Response Structure
(dict) --
NextToken (string) --
A pagination token that's included if more results are available.
PackageImportJobs (list) --
A list of package import jobs.
(dict) --
A job to import a package version.
CreatedTime (datetime) --
When the job was created.
JobId (string) --
The job's ID.
JobType (string) --
The job's type.
LastUpdatedTime (datetime) --
When the job was updated.
Status (string) --
The job's status.
StatusMessage (string) --
The job's status message.
Exceptions
Returns a list of packages.
See also: AWS API Documentation
Request Syntax
response = client.list_packages(
MaxResults=123,
NextToken='string'
)
dict
Response Syntax
{
'NextToken': 'string',
'Packages': [
{
'Arn': 'string',
'CreatedTime': datetime(2015, 1, 1),
'PackageId': 'string',
'PackageName': 'string',
'Tags': {
'string': 'string'
}
},
]
}
Response Structure
(dict) --
NextToken (string) --
A pagination token that's included if more results are available.
Packages (list) --
A list of packages.
(dict) --
A package summary.
Arn (string) --
The package's ARN.
CreatedTime (datetime) --
When the package was created.
PackageId (string) --
The package's ID.
PackageName (string) --
The package's name.
Tags (dict) --
The package's tags.
Exceptions
Returns a list of tags for a resource.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
ResourceArn='string'
)
[REQUIRED]
The resource's ARN.
{
'Tags': {
'string': 'string'
}
}
Response Structure
A list of tags.
Exceptions
Creates a device and returns a configuration archive. The configuration archive is a ZIP file that contains a provisioning certificate that is valid for 5 minutes. Name the configuration archive certificates-omni_*device-name* .zip and transfer it to the device within 5 minutes. Use the included USB storage device and connect it to the USB 3.0 port next to the HDMI output.
See also: AWS API Documentation
Request Syntax
response = client.provision_device(
Description='string',
Name='string',
NetworkingConfiguration={
'Ethernet0': {
'ConnectionType': 'STATIC_IP'|'DHCP',
'StaticIpConnectionInfo': {
'DefaultGateway': 'string',
'Dns': [
'string',
],
'IpAddress': 'string',
'Mask': 'string'
}
},
'Ethernet1': {
'ConnectionType': 'STATIC_IP'|'DHCP',
'StaticIpConnectionInfo': {
'DefaultGateway': 'string',
'Dns': [
'string',
],
'IpAddress': 'string',
'Mask': 'string'
}
},
'Ntp': {
'NtpServers': [
'string',
]
}
},
Tags={
'string': 'string'
}
)
[REQUIRED]
A name for the device.
A networking configuration for the device.
Settings for Ethernet port 0.
How the device gets an IP address.
Network configuration for a static IP connection.
The connection's default gateway.
The connection's DNS address.
The connection's IP address.
The connection's DNS mask.
Settings for Ethernet port 1.
How the device gets an IP address.
Network configuration for a static IP connection.
The connection's default gateway.
The connection's DNS address.
The connection's IP address.
The connection's DNS mask.
Network time protocol (NTP) server settings.
NTP servers to use, in order of preference.
Tags for the device.
dict
Response Syntax
{
'Arn': 'string',
'Certificates': b'bytes',
'DeviceId': 'string',
'IotThingName': 'string',
'Status': 'AWAITING_PROVISIONING'|'PENDING'|'SUCCEEDED'|'FAILED'|'ERROR'|'DELETING'
}
Response Structure
(dict) --
Arn (string) --
The device's ARN.
Certificates (bytes) --
The device's configuration bundle.
DeviceId (string) --
The device's ID.
IotThingName (string) --
The device's IoT thing name.
Status (string) --
The device's status.
Exceptions
Registers a package version.
See also: AWS API Documentation
Request Syntax
response = client.register_package_version(
MarkLatest=True|False,
OwnerAccount='string',
PackageId='string',
PackageVersion='string',
PatchVersion='string'
)
[REQUIRED]
A package ID.
[REQUIRED]
A package version.
[REQUIRED]
A patch version.
dict
Response Syntax
{}
Response Structure
Exceptions
Removes an application instance.
See also: AWS API Documentation
Request Syntax
response = client.remove_application_instance(
ApplicationInstanceId='string'
)
[REQUIRED]
An application instance ID.
{}
Response Structure
Exceptions
Tags a resource.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
ResourceArn='string',
Tags={
'string': 'string'
}
)
[REQUIRED]
The resource's ARN.
[REQUIRED]
Tags for the resource.
dict
Response Syntax
{}
Response Structure
Exceptions
Removes tags from a resource.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
ResourceArn='string',
TagKeys=[
'string',
]
)
[REQUIRED]
The resource's ARN.
[REQUIRED]
Tag keys to remove.
dict
Response Syntax
{}
Response Structure
Exceptions
Updates a device's metadata.
See also: AWS API Documentation
Request Syntax
response = client.update_device_metadata(
Description='string',
DeviceId='string'
)
[REQUIRED]
The device's ID.
dict
Response Syntax
{
'DeviceId': 'string'
}
Response Structure
(dict) --
DeviceId (string) --
The device's ID.
Exceptions
The available paginators are: