UNPKG

prowler-sdk-poc

Version:
1,622 lines 38.2 kB
{ "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": { "http": { "requestUri": "/application-instances" }, "input": { "type": "structure", "required": [ "ManifestPayload", "DefaultRuntimeContextDevice" ], "members": { "Name": {}, "Description": {}, "ManifestPayload": { "shape": "S4" }, "ManifestOverridesPayload": { "shape": "S6" }, "ApplicationInstanceIdToReplace": {}, "RuntimeRoleArn": {}, "DefaultRuntimeContextDevice": {}, "Tags": { "shape": "Sb" } } }, "output": { "type": "structure", "required": [ "ApplicationInstanceId" ], "members": { "ApplicationInstanceId": {} } } }, "CreateJobForDevices": { "http": { "requestUri": "/jobs" }, "input": { "type": "structure", "required": [ "DeviceIds", "DeviceJobConfig", "JobType" ], "members": { "DeviceIds": { "type": "list", "member": {} }, "DeviceJobConfig": { "type": "structure", "members": { "OTAJobConfig": { "type": "structure", "required": [ "ImageVersion" ], "members": { "ImageVersion": {} } } } }, "JobType": {} } }, "output": { "type": "structure", "required": [ "Jobs" ], "members": { "Jobs": { "type": "list", "member": { "type": "structure", "members": { "JobId": {}, "DeviceId": {} } } } } } }, "CreateNodeFromTemplateJob": { "http": { "requestUri": "/packages/template-job" }, "input": { "type": "structure", "required": [ "TemplateType", "OutputPackageName", "OutputPackageVersion", "NodeName", "TemplateParameters" ], "members": { "TemplateType": {}, "OutputPackageName": {}, "OutputPackageVersion": {}, "NodeName": {}, "NodeDescription": {}, "TemplateParameters": { "shape": "Sv" }, "JobTags": { "shape": "Sy" } } }, "output": { "type": "structure", "required": [ "JobId" ], "members": { "JobId": {} } } }, "CreatePackage": { "http": { "requestUri": "/packages" }, "input": { "type": "structure", "required": [ "PackageName" ], "members": { "PackageName": {}, "Tags": { "shape": "Sb" } } }, "output": { "type": "structure", "required": [ "StorageLocation" ], "members": { "PackageId": {}, "Arn": {}, "StorageLocation": { "shape": "S16" } } } }, "CreatePackageImportJob": { "http": { "requestUri": "/packages/import-jobs" }, "input": { "type": "structure", "required": [ "JobType", "InputConfig", "OutputConfig", "ClientToken" ], "members": { "JobType": {}, "InputConfig": { "shape": "S1b" }, "OutputConfig": { "shape": "S1h" }, "ClientToken": {}, "JobTags": { "shape": "Sy" } } }, "output": { "type": "structure", "required": [ "JobId" ], "members": { "JobId": {} } } }, "DeleteDevice": { "http": { "method": "DELETE", "requestUri": "/devices/{DeviceId}" }, "input": { "type": "structure", "required": [ "DeviceId" ], "members": { "DeviceId": { "location": "uri", "locationName": "DeviceId" } } }, "output": { "type": "structure", "members": { "DeviceId": {} } } }, "DeletePackage": { "http": { "method": "DELETE", "requestUri": "/packages/{PackageId}" }, "input": { "type": "structure", "required": [ "PackageId" ], "members": { "PackageId": { "location": "uri", "locationName": "PackageId" }, "ForceDelete": { "location": "querystring", "locationName": "ForceDelete", "type": "boolean" } } }, "output": { "type": "structure", "members": {} } }, "DeregisterPackageVersion": { "http": { "method": "DELETE", "requestUri": "/packages/{PackageId}/versions/{PackageVersion}/patch/{PatchVersion}" }, "input": { "type": "structure", "required": [ "PackageId", "PackageVersion", "PatchVersion" ], "members": { "OwnerAccount": { "location": "querystring", "locationName": "OwnerAccount" }, "PackageId": { "location": "uri", "locationName": "PackageId" }, "PackageVersion": { "location": "uri", "locationName": "PackageVersion" }, "PatchVersion": { "location": "uri", "locationName": "PatchVersion" }, "UpdatedLatestPatchVersion": { "location": "querystring", "locationName": "UpdatedLatestPatchVersion" } } }, "output": { "type": "structure", "members": {} } }, "DescribeApplicationInstance": { "http": { "method": "GET", "requestUri": "/application-instances/{applicationInstanceId}" }, "input": { "type": "structure", "required": [ "ApplicationInstanceId" ], "members": { "ApplicationInstanceId": { "location": "uri", "locationName": "applicationInstanceId" } } }, "output": { "type": "structure", "members": { "Name": {}, "Description": {}, "DefaultRuntimeContextDevice": {}, "DefaultRuntimeContextDeviceName": {}, "ApplicationInstanceIdToReplace": {}, "RuntimeRoleArn": {}, "Status": {}, "HealthStatus": {}, "StatusDescription": {}, "CreatedTime": { "type": "timestamp" }, "LastUpdatedTime": { "type": "timestamp" }, "ApplicationInstanceId": {}, "Arn": {}, "Tags": { "shape": "Sb" } } } }, "DescribeApplicationInstanceDetails": { "http": { "method": "GET", "requestUri": "/application-instances/{applicationInstanceId}/details" }, "input": { "type": "structure", "required": [ "ApplicationInstanceId" ], "members": { "ApplicationInstanceId": { "location": "uri", "locationName": "applicationInstanceId" } } }, "output": { "type": "structure", "members": { "Name": {}, "Description": {}, "DefaultRuntimeContextDevice": {}, "ManifestPayload": { "shape": "S4" }, "ManifestOverridesPayload": { "shape": "S6" }, "ApplicationInstanceIdToReplace": {}, "CreatedTime": { "type": "timestamp" }, "ApplicationInstanceId": {} } } }, "DescribeDevice": { "http": { "method": "GET", "requestUri": "/devices/{DeviceId}" }, "input": { "type": "structure", "required": [ "DeviceId" ], "members": { "DeviceId": { "location": "uri", "locationName": "DeviceId" } } }, "output": { "type": "structure", "members": { "DeviceId": {}, "Name": {}, "Arn": {}, "Description": {}, "Type": {}, "DeviceConnectionStatus": {}, "CreatedTime": { "type": "timestamp" }, "ProvisioningStatus": {}, "LatestSoftware": {}, "CurrentSoftware": {}, "SerialNumber": {}, "Tags": { "shape": "Sb" }, "NetworkingConfiguration": { "shape": "S2f" }, "CurrentNetworkingStatus": { "type": "structure", "members": { "Ethernet0Status": { "shape": "S2p" }, "Ethernet1Status": { "shape": "S2p" } } }, "LeaseExpirationTime": { "type": "timestamp" } } } }, "DescribeDeviceJob": { "http": { "method": "GET", "requestUri": "/jobs/{JobId}" }, "input": { "type": "structure", "required": [ "JobId" ], "members": { "JobId": { "location": "uri", "locationName": "JobId" } } }, "output": { "type": "structure", "members": { "JobId": {}, "DeviceId": {}, "DeviceArn": {}, "DeviceName": {}, "DeviceType": {}, "ImageVersion": {}, "Status": {}, "CreatedTime": { "type": "timestamp" } } } }, "DescribeNode": { "http": { "method": "GET", "requestUri": "/nodes/{NodeId}" }, "input": { "type": "structure", "required": [ "NodeId" ], "members": { "NodeId": { "location": "uri", "locationName": "NodeId" }, "OwnerAccount": { "location": "querystring", "locationName": "OwnerAccount" } } }, "output": { "type": "structure", "required": [ "NodeId", "Name", "Category", "OwnerAccount", "PackageName", "PackageId", "PackageVersion", "PatchVersion", "NodeInterface", "Description", "CreatedTime", "LastUpdatedTime" ], "members": { "NodeId": {}, "Name": {}, "Category": {}, "OwnerAccount": {}, "PackageName": {}, "PackageId": {}, "PackageArn": {}, "PackageVersion": {}, "PatchVersion": {}, "NodeInterface": { "type": "structure", "required": [ "Inputs", "Outputs" ], "members": { "Inputs": { "type": "list", "member": { "type": "structure", "members": { "Name": {}, "Description": {}, "Type": {}, "DefaultValue": {}, "MaxConnections": { "type": "integer" } } } }, "Outputs": { "type": "list", "member": { "type": "structure", "members": { "Name": {}, "Description": {}, "Type": {} } } } } }, "AssetName": {}, "Description": {}, "CreatedTime": { "type": "timestamp" }, "LastUpdatedTime": { "type": "timestamp" } } } }, "DescribeNodeFromTemplateJob": { "http": { "method": "GET", "requestUri": "/packages/template-job/{JobId}" }, "input": { "type": "structure", "required": [ "JobId" ], "members": { "JobId": { "location": "uri", "locationName": "JobId" } } }, "output": { "type": "structure", "required": [ "JobId", "Status", "StatusMessage", "CreatedTime", "LastUpdatedTime", "OutputPackageName", "OutputPackageVersion", "NodeName", "TemplateType", "TemplateParameters" ], "members": { "JobId": {}, "Status": {}, "StatusMessage": {}, "CreatedTime": { "type": "timestamp" }, "LastUpdatedTime": { "type": "timestamp" }, "OutputPackageName": {}, "OutputPackageVersion": {}, "NodeName": {}, "NodeDescription": {}, "TemplateType": {}, "TemplateParameters": { "shape": "Sv" }, "JobTags": { "shape": "Sy" } } } }, "DescribePackage": { "http": { "method": "GET", "requestUri": "/packages/metadata/{PackageId}" }, "input": { "type": "structure", "required": [ "PackageId" ], "members": { "PackageId": { "location": "uri", "locationName": "PackageId" } } }, "output": { "type": "structure", "required": [ "PackageId", "PackageName", "Arn", "StorageLocation", "CreatedTime", "Tags" ], "members": { "PackageId": {}, "PackageName": {}, "Arn": {}, "StorageLocation": { "shape": "S16" }, "ReadAccessPrincipalArns": { "shape": "S3i" }, "WriteAccessPrincipalArns": { "shape": "S3i" }, "CreatedTime": { "type": "timestamp" }, "Tags": { "shape": "Sb" } } } }, "DescribePackageImportJob": { "http": { "method": "GET", "requestUri": "/packages/import-jobs/{JobId}" }, "input": { "type": "structure", "required": [ "JobId" ], "members": { "JobId": { "location": "uri", "locationName": "JobId" } } }, "output": { "type": "structure", "required": [ "JobId", "JobType", "InputConfig", "OutputConfig", "Output", "CreatedTime", "LastUpdatedTime", "Status", "StatusMessage" ], "members": { "JobId": {}, "ClientToken": {}, "JobType": {}, "InputConfig": { "shape": "S1b" }, "OutputConfig": { "shape": "S1h" }, "Output": { "type": "structure", "required": [ "PackageId", "PackageVersion", "PatchVersion", "OutputS3Location" ], "members": { "PackageId": {}, "PackageVersion": {}, "PatchVersion": {}, "OutputS3Location": { "type": "structure", "required": [ "BucketName", "ObjectKey" ], "members": { "BucketName": {}, "ObjectKey": {} } } } }, "CreatedTime": { "type": "timestamp" }, "LastUpdatedTime": { "type": "timestamp" }, "Status": {}, "StatusMessage": {}, "JobTags": { "shape": "Sy" } } } }, "DescribePackageVersion": { "http": { "method": "GET", "requestUri": "/packages/metadata/{PackageId}/versions/{PackageVersion}" }, "input": { "type": "structure", "required": [ "PackageId", "PackageVersion" ], "members": { "OwnerAccount": { "location": "querystring", "locationName": "OwnerAccount" }, "PackageId": { "location": "uri", "locationName": "PackageId" }, "PackageVersion": { "location": "uri", "locationName": "PackageVersion" }, "PatchVersion": { "location": "querystring", "locationName": "PatchVersion" } } }, "output": { "type": "structure", "required": [ "PackageId", "PackageName", "PackageVersion", "PatchVersion", "IsLatestPatch", "Status" ], "members": { "OwnerAccount": {}, "PackageId": {}, "PackageArn": {}, "PackageName": {}, "PackageVersion": {}, "PatchVersion": {}, "IsLatestPatch": { "type": "boolean" }, "Status": {}, "StatusDescription": {}, "RegisteredTime": { "type": "timestamp" } } } }, "ListApplicationInstanceDependencies": { "http": { "method": "GET", "requestUri": "/application-instances/{applicationInstanceId}/package-dependencies" }, "input": { "type": "structure", "required": [ "ApplicationInstanceId" ], "members": { "ApplicationInstanceId": { "location": "uri", "locationName": "applicationInstanceId" }, "MaxResults": { "location": "querystring", "locationName": "maxResults", "type": "integer" }, "NextToken": { "location": "querystring", "locationName": "nextToken" } } }, "output": { "type": "structure", "members": { "PackageObjects": { "type": "list", "member": { "type": "structure", "required": [ "Name", "PackageVersion", "PatchVersion" ], "members": { "Name": {}, "PackageVersion": {}, "PatchVersion": {} } } }, "NextToken": {} } } }, "ListApplicationInstanceNodeInstances": { "http": { "method": "GET", "requestUri": "/application-instances/{applicationInstanceId}/node-instances" }, "input": { "type": "structure", "required": [ "ApplicationInstanceId" ], "members": { "ApplicationInstanceId": { "location": "uri", "locationName": "applicationInstanceId" }, "MaxResults": { "location": "querystring", "locationName": "maxResults", "type": "integer" }, "NextToken": { "location": "querystring", "locationName": "nextToken" } } }, "output": { "type": "structure", "members": { "NodeInstances": { "type": "list", "member": { "type": "structure", "required": [ "NodeInstanceId", "CurrentStatus" ], "members": { "NodeInstanceId": {}, "NodeId": {}, "PackageName": {}, "PackageVersion": {}, "PackagePatchVersion": {}, "NodeName": {}, "CurrentStatus": {} } } }, "NextToken": {} } } }, "ListApplicationInstances": { "http": { "method": "GET", "requestUri": "/application-instances" }, "input": { "type": "structure", "members": { "DeviceId": { "location": "querystring", "locationName": "deviceId" }, "StatusFilter": { "location": "querystring", "locationName": "statusFilter" }, "MaxResults": { "location": "querystring", "locationName": "maxResults", "type": "integer" }, "NextToken": { "location": "querystring", "locationName": "nextToken" } } }, "output": { "type": "structure", "members": { "ApplicationInstances": { "type": "list", "member": { "type": "structure", "members": { "Name": {}, "ApplicationInstanceId": {}, "DefaultRuntimeContextDevice": {}, "DefaultRuntimeContextDeviceName": {}, "Description": {}, "Status": {}, "HealthStatus": {}, "StatusDescription": {}, "CreatedTime": { "type": "timestamp" }, "Arn": {}, "Tags": { "shape": "Sb" } } } }, "NextToken": {} } } }, "ListDevices": { "http": { "method": "GET", "requestUri": "/devices" }, "input": { "type": "structure", "members": { "NextToken": { "location": "querystring", "locationName": "NextToken" }, "MaxResults": { "location": "querystring", "locationName": "MaxResults", "type": "integer" } } }, "output": { "type": "structure", "required": [ "Devices" ], "members": { "Devices": { "type": "list", "member": { "type": "structure", "members": { "DeviceId": {}, "Name": {}, "CreatedTime": { "type": "timestamp" }, "ProvisioningStatus": {}, "LastUpdatedTime": { "type": "timestamp" }, "LeaseExpirationTime": { "type": "timestamp" } } } }, "NextToken": {} } } }, "ListDevicesJobs": { "http": { "method": "GET", "requestUri": "/jobs" }, "input": { "type": "structure", "members": { "DeviceId": { "location": "querystring", "locationName": "DeviceId" }, "NextToken": { "location": "querystring", "locationName": "NextToken" }, "MaxResults": { "location": "querystring", "locationName": "MaxResults", "type": "integer" } } }, "output": { "type": "structure", "members": { "DeviceJobs": { "type": "list", "member": { "type": "structure", "members": { "DeviceName": {}, "DeviceId": {}, "JobId": {}, "CreatedTime": { "type": "timestamp" } } } }, "NextToken": {} } } }, "ListNodeFromTemplateJobs": { "http": { "method": "GET", "requestUri": "/packages/template-job" }, "input": { "type": "structure", "members": { "NextToken": { "location": "querystring", "locationName": "NextToken" }, "MaxResults": { "location": "querystring", "locationName": "MaxResults", "type": "integer" } } }, "output": { "type": "structure", "required": [ "NodeFromTemplateJobs" ], "members": { "NodeFromTemplateJobs": { "type": "list", "member": { "type": "structure", "members": { "JobId": {}, "TemplateType": {}, "Status": {}, "StatusMessage": {}, "CreatedTime": { "type": "timestamp" }, "NodeName": {} } } }, "NextToken": {} } } }, "ListNodes": { "http": { "method": "GET", "requestUri": "/nodes" }, "input": { "type": "structure", "members": { "Category": { "location": "querystring", "locationName": "category" }, "OwnerAccount": { "location": "querystring", "locationName": "ownerAccount" }, "PackageName": { "location": "querystring", "locationName": "packageName" }, "PackageVersion": { "location": "querystring", "locationName": "packageVersion" }, "PatchVersion": { "location": "querystring", "locationName": "patchVersion" }, "NextToken": { "location": "querystring", "locationName": "nextToken" }, "MaxResults": { "location": "querystring", "locationName": "maxResults", "type": "integer" } } }, "output": { "type": "structure", "members": { "Nodes": { "type": "list", "member": { "type": "structure", "required": [ "NodeId", "Name", "Category", "PackageName", "PackageId", "PackageVersion", "PatchVersion", "CreatedTime" ], "members": { "NodeId": {}, "Name": {}, "Category": {}, "OwnerAccount": {}, "PackageName": {}, "PackageId": {}, "PackageArn": {}, "PackageVersion": {}, "PatchVersion": {}, "Description": {}, "CreatedTime": { "type": "timestamp" } } } }, "NextToken": {} } } }, "ListPackageImportJobs": { "http": { "method": "GET", "requestUri": "/packages/import-jobs" }, "input": { "type": "structure", "members": { "NextToken": { "location": "querystring", "locationName": "NextToken" }, "MaxResults": { "location": "querystring", "locationName": "MaxResults", "type": "integer" } } }, "output": { "type": "structure", "required": [ "PackageImportJobs" ], "members": { "PackageImportJobs": { "type": "list", "member": { "type": "structure", "members": { "JobId": {}, "JobType": {}, "Status": {}, "StatusMessage": {}, "CreatedTime": { "type": "timestamp" }, "LastUpdatedTime": { "type": "timestamp" } } } }, "NextToken": {} } } }, "ListPackages": { "http": { "method": "GET", "requestUri": "/packages" }, "input": { "type": "structure", "members": { "MaxResults": { "location": "querystring", "locationName": "maxResults", "type": "integer" }, "NextToken": { "location": "querystring", "locationName": "nextToken" } } }, "output": { "type": "structure", "members": { "Packages": { "type": "list", "member": { "type": "structure", "members": { "PackageId": {}, "PackageName": {}, "Arn": {}, "CreatedTime": { "type": "timestamp" }, "Tags": { "shape": "Sb" } } } }, "NextToken": {} } } }, "ListTagsForResource": { "http": { "method": "GET", "requestUri": "/tags/{ResourceArn}" }, "input": { "type": "structure", "required": [ "ResourceArn" ], "members": { "ResourceArn": { "location": "uri", "locationName": "ResourceArn" } } }, "output": { "type": "structure", "members": { "Tags": { "shape": "Sb" } } } }, "ProvisionDevice": { "http": { "requestUri": "/devices" }, "input": { "type": "structure", "required": [ "Name" ], "members": { "Name": {}, "Description": {}, "Tags": { "shape": "Sb" }, "NetworkingConfiguration": { "shape": "S2f" } } }, "output": { "type": "structure", "required": [ "Arn", "Status" ], "members": { "DeviceId": {}, "Arn": {}, "Status": {}, "Certificates": { "type": "blob" }, "IotThingName": {} } } }, "RegisterPackageVersion": { "http": { "method": "PUT", "requestUri": "/packages/{PackageId}/versions/{PackageVersion}/patch/{PatchVersion}" }, "input": { "type": "structure", "required": [ "PackageId", "PackageVersion", "PatchVersion" ], "members": { "OwnerAccount": {}, "PackageId": { "location": "uri", "locationName": "PackageId" }, "PackageVersion": { "location": "uri", "locationName": "PackageVersion" }, "PatchVersion": { "location": "uri", "locationName": "PatchVersion" }, "MarkLatest": { "type": "boolean" } } }, "output": { "type": "structure", "members": {} } }, "RemoveApplicationInstance": { "http": { "method": "DELETE", "requestUri": "/application-instances/{applicationInstanceId}" }, "input": { "type": "structure", "required": [ "ApplicationInstanceId" ], "members": { "ApplicationInstanceId": { "location": "uri", "locationName": "applicationInstanceId" } } }, "output": { "type": "structure", "members": {} } }, "TagResource": { "http": { "requestUri": "/tags/{ResourceArn}" }, "input": { "type": "structure", "required": [ "ResourceArn", "Tags" ], "members": { "ResourceArn": { "location": "uri", "locationName": "ResourceArn" }, "Tags": { "shape": "Sb" } } }, "output": { "type": "structure", "members": {} } }, "UntagResource": { "http": { "method": "DELETE", "requestUri": "/tags/{ResourceArn}" }, "input": { "type": "structure", "required": [ "ResourceArn", "TagKeys" ], "members": { "ResourceArn": { "location": "uri", "locationName": "ResourceArn" }, "TagKeys": { "location": "querystring", "locationName": "tagKeys", "type": "list", "member": {} } } }, "output": { "type": "structure", "members": {} } }, "UpdateDeviceMetadata": { "http": { "method": "PUT", "requestUri": "/devices/{DeviceId}" }, "input": { "type": "structure", "required": [ "DeviceId" ], "members": { "DeviceId": { "location": "uri", "locationName": "DeviceId" }, "Description": {} } }, "output": { "type": "structure", "members": { "DeviceId": {} } } } }, "shapes": { "S4": { "type": "structure", "members": { "PayloadData": {} }, "union": true }, "S6": { "type": "structure", "members": { "PayloadData": {} }, "union": true }, "Sb": { "type": "map", "key": {}, "value": {} }, "Sv": { "type": "map", "key": {}, "value": { "type": "string", "sensitive": true } }, "Sy": { "type": "list", "member": { "type": "structure", "required": [ "ResourceType", "Tags" ], "members": { "ResourceType": {}, "Tags": { "shape": "Sb" } } } }, "S16": { "type": "structure", "required": [ "Bucket", "RepoPrefixLocation", "GeneratedPrefixLocation", "BinaryPrefixLocation", "ManifestPrefixLocation" ], "members": { "Bucket": {}, "RepoPrefixLocation": {}, "GeneratedPrefixLocation": {}, "BinaryPrefixLocation": {}, "ManifestPrefixLocation": {} } }, "S1b": { "type": "structure", "members": { "PackageVersionInputConfig": { "type": "structure", "required": [ "S3Location" ], "members": { "S3Location": { "type": "structure", "required": [ "BucketName", "ObjectKey" ], "members": { "Region": {}, "BucketName": {}, "ObjectKey": {} } } } } } }, "S1h": { "type": "structure", "members": { "PackageVersionOutputConfig": { "type": "structure", "required": [ "PackageName", "PackageVersion" ], "members": { "PackageName": {}, "PackageVersion": {}, "MarkLatest": { "type": "boolean" } } } } }, "S2f": { "type": "structure", "members": { "Ethernet0": { "shape": "S2g" }, "Ethernet1": { "shape": "S2g" } } }, "S2g": { "type": "structure", "required": [ "ConnectionType" ], "members": { "ConnectionType": {}, "StaticIpConnectionInfo": { "type": "structure", "required": [ "IpAddress", "Mask", "Dns", "DefaultGateway" ], "members": { "IpAddress": {}, "Mask": {}, "Dns": { "type": "list", "member": {} }, "DefaultGateway": {} } } } }, "S2p": { "type": "structure", "members": { "IpAddress": {}, "ConnectionStatus": {}, "HwAddress": {} } }, "S3i": { "type": "list", "member": {} } } }