PanoramaClient#
Auto-generated documentation for Panorama type annotations stubs module types-boto3-panorama.
PanoramaClient#
Type annotations and code completion for boto3.client("panorama").
 boto3 documentation
# PanoramaClient usage example
from boto3.session import Session
from types_boto3_panorama.client import PanoramaClient
def get_panorama_client() -> PanoramaClient:
    return Session().client("panorama")Exceptions#
boto3 client exceptions are generated in runtime.
This class provides code completion for boto3.client("panorama").exceptions structure.
# Exceptions.exceptions usage example
client = boto3.client("panorama")
try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.InternalServerException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ValidationException,
) as e:
    print(e)# Exceptions.exceptions type checking example
from types_boto3_panorama.client import Exceptions
def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...Methods#
can_paginate#
Type annotations and code completion for boto3.client("panorama").can_paginate method.
 boto3 documentation
# can_paginate method definition
def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...generate_presigned_url#
Type annotations and code completion for boto3.client("panorama").generate_presigned_url method.
 boto3 documentation
# generate_presigned_url method definition
def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...create_application_instance#
Creates an application instance and deploys it to a device.
Type annotations and code completion for boto3.client("panorama").create_application_instance method.
 boto3 documentation
# create_application_instance method definition
def create_application_instance(
    self,
    *,
    DefaultRuntimeContextDevice: str,
    ManifestPayload: ManifestPayloadTypeDef,  # (1)
    ApplicationInstanceIdToReplace: str = ...,
    Description: str = ...,
    ManifestOverridesPayload: ManifestOverridesPayloadTypeDef = ...,  # (2)
    Name: str = ...,
    RuntimeRoleArn: str = ...,
    Tags: Mapping[str, str] = ...,
) -> CreateApplicationInstanceResponseTypeDef:  # (3)
    ...- See ManifestPayloadTypeDef
- See ManifestOverridesPayloadTypeDef
- See CreateApplicationInstanceResponseTypeDef
# create_application_instance method usage example with argument unpacking
kwargs: CreateApplicationInstanceRequestTypeDef = {  # (1)
    "DefaultRuntimeContextDevice": ...,
    "ManifestPayload": ...,
}
parent.create_application_instance(**kwargs)create_job_for_devices#
Creates a job to run on a device.
Type annotations and code completion for boto3.client("panorama").create_job_for_devices method.
 boto3 documentation
# create_job_for_devices method definition
def create_job_for_devices(
    self,
    *,
    DeviceIds: Sequence[str],
    JobType: JobTypeType,  # (1)
    DeviceJobConfig: DeviceJobConfigTypeDef = ...,  # (2)
) -> CreateJobForDevicesResponseTypeDef:  # (3)
    ...# create_job_for_devices method usage example with argument unpacking
kwargs: CreateJobForDevicesRequestTypeDef = {  # (1)
    "DeviceIds": ...,
    "JobType": ...,
}
parent.create_job_for_devices(**kwargs)create_node_from_template_job#
Creates a camera stream node.
Type annotations and code completion for boto3.client("panorama").create_node_from_template_job method.
 boto3 documentation
# create_node_from_template_job method definition
def create_node_from_template_job(
    self,
    *,
    NodeName: str,
    OutputPackageName: str,
    OutputPackageVersion: str,
    TemplateParameters: Mapping[str, str],
    TemplateType: TemplateTypeType,  # (1)
    JobTags: Sequence[JobResourceTagsUnionTypeDef] = ...,  # (2)
    NodeDescription: str = ...,
) -> CreateNodeFromTemplateJobResponseTypeDef:  # (3)
    ...- See TemplateTypeType
- See Sequence[JobResourceTagsUnionTypeDef]
- See CreateNodeFromTemplateJobResponseTypeDef
# create_node_from_template_job method usage example with argument unpacking
kwargs: CreateNodeFromTemplateJobRequestTypeDef = {  # (1)
    "NodeName": ...,
    "OutputPackageName": ...,
    "OutputPackageVersion": ...,
    "TemplateParameters": ...,
    "TemplateType": ...,
}
parent.create_node_from_template_job(**kwargs)create_package#
Creates a package and storage location in an Amazon S3 access point.
Type annotations and code completion for boto3.client("panorama").create_package method.
 boto3 documentation
# create_package method definition
def create_package(
    self,
    *,
    PackageName: str,
    Tags: Mapping[str, str] = ...,
) -> CreatePackageResponseTypeDef:  # (1)
    ...# create_package method usage example with argument unpacking
kwargs: CreatePackageRequestTypeDef = {  # (1)
    "PackageName": ...,
}
parent.create_package(**kwargs)create_package_import_job#
Imports a node package.
Type annotations and code completion for boto3.client("panorama").create_package_import_job method.
 boto3 documentation
# create_package_import_job method definition
def create_package_import_job(
    self,
    *,
    ClientToken: str,
    InputConfig: PackageImportJobInputConfigTypeDef,  # (1)
    JobType: PackageImportJobTypeType,  # (2)
    OutputConfig: PackageImportJobOutputConfigTypeDef,  # (3)
    JobTags: Sequence[JobResourceTagsUnionTypeDef] = ...,  # (4)
) -> CreatePackageImportJobResponseTypeDef:  # (5)
    ...- See PackageImportJobInputConfigTypeDef
- See PackageImportJobTypeType
- See PackageImportJobOutputConfigTypeDef
- See Sequence[JobResourceTagsUnionTypeDef]
- See CreatePackageImportJobResponseTypeDef
# create_package_import_job method usage example with argument unpacking
kwargs: CreatePackageImportJobRequestTypeDef = {  # (1)
    "ClientToken": ...,
    "InputConfig": ...,
    "JobType": ...,
    "OutputConfig": ...,
}
parent.create_package_import_job(**kwargs)delete_device#
Deletes a device.
Type annotations and code completion for boto3.client("panorama").delete_device method.
 boto3 documentation
# delete_device method definition
def delete_device(
    self,
    *,
    DeviceId: str,
) -> DeleteDeviceResponseTypeDef:  # (1)
    ...# delete_device method usage example with argument unpacking
kwargs: DeleteDeviceRequestTypeDef = {  # (1)
    "DeviceId": ...,
}
parent.delete_device(**kwargs)delete_package#
Deletes a package.
Type annotations and code completion for boto3.client("panorama").delete_package method.
 boto3 documentation
# delete_package method definition
def delete_package(
    self,
    *,
    PackageId: str,
    ForceDelete: bool = ...,
) -> Dict[str, Any]:
    ...# delete_package method usage example with argument unpacking
kwargs: DeletePackageRequestTypeDef = {  # (1)
    "PackageId": ...,
}
parent.delete_package(**kwargs)deregister_package_version#
Deregisters a package version.
Type annotations and code completion for boto3.client("panorama").deregister_package_version method.
 boto3 documentation
# deregister_package_version method definition
def deregister_package_version(
    self,
    *,
    PackageId: str,
    PackageVersion: str,
    PatchVersion: str,
    OwnerAccount: str = ...,
    UpdatedLatestPatchVersion: str = ...,
) -> Dict[str, Any]:
    ...# deregister_package_version method usage example with argument unpacking
kwargs: DeregisterPackageVersionRequestTypeDef = {  # (1)
    "PackageId": ...,
    "PackageVersion": ...,
    "PatchVersion": ...,
}
parent.deregister_package_version(**kwargs)describe_application_instance#
Returns information about an application instance on a device.
Type annotations and code completion for boto3.client("panorama").describe_application_instance method.
 boto3 documentation
# describe_application_instance method definition
def describe_application_instance(
    self,
    *,
    ApplicationInstanceId: str,
) -> DescribeApplicationInstanceResponseTypeDef:  # (1)
    ...# describe_application_instance method usage example with argument unpacking
kwargs: DescribeApplicationInstanceRequestTypeDef = {  # (1)
    "ApplicationInstanceId": ...,
}
parent.describe_application_instance(**kwargs)describe_application_instance_details#
Returns information about an application instance's configuration manifest.
Type annotations and code completion for boto3.client("panorama").describe_application_instance_details method.
 boto3 documentation
# describe_application_instance_details method definition
def describe_application_instance_details(
    self,
    *,
    ApplicationInstanceId: str,
) -> DescribeApplicationInstanceDetailsResponseTypeDef:  # (1)
    ...# describe_application_instance_details method usage example with argument unpacking
kwargs: DescribeApplicationInstanceDetailsRequestTypeDef = {  # (1)
    "ApplicationInstanceId": ...,
}
parent.describe_application_instance_details(**kwargs)describe_device#
Returns information about a device.
Type annotations and code completion for boto3.client("panorama").describe_device method.
 boto3 documentation
# describe_device method definition
def describe_device(
    self,
    *,
    DeviceId: str,
) -> DescribeDeviceResponseTypeDef:  # (1)
    ...# describe_device method usage example with argument unpacking
kwargs: DescribeDeviceRequestTypeDef = {  # (1)
    "DeviceId": ...,
}
parent.describe_device(**kwargs)describe_device_job#
Returns information about a device job.
Type annotations and code completion for boto3.client("panorama").describe_device_job method.
 boto3 documentation
# describe_device_job method definition
def describe_device_job(
    self,
    *,
    JobId: str,
) -> DescribeDeviceJobResponseTypeDef:  # (1)
    ...# describe_device_job method usage example with argument unpacking
kwargs: DescribeDeviceJobRequestTypeDef = {  # (1)
    "JobId": ...,
}
parent.describe_device_job(**kwargs)describe_node#
Returns information about a node.
Type annotations and code completion for boto3.client("panorama").describe_node method.
 boto3 documentation
# describe_node method definition
def describe_node(
    self,
    *,
    NodeId: str,
    OwnerAccount: str = ...,
) -> DescribeNodeResponseTypeDef:  # (1)
    ...# describe_node method usage example with argument unpacking
kwargs: DescribeNodeRequestTypeDef = {  # (1)
    "NodeId": ...,
}
parent.describe_node(**kwargs)describe_node_from_template_job#
Returns information about a job to create a camera stream node.
Type annotations and code completion for boto3.client("panorama").describe_node_from_template_job method.
 boto3 documentation
# describe_node_from_template_job method definition
def describe_node_from_template_job(
    self,
    *,
    JobId: str,
) -> DescribeNodeFromTemplateJobResponseTypeDef:  # (1)
    ...# describe_node_from_template_job method usage example with argument unpacking
kwargs: DescribeNodeFromTemplateJobRequestTypeDef = {  # (1)
    "JobId": ...,
}
parent.describe_node_from_template_job(**kwargs)describe_package#
Returns information about a package.
Type annotations and code completion for boto3.client("panorama").describe_package method.
 boto3 documentation
# describe_package method definition
def describe_package(
    self,
    *,
    PackageId: str,
) -> DescribePackageResponseTypeDef:  # (1)
    ...# describe_package method usage example with argument unpacking
kwargs: DescribePackageRequestTypeDef = {  # (1)
    "PackageId": ...,
}
parent.describe_package(**kwargs)describe_package_import_job#
Returns information about a package import job.
Type annotations and code completion for boto3.client("panorama").describe_package_import_job method.
 boto3 documentation
# describe_package_import_job method definition
def describe_package_import_job(
    self,
    *,
    JobId: str,
) -> DescribePackageImportJobResponseTypeDef:  # (1)
    ...# describe_package_import_job method usage example with argument unpacking
kwargs: DescribePackageImportJobRequestTypeDef = {  # (1)
    "JobId": ...,
}
parent.describe_package_import_job(**kwargs)describe_package_version#
Returns information about a package version.
Type annotations and code completion for boto3.client("panorama").describe_package_version method.
 boto3 documentation
# describe_package_version method definition
def describe_package_version(
    self,
    *,
    PackageId: str,
    PackageVersion: str,
    OwnerAccount: str = ...,
    PatchVersion: str = ...,
) -> DescribePackageVersionResponseTypeDef:  # (1)
    ...# describe_package_version method usage example with argument unpacking
kwargs: DescribePackageVersionRequestTypeDef = {  # (1)
    "PackageId": ...,
    "PackageVersion": ...,
}
parent.describe_package_version(**kwargs)list_application_instance_dependencies#
Returns a list of application instance dependencies.
Type annotations and code completion for boto3.client("panorama").list_application_instance_dependencies method.
 boto3 documentation
# list_application_instance_dependencies method definition
def list_application_instance_dependencies(
    self,
    *,
    ApplicationInstanceId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListApplicationInstanceDependenciesResponseTypeDef:  # (1)
    ...# list_application_instance_dependencies method usage example with argument unpacking
kwargs: ListApplicationInstanceDependenciesRequestTypeDef = {  # (1)
    "ApplicationInstanceId": ...,
}
parent.list_application_instance_dependencies(**kwargs)list_application_instance_node_instances#
Returns a list of application node instances.
Type annotations and code completion for boto3.client("panorama").list_application_instance_node_instances method.
 boto3 documentation
# list_application_instance_node_instances method definition
def list_application_instance_node_instances(
    self,
    *,
    ApplicationInstanceId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListApplicationInstanceNodeInstancesResponseTypeDef:  # (1)
    ...# list_application_instance_node_instances method usage example with argument unpacking
kwargs: ListApplicationInstanceNodeInstancesRequestTypeDef = {  # (1)
    "ApplicationInstanceId": ...,
}
parent.list_application_instance_node_instances(**kwargs)list_application_instances#
Returns a list of application instances.
Type annotations and code completion for boto3.client("panorama").list_application_instances method.
 boto3 documentation
# list_application_instances method definition
def list_application_instances(
    self,
    *,
    DeviceId: str = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
    StatusFilter: StatusFilterType = ...,  # (1)
) -> ListApplicationInstancesResponseTypeDef:  # (2)
    ...# list_application_instances method usage example with argument unpacking
kwargs: ListApplicationInstancesRequestTypeDef = {  # (1)
    "DeviceId": ...,
}
parent.list_application_instances(**kwargs)list_devices#
Returns a list of devices.
Type annotations and code completion for boto3.client("panorama").list_devices method.
 boto3 documentation
# list_devices method definition
def list_devices(
    self,
    *,
    DeviceAggregatedStatusFilter: DeviceAggregatedStatusType = ...,  # (1)
    MaxResults: int = ...,
    NameFilter: str = ...,
    NextToken: str = ...,
    SortBy: ListDevicesSortByType = ...,  # (2)
    SortOrder: SortOrderType = ...,  # (3)
) -> ListDevicesResponseTypeDef:  # (4)
    ...- See DeviceAggregatedStatusType
- See ListDevicesSortByType
- See SortOrderType
- See ListDevicesResponseTypeDef
# list_devices method usage example with argument unpacking
kwargs: ListDevicesRequestTypeDef = {  # (1)
    "DeviceAggregatedStatusFilter": ...,
}
parent.list_devices(**kwargs)list_devices_jobs#
Returns a list of jobs.
Type annotations and code completion for boto3.client("panorama").list_devices_jobs method.
 boto3 documentation
# list_devices_jobs method definition
def list_devices_jobs(
    self,
    *,
    DeviceId: str = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListDevicesJobsResponseTypeDef:  # (1)
    ...# list_devices_jobs method usage example with argument unpacking
kwargs: ListDevicesJobsRequestTypeDef = {  # (1)
    "DeviceId": ...,
}
parent.list_devices_jobs(**kwargs)list_node_from_template_jobs#
Returns a list of camera stream node jobs.
Type annotations and code completion for boto3.client("panorama").list_node_from_template_jobs method.
 boto3 documentation
# list_node_from_template_jobs method definition
def list_node_from_template_jobs(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListNodeFromTemplateJobsResponseTypeDef:  # (1)
    ...# list_node_from_template_jobs method usage example with argument unpacking
kwargs: ListNodeFromTemplateJobsRequestTypeDef = {  # (1)
    "MaxResults": ...,
}
parent.list_node_from_template_jobs(**kwargs)list_nodes#
Returns a list of nodes.
Type annotations and code completion for boto3.client("panorama").list_nodes method.
 boto3 documentation
# list_nodes method definition
def list_nodes(
    self,
    *,
    Category: NodeCategoryType = ...,  # (1)
    MaxResults: int = ...,
    NextToken: str = ...,
    OwnerAccount: str = ...,
    PackageName: str = ...,
    PackageVersion: str = ...,
    PatchVersion: str = ...,
) -> ListNodesResponseTypeDef:  # (2)
    ...# list_nodes method usage example with argument unpacking
kwargs: ListNodesRequestTypeDef = {  # (1)
    "Category": ...,
}
parent.list_nodes(**kwargs)list_package_import_jobs#
Returns a list of package import jobs.
Type annotations and code completion for boto3.client("panorama").list_package_import_jobs method.
 boto3 documentation
# list_package_import_jobs method definition
def list_package_import_jobs(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListPackageImportJobsResponseTypeDef:  # (1)
    ...# list_package_import_jobs method usage example with argument unpacking
kwargs: ListPackageImportJobsRequestTypeDef = {  # (1)
    "MaxResults": ...,
}
parent.list_package_import_jobs(**kwargs)list_packages#
Returns a list of packages.
Type annotations and code completion for boto3.client("panorama").list_packages method.
 boto3 documentation
# list_packages method definition
def list_packages(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListPackagesResponseTypeDef:  # (1)
    ...# list_packages method usage example with argument unpacking
kwargs: ListPackagesRequestTypeDef = {  # (1)
    "MaxResults": ...,
}
parent.list_packages(**kwargs)list_tags_for_resource#
Returns a list of tags for a resource.
Type annotations and code completion for boto3.client("panorama").list_tags_for_resource method.
 boto3 documentation
# list_tags_for_resource method definition
def list_tags_for_resource(
    self,
    *,
    ResourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...# list_tags_for_resource method usage example with argument unpacking
kwargs: ListTagsForResourceRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)provision_device#
Creates a device and returns a configuration archive.
Type annotations and code completion for boto3.client("panorama").provision_device method.
 boto3 documentation
# provision_device method definition
def provision_device(
    self,
    *,
    Name: str,
    Description: str = ...,
    NetworkingConfiguration: NetworkPayloadUnionTypeDef = ...,  # (1)
    Tags: Mapping[str, str] = ...,
) -> ProvisionDeviceResponseTypeDef:  # (2)
    ...# provision_device method usage example with argument unpacking
kwargs: ProvisionDeviceRequestTypeDef = {  # (1)
    "Name": ...,
}
parent.provision_device(**kwargs)register_package_version#
Registers a package version.
Type annotations and code completion for boto3.client("panorama").register_package_version method.
 boto3 documentation
# register_package_version method definition
def register_package_version(
    self,
    *,
    PackageId: str,
    PackageVersion: str,
    PatchVersion: str,
    MarkLatest: bool = ...,
    OwnerAccount: str = ...,
) -> Dict[str, Any]:
    ...# register_package_version method usage example with argument unpacking
kwargs: RegisterPackageVersionRequestTypeDef = {  # (1)
    "PackageId": ...,
    "PackageVersion": ...,
    "PatchVersion": ...,
}
parent.register_package_version(**kwargs)remove_application_instance#
Removes an application instance.
Type annotations and code completion for boto3.client("panorama").remove_application_instance method.
 boto3 documentation
# remove_application_instance method definition
def remove_application_instance(
    self,
    *,
    ApplicationInstanceId: str,
) -> Dict[str, Any]:
    ...# remove_application_instance method usage example with argument unpacking
kwargs: RemoveApplicationInstanceRequestTypeDef = {  # (1)
    "ApplicationInstanceId": ...,
}
parent.remove_application_instance(**kwargs)signal_application_instance_node_instances#
Signal camera nodes to stop or resume.
Type annotations and code completion for boto3.client("panorama").signal_application_instance_node_instances method.
 boto3 documentation
# signal_application_instance_node_instances method definition
def signal_application_instance_node_instances(
    self,
    *,
    ApplicationInstanceId: str,
    NodeSignals: Sequence[NodeSignalTypeDef],  # (1)
) -> SignalApplicationInstanceNodeInstancesResponseTypeDef:  # (2)
    ...- See Sequence[NodeSignalTypeDef]
- See SignalApplicationInstanceNodeInstancesResponseTypeDef
# signal_application_instance_node_instances method usage example with argument unpacking
kwargs: SignalApplicationInstanceNodeInstancesRequestTypeDef = {  # (1)
    "ApplicationInstanceId": ...,
    "NodeSignals": ...,
}
parent.signal_application_instance_node_instances(**kwargs)tag_resource#
Tags a resource.
Type annotations and code completion for boto3.client("panorama").tag_resource method.
 boto3 documentation
# tag_resource method definition
def tag_resource(
    self,
    *,
    ResourceArn: str,
    Tags: Mapping[str, str],
) -> Dict[str, Any]:
    ...# tag_resource method usage example with argument unpacking
kwargs: TagResourceRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "Tags": ...,
}
parent.tag_resource(**kwargs)untag_resource#
Removes tags from a resource.
Type annotations and code completion for boto3.client("panorama").untag_resource method.
 boto3 documentation
# untag_resource method definition
def untag_resource(
    self,
    *,
    ResourceArn: str,
    TagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...# untag_resource method usage example with argument unpacking
kwargs: UntagResourceRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "TagKeys": ...,
}
parent.untag_resource(**kwargs)update_device_metadata#
Updates a device's metadata.
Type annotations and code completion for boto3.client("panorama").update_device_metadata method.
 boto3 documentation
# update_device_metadata method definition
def update_device_metadata(
    self,
    *,
    DeviceId: str,
    Description: str = ...,
) -> UpdateDeviceMetadataResponseTypeDef:  # (1)
    ...# update_device_metadata method usage example with argument unpacking
kwargs: UpdateDeviceMetadataRequestTypeDef = {  # (1)
    "DeviceId": ...,
}
parent.update_device_metadata(**kwargs)