Panorama ¶

Table of Contents

Panorama
- Client
- Paginators

Client ¶

class Panorama.Client¶

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:

can_paginate()
close()
create_application_instance()
create_job_for_devices()
create_node_from_template_job()
create_package()
create_package_import_job()
delete_device()
delete_package()
deregister_package_version()
describe_application_instance()
describe_application_instance_details()
describe_device()
describe_device_job()
describe_node()
describe_node_from_template_job()
describe_package()
describe_package_import_job()
describe_package_version()
get_paginator()
get_waiter()
list_application_instance_dependencies()
list_application_instance_node_instances()
list_application_instances()
list_devices()
list_devices_jobs()
list_node_from_template_jobs()
list_nodes()
list_package_import_jobs()
list_packages()
list_tags_for_resource()
provision_device()
register_package_version()
remove_application_instance()
signal_application_instance_node_instances()
tag_resource()
untag_resource()
update_device_metadata()

can_paginate(operation_name)¶

Check if an operation can be paginated.

Parameters: operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns: True if the operation can be paginated, False otherwise.

close()¶: Closes underlying endpoint connections.

create_application_instance(**kwargs)¶

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'
    }
)

Parameters

ApplicationInstanceIdToReplace (string) -- The ID of an application instance to replace with the new instance.
DefaultRuntimeContextDevice (string) --
[REQUIRED]

A device's ID.
Description (string) -- A description for the application instance.
ManifestOverridesPayload (dict) --
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.
- PayloadData (string) --
  The overrides document.
ManifestPayload (dict) --
[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.
- PayloadData (string) --
  The application manifest.
Name (string) -- A name for the application instance.
RuntimeRoleArn (string) -- The ARN of a runtime role for the application instance.
Tags (dict) --
Tags for the application instance.
- (string) --
  - (string) --

Return type

dict

Returns

Response Syntax

{
    'ApplicationInstanceId': 'string'
}

Response Structure

(dict) --
- ApplicationInstanceId (string) --
  
  The application instance's ID.

Exceptions

Panorama.Client.exceptions.ValidationException
Panorama.Client.exceptions.AccessDeniedException
Panorama.Client.exceptions.ServiceQuotaExceededException
Panorama.Client.exceptions.InternalServerException

create_job_for_devices(**kwargs)¶

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

See also: AWS API Documentation

Request Syntax

response = client.create_job_for_devices(
    DeviceIds=[
        'string',
    ],
    DeviceJobConfig={
        'OTAJobConfig': {
            'ImageVersion': 'string'
        }
    },
    JobType='OTA'|'REBOOT'
)

Parameters

DeviceIds (list) --
[REQUIRED]

IDs of target devices.
- (string) --
DeviceJobConfig (dict) --
Configuration settings for a software update job.
- OTAJobConfig (dict) --
  A configuration for an over-the-air (OTA) upgrade. Required for OTA jobs.
  - ImageVersion (string) -- [REQUIRED]
    The target version of the device software.
JobType (string) --
[REQUIRED]

The type of job to run.

Return type

dict

Returns

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

Panorama.Client.exceptions.ConflictException
Panorama.Client.exceptions.ValidationException
Panorama.Client.exceptions.AccessDeniedException
Panorama.Client.exceptions.ResourceNotFoundException
Panorama.Client.exceptions.InternalServerException

create_node_from_template_job(**kwargs)¶

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'
)

Parameters

JobTags (list) --
Tags for the job.
- (dict) --
  Tags for a job.
  - ResourceType (string) -- [REQUIRED]
    The job's type.
  - Tags (dict) -- [REQUIRED]
    The job's tags.
    - (string) --
      - (string) --
NodeDescription (string) -- A description for the node.
NodeName (string) --
[REQUIRED]

A name for the node.
OutputPackageName (string) --
[REQUIRED]

An output package name for the node.
OutputPackageVersion (string) --
[REQUIRED]

An output package version for the node.
TemplateParameters (dict) --
[REQUIRED]

Template parameters for the node.
- (string) --
  - (string) --
TemplateType (string) --
[REQUIRED]

The type of node.

Return type

dict

Returns

Response Syntax

{
    'JobId': 'string'
}

Response Structure

(dict) --
- JobId (string) --
  
  The job's ID.

Exceptions

Panorama.Client.exceptions.ConflictException
Panorama.Client.exceptions.ValidationException
Panorama.Client.exceptions.AccessDeniedException
Panorama.Client.exceptions.InternalServerException

create_package(**kwargs)¶

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'
    }
)

Parameters

PackageName (string) --
[REQUIRED]

A name for the package.
Tags (dict) --
Tags for the package.
- (string) --
  - (string) --

Return type

dict

Returns

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

Panorama.Client.exceptions.ConflictException
Panorama.Client.exceptions.ValidationException
Panorama.Client.exceptions.AccessDeniedException
Panorama.Client.exceptions.InternalServerException

create_package_import_job(**kwargs)¶

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'
        }
    }
)

Parameters

ClientToken (string) --
[REQUIRED]

A client token for the package import job.
InputConfig (dict) --
[REQUIRED]

An input config for the package import job.
- PackageVersionInputConfig (dict) --
  The package version's input configuration.
  - S3Location (dict) -- [REQUIRED]
    A location in Amazon S3.
    - BucketName (string) -- [REQUIRED]
      A bucket name.
    - ObjectKey (string) -- [REQUIRED]
      An object key.
    - Region (string) --
      The bucket's Region.
JobTags (list) --
Tags for the package import job.
- (dict) --
  Tags for a job.
  - ResourceType (string) -- [REQUIRED]
    The job's type.
  - Tags (dict) -- [REQUIRED]
    The job's tags.
    - (string) --
      - (string) --
JobType (string) --
[REQUIRED]

A job type for the package import job.
OutputConfig (dict) --
[REQUIRED]

An output config for the package import job.
- PackageVersionOutputConfig (dict) --
  The package version's output configuration.
  - MarkLatest (boolean) --
    Indicates that the version is recommended for all users.
  - PackageName (string) -- [REQUIRED]
    The output's package name.
  - PackageVersion (string) -- [REQUIRED]
    The output's package version.

Return type

dict

Returns

Response Syntax

{
    'JobId': 'string'
}

Response Structure

(dict) --
- JobId (string) --
  
  The job's ID.

Exceptions

Panorama.Client.exceptions.ConflictException
Panorama.Client.exceptions.ValidationException
Panorama.Client.exceptions.AccessDeniedException
Panorama.Client.exceptions.InternalServerException

delete_device(**kwargs)¶

Deletes a device.

See also: AWS API Documentation

Request Syntax

response = client.delete_device(
    DeviceId='string'
)

Parameters

DeviceId (string) --

[REQUIRED]

The device's ID.

Return type

dict

Returns

Response Syntax

{
    'DeviceId': 'string'
}

Response Structure

(dict) --
- DeviceId (string) --
  The device's ID.

Exceptions

Panorama.Client.exceptions.ConflictException
Panorama.Client.exceptions.ValidationException
Panorama.Client.exceptions.AccessDeniedException
Panorama.Client.exceptions.ResourceNotFoundException
Panorama.Client.exceptions.InternalServerException

delete_package(**kwargs)¶

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'
)

Parameters

ForceDelete (boolean) -- Delete the package even if it has artifacts stored in its access point. Deletes the package's artifacts from Amazon S3.
PackageId (string) --
[REQUIRED]

The package's ID.

Return type

dict

Returns

Response Syntax

{}

Response Structure

(dict) --

Exceptions

Panorama.Client.exceptions.ConflictException
Panorama.Client.exceptions.ValidationException
Panorama.Client.exceptions.AccessDeniedException
Panorama.Client.exceptions.ResourceNotFoundException
Panorama.Client.exceptions.InternalServerException

deregister_package_version(**kwargs)¶

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'
)

Parameters

OwnerAccount (string) -- An owner account.
PackageId (string) --
[REQUIRED]

A package ID.
PackageVersion (string) --
[REQUIRED]

A package version.
PatchVersion (string) --
[REQUIRED]

A patch version.
UpdatedLatestPatchVersion (string) -- If the version was marked latest, the new version to maker as latest.

Return type

dict

Returns

Response Syntax

{}

Response Structure

(dict) --

Exceptions

Panorama.Client.exceptions.ConflictException
Panorama.Client.exceptions.ValidationException
Panorama.Client.exceptions.AccessDeniedException
Panorama.Client.exceptions.ResourceNotFoundException
Panorama.Client.exceptions.InternalServerException

describe_application_instance(**kwargs)¶

Returns information about an application instance on a device.

See also: AWS API Documentation

Request Syntax

response = client.describe_application_instance(
    ApplicationInstanceId='string'
)

Parameters

ApplicationInstanceId (string) --

[REQUIRED]

The application instance's ID.

Return type

dict

Returns

Response Syntax

{
    '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',
    'RuntimeContextStates': [
        {
            'DesiredState': 'RUNNING'|'STOPPED'|'REMOVED',
            'DeviceReportedStatus': 'STOPPING'|'STOPPED'|'STOP_ERROR'|'REMOVAL_FAILED'|'REMOVAL_IN_PROGRESS'|'STARTING'|'RUNNING'|'INSTALL_ERROR'|'LAUNCHED'|'LAUNCH_ERROR'|'INSTALL_IN_PROGRESS',
            'DeviceReportedTime': datetime(2015, 1, 1),
            'RuntimeContextName': '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

(dict) --
- ApplicationInstanceId (string) --
  The application instance's ID.
- ApplicationInstanceIdToReplace (string) --
  The ID of the application instance that this instance replaced.
- 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 bane.
- Description (string) --
  The application instance's description.
- HealthStatus (string) --
  The application instance's health status.
- LastUpdatedTime (datetime) --
  The application instance was updated.
- Name (string) --
  The application instance's name.
- RuntimeContextStates (list) --
  The application instance's state.
  - (dict) --
    An application instance's state.
    - DesiredState (string) --
      The application's desired state.
    - DeviceReportedStatus (string) --
      The application's reported status.
    - DeviceReportedTime (datetime) --
      When the device reported the application's state.
    - RuntimeContextName (string) --
      The device's name.
- RuntimeRoleArn (string) --
  The application instance's runtime role ARN.
- Status (string) --
  The application instance's status.
- StatusDescription (string) --
  The application instance's status description.
- Tags (dict) --
  The application instance's tags.
  - (string) --
    - (string) --

Exceptions

Panorama.Client.exceptions.ConflictException
Panorama.Client.exceptions.ValidationException
Panorama.Client.exceptions.AccessDeniedException
Panorama.Client.exceptions.ResourceNotFoundException
Panorama.Client.exceptions.InternalServerException

describe_application_instance_details(**kwargs)¶

Returns information about an application instance's configuration manifest.

See also: AWS API Documentation

Request Syntax

response = client.describe_application_instance_details(
    ApplicationInstanceId='string'
)

Parameters

ApplicationInstanceId (string) --

[REQUIRED]

The application instance's ID.

Return type

dict

Returns

Response Syntax

{
    'ApplicationInstanceId': 'string',
    'ApplicationInstanceIdToReplace': 'string',
    'CreatedTime': datetime(2015, 1, 1),
    'DefaultRuntimeContextDevice': 'string',
    'Description': 'string',
    'ManifestOverridesPayload': {
        'PayloadData': 'string'
    },
    'ManifestPayload': {
        'PayloadData': 'string'
    },
    'Name': 'string'
}

Response Structure

(dict) --
- ApplicationInstanceId (string) --
  The application instance's ID.
- ApplicationInstanceIdToReplace (string) --
  The ID of the application instance that this instance replaced.
- CreatedTime (datetime) --
  When the application instance was created.
- DefaultRuntimeContextDevice (string) --
  The application instance's default runtime context device.
- Description (string) --
  The application instance's description.
- ManifestOverridesPayload (dict) --
  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'}
  - PayloadData (string) --
    The overrides document.
- ManifestPayload (dict) --
  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'}
  - PayloadData (string) --
    The application manifest.
- Name (string) --
  The application instance's name.

Exceptions

Panorama.Client.exceptions.ConflictException
Panorama.Client.exceptions.ValidationException
Panorama.Client.exceptions.AccessDeniedException
Panorama.Client.exceptions.ResourceNotFoundException
Panorama.Client.exceptions.InternalServerException

describe_device(**kwargs)¶

Returns information about a device.

See also: AWS API Documentation

Request Syntax

response = client.describe_device(
    DeviceId='string'
)

Parameters

DeviceId (string) --

[REQUIRED]

The device's ID.

Return type

dict

Returns

Response Syntax

{
    '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',
    'DeviceAggregatedStatus': 'ERROR'|'AWAITING_PROVISIONING'|'PENDING'|'FAILED'|'DELETING'|'ONLINE'|'OFFLINE'|'LEASE_EXPIRED'|'UPDATE_NEEDED'|'REBOOTING',
    'DeviceConnectionStatus': 'ONLINE'|'OFFLINE'|'AWAITING_CREDENTIALS'|'NOT_AVAILABLE'|'ERROR',
    'DeviceId': 'string',
    'LatestAlternateSoftware': 'string',
    'LatestDeviceJob': {
        'ImageVersion': 'string',
        'JobType': 'OTA'|'REBOOT',
        'Status': 'PENDING'|'IN_PROGRESS'|'VERIFYING'|'REBOOTING'|'DOWNLOADING'|'COMPLETED'|'FAILED'
    },
    '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

(dict) --
- AlternateSoftwares (list) --
  Beta software releases available for the device.
  - (dict) --
    Details about a beta appliance software update.
    - Version (string) --
      The appliance software version.
- Arn (string) --
  The device's ARN.
- Brand (string) --
  The device's maker.
- CreatedTime (datetime) --
  When the device was created.
- CurrentNetworkingStatus (dict) --
  The device's networking status.
  - Ethernet0Status (dict) --
    The status of Ethernet port 0.
    - ConnectionStatus (string) --
      The device's connection status.
    - HwAddress (string) --
      The device's physical address.
    - IpAddress (string) --
      The device's IP address.
  - Ethernet1Status (dict) --
    The status of Ethernet port 1.
    - ConnectionStatus (string) --
      The device's connection status.
    - HwAddress (string) --
      The device's physical address.
    - IpAddress (string) --
      The device's IP address.
  - LastUpdatedTime (datetime) --
    When the network status changed.
  - NtpStatus (dict) --
    Details about a network time protocol (NTP) server connection.
    - ConnectionStatus (string) --
      The connection's status.
    - IpAddress (string) --
      The IP address of the server.
    - NtpServerName (string) --
      The domain name of the server.
- CurrentSoftware (string) --
  The device's current software version.
- Description (string) --
  The device's description.
- DeviceAggregatedStatus (string) --
  A device's aggregated status. Including the device's connection status, provisioning status, and lease status.
- DeviceConnectionStatus (string) --
  The device's connection status.
- DeviceId (string) --
  The device's ID.
- LatestAlternateSoftware (string) --
  The most recent beta software release.
- LatestDeviceJob (dict) --
  A device's latest job. Includes the target image version, and the job status.
  - ImageVersion (string) --
    The target version of the device software.
  - JobType (string) --
    The job's type.
  - Status (string) --
    Status of the latest device job.
- LatestSoftware (string) --
  The latest software version available for the device.
- LeaseExpirationTime (datetime) --
  The device's lease expiration time.
- Name (string) --
  The device's name.
- NetworkingConfiguration (dict) --
  The device's networking configuration.
  - Ethernet0 (dict) --
    Settings for Ethernet port 0.
    - ConnectionType (string) --
      How the device gets an IP address.
    - StaticIpConnectionInfo (dict) --
      Network configuration for a static IP connection.
      - DefaultGateway (string) --
        The connection's default gateway.
      - Dns (list) --
        The connection's DNS address.
        
        (string) --
      - IpAddress (string) --
        The connection's IP address.
      - Mask (string) --
        The connection's DNS mask.
  - Ethernet1 (dict) --
    Settings for Ethernet port 1.
    - ConnectionType (string) --
      How the device gets an IP address.
    - StaticIpConnectionInfo (dict) --
      Network configuration for a static IP connection.
      - DefaultGateway (string) --
        The connection's default gateway.
      - Dns (list) --
        The connection's DNS address.
        
        (string) --
      - IpAddress (string) --
        The connection's IP address.
      - Mask (string) --
        The connection's DNS mask.
  - Ntp (dict) --
    Network time protocol (NTP) server settings.
    - NtpServers (list) --
      NTP servers to use, in order of preference.
      - (string) --
- ProvisioningStatus (string) --
  The device's provisioning status.
- SerialNumber (string) --
  The device's serial number.
- Tags (dict) --
  The device's tags.
  - (string) --
    - (string) --
- Type (string) --
  The device's type.

Exceptions

Panorama.Client.exceptions.ValidationException
Panorama.Client.exceptions.AccessDeniedException
Panorama.Client.exceptions.ResourceNotFoundException
Panorama.Client.exceptions.InternalServerException

describe_device_job(**kwargs)¶

Returns information about a device job.

See also: AWS API Documentation

Request Syntax

response = client.describe_device_job(
    JobId='string'
)

Parameters

JobId (string) --

[REQUIRED]

The job's ID.

Return type

dict

Returns

Response Syntax

{
    'CreatedTime': datetime(2015, 1, 1),
    'DeviceArn': 'string',
    'DeviceId': 'string',
    'DeviceName': 'string',
    'DeviceType': 'PANORAMA_APPLIANCE_DEVELOPER_KIT'|'PANORAMA_APPLIANCE',
    'ImageVersion': 'string',
    'JobId': 'string',
    'JobType': 'OTA'|'REBOOT',
    'Status': 'PENDING'|'IN_PROGRESS'|'VERIFYING'|'REBOOTING'|'DOWNLOADING'|'COMPLETED'|'FAILED'
}

Response Structure

(dict) --
- CreatedTime (datetime) --
  When the job was created.
- DeviceArn (string) --
  The device's ARN.
- DeviceId (string) --
  The device's ID.
- DeviceName (string) --
  The device's name.
- DeviceType (string) --
  The device's type.
- ImageVersion (string) --
  For an OTA job, the target version of the device software.
- JobId (string) --
  The job's ID.
- JobType (string) --
  The job's type.
- Status (string) --
  The job's status.

Exceptions

Panorama.Client.exceptions.ConflictException
Panorama.Client.exceptions.ValidationException
Panorama.Client.exceptions.AccessDeniedException
Panorama.Client.exceptions.ResourceNotFoundException
Panorama.Client.exceptions.InternalServerException

describe_node(**kwargs)¶

Returns information about a node.

See also: AWS API Documentation

Request Syntax

response = client.describe_node(
    NodeId='string',
    OwnerAccount='string'
)

Parameters

NodeId (string) --
[REQUIRED]

The node's ID.
OwnerAccount (string) -- The account ID of the node's owner.

Return type

dict

Returns

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

Panorama.Client.exceptions.ConflictException
Panorama.Client.exceptions.ValidationException
Panorama.Client.exceptions.AccessDeniedException
Panorama.Client.exceptions.ResourceNotFoundException
Panorama.Client.exceptions.InternalServerException

describe_node_from_template_job(**kwargs)¶

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'
)

Parameters

JobId (string) --

[REQUIRED]

The job's ID.

Return type

dict

Returns

Response Syntax

{
    '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

(dict) --
- CreatedTime (datetime) --
  When the job was created.
- JobId (string) --
  The job's ID.
- JobTags (list) --
  The job's tags.
  - (dict) --
    Tags for a job.
    - ResourceType (string) --
      The job's type.
    - Tags (dict) --
      The job's tags.
      - (string) --
        
        (string) --
- LastUpdatedTime (datetime) --
  When the job was updated.
- NodeDescription (string) --
  The node's description.
- NodeName (string) --
  The node's name.
- OutputPackageName (string) --
  The job's output package name.
- OutputPackageVersion (string) --
  The job's output package version.
- Status (string) --
  The job's status.
- StatusMessage (string) --
  The job's status message.
- TemplateParameters (dict) --
  The job's template parameters.
  - (string) --
    - (string) --
- TemplateType (string) --
  The job's template type.

Exceptions

Panorama.Client.exceptions.ConflictException
Panorama.Client.exceptions.ValidationException
Panorama.Client.exceptions.AccessDeniedException
Panorama.Client.exceptions.InternalServerException

describe_package(**kwargs)¶

Returns information about a package.

See also: AWS API Documentation

Request Syntax

response = client.describe_package(
    PackageId='string'
)

Parameters

PackageId (string) --

[REQUIRED]

The package's ID.

Return type

dict

Returns

Response Syntax

{
    '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

(dict) --
- 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.
- ReadAccessPrincipalArns (list) --
  ARNs of accounts that have read access to the package.
  - (string) --
- 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.
- Tags (dict) --
  The package's tags.
  - (string) --
    - (string) --
- WriteAccessPrincipalArns (list) --
  ARNs of accounts that have write access to the package.
  - (string) --

Exceptions

Panorama.Client.exceptions.ConflictException
Panorama.Client.exceptions.ValidationException
Panorama.Client.exceptions.AccessDeniedException
Panorama.Client.exceptions.ResourceNotFoundException
Panorama.Client.exceptions.InternalServerException

describe_package_import_job(**kwargs)¶

Returns information about a package import job.

See also: AWS API Documentation

Request Syntax

response = client.describe_package_import_job(
    JobId='string'
)

Parameters

JobId (string) --

[REQUIRED]

The job's ID.

Return type

dict

Returns

Response Syntax

{
    '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

(dict) --
- ClientToken (string) --
  The job's client token.
- CreatedTime (datetime) --
  When the job was created.
- InputConfig (dict) --
  The job's input config.
  - PackageVersionInputConfig (dict) --
    The package version's input configuration.
    - S3Location (dict) --
      A location in Amazon S3.
      - BucketName (string) --
        A bucket name.
      - ObjectKey (string) --
        An object key.
      - Region (string) --
        The bucket's Region.
- JobId (string) --
  The job's ID.
- JobTags (list) --
  The job's tags.
  - (dict) --
    Tags for a job.
    - ResourceType (string) --
      The job's type.
    - Tags (dict) --
      The job's tags.
      - (string) --
        
        (string) --
- JobType (string) --
  The job's type.
- LastUpdatedTime (datetime) --
  When the job was updated.
- Output (dict) --
  The job's output.
  - OutputS3Location (dict) --
    The package's output location.
    - BucketName (string) --
      The object's bucket.
    - ObjectKey (string) --
      The object's key.
  - PackageId (string) --
    The package's ID.
  - PackageVersion (string) --
    The package's version.
  - PatchVersion (string) --
    The package's patch version.
- OutputConfig (dict) --
  The job's output config.
  - PackageVersionOutputConfig (dict) --
    The package version's output configuration.
    - MarkLatest (boolean) --
      Indicates that the version is recommended for all users.
    - PackageName (string) --
      The output's package name.
    - PackageVersion (string) --
      The output's package version.
- Status (string) --
  The job's status.
- StatusMessage (string) --
  The job's status message.

Exceptions

Panorama.Client.exceptions.ConflictException
Panorama.Client.exceptions.ValidationException
Panorama.Client.exceptions.AccessDeniedException
Panorama.Client.exceptions.InternalServerException

describe_package_version(**kwargs)¶

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'
)

Parameters

OwnerAccount (string) -- The version's owner account.
PackageId (string) --
[REQUIRED]

The version's ID.
PackageVersion (string) --
[REQUIRED]

The version's version.
PatchVersion (string) -- The version's patch version.

Return type

dict

Returns

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

Panorama.Client.exceptions.ConflictException
Panorama.Client.exceptions.ValidationException
Panorama.Client.exceptions.AccessDeniedException
Panorama.Client.exceptions.ResourceNotFoundException
Panorama.Client.exceptions.InternalServerException

get_paginator(operation_name)¶

Create a paginator for an operation.

Parameters: operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError: Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type: L{botocore.paginate.Paginator}
Returns: A paginator object.

get_waiter(waiter_name)¶

Returns an object that can wait for some condition.

Parameters: waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns: The specified waiter object.
Return type: botocore.waiter.Waiter

list_application_instance_dependencies(**kwargs)¶

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'
)

Parameters

ApplicationInstanceId (string) --
[REQUIRED]

The application instance's ID.
MaxResults (integer) -- The maximum number of application instance dependencies to return in one page of results.
NextToken (string) -- Specify the pagination token from a previous request to retrieve the next page of results.

Return type

dict

Returns

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

Panorama.Client.exceptions.AccessDeniedException
Panorama.Client.exceptions.InternalServerException

list_application_instance_node_instances(**kwargs)¶

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'
)

Parameters

ApplicationInstanceId (string) --
[REQUIRED]

The node instances' application instance ID.
MaxResults (integer) -- The maximum number of node instances to return in one page of results.
NextToken (string) -- Specify the pagination token from a previous request to retrieve the next page of results.

Return type

dict

Returns

Response Syntax

{
    'NextToken': 'string',
    'NodeInstances': [
        {
            'CurrentStatus': 'RUNNING'|'ERROR'|'NOT_AVAILABLE'|'PAUSED',
            '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

Panorama.Client.exceptions.AccessDeniedException
Panorama.Client.exceptions.InternalServerException

list_application_instances(**kwargs)¶

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'
)

Parameters

DeviceId (string) -- The application instances' device ID.
MaxResults (integer) -- The maximum number of application instances to return in one page of results.
NextToken (string) -- Specify the pagination token from a previous request to retrieve the next page of results.
StatusFilter (string) -- Only include instances with a specific status.

Return type

dict

Returns

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',
            'RuntimeContextStates': [
                {
                    'DesiredState': 'RUNNING'|'STOPPED'|'REMOVED',
                    'DeviceReportedStatus': 'STOPPING'|'STOPPED'|'STOP_ERROR'|'REMOVAL_FAILED'|'REMOVAL_IN_PROGRESS'|'STARTING'|'RUNNING'|'INSTALL_ERROR'|'LAUNCHED'|'LAUNCH_ERROR'|'INSTALL_IN_PROGRESS',
                    'DeviceReportedTime': datetime(2015, 1, 1),
                    'RuntimeContextName': '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.
    - RuntimeContextStates (list) --
      
      The application's state.
      - (dict) --
        
        An application instance's state.
        
        DesiredState (string) --
        
        The application's desired state.
        
        DeviceReportedStatus (string) --
        
        The application's reported status.
        
        DeviceReportedTime (datetime) --
        
        When the device reported the application's state.
        
        RuntimeContextName (string) --
        
        The device's name.
    - Status (string) --
      
      The application instance's status.
    - StatusDescription (string) --
      
      The application instance's status description.
    - Tags (dict) --
      
      The application instance's tags.
      - (string) --
        
        (string) --
- NextToken (string) --
  
  A pagination token that's included if more results are available.

Exceptions

Panorama.Client.exceptions.AccessDeniedException
Panorama.Client.exceptions.InternalServerException

list_devices(**kwargs)¶

Returns a list of devices.

See also: AWS API Documentation

Request Syntax

response = client.list_devices(
    DeviceAggregatedStatusFilter='ERROR'|'AWAITING_PROVISIONING'|'PENDING'|'FAILED'|'DELETING'|'ONLINE'|'OFFLINE'|'LEASE_EXPIRED'|'UPDATE_NEEDED'|'REBOOTING',
    MaxResults=123,
    NameFilter='string',
    NextToken='string',
    SortBy='DEVICE_ID'|'CREATED_TIME'|'NAME'|'DEVICE_AGGREGATED_STATUS',
    SortOrder='ASCENDING'|'DESCENDING'
)

Parameters

DeviceAggregatedStatusFilter (string) -- Filter based on a device's status.
MaxResults (integer) -- The maximum number of devices to return in one page of results.
NameFilter (string) -- Filter based on device's name. Prefixes supported.
NextToken (string) -- Specify the pagination token from a previous request to retrieve the next page of results.
SortBy (string) -- The target column to be sorted on. Default column sort is CREATED_TIME.
SortOrder (string) -- The sorting order for the returned list. SortOrder is DESCENDING by default based on CREATED_TIME. Otherwise, SortOrder is ASCENDING.

Return type

dict

Returns

Response Syntax

{
    'Devices': [
        {
            'Brand': 'AWS_PANORAMA'|'LENOVO',
            'CreatedTime': datetime(2015, 1, 1),
            'CurrentSoftware': 'string',
            'Description': 'string',
            'DeviceAggregatedStatus': 'ERROR'|'AWAITING_PROVISIONING'|'PENDING'|'FAILED'|'DELETING'|'ONLINE'|'OFFLINE'|'LEASE_EXPIRED'|'UPDATE_NEEDED'|'REBOOTING',
            'DeviceId': 'string',
            'LastUpdatedTime': datetime(2015, 1, 1),
            'LatestDeviceJob': {
                'ImageVersion': 'string',
                'JobType': 'OTA'|'REBOOT',
                'Status': 'PENDING'|'IN_PROGRESS'|'VERIFYING'|'REBOOTING'|'DOWNLOADING'|'COMPLETED'|'FAILED'
            },
            'LeaseExpirationTime': datetime(2015, 1, 1),
            'Name': 'string',
            'ProvisioningStatus': 'AWAITING_PROVISIONING'|'PENDING'|'SUCCEEDED'|'FAILED'|'ERROR'|'DELETING',
            'Tags': {
                'string': 'string'
            },
            'Type': 'PANORAMA_APPLIANCE_DEVELOPER_KIT'|'PANORAMA_APPLIANCE'
        },
    ],
    '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.
    - CurrentSoftware (string) --
      
      A device's current software.
    - Description (string) --
      
      A description for the device.
    - DeviceAggregatedStatus (string) --
      
      A device's aggregated status. Including the device's connection status, provisioning status, and lease status.
    - DeviceId (string) --
      
      The device's ID.
    - LastUpdatedTime (datetime) --
      
      When the device was updated.
    - LatestDeviceJob (dict) --
      
      A device's latest job. Includes the target image version, and the update job status.
      - ImageVersion (string) --
        
        The target version of the device software.
      - JobType (string) --
        
        The job's type.
      - Status (string) --
        
        Status of the latest device job.
    - LeaseExpirationTime (datetime) --
      
      The device's lease expiration time.
    - Name (string) --
      
      The device's name.
    - ProvisioningStatus (string) --
      
      The device's provisioning status.
    - Tags (dict) --
      
      The device's tags.
      - (string) --
        
        (string) --
    - Type (string) --
      
      The device's type.
- NextToken (string) --
  
  A pagination token that's included if more results are available.

Exceptions

Panorama.Client.exceptions.ConflictException
Panorama.Client.exceptions.ValidationException
Panorama.Client.exceptions.AccessDeniedException
Panorama.Client.exceptions.InternalServerException

list_devices_jobs(**kwargs)¶

Returns a list of jobs.

See also: AWS API Documentation

Request Syntax

response = client.list_devices_jobs(
    DeviceId='string',
    MaxResults=123,
    NextToken='string'
)

Parameters

DeviceId (string) -- Filter results by the job's target device ID.
MaxResults (integer) -- The maximum number of device jobs to return in one page of results.
NextToken (string) -- Specify the pagination token from a previous request to retrieve the next page of results.

Return type

dict

Returns

Response Syntax

{
    'DeviceJobs': [
        {
            'CreatedTime': datetime(2015, 1, 1),
            'DeviceId': 'string',
            'DeviceName': 'string',
            'JobId': 'string',
            'JobType': 'OTA'|'REBOOT'
        },
    ],
    '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.
    - JobType (string) --
      
      The job's type.
- NextToken (string) --
  
  A pagination token that's included if more results are available.

Exceptions

Panorama.Client.exceptions.ConflictException
Panorama.Client.exceptions.ValidationException
Panorama.Client.exceptions.AccessDeniedException
Panorama.Client.exceptions.ResourceNotFoundException
Panorama.Client.exceptions.InternalServerException

list_node_from_template_jobs(**kwargs)¶

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'
)

Parameters

MaxResults (integer) -- The maximum number of node from template jobs to return in one page of results.
NextToken (string) -- Specify the pagination token from a previous request to retrieve the next page of results.

Return type

dict

Returns

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

Panorama.Client.exceptions.ConflictException
Panorama.Client.exceptions.ValidationException
Panorama.Client.exceptions.AccessDeniedException
Panorama.Client.exceptions.InternalServerException

list_nodes(**kwargs)¶

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'
)

Parameters

Category (string) -- Search for nodes by category.
MaxResults (integer) -- The maximum number of nodes to return in one page of results.
NextToken (string) -- Specify the pagination token from a previous request to retrieve the next page of results.
OwnerAccount (string) -- Search for nodes by the account ID of the nodes' owner.
PackageName (string) -- Search for nodes by name.
PackageVersion (string) -- Search for nodes by version.
PatchVersion (string) -- Search for nodes by patch version.

Return type

dict

Returns

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

Panorama.Client.exceptions.ConflictException
Panorama.Client.exceptions.ValidationException
Panorama.Client.exceptions.InternalServerException

list_package_import_jobs(**kwargs)¶

Returns a list of package import jobs.

See also: AWS API Documentation

Request Syntax

response = client.list_package_import_jobs(
    MaxResults=123,
    NextToken='string'
)

Parameters

MaxResults (integer) -- The maximum number of package import jobs to return in one page of results.
NextToken (string) -- Specify the pagination token from a previous request to retrieve the next page of results.

Return type

dict

Returns

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

Panorama.Client.exceptions.ConflictException
Panorama.Client.exceptions.ValidationException
Panorama.Client.exceptions.AccessDeniedException
Panorama.Client.exceptions.InternalServerException

list_packages(**kwargs)¶

Returns a list of packages.

See also: AWS API Documentation

Request Syntax

response = client.list_packages(
    MaxResults=123,
    NextToken='string'
)

Parameters

MaxResults (integer) -- The maximum number of packages to return in one page of results.
NextToken (string) -- Specify the pagination token from a previous request to retrieve the next page of results.

Return type

dict

Returns

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.
      - (string) --
        
        (string) --

Exceptions

Panorama.Client.exceptions.ConflictException
Panorama.Client.exceptions.ValidationException
Panorama.Client.exceptions.AccessDeniedException
Panorama.Client.exceptions.ResourceNotFoundException
Panorama.Client.exceptions.InternalServerException

list_tags_for_resource(**kwargs)¶

Returns a list of tags for a resource.

See also: AWS API Documentation

Request Syntax

response = client.list_tags_for_resource(
    ResourceArn='string'
)

Parameters

ResourceArn (string) --

[REQUIRED]

The resource's ARN.

Return type

dict

Returns

Response Syntax

{
    'Tags': {
        'string': 'string'
    }
}

Response Structure

(dict) --
- Tags (dict) --
  A list of tags.
  - (string) --
    - (string) --

Exceptions

Panorama.Client.exceptions.ValidationException
Panorama.Client.exceptions.ResourceNotFoundException
Panorama.Client.exceptions.InternalServerException

provision_device(**kwargs)¶

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'
    }
)

Parameters

Description (string) -- A description for the device.
Name (string) --
[REQUIRED]

A name for the device.
NetworkingConfiguration (dict) --
A networking configuration for the device.
- Ethernet0 (dict) --
  Settings for Ethernet port 0.
  - ConnectionType (string) -- [REQUIRED]
    How the device gets an IP address.
  - StaticIpConnectionInfo (dict) --
    Network configuration for a static IP connection.
    - DefaultGateway (string) -- [REQUIRED]
      The connection's default gateway.
    - Dns (list) -- [REQUIRED]
      The connection's DNS address.
      - (string) --
    - IpAddress (string) -- [REQUIRED]
      The connection's IP address.
    - Mask (string) -- [REQUIRED]
      The connection's DNS mask.
- Ethernet1 (dict) --
  Settings for Ethernet port 1.
  - ConnectionType (string) -- [REQUIRED]
    How the device gets an IP address.
  - StaticIpConnectionInfo (dict) --
    Network configuration for a static IP connection.
    - DefaultGateway (string) -- [REQUIRED]
      The connection's default gateway.
    - Dns (list) -- [REQUIRED]
      The connection's DNS address.
      - (string) --
    - IpAddress (string) -- [REQUIRED]
      The connection's IP address.
    - Mask (string) -- [REQUIRED]
      The connection's DNS mask.
- Ntp (dict) --
  Network time protocol (NTP) server settings.
  - NtpServers (list) -- [REQUIRED]
    NTP servers to use, in order of preference.
    - (string) --
Tags (dict) --
Tags for the device.
- (string) --
  - (string) --

Return type

dict

Returns

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

Panorama.Client.exceptions.ConflictException
Panorama.Client.exceptions.ValidationException
Panorama.Client.exceptions.AccessDeniedException
Panorama.Client.exceptions.ServiceQuotaExceededException
Panorama.Client.exceptions.InternalServerException

register_package_version(**kwargs)¶

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'
)

Parameters

MarkLatest (boolean) -- Whether to mark the new version as the latest version.
OwnerAccount (string) -- An owner account.
PackageId (string) --
[REQUIRED]

A package ID.
PackageVersion (string) --
[REQUIRED]

A package version.
PatchVersion (string) --
[REQUIRED]

A patch version.

Return type

dict

Returns

Response Syntax

{}

Response Structure

(dict) --

Exceptions

Panorama.Client.exceptions.ConflictException
Panorama.Client.exceptions.ValidationException
Panorama.Client.exceptions.AccessDeniedException
Panorama.Client.exceptions.InternalServerException

remove_application_instance(**kwargs)¶

Removes an application instance.

See also: AWS API Documentation

Request Syntax

response = client.remove_application_instance(
    ApplicationInstanceId='string'
)

Parameters

ApplicationInstanceId (string) --

[REQUIRED]

An application instance ID.

Return type

dict

Returns

Response Syntax

{}

Response Structure

(dict) --

Exceptions

Panorama.Client.exceptions.ConflictException
Panorama.Client.exceptions.ValidationException
Panorama.Client.exceptions.AccessDeniedException
Panorama.Client.exceptions.ResourceNotFoundException
Panorama.Client.exceptions.InternalServerException

signal_application_instance_node_instances(**kwargs)¶

Signal camera nodes to stop or resume.

See also: AWS API Documentation

Request Syntax

response = client.signal_application_instance_node_instances(
    ApplicationInstanceId='string',
    NodeSignals=[
        {
            'NodeInstanceId': 'string',
            'Signal': 'PAUSE'|'RESUME'
        },
    ]
)

Parameters

ApplicationInstanceId (string) --
[REQUIRED]

An application instance ID.
NodeSignals (list) --
[REQUIRED]

A list of signals.
- (dict) --
  A signal to a camera node to start or stop processing video.
  - NodeInstanceId (string) -- [REQUIRED]
    The camera node's name, from the application manifest.
  - Signal (string) -- [REQUIRED]
    The signal value.

Return type

dict

Returns

Response Syntax

{
    'ApplicationInstanceId': 'string'
}

Response Structure

(dict) --
- ApplicationInstanceId (string) --
  
  An application instance ID.

Exceptions

Panorama.Client.exceptions.ValidationException
Panorama.Client.exceptions.AccessDeniedException
Panorama.Client.exceptions.ServiceQuotaExceededException
Panorama.Client.exceptions.InternalServerException

tag_resource(**kwargs)¶

Tags a resource.

See also: AWS API Documentation

Request Syntax

response = client.tag_resource(
    ResourceArn='string',
    Tags={
        'string': 'string'
    }
)

Parameters

ResourceArn (string) --
[REQUIRED]

The resource's ARN.
Tags (dict) --
[REQUIRED]

Tags for the resource.
- (string) --
  - (string) --

Return type

dict

Returns

Response Syntax

{}

Response Structure

(dict) --

Exceptions

Panorama.Client.exceptions.ValidationException
Panorama.Client.exceptions.ResourceNotFoundException
Panorama.Client.exceptions.InternalServerException

untag_resource(**kwargs)¶

Removes tags from a resource.

See also: AWS API Documentation

Request Syntax

response = client.untag_resource(
    ResourceArn='string',
    TagKeys=[
        'string',
    ]
)

Parameters

ResourceArn (string) --
[REQUIRED]

The resource's ARN.
TagKeys (list) --
[REQUIRED]

Tag keys to remove.
- (string) --

Return type

dict

Returns

Response Syntax

{}

Response Structure

(dict) --

Exceptions

Panorama.Client.exceptions.ValidationException
Panorama.Client.exceptions.ResourceNotFoundException
Panorama.Client.exceptions.InternalServerException

update_device_metadata(**kwargs)¶

Updates a device's metadata.

See also: AWS API Documentation

Request Syntax

response = client.update_device_metadata(
    Description='string',
    DeviceId='string'
)

Parameters

Description (string) -- A description for the device.
DeviceId (string) --
[REQUIRED]

The device's ID.

Return type

dict

Returns

Response Syntax

{
    'DeviceId': 'string'
}

Response Structure

(dict) --
- DeviceId (string) --
  
  The device's ID.

Exceptions

Panorama.Client.exceptions.ConflictException
Panorama.Client.exceptions.ValidationException
Panorama.Client.exceptions.AccessDeniedException
Panorama.Client.exceptions.ResourceNotFoundException
Panorama.Client.exceptions.InternalServerException

Paginators ¶

The available paginators are:

Table Of Contents

Panorama¶

Client¶

Paginators¶

Panorama ¶

Client ¶

Paginators ¶