AWS API Changes

2022/04/06 - AWS Panorama - 4 updated api methods

Changes Added Brand field to device listings.

DescribeApplicationInstance (updated)

Link ¶
Changes (response)

{'Status': {'DEPLOYMENT_FAILED'}}

Returns information about an application instance on a device.

See also: AWS API Documentation

Request Syntax

client.describe_application_instance(
    ApplicationInstanceId='string'
)

type ApplicationInstanceId

string

param ApplicationInstanceId

[REQUIRED]

The application instance's ID.

rtype

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

DescribeDevice (updated)

Link ¶
Changes (response)

{'Brand': 'AWS_PANORAMA | LENOVO'}

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

Response Structure

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

ListApplicationInstances (updated)

Link ¶
Changes (request, response)
Request

{'StatusFilter': {'DEPLOYMENT_FAILED'}}

Response

{'ApplicationInstances': {'Status': {'DEPLOYMENT_FAILED'}}}

Returns a list of application instances.

See also: AWS API Documentation

Request Syntax

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

type DeviceId

string

param DeviceId

The application instances' device ID.

type MaxResults

integer

param MaxResults

The maximum number of application instances 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.

type StatusFilter

string

param StatusFilter

Only include instances with a specific status.

rtype

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',
            'Status': 'DEPLOYMENT_PENDING'|'DEPLOYMENT_REQUESTED'|'DEPLOYMENT_IN_PROGRESS'|'DEPLOYMENT_ERROR'|'DEPLOYMENT_SUCCEEDED'|'REMOVAL_PENDING'|'REMOVAL_REQUESTED'|'REMOVAL_IN_PROGRESS'|'REMOVAL_FAILED'|'REMOVAL_SUCCEEDED'|'DEPLOYMENT_FAILED',
            'StatusDescription': 'string',
            'Tags': {
                'string': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- ApplicationInstances (list) --
  
  A list of application instances.
  - (dict) --
    
    An application instance on a device.
    - ApplicationInstanceId (string) --
      
      The application instance's ID.
    - Arn (string) --
      
      The application instance's ARN.
    - CreatedTime (datetime) --
      
      When the application instance was created.
    - DefaultRuntimeContextDevice (string) --
      
      The device's ID.
    - DefaultRuntimeContextDeviceName (string) --
      
      The device's name.
    - Description (string) --
      
      The application instance's description.
    - HealthStatus (string) --
      
      The application instance's health status.
    - Name (string) --
      
      The application instance's name.
    - Status (string) --
      
      The application instance's status.
    - StatusDescription (string) --
      
      The application instance's status description.
    - Tags (dict) --
      
      The application instance's tags.
      - (string) --
        
        (string) --
- NextToken (string) --
  
  A pagination token that's included if more results are available.

ListDevices (updated)

Link ¶
Changes (response)

{'Devices': {'Brand': 'AWS_PANORAMA | LENOVO'}}

Returns a list of devices.

See also: AWS API Documentation

Request Syntax

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

type MaxResults

integer

param MaxResults

The maximum number of devices 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

{
    'Devices': [
        {
            'Brand': 'AWS_PANORAMA'|'LENOVO',
            'CreatedTime': datetime(2015, 1, 1),
            'DeviceId': 'string',
            'LastUpdatedTime': datetime(2015, 1, 1),
            'LeaseExpirationTime': datetime(2015, 1, 1),
            'Name': 'string',
            'ProvisioningStatus': 'AWAITING_PROVISIONING'|'PENDING'|'SUCCEEDED'|'FAILED'|'ERROR'|'DELETING'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- Devices (list) --
  
  A list of devices.
  - (dict) --
    
    A device.
    - Brand (string) --
      
      The device's maker.
    - CreatedTime (datetime) --
      
      When the device was created.
    - DeviceId (string) --
      
      The device's ID.
    - LastUpdatedTime (datetime) --
      
      When the device was updated.
    - LeaseExpirationTime (datetime) --
      
      The device's lease expiration time.
    - Name (string) --
      
      The device's name.
    - ProvisioningStatus (string) --
      
      The device's provisioning status.
- NextToken (string) --
  
  A pagination token that's included if more results are available.