Skip to content

Type definitions#

Index > Panorama > Type definitions

Auto-generated documentation for Panorama type annotations stubs module mypy-boto3-panorama.

AlternateSoftwareMetadataTypeDef#

# AlternateSoftwareMetadataTypeDef definition

class AlternateSoftwareMetadataTypeDef(TypedDict):
    Version: NotRequired[str],

ReportedRuntimeContextStateTypeDef#

# ReportedRuntimeContextStateTypeDef definition

class ReportedRuntimeContextStateTypeDef(TypedDict):
    DesiredState: DesiredStateType,  # (1)
    DeviceReportedStatus: DeviceReportedStatusType,  # (2)
    DeviceReportedTime: datetime,
    RuntimeContextName: str,
  1. See DesiredStateType
  2. See DeviceReportedStatusType

ManifestOverridesPayloadTypeDef#

# ManifestOverridesPayloadTypeDef definition

class ManifestOverridesPayloadTypeDef(TypedDict):
    PayloadData: NotRequired[str],

ManifestPayloadTypeDef#

# ManifestPayloadTypeDef definition

class ManifestPayloadTypeDef(TypedDict):
    PayloadData: NotRequired[str],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

JobTypeDef#

# JobTypeDef definition

class JobTypeDef(TypedDict):
    DeviceId: NotRequired[str],
    JobId: NotRequired[str],

JobResourceTagsTypeDef#

# JobResourceTagsTypeDef definition

class JobResourceTagsTypeDef(TypedDict):
    ResourceType: JobResourceTypeType,  # (1)
    Tags: Mapping[str, str],
  1. See JobResourceTypeType

CreatePackageRequestRequestTypeDef#

# CreatePackageRequestRequestTypeDef definition

class CreatePackageRequestRequestTypeDef(TypedDict):
    PackageName: str,
    Tags: NotRequired[Mapping[str, str]],

StorageLocationTypeDef#

# StorageLocationTypeDef definition

class StorageLocationTypeDef(TypedDict):
    BinaryPrefixLocation: str,
    Bucket: str,
    GeneratedPrefixLocation: str,
    ManifestPrefixLocation: str,
    RepoPrefixLocation: str,

DeleteDeviceRequestRequestTypeDef#

# DeleteDeviceRequestRequestTypeDef definition

class DeleteDeviceRequestRequestTypeDef(TypedDict):
    DeviceId: str,

DeletePackageRequestRequestTypeDef#

# DeletePackageRequestRequestTypeDef definition

class DeletePackageRequestRequestTypeDef(TypedDict):
    PackageId: str,
    ForceDelete: NotRequired[bool],

DeregisterPackageVersionRequestRequestTypeDef#

# DeregisterPackageVersionRequestRequestTypeDef definition

class DeregisterPackageVersionRequestRequestTypeDef(TypedDict):
    PackageId: str,
    PackageVersion: str,
    PatchVersion: str,
    OwnerAccount: NotRequired[str],
    UpdatedLatestPatchVersion: NotRequired[str],

DescribeApplicationInstanceDetailsRequestRequestTypeDef#

# DescribeApplicationInstanceDetailsRequestRequestTypeDef definition

class DescribeApplicationInstanceDetailsRequestRequestTypeDef(TypedDict):
    ApplicationInstanceId: str,

DescribeApplicationInstanceRequestRequestTypeDef#

# DescribeApplicationInstanceRequestRequestTypeDef definition

class DescribeApplicationInstanceRequestRequestTypeDef(TypedDict):
    ApplicationInstanceId: str,

DescribeDeviceJobRequestRequestTypeDef#

# DescribeDeviceJobRequestRequestTypeDef definition

class DescribeDeviceJobRequestRequestTypeDef(TypedDict):
    JobId: str,

DescribeDeviceRequestRequestTypeDef#

# DescribeDeviceRequestRequestTypeDef definition

class DescribeDeviceRequestRequestTypeDef(TypedDict):
    DeviceId: str,

LatestDeviceJobTypeDef#

# LatestDeviceJobTypeDef definition

class LatestDeviceJobTypeDef(TypedDict):
    ImageVersion: NotRequired[str],
    JobType: NotRequired[JobTypeType],  # (1)
    Status: NotRequired[UpdateProgressType],  # (2)
  1. See JobTypeType
  2. See UpdateProgressType

DescribeNodeFromTemplateJobRequestRequestTypeDef#

# DescribeNodeFromTemplateJobRequestRequestTypeDef definition

class DescribeNodeFromTemplateJobRequestRequestTypeDef(TypedDict):
    JobId: str,

DescribeNodeRequestRequestTypeDef#

# DescribeNodeRequestRequestTypeDef definition

class DescribeNodeRequestRequestTypeDef(TypedDict):
    NodeId: str,
    OwnerAccount: NotRequired[str],

DescribePackageImportJobRequestRequestTypeDef#

# DescribePackageImportJobRequestRequestTypeDef definition

class DescribePackageImportJobRequestRequestTypeDef(TypedDict):
    JobId: str,

DescribePackageRequestRequestTypeDef#

# DescribePackageRequestRequestTypeDef definition

class DescribePackageRequestRequestTypeDef(TypedDict):
    PackageId: str,

DescribePackageVersionRequestRequestTypeDef#

# DescribePackageVersionRequestRequestTypeDef definition

class DescribePackageVersionRequestRequestTypeDef(TypedDict):
    PackageId: str,
    PackageVersion: str,
    OwnerAccount: NotRequired[str],
    PatchVersion: NotRequired[str],

OTAJobConfigTypeDef#

# OTAJobConfigTypeDef definition

class OTAJobConfigTypeDef(TypedDict):
    ImageVersion: str,
    AllowMajorVersionUpdate: NotRequired[bool],

DeviceJobTypeDef#

# DeviceJobTypeDef definition

class DeviceJobTypeDef(TypedDict):
    CreatedTime: NotRequired[datetime],
    DeviceId: NotRequired[str],
    DeviceName: NotRequired[str],
    JobId: NotRequired[str],
    JobType: NotRequired[JobTypeType],  # (1)
  1. See JobTypeType

StaticIpConnectionInfoTypeDef#

# StaticIpConnectionInfoTypeDef definition

class StaticIpConnectionInfoTypeDef(TypedDict):
    DefaultGateway: str,
    Dns: List[str],
    IpAddress: str,
    Mask: str,

EthernetStatusTypeDef#

# EthernetStatusTypeDef definition

class EthernetStatusTypeDef(TypedDict):
    ConnectionStatus: NotRequired[NetworkConnectionStatusType],  # (1)
    HwAddress: NotRequired[str],
    IpAddress: NotRequired[str],
  1. See NetworkConnectionStatusType

ListApplicationInstanceDependenciesRequestRequestTypeDef#

# ListApplicationInstanceDependenciesRequestRequestTypeDef definition

class ListApplicationInstanceDependenciesRequestRequestTypeDef(TypedDict):
    ApplicationInstanceId: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

PackageObjectTypeDef#

# PackageObjectTypeDef definition

class PackageObjectTypeDef(TypedDict):
    Name: str,
    PackageVersion: str,
    PatchVersion: str,

ListApplicationInstanceNodeInstancesRequestRequestTypeDef#

# ListApplicationInstanceNodeInstancesRequestRequestTypeDef definition

class ListApplicationInstanceNodeInstancesRequestRequestTypeDef(TypedDict):
    ApplicationInstanceId: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

NodeInstanceTypeDef#

# NodeInstanceTypeDef definition

class NodeInstanceTypeDef(TypedDict):
    CurrentStatus: NodeInstanceStatusType,  # (1)
    NodeInstanceId: str,
    NodeId: NotRequired[str],
    NodeName: NotRequired[str],
    PackageName: NotRequired[str],
    PackagePatchVersion: NotRequired[str],
    PackageVersion: NotRequired[str],
  1. See NodeInstanceStatusType

ListApplicationInstancesRequestRequestTypeDef#

# ListApplicationInstancesRequestRequestTypeDef definition

class ListApplicationInstancesRequestRequestTypeDef(TypedDict):
    DeviceId: NotRequired[str],
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
    StatusFilter: NotRequired[StatusFilterType],  # (1)
  1. See StatusFilterType

ListDevicesJobsRequestRequestTypeDef#

# ListDevicesJobsRequestRequestTypeDef definition

class ListDevicesJobsRequestRequestTypeDef(TypedDict):
    DeviceId: NotRequired[str],
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

ListDevicesRequestRequestTypeDef#

# ListDevicesRequestRequestTypeDef definition

class ListDevicesRequestRequestTypeDef(TypedDict):
    DeviceAggregatedStatusFilter: NotRequired[DeviceAggregatedStatusType],  # (1)
    MaxResults: NotRequired[int],
    NameFilter: NotRequired[str],
    NextToken: NotRequired[str],
    SortBy: NotRequired[ListDevicesSortByType],  # (2)
    SortOrder: NotRequired[SortOrderType],  # (3)
  1. See DeviceAggregatedStatusType
  2. See ListDevicesSortByType
  3. See SortOrderType

ListNodeFromTemplateJobsRequestRequestTypeDef#

# ListNodeFromTemplateJobsRequestRequestTypeDef definition

class ListNodeFromTemplateJobsRequestRequestTypeDef(TypedDict):
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

NodeFromTemplateJobTypeDef#

# NodeFromTemplateJobTypeDef definition

class NodeFromTemplateJobTypeDef(TypedDict):
    CreatedTime: NotRequired[datetime],
    JobId: NotRequired[str],
    NodeName: NotRequired[str],
    Status: NotRequired[NodeFromTemplateJobStatusType],  # (1)
    StatusMessage: NotRequired[str],
    TemplateType: NotRequired[TemplateTypeType],  # (2)
  1. See NodeFromTemplateJobStatusType
  2. See TemplateTypeType

ListNodesRequestRequestTypeDef#

# ListNodesRequestRequestTypeDef definition

class ListNodesRequestRequestTypeDef(TypedDict):
    Category: NotRequired[NodeCategoryType],  # (1)
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
    OwnerAccount: NotRequired[str],
    PackageName: NotRequired[str],
    PackageVersion: NotRequired[str],
    PatchVersion: NotRequired[str],
  1. See NodeCategoryType

NodeTypeDef#

# NodeTypeDef definition

class NodeTypeDef(TypedDict):
    Category: NodeCategoryType,  # (1)
    CreatedTime: datetime,
    Name: str,
    NodeId: str,
    PackageId: str,
    PackageName: str,
    PackageVersion: str,
    PatchVersion: str,
    Description: NotRequired[str],
    OwnerAccount: NotRequired[str],
    PackageArn: NotRequired[str],
  1. See NodeCategoryType

ListPackageImportJobsRequestRequestTypeDef#

# ListPackageImportJobsRequestRequestTypeDef definition

class ListPackageImportJobsRequestRequestTypeDef(TypedDict):
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

PackageImportJobTypeDef#

# PackageImportJobTypeDef definition

class PackageImportJobTypeDef(TypedDict):
    CreatedTime: NotRequired[datetime],
    JobId: NotRequired[str],
    JobType: NotRequired[PackageImportJobTypeType],  # (1)
    LastUpdatedTime: NotRequired[datetime],
    Status: NotRequired[PackageImportJobStatusType],  # (2)
    StatusMessage: NotRequired[str],
  1. See PackageImportJobTypeType
  2. See PackageImportJobStatusType

ListPackagesRequestRequestTypeDef#

# ListPackagesRequestRequestTypeDef definition

class ListPackagesRequestRequestTypeDef(TypedDict):
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

PackageListItemTypeDef#

# PackageListItemTypeDef definition

class PackageListItemTypeDef(TypedDict):
    Arn: NotRequired[str],
    CreatedTime: NotRequired[datetime],
    PackageId: NotRequired[str],
    PackageName: NotRequired[str],
    Tags: NotRequired[Dict[str, str]],

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,

NtpPayloadTypeDef#

# NtpPayloadTypeDef definition

class NtpPayloadTypeDef(TypedDict):
    NtpServers: List[str],

NtpStatusTypeDef#

# NtpStatusTypeDef definition

class NtpStatusTypeDef(TypedDict):
    ConnectionStatus: NotRequired[NetworkConnectionStatusType],  # (1)
    IpAddress: NotRequired[str],
    NtpServerName: NotRequired[str],
  1. See NetworkConnectionStatusType

NodeInputPortTypeDef#

# NodeInputPortTypeDef definition

class NodeInputPortTypeDef(TypedDict):
    DefaultValue: NotRequired[str],
    Description: NotRequired[str],
    MaxConnections: NotRequired[int],
    Name: NotRequired[str],
    Type: NotRequired[PortTypeType],  # (1)
  1. See PortTypeType

NodeOutputPortTypeDef#

# NodeOutputPortTypeDef definition

class NodeOutputPortTypeDef(TypedDict):
    Description: NotRequired[str],
    Name: NotRequired[str],
    Type: NotRequired[PortTypeType],  # (1)
  1. See PortTypeType

NodeSignalTypeDef#

# NodeSignalTypeDef definition

class NodeSignalTypeDef(TypedDict):
    NodeInstanceId: str,
    Signal: NodeSignalValueType,  # (1)
  1. See NodeSignalValueType

OutPutS3LocationTypeDef#

# OutPutS3LocationTypeDef definition

class OutPutS3LocationTypeDef(TypedDict):
    BucketName: str,
    ObjectKey: str,

PackageVersionOutputConfigTypeDef#

# PackageVersionOutputConfigTypeDef definition

class PackageVersionOutputConfigTypeDef(TypedDict):
    PackageName: str,
    PackageVersion: str,
    MarkLatest: NotRequired[bool],

S3LocationTypeDef#

# S3LocationTypeDef definition

class S3LocationTypeDef(TypedDict):
    BucketName: str,
    ObjectKey: str,
    Region: NotRequired[str],

RegisterPackageVersionRequestRequestTypeDef#

# RegisterPackageVersionRequestRequestTypeDef definition

class RegisterPackageVersionRequestRequestTypeDef(TypedDict):
    PackageId: str,
    PackageVersion: str,
    PatchVersion: str,
    MarkLatest: NotRequired[bool],
    OwnerAccount: NotRequired[str],

RemoveApplicationInstanceRequestRequestTypeDef#

# RemoveApplicationInstanceRequestRequestTypeDef definition

class RemoveApplicationInstanceRequestRequestTypeDef(TypedDict):
    ApplicationInstanceId: str,

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

class TagResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,
    Tags: Mapping[str, str],

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

class UntagResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,
    TagKeys: Sequence[str],

UpdateDeviceMetadataRequestRequestTypeDef#

# UpdateDeviceMetadataRequestRequestTypeDef definition

class UpdateDeviceMetadataRequestRequestTypeDef(TypedDict):
    DeviceId: str,
    Description: NotRequired[str],

ApplicationInstanceTypeDef#

# ApplicationInstanceTypeDef definition

class ApplicationInstanceTypeDef(TypedDict):
    ApplicationInstanceId: NotRequired[str],
    Arn: NotRequired[str],
    CreatedTime: NotRequired[datetime],
    DefaultRuntimeContextDevice: NotRequired[str],
    DefaultRuntimeContextDeviceName: NotRequired[str],
    Description: NotRequired[str],
    HealthStatus: NotRequired[ApplicationInstanceHealthStatusType],  # (1)
    Name: NotRequired[str],
    RuntimeContextStates: NotRequired[List[ReportedRuntimeContextStateTypeDef]],  # (2)
    Status: NotRequired[ApplicationInstanceStatusType],  # (3)
    StatusDescription: NotRequired[str],
    Tags: NotRequired[Dict[str, str]],
  1. See ApplicationInstanceHealthStatusType
  2. See ReportedRuntimeContextStateTypeDef
  3. See ApplicationInstanceStatusType

CreateApplicationInstanceRequestRequestTypeDef#

# CreateApplicationInstanceRequestRequestTypeDef definition

class CreateApplicationInstanceRequestRequestTypeDef(TypedDict):
    DefaultRuntimeContextDevice: str,
    ManifestPayload: ManifestPayloadTypeDef,  # (1)
    ApplicationInstanceIdToReplace: NotRequired[str],
    Description: NotRequired[str],
    ManifestOverridesPayload: NotRequired[ManifestOverridesPayloadTypeDef],  # (2)
    Name: NotRequired[str],
    RuntimeRoleArn: NotRequired[str],
    Tags: NotRequired[Mapping[str, str]],
  1. See ManifestPayloadTypeDef
  2. See ManifestOverridesPayloadTypeDef

CreateApplicationInstanceResponseTypeDef#

# CreateApplicationInstanceResponseTypeDef definition

class CreateApplicationInstanceResponseTypeDef(TypedDict):
    ApplicationInstanceId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateNodeFromTemplateJobResponseTypeDef#

# CreateNodeFromTemplateJobResponseTypeDef definition

class CreateNodeFromTemplateJobResponseTypeDef(TypedDict):
    JobId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreatePackageImportJobResponseTypeDef#

# CreatePackageImportJobResponseTypeDef definition

class CreatePackageImportJobResponseTypeDef(TypedDict):
    JobId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteDeviceResponseTypeDef#

# DeleteDeviceResponseTypeDef definition

class DeleteDeviceResponseTypeDef(TypedDict):
    DeviceId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

Desc