PanoramaClient#
Auto-generated documentation for Panorama type annotations stubs module mypy-boto3-panorama.
PanoramaClient#
Type annotations and code completion for boto3.client("panorama")
.
boto3 documentation
# PanoramaClient usage example
from boto3.session import Session
from mypy_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 mypy_boto3_panorama.client import Exceptions
def handle_error(exc: Exceptions.AccessDeniedException) -> None:
...
Methods#
can_paginate#
Check if an operation can be paginated.
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:
...
close#
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("panorama").close
method.
boto3 documentation
# close method definition
def close(
self,
) -> None:
...
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: CreateApplicationInstanceRequestRequestTypeDef = { # (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: CreateJobForDevicesRequestRequestTypeDef = { # (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[JobResourceTagsTypeDef] = ..., # (2)
NodeDescription: str = ...,
) -> CreateNodeFromTemplateJobResponseTypeDef: # (3)
...
# create_node_from_template_job method usage example with argument unpacking
kwargs: CreateNodeFromTemplateJobRequestRequestTypeDef = { # (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: CreatePackageRequestRequestTypeDef = { # (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[JobResourceTagsTypeDef] = ..., # (4)
) -> CreatePackageImportJobResponseTypeDef: # (5)
...
- See PackageImportJobInputConfigTypeDef
- See PackageImportJobTypeType
- See PackageImportJobOutputConfigTypeDef
- See JobResourceTagsTypeDef
- See CreatePackageImportJobResponseTypeDef
# create_package_import_job method usage example with argument unpacking
kwargs: CreatePackageImportJobRequestRequestTypeDef = { # (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: DeleteDeviceRequestRequestTypeDef = { # (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: DeletePackageRequestRequestTypeDef = { # (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: DeregisterPackageVersionRequestRequestTypeDef = { # (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: DescribeApplicationInstanceRequestRequestTypeDef = { # (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: DescribeApplicationInstanceDetailsRequestRequestTypeDef = { # (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: DescribeDeviceRequestRequestTypeDef = { # (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: DescribeDeviceJobRequestRequestTypeDef = { # (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: DescribeNodeRequestRequestTypeDef = { # (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
kwa