# AWS Panorama API

> AWS Panorama API on Apizie: 34 endpoints (Returns a list of application instances., Creates an application instance and deploys it to a device., Returns a list of jobs., Creates a job to run on a device. A job can update a device's software or reboot it., …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/cloud:amazonaws-panorama/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:amazonaws-panorama`
- Category: Cloud
- Status: byok
- Source: https://github.com/mermade/aws2openapi
- Page: https://zieapi.vercel.app/api/cloud/amazonaws-panorama
- OpenAPI: https://zieapi.vercel.app/api/cloud/amazonaws-panorama/openapi.json

AWS Panorama Overview This is the AWS Panorama API Reference . For an introduction to the service, see What is AWS Panorama? in the AWS Panorama Developer Guide .

## Endpoints

### Returns a list of application instances.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-panorama/list-application-instances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| deviceId | string | no | The application instances' device ID. |
| maxResults | integer | no | The maximum number of application instances to return in one page of results. |
| nextToken | string | no | Specify the pagination token from a previous request to retrieve the next page of results. |
| statusFilter | string | no | Only include instances with a specific status. |
| MaxResults | string | no | Pagination limit |
| NextToken | string | no | Pagination token |

### Creates an application instance and deploys it to a device.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-panorama/create-application-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Returns a list of jobs.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-panorama/list-devices-jobs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DeviceId | string | no | Filter results by the job's target device ID. |
| MaxResults | integer | no | The maximum number of device jobs to return in one page of results. |
| NextToken | string | no | Specify the pagination token from a previous request to retrieve the next page of results. |

### Creates a job to run on a device. A job can update a device's software or reboot it.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-panorama/create-job-for-devices` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Returns a list of camera stream node jobs.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-panorama/list-node-from-template-jobs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| MaxResults | integer | no | The maximum number of node from template jobs to return in one page of results. |
| NextToken | string | no | Specify the pagination token from a previous request to retrieve the next page of results. |

### Creates a camera stream node.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-panorama/create-node-from-template-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Returns a list of packages.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-panorama/list-packages` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| maxResults | integer | no | The maximum number of packages to return in one page of results. |
| nextToken | string | no | Specify the pagination token from a previous request to retrieve the next page of results. |
| MaxResults | string | no | Pagination limit |
| NextToken | string | no | Pagination token |

### Creates a package and storage location in an Amazon S3 access point.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-panorama/create-package` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Returns a list of package import jobs.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-panorama/list-package-import-jobs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| MaxResults | integer | no | The maximum number of package import jobs to return in one page of results. |
| NextToken | string | no | Specify the pagination token from a previous request to retrieve the next page of results. |

### Imports a node package.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-panorama/create-package-import-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Returns information about a device.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-panorama/describe-device` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DeviceId | string | yes | The device's ID. |

### Updates a device's metadata.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-panorama/update-device-metadata` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DeviceId | string | yes | The device's ID. |
| body | object | yes | JSON request body |

### Deletes a device.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-panorama/delete-device` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DeviceId | string | yes | The device's ID. |

### Deletes a package. To delete a package, you need permission to call s3:DeleteObject in addition to…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-panorama/delete-package` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| ForceDelete | boolean | no | Delete the package even if it has artifacts stored in its access point. Deletes the package's artifacts from Amazon S3. |
| PackageId | string | yes | The package's ID. |

### Registers a package version.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-panorama/register-package-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| PackageId | string | yes | A package ID. |
| PackageVersion | string | yes | A package version. |
| PatchVersion | string | yes | A patch version. |
| body | object | yes | JSON request body |

### Deregisters a package version.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-panorama/deregister-package-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| OwnerAccount | string | no | An owner account. |
| PackageId | string | yes | A package ID. |
| PackageVersion | string | yes | A package version. |
| PatchVersion | string | yes | A patch version. |
| UpdatedLatestPatchVersion | string | no | If the version was marked latest, the new version to maker as latest. |

### Returns information about an application instance on a device.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-panorama/describe-application-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| ApplicationInstanceId | string | yes | The application instance's ID. |

### Removes an application instance.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-panorama/remove-application-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| ApplicationInstanceId | string | yes | An application instance ID. |

### Returns information about an application instance's configuration manifest.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-panorama/describe-application-instance-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| ApplicationInstanceId | string | yes | The application instance's ID. |

### Returns information about a device job.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-panorama/describe-device-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| JobId | string | yes | The job's ID. |

### Returns information about a node.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-panorama/describe-node` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| NodeId | string | yes | The node's ID. |
| OwnerAccount | string | no | The account ID of the node's owner. |

### Returns information about a job to create a camera stream node.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-panorama/describe-node-from-template-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| JobId | string | yes | The job's ID. |

### Returns information about a package.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-panorama/describe-package` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| PackageId | string | yes | The package's ID. |

### Returns information about a package import job.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-panorama/describe-package-import-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| JobId | string | yes | The job's ID. |

### Returns information about a package version.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-panorama/describe-package-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| OwnerAccount | string | no | The version's owner account. |
| PackageId | string | yes | The version's ID. |
| PackageVersion | string | yes | The version's version. |
| PatchVersion | string | no | The version's patch version. |

### Returns a list of application instance dependencies.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-panorama/list-application-instance-dependencies` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| ApplicationInstanceId | string | yes | The application instance's ID. |
| maxResults | integer | no | The maximum number of application instance dependencies to return in one page of results. |
| nextToken | string | no | Specify the pagination token from a previous request to retrieve the next page of results. |
| MaxResults | string | no | Pagination limit |
| NextToken | string | no | Pagination token |

### Returns a list of application node instances.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-panorama/list-application-instance-node-instances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| ApplicationInstanceId | string | yes | The node instances' application instance ID. |
| maxResults | integer | no | The maximum number of node instances to return in one page of results. |
| nextToken | string | no | Specify the pagination token from a previous request to retrieve the next page of results. |
| MaxResults | string | no | Pagination limit |
| NextToken | string | no | Pagination token |

### Returns a list of devices.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-panorama/list-devices` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DeviceAggregatedStatusFilter | string | no | Filter based on a device's status. |
| MaxResults | integer | no | The maximum number of devices to return in one page of results. |
| NameFilter | string | no | Filter based on device's name. Prefixes supported. |
| NextToken | string | no | Specify the pagination token from a previous request to retrieve the next page of results. |
| SortBy | string | no | The target column to be sorted on. Default column sort is CREATED_TIME. |
| SortOrder | string | no | The sorting order for the returned list. SortOrder is DESCENDING by default based on CREATED_TIME. Otherwise, SortOrder is ASCENDING. |

### Creates a device and returns a configuration archive. The configuration archive is a ZIP file that contains…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-panorama/provision-device` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Returns a list of nodes.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-panorama/list-nodes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| category | string | no | Search for nodes by category. |
| maxResults | integer | no | The maximum number of nodes to return in one page of results. |
| nextToken | string | no | Specify the pagination token from a previous request to retrieve the next page of results. |
| ownerAccount | string | no | Search for nodes by the account ID of the nodes' owner. |
| packageName | string | no | Search for nodes by name. |
| packageVersion | string | no | Search for nodes by version. |
| patchVersion | string | no | Search for nodes by patch version. |
| MaxResults | string | no | Pagination limit |
| NextToken | string | no | Pagination token |

### Returns a list of tags for a resource.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-panorama/list-tags-for-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| ResourceArn | string | yes | The resource's ARN. |

### Tags a resource.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-panorama/tag-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| ResourceArn | string | yes | The resource's ARN. |
| body | object | yes | JSON request body |

### Signal camera nodes to stop or resume.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-panorama/signal-application-instance-node-instances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| ApplicationInstanceId | string | yes | An application instance ID. |
| body | object | yes | JSON request body |

### Removes tags from a resource.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-panorama/untag-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| ResourceArn | string | yes | The resource's ARN. |
| tagKeys | array | yes | Tag keys to remove. |

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:amazonaws-panorama/list-application-instances" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the AWS Panorama API?
Create a free Apizie key, then send GET https://zieapi.vercel.app/v1/cloud:amazonaws-panorama/list-application-instances with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the AWS Panorama API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. AWS Panorama itself also needs your own key from amazonaws.com.

### Can AI agents use the AWS Panorama API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:amazonaws-panorama.

### What is the status of the AWS Panorama API?
Needs your own provider key (bring your own key)