PanoramaClient
Auto-generated documentation for Panorama type annotations stubs module types-aiobotocore-panorama.
PanoramaClient
Type annotations and code completion for session.client("panorama")
boto3 documentation
from aioboto3.session import Session
from types_aiobotocore_panorama.client import PanoramaClient
session = Session()
async with session.client("panorama") as client:
client: PanoramaClient
Exceptions
aioboto3
client exceptions are generated in runtime.
This class provides code completion for session.client("panorama").exceptions
structure.
async with session.client("panorama") as client:
try:
do_something(client)
except (
client.AccessDeniedException,
client.ClientError,
client.ConflictException,
client.InternalServerException,
client.ResourceNotFoundException,
client.ServiceQuotaExceededException,
client.ValidationException,
) as e:
print(e)
from types_aiobotocore_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 session.client("panorama").can_paginate
method.
boto3 documentation
close
Closes underlying endpoint connections.
Type annotations and code completion for session.client("panorama").close
method.
boto3 documentation
create_application_instance
Creates an application instance and deploys it to a device.
Type annotations and code completion for session.client("panorama").create_application_instance
method.
boto3 documentation
await 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
kwargs: CreateApplicationInstanceRequestRequestTypeDef = { # (1)
"DefaultRuntimeContextDevice": ...,
"ManifestPayload": ...,
}
parent.create_application_instance(**kwargs)
create_job_for_devices
Creates a job to run on one or more devices.
Type annotations and code completion for session.client("panorama").create_job_for_devices
method.
boto3 documentation
await def create_job_for_devices(
self,
*,
DeviceIds: Sequence[str],
DeviceJobConfig: DeviceJobConfigTypeDef, # (1)
JobType: JobTypeType, # (2)
) -> CreateJobForDevicesResponseTypeDef: # (3)
...
kwargs: CreateJobForDevicesRequestRequestTypeDef = { # (1)
"DeviceIds": ...,
"DeviceJobConfig": ...,
"JobType": ...,
}
parent.create_job_for_devices(**kwargs)
create_node_from_template_job
Creates a camera stream node.
Type annotations and code completion for session.client("panorama").create_node_from_template_job
method.
boto3 documentation
await 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)
...
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 session.client("panorama").create_package
method.
boto3 documentation
await def create_package(
self,
*,
PackageName: str,
Tags: Mapping[str, str] = ...,
) -> CreatePackageResponseTypeDef: # (1)
...
kwargs: CreatePackageRequestRequestTypeDef = { # (1)
"PackageName": ...,
}
parent.create_package(**kwargs)
create_package_import_job
Imports a node package.
Type annotations and code completion for session.client("panorama").create_package_import_job
method.
boto3 documentation
await 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
kwargs: CreatePackageImportJobRequestRequestTypeDef = { # (1)
"ClientToken": ...,
"InputConfig": ...,
"JobType": ...,
"OutputConfig": ...,
}
parent.create_package_import_job(**kwargs)
delete_device
Deletes a device.
Type annotations and code completion for session.client("panorama").delete_device
method.
boto3 documentation
await def delete_device(
self,
*,
DeviceId: str,
) -> DeleteDeviceResponseTypeDef: # (1)
...
kwargs: DeleteDeviceRequestRequestTypeDef = { # (1)
"DeviceId": ...,
}
parent.delete_device(**kwargs)
delete_package
Deletes a package.
Type annotations and code completion for session.client("panorama").delete_package
method.
boto3 documentation
await def delete_package(
self,
*,
PackageId: str,
ForceDelete: bool = ...,
) -> Dict[str, Any]:
...
kwargs: DeletePackageRequestRequestTypeDef = { # (1)
"PackageId": ...,
}
parent.delete_package(**kwargs)
deregister_package_version
Deregisters a package version.
Type annotations and code completion for session.client("panorama").deregister_package_version
method.
boto3 documentation
await def deregister_package_version(
self,
*,
PackageId: str,
PackageVersion: str,
PatchVersion: str,
OwnerAccount: str = ...,
UpdatedLatestPatchVersion: str = ...,
) -> Dict[str, Any]:
...
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 session.client("panorama").describe_application_instance
method.
boto3 documentation
await def describe_application_instance(
self,
*,
ApplicationInstanceId: str,
) -> DescribeApplicationInstanceResponseTypeDef: # (1)
...
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 session.client("panorama").describe_application_instance_details
method.
boto3 documentation
await def describe_application_instance_details(
self,
*,
ApplicationInstanceId: str,
) -> DescribeApplicationInstanceDetailsResponseTypeDef: # (1)
...
kwargs: DescribeApplicationInstanceDetailsRequestRequestTypeDef = { # (1)
"ApplicationInstanceId": ...,
}
parent.describe_application_instance_details(**kwargs)
describe_device
Returns information about a device.
Type annotations and code completion for session.client("panorama").describe_device
method.
boto3 documentation
await def describe_device(
self,
*,
DeviceId: str,
) -> DescribeDeviceResponseTypeDef: # (1)
...
kwargs: DescribeDeviceRequestRequestTypeDef = { # (1)
"DeviceId": ...,
}
parent.describe_device(**kwargs)
describe_device_job
Returns information about a device job.
Type annotations and code completion for session.client("panorama").describe_device_job
method.
boto3 documentation
await def describe_device_job(
self,
*,
JobId: str,
) -> DescribeDeviceJobResponseTypeDef: # (1)
...
kwargs: DescribeDeviceJobRequestRequestTypeDef = { # (1)
"JobId": ...,
}
parent.describe_device_job(**kwargs)
describe_node
Returns information about a node.
Type annotations and code completion for session.client("panorama").describe_node
method.
boto3 documentation
await def describe_node(
self,
*,
NodeId: str,
OwnerAccount: str = ...,
) -> DescribeNodeResponseTypeDef: # (1)
...
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 session.client("panorama").describe_node_from_template_job
method.
boto3 documentation
await def describe_node_from_template_job(
self,
*,
JobId: str,
) -> DescribeNodeFromTemplateJobResponseTypeDef: # (1)
...
kwargs: DescribeNodeFromTemplateJobRequestRequestTypeDef = { # (1)
"JobId": ...,
}
parent.describe_node_from_template_job(**kwargs)
describe_package
Returns information about a package.
Type annotations and code completion for session.client("panorama").describe_package
method.
boto3 documentation
await def describe_package(
self,
*,
PackageId: str,
) -> DescribePackageResponseTypeDef: # (1)
...
kwargs: DescribePackageRequestRequestTypeDef = { # (1)
"PackageId": ...,
}
parent.describe_package(**kwargs)
describe_package_import_job
Returns information about a package import job.
Type annotations and code completion for session.client("panorama").describe_package_import_job
method.
boto3 documentation
await def describe_package_import_job(
self,
*,
JobId: str,
) -> DescribePackageImportJobResponseTypeDef: # (1)
...
kwargs: DescribePackageImportJobRequestRequestTypeDef = { # (1)
"JobId": ...,
}
parent.describe_package_import_job(**kwargs)
describe_package_version
Returns information about a package version.
Type annotations and code completion for session.client("panorama").describe_package_version
method.
boto3 documentation
await def describe_package_version(
self,
*,
PackageId: str,
PackageVersion: str,
OwnerAccount: str = ...,
PatchVersion: str = ...,
) -> DescribePackageVersionResponseTypeDef: # (1)
...
kwargs: DescribePackageVersionRequestRequestTypeDef = { # (1)
"PackageId": ...,
"PackageVersion": ...,
}
parent.describe_package_version(**kwargs)
generate_presigned_url
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for session.client("panorama").generate_presigned_url
method.
boto3 documentation
await def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...
list_application_instance_dependencies
Returns a list of application instance dependencies.
Type annotations and code completion for session.client("panorama").list_application_instance_dependencies
method.
boto3 documentation
await def list_application_instance_dependencies(
self,
*,
ApplicationInstanceId: str,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListApplicationInstanceDependenciesResponseTypeDef: # (1)
...
kwargs: ListApplicationInstanceDependenciesRequestRequestTypeDef = { # (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 session.client("panorama").list_application_instance_node_instances
method.
boto3 documentation
await def list_application_instance_node_instances(
self,
*,
ApplicationInstanceId: str,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListApplicationInstanceNodeInstancesResponseTypeDef: # (1)
...
kwargs: ListApplicationInstanceNodeInstancesRequestRequestTypeDef = { # (1)
"ApplicationInstanceId": ...,
}
parent.list_application_instance_node_instances(**kwargs)
list_application_instances
Returns a list of application instances.
Type annotations and code completion for session.client("panorama").list_application_instances
method.
boto3 documentation
await def list_application_instances(
self,
*,
DeviceId: str = ...,
MaxResults: int = ...,
NextToken: str = ...,
StatusFilter: StatusFilterType = ..., # (1)
) -> ListApplicationInstancesResponseTypeDef: # (2)
...
kwargs: ListApplicationInstancesRequestRequestTypeDef = { # (1)
"DeviceId": ...,
}
parent.list_application_instances(**kwargs)
list_devices
Returns a list of devices.
Type annotations and code completion for session.client("panorama").list_devices
method.
boto3 documentation
await def list_devices(
self,
*,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListDevicesResponseTypeDef: # (1)
...
kwargs: ListDevicesRequestRequestTypeDef = { # (1)
"MaxResults": ...,
}
parent.list_devices(**kwargs)
list_devices_jobs
Returns a list of jobs.
Type annotations and code completion for session.client("panorama").list_devices_jobs
method.
boto3 documentation
await def list_devices_jobs(
self,
*,
DeviceId: str = ...,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListDevicesJobsResponseTypeDef: # (1)
...
kwargs: ListDevicesJobsRequestRequestTypeDef = { # (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 session.client("panorama").list_node_from_template_jobs
method.
boto3 documentation
await def list_node_from_template_jobs(
self,
*,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListNodeFromTemplateJobsResponseTypeDef: # (1)
...
kwargs: ListNodeFromTemplateJobsRequestRequestTypeDef = { # (1)
"MaxResults": ...,
}
parent.list_node_from_template_jobs(**kwargs)
list_nodes
Returns a list of nodes.
Type annotations and code completion for session.client("panorama").list_nodes
method.
boto3 documentation
await def list_nodes(
self,
*,
Category: NodeCategoryType = ..., # (1)
MaxResults: int = ...,
NextToken: str = ...,
OwnerAccount: str = ...,
PackageName: str = ...,
PackageVersion: str = ...,
PatchVersion: str = ...,
) -> ListNodesResponseTypeDef: # (2)
...
kwargs: ListNodesRequestRequestTypeDef = { # (1)
"Category": ...,
}
parent.list_nodes(**kwargs)
list_package_import_jobs
Returns a list of package import jobs.
Type annotations and code completion for session.client("panorama").list_package_import_jobs
method.
boto3 documentation
await def list_package_import_jobs(
self,
*,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListPackageImportJobsResponseTypeDef: # (1)
...
kwargs: ListPackageImportJobsRequestRequestTypeDef = { # (1)
"MaxResults": ...,
}
parent.list_package_import_jobs(**kwargs)
list_packages
Returns a list of packages.
Type annotations and code completion for session.client("panorama").list_packages
method.
boto3 documentation
await def list_packages(
self,
*,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListPackagesResponseTypeDef: # (1)
...
kwargs: ListPackagesRequestRequestTypeDef = { # (1)
"MaxResults": ...,
}
parent.list_packages(**kwargs)
list_tags_for_resource
Returns a list of tags for a resource.
Type annotations and code completion for session.client("panorama").list_tags_for_resource
method.
boto3 documentation
await def list_tags_for_resource(
self,
*,
ResourceArn: str,
) -> ListTagsForResourceResponseTypeDef: # (1)
...
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)
provision_device
Creates a device and returns a configuration archive.
Type annotations and code completion for session.client("panorama").provision_device
method.
boto3 documentation
await def provision_device(
self,
*,
Name: str,
Description: str = ...,
NetworkingConfiguration: NetworkPayloadTypeDef = ..., # (1)
Tags: Mapping[str, str] = ...,
) -> ProvisionDeviceResponseTypeDef: # (2)
...
kwargs: ProvisionDeviceRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.provision_device(**kwargs)
register_package_version
Registers a package version.
Type annotations and code completion for session.client("panorama").register_package_version
method.
boto3 documentation
await def register_package_version(
self,
*,
PackageId: str,
PackageVersion: str,
PatchVersion: str,
MarkLatest: bool = ...,
OwnerAccount: str = ...,
) -> Dict[str, Any]:
...
kwargs: RegisterPackageVersionRequestRequestTypeDef = { # (1)
"PackageId": ...,
"PackageVersion": ...,
"PatchVersion": ...,
}
parent.register_package_version(**kwargs)
remove_application_instance
Removes an application instance.
Type annotations and code completion for session.client("panorama").remove_application_instance
method.
boto3 documentation
await def remove_application_instance(
self,
*,
ApplicationInstanceId: str,
) -> Dict[str, Any]:
...
kwargs: RemoveApplicationInstanceRequestRequestTypeDef = { # (1)
"ApplicationInstanceId": ...,
}
parent.remove_application_instance(**kwargs)
tag_resource
Tags a resource.
Type annotations and code completion for session.client("panorama").tag_resource
method.
boto3 documentation
await def tag_resource(
self,
*,
ResourceArn: str,
Tags: Mapping[str, str],
) -> Dict[str, Any]:
...
kwargs: TagResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
"Tags": ...,
}
parent.tag_resource(**kwargs)
untag_resource
Removes tags from a resource.
Type annotations and code completion for session.client("panorama").untag_resource
method.
boto3 documentation
await def untag_resource(
self,
*,
ResourceArn: str,
TagKeys: Sequence[str],
) -> Dict[str, Any]:
...
kwargs: UntagResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
"TagKeys": ...,
}
parent.untag_resource(**kwargs)
update_device_metadata
Updates a device's metadata.
Type annotations and code completion for session.client("panorama").update_device_metadata
method.
boto3 documentation
await def update_device_metadata(
self,
*,
DeviceId: str,
Description: str = ...,
) -> UpdateDeviceMetadataResponseTypeDef: # (1)
...
kwargs: UpdateDeviceMetadataRequestRequestTypeDef = { # (1)
"DeviceId": ...,
}
parent.update_device_metadata(**kwargs)
__aenter__
Type annotations and code completion for session.client("panorama").__aenter__
method.
boto3 documentation
__aexit__
Type annotations and code completion for session.client("panorama").__aexit__
method.
boto3 documentation