From 17010b2d3147b50d6963b0525b28df93201542d3 Mon Sep 17 00:00:00 2001 From: AWS <> Date: Wed, 20 Oct 2021 18:05:18 +0000 Subject: [PATCH] AWS Panorama Update: General availability for AWS Panorama. AWS SDK for Panorama includes APIs to manage your devices and nodes, and deploy computer vision applications to the edge. For more information, see the AWS Panorama documentation at http://docs.aws.amazon.com/panorama --- .../feature-AWSPanorama-b81d1df.json | 6 + services/panorama/pom.xml | 60 + .../codegen-resources/paginators-1.json | 49 + .../codegen-resources/service-2.json | 3457 +++++++++++++++++ 4 files changed, 3572 insertions(+) create mode 100644 .changes/next-release/feature-AWSPanorama-b81d1df.json create mode 100644 services/panorama/pom.xml create mode 100644 services/panorama/src/main/resources/codegen-resources/paginators-1.json create mode 100644 services/panorama/src/main/resources/codegen-resources/service-2.json diff --git a/.changes/next-release/feature-AWSPanorama-b81d1df.json b/.changes/next-release/feature-AWSPanorama-b81d1df.json new file mode 100644 index 000000000000..f9f4a35ec3f7 --- /dev/null +++ b/.changes/next-release/feature-AWSPanorama-b81d1df.json @@ -0,0 +1,6 @@ +{ + "type": "feature", + "category": "AWS Panorama", + "contributor": "", + "description": "General availability for AWS Panorama. AWS SDK for Panorama includes APIs to manage your devices and nodes, and deploy computer vision applications to the edge. For more information, see the AWS Panorama documentation at http://docs.aws.amazon.com/panorama" +} diff --git a/services/panorama/pom.xml b/services/panorama/pom.xml new file mode 100644 index 000000000000..47f7420ec9cf --- /dev/null +++ b/services/panorama/pom.xml @@ -0,0 +1,60 @@ + + + + + 4.0.0 + + software.amazon.awssdk + services + 2.17.64-SNAPSHOT + + panorama + AWS Java SDK :: Services :: Panorama + The AWS Java SDK for Panorama module holds the client classes that are used for + communicating with Panorama. + + https://aws.amazon.com/sdkforjava + + + + org.apache.maven.plugins + maven-jar-plugin + + + + software.amazon.awssdk.services.panorama + + + + + + + + + + software.amazon.awssdk + protocol-core + ${awsjavasdk.version} + + + software.amazon.awssdk + aws-json-protocol + ${awsjavasdk.version} + + + diff --git a/services/panorama/src/main/resources/codegen-resources/paginators-1.json b/services/panorama/src/main/resources/codegen-resources/paginators-1.json new file mode 100644 index 000000000000..6958fd26237d --- /dev/null +++ b/services/panorama/src/main/resources/codegen-resources/paginators-1.json @@ -0,0 +1,49 @@ +{ + "pagination": { + "ListApplicationInstanceDependencies": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListApplicationInstanceNodeInstances": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListApplicationInstances": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListDevices": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListDevicesJobs": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListNodeFromTemplateJobs": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListNodes": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListPackageImportJobs": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListPackages": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + } + } +} diff --git a/services/panorama/src/main/resources/codegen-resources/service-2.json b/services/panorama/src/main/resources/codegen-resources/service-2.json new file mode 100644 index 000000000000..4b8fdf72ef0d --- /dev/null +++ b/services/panorama/src/main/resources/codegen-resources/service-2.json @@ -0,0 +1,3457 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2019-07-24", + "endpointPrefix":"panorama", + "jsonVersion":"1.1", + "protocol":"rest-json", + "serviceAbbreviation":"Panorama", + "serviceFullName":"AWS Panorama", + "serviceId":"Panorama", + "signatureVersion":"v4", + "signingName":"panorama", + "uid":"panorama-2019-07-24" + }, + "operations":{ + "CreateApplicationInstance":{ + "name":"CreateApplicationInstance", + "http":{ + "method":"POST", + "requestUri":"/application-instances" + }, + "input":{"shape":"CreateApplicationInstanceRequest"}, + "output":{"shape":"CreateApplicationInstanceResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ServiceQuotaExceededException"} + ], + "documentation":"

Creates an application instance and deploys it to a device.

" + }, + "CreateJobForDevices":{ + "name":"CreateJobForDevices", + "http":{ + "method":"POST", + "requestUri":"/jobs" + }, + "input":{"shape":"CreateJobForDevicesRequest"}, + "output":{"shape":"CreateJobForDevicesResponse"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Creates a job to run on one or more devices.

" + }, + "CreateNodeFromTemplateJob":{ + "name":"CreateNodeFromTemplateJob", + "http":{ + "method":"POST", + "requestUri":"/packages/template-job" + }, + "input":{"shape":"CreateNodeFromTemplateJobRequest"}, + "output":{"shape":"CreateNodeFromTemplateJobResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"} + ], + "documentation":"

Creates a camera stream node.

" + }, + "CreatePackage":{ + "name":"CreatePackage", + "http":{ + "method":"POST", + "requestUri":"/packages" + }, + "input":{"shape":"CreatePackageRequest"}, + "output":{"shape":"CreatePackageResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"} + ], + "documentation":"

Creates a package and storage location in an Amazon S3 access point.

" + }, + "CreatePackageImportJob":{ + "name":"CreatePackageImportJob", + "http":{ + "method":"POST", + "requestUri":"/packages/import-jobs" + }, + "input":{"shape":"CreatePackageImportJobRequest"}, + "output":{"shape":"CreatePackageImportJobResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"} + ], + "documentation":"

Imports a node package.

" + }, + "DeleteDevice":{ + "name":"DeleteDevice", + "http":{ + "method":"DELETE", + "requestUri":"/devices/{DeviceId}" + }, + "input":{"shape":"DeleteDeviceRequest"}, + "output":{"shape":"DeleteDeviceResponse"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Deletes a device.

" + }, + "DeletePackage":{ + "name":"DeletePackage", + "http":{ + "method":"DELETE", + "requestUri":"/packages/{PackageId}" + }, + "input":{"shape":"DeletePackageRequest"}, + "output":{"shape":"DeletePackageResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Deletes a package.

" + }, + "DeregisterPackageVersion":{ + "name":"DeregisterPackageVersion", + "http":{ + "method":"DELETE", + "requestUri":"/packages/{PackageId}/versions/{PackageVersion}/patch/{PatchVersion}" + }, + "input":{"shape":"DeregisterPackageVersionRequest"}, + "output":{"shape":"DeregisterPackageVersionResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Deregisters a package version.

" + }, + "DescribeApplicationInstance":{ + "name":"DescribeApplicationInstance", + "http":{ + "method":"GET", + "requestUri":"/application-instances/{applicationInstanceId}" + }, + "input":{"shape":"DescribeApplicationInstanceRequest"}, + "output":{"shape":"DescribeApplicationInstanceResponse"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Returns information about an application instance on a device.

" + }, + "DescribeApplicationInstanceDetails":{ + "name":"DescribeApplicationInstanceDetails", + "http":{ + "method":"GET", + "requestUri":"/application-instances/{applicationInstanceId}/details" + }, + "input":{"shape":"DescribeApplicationInstanceDetailsRequest"}, + "output":{"shape":"DescribeApplicationInstanceDetailsResponse"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Returns information about an application instance's configuration manifest.

" + }, + "DescribeDevice":{ + "name":"DescribeDevice", + "http":{ + "method":"GET", + "requestUri":"/devices/{DeviceId}" + }, + "input":{"shape":"DescribeDeviceRequest"}, + "output":{"shape":"DescribeDeviceResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Returns information about a device.

" + }, + "DescribeDeviceJob":{ + "name":"DescribeDeviceJob", + "http":{ + "method":"GET", + "requestUri":"/jobs/{JobId}" + }, + "input":{"shape":"DescribeDeviceJobRequest"}, + "output":{"shape":"DescribeDeviceJobResponse"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Returns information about a device job.

" + }, + "DescribeNode":{ + "name":"DescribeNode", + "http":{ + "method":"GET", + "requestUri":"/nodes/{NodeId}" + }, + "input":{"shape":"DescribeNodeRequest"}, + "output":{"shape":"DescribeNodeResponse"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Returns information about a node.

" + }, + "DescribeNodeFromTemplateJob":{ + "name":"DescribeNodeFromTemplateJob", + "http":{ + "method":"GET", + "requestUri":"/packages/template-job/{JobId}" + }, + "input":{"shape":"DescribeNodeFromTemplateJobRequest"}, + "output":{"shape":"DescribeNodeFromTemplateJobResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"} + ], + "documentation":"

Returns information about a job to create a camera stream node.

" + }, + "DescribePackage":{ + "name":"DescribePackage", + "http":{ + "method":"GET", + "requestUri":"/packages/metadata/{PackageId}" + }, + "input":{"shape":"DescribePackageRequest"}, + "output":{"shape":"DescribePackageResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Returns information about a package.

" + }, + "DescribePackageImportJob":{ + "name":"DescribePackageImportJob", + "http":{ + "method":"GET", + "requestUri":"/packages/import-jobs/{JobId}" + }, + "input":{"shape":"DescribePackageImportJobRequest"}, + "output":{"shape":"DescribePackageImportJobResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"} + ], + "documentation":"

Returns information about a package import job.

" + }, + "DescribePackageVersion":{ + "name":"DescribePackageVersion", + "http":{ + "method":"GET", + "requestUri":"/packages/metadata/{PackageId}/versions/{PackageVersion}" + }, + "input":{"shape":"DescribePackageVersionRequest"}, + "output":{"shape":"DescribePackageVersionResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Returns information about a package version.

" + }, + "ListApplicationInstanceDependencies":{ + "name":"ListApplicationInstanceDependencies", + "http":{ + "method":"GET", + "requestUri":"/application-instances/{applicationInstanceId}/package-dependencies" + }, + "input":{"shape":"ListApplicationInstanceDependenciesRequest"}, + "output":{"shape":"ListApplicationInstanceDependenciesResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

Returns a list of application instance dependencies.

" + }, + "ListApplicationInstanceNodeInstances":{ + "name":"ListApplicationInstanceNodeInstances", + "http":{ + "method":"GET", + "requestUri":"/application-instances/{applicationInstanceId}/node-instances" + }, + "input":{"shape":"ListApplicationInstanceNodeInstancesRequest"}, + "output":{"shape":"ListApplicationInstanceNodeInstancesResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

Returns a list of application node instances.

" + }, + "ListApplicationInstances":{ + "name":"ListApplicationInstances", + "http":{ + "method":"GET", + "requestUri":"/application-instances" + }, + "input":{"shape":"ListApplicationInstancesRequest"}, + "output":{"shape":"ListApplicationInstancesResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

Returns a list of application instances.

" + }, + "ListDevices":{ + "name":"ListDevices", + "http":{ + "method":"GET", + "requestUri":"/devices" + }, + "input":{"shape":"ListDevicesRequest"}, + "output":{"shape":"ListDevicesResponse"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Returns a list of devices.

" + }, + "ListDevicesJobs":{ + "name":"ListDevicesJobs", + "http":{ + "method":"GET", + "requestUri":"/jobs" + }, + "input":{"shape":"ListDevicesJobsRequest"}, + "output":{"shape":"ListDevicesJobsResponse"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Returns a list of jobs.

" + }, + "ListNodeFromTemplateJobs":{ + "name":"ListNodeFromTemplateJobs", + "http":{ + "method":"GET", + "requestUri":"/packages/template-job" + }, + "input":{"shape":"ListNodeFromTemplateJobsRequest"}, + "output":{"shape":"ListNodeFromTemplateJobsResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"} + ], + "documentation":"

Returns a list of camera stream node jobs.

" + }, + "ListNodes":{ + "name":"ListNodes", + "http":{ + "method":"GET", + "requestUri":"/nodes" + }, + "input":{"shape":"ListNodesRequest"}, + "output":{"shape":"ListNodesResponse"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

Returns a list of nodes.

" + }, + "ListPackageImportJobs":{ + "name":"ListPackageImportJobs", + "http":{ + "method":"GET", + "requestUri":"/packages/import-jobs" + }, + "input":{"shape":"ListPackageImportJobsRequest"}, + "output":{"shape":"ListPackageImportJobsResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"} + ], + "documentation":"

Returns a list of package import jobs.

" + }, + "ListPackages":{ + "name":"ListPackages", + "http":{ + "method":"GET", + "requestUri":"/packages" + }, + "input":{"shape":"ListPackagesRequest"}, + "output":{"shape":"ListPackagesResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Returns a list of packages.

" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"GET", + "requestUri":"/tags/{ResourceArn}" + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

Returns a list of tags for a resource.

" + }, + "ProvisionDevice":{ + "name":"ProvisionDevice", + "http":{ + "method":"POST", + "requestUri":"/devices" + }, + "input":{"shape":"ProvisionDeviceRequest"}, + "output":{"shape":"ProvisionDeviceResponse"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ServiceQuotaExceededException"} + ], + "documentation":"

Creates a device and returns a configuration archive. The configuration archive is a ZIP file that contains a provisioning certificate that is valid for 5 minutes. Transfer the configuration archive to the device with the included USB storage device within 5 minutes.

" + }, + "RegisterPackageVersion":{ + "name":"RegisterPackageVersion", + "http":{ + "method":"PUT", + "requestUri":"/packages/{PackageId}/versions/{PackageVersion}/patch/{PatchVersion}" + }, + "input":{"shape":"RegisterPackageVersionRequest"}, + "output":{"shape":"RegisterPackageVersionResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"} + ], + "documentation":"

Registers a package version.

" + }, + "RemoveApplicationInstance":{ + "name":"RemoveApplicationInstance", + "http":{ + "method":"DELETE", + "requestUri":"/application-instances/{applicationInstanceId}" + }, + "input":{"shape":"RemoveApplicationInstanceRequest"}, + "output":{"shape":"RemoveApplicationInstanceResponse"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Removes an application instance.

" + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/tags/{ResourceArn}" + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

Tags a resource.

" + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"DELETE", + "requestUri":"/tags/{ResourceArn}" + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

Removes tags from a resource.

" + }, + "UpdateDeviceMetadata":{ + "name":"UpdateDeviceMetadata", + "http":{ + "method":"PUT", + "requestUri":"/devices/{DeviceId}" + }, + "input":{"shape":"UpdateDeviceMetadataRequest"}, + "output":{"shape":"UpdateDeviceMetadataResponse"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Updates a device's metadata.

" + } + }, + "shapes":{ + "AccessDeniedException":{ + "type":"structure", + "required":["Message"], + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

The requestor does not have permission to access the target action or resource.

", + "error":{"httpStatusCode":403}, + "exception":true + }, + "ApplicationInstance":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"ApplicationInstanceName", + "documentation":"

The application instance's name.

" + }, + "ApplicationInstanceId":{ + "shape":"ApplicationInstanceId", + "documentation":"

The application instance's ID.

" + }, + "DefaultRuntimeContextDevice":{ + "shape":"DefaultRuntimeContextDevice", + "documentation":"

The device's ID.

" + }, + "DefaultRuntimeContextDeviceName":{ + "shape":"DeviceName", + "documentation":"

The device's name.

" + }, + "Description":{ + "shape":"Description", + "documentation":"

The application instance's description.

" + }, + "Status":{ + "shape":"ApplicationInstanceStatus", + "documentation":"

The application instance's status.

" + }, + "HealthStatus":{ + "shape":"ApplicationInstanceHealthStatus", + "documentation":"

The application instance's health status.

" + }, + "StatusDescription":{ + "shape":"ApplicationInstanceStatusDescription", + "documentation":"

The application instance's status description.

" + }, + "CreatedTime":{ + "shape":"TimeStamp", + "documentation":"

When the application instance was created.

" + }, + "Arn":{ + "shape":"ApplicationInstanceArn", + "documentation":"

The application instance's ARN.

" + }, + "Tags":{ + "shape":"TagMap", + "documentation":"

The application instance's tags.

" + } + }, + "documentation":"

An application instance on a device.

" + }, + "ApplicationInstanceArn":{ + "type":"string", + "max":255, + "min":1 + }, + "ApplicationInstanceHealthStatus":{ + "type":"string", + "enum":[ + "RUNNING", + "ERROR", + "NOT_AVAILABLE" + ] + }, + "ApplicationInstanceId":{ + "type":"string", + "max":255, + "min":1, + "pattern":"^[a-zA-Z0-9\\-\\_]+$" + }, + "ApplicationInstanceName":{ + "type":"string", + "max":255, + "min":1, + "pattern":"^[a-zA-Z0-9\\-\\_]+$" + }, + "ApplicationInstanceStatus":{ + "type":"string", + "enum":[ + "DEPLOYMENT_PENDING", + "DEPLOYMENT_REQUESTED", + "DEPLOYMENT_IN_PROGRESS", + "DEPLOYMENT_ERROR", + "DEPLOYMENT_SUCCEEDED", + "REMOVAL_PENDING", + "REMOVAL_REQUESTED", + "REMOVAL_IN_PROGRESS", + "REMOVAL_FAILED", + "REMOVAL_SUCCEEDED" + ] + }, + "ApplicationInstanceStatusDescription":{ + "type":"string", + "max":255, + "min":1 + }, + "ApplicationInstances":{ + "type":"list", + "member":{"shape":"ApplicationInstance"} + }, + "Boolean":{"type":"boolean"}, + "Bucket":{"type":"string"}, + "BucketName":{ + "type":"string", + "max":255, + "min":1, + "pattern":"^.+$" + }, + "Certificates":{"type":"blob"}, + "ClientToken":{ + "type":"string", + "max":64, + "min":1, + "pattern":"^[a-zA-Z0-9\\-\\_]+$" + }, + "ConflictException":{ + "type":"structure", + "required":[ + "Message", + "ResourceId", + "ResourceType" + ], + "members":{ + "Message":{"shape":"String"}, + "ResourceId":{ + "shape":"String", + "documentation":"

The resource's ID.

" + }, + "ResourceType":{ + "shape":"String", + "documentation":"

The resource's type.

" + }, + "ErrorId":{ + "shape":"String", + "documentation":"

A unique ID for the error.

" + }, + "ErrorArguments":{ + "shape":"ConflictExceptionErrorArgumentList", + "documentation":"

A list of attributes that led to the exception and their values.

" + } + }, + "documentation":"

The target resource is in use.

", + "error":{"httpStatusCode":409}, + "exception":true + }, + "ConflictExceptionErrorArgument":{ + "type":"structure", + "required":[ + "Name", + "Value" + ], + "members":{ + "Name":{ + "shape":"String", + "documentation":"

The error argument's name.

" + }, + "Value":{ + "shape":"String", + "documentation":"

The error argument's value.

" + } + }, + "documentation":"

A conflict exception error argument.

" + }, + "ConflictExceptionErrorArgumentList":{ + "type":"list", + "member":{"shape":"ConflictExceptionErrorArgument"} + }, + "ConnectionType":{ + "type":"string", + "enum":[ + "STATIC_IP", + "DHCP" + ] + }, + "CreateApplicationInstanceRequest":{ + "type":"structure", + "required":[ + "ManifestPayload", + "DefaultRuntimeContextDevice" + ], + "members":{ + "Name":{ + "shape":"ApplicationInstanceName", + "documentation":"

A name for the application instance.

" + }, + "Description":{ + "shape":"Description", + "documentation":"

A description for the application instance.

" + }, + "ManifestPayload":{ + "shape":"ManifestPayload", + "documentation":"

The application's manifest document.

" + }, + "ManifestOverridesPayload":{ + "shape":"ManifestOverridesPayload", + "documentation":"

Setting overrides for the application manifest.

" + }, + "ApplicationInstanceIdToReplace":{ + "shape":"ApplicationInstanceId", + "documentation":"

The ID of an application instance to replace with the new instance.

" + }, + "RuntimeRoleArn":{ + "shape":"RuntimeRoleArn", + "documentation":"

The ARN of a runtime role for the application instance.

" + }, + "DefaultRuntimeContextDevice":{ + "shape":"DefaultRuntimeContextDevice", + "documentation":"

A device's ID.

" + }, + "Tags":{ + "shape":"TagMap", + "documentation":"

Tags for the application instance.

" + } + } + }, + "CreateApplicationInstanceResponse":{ + "type":"structure", + "required":["ApplicationInstanceId"], + "members":{ + "ApplicationInstanceId":{ + "shape":"ApplicationInstanceId", + "documentation":"

The application instance's ID.

" + } + } + }, + "CreateJobForDevicesRequest":{ + "type":"structure", + "required":[ + "DeviceIds", + "DeviceJobConfig", + "JobType" + ], + "members":{ + "DeviceIds":{ + "shape":"DeviceIdList", + "documentation":"

IDs of target devices.

" + }, + "DeviceJobConfig":{ + "shape":"DeviceJobConfig", + "documentation":"

Configuration settings for the job.

" + }, + "JobType":{ + "shape":"JobType", + "documentation":"

The type of job to run.

" + } + } + }, + "CreateJobForDevicesResponse":{ + "type":"structure", + "required":["Jobs"], + "members":{ + "Jobs":{ + "shape":"JobList", + "documentation":"

A list of jobs.

" + } + } + }, + "CreateNodeFromTemplateJobRequest":{ + "type":"structure", + "required":[ + "TemplateType", + "OutputPackageName", + "OutputPackageVersion", + "NodeName", + "TemplateParameters" + ], + "members":{ + "TemplateType":{ + "shape":"TemplateType", + "documentation":"

The type of node.

" + }, + "OutputPackageName":{ + "shape":"NodePackageName", + "documentation":"

An output package name for the node.

" + }, + "OutputPackageVersion":{ + "shape":"NodePackageVersion", + "documentation":"

An output package version for the node.

" + }, + "NodeName":{ + "shape":"NodeName", + "documentation":"

A name for the node.

" + }, + "NodeDescription":{ + "shape":"Description", + "documentation":"

A description for the node.

" + }, + "TemplateParameters":{ + "shape":"TemplateParametersMap", + "documentation":"

Template parameters for the node.

" + }, + "JobTags":{ + "shape":"JobTagsList", + "documentation":"

Tags for the job.

" + } + } + }, + "CreateNodeFromTemplateJobResponse":{ + "type":"structure", + "required":["JobId"], + "members":{ + "JobId":{ + "shape":"JobId", + "documentation":"

The job's ID.

" + } + } + }, + "CreatePackageImportJobRequest":{ + "type":"structure", + "required":[ + "JobType", + "InputConfig", + "OutputConfig", + "ClientToken" + ], + "members":{ + "JobType":{ + "shape":"PackageImportJobType", + "documentation":"

A job type for the package import job.

" + }, + "InputConfig":{ + "shape":"PackageImportJobInputConfig", + "documentation":"

An input config for the package import job.

" + }, + "OutputConfig":{ + "shape":"PackageImportJobOutputConfig", + "documentation":"

An output config for the package import job.

" + }, + "ClientToken":{ + "shape":"ClientToken", + "documentation":"

A client token for the package import job.

" + }, + "JobTags":{ + "shape":"JobTagsList", + "documentation":"

Tags for the package import job.

" + } + } + }, + "CreatePackageImportJobResponse":{ + "type":"structure", + "required":["JobId"], + "members":{ + "JobId":{ + "shape":"JobId", + "documentation":"

The job's ID.

" + } + } + }, + "CreatePackageRequest":{ + "type":"structure", + "required":["PackageName"], + "members":{ + "PackageName":{ + "shape":"NodePackageName", + "documentation":"

A name for the package.

" + }, + "Tags":{ + "shape":"TagMap", + "documentation":"

Tags for the package.

" + } + } + }, + "CreatePackageResponse":{ + "type":"structure", + "required":["StorageLocation"], + "members":{ + "PackageId":{ + "shape":"NodePackageId", + "documentation":"

The package's ID.

" + }, + "Arn":{ + "shape":"NodePackageArn", + "documentation":"

The package's ARN.

" + }, + "StorageLocation":{ + "shape":"StorageLocation", + "documentation":"

The package's storage location.

" + } + } + }, + "CreatedTime":{"type":"timestamp"}, + "CurrentSoftware":{ + "type":"string", + "max":255, + "min":1 + }, + "DefaultGateway":{ + "type":"string", + "max":255, + "min":1, + "pattern":"^.+$" + }, + "DefaultRuntimeContextDevice":{ + "type":"string", + "max":255, + "min":1, + "pattern":"^[a-zA-Z0-9\\-\\_]+$" + }, + "DeleteDeviceRequest":{ + "type":"structure", + "required":["DeviceId"], + "members":{ + "DeviceId":{ + "shape":"DeviceId", + "documentation":"

The device's ID.

", + "location":"uri", + "locationName":"DeviceId" + } + } + }, + "DeleteDeviceResponse":{ + "type":"structure", + "members":{ + "DeviceId":{ + "shape":"DeviceId", + "documentation":"

The device's ID.

" + } + } + }, + "DeletePackageRequest":{ + "type":"structure", + "required":["PackageId"], + "members":{ + "PackageId":{ + "shape":"NodePackageId", + "documentation":"

The package's ID.

", + "location":"uri", + "locationName":"PackageId" + }, + "ForceDelete":{ + "shape":"Boolean", + "documentation":"

Delete the package even if it has artifacts stored in its access point. Deletes the package's artifacts from Amazon S3.

", + "location":"querystring", + "locationName":"ForceDelete" + } + } + }, + "DeletePackageResponse":{ + "type":"structure", + "members":{ + } + }, + "DeregisterPackageVersionRequest":{ + "type":"structure", + "required":[ + "PackageId", + "PackageVersion", + "PatchVersion" + ], + "members":{ + "OwnerAccount":{ + "shape":"PackageOwnerAccount", + "documentation":"

An owner account.

", + "location":"querystring", + "locationName":"OwnerAccount" + }, + "PackageId":{ + "shape":"NodePackageId", + "documentation":"

A package ID.

", + "location":"uri", + "locationName":"PackageId" + }, + "PackageVersion":{ + "shape":"NodePackageVersion", + "documentation":"

A package version.

", + "location":"uri", + "locationName":"PackageVersion" + }, + "PatchVersion":{ + "shape":"NodePackagePatchVersion", + "documentation":"

A patch version.

", + "location":"uri", + "locationName":"PatchVersion" + }, + "UpdatedLatestPatchVersion":{ + "shape":"NodePackagePatchVersion", + "documentation":"

If the version was marked latest, the new version to maker as latest.

", + "location":"querystring", + "locationName":"UpdatedLatestPatchVersion" + } + } + }, + "DeregisterPackageVersionResponse":{ + "type":"structure", + "members":{ + } + }, + "DescribeApplicationInstanceDetailsRequest":{ + "type":"structure", + "required":["ApplicationInstanceId"], + "members":{ + "ApplicationInstanceId":{ + "shape":"ApplicationInstanceId", + "documentation":"

The application instance's ID.

", + "location":"uri", + "locationName":"applicationInstanceId" + } + } + }, + "DescribeApplicationInstanceDetailsResponse":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"ApplicationInstanceName", + "documentation":"

The application instance's name.

" + }, + "Description":{ + "shape":"Description", + "documentation":"

The application instance's description.

" + }, + "DefaultRuntimeContextDevice":{ + "shape":"DefaultRuntimeContextDevice", + "documentation":"

The application instance's default runtime context device.

" + }, + "ManifestPayload":{ + "shape":"ManifestPayload", + "documentation":"

The application instance's configuration manifest.

" + }, + "ManifestOverridesPayload":{ + "shape":"ManifestOverridesPayload", + "documentation":"

Parameter overrides for the configuration manifest.

" + }, + "ApplicationInstanceIdToReplace":{ + "shape":"ApplicationInstanceId", + "documentation":"

The ID of the application instance that this instance replaced.

" + }, + "CreatedTime":{ + "shape":"TimeStamp", + "documentation":"

When the application instance was created.

" + }, + "ApplicationInstanceId":{ + "shape":"ApplicationInstanceId", + "documentation":"

The application instance's ID.

" + } + } + }, + "DescribeApplicationInstanceRequest":{ + "type":"structure", + "required":["ApplicationInstanceId"], + "members":{ + "ApplicationInstanceId":{ + "shape":"ApplicationInstanceId", + "documentation":"

The application instance's ID.

", + "location":"uri", + "locationName":"applicationInstanceId" + } + } + }, + "DescribeApplicationInstanceResponse":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"ApplicationInstanceName", + "documentation":"

The application instance's name.

" + }, + "Description":{ + "shape":"Description", + "documentation":"

The application instance's description.

" + }, + "DefaultRuntimeContextDevice":{ + "shape":"DefaultRuntimeContextDevice", + "documentation":"

The device's ID.

" + }, + "DefaultRuntimeContextDeviceName":{ + "shape":"DeviceName", + "documentation":"

The device's bane.

" + }, + "ApplicationInstanceIdToReplace":{ + "shape":"ApplicationInstanceId", + "documentation":"

The ID of the application instance that this instance replaced.

" + }, + "RuntimeRoleArn":{ + "shape":"RuntimeRoleArn", + "documentation":"

The application instance's runtime role ARN.

" + }, + "Status":{ + "shape":"ApplicationInstanceStatus", + "documentation":"

The application instance's status.

" + }, + "HealthStatus":{ + "shape":"ApplicationInstanceHealthStatus", + "documentation":"

The application instance's health status.

" + }, + "StatusDescription":{ + "shape":"ApplicationInstanceStatusDescription", + "documentation":"

The application instance's status description.

" + }, + "CreatedTime":{ + "shape":"TimeStamp", + "documentation":"

When the application instance was created.

" + }, + "LastUpdatedTime":{ + "shape":"TimeStamp", + "documentation":"

The application instance was updated.

" + }, + "ApplicationInstanceId":{ + "shape":"ApplicationInstanceId", + "documentation":"

The application instance's ID.

" + }, + "Arn":{ + "shape":"ApplicationInstanceArn", + "documentation":"

The application instance's ARN.

" + }, + "Tags":{ + "shape":"TagMap", + "documentation":"

The application instance's tags.

" + } + } + }, + "DescribeDeviceJobRequest":{ + "type":"structure", + "required":["JobId"], + "members":{ + "JobId":{ + "shape":"JobId", + "documentation":"

The job's ID.

", + "location":"uri", + "locationName":"JobId" + } + } + }, + "DescribeDeviceJobResponse":{ + "type":"structure", + "members":{ + "JobId":{ + "shape":"JobId", + "documentation":"

The job's ID.

" + }, + "DeviceId":{ + "shape":"DeviceId", + "documentation":"

The device's ID.

" + }, + "DeviceArn":{ + "shape":"DeviceArn", + "documentation":"

The device's ARN.

" + }, + "DeviceName":{ + "shape":"DeviceName", + "documentation":"

The device's name.

" + }, + "DeviceType":{ + "shape":"DeviceType", + "documentation":"

The device's type.

" + }, + "ImageVersion":{ + "shape":"ImageVersion", + "documentation":"

For an OTA job, the target version of the device software.

" + }, + "Status":{ + "shape":"UpdateProgress", + "documentation":"

The job's status.

" + }, + "CreatedTime":{ + "shape":"UpdateCreatedTime", + "documentation":"

When the job was created.

" + } + } + }, + "DescribeDeviceRequest":{ + "type":"structure", + "required":["DeviceId"], + "members":{ + "DeviceId":{ + "shape":"DeviceId", + "documentation":"

The device's ID.

", + "location":"uri", + "locationName":"DeviceId" + } + } + }, + "DescribeDeviceResponse":{ + "type":"structure", + "members":{ + "DeviceId":{ + "shape":"DeviceId", + "documentation":"

The device's ID.

" + }, + "Name":{ + "shape":"DeviceName", + "documentation":"

The device's name.

" + }, + "Arn":{ + "shape":"DeviceArn", + "documentation":"

The device's ARN.

" + }, + "Description":{ + "shape":"Description", + "documentation":"

The device's description.

" + }, + "Type":{ + "shape":"DeviceType", + "documentation":"

The device's type.

" + }, + "DeviceConnectionStatus":{ + "shape":"DeviceConnectionStatus", + "documentation":"

The device's connection status.

" + }, + "CreatedTime":{ + "shape":"CreatedTime", + "documentation":"

When the device was created.

" + }, + "ProvisioningStatus":{ + "shape":"DeviceStatus", + "documentation":"

The device's provisioning status.

" + }, + "LatestSoftware":{ + "shape":"LatestSoftware", + "documentation":"

The latest software version available for the device.

" + }, + "CurrentSoftware":{ + "shape":"CurrentSoftware", + "documentation":"

The device's current software version.

" + }, + "SerialNumber":{ + "shape":"DeviceSerialNumber", + "documentation":"

The device's serial number.

" + }, + "Tags":{ + "shape":"TagMap", + "documentation":"

The device's tags.

" + }, + "NetworkingConfiguration":{ + "shape":"NetworkPayload", + "documentation":"

The device's networking configuration.

" + }, + "CurrentNetworkingStatus":{ + "shape":"NetworkStatus", + "documentation":"

The device's networking status.

" + }, + "LeaseExpirationTime":{ + "shape":"LeaseExpirationTime", + "documentation":"

The device's lease expiration time.

" + } + } + }, + "DescribeNodeFromTemplateJobRequest":{ + "type":"structure", + "required":["JobId"], + "members":{ + "JobId":{ + "shape":"JobId", + "documentation":"

The job's ID.

", + "location":"uri", + "locationName":"JobId" + } + } + }, + "DescribeNodeFromTemplateJobResponse":{ + "type":"structure", + "required":[ + "JobId", + "Status", + "StatusMessage", + "CreatedTime", + "LastUpdatedTime", + "OutputPackageName", + "OutputPackageVersion", + "NodeName", + "TemplateType", + "TemplateParameters" + ], + "members":{ + "JobId":{ + "shape":"JobId", + "documentation":"

The job's ID.

" + }, + "Status":{ + "shape":"NodeFromTemplateJobStatus", + "documentation":"

The job's status.

" + }, + "StatusMessage":{ + "shape":"NodeFromTemplateJobStatusMessage", + "documentation":"

The job's status message.

" + }, + "CreatedTime":{ + "shape":"CreatedTime", + "documentation":"

When the job was created.

" + }, + "LastUpdatedTime":{ + "shape":"LastUpdatedTime", + "documentation":"

When the job was updated.

" + }, + "OutputPackageName":{ + "shape":"NodePackageName", + "documentation":"

The job's output package name.

" + }, + "OutputPackageVersion":{ + "shape":"NodePackageVersion", + "documentation":"

The job's output package version.

" + }, + "NodeName":{ + "shape":"NodeName", + "documentation":"

The node's name.

" + }, + "NodeDescription":{ + "shape":"Description", + "documentation":"

The node's description.

" + }, + "TemplateType":{ + "shape":"TemplateType", + "documentation":"

The job's template type.

" + }, + "TemplateParameters":{ + "shape":"TemplateParametersMap", + "documentation":"

The job's template parameters.

" + }, + "JobTags":{ + "shape":"JobTagsList", + "documentation":"

The job's tags.

" + } + } + }, + "DescribeNodeRequest":{ + "type":"structure", + "required":["NodeId"], + "members":{ + "NodeId":{ + "shape":"NodeId", + "documentation":"

The node's ID.

", + "location":"uri", + "locationName":"NodeId" + }, + "OwnerAccount":{ + "shape":"PackageOwnerAccount", + "documentation":"

The account ID of the node's owner.

", + "location":"querystring", + "locationName":"OwnerAccount" + } + } + }, + "DescribeNodeResponse":{ + "type":"structure", + "required":[ + "NodeId", + "Name", + "Category", + "OwnerAccount", + "PackageName", + "PackageId", + "PackageVersion", + "PatchVersion", + "NodeInterface", + "Description", + "CreatedTime", + "LastUpdatedTime" + ], + "members":{ + "NodeId":{ + "shape":"NodeId", + "documentation":"

The node's ID.

" + }, + "Name":{ + "shape":"NodeName", + "documentation":"

The node's name.

" + }, + "Category":{ + "shape":"NodeCategory", + "documentation":"

The node's category.

" + }, + "OwnerAccount":{ + "shape":"PackageOwnerAccount", + "documentation":"

The account ID of the node's owner.

" + }, + "PackageName":{ + "shape":"NodePackageName", + "documentation":"

The node's package name.

" + }, + "PackageId":{ + "shape":"NodePackageId", + "documentation":"

The node's package ID.

" + }, + "PackageArn":{ + "shape":"NodePackageArn", + "documentation":"

The node's ARN.

" + }, + "PackageVersion":{ + "shape":"NodePackageVersion", + "documentation":"

The node's package version.

" + }, + "PatchVersion":{ + "shape":"NodePackagePatchVersion", + "documentation":"

The node's patch version.

" + }, + "NodeInterface":{ + "shape":"NodeInterface", + "documentation":"

The node's interface.

" + }, + "AssetName":{ + "shape":"NodeAssetName", + "documentation":"

The node's asset name.

" + }, + "Description":{ + "shape":"Description", + "documentation":"

The node's description.

" + }, + "CreatedTime":{ + "shape":"TimeStamp", + "documentation":"

When the node was created.

" + }, + "LastUpdatedTime":{ + "shape":"TimeStamp", + "documentation":"

When the node was updated.

" + } + } + }, + "DescribePackageImportJobRequest":{ + "type":"structure", + "required":["JobId"], + "members":{ + "JobId":{ + "shape":"JobId", + "documentation":"

The job's ID.

", + "location":"uri", + "locationName":"JobId" + } + } + }, + "DescribePackageImportJobResponse":{ + "type":"structure", + "required":[ + "JobId", + "JobType", + "InputConfig", + "OutputConfig", + "Output", + "CreatedTime", + "LastUpdatedTime", + "Status", + "StatusMessage" + ], + "members":{ + "JobId":{ + "shape":"JobId", + "documentation":"

The job's ID.

" + }, + "ClientToken":{ + "shape":"ClientToken", + "documentation":"

The job's client token.

" + }, + "JobType":{ + "shape":"PackageImportJobType", + "documentation":"

The job's type.

" + }, + "InputConfig":{ + "shape":"PackageImportJobInputConfig", + "documentation":"

The job's input config.

" + }, + "OutputConfig":{ + "shape":"PackageImportJobOutputConfig", + "documentation":"

The job's output config.

" + }, + "Output":{ + "shape":"PackageImportJobOutput", + "documentation":"

The job's output.

" + }, + "CreatedTime":{ + "shape":"CreatedTime", + "documentation":"

When the job was created.

" + }, + "LastUpdatedTime":{ + "shape":"LastUpdatedTime", + "documentation":"

When the job was updated.

" + }, + "Status":{ + "shape":"PackageImportJobStatus", + "documentation":"

The job's status.

" + }, + "StatusMessage":{ + "shape":"PackageImportJobStatusMessage", + "documentation":"

The job's status message.

" + }, + "JobTags":{ + "shape":"JobTagsList", + "documentation":"

The job's tags.

" + } + } + }, + "DescribePackageRequest":{ + "type":"structure", + "required":["PackageId"], + "members":{ + "PackageId":{ + "shape":"NodePackageId", + "documentation":"

The package's ID.

", + "location":"uri", + "locationName":"PackageId" + } + } + }, + "DescribePackageResponse":{ + "type":"structure", + "required":[ + "PackageId", + "PackageName", + "Arn", + "StorageLocation", + "CreatedTime", + "Tags" + ], + "members":{ + "PackageId":{ + "shape":"NodePackageId", + "documentation":"

The package's ID.

" + }, + "PackageName":{ + "shape":"NodePackageName", + "documentation":"

The package's name.

" + }, + "Arn":{ + "shape":"NodePackageArn", + "documentation":"

The package's ARN.

" + }, + "StorageLocation":{ + "shape":"StorageLocation", + "documentation":"

The package's storage location.

" + }, + "ReadAccessPrincipalArns":{ + "shape":"PrincipalArnsList", + "documentation":"

ARNs of accounts that have read access to the package.

" + }, + "WriteAccessPrincipalArns":{ + "shape":"PrincipalArnsList", + "documentation":"

ARNs of accounts that have write access to the package.

" + }, + "CreatedTime":{ + "shape":"TimeStamp", + "documentation":"

When the package was created.

" + }, + "Tags":{ + "shape":"TagMap", + "documentation":"

The package's tags.

" + } + } + }, + "DescribePackageVersionRequest":{ + "type":"structure", + "required":[ + "PackageId", + "PackageVersion" + ], + "members":{ + "OwnerAccount":{ + "shape":"PackageOwnerAccount", + "documentation":"

The version's owner account.

", + "location":"querystring", + "locationName":"OwnerAccount" + }, + "PackageId":{ + "shape":"NodePackageId", + "documentation":"

The version's ID.

", + "location":"uri", + "locationName":"PackageId" + }, + "PackageVersion":{ + "shape":"NodePackageVersion", + "documentation":"

The version's version.

", + "location":"uri", + "locationName":"PackageVersion" + }, + "PatchVersion":{ + "shape":"NodePackagePatchVersion", + "documentation":"

The version's patch version.

", + "location":"querystring", + "locationName":"PatchVersion" + } + } + }, + "DescribePackageVersionResponse":{ + "type":"structure", + "required":[ + "PackageId", + "PackageName", + "PackageVersion", + "PatchVersion", + "IsLatestPatch", + "Status" + ], + "members":{ + "OwnerAccount":{ + "shape":"PackageOwnerAccount", + "documentation":"

The account ID of the version's owner.

" + }, + "PackageId":{ + "shape":"NodePackageId", + "documentation":"

The version's ID.

" + }, + "PackageArn":{ + "shape":"NodePackageArn", + "documentation":"

The ARN of the package.

" + }, + "PackageName":{ + "shape":"NodePackageName", + "documentation":"

The version's name.

" + }, + "PackageVersion":{ + "shape":"NodePackageVersion", + "documentation":"

The version's version.

" + }, + "PatchVersion":{ + "shape":"NodePackagePatchVersion", + "documentation":"

The version's patch version.

" + }, + "IsLatestPatch":{ + "shape":"Boolean", + "documentation":"

Whether the version is the latest available.

" + }, + "Status":{ + "shape":"PackageVersionStatus", + "documentation":"

The version's status.

" + }, + "StatusDescription":{ + "shape":"PackageVersionStatusDescription", + "documentation":"

The version's status description.

" + }, + "RegisteredTime":{ + "shape":"TimeStamp", + "documentation":"

The version's registered time.

" + } + } + }, + "Description":{ + "type":"string", + "max":255, + "min":0, + "pattern":"^.*$" + }, + "Device":{ + "type":"structure", + "members":{ + "DeviceId":{ + "shape":"DeviceId", + "documentation":"

The device's ID.

" + }, + "Name":{ + "shape":"DeviceName", + "documentation":"

The device's name.

" + }, + "CreatedTime":{ + "shape":"CreatedTime", + "documentation":"

When the device was created.

" + }, + "ProvisioningStatus":{ + "shape":"DeviceStatus", + "documentation":"

The device's provisioning status.

" + }, + "LastUpdatedTime":{ + "shape":"LastUpdatedTime", + "documentation":"

When the device was updated.

" + }, + "LeaseExpirationTime":{ + "shape":"LeaseExpirationTime", + "documentation":"

The device's lease expiration time.

" + } + }, + "documentation":"

A device.

" + }, + "DeviceArn":{ + "type":"string", + "max":255, + "min":1 + }, + "DeviceConnectionStatus":{ + "type":"string", + "enum":[ + "ONLINE", + "OFFLINE", + "AWAITING_CREDENTIALS", + "NOT_AVAILABLE", + "ERROR" + ] + }, + "DeviceId":{ + "type":"string", + "max":255, + "min":1, + "pattern":"^[a-zA-Z0-9\\-\\_]+$" + }, + "DeviceIdList":{ + "type":"list", + "member":{"shape":"DeviceId"}, + "max":1, + "min":1 + }, + "DeviceJob":{ + "type":"structure", + "members":{ + "DeviceName":{ + "shape":"DeviceName", + "documentation":"

The name of the target device

" + }, + "DeviceId":{ + "shape":"DeviceId", + "documentation":"

The ID of the target device.

" + }, + "JobId":{ + "shape":"JobId", + "documentation":"

The job's ID.

" + }, + "CreatedTime":{ + "shape":"CreatedTime", + "documentation":"

When the job was created.

" + } + }, + "documentation":"

A job that runs on a device.

" + }, + "DeviceJobConfig":{ + "type":"structure", + "members":{ + "OTAJobConfig":{ + "shape":"OTAJobConfig", + "documentation":"

A configuration for an over-the-air (OTA) upgrade. Required for OTA jobs.

" + } + }, + "documentation":"

A job's configuration.

" + }, + "DeviceJobList":{ + "type":"list", + "member":{"shape":"DeviceJob"} + }, + "DeviceList":{ + "type":"list", + "member":{"shape":"Device"} + }, + "DeviceName":{ + "type":"string", + "max":255, + "min":1, + "pattern":"^[a-zA-Z0-9\\-\\_]+$" + }, + "DeviceSerialNumber":{ + "type":"string", + "pattern":"^[0-9]{1,20}$" + }, + "DeviceStatus":{ + "type":"string", + "enum":[ + "AWAITING_PROVISIONING", + "PENDING", + "SUCCEEDED", + "FAILED", + "ERROR", + "DELETING" + ] + }, + "DeviceType":{ + "type":"string", + "enum":[ + "PANORAMA_APPLIANCE_DEVELOPER_KIT", + "PANORAMA_APPLIANCE" + ] + }, + "Dns":{ + "type":"string", + "max":255, + "min":1, + "pattern":"^.+$" + }, + "DnsList":{ + "type":"list", + "member":{"shape":"Dns"} + }, + "EthernetPayload":{ + "type":"structure", + "required":["ConnectionType"], + "members":{ + "ConnectionType":{ + "shape":"ConnectionType", + "documentation":"

How the device gets an IP address.

" + }, + "StaticIpConnectionInfo":{ + "shape":"StaticIpConnectionInfo", + "documentation":"

Network configuration for a static IP connection.

" + } + }, + "documentation":"

A device's network configuration.

" + }, + "EthernetStatus":{ + "type":"structure", + "members":{ + "IpAddress":{ + "shape":"IpAddress", + "documentation":"

The device's IP address.

" + }, + "ConnectionStatus":{ + "shape":"NetworkConnectionStatus", + "documentation":"

The device's connection status.

" + }, + "HwAddress":{ + "shape":"HwAddress", + "documentation":"

The device's physical address.

" + } + }, + "documentation":"

A device's Ethernet status.

" + }, + "HwAddress":{ + "type":"string", + "max":255, + "min":1 + }, + "ImageVersion":{ + "type":"string", + "max":255, + "min":1, + "pattern":"^.+$" + }, + "InputPortList":{ + "type":"list", + "member":{"shape":"NodeInputPort"} + }, + "InternalServerException":{ + "type":"structure", + "required":["Message"], + "members":{ + "Message":{"shape":"String"}, + "RetryAfterSeconds":{ + "shape":"RetryAfterSeconds", + "documentation":"

The number of seconds a client should wait before retrying the call.

", + "location":"header", + "locationName":"Retry-After" + } + }, + "documentation":"

An internal error occurred.

", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + "IotThingName":{ + "type":"string", + "max":255, + "min":1 + }, + "IpAddress":{ + "type":"string", + "max":255, + "min":1, + "pattern":"^((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d))(:(6553[0-5]|655[0-2]\\d|65[0-4]\\d{2}|6[0-4]\\d{3}|[1-5]\\d{4}|[1-9]\\d{0,3}))?$" + }, + "Job":{ + "type":"structure", + "members":{ + "JobId":{ + "shape":"JobId", + "documentation":"

The job's ID.

" + }, + "DeviceId":{ + "shape":"DeviceId", + "documentation":"

The target device's ID.

" + } + }, + "documentation":"

A job for a device.

" + }, + "JobId":{ + "type":"string", + "max":255, + "min":1, + "pattern":"^[a-zA-Z0-9\\-\\_]+$" + }, + "JobList":{ + "type":"list", + "member":{"shape":"Job"} + }, + "JobResourceTags":{ + "type":"structure", + "required":[ + "ResourceType", + "Tags" + ], + "members":{ + "ResourceType":{ + "shape":"JobResourceType", + "documentation":"

The job's type.

" + }, + "Tags":{ + "shape":"TagMap", + "documentation":"

The job's tags.

" + } + }, + "documentation":"

Tags for a job.

" + }, + "JobResourceType":{ + "type":"string", + "enum":["PACKAGE"] + }, + "JobTagsList":{ + "type":"list", + "member":{"shape":"JobResourceTags"} + }, + "JobType":{ + "type":"string", + "enum":["OTA"] + }, + "LastUpdatedTime":{"type":"timestamp"}, + "LatestSoftware":{ + "type":"string", + "max":255, + "min":1 + }, + "LeaseExpirationTime":{"type":"timestamp"}, + "ListApplicationInstanceDependenciesRequest":{ + "type":"structure", + "required":["ApplicationInstanceId"], + "members":{ + "ApplicationInstanceId":{ + "shape":"ApplicationInstanceId", + "documentation":"

The application instance's ID.

", + "location":"uri", + "locationName":"applicationInstanceId" + }, + "MaxResults":{ + "shape":"MaxSize25", + "documentation":"

The maximum number of application instance dependencies to return in one page of results.

", + "location":"querystring", + "locationName":"maxResults" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

Specify the pagination token from a previous request to retrieve the next page of results.

", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListApplicationInstanceDependenciesResponse":{ + "type":"structure", + "members":{ + "PackageObjects":{ + "shape":"PackageObjects", + "documentation":"

A list of package objects.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

A pagination token that's included if more results are available.

" + } + } + }, + "ListApplicationInstanceNodeInstancesRequest":{ + "type":"structure", + "required":["ApplicationInstanceId"], + "members":{ + "ApplicationInstanceId":{ + "shape":"ApplicationInstanceId", + "documentation":"

The node instances' application instance ID.

", + "location":"uri", + "locationName":"applicationInstanceId" + }, + "MaxResults":{ + "shape":"MaxSize25", + "documentation":"

The maximum number of node instances to return in one page of results.

", + "location":"querystring", + "locationName":"maxResults" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

Specify the pagination token from a previous request to retrieve the next page of results.

", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListApplicationInstanceNodeInstancesResponse":{ + "type":"structure", + "members":{ + "NodeInstances":{ + "shape":"NodeInstances", + "documentation":"

A list of node instances.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

A pagination token that's included if more results are available.

" + } + } + }, + "ListApplicationInstancesRequest":{ + "type":"structure", + "members":{ + "DeviceId":{ + "shape":"DeviceId", + "documentation":"

The application instances' device ID.

", + "location":"querystring", + "locationName":"deviceId" + }, + "StatusFilter":{ + "shape":"StatusFilter", + "documentation":"

Only include instances with a specific status.

", + "location":"querystring", + "locationName":"statusFilter" + }, + "MaxResults":{ + "shape":"MaxSize25", + "documentation":"

The maximum number of application instances to return in one page of results.

", + "location":"querystring", + "locationName":"maxResults" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

Specify the pagination token from a previous request to retrieve the next page of results.

", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListApplicationInstancesResponse":{ + "type":"structure", + "members":{ + "ApplicationInstances":{ + "shape":"ApplicationInstances", + "documentation":"

A list of application instances.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

A pagination token that's included if more results are available.

" + } + } + }, + "ListDevicesJobsRequest":{ + "type":"structure", + "members":{ + "DeviceId":{ + "shape":"DeviceId", + "documentation":"

Filter results by the job's target device ID.

", + "location":"querystring", + "locationName":"DeviceId" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

Specify the pagination token from a previous request to retrieve the next page of results.

", + "location":"querystring", + "locationName":"NextToken" + }, + "MaxResults":{ + "shape":"MaxSize25", + "documentation":"

The maximum number of device jobs to return in one page of results.

", + "location":"querystring", + "locationName":"MaxResults" + } + } + }, + "ListDevicesJobsResponse":{ + "type":"structure", + "members":{ + "DeviceJobs":{ + "shape":"DeviceJobList", + "documentation":"

A list of jobs.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

A pagination token that's included if more results are available.

" + } + } + }, + "ListDevicesRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"

Specify the pagination token from a previous request to retrieve the next page of results.

", + "location":"querystring", + "locationName":"NextToken" + }, + "MaxResults":{ + "shape":"MaxSize25", + "documentation":"

The maximum number of devices to return in one page of results.

", + "location":"querystring", + "locationName":"MaxResults" + } + } + }, + "ListDevicesResponse":{ + "type":"structure", + "required":["Devices"], + "members":{ + "Devices":{ + "shape":"DeviceList", + "documentation":"

A list of devices.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

A pagination token that's included if more results are available.

" + } + } + }, + "ListNodeFromTemplateJobsRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"

Specify the pagination token from a previous request to retrieve the next page of results.

", + "location":"querystring", + "locationName":"NextToken" + }, + "MaxResults":{ + "shape":"MaxSize25", + "documentation":"

The maximum number of node from template jobs to return in one page of results.

", + "location":"querystring", + "locationName":"MaxResults" + } + } + }, + "ListNodeFromTemplateJobsResponse":{ + "type":"structure", + "required":["NodeFromTemplateJobs"], + "members":{ + "NodeFromTemplateJobs":{ + "shape":"NodeFromTemplateJobList", + "documentation":"

A list of jobs.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

A pagination token that's included if more results are available.

" + } + } + }, + "ListNodesRequest":{ + "type":"structure", + "members":{ + "Category":{ + "shape":"NodeCategory", + "documentation":"

Search for nodes by category.

", + "location":"querystring", + "locationName":"category" + }, + "OwnerAccount":{ + "shape":"PackageOwnerAccount", + "documentation":"

Search for nodes by the account ID of the nodes' owner.

", + "location":"querystring", + "locationName":"ownerAccount" + }, + "PackageName":{ + "shape":"NodePackageName", + "documentation":"

Search for nodes by name.

", + "location":"querystring", + "locationName":"packageName" + }, + "PackageVersion":{ + "shape":"NodePackageVersion", + "documentation":"

Search for nodes by version.

", + "location":"querystring", + "locationName":"packageVersion" + }, + "PatchVersion":{ + "shape":"NodePackagePatchVersion", + "documentation":"

Search for nodes by patch version.

", + "location":"querystring", + "locationName":"patchVersion" + }, + "NextToken":{ + "shape":"Token", + "documentation":"

Specify the pagination token from a previous request to retrieve the next page of results.

", + "location":"querystring", + "locationName":"nextToken" + }, + "MaxResults":{ + "shape":"MaxSize25", + "documentation":"

The maximum number of nodes to return in one page of results.

", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListNodesResponse":{ + "type":"structure", + "members":{ + "Nodes":{ + "shape":"NodesList", + "documentation":"

A list of nodes.

" + }, + "NextToken":{ + "shape":"Token", + "documentation":"

A pagination token that's included if more results are available.

" + } + } + }, + "ListPackageImportJobsRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"

Specify the pagination token from a previous request to retrieve the next page of results.

", + "location":"querystring", + "locationName":"NextToken" + }, + "MaxResults":{ + "shape":"MaxSize25", + "documentation":"

The maximum number of package import jobs to return in one page of results.

", + "location":"querystring", + "locationName":"MaxResults" + } + } + }, + "ListPackageImportJobsResponse":{ + "type":"structure", + "required":["PackageImportJobs"], + "members":{ + "PackageImportJobs":{ + "shape":"PackageImportJobList", + "documentation":"

A list of package import jobs.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

A pagination token that's included if more results are available.

" + } + } + }, + "ListPackagesRequest":{ + "type":"structure", + "members":{ + "MaxResults":{ + "shape":"MaxSize25", + "documentation":"

The maximum number of packages to return in one page of results.

", + "location":"querystring", + "locationName":"maxResults" + }, + "NextToken":{ + "shape":"Token", + "documentation":"

Specify the pagination token from a previous request to retrieve the next page of results.

", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListPackagesResponse":{ + "type":"structure", + "members":{ + "Packages":{ + "shape":"PackageList", + "documentation":"

A list of packages.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

A pagination token that's included if more results are available.

" + } + } + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["ResourceArn"], + "members":{ + "ResourceArn":{ + "shape":"ResourceArn", + "documentation":"

The resource's ARN.

", + "location":"uri", + "locationName":"ResourceArn" + } + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "members":{ + "Tags":{ + "shape":"TagMap", + "documentation":"

A list of tags.

" + } + } + }, + "ManifestOverridesPayload":{ + "type":"structure", + "members":{ + "PayloadData":{ + "shape":"ManifestOverridesPayloadData", + "documentation":"

The overrides document.

" + } + }, + "documentation":"

Parameter overrides for an application instance. This is a JSON document that has a single key (PayloadData) where the value is an escaped string representation of the overrides document.

", + "union":true + }, + "ManifestOverridesPayloadData":{ + "type":"string", + "max":51200, + "min":0, + "pattern":"^.*$" + }, + "ManifestPayload":{ + "type":"structure", + "members":{ + "PayloadData":{ + "shape":"ManifestPayloadData", + "documentation":"

The application manifest.

" + } + }, + "documentation":"

A application verion's manifest file. This is a JSON document that has a single key (PayloadData) where the value is an escaped string representation of the application manifest (graph.json). This file is located in the graphs folder in your application source.

", + "union":true + }, + "ManifestPayloadData":{ + "type":"string", + "max":51200, + "min":1, + "pattern":"^.+$" + }, + "MarkLatestPatch":{"type":"boolean"}, + "Mask":{ + "type":"string", + "max":255, + "min":1, + "pattern":"^.+$" + }, + "MaxConnections":{"type":"integer"}, + "MaxSize25":{ + "type":"integer", + "max":25, + "min":0 + }, + "NetworkConnectionStatus":{ + "type":"string", + "enum":[ + "CONNECTED", + "NOT_CONNECTED" + ] + }, + "NetworkPayload":{ + "type":"structure", + "members":{ + "Ethernet0":{ + "shape":"EthernetPayload", + "documentation":"

Settings for Ethernet port 0.

" + }, + "Ethernet1":{ + "shape":"EthernetPayload", + "documentation":"

Settings for Ethernet port 1.

" + } + }, + "documentation":"

The network configuration for a device.

" + }, + "NetworkStatus":{ + "type":"structure", + "members":{ + "Ethernet0Status":{ + "shape":"EthernetStatus", + "documentation":"

The status of Ethernet port 0.

" + }, + "Ethernet1Status":{ + "shape":"EthernetStatus", + "documentation":"

The status of Ethernet port 1.

" + } + }, + "documentation":"

The network status of a device.

" + }, + "NextToken":{ + "type":"string", + "max":4096, + "min":1, + "pattern":"^.+$" + }, + "Node":{ + "type":"structure", + "required":[ + "NodeId", + "Name", + "Category", + "PackageName", + "PackageId", + "PackageVersion", + "PatchVersion", + "CreatedTime" + ], + "members":{ + "NodeId":{ + "shape":"NodeId", + "documentation":"

The node's ID.

" + }, + "Name":{ + "shape":"NodeName", + "documentation":"

The node's name.

" + }, + "Category":{ + "shape":"NodeCategory", + "documentation":"

The node's category.

" + }, + "OwnerAccount":{ + "shape":"PackageOwnerAccount", + "documentation":"

The account ID of the node's owner.

" + }, + "PackageName":{ + "shape":"NodePackageName", + "documentation":"

The node's package name.

" + }, + "PackageId":{ + "shape":"NodePackageId", + "documentation":"

The node's package ID.

" + }, + "PackageArn":{ + "shape":"NodePackageArn", + "documentation":"

The node's ARN.

" + }, + "PackageVersion":{ + "shape":"NodePackageVersion", + "documentation":"

The node's package version.

" + }, + "PatchVersion":{ + "shape":"NodePackagePatchVersion", + "documentation":"

The node's patch version.

" + }, + "Description":{ + "shape":"Description", + "documentation":"

The node's description.

" + }, + "CreatedTime":{ + "shape":"TimeStamp", + "documentation":"

When the node was created.

" + } + }, + "documentation":"

An application node that represents a camera stream, a model, code, or output.

" + }, + "NodeAssetName":{ + "type":"string", + "max":255, + "min":1, + "pattern":"^[a-zA-Z0-9\\-\\_]+$" + }, + "NodeCategory":{ + "type":"string", + "enum":[ + "BUSINESS_LOGIC", + "ML_MODEL", + "MEDIA_SOURCE", + "MEDIA_SINK" + ] + }, + "NodeFromTemplateJob":{ + "type":"structure", + "members":{ + "JobId":{ + "shape":"JobId", + "documentation":"

The job's ID.

" + }, + "TemplateType":{ + "shape":"TemplateType", + "documentation":"

The job's template type.

" + }, + "Status":{ + "shape":"NodeFromTemplateJobStatus", + "documentation":"

The job's status.

" + }, + "StatusMessage":{ + "shape":"NodeFromTemplateJobStatusMessage", + "documentation":"

The job's status message.

" + }, + "CreatedTime":{ + "shape":"CreatedTime", + "documentation":"

When the job was created.

" + }, + "NodeName":{ + "shape":"NodeName", + "documentation":"

The node's name.

" + } + }, + "documentation":"

A job to create a camera stream node.

" + }, + "NodeFromTemplateJobList":{ + "type":"list", + "member":{"shape":"NodeFromTemplateJob"} + }, + "NodeFromTemplateJobStatus":{ + "type":"string", + "enum":[ + "PENDING", + "SUCCEEDED", + "FAILED" + ] + }, + "NodeFromTemplateJobStatusMessage":{"type":"string"}, + "NodeId":{ + "type":"string", + "max":255, + "min":1, + "pattern":"^[a-zA-Z0-9\\-\\_\\.]+$" + }, + "NodeInputPort":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"PortName", + "documentation":"

The input port's name.

" + }, + "Description":{ + "shape":"Description", + "documentation":"

The input port's description.

" + }, + "Type":{ + "shape":"PortType", + "documentation":"

The input port's type.

" + }, + "DefaultValue":{ + "shape":"PortDefaultValue", + "documentation":"

The input port's default value.

" + }, + "MaxConnections":{ + "shape":"MaxConnections", + "documentation":"

The input port's max connections.

" + } + }, + "documentation":"

A node input port.

" + }, + "NodeInstance":{ + "type":"structure", + "required":[ + "NodeInstanceId", + "CurrentStatus" + ], + "members":{ + "NodeInstanceId":{ + "shape":"NodeInstanceId", + "documentation":"

The instance's ID.

" + }, + "NodeId":{ + "shape":"NodeId", + "documentation":"

The node's ID.

" + }, + "PackageName":{ + "shape":"NodePackageName", + "documentation":"

The instance's package name.

" + }, + "PackageVersion":{ + "shape":"NodePackageVersion", + "documentation":"

The instance's package version.

" + }, + "PackagePatchVersion":{ + "shape":"NodePackagePatchVersion", + "documentation":"

The instance's package patch version.

" + }, + "NodeName":{ + "shape":"NodeName", + "documentation":"

The instance's name.

" + }, + "CurrentStatus":{ + "shape":"NodeInstanceStatus", + "documentation":"

The instance's current status.

" + } + }, + "documentation":"

A node instance.

" + }, + "NodeInstanceId":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^[a-zA-Z0-9\\-\\_]+$" + }, + "NodeInstanceStatus":{ + "type":"string", + "enum":[ + "RUNNING", + "ERROR", + "NOT_AVAILABLE" + ] + }, + "NodeInstances":{ + "type":"list", + "member":{"shape":"NodeInstance"} + }, + "NodeInterface":{ + "type":"structure", + "required":[ + "Inputs", + "Outputs" + ], + "members":{ + "Inputs":{ + "shape":"InputPortList", + "documentation":"

The node interface's inputs.

" + }, + "Outputs":{ + "shape":"OutputPortList", + "documentation":"

The node interface's outputs.

" + } + }, + "documentation":"

A node interface.

" + }, + "NodeName":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^[a-zA-Z0-9\\-\\_]+$" + }, + "NodeOutputPort":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"PortName", + "documentation":"

The output port's name.

" + }, + "Description":{ + "shape":"Description", + "documentation":"

The output port's description.

" + }, + "Type":{ + "shape":"PortType", + "documentation":"

The output port's type.

" + } + }, + "documentation":"

A node output port.

" + }, + "NodePackageArn":{ + "type":"string", + "max":255, + "min":1 + }, + "NodePackageId":{ + "type":"string", + "max":255, + "min":1, + "pattern":"^[a-zA-Z0-9\\-\\_\\/]+$" + }, + "NodePackageName":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^[a-zA-Z0-9\\-\\_]+$" + }, + "NodePackagePatchVersion":{ + "type":"string", + "max":255, + "min":1, + "pattern":"^[a-z0-9]+$" + }, + "NodePackageVersion":{ + "type":"string", + "max":255, + "min":1, + "pattern":"^([0-9]+)\\.([0-9]+)$" + }, + "NodesList":{ + "type":"list", + "member":{"shape":"Node"} + }, + "OTAJobConfig":{ + "type":"structure", + "required":["ImageVersion"], + "members":{ + "ImageVersion":{ + "shape":"ImageVersion", + "documentation":"

The target version of the device software.

" + } + }, + "documentation":"

An over-the-air update (OTA) job configuration.

" + }, + "Object":{"type":"string"}, + "ObjectKey":{ + "type":"string", + "max":255, + "min":1, + "pattern":"^.+$" + }, + "OutPutS3Location":{ + "type":"structure", + "required":[ + "BucketName", + "ObjectKey" + ], + "members":{ + "BucketName":{ + "shape":"BucketName", + "documentation":"

The object's bucket.

" + }, + "ObjectKey":{ + "shape":"ObjectKey", + "documentation":"

The object's key.

" + } + }, + "documentation":"

The location of an output object in Amazon S3.

" + }, + "OutputPortList":{ + "type":"list", + "member":{"shape":"NodeOutputPort"} + }, + "PackageImportJob":{ + "type":"structure", + "members":{ + "JobId":{ + "shape":"JobId", + "documentation":"

The job's ID.

" + }, + "JobType":{ + "shape":"PackageImportJobType", + "documentation":"

The job's type.

" + }, + "Status":{ + "shape":"PackageImportJobStatus", + "documentation":"

The job's status.

" + }, + "StatusMessage":{ + "shape":"PackageImportJobStatusMessage", + "documentation":"

The job's status message.

" + }, + "CreatedTime":{ + "shape":"CreatedTime", + "documentation":"

When the job was created.

" + }, + "LastUpdatedTime":{ + "shape":"LastUpdatedTime", + "documentation":"

When the job was updated.

" + } + }, + "documentation":"

A job to import a package version.

" + }, + "PackageImportJobInputConfig":{ + "type":"structure", + "members":{ + "PackageVersionInputConfig":{ + "shape":"PackageVersionInputConfig", + "documentation":"

The package version's input configuration.

" + } + }, + "documentation":"

A configuration for a package import job.

" + }, + "PackageImportJobList":{ + "type":"list", + "member":{"shape":"PackageImportJob"} + }, + "PackageImportJobOutput":{ + "type":"structure", + "required":[ + "PackageId", + "PackageVersion", + "PatchVersion", + "OutputS3Location" + ], + "members":{ + "PackageId":{ + "shape":"NodePackageId", + "documentation":"

The package's ID.

" + }, + "PackageVersion":{ + "shape":"NodePackageVersion", + "documentation":"

The package's version.

" + }, + "PatchVersion":{ + "shape":"NodePackagePatchVersion", + "documentation":"

The package's patch version.

" + }, + "OutputS3Location":{ + "shape":"OutPutS3Location", + "documentation":"

The package's output location.

" + } + }, + "documentation":"

Results of a package import job.

" + }, + "PackageImportJobOutputConfig":{ + "type":"structure", + "members":{ + "PackageVersionOutputConfig":{ + "shape":"PackageVersionOutputConfig", + "documentation":"

The package version's output configuration.

" + } + }, + "documentation":"

An output configuration for a package import job.

" + }, + "PackageImportJobStatus":{ + "type":"string", + "enum":[ + "PENDING", + "SUCCEEDED", + "FAILED" + ] + }, + "PackageImportJobStatusMessage":{"type":"string"}, + "PackageImportJobType":{ + "type":"string", + "enum":["NODE_PACKAGE_VERSION"] + }, + "PackageList":{ + "type":"list", + "member":{"shape":"PackageListItem"} + }, + "PackageListItem":{ + "type":"structure", + "members":{ + "PackageId":{ + "shape":"NodePackageId", + "documentation":"

The package's ID.

" + }, + "PackageName":{ + "shape":"NodePackageName", + "documentation":"

The package's name.

" + }, + "Arn":{ + "shape":"NodePackageArn", + "documentation":"

The package's ARN.

" + }, + "CreatedTime":{ + "shape":"TimeStamp", + "documentation":"

When the package was created.

" + }, + "Tags":{ + "shape":"TagMap", + "documentation":"

The package's tags.

" + } + }, + "documentation":"

A package summary.

" + }, + "PackageObject":{ + "type":"structure", + "required":[ + "Name", + "PackageVersion", + "PatchVersion" + ], + "members":{ + "Name":{ + "shape":"NodePackageName", + "documentation":"

The object's name.

" + }, + "PackageVersion":{ + "shape":"NodePackageVersion", + "documentation":"

The object's package version.

" + }, + "PatchVersion":{ + "shape":"NodePackagePatchVersion", + "documentation":"

The object's patch version.

" + } + }, + "documentation":"

A package object.

" + }, + "PackageObjects":{ + "type":"list", + "member":{"shape":"PackageObject"} + }, + "PackageOwnerAccount":{ + "type":"string", + "max":12, + "min":1, + "pattern":"^[0-9a-z\\_]+$" + }, + "PackageVersionInputConfig":{ + "type":"structure", + "required":["S3Location"], + "members":{ + "S3Location":{ + "shape":"S3Location", + "documentation":"

A location in Amazon S3.

" + } + }, + "documentation":"

A package version input configuration.

" + }, + "PackageVersionOutputConfig":{ + "type":"structure", + "required":[ + "PackageName", + "PackageVersion" + ], + "members":{ + "PackageName":{ + "shape":"NodePackageName", + "documentation":"

The output's package name.

" + }, + "PackageVersion":{ + "shape":"NodePackageVersion", + "documentation":"

The output's package version.

" + }, + "MarkLatest":{ + "shape":"MarkLatestPatch", + "documentation":"

Indicates that the version is recommended for all users.

" + } + }, + "documentation":"

A package version output configuration.

" + }, + "PackageVersionStatus":{ + "type":"string", + "enum":[ + "REGISTER_PENDING", + "REGISTER_COMPLETED", + "FAILED", + "DELETING" + ] + }, + "PackageVersionStatusDescription":{ + "type":"string", + "max":255, + "min":1 + }, + "PortDefaultValue":{ + "type":"string", + "max":255, + "min":1 + }, + "PortName":{ + "type":"string", + "max":50, + "min":1, + "pattern":"^[a-zA-Z0-9\\_]+$" + }, + "PortType":{ + "type":"string", + "enum":[ + "BOOLEAN", + "STRING", + "INT32", + "FLOAT32", + "MEDIA" + ] + }, + "PrincipalArn":{ + "type":"string", + "max":255, + "min":1, + "pattern":"^arn:[a-z0-9][-.a-z0-9]{0,62}:iam::[0-9]{12}:[a-zA-Z0-9+=,.@\\-_/]+$" + }, + "PrincipalArnsList":{ + "type":"list", + "member":{"shape":"PrincipalArn"} + }, + "ProvisionDeviceRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"DeviceName", + "documentation":"

A name for the device.

" + }, + "Description":{ + "shape":"Description", + "documentation":"

A description for the device.

" + }, + "Tags":{ + "shape":"TagMap", + "documentation":"

Tags for the device.

" + }, + "NetworkingConfiguration":{ + "shape":"NetworkPayload", + "documentation":"

A networking configuration for the device.

" + } + } + }, + "ProvisionDeviceResponse":{ + "type":"structure", + "required":[ + "Arn", + "Status" + ], + "members":{ + "DeviceId":{ + "shape":"DeviceId", + "documentation":"

The device's ID.

" + }, + "Arn":{ + "shape":"DeviceArn", + "documentation":"

The device's ARN.

" + }, + "Status":{ + "shape":"DeviceStatus", + "documentation":"

The device's status.

" + }, + "Certificates":{ + "shape":"Certificates", + "documentation":"

The device's configuration bundle.

" + }, + "IotThingName":{ + "shape":"IotThingName", + "documentation":"

The device's IoT thing name.

" + } + } + }, + "Region":{ + "type":"string", + "max":255, + "min":1, + "pattern":"^.+$" + }, + "RegisterPackageVersionRequest":{ + "type":"structure", + "required":[ + "PackageId", + "PackageVersion", + "PatchVersion" + ], + "members":{ + "OwnerAccount":{ + "shape":"PackageOwnerAccount", + "documentation":"

An owner account.

" + }, + "PackageId":{ + "shape":"NodePackageId", + "documentation":"

A package ID.

", + "location":"uri", + "locationName":"PackageId" + }, + "PackageVersion":{ + "shape":"NodePackageVersion", + "documentation":"

A package version.

", + "location":"uri", + "locationName":"PackageVersion" + }, + "PatchVersion":{ + "shape":"NodePackagePatchVersion", + "documentation":"

A patch version.

", + "location":"uri", + "locationName":"PatchVersion" + }, + "MarkLatest":{ + "shape":"MarkLatestPatch", + "documentation":"

Whether to mark the new version as the latest version.

" + } + } + }, + "RegisterPackageVersionResponse":{ + "type":"structure", + "members":{ + } + }, + "RemoveApplicationInstanceRequest":{ + "type":"structure", + "required":["ApplicationInstanceId"], + "members":{ + "ApplicationInstanceId":{ + "shape":"ApplicationInstanceId", + "documentation":"

An application instance ID.

", + "location":"uri", + "locationName":"applicationInstanceId" + } + } + }, + "RemoveApplicationInstanceResponse":{ + "type":"structure", + "members":{ + } + }, + "ResourceArn":{ + "type":"string", + "max":2048, + "min":1, + "pattern":"^.+$" + }, + "ResourceNotFoundException":{ + "type":"structure", + "required":[ + "Message", + "ResourceId", + "ResourceType" + ], + "members":{ + "Message":{"shape":"String"}, + "ResourceId":{ + "shape":"String", + "documentation":"

The resource's ID.

" + }, + "ResourceType":{ + "shape":"String", + "documentation":"

The resource's type.

" + } + }, + "documentation":"

The target resource was not found.

", + "error":{"httpStatusCode":404}, + "exception":true + }, + "RetryAfterSeconds":{"type":"integer"}, + "RuntimeRoleArn":{ + "type":"string", + "max":255, + "min":1, + "pattern":"^arn:[a-z0-9][-.a-z0-9]{0,62}:iam::[0-9]{12}:role/.+$" + }, + "S3Location":{ + "type":"structure", + "required":[ + "BucketName", + "ObjectKey" + ], + "members":{ + "Region":{ + "shape":"Region", + "documentation":"

The bucket's Region.

" + }, + "BucketName":{ + "shape":"BucketName", + "documentation":"

A bucket name.

" + }, + "ObjectKey":{ + "shape":"ObjectKey", + "documentation":"

An object key.

" + } + }, + "documentation":"

A location in Amazon S3.

" + }, + "ServiceQuotaExceededException":{ + "type":"structure", + "required":[ + "Message", + "QuotaCode", + "ServiceCode" + ], + "members":{ + "Message":{"shape":"String"}, + "ResourceId":{ + "shape":"String", + "documentation":"

The target resource's ID.

" + }, + "ResourceType":{ + "shape":"String", + "documentation":"

The target resource's type.

" + }, + "QuotaCode":{ + "shape":"String", + "documentation":"

The name of the limit.

" + }, + "ServiceCode":{ + "shape":"String", + "documentation":"

The name of the service.

" + } + }, + "documentation":"

The request would cause a limit to be exceeded.

", + "error":{"httpStatusCode":402}, + "exception":true + }, + "StaticIpConnectionInfo":{ + "type":"structure", + "required":[ + "IpAddress", + "Mask", + "Dns", + "DefaultGateway" + ], + "members":{ + "IpAddress":{ + "shape":"IpAddress", + "documentation":"

The connection's IP address.

" + }, + "Mask":{ + "shape":"Mask", + "documentation":"

The connection's DNS mask.

" + }, + "Dns":{ + "shape":"DnsList", + "documentation":"

The connection's DNS address.

" + }, + "DefaultGateway":{ + "shape":"DefaultGateway", + "documentation":"

The connection's default gateway.

" + } + }, + "documentation":"

A static IP configuration.

" + }, + "StatusFilter":{ + "type":"string", + "enum":[ + "DEPLOYMENT_SUCCEEDED", + "DEPLOYMENT_ERROR", + "REMOVAL_SUCCEEDED", + "REMOVAL_FAILED", + "PROCESSING_DEPLOYMENT", + "PROCESSING_REMOVAL" + ] + }, + "StorageLocation":{ + "type":"structure", + "required":[ + "Bucket", + "RepoPrefixLocation", + "GeneratedPrefixLocation", + "BinaryPrefixLocation", + "ManifestPrefixLocation" + ], + "members":{ + "Bucket":{ + "shape":"Bucket", + "documentation":"

The location's bucket.

" + }, + "RepoPrefixLocation":{ + "shape":"Object", + "documentation":"

The location's repo prefix.

" + }, + "GeneratedPrefixLocation":{ + "shape":"Object", + "documentation":"

The location's generated prefix.

" + }, + "BinaryPrefixLocation":{ + "shape":"Object", + "documentation":"

The location's binary prefix.

" + }, + "ManifestPrefixLocation":{ + "shape":"Object", + "documentation":"

The location's manifest prefix.

" + } + }, + "documentation":"

A storage location.

" + }, + "String":{"type":"string"}, + "TagKey":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^.+$" + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"}, + "max":50, + "min":1 + }, + "TagMap":{ + "type":"map", + "key":{"shape":"TagKey"}, + "value":{"shape":"TagValue"}, + "max":50, + "min":0 + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceArn", + "Tags" + ], + "members":{ + "ResourceArn":{ + "shape":"ResourceArn", + "documentation":"

The resource's ARN.

", + "location":"uri", + "locationName":"ResourceArn" + }, + "Tags":{ + "shape":"TagMap", + "documentation":"

Tags for the resource.

" + } + } + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0, + "pattern":"^.*$" + }, + "TemplateKey":{ + "type":"string", + "max":255, + "min":1, + "pattern":"^.+$" + }, + "TemplateParametersMap":{ + "type":"map", + "key":{"shape":"TemplateKey"}, + "value":{"shape":"TemplateValue"} + }, + "TemplateType":{ + "type":"string", + "enum":["RTSP_CAMERA_STREAM"] + }, + "TemplateValue":{ + "type":"string", + "max":255, + "min":1, + "pattern":"^.+$", + "sensitive":true + }, + "TimeStamp":{"type":"timestamp"}, + "Token":{ + "type":"string", + "max":4096, + "min":1, + "pattern":"^.+$" + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceArn", + "TagKeys" + ], + "members":{ + "ResourceArn":{ + "shape":"ResourceArn", + "documentation":"

The resource's ARN.

", + "location":"uri", + "locationName":"ResourceArn" + }, + "TagKeys":{ + "shape":"TagKeyList", + "documentation":"

Tag keys to remove.

", + "location":"querystring", + "locationName":"tagKeys" + } + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateCreatedTime":{"type":"timestamp"}, + "UpdateDeviceMetadataRequest":{ + "type":"structure", + "required":["DeviceId"], + "members":{ + "DeviceId":{ + "shape":"DeviceId", + "documentation":"

The device's ID.

", + "location":"uri", + "locationName":"DeviceId" + }, + "Description":{ + "shape":"Description", + "documentation":"

A description for the device.

" + } + } + }, + "UpdateDeviceMetadataResponse":{ + "type":"structure", + "members":{ + "DeviceId":{ + "shape":"DeviceId", + "documentation":"

The device's ID.

" + } + } + }, + "UpdateProgress":{ + "type":"string", + "enum":[ + "PENDING", + "IN_PROGRESS", + "VERIFYING", + "REBOOTING", + "DOWNLOADING", + "COMPLETED", + "FAILED" + ] + }, + "ValidationException":{ + "type":"structure", + "required":["Message"], + "members":{ + "Message":{"shape":"String"}, + "Reason":{ + "shape":"ValidationExceptionReason", + "documentation":"

The reason that validation failed.

" + }, + "ErrorId":{ + "shape":"String", + "documentation":"

A unique ID for the error.

" + }, + "ErrorArguments":{ + "shape":"ValidationExceptionErrorArgumentList", + "documentation":"

A list of attributes that led to the exception and their values.

" + }, + "Fields":{ + "shape":"ValidationExceptionFieldList", + "documentation":"

A list of request parameters that failed validation.

" + } + }, + "documentation":"

The request contains an invalid parameter value.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "ValidationExceptionErrorArgument":{ + "type":"structure", + "required":[ + "Name", + "Value" + ], + "members":{ + "Name":{ + "shape":"String", + "documentation":"

The argument's name.

" + }, + "Value":{ + "shape":"String", + "documentation":"

The argument's value.

" + } + }, + "documentation":"

A validation exception error argument.

" + }, + "ValidationExceptionErrorArgumentList":{ + "type":"list", + "member":{"shape":"ValidationExceptionErrorArgument"} + }, + "ValidationExceptionField":{ + "type":"structure", + "required":[ + "Name", + "Message" + ], + "members":{ + "Name":{ + "shape":"String", + "documentation":"

The field's name.

" + }, + "Message":{ + "shape":"String", + "documentation":"

The field's message.

" + } + }, + "documentation":"

A validation exception field.

" + }, + "ValidationExceptionFieldList":{ + "type":"list", + "member":{"shape":"ValidationExceptionField"} + }, + "ValidationExceptionReason":{ + "type":"string", + "enum":[ + "UNKNOWN_OPERATION", + "CANNOT_PARSE", + "FIELD_VALIDATION_FAILED", + "OTHER" + ] + } + }, + "documentation":"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.

" +}