prowler-sdk-poc
Version:
1,593 lines (1,592 loc) • 58.4 kB
TypeScript
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config-base';
interface Blob {}
declare class Panorama extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: Panorama.Types.ClientConfiguration)
config: Config & Panorama.Types.ClientConfiguration;
/**
* Creates an application instance and deploys it to a device.
*/
createApplicationInstance(params: Panorama.Types.CreateApplicationInstanceRequest, callback?: (err: AWSError, data: Panorama.Types.CreateApplicationInstanceResponse) => void): Request<Panorama.Types.CreateApplicationInstanceResponse, AWSError>;
/**
* Creates an application instance and deploys it to a device.
*/
createApplicationInstance(callback?: (err: AWSError, data: Panorama.Types.CreateApplicationInstanceResponse) => void): Request<Panorama.Types.CreateApplicationInstanceResponse, AWSError>;
/**
* Creates a job to run on one or more devices.
*/
createJobForDevices(params: Panorama.Types.CreateJobForDevicesRequest, callback?: (err: AWSError, data: Panorama.Types.CreateJobForDevicesResponse) => void): Request<Panorama.Types.CreateJobForDevicesResponse, AWSError>;
/**
* Creates a job to run on one or more devices.
*/
createJobForDevices(callback?: (err: AWSError, data: Panorama.Types.CreateJobForDevicesResponse) => void): Request<Panorama.Types.CreateJobForDevicesResponse, AWSError>;
/**
* Creates a camera stream node.
*/
createNodeFromTemplateJob(params: Panorama.Types.CreateNodeFromTemplateJobRequest, callback?: (err: AWSError, data: Panorama.Types.CreateNodeFromTemplateJobResponse) => void): Request<Panorama.Types.CreateNodeFromTemplateJobResponse, AWSError>;
/**
* Creates a camera stream node.
*/
createNodeFromTemplateJob(callback?: (err: AWSError, data: Panorama.Types.CreateNodeFromTemplateJobResponse) => void): Request<Panorama.Types.CreateNodeFromTemplateJobResponse, AWSError>;
/**
* Creates a package and storage location in an Amazon S3 access point.
*/
createPackage(params: Panorama.Types.CreatePackageRequest, callback?: (err: AWSError, data: Panorama.Types.CreatePackageResponse) => void): Request<Panorama.Types.CreatePackageResponse, AWSError>;
/**
* Creates a package and storage location in an Amazon S3 access point.
*/
createPackage(callback?: (err: AWSError, data: Panorama.Types.CreatePackageResponse) => void): Request<Panorama.Types.CreatePackageResponse, AWSError>;
/**
* Imports a node package.
*/
createPackageImportJob(params: Panorama.Types.CreatePackageImportJobRequest, callback?: (err: AWSError, data: Panorama.Types.CreatePackageImportJobResponse) => void): Request<Panorama.Types.CreatePackageImportJobResponse, AWSError>;
/**
* Imports a node package.
*/
createPackageImportJob(callback?: (err: AWSError, data: Panorama.Types.CreatePackageImportJobResponse) => void): Request<Panorama.Types.CreatePackageImportJobResponse, AWSError>;
/**
* Deletes a device.
*/
deleteDevice(params: Panorama.Types.DeleteDeviceRequest, callback?: (err: AWSError, data: Panorama.Types.DeleteDeviceResponse) => void): Request<Panorama.Types.DeleteDeviceResponse, AWSError>;
/**
* Deletes a device.
*/
deleteDevice(callback?: (err: AWSError, data: Panorama.Types.DeleteDeviceResponse) => void): Request<Panorama.Types.DeleteDeviceResponse, AWSError>;
/**
* Deletes a package.
*/
deletePackage(params: Panorama.Types.DeletePackageRequest, callback?: (err: AWSError, data: Panorama.Types.DeletePackageResponse) => void): Request<Panorama.Types.DeletePackageResponse, AWSError>;
/**
* Deletes a package.
*/
deletePackage(callback?: (err: AWSError, data: Panorama.Types.DeletePackageResponse) => void): Request<Panorama.Types.DeletePackageResponse, AWSError>;
/**
* Deregisters a package version.
*/
deregisterPackageVersion(params: Panorama.Types.DeregisterPackageVersionRequest, callback?: (err: AWSError, data: Panorama.Types.DeregisterPackageVersionResponse) => void): Request<Panorama.Types.DeregisterPackageVersionResponse, AWSError>;
/**
* Deregisters a package version.
*/
deregisterPackageVersion(callback?: (err: AWSError, data: Panorama.Types.DeregisterPackageVersionResponse) => void): Request<Panorama.Types.DeregisterPackageVersionResponse, AWSError>;
/**
* Returns information about an application instance on a device.
*/
describeApplicationInstance(params: Panorama.Types.DescribeApplicationInstanceRequest, callback?: (err: AWSError, data: Panorama.Types.DescribeApplicationInstanceResponse) => void): Request<Panorama.Types.DescribeApplicationInstanceResponse, AWSError>;
/**
* Returns information about an application instance on a device.
*/
describeApplicationInstance(callback?: (err: AWSError, data: Panorama.Types.DescribeApplicationInstanceResponse) => void): Request<Panorama.Types.DescribeApplicationInstanceResponse, AWSError>;
/**
* Returns information about an application instance's configuration manifest.
*/
describeApplicationInstanceDetails(params: Panorama.Types.DescribeApplicationInstanceDetailsRequest, callback?: (err: AWSError, data: Panorama.Types.DescribeApplicationInstanceDetailsResponse) => void): Request<Panorama.Types.DescribeApplicationInstanceDetailsResponse, AWSError>;
/**
* Returns information about an application instance's configuration manifest.
*/
describeApplicationInstanceDetails(callback?: (err: AWSError, data: Panorama.Types.DescribeApplicationInstanceDetailsResponse) => void): Request<Panorama.Types.DescribeApplicationInstanceDetailsResponse, AWSError>;
/**
* Returns information about a device.
*/
describeDevice(params: Panorama.Types.DescribeDeviceRequest, callback?: (err: AWSError, data: Panorama.Types.DescribeDeviceResponse) => void): Request<Panorama.Types.DescribeDeviceResponse, AWSError>;
/**
* Returns information about a device.
*/
describeDevice(callback?: (err: AWSError, data: Panorama.Types.DescribeDeviceResponse) => void): Request<Panorama.Types.DescribeDeviceResponse, AWSError>;
/**
* Returns information about a device job.
*/
describeDeviceJob(params: Panorama.Types.DescribeDeviceJobRequest, callback?: (err: AWSError, data: Panorama.Types.DescribeDeviceJobResponse) => void): Request<Panorama.Types.DescribeDeviceJobResponse, AWSError>;
/**
* Returns information about a device job.
*/
describeDeviceJob(callback?: (err: AWSError, data: Panorama.Types.DescribeDeviceJobResponse) => void): Request<Panorama.Types.DescribeDeviceJobResponse, AWSError>;
/**
* Returns information about a node.
*/
describeNode(params: Panorama.Types.DescribeNodeRequest, callback?: (err: AWSError, data: Panorama.Types.DescribeNodeResponse) => void): Request<Panorama.Types.DescribeNodeResponse, AWSError>;
/**
* Returns information about a node.
*/
describeNode(callback?: (err: AWSError, data: Panorama.Types.DescribeNodeResponse) => void): Request<Panorama.Types.DescribeNodeResponse, AWSError>;
/**
* Returns information about a job to create a camera stream node.
*/
describeNodeFromTemplateJob(params: Panorama.Types.DescribeNodeFromTemplateJobRequest, callback?: (err: AWSError, data: Panorama.Types.DescribeNodeFromTemplateJobResponse) => void): Request<Panorama.Types.DescribeNodeFromTemplateJobResponse, AWSError>;
/**
* Returns information about a job to create a camera stream node.
*/
describeNodeFromTemplateJob(callback?: (err: AWSError, data: Panorama.Types.DescribeNodeFromTemplateJobResponse) => void): Request<Panorama.Types.DescribeNodeFromTemplateJobResponse, AWSError>;
/**
* Returns information about a package.
*/
describePackage(params: Panorama.Types.DescribePackageRequest, callback?: (err: AWSError, data: Panorama.Types.DescribePackageResponse) => void): Request<Panorama.Types.DescribePackageResponse, AWSError>;
/**
* Returns information about a package.
*/
describePackage(callback?: (err: AWSError, data: Panorama.Types.DescribePackageResponse) => void): Request<Panorama.Types.DescribePackageResponse, AWSError>;
/**
* Returns information about a package import job.
*/
describePackageImportJob(params: Panorama.Types.DescribePackageImportJobRequest, callback?: (err: AWSError, data: Panorama.Types.DescribePackageImportJobResponse) => void): Request<Panorama.Types.DescribePackageImportJobResponse, AWSError>;
/**
* Returns information about a package import job.
*/
describePackageImportJob(callback?: (err: AWSError, data: Panorama.Types.DescribePackageImportJobResponse) => void): Request<Panorama.Types.DescribePackageImportJobResponse, AWSError>;
/**
* Returns information about a package version.
*/
describePackageVersion(params: Panorama.Types.DescribePackageVersionRequest, callback?: (err: AWSError, data: Panorama.Types.DescribePackageVersionResponse) => void): Request<Panorama.Types.DescribePackageVersionResponse, AWSError>;
/**
* Returns information about a package version.
*/
describePackageVersion(callback?: (err: AWSError, data: Panorama.Types.DescribePackageVersionResponse) => void): Request<Panorama.Types.DescribePackageVersionResponse, AWSError>;
/**
* Returns a list of application instance dependencies.
*/
listApplicationInstanceDependencies(params: Panorama.Types.ListApplicationInstanceDependenciesRequest, callback?: (err: AWSError, data: Panorama.Types.ListApplicationInstanceDependenciesResponse) => void): Request<Panorama.Types.ListApplicationInstanceDependenciesResponse, AWSError>;
/**
* Returns a list of application instance dependencies.
*/
listApplicationInstanceDependencies(callback?: (err: AWSError, data: Panorama.Types.ListApplicationInstanceDependenciesResponse) => void): Request<Panorama.Types.ListApplicationInstanceDependenciesResponse, AWSError>;
/**
* Returns a list of application node instances.
*/
listApplicationInstanceNodeInstances(params: Panorama.Types.ListApplicationInstanceNodeInstancesRequest, callback?: (err: AWSError, data: Panorama.Types.ListApplicationInstanceNodeInstancesResponse) => void): Request<Panorama.Types.ListApplicationInstanceNodeInstancesResponse, AWSError>;
/**
* Returns a list of application node instances.
*/
listApplicationInstanceNodeInstances(callback?: (err: AWSError, data: Panorama.Types.ListApplicationInstanceNodeInstancesResponse) => void): Request<Panorama.Types.ListApplicationInstanceNodeInstancesResponse, AWSError>;
/**
* Returns a list of application instances.
*/
listApplicationInstances(params: Panorama.Types.ListApplicationInstancesRequest, callback?: (err: AWSError, data: Panorama.Types.ListApplicationInstancesResponse) => void): Request<Panorama.Types.ListApplicationInstancesResponse, AWSError>;
/**
* Returns a list of application instances.
*/
listApplicationInstances(callback?: (err: AWSError, data: Panorama.Types.ListApplicationInstancesResponse) => void): Request<Panorama.Types.ListApplicationInstancesResponse, AWSError>;
/**
* Returns a list of devices.
*/
listDevices(params: Panorama.Types.ListDevicesRequest, callback?: (err: AWSError, data: Panorama.Types.ListDevicesResponse) => void): Request<Panorama.Types.ListDevicesResponse, AWSError>;
/**
* Returns a list of devices.
*/
listDevices(callback?: (err: AWSError, data: Panorama.Types.ListDevicesResponse) => void): Request<Panorama.Types.ListDevicesResponse, AWSError>;
/**
* Returns a list of jobs.
*/
listDevicesJobs(params: Panorama.Types.ListDevicesJobsRequest, callback?: (err: AWSError, data: Panorama.Types.ListDevicesJobsResponse) => void): Request<Panorama.Types.ListDevicesJobsResponse, AWSError>;
/**
* Returns a list of jobs.
*/
listDevicesJobs(callback?: (err: AWSError, data: Panorama.Types.ListDevicesJobsResponse) => void): Request<Panorama.Types.ListDevicesJobsResponse, AWSError>;
/**
* Returns a list of camera stream node jobs.
*/
listNodeFromTemplateJobs(params: Panorama.Types.ListNodeFromTemplateJobsRequest, callback?: (err: AWSError, data: Panorama.Types.ListNodeFromTemplateJobsResponse) => void): Request<Panorama.Types.ListNodeFromTemplateJobsResponse, AWSError>;
/**
* Returns a list of camera stream node jobs.
*/
listNodeFromTemplateJobs(callback?: (err: AWSError, data: Panorama.Types.ListNodeFromTemplateJobsResponse) => void): Request<Panorama.Types.ListNodeFromTemplateJobsResponse, AWSError>;
/**
* Returns a list of nodes.
*/
listNodes(params: Panorama.Types.ListNodesRequest, callback?: (err: AWSError, data: Panorama.Types.ListNodesResponse) => void): Request<Panorama.Types.ListNodesResponse, AWSError>;
/**
* Returns a list of nodes.
*/
listNodes(callback?: (err: AWSError, data: Panorama.Types.ListNodesResponse) => void): Request<Panorama.Types.ListNodesResponse, AWSError>;
/**
* Returns a list of package import jobs.
*/
listPackageImportJobs(params: Panorama.Types.ListPackageImportJobsRequest, callback?: (err: AWSError, data: Panorama.Types.ListPackageImportJobsResponse) => void): Request<Panorama.Types.ListPackageImportJobsResponse, AWSError>;
/**
* Returns a list of package import jobs.
*/
listPackageImportJobs(callback?: (err: AWSError, data: Panorama.Types.ListPackageImportJobsResponse) => void): Request<Panorama.Types.ListPackageImportJobsResponse, AWSError>;
/**
* Returns a list of packages.
*/
listPackages(params: Panorama.Types.ListPackagesRequest, callback?: (err: AWSError, data: Panorama.Types.ListPackagesResponse) => void): Request<Panorama.Types.ListPackagesResponse, AWSError>;
/**
* Returns a list of packages.
*/
listPackages(callback?: (err: AWSError, data: Panorama.Types.ListPackagesResponse) => void): Request<Panorama.Types.ListPackagesResponse, AWSError>;
/**
* Returns a list of tags for a resource.
*/
listTagsForResource(params: Panorama.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: Panorama.Types.ListTagsForResourceResponse) => void): Request<Panorama.Types.ListTagsForResourceResponse, AWSError>;
/**
* Returns a list of tags for a resource.
*/
listTagsForResource(callback?: (err: AWSError, data: Panorama.Types.ListTagsForResourceResponse) => void): Request<Panorama.Types.ListTagsForResourceResponse, AWSError>;
/**
* 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.
*/
provisionDevice(params: Panorama.Types.ProvisionDeviceRequest, callback?: (err: AWSError, data: Panorama.Types.ProvisionDeviceResponse) => void): Request<Panorama.Types.ProvisionDeviceResponse, AWSError>;
/**
* 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.
*/
provisionDevice(callback?: (err: AWSError, data: Panorama.Types.ProvisionDeviceResponse) => void): Request<Panorama.Types.ProvisionDeviceResponse, AWSError>;
/**
* Registers a package version.
*/
registerPackageVersion(params: Panorama.Types.RegisterPackageVersionRequest, callback?: (err: AWSError, data: Panorama.Types.RegisterPackageVersionResponse) => void): Request<Panorama.Types.RegisterPackageVersionResponse, AWSError>;
/**
* Registers a package version.
*/
registerPackageVersion(callback?: (err: AWSError, data: Panorama.Types.RegisterPackageVersionResponse) => void): Request<Panorama.Types.RegisterPackageVersionResponse, AWSError>;
/**
* Removes an application instance.
*/
removeApplicationInstance(params: Panorama.Types.RemoveApplicationInstanceRequest, callback?: (err: AWSError, data: Panorama.Types.RemoveApplicationInstanceResponse) => void): Request<Panorama.Types.RemoveApplicationInstanceResponse, AWSError>;
/**
* Removes an application instance.
*/
removeApplicationInstance(callback?: (err: AWSError, data: Panorama.Types.RemoveApplicationInstanceResponse) => void): Request<Panorama.Types.RemoveApplicationInstanceResponse, AWSError>;
/**
* Tags a resource.
*/
tagResource(params: Panorama.Types.TagResourceRequest, callback?: (err: AWSError, data: Panorama.Types.TagResourceResponse) => void): Request<Panorama.Types.TagResourceResponse, AWSError>;
/**
* Tags a resource.
*/
tagResource(callback?: (err: AWSError, data: Panorama.Types.TagResourceResponse) => void): Request<Panorama.Types.TagResourceResponse, AWSError>;
/**
* Removes tags from a resource.
*/
untagResource(params: Panorama.Types.UntagResourceRequest, callback?: (err: AWSError, data: Panorama.Types.UntagResourceResponse) => void): Request<Panorama.Types.UntagResourceResponse, AWSError>;
/**
* Removes tags from a resource.
*/
untagResource(callback?: (err: AWSError, data: Panorama.Types.UntagResourceResponse) => void): Request<Panorama.Types.UntagResourceResponse, AWSError>;
/**
* Updates a device's metadata.
*/
updateDeviceMetadata(params: Panorama.Types.UpdateDeviceMetadataRequest, callback?: (err: AWSError, data: Panorama.Types.UpdateDeviceMetadataResponse) => void): Request<Panorama.Types.UpdateDeviceMetadataResponse, AWSError>;
/**
* Updates a device's metadata.
*/
updateDeviceMetadata(callback?: (err: AWSError, data: Panorama.Types.UpdateDeviceMetadataResponse) => void): Request<Panorama.Types.UpdateDeviceMetadataResponse, AWSError>;
}
declare namespace Panorama {
export interface ApplicationInstance {
/**
* The application instance's name.
*/
Name?: ApplicationInstanceName;
/**
* The application instance's ID.
*/
ApplicationInstanceId?: ApplicationInstanceId;
/**
* The device's ID.
*/
DefaultRuntimeContextDevice?: DefaultRuntimeContextDevice;
/**
* The device's name.
*/
DefaultRuntimeContextDeviceName?: DeviceName;
/**
* The application instance's description.
*/
Description?: Description;
/**
* The application instance's status.
*/
Status?: ApplicationInstanceStatus;
/**
* The application instance's health status.
*/
HealthStatus?: ApplicationInstanceHealthStatus;
/**
* The application instance's status description.
*/
StatusDescription?: ApplicationInstanceStatusDescription;
/**
* When the application instance was created.
*/
CreatedTime?: TimeStamp;
/**
* The application instance's ARN.
*/
Arn?: ApplicationInstanceArn;
/**
* The application instance's tags.
*/
Tags?: TagMap;
}
export type ApplicationInstanceArn = string;
export type ApplicationInstanceHealthStatus = "RUNNING"|"ERROR"|"NOT_AVAILABLE"|string;
export type ApplicationInstanceId = string;
export type ApplicationInstanceName = string;
export type ApplicationInstanceStatus = "DEPLOYMENT_PENDING"|"DEPLOYMENT_REQUESTED"|"DEPLOYMENT_IN_PROGRESS"|"DEPLOYMENT_ERROR"|"DEPLOYMENT_SUCCEEDED"|"REMOVAL_PENDING"|"REMOVAL_REQUESTED"|"REMOVAL_IN_PROGRESS"|"REMOVAL_FAILED"|"REMOVAL_SUCCEEDED"|string;
export type ApplicationInstanceStatusDescription = string;
export type ApplicationInstances = ApplicationInstance[];
export type Boolean = boolean;
export type Bucket = string;
export type BucketName = string;
export type Certificates = Buffer|Uint8Array|Blob|string;
export type ClientToken = string;
export type ConnectionType = "STATIC_IP"|"DHCP"|string;
export interface CreateApplicationInstanceRequest {
/**
* A name for the application instance.
*/
Name?: ApplicationInstanceName;
/**
* A description for the application instance.
*/
Description?: Description;
/**
* The application's manifest document.
*/
ManifestPayload: ManifestPayload;
/**
* Setting overrides for the application manifest.
*/
ManifestOverridesPayload?: ManifestOverridesPayload;
/**
* The ID of an application instance to replace with the new instance.
*/
ApplicationInstanceIdToReplace?: ApplicationInstanceId;
/**
* The ARN of a runtime role for the application instance.
*/
RuntimeRoleArn?: RuntimeRoleArn;
/**
* A device's ID.
*/
DefaultRuntimeContextDevice: DefaultRuntimeContextDevice;
/**
* Tags for the application instance.
*/
Tags?: TagMap;
}
export interface CreateApplicationInstanceResponse {
/**
* The application instance's ID.
*/
ApplicationInstanceId: ApplicationInstanceId;
}
export interface CreateJobForDevicesRequest {
/**
* IDs of target devices.
*/
DeviceIds: DeviceIdList;
/**
* Configuration settings for the job.
*/
DeviceJobConfig: DeviceJobConfig;
/**
* The type of job to run.
*/
JobType: JobType;
}
export interface CreateJobForDevicesResponse {
/**
* A list of jobs.
*/
Jobs: JobList;
}
export interface CreateNodeFromTemplateJobRequest {
/**
* The type of node.
*/
TemplateType: TemplateType;
/**
* An output package name for the node.
*/
OutputPackageName: NodePackageName;
/**
* An output package version for the node.
*/
OutputPackageVersion: NodePackageVersion;
/**
* A name for the node.
*/
NodeName: NodeName;
/**
* A description for the node.
*/
NodeDescription?: Description;
/**
* Template parameters for the node.
*/
TemplateParameters: TemplateParametersMap;
/**
* Tags for the job.
*/
JobTags?: JobTagsList;
}
export interface CreateNodeFromTemplateJobResponse {
/**
* The job's ID.
*/
JobId: JobId;
}
export interface CreatePackageImportJobRequest {
/**
* A job type for the package import job.
*/
JobType: PackageImportJobType;
/**
* An input config for the package import job.
*/
InputConfig: PackageImportJobInputConfig;
/**
* An output config for the package import job.
*/
OutputConfig: PackageImportJobOutputConfig;
/**
* A client token for the package import job.
*/
ClientToken: ClientToken;
/**
* Tags for the package import job.
*/
JobTags?: JobTagsList;
}
export interface CreatePackageImportJobResponse {
/**
* The job's ID.
*/
JobId: JobId;
}
export interface CreatePackageRequest {
/**
* A name for the package.
*/
PackageName: NodePackageName;
/**
* Tags for the package.
*/
Tags?: TagMap;
}
export interface CreatePackageResponse {
/**
* The package's ID.
*/
PackageId?: NodePackageId;
/**
* The package's ARN.
*/
Arn?: NodePackageArn;
/**
* The package's storage location.
*/
StorageLocation: StorageLocation;
}
export type CreatedTime = Date;
export type CurrentSoftware = string;
export type DefaultGateway = string;
export type DefaultRuntimeContextDevice = string;
export interface DeleteDeviceRequest {
/**
* The device's ID.
*/
DeviceId: DeviceId;
}
export interface DeleteDeviceResponse {
/**
* The device's ID.
*/
DeviceId?: DeviceId;
}
export interface DeletePackageRequest {
/**
* The package's ID.
*/
PackageId: NodePackageId;
/**
* Delete the package even if it has artifacts stored in its access point. Deletes the package's artifacts from Amazon S3.
*/
ForceDelete?: Boolean;
}
export interface DeletePackageResponse {
}
export interface DeregisterPackageVersionRequest {
/**
* An owner account.
*/
OwnerAccount?: PackageOwnerAccount;
/**
* A package ID.
*/
PackageId: NodePackageId;
/**
* A package version.
*/
PackageVersion: NodePackageVersion;
/**
* A patch version.
*/
PatchVersion: NodePackagePatchVersion;
/**
* If the version was marked latest, the new version to maker as latest.
*/
UpdatedLatestPatchVersion?: NodePackagePatchVersion;
}
export interface DeregisterPackageVersionResponse {
}
export interface DescribeApplicationInstanceDetailsRequest {
/**
* The application instance's ID.
*/
ApplicationInstanceId: ApplicationInstanceId;
}
export interface DescribeApplicationInstanceDetailsResponse {
/**
* The application instance's name.
*/
Name?: ApplicationInstanceName;
/**
* The application instance's description.
*/
Description?: Description;
/**
* The application instance's default runtime context device.
*/
DefaultRuntimeContextDevice?: DefaultRuntimeContextDevice;
/**
* The application instance's configuration manifest.
*/
ManifestPayload?: ManifestPayload;
/**
* Parameter overrides for the configuration manifest.
*/
ManifestOverridesPayload?: ManifestOverridesPayload;
/**
* The ID of the application instance that this instance replaced.
*/
ApplicationInstanceIdToReplace?: ApplicationInstanceId;
/**
* When the application instance was created.
*/
CreatedTime?: TimeStamp;
/**
* The application instance's ID.
*/
ApplicationInstanceId?: ApplicationInstanceId;
}
export interface DescribeApplicationInstanceRequest {
/**
* The application instance's ID.
*/
ApplicationInstanceId: ApplicationInstanceId;
}
export interface DescribeApplicationInstanceResponse {
/**
* The application instance's name.
*/
Name?: ApplicationInstanceName;
/**
* The application instance's description.
*/
Description?: Description;
/**
* The device's ID.
*/
DefaultRuntimeContextDevice?: DefaultRuntimeContextDevice;
/**
* The device's bane.
*/
DefaultRuntimeContextDeviceName?: DeviceName;
/**
* The ID of the application instance that this instance replaced.
*/
ApplicationInstanceIdToReplace?: ApplicationInstanceId;
/**
* The application instance's runtime role ARN.
*/
RuntimeRoleArn?: RuntimeRoleArn;
/**
* The application instance's status.
*/
Status?: ApplicationInstanceStatus;
/**
* The application instance's health status.
*/
HealthStatus?: ApplicationInstanceHealthStatus;
/**
* The application instance's status description.
*/
StatusDescription?: ApplicationInstanceStatusDescription;
/**
* When the application instance was created.
*/
CreatedTime?: TimeStamp;
/**
* The application instance was updated.
*/
LastUpdatedTime?: TimeStamp;
/**
* The application instance's ID.
*/
ApplicationInstanceId?: ApplicationInstanceId;
/**
* The application instance's ARN.
*/
Arn?: ApplicationInstanceArn;
/**
* The application instance's tags.
*/
Tags?: TagMap;
}
export interface DescribeDeviceJobRequest {
/**
* The job's ID.
*/
JobId: JobId;
}
export interface DescribeDeviceJobResponse {
/**
* The job's ID.
*/
JobId?: JobId;
/**
* The device's ID.
*/
DeviceId?: DeviceId;
/**
* The device's ARN.
*/
DeviceArn?: DeviceArn;
/**
* The device's name.
*/
DeviceName?: DeviceName;
/**
* The device's type.
*/
DeviceType?: DeviceType;
/**
* For an OTA job, the target version of the device software.
*/
ImageVersion?: ImageVersion;
/**
* The job's status.
*/
Status?: UpdateProgress;
/**
* When the job was created.
*/
CreatedTime?: UpdateCreatedTime;
}
export interface DescribeDeviceRequest {
/**
* The device's ID.
*/
DeviceId: DeviceId;
}
export interface DescribeDeviceResponse {
/**
* The device's ID.
*/
DeviceId?: DeviceId;
/**
* The device's name.
*/
Name?: DeviceName;
/**
* The device's ARN.
*/
Arn?: DeviceArn;
/**
* The device's description.
*/
Description?: Description;
/**
* The device's type.
*/
Type?: DeviceType;
/**
* The device's connection status.
*/
DeviceConnectionStatus?: DeviceConnectionStatus;
/**
* When the device was created.
*/
CreatedTime?: CreatedTime;
/**
* The device's provisioning status.
*/
ProvisioningStatus?: DeviceStatus;
/**
* The latest software version available for the device.
*/
LatestSoftware?: LatestSoftware;
/**
* The device's current software version.
*/
CurrentSoftware?: CurrentSoftware;
/**
* The device's serial number.
*/
SerialNumber?: DeviceSerialNumber;
/**
* The device's tags.
*/
Tags?: TagMap;
/**
* The device's networking configuration.
*/
NetworkingConfiguration?: NetworkPayload;
/**
* The device's networking status.
*/
CurrentNetworkingStatus?: NetworkStatus;
/**
* The device's lease expiration time.
*/
LeaseExpirationTime?: LeaseExpirationTime;
}
export interface DescribeNodeFromTemplateJobRequest {
/**
* The job's ID.
*/
JobId: JobId;
}
export interface DescribeNodeFromTemplateJobResponse {
/**
* The job's ID.
*/
JobId: JobId;
/**
* The job's status.
*/
Status: NodeFromTemplateJobStatus;
/**
* The job's status message.
*/
StatusMessage: NodeFromTemplateJobStatusMessage;
/**
* When the job was created.
*/
CreatedTime: CreatedTime;
/**
* When the job was updated.
*/
LastUpdatedTime: LastUpdatedTime;
/**
* The job's output package name.
*/
OutputPackageName: NodePackageName;
/**
* The job's output package version.
*/
OutputPackageVersion: NodePackageVersion;
/**
* The node's name.
*/
NodeName: NodeName;
/**
* The node's description.
*/
NodeDescription?: Description;
/**
* The job's template type.
*/
TemplateType: TemplateType;
/**
* The job's template parameters.
*/
TemplateParameters: TemplateParametersMap;
/**
* The job's tags.
*/
JobTags?: JobTagsList;
}
export interface DescribeNodeRequest {
/**
* The node's ID.
*/
NodeId: NodeId;
/**
* The account ID of the node's owner.
*/
OwnerAccount?: PackageOwnerAccount;
}
export interface DescribeNodeResponse {
/**
* The node's ID.
*/
NodeId: NodeId;
/**
* The node's name.
*/
Name: NodeName;
/**
* The node's category.
*/
Category: NodeCategory;
/**
* The account ID of the node's owner.
*/
OwnerAccount: PackageOwnerAccount;
/**
* The node's package name.
*/
PackageName: NodePackageName;
/**
* The node's package ID.
*/
PackageId: NodePackageId;
/**
* The node's ARN.
*/
PackageArn?: NodePackageArn;
/**
* The node's package version.
*/
PackageVersion: NodePackageVersion;
/**
* The node's patch version.
*/
PatchVersion: NodePackagePatchVersion;
/**
* The node's interface.
*/
NodeInterface: NodeInterface;
/**
* The node's asset name.
*/
AssetName?: NodeAssetName;
/**
* The node's description.
*/
Description: Description;
/**
* When the node was created.
*/
CreatedTime: TimeStamp;
/**
* When the node was updated.
*/
LastUpdatedTime: TimeStamp;
}
export interface DescribePackageImportJobRequest {
/**
* The job's ID.
*/
JobId: JobId;
}
export interface DescribePackageImportJobResponse {
/**
* The job's ID.
*/
JobId: JobId;
/**
* The job's client token.
*/
ClientToken?: ClientToken;
/**
* The job's type.
*/
JobType: PackageImportJobType;
/**
* The job's input config.
*/
InputConfig: PackageImportJobInputConfig;
/**
* The job's output config.
*/
OutputConfig: PackageImportJobOutputConfig;
/**
* The job's output.
*/
Output: PackageImportJobOutput;
/**
* When the job was created.
*/
CreatedTime: CreatedTime;
/**
* When the job was updated.
*/
LastUpdatedTime: LastUpdatedTime;
/**
* The job's status.
*/
Status: PackageImportJobStatus;
/**
* The job's status message.
*/
StatusMessage: PackageImportJobStatusMessage;
/**
* The job's tags.
*/
JobTags?: JobTagsList;
}
export interface DescribePackageRequest {
/**
* The package's ID.
*/
PackageId: NodePackageId;
}
export interface DescribePackageResponse {
/**
* The package's ID.
*/
PackageId: NodePackageId;
/**
* The package's name.
*/
PackageName: NodePackageName;
/**
* The package's ARN.
*/
Arn: NodePackageArn;
/**
* The package's storage location.
*/
StorageLocation: StorageLocation;
/**
* ARNs of accounts that have read access to the package.
*/
ReadAccessPrincipalArns?: PrincipalArnsList;
/**
* ARNs of accounts that have write access to the package.
*/
WriteAccessPrincipalArns?: PrincipalArnsList;
/**
* When the package was created.
*/
CreatedTime: TimeStamp;
/**
* The package's tags.
*/
Tags: TagMap;
}
export interface DescribePackageVersionRequest {
/**
* The version's owner account.
*/
OwnerAccount?: PackageOwnerAccount;
/**
* The version's ID.
*/
PackageId: NodePackageId;
/**
* The version's version.
*/
PackageVersion: NodePackageVersion;
/**
* The version's patch version.
*/
PatchVersion?: NodePackagePatchVersion;
}
export interface DescribePackageVersionResponse {
/**
* The account ID of the version's owner.
*/
OwnerAccount?: PackageOwnerAccount;
/**
* The version's ID.
*/
PackageId: NodePackageId;
/**
* The ARN of the package.
*/
PackageArn?: NodePackageArn;
/**
* The version's name.
*/
PackageName: NodePackageName;
/**
* The version's version.
*/
PackageVersion: NodePackageVersion;
/**
* The version's patch version.
*/
PatchVersion: NodePackagePatchVersion;
/**
* Whether the version is the latest available.
*/
IsLatestPatch: Boolean;
/**
* The version's status.
*/
Status: PackageVersionStatus;
/**
* The version's status description.
*/
StatusDescription?: PackageVersionStatusDescription;
/**
* The version's registered time.
*/
RegisteredTime?: TimeStamp;
}
export type Description = string;
export interface Device {
/**
* The device's ID.
*/
DeviceId?: DeviceId;
/**
* The device's name.
*/
Name?: DeviceName;
/**
* When the device was created.
*/
CreatedTime?: CreatedTime;
/**
* The device's provisioning status.
*/
ProvisioningStatus?: DeviceStatus;
/**
* When the device was updated.
*/
LastUpdatedTime?: LastUpdatedTime;
/**
* The device's lease expiration time.
*/
LeaseExpirationTime?: LeaseExpirationTime;
}
export type DeviceArn = string;
export type DeviceConnectionStatus = "ONLINE"|"OFFLINE"|"AWAITING_CREDENTIALS"|"NOT_AVAILABLE"|"ERROR"|string;
export type DeviceId = string;
export type DeviceIdList = DeviceId[];
export interface DeviceJob {
/**
* The name of the target device
*/
DeviceName?: DeviceName;
/**
* The ID of the target device.
*/
DeviceId?: DeviceId;
/**
* The job's ID.
*/
JobId?: JobId;
/**
* When the job was created.
*/
CreatedTime?: CreatedTime;
}
export interface DeviceJobConfig {
/**
* A configuration for an over-the-air (OTA) upgrade. Required for OTA jobs.
*/
OTAJobConfig?: OTAJobConfig;
}
export type DeviceJobList = DeviceJob[];
export type DeviceList = Device[];
export type DeviceName = string;
export type DeviceSerialNumber = string;
export type DeviceStatus = "AWAITING_PROVISIONING"|"PENDING"|"SUCCEEDED"|"FAILED"|"ERROR"|"DELETING"|string;
export type DeviceType = "PANORAMA_APPLIANCE_DEVELOPER_KIT"|"PANORAMA_APPLIANCE"|string;
export type Dns = string;
export type DnsList = Dns[];
export interface EthernetPayload {
/**
* How the device gets an IP address.
*/
ConnectionType: ConnectionType;
/**
* Network configuration for a static IP connection.
*/
StaticIpConnectionInfo?: StaticIpConnectionInfo;
}
export interface EthernetStatus {
/**
* The device's IP address.
*/
IpAddress?: IpAddress;
/**
* The device's connection status.
*/
ConnectionStatus?: NetworkConnectionStatus;
/**
* The device's physical address.
*/
HwAddress?: HwAddress;
}
export type HwAddress = string;
export type ImageVersion = string;
export type InputPortList = NodeInputPort[];
export type IotThingName = string;
export type IpAddress = string;
export interface Job {
/**
* The job's ID.
*/
JobId?: JobId;
/**
* The target device's ID.
*/
DeviceId?: DeviceId;
}
export type JobId = string;
export type JobList = Job[];
export interface JobResourceTags {
/**
* The job's type.
*/
ResourceType: JobResourceType;
/**
* The job's tags.
*/
Tags: TagMap;
}
export type JobResourceType = "PACKAGE"|string;
export type JobTagsList = JobResourceTags[];
export type JobType = "OTA"|string;
export type LastUpdatedTime = Date;
export type LatestSoftware = string;
export type LeaseExpirationTime = Date;
export interface ListApplicationInstanceDependenciesRequest {
/**
* The application instance's ID.
*/
ApplicationInstanceId: ApplicationInstanceId;
/**
* The maximum number of application instance dependencies to return in one page of results.
*/
MaxResults?: MaxSize25;
/**
* Specify the pagination token from a previous request to retrieve the next page of results.
*/
NextToken?: NextToken;
}
export interface ListApplicationInstanceDependenciesResponse {
/**
* A list of package objects.
*/
PackageObjects?: PackageObjects;
/**
* A pagination token that's included if more results are available.
*/
NextToken?: NextToken;
}
export interface ListApplicationInstanceNodeInstancesRequest {
/**
* The node instances' application instance ID.
*/
ApplicationInstanceId: ApplicationInstanceId;
/**
* The maximum number of node instances to return in one page of results.
*/
MaxResults?: MaxSize25;
/**
* Specify the pagination token from a previous request to retrieve the next page of results.
*/
NextToken?: NextToken;
}
export interface ListApplicationInstanceNodeInstancesResponse {
/**
* A list of node instances.
*/
NodeInstances?: NodeInstances;
/**
* A pagination token that's included if more results are available.
*/
NextToken?: NextToken;
}
export interface ListApplicationInstancesRequest {
/**
* The application instances' device ID.
*/
DeviceId?: DeviceId;
/**
* Only include instances with a specific status.
*/
StatusFilter?: StatusFilter;
/**
* The maximum number of application instances to return in one page of results.
*/
MaxResults?: MaxSize25;
/**
* Specify the pagination token from a previous request to retrieve the next page of results.
*/
NextToken?: NextToken;
}
export interface ListApplicationInstancesResponse {
/**
* A list of application instances.
*/
ApplicationInstances?: ApplicationInstances;
/**
* A pagination token that's included if more results are available.
*/
NextToken?: NextToken;
}
export interface ListDevicesJobsRequest {
/**
* Filter results by the job's target device ID.
*/
DeviceId?: DeviceId;
/**
* Specify the pagination token from a previous request to retrieve the next page of results.
*/
NextToken?: NextToken;
/**
* The maximum number of device jobs to return in one page of results.
*/
MaxResults?: MaxSize25;
}
export interface ListDevicesJobsResponse {
/**
* A list of jobs.
*/
DeviceJobs?: DeviceJobList;
/**
* A pagination token that's included if more results are available.
*/
NextToken?: NextToken;
}
export interface ListDevicesRequest {
/**
* Specify the pagination token from a previous request to retrieve the next page of results.
*/
NextToken?: NextToken;
/**
* The maximum number of devices to return in one page of results.
*/
MaxResults?: MaxSize25;
}
export interface ListDevicesResponse {
/**
* A list of devices.
*/
Devices: DeviceList;
/**
* A pagination token that's included if more results are available.
*/
NextToken?: NextToken;
}
export interface ListNodeFromTemplateJobsRequest {
/**
* Specify the pagination token from a previous request to retrieve the next page of results.
*/
NextToken?: NextToken;
/**
* The maximum number of node from template jobs to return in one page of results.
*/
MaxResults?: MaxSize25;
}
export interface ListNodeFromTemplateJobsResponse {
/**
* A list of jobs.
*/
NodeFromTemplateJobs: NodeFromTemplateJobList;
/**
* A pagination token that's included if more results are available.
*/
NextToken?: NextToken;
}
export interface ListNodesRequest {
/**
* Search for nodes by category.
*/
Category?: NodeCategory;
/**
* Search for nodes by the account ID of the nodes' owner.
*/
OwnerAccount?: PackageOwnerAccount;
/**
* Search for nodes by name.
*/
PackageName?: NodePackageName;
/**
* Search for nodes by version.
*/
PackageVersion?: NodePackageVersion;
/**
* Search for nodes by patch version.
*/
PatchVersion?: NodePackagePatchVersion;
/**
* Specify the pagination token from a previous request to retrieve the next page of results.
*/
NextToken?: Token;
/**
* The maximum number of nodes to return in one page of results.
*/
MaxResults?: MaxSize25;
}
export interface ListNodesResponse {
/**
* A list of nodes.
*/
Nodes?: NodesList;
/**
* A pagination token that's included if more results are available.
*/
NextToken?: Token;
}
export interface ListPackageImportJobsRequest {
/**
* Specify the pagination token from a previous request to retrieve the next page of results.
*/
NextToken?: NextToken;
/**
* The maximum number of package import jobs to return in one page of results.
*/
MaxResults?: MaxSize25;
}
export interface ListPackageImportJobsResponse {
/**
* A list of package import jobs.
*/
PackageImportJobs: PackageImportJobList;
/**
* A pagination token that's included if more results are available.
*/
NextToken?: NextToken;
}
export interface ListPackagesRequest {
/**
* The maximum number of packages to return in one page of results.
*/
MaxResults?: MaxSize25;
/**
* Specify the pagination token from a previous request to retrieve the next page of results.
*/
NextToken?: Token;
}
export interface ListPackagesResponse {
/**
* A list of packages.
*/
Packages?: PackageList;
/**
* A pagination token that's included if more results are available.
*/
NextToken?: NextToken;
}
export interface ListTagsForResourceRequest {
/**
* The resource's ARN.
*/
ResourceArn: ResourceArn;
}
export interface ListTagsForResourceResponse {
/**
* A list of tags.
*/
Tags?: TagMap;
}
export interface ManifestOverridesPayload {
/**
* The overrides document.
*/
PayloadData?: ManifestOverridesPayloadData;
}
export type ManifestOverridesPayloadData = string;
export interface ManifestPayload {
/**
* The application manifest.
*/
PayloadData?: ManifestPayloadData;
}
export type ManifestPayloadData = string;
export type MarkLatestPatch = boolean;
export type Mask = string;
export type MaxConnections = number;
export type MaxSize25 = number;
export type NetworkConnectionStatus = "CONNECTED"|"NOT_CONNECTED"|string;
export interface NetworkPayload {
/**
* Settings for Ethernet port 0.
*/
Ethernet0?: EthernetPayload;
/**
* Settings for Ethernet port 1.
*/
Ethernet1?: EthernetPayload;
}
export interface NetworkStatus {
/**
* The status of Ethernet port 0.
*/
Ethernet0Status?: EthernetStatus;
/**
* The status of Ethernet port 1.
*/
Ethernet1Status?: EthernetStatus;
}
export type NextToken = string;
export interface Node {
/**
* The node's ID.
*/
NodeId: NodeId;
/**
* The node's name.
*/
Name: NodeName;
/**
* The node's category.
*/
Category: NodeCategory;
/**
* The account ID of the node's owner.
*/
OwnerAccount?: PackageOwnerAccount;
/**
* The node's package name.
*/
PackageName: NodePackageName;
/**
* The node's package ID.
*/
PackageId: NodePackageId;
/**
* The node's ARN.
*/
PackageArn?: NodePackageArn;
/**
* The node's package version.
*/
PackageVersion: NodePackageVersion;
/**
* The node's patch version.
*/
PatchVersion: NodePackagePatchVersion;
/**
* The node's description.
*/
Description?: Description;
/**
* When the node was created.
*/
CreatedTime: TimeStamp;
}
export type NodeAssetName = string;
export type NodeCategory = "BUSINESS_LOGIC"|"ML_MODEL"|"MEDIA_SOURCE"|"MEDIA_SINK"|string;
export interface NodeFromTemplateJob {
/**
* The job's ID.
*/
JobId?: JobId;
/**
* The job's template type.
*/
TemplateType?: TemplateType;
/**
* The job's status.
*/
Status?: NodeFromTemplateJobStatus;
/**
* The job's status message.
*/
StatusMessage?: NodeFromTemplateJobStatusMessage;
/**
* When the job was created.
*/
CreatedTime?: CreatedTime;
/**
* The node's name.
*/
NodeName?: NodeName;
}
export type NodeFromTemplateJobList = NodeFromTemplateJob[];
export type NodeFromTemplateJobStatus = "PENDING"|"SUCCEEDED"|"FAILED"|string;
export type NodeFromTemplateJobStatusMessage = string;
export type NodeId = string;
export interface NodeInputPort {
/**
* The input port's name.
*/
Name?: PortName;
/**
* The input port's description.
*/
Description?: Description;
/**
* The input port's type.
*/
Type?: PortType;
/**
* The input port's default value.
*/
DefaultValue?: PortDefaultValue;
/**
* The input port's max connections.
*/
MaxConnections?: MaxConnections;
}
export interface NodeInstance {
/**
* The instance's ID.
*/
NodeInstanceId: NodeInstanceId;
/**
* The node's ID.
*/
NodeId?: NodeId;
/**
* The instance's package name.
*/
PackageName?: NodePackageName;
/**
* The instance's package version.
*/
PackageVersion?: NodePackageVersion;
/**
* The instance's package patch version.
*/
PackagePatchVersion?: NodePackagePatchVersion;
/**
* The instance's name.
*/
NodeName?: NodeName;
/**
* The instance's current status.
*/
CurrentStatus: NodeInstanceStatus;
}
export type NodeInstanceId = string;
export type NodeInstanceStatus = "RUNNING"|"ERROR"|"NOT_AVAILABLE"|string;
export type NodeInstances = NodeInstance[];
export interface NodeInterface {
/**
* The node interface's inputs.
*/
Inputs: InputPortList;
/**
* The node interface's outputs.
*/
Outputs: OutputPortList;
}
export type NodeName = string;
export interface NodeOutputPort {
/**
* The output port's name.
*/
Name?: PortName;
/**
* The output port's description.
*/
Description?: Description;
/**
* The output port's type.
*/
Type?: PortType;
}
export type NodePackageArn = string;
export type NodePackageId = string;
export type NodePackageName = string;
export type NodePackagePatchVersion = string;
export type NodePackageVersion = string;
export type NodesList = Node[];
export interface OTAJobConfig {
/**
* The target version of the device software.
*/
ImageVersion: ImageVersion;
}
export type Object = string;
export type ObjectKey = string;
export interface OutPutS3Location {
/**