AWS Panorama API
The AWS Panorama API provides programmatic access to create and manage appliances, application instances, packages, nodes, and device jobs for deploying computer vision applications to edge cameras.
The AWS Panorama API provides programmatic access to create and manage appliances, application instances, packages, nodes, and device jobs for deploying computer vision applications to edge cameras.
openapi: 3.0.0
info:
version: '2019-07-24'
x-release: v4
title: AWS Panorama
description: '<p><fullname>AWS Panorama</fullname> <p> <b>Overview</b> </p> <p>This is the <i>AWS Panorama API Reference</i>. For an introduction to the service, see <a href="https://docs.aws.amazon.com/panorama/latest/dev/panorama-welcome.html">What
is AWS Panorama?</a> in the <i>AWS Panorama Developer Guide</i>.</p></p>'
x-logo:
url: 'https://twitter.com/awscloud/profile_image?size=original'
backgroundColor: '#FFFFFF'
termsOfService: 'https://aws.amazon.com/service-terms/'
contact:
name: Mike Ralphson
email: [email protected]
url: 'https://github.com/mermade/aws2openapi'
x-twitter: PermittedSoc
license:
name: Apache 2.0 License
url: 'http://www.apache.org/licenses/'
x-providerName: amazonaws.com
x-serviceName: panorama
x-aws-signingName: panorama
x-origin:
- contentType: application/json
url: 'https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/panorama-2019-07-24.normal.json'
converter:
url: 'https://github.com/mermade/aws2openapi'
version: 1.0.0
x-apisguru-driver: external
x-apiClientRegistration:
url: 'https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct'
x-apisguru-categories:
- cloud
x-preferred: true
externalDocs:
description: Amazon Web Services documentation
url: 'https://docs.aws.amazon.com/panorama/'
servers:
- url: 'http://panorama.{region}.amazonaws.com'
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The Panorama multi-region endpoint
- url: 'https://panorama.{region}.amazonaws.com'
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The Panorama multi-region endpoint
- url: 'http://panorama.{region}.amazonaws.com.cn'
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The Panorama endpoint for China (Beijing) and China (Ningxia)
- url: 'https://panorama.{region}.amazonaws.com.cn'
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The Panorama endpoint for China (Beijing) and China (Ningxia)
x-hasEquivalentPaths: true
paths:
/application-instances:
post:
operationId: CreateApplicationInstance
description: Creates an application instance and deploys it to a device.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateApplicationInstanceResponse'
examples:
CreateApplicationInstance200Example:
summary: Default CreateApplicationInstance 200 response
x-microcks-default: true
value:
ApplicationInstanceId: resource-abc123
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
'483':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- DefaultRuntimeContextDevice
- ManifestPayload
properties:
ApplicationInstanceIdToReplace:
description: The ID of an application instance to replace with the new instance.
type: string
pattern: '^[a-zA-Z0-9\-\_]+$'
minLength: 1
maxLength: 255
DefaultRuntimeContextDevice:
description: A device's ID.
type: string
pattern: '^[a-zA-Z0-9\-\_]+$'
minLength: 1
maxLength: 255
Description:
description: A description for the application instance.
type: string
pattern: ^.*$
minLength: 0
maxLength: 255
ManifestOverridesPayload:
description: Parameter overrides for an application instance. This is a JSON document that has a single key (<code>PayloadData</code>) where the value is an escaped string
representation of the overrides document.
type: object
properties:
PayloadData:
allOf:
- $ref: '#/components/schemas/ManifestOverridesPayloadData'
- description: The overrides document.
ManifestPayload:
description: A application verion's manifest file. This is a JSON document that has a single key (<code>PayloadData</code>) where the value is an escaped string representation of the
application manifest (<code>graph.json</code>). This file is located in the <code>graphs</code> folder in your application source.
type: object
properties:
PayloadData:
allOf:
- $ref: '#/components/schemas/ManifestPayloadData'
- description: The application manifest.
Name:
description: A name for the application instance.
type: string
pattern: '^[a-zA-Z0-9\-\_]+$'
minLength: 1
maxLength: 255
RuntimeRoleArn:
description: The ARN of a runtime role for the application instance.
type: string
pattern: '^arn:[a-z0-9][-.a-z0-9]{0,62}:iam::[0-9]{12}:role/.+$'
minLength: 1
maxLength: 255
Tags:
description: Tags for the application instance.
type: object
minProperties: 0
maxProperties: 50
additionalProperties:
$ref: '#/components/schemas/TagValue'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
summary: Amazon Panorama Create Application Instance
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
get:
operationId: ListApplicationInstances
description: Returns a list of application instances.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListApplicationInstancesResponse'
examples:
ListApplicationInstances200Example:
summary: Default ListApplicationInstances 200 response
x-microcks-default: true
value:
ApplicationInstances: example-string
NextToken: example-string
'480':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'481':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
parameters:
- name: deviceId
in: query
required: false
description: The application instances' device ID.
schema:
type: string
pattern: '^[a-zA-Z0-9\-\_]+$'
minLength: 1
maxLength: 255
- name: maxResults
in: query
required: false
description: The maximum number of application instances to return in one page of results.
schema:
type: integer
minimum: 0
maximum: 25
- name: nextToken
in: query
required: false
description: Specify the pagination token from a previous request to retrieve the next page of results.
schema:
type: string
pattern: ^.+$
minLength: 1
maxLength: 4096
- name: statusFilter
in: query
required: false
description: Only include instances with a specific status.
schema:
type: string
enum:
- DEPLOYMENT_SUCCEEDED
- DEPLOYMENT_ERROR
- REMOVAL_SUCCEEDED
- REMOVAL_FAILED
- PROCESSING_DEPLOYMENT
- PROCESSING_REMOVAL
- DEPLOYMENT_FAILED
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
summary: Amazon Panorama List Application Instances
/jobs:
post:
operationId: CreateJobForDevices
description: Creates a job to run on a device. A job can update a device's software or reboot it.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateJobForDevicesResponse'
examples:
CreateJobForDevices200Example:
summary: Default CreateJobForDevices 200 response
x-microcks-default: true
value:
Jobs: example-string
'480':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'481':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'482':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'484':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- DeviceIds
- JobType
properties:
DeviceIds:
description: ID of target device.
type: array
items:
$ref: '#/components/schemas/DeviceId'
minItems: 1
maxItems: 1
DeviceJobConfig:
description: A job's configuration.
type: object
properties:
OTAJobConfig:
allOf:
- $ref: '#/components/schemas/OTAJobConfig'
- description: A configuration for an over-the-air (OTA) upgrade. Required for OTA jobs.
JobType:
description: The type of job to run.
type: string
enum:
- OTA
- REBOOT
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
summary: Amazon Panorama Create Job for Devices
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
get:
operationId: ListDevicesJobs
description: Returns a list of jobs.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListDevicesJobsResponse'
examples:
ListDevicesJobs200Example:
summary: Default ListDevicesJobs 200 response
x-microcks-default: true
value:
DeviceJobs: example-string
NextToken: example-string
'480':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'481':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'482':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'484':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
parameters:
- name: DeviceId
in: query
required: false
description: Filter results by the job's target device ID.
schema:
type: string
pattern: '^[a-zA-Z0-9\-\_]+$'
minLength: 1
maxLength: 255
- name: MaxResults
in: query
required: false
description: The maximum number of device jobs to return in one page of results.
schema:
type: integer
minimum: 0
maximum: 25
- name: NextToken
in: query
required: false
description: Specify the pagination token from a previous request to retrieve the next page of results.
schema:
type: string
pattern: ^.+$
minLength: 1
maxLength: 4096
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
summary: Amazon Panorama List Devices Jobs
/packages/template-job:
post:
operationId: CreateNodeFromTemplateJob
description: Creates a camera stream node.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateNodeFromTemplateJobResponse'
examples:
CreateNodeFromTemplateJob200Example:
summary: Default CreateNodeFromTemplateJob 200 response
x-microcks-default: true
value:
JobId: resource-abc123
'480':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'481':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'482':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'483':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- NodeName
- OutputPackageName
- OutputPackageVersion
- TemplateParameters
- TemplateType
properties:
JobTags:
description: Tags for the job.
type: array
items:
$ref: '#/components/schemas/JobResourceTags'
NodeDescription:
description: A description for the node.
type: string
pattern: ^.*$
minLength: 0
maxLength: 255
NodeName:
description: A name for the node.
type: string
pattern: '^[a-zA-Z0-9\-\_]+$'
minLength: 1
maxLength: 128
OutputPackageName:
description: An output package name for the node.
type: string
pattern: '^[a-zA-Z0-9\-\_]+$'
minLength: 1
maxLength: 128
OutputPackageVersion:
description: An output package version for the node.
type: string
pattern: '^([0-9]+)\.([0-9]+)$'
minLength: 1
maxLength: 255
TemplateParameters:
description: Template parameters for the node.
type: object
additionalProperties:
$ref: '#/components/schemas/TemplateValue'
TemplateType:
description: The type of node.
type: string
enum:
- RTSP_CAMERA_STREAM
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
summary: Amazon Panorama Create Node from Template Job
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
get:
operationId: ListNodeFromTemplateJobs
description: Returns a list of camera stream node jobs.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListNodeFromTemplateJobsResponse'
examples:
ListNodeFromTemplateJobs200Example:
summary: Default ListNodeFromTemplateJobs 200 response
x-microcks-default: true
value:
NextToken: example-string
NodeFromTemplateJobs: example-string
'480':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'481':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'482':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'483':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
parameters:
- name: MaxResults
in: query
required: false
description: The maximum number of node from template jobs to return in one page of results.
schema:
type: integer
minimum: 0
maximum: 25
- name: NextToken
in: query
required: false
description: Specify the pagination token from a previous request to retrieve the next page of results.
schema:
type: string
pattern: ^.+$
minLength: 1
maxLength: 4096
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
summary: Amazon Panorama List Node from Template Jobs
/packages:
post:
operationId: CreatePackage
description: Creates a package and storage location in an Amazon S3 access point.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreatePackageResponse'
examples:
CreatePackage200Example:
summary: Default CreatePackage 200 response
x-microcks-default: true
value:
Arn: arn:aws:service:us-east-1:123456789012:resource/example
PackageId: resource-abc123
StorageLocation: example-string
'480':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'481':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'482':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'483':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- PackageName
properties:
PackageName:
description: A name for the package.
type: string
pattern: '^[a-zA-Z0-9\-\_]+$'
minLength: 1
maxLength: 128
Tags:
description: Tags for the package.
type: object
minProperties: 0
maxProperties: 50
additionalProperties:
$ref: '#/components/schemas/TagValue'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
summary: Amazon Panorama Create Package
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
get:
operationId: ListPackages
description: Returns a list of packages.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListPackagesResponse'
examples:
ListPackages200Example:
summary: Default ListPackages 200 response
x-microcks-default: true
value:
NextToken: example-string
Packages: example-string
'480':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'481':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'482':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'484':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
parameters:
- name: maxResults
in: query
required: false
description: The maximum number of packages to return in one page of results.
schema:
type: integer
minimum: 0
maximum: 25
- name: nextToken
in: query
required: false
description: Specify the pagination token from a previous request to retrieve the next page of results.
schema:
type: string
pattern: ^.+$
minLength: 1
maxLength: 4096
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
summary: Amazon Panorama List Packages
/packages/import-jobs:
post:
operationId: CreatePackageImportJob
description: Imports a node package.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreatePackageImportJobResponse'
examples:
CreatePackageImportJob200Example:
summary: Default CreatePackageImportJob 200 response
x-microcks-default: true
value:
JobId: resource-abc123
'480':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'481':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'482':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'483':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- ClientToken
- InputConfig
- JobType
- OutputConfig
properties:
ClientToken:
description: A client token for the package import job.
type: string
pattern: '^[a-zA-Z0-9\-\_]+$'
minLength: 1
maxLength: 64
InputConfig:
description: A configuration for a package import job.
type: object
properties:
PackageVersionInputConfig:
allOf:
- $ref: '#/components/schemas/PackageVersionInputConfig'
- description: The package version's input configuration.
JobTags:
description: Tags for the package import job.
type: array
items:
$ref: '#/components/schemas/JobResourceTags'
JobType:
description: A job type for the package import job.
type: string
enum:
- NODE_PACKAGE_VERSION
- MARKETPLACE_NODE_PACKAGE_VERSION
OutputConfig:
description: An output configuration for a package import job.
type: object
properties:
PackageVersionOutputConfig:
allOf:
- $ref: '#/components/schemas/PackageVersionOutputConfig'
- description: The package version's output configuration.
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
summary: Amazon Panorama Create Package Import Job
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
get:
operationId: ListPackageImportJobs
description: Returns a list of package import jobs.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListPackageImportJobsResponse'
examples:
ListPackageImportJobs200Example:
summary: Default ListPackageImportJobs 200 response
x-microcks-default: true
value:
NextToken: example-string
PackageImportJobs: example-string
'480':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'481':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
# --- truncated at 32 KB (170 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amazon-panorama/refs/heads/main/openapi/amazon-panorama-openapi.yml