AWS API Changes

2022/02/25 - AWS Panorama - 5 updated api methods

Changes Added NTP server configuration parameter to ProvisionDevice operation. Added alternate software fields to DescribeDevice response

CreatePackageImportJob (updated)

Link ¶
Changes (request)

{'JobType': {'MARKETPLACE_NODE_PACKAGE_VERSION'}}

Imports a node package.

See also: AWS API Documentation

Request Syntax

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

type ClientToken:

string

param ClientToken:

[REQUIRED]

A client token for the package import job.

type InputConfig:

dict

param InputConfig:

[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.

type JobTags:

list

param JobTags:

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

type JobType:

string

param JobType:

[REQUIRED]

A job type for the package import job.

type OutputConfig:

dict

param OutputConfig:

[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.

rtype:

dict

returns:

Response Syntax

{
    'JobId': 'string'
}

Response Structure

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

DescribeDevice (updated)

Link ¶
Changes (response)

{'AlternateSoftwares': [{'Version': 'string'}],
 'CurrentNetworkingStatus': {'Ethernet0Status': {'ConnectionStatus': {'CONNECTING'}},
                             'Ethernet1Status': {'ConnectionStatus': {'CONNECTING'}},
                             'LastUpdatedTime': 'timestamp',
                             'NtpStatus': {'ConnectionStatus': 'CONNECTED | '
                                                               'NOT_CONNECTED '
                                                               '| CONNECTING',
                                           'IpAddress': 'string',
                                           'NtpServerName': 'string'}},
 'LatestAlternateSoftware': 'string',
 'NetworkingConfiguration': {'Ntp': {'NtpServers': ['string']}}}

Returns information about a device.

See also: AWS API Documentation

Request Syntax

client.describe_device(
    DeviceId='string'
)

type DeviceId:

string

param DeviceId:

[REQUIRED]

The device's ID.

rtype:

dict

returns:

Response Syntax

{
    'AlternateSoftwares': [
        {
            'Version': 'string'
        },
    ],
    'Arn': 'string',
    'CreatedTime': datetime(2015, 1, 1),
    'CurrentNetworkingStatus': {
        'Ethernet0Status': {
            'ConnectionStatus': 'CONNECTED'|'NOT_CONNECTED'|'CONNECTING',
            'HwAddress': 'string',
            'IpAddress': 'string'
        },
        'Ethernet1Status': {
            'ConnectionStatus': 'CONNECTED'|'NOT_CONNECTED'|'CONNECTING',
            'HwAddress': 'string',
            'IpAddress': 'string'
        },
        'LastUpdatedTime': datetime(2015, 1, 1),
        'NtpStatus': {
            'ConnectionStatus': 'CONNECTED'|'NOT_CONNECTED'|'CONNECTING',
            'IpAddress': 'string',
            'NtpServerName': 'string'
        }
    },
    'CurrentSoftware': 'string',
    'Description': 'string',
    'DeviceConnectionStatus': 'ONLINE'|'OFFLINE'|'AWAITING_CREDENTIALS'|'NOT_AVAILABLE'|'ERROR',
    'DeviceId': 'string',
    'LatestAlternateSoftware': 'string',
    'LatestSoftware': 'string',
    'LeaseExpirationTime': datetime(2015, 1, 1),
    'Name': 'string',
    'NetworkingConfiguration': {
        'Ethernet0': {
            'ConnectionType': 'STATIC_IP'|'DHCP',
            'StaticIpConnectionInfo': {
                'DefaultGateway': 'string',
                'Dns': [
                    'string',
                ],
                'IpAddress': 'string',
                'Mask': 'string'
            }
        },
        'Ethernet1': {
            'ConnectionType': 'STATIC_IP'|'DHCP',
            'StaticIpConnectionInfo': {
                'DefaultGateway': 'string',
                'Dns': [
                    'string',
                ],
                'IpAddress': 'string',
                'Mask': 'string'
            }
        },
        'Ntp': {
            'NtpServers': [
                'string',
            ]
        }
    },
    'ProvisioningStatus': 'AWAITING_PROVISIONING'|'PENDING'|'SUCCEEDED'|'FAILED'|'ERROR'|'DELETING',
    'SerialNumber': 'string',
    'Tags': {
        'string': 'string'
    },
    'Type': 'PANORAMA_APPLIANCE_DEVELOPER_KIT'|'PANORAMA_APPLIANCE'
}

Response Structure

(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.
- 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.
- DeviceConnectionStatus (string) --
  
  The device's connection status.
- DeviceId (string) --
  
  The device's ID.
- LatestAlternateSoftware (string) --
  
  The most recent beta software release.
- 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.

DescribePackageImportJob (updated)

Link ¶
Changes (response)

{'JobType': {'MARKETPLACE_NODE_PACKAGE_VERSION'}}

Returns information about a package import job.

See also: AWS API Documentation

Request Syntax

client.describe_package_import_job(
    JobId='string'
)

type JobId:

string

param JobId:

[REQUIRED]

The job's ID.

rtype:

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.

ListPackageImportJobs (updated)

Link ¶
Changes (response)

{'PackageImportJobs': {'JobType': {'MARKETPLACE_NODE_PACKAGE_VERSION'}}}

Returns a list of package import jobs.

See also: AWS API Documentation

Request Syntax

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

type MaxResults:

integer

param MaxResults:

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

type NextToken:

string

param NextToken:

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

rtype:

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.

ProvisionDevice (updated)

Link ¶
Changes (request)

{'NetworkingConfiguration': {'Ntp': {'NtpServers': ['string']}}}

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

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

type Description:

string

param Description:

A description for the device.

type Name:

string

param Name:

[REQUIRED]

A name for the device.

type NetworkingConfiguration:

dict

param NetworkingConfiguration:

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

type Tags:

dict

param Tags:

Tags for the device.

(string) --
- (string) --

rtype:

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.