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(
Name='string',
Description='string',
ManifestPayload={
'PayloadData': 'string'
},
ManifestOverridesPayload={
'PayloadData': 'string'
},
ApplicationInstanceIdToReplace='string',
RuntimeRoleArn='string',
DefaultRuntimeContextDevice='string',
Tags={
'string': 'string'
}
)
[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.
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]
A device's ID.
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': [
{
'JobId': 'string',
'DeviceId': 'string'
},
]
}
Response Structure
(dict) --
Jobs (list) --
A list of jobs.
(dict) --
A job for a device.
JobId (string) --
The job's ID.
DeviceId (string) --
The target device's ID.
Exceptions
Creates a camera stream node.
See also: AWS API Documentation
Request Syntax
response = client.create_node_from_template_job(
TemplateType='RTSP_CAMERA_STREAM',
OutputPackageName='string',
OutputPackageVersion='string',
NodeName='string',
NodeDescription='string',
TemplateParameters={
'string': 'string'
},
JobTags=[
{
'ResourceType': 'PACKAGE',
'Tags': {
'string': 'string'
}
},
]
)
[REQUIRED]
The type of node.
[REQUIRED]
An output package name for the node.
[REQUIRED]
An output package version for the node.
[REQUIRED]
A name for the node.
[REQUIRED]
Template parameters for the node.
Tags for the job.
Tags for a job.
The job's type.
The job's tags.
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
{
'PackageId': 'string',
'Arn': 'string',
'StorageLocation': {
'Bucket': 'string',
'RepoPrefixLocation': 'string',
'GeneratedPrefixLocation': 'string',
'BinaryPrefixLocation': 'string',
'ManifestPrefixLocation': 'string'
}
}
Response Structure
(dict) --
PackageId (string) --
The package's ID.
Arn (string) --
The package's ARN.
StorageLocation (dict) --
The package's storage location.
Bucket (string) --
The location's bucket.
RepoPrefixLocation (string) --
The location's repo prefix.
GeneratedPrefixLocation (string) --
The location's generated prefix.
BinaryPrefixLocation (string) --
The location's binary prefix.
ManifestPrefixLocation (string) --
The location's manifest prefix.
Exceptions
Imports a node package.
See also: AWS API Documentation
Request Syntax
response = client.create_package_import_job(
JobType='NODE_PACKAGE_VERSION',
InputConfig={
'PackageVersionInputConfig': {
'S3Location': {
'Region': 'string',
'BucketName': 'string',
'ObjectKey': 'string'
}
}
},
OutputConfig={
'PackageVersionOutputConfig': {
'PackageName': 'string',
'PackageVersion': 'string',
'MarkLatest': True|False
}
},
ClientToken='string',
JobTags=[
{
'ResourceType': 'PACKAGE',
'Tags': {
'string': 'string'
}
},
]
)
[REQUIRED]
A job type 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.
The bucket's Region.
A bucket name.
An object key.
[REQUIRED]
An output config for the package import job.
The package version's output configuration.
The output's package name.
The output's package version.
Indicates that the version is recommended for all users.
[REQUIRED]
A client token for the package import job.
Tags for the package import job.
Tags for a job.
The job's type.
The job's tags.
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.
See also: AWS API Documentation
Request Syntax
response = client.delete_package(
PackageId='string',
ForceDelete=True|False
)
[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.
{
'Name': 'string',
'Description': 'string',
'DefaultRuntimeContextDevice': 'string',
'DefaultRuntimeContextDeviceName': 'string',
'ApplicationInstanceIdToReplace': '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',
'HealthStatus': 'RUNNING'|'ERROR'|'NOT_AVAILABLE',
'StatusDescription': 'string',
'CreatedTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1),
'ApplicationInstanceId': 'string',
'Arn': 'string',
'Tags': {
'string': 'string'
}
}
Response Structure
The application instance's name.
The application instance's description.
The device's ID.
The device's bane.
The ID of the application instance that this instance replaced.
The application instance's runtime role ARN.
The application instance's status.
The application instance's health status.
The application instance's status description.
When the application instance was created.
The application instance was updated.
The application instance's ID.
The application instance's ARN.
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.
{
'Name': 'string',
'Description': 'string',
'DefaultRuntimeContextDevice': 'string',
'ManifestPayload': {
'PayloadData': 'string'
},
'ManifestOverridesPayload': {
'PayloadData': 'string'
},
'ApplicationInstanceIdToReplace': 'string',
'CreatedTime': datetime(2015, 1, 1),
'ApplicationInstanceId': 'string'
}
Response Structure
The application instance's name.
The application instance's description.
The application instance's default runtime context device.
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.
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 ID of the application instance that this instance replaced.
When the application instance was created.
The application instance's ID.
Exceptions
Returns information about a device.
See also: AWS API Documentation
Request Syntax
response = client.describe_device(
DeviceId='string'
)
[REQUIRED]
The device's ID.
{
'DeviceId': 'string',
'Name': 'string',
'Arn': 'string',
'Description': 'string',
'Type': 'PANORAMA_APPLIANCE_DEVELOPER_KIT'|'PANORAMA_APPLIANCE',
'DeviceConnectionStatus': 'ONLINE'|'OFFLINE'|'AWAITING_CREDENTIALS'|'NOT_AVAILABLE'|'ERROR',
'CreatedTime': datetime(2015, 1, 1),
'ProvisioningStatus': 'AWAITING_PROVISIONING'|'PENDING'|'SUCCEEDED'|'FAILED'|'ERROR'|'DELETING',
'LatestSoftware': 'string',
'CurrentSoftware': 'string',
'SerialNumber': 'string',
'Tags': {
'string': 'string'
},
'NetworkingConfiguration': {
'Ethernet0': {
'ConnectionType': 'STATIC_IP'|'DHCP',
'StaticIpConnectionInfo': {
'IpAddress': 'string',
'Mask': 'string',
'Dns': [
'string',
],
'DefaultGateway': 'string'
}
},
'Ethernet1': {
'ConnectionType': 'STATIC_IP'|'DHCP',
'StaticIpConnectionInfo': {
'IpAddress': 'string',
'Mask': 'string',
'Dns': [
'string',
],
'DefaultGateway': 'string'
}
}
},
'CurrentNetworkingStatus': {
'Ethernet0Status': {
'IpAddress': 'string',
'ConnectionStatus': 'CONNECTED'|'NOT_CONNECTED',
'HwAddress': 'string'
},
'Ethernet1Status': {
'IpAddress': 'string',
'ConnectionStatus': 'CONNECTED'|'NOT_CONNECTED',
'HwAddress': 'string'
}
},
'LeaseExpirationTime': datetime(2015, 1, 1)
}
Response Structure
The device's ID.
The device's name.
The device's ARN.
The device's description.
The device's type.
The device's connection status.
When the device was created.
The device's provisioning status.
The latest software version available for the device.
The device's current software version.
The device's serial number.
The device's tags.
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 IP address.
The connection's DNS mask.
The connection's DNS address.
The connection's default gateway.
Settings for Ethernet port 1.
How the device gets an IP address.
Network configuration for a static IP connection.
The connection's IP address.
The connection's DNS mask.
The connection's DNS address.
The connection's default gateway.
The device's networking status.
The status of Ethernet port 0.
The device's IP address.
The device's connection status.
The device's physical address.
The status of Ethernet port 1.
The device's IP address.
The device's connection status.
The device's physical address.
The device's lease expiration time.
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.
{
'JobId': 'string',
'DeviceId': 'string',
'DeviceArn': 'string',
'DeviceName': 'string',
'DeviceType': 'PANORAMA_APPLIANCE_DEVELOPER_KIT'|'PANORAMA_APPLIANCE',
'ImageVersion': 'string',
'Status': 'PENDING'|'IN_PROGRESS'|'VERIFYING'|'REBOOTING'|'DOWNLOADING'|'COMPLETED'|'FAILED',
'CreatedTime': datetime(2015, 1, 1)
}
Response Structure
The job's ID.
The device's ID.
The device's ARN.
The device's name.
The device's type.
For an OTA job, the target version of the device software.
The job's status.
When the job was created.
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
{
'NodeId': 'string',
'Name': 'string',
'Category': 'BUSINESS_LOGIC'|'ML_MODEL'|'MEDIA_SOURCE'|'MEDIA_SINK',
'OwnerAccount': 'string',
'PackageName': 'string',
'PackageId': 'string',
'PackageArn': 'string',
'PackageVersion': 'string',
'PatchVersion': 'string',
'NodeInterface': {
'Inputs': [
{
'Name': 'string',
'Description': 'string',
'Type': 'BOOLEAN'|'STRING'|'INT32'|'FLOAT32'|'MEDIA',
'DefaultValue': 'string',
'MaxConnections': 123
},
],
'Outputs': [
{
'Name': 'string',
'Description': 'string',
'Type': 'BOOLEAN'|'STRING'|'INT32'|'FLOAT32'|'MEDIA'
},
]
},
'AssetName': 'string',
'Description': 'string',
'CreatedTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
NodeId (string) --
The node's ID.
Name (string) --
The node's name.
Category (string) --
The node's category.
OwnerAccount (string) --
The account ID of the node's owner.
PackageName (string) --
The node's package name.
PackageId (string) --
The node's package ID.
PackageArn (string) --
The node's ARN.
PackageVersion (string) --
The node's package version.
PatchVersion (string) --
The node's patch version.
NodeInterface (dict) --
The node's interface.
Inputs (list) --
The node interface's inputs.
(dict) --
A node input port.
Name (string) --
The input port's name.
Description (string) --
The input port's description.
Type (string) --
The input port's type.
DefaultValue (string) --
The input port's default value.
MaxConnections (integer) --
The input port's max connections.
Outputs (list) --
The node interface's outputs.
(dict) --
A node output port.
Name (string) --
The output port's name.
Description (string) --
The output port's description.
Type (string) --
The output port's type.
AssetName (string) --
The node's asset name.
Description (string) --
The node's description.
CreatedTime (datetime) --
When the node was created.
LastUpdatedTime (datetime) --
When the node was updated.
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.
{
'JobId': 'string',
'Status': 'PENDING'|'SUCCEEDED'|'FAILED',
'StatusMessage': 'string',
'CreatedTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1),
'OutputPackageName': 'string',
'OutputPackageVersion': 'string',
'NodeName': 'string',
'NodeDescription': 'string',
'TemplateType': 'RTSP_CAMERA_STREAM',
'TemplateParameters': {
'string': 'string'
},
'JobTags': [
{
'ResourceType': 'PACKAGE',
'Tags': {
'string': 'string'
}
},
]
}
Response Structure
The job's ID.
The job's status.
The job's status message.
When the job was created.
When the job was updated.
The job's output package name.
The job's output package version.
The node's name.
The node's description.
The job's template type.
The job's template parameters.
The job's tags.
Tags for a job.
The job's type.
The job's tags.
Exceptions
Returns information about a package.
See also: AWS API Documentation
Request Syntax
response = client.describe_package(
PackageId='string'
)
[REQUIRED]
The package's ID.
{
'PackageId': 'string',
'PackageName': 'string',
'Arn': 'string',
'StorageLocation': {
'Bucket': 'string',
'RepoPrefixLocation': 'string',
'GeneratedPrefixLocation': 'string',
'BinaryPrefixLocation': 'string',
'ManifestPrefixLocation': 'string'
},
'ReadAccessPrincipalArns': [
'string',
],
'WriteAccessPrincipalArns': [
'string',
],
'CreatedTime': datetime(2015, 1, 1),
'Tags': {
'string': 'string'
}
}
Response Structure
The package's ID.
The package's name.
The package's ARN.
The package's storage location.
The location's bucket.
The location's repo prefix.
The location's generated prefix.
The location's binary prefix.
The location's manifest prefix.
ARNs of accounts that have read access to the package.
ARNs of accounts that have write access to the package.
When the package was created.
The package's tags.
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.
{
'JobId': 'string',
'ClientToken': 'string',
'JobType': 'NODE_PACKAGE_VERSION',
'InputConfig': {
'PackageVersionInputConfig': {
'S3Location': {
'Region': 'string',
'BucketName': 'string',
'ObjectKey': 'string'
}
}
},
'OutputConfig': {
'PackageVersionOutputConfig': {
'PackageName': 'string',
'PackageVersion': 'string',
'MarkLatest': True|False
}
},
'Output': {
'PackageId': 'string',
'PackageVersion': 'string',
'PatchVersion': 'string',
'OutputS3Location': {
'BucketName': 'string',
'ObjectKey': 'string'
}
},
'CreatedTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1),
'Status': 'PENDING'|'SUCCEEDED'|'FAILED',
'StatusMessage': 'string',
'JobTags': [
{
'ResourceType': 'PACKAGE',
'Tags': {
'string': 'string'
}
},
]
}
Response Structure
The job's ID.
The job's client token.
The job's type.
The job's input config.
The package version's input configuration.
A location in Amazon S3.
The bucket's Region.
A bucket name.
An object key.
The job's output config.
The package version's output configuration.
The output's package name.
The output's package version.
Indicates that the version is recommended for all users.
The job's output.
The package's ID.
The package's version.
The package's patch version.
The package's output location.
The object's bucket.
The object's key.
When the job was created.
When the job was updated.
The job's status.
The job's status message.
The job's tags.
Tags for a job.
The job's type.
The job's tags.
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
{
'OwnerAccount': 'string',
'PackageId': 'string',
'PackageArn': 'string',
'PackageName': 'string',
'PackageVersion': 'string',
'PatchVersion': 'string',
'IsLatestPatch': True|False,
'Status': 'REGISTER_PENDING'|'REGISTER_COMPLETED'|'FAILED'|'DELETING',
'StatusDescription': 'string',
'RegisteredTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
OwnerAccount (string) --
The account ID of the version's owner.
PackageId (string) --
The version's ID.
PackageArn (string) --
The ARN of the package.
PackageName (string) --
The version's name.
PackageVersion (string) --
The version's version.
PatchVersion (string) --
The version's patch version.
IsLatestPatch (boolean) --
Whether the version is the latest available.
Status (string) --
The version's status.
StatusDescription (string) --
The version's status description.
RegisteredTime (datetime) --
The version's registered time.
Exceptions
Generate a presigned url given a client, its method, and arguments
The presigned url
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
{
'PackageObjects': [
{
'Name': 'string',
'PackageVersion': 'string',
'PatchVersion': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
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.
NextToken (string) --
A pagination token that's included if more results are available.
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
{
'NodeInstances': [
{
'NodeInstanceId': 'string',
'NodeId': 'string',
'PackageName': 'string',
'PackageVersion': 'string',
'PackagePatchVersion': 'string',
'NodeName': 'string',
'CurrentStatus': 'RUNNING'|'ERROR'|'NOT_AVAILABLE'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
NodeInstances (list) --
A list of node instances.
(dict) --
A node instance.
NodeInstanceId (string) --
The instance's ID.
NodeId (string) --
The node's ID.
PackageName (string) --
The instance's package name.
PackageVersion (string) --
The instance's package version.
PackagePatchVersion (string) --
The instance's package patch version.
NodeName (string) --
The instance's name.
CurrentStatus (string) --
The instance's current status.
NextToken (string) --
A pagination token that's included if more results are available.
Exceptions
Returns a list of application instances.
See also: AWS API Documentation
Request Syntax
response = client.list_application_instances(
DeviceId='string',
StatusFilter='DEPLOYMENT_SUCCEEDED'|'DEPLOYMENT_ERROR'|'REMOVAL_SUCCEEDED'|'REMOVAL_FAILED'|'PROCESSING_DEPLOYMENT'|'PROCESSING_REMOVAL',
MaxResults=123,
NextToken='string'
)
dict
Response Syntax
{
'ApplicationInstances': [
{
'Name': 'string',
'ApplicationInstanceId': 'string',
'DefaultRuntimeContextDevice': 'string',
'DefaultRuntimeContextDeviceName': 'string',
'Description': 'string',
'Status': 'DEPLOYMENT_PENDING'|'DEPLOYMENT_REQUESTED'|'DEPLOYMENT_IN_PROGRESS'|'DEPLOYMENT_ERROR'|'DEPLOYMENT_SUCCEEDED'|'REMOVAL_PENDING'|'REMOVAL_REQUESTED'|'REMOVAL_IN_PROGRESS'|'REMOVAL_FAILED'|'REMOVAL_SUCCEEDED',
'HealthStatus': 'RUNNING'|'ERROR'|'NOT_AVAILABLE',
'StatusDescription': 'string',
'CreatedTime': datetime(2015, 1, 1),
'Arn': 'string',
'Tags': {
'string': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ApplicationInstances (list) --
A list of application instances.
(dict) --
An application instance on a device.
Name (string) --
The application instance's name.
ApplicationInstanceId (string) --
The application instance's ID.
DefaultRuntimeContextDevice (string) --
The device's ID.
DefaultRuntimeContextDeviceName (string) --
The device's name.
Description (string) --
The application instance's description.
Status (string) --
The application instance's status.
HealthStatus (string) --
The application instance's health status.
StatusDescription (string) --
The application instance's status description.
CreatedTime (datetime) --
When the application instance was created.
Arn (string) --
The application instance's ARN.
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(
NextToken='string',
MaxResults=123
)
dict
Response Syntax
{
'Devices': [
{
'DeviceId': 'string',
'Name': 'string',
'CreatedTime': datetime(2015, 1, 1),
'ProvisioningStatus': 'AWAITING_PROVISIONING'|'PENDING'|'SUCCEEDED'|'FAILED'|'ERROR'|'DELETING',
'LastUpdatedTime': datetime(2015, 1, 1),
'LeaseExpirationTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Devices (list) --
A list of devices.
(dict) --
A device.
DeviceId (string) --
The device's ID.
Name (string) --
The device's name.
CreatedTime (datetime) --
When the device was created.
ProvisioningStatus (string) --
The device's provisioning status.
LastUpdatedTime (datetime) --
When the device was updated.
LeaseExpirationTime (datetime) --
The device's lease expiration time.
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',
NextToken='string',
MaxResults=123
)
dict
Response Syntax
{
'DeviceJobs': [
{
'DeviceName': 'string',
'DeviceId': 'string',
'JobId': 'string',
'CreatedTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
DeviceJobs (list) --
A list of jobs.
(dict) --
A job that runs on a device.
DeviceName (string) --
The name of the target device
DeviceId (string) --
The ID of the target device.
JobId (string) --
The job's ID.
CreatedTime (datetime) --
When the job was created.
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(
NextToken='string',
MaxResults=123
)
dict
Response Syntax
{
'NodeFromTemplateJobs': [
{
'JobId': 'string',
'TemplateType': 'RTSP_CAMERA_STREAM',
'Status': 'PENDING'|'SUCCEEDED'|'FAILED',
'StatusMessage': 'string',
'CreatedTime': datetime(2015, 1, 1),
'NodeName': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
NodeFromTemplateJobs (list) --
A list of jobs.
(dict) --
A job to create a camera stream node.
JobId (string) --
The job's ID.
TemplateType (string) --
The job's template type.
Status (string) --
The job's status.
StatusMessage (string) --
The job's status message.
CreatedTime (datetime) --
When the job was created.
NodeName (string) --
The node's name.
NextToken (string) --
A pagination token that's included if more results are available.
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',
OwnerAccount='string',
PackageName='string',
PackageVersion='string',
PatchVersion='string',
NextToken='string',
MaxResults=123
)
dict
Response Syntax
{
'Nodes': [
{
'NodeId': 'string',
'Name': 'string',
'Category': 'BUSINESS_LOGIC'|'ML_MODEL'|'MEDIA_SOURCE'|'MEDIA_SINK',
'OwnerAccount': 'string',
'PackageName': 'string',
'PackageId': 'string',
'PackageArn': 'string',
'PackageVersion': 'string',
'PatchVersion': 'string',
'Description': 'string',
'CreatedTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Nodes (list) --
A list of nodes.
(dict) --
An application node that represents a camera stream, a model, code, or output.
NodeId (string) --
The node's ID.
Name (string) --
The node's name.
Category (string) --
The node's category.
OwnerAccount (string) --
The account ID of the node's owner.
PackageName (string) --
The node's package name.
PackageId (string) --
The node's package ID.
PackageArn (string) --
The node's ARN.
PackageVersion (string) --
The node's package version.
PatchVersion (string) --
The node's patch version.
Description (string) --
The node's description.
CreatedTime (datetime) --
When the node was created.
NextToken (string) --
A pagination token that's included if more results are available.
Exceptions
Returns a list of package import jobs.
See also: AWS API Documentation
Request Syntax
response = client.list_package_import_jobs(
NextToken='string',
MaxResults=123
)
dict
Response Syntax
{
'PackageImportJobs': [
{
'JobId': 'string',
'JobType': 'NODE_PACKAGE_VERSION',
'Status': 'PENDING'|'SUCCEEDED'|'FAILED',
'StatusMessage': 'string',
'CreatedTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
PackageImportJobs (list) --
A list of package import jobs.
(dict) --
A job to import a package version.
JobId (string) --
The job's ID.
JobType (string) --
The job's type.
Status (string) --
The job's status.
StatusMessage (string) --
The job's status message.
CreatedTime (datetime) --
When the job was created.
LastUpdatedTime (datetime) --
When the job was updated.
NextToken (string) --
A pagination token that's included if more results are available.
Exceptions
Returns a list of packages.
See also: AWS API Documentation
Request Syntax
response = client.list_packages(
MaxResults=123,
NextToken='string'
)
dict
Response Syntax
{
'Packages': [
{
'PackageId': 'string',
'PackageName': 'string',
'Arn': 'string',
'CreatedTime': datetime(2015, 1, 1),
'Tags': {
'string': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Packages (list) --
A list of packages.
(dict) --
A package summary.
PackageId (string) --
The package's ID.
PackageName (string) --
The package's name.
Arn (string) --
The package's ARN.
CreatedTime (datetime) --
When the package was created.
Tags (dict) --
The package's tags.
NextToken (string) --
A pagination token that's included if more results are available.
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. Transfer the configuration archive to the device with the included USB storage device within 5 minutes.
See also: AWS API Documentation
Request Syntax
response = client.provision_device(
Name='string',
Description='string',
Tags={
'string': 'string'
},
NetworkingConfiguration={
'Ethernet0': {
'ConnectionType': 'STATIC_IP'|'DHCP',
'StaticIpConnectionInfo': {
'IpAddress': 'string',
'Mask': 'string',
'Dns': [
'string',
],
'DefaultGateway': 'string'
}
},
'Ethernet1': {
'ConnectionType': 'STATIC_IP'|'DHCP',
'StaticIpConnectionInfo': {
'IpAddress': 'string',
'Mask': 'string',
'Dns': [
'string',
],
'DefaultGateway': 'string'
}
}
}
)
[REQUIRED]
A name for the device.
Tags 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 IP address.
The connection's DNS mask.
The connection's DNS address.
The connection's default gateway.
Settings for Ethernet port 1.
How the device gets an IP address.
Network configuration for a static IP connection.
The connection's IP address.
The connection's DNS mask.
The connection's DNS address.
The connection's default gateway.
dict
Response Syntax
{
'DeviceId': 'string',
'Arn': 'string',
'Status': 'AWAITING_PROVISIONING'|'PENDING'|'SUCCEEDED'|'FAILED'|'ERROR'|'DELETING',
'Certificates': b'bytes',
'IotThingName': 'string'
}
Response Structure
(dict) --
DeviceId (string) --
The device's ID.
Arn (string) --
The device's ARN.
Status (string) --
The device's status.
Certificates (bytes) --
The device's configuration bundle.
IotThingName (string) --
The device's IoT thing name.
Exceptions
Registers a package version.
See also: AWS API Documentation
Request Syntax
response = client.register_package_version(
OwnerAccount='string',
PackageId='string',
PackageVersion='string',
PatchVersion='string',
MarkLatest=True|False
)
[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(
DeviceId='string',
Description='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: